premiere-libtorrent/docs/gen_settings_doc.py

124 lines
3.3 KiB
Python
Raw Normal View History

#!/usr/bin/env python
from __future__ import print_function
2014-07-06 21:18:00 +02:00
f = open('../include/libtorrent/settings_pack.hpp')
out = open('settings.rst', 'w+')
2014-07-06 21:18:00 +02:00
def print_field(str, width):
return '%s%s' % (str, ' ' * (width - len(str)))
2014-07-06 21:18:00 +02:00
def render_section(names, description, type, default_values):
max_name_len = max(len(max(names, key=len)), len('name'))
max_type_len = max(len(type), len('type'))
max_val_len = max(len(max(default_values, key=len)), len('default'))
# add link targets for the rest of the manual to reference
for n in names:
print('.. _%s:\n' % n, file=out)
if len(names) > 0:
print('.. raw:: html\n', file=out)
for n in names:
print('\t<a name="%s"></a>' % n, file=out)
print('', file=out)
separator = '+-' + ('-' * max_name_len) + '-+-' + ('-' * max_type_len) + '-+-' + ('-' * max_val_len) + '-+'
# build a table for the settings, their type and default value
print(separator, file=out)
print(
'| %s | %s | %s |' %
(print_field(
'name', max_name_len), print_field(
'type', max_type_len), print_field(
'default', max_val_len)), file=out)
print(separator.replace('-', '='), file=out)
for i in range(len(names)):
print(
'| %s | %s | %s |' %
(print_field(
names[i], max_name_len), print_field(
type, max_type_len), print_field(
default_values[i], max_val_len)), file=out)
print(separator, file=out)
print(file=out)
print(description, file=out)
2014-07-06 21:18:00 +02:00
mode = ''
# parse out default values for settings
f2 = open('../src/settings_pack.cpp')
def_map = {}
for line in f2:
line = line.strip()
if not line.startswith('SET(') \
and not line.startswith('SET_NOPREV(') \
and not line.startswith('DEPRECATED_SET('):
continue
2014-07-06 21:18:00 +02:00
line = line.split('(')[1].split(',')
def_map[line[0]] = line[1].strip()
print('%s = %s' % (line[0], line[1].strip()))
2014-07-06 21:18:00 +02:00
description = ''
names = []
for line in f:
if 'enum string_types' in line:
mode = 'string'
if 'enum bool_types' in line:
mode = 'bool'
if 'enum int_types' in line:
mode = 'int'
if '#if TORRENT_ABI_VERSION == 1' in line:
mode += 'skip'
if '#endif' in line:
mode = mode[0:-4]
if mode == '':
continue
if mode[-4:] == 'skip':
continue
line = line.lstrip()
if line == '' and len(names) > 0:
if description == '':
for n in names:
print('WARNING: no description for "%s"' % n)
else:
default_values = []
for n in names:
default_values.append(def_map[n])
render_section(names, description, mode, default_values)
description = ''
names = []
if line.startswith('};'):
mode = ''
continue
if line.startswith('//'):
if line[2] == ' ':
description += line[3:]
else:
description += line[2:]
continue
line = line.strip()
if line.endswith(','):
line = line[:-1] # strip trailing comma
if '=' in line:
line = line.split('=')[0].strip()
if line.endswith('_internal'):
continue
names.append(line)
2014-07-06 21:18:00 +02:00
out.close()
f.close()