1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
#!/usr/bin/env python3
# encoding: utf-8
from glob import glob
import os
import os.path as p
import re
import sys
import documentation_enhancements as doc_enh
from make import builder_help
###################
# inputs, outputs #
###################
# These files are known to have rst comments; cpp files
# Meaning: (src_file, file_name_to_generate_rst)
cpp_pairs = (
('src/ai/ai_hints.cc', 'autogen_ai_hints.rst'),
('src/graphic/text/rt_parse.cc', 'autogen_rt_tags.rst'),
('src/scripting/lua_root.cc', 'autogen_wl.rst'),
('src/scripting/lua_bases.cc', 'autogen_wl_bases.rst'),
('src/scripting/lua_editor.cc', 'autogen_wl_editor.rst'),
('src/scripting/lua_map.cc', 'autogen_wl_map.rst'),
('src/scripting/lua_game.cc', 'autogen_wl_game.rst'),
('src/scripting/lua_ui.cc', 'autogen_wl_ui.rst'),
('src/scripting/lua_globals.cc', 'autogen_globals.rst'),
('src/scripting/lua_path.cc', 'autogen_path.rst'),
('src/scripting/lua_styles.cc', 'autogen_styles.rst'),
('src/logic/map_objects/map_object_program.cc', 'autogen_map_object_programs.rst'),
('src/logic/map_objects/tribes/worker_program.cc', 'autogen_tribes_worker_programs.rst'),
('src/logic/map_objects/immovable_program.cc', 'autogen_immovable_programs.rst'),
('src/logic/map_objects/tribes/production_program.cc', 'autogen_tribes_productionsite_programs.rst'),
)
# These directories are scanned without knowing which file
# has rst comments; scan for *.lua files
# Meaning: (src_dir, file_prefix, toc_name_to_place)
# The file prefix can be left empty. You can use it to disambiguate if multiple
# directories contain lua files of the same name (e.g. "init.lua").
lua_dirs = (
('data/scripting', '', 'auxiliary'),
('data/scripting/training_wheels', '', 'auxiliary'),
('data/scripting/win_conditions', '', 'auxiliary'),
('data/scripting/editor', '', 'lua_world_other'),
('data/tribes/initialization/atlanteans', '', 'lua_tribes_defining'),
('data/tribes/initialization/atlanteans/starting_conditions', '', 'lua_tribes_defining'),
('data/campaigns/emp04.wmf/scripting/tribes', '', 'lua_tribes_defining'),
('data/tribes/scripting', '', 'lua_tribes_other'),
('data/tribes/scripting/mapobject_info', '', 'lua_tribes_other'),
('data/tribes/scripting/help', '', 'lua_tribes_other'),
('data/tribes/buildings/militarysites/atlanteans/castle',
'militarysite', 'lua_tribes_buildings'),
('data/tribes/buildings/productionsites/atlanteans/armorsmithy',
'productionsite', 'lua_tribes_buildings'),
('data/tribes/buildings/trainingsites/atlanteans/dungeon',
'trainingsite', 'lua_tribes_buildings'),
('data/tribes/buildings/warehouses/atlanteans/headquarters',
'warehouse', 'lua_tribes_buildings'),
# ('data/tribes/buildings/markets/barbarians/market',
# 'market', 'lua_tribes_buildings'),
('data/tribes/buildings/partially_finished/constructionsite',
'constructionsite', 'lua_tribes_buildings'),
('data/tribes/buildings/partially_finished/dismantlesite',
'dismantlesite', 'lua_tribes_buildings'),
('data/tribes/immovables/ashes',
'immovables', 'lua_tribes_units'),
('data/tribes/ships/atlanteans',
'ships', 'lua_tribes_units'),
('data/tribes/wares/armor',
'wares', 'lua_tribes_units'),
('data/tribes/workers/atlanteans/armorsmith',
'basic_workers', 'lua_tribes_workers'),
('data/tribes/workers/atlanteans/carrier',
'carriers', 'lua_tribes_workers'),
('data/tribes/workers/atlanteans/soldier',
'soldiers', 'lua_tribes_workers'),
('data/world', '', 'lua_world_defining'),
('data/world/critters/badger',
'critters', 'lua_world_units'),
('data/world/immovables/artifacts/artifact00',
'immovables', 'lua_world_units'),
('data/world/resources/coal',
'resources', 'lua_world_units'),
('data/world/terrains/desert/beach',
'terrains', 'lua_world_units'),
)
def _find_basedir():
"""Walk upwards in the directory tree till we are in the base directory of
Widelands.
Return the base directory and the source/ directory.
"""
curdir = p.abspath(p.dirname(__file__))
source_dir = p.join(curdir, 'source')
while not (p.exists(p.join(curdir, 'data/tribes')) and p.exists(p.join(curdir, 'data/world'))):
curdir = p.abspath(p.join(curdir, p.pardir))
return source_dir, curdir
source_dir, base_dir = _find_basedir()
def extract_rst_from_cpp(inname, outname=None):
"""Searches for /* RST comments in the given filename, strips the lines and
prints them out on stdout or writes them to outname."""
data = open(p.join(base_dir, inname), 'r').read()
res = re.findall(r"\s*/\* RST\s(.*?)\*/", data, re.M | re.DOTALL)
output = ''
for r in res:
r = r.expandtabs(4)
output += r + '\n'
# Add string 'Child of: …'
output = doc_enh.add_child_of(output, outname)
if '-graphs' in sys.argv:
try:
builder = sys.argv[2]
if sys.argv[1] == '-graphs' and builder:
# Add dependency graph
output = doc_enh.add_dependency_graph(output, outname, builder)
except IndexError:
print('You must provide the sphinx-builder to make the links in graphs work correctly!')
print('Choose a builder out of', [n for n in builder_help], 'e.g. run:')
print("./extract_rst.py -graphs dirhtml")
sys.exit(1)
if output.strip():
out = sys.stdout
if outname is not None:
out = open(p.join(source_dir, outname), 'w')
out.write(output)
def extract_rst_from_lua(directory, file_prefix, toc):
"""Searches for files with /* RST comments in the given directory, strips
the lines and writes them to a file (each found file gets a new
'file.rst').
Returns a list with produced files for this directory.
"""
# List to contain all created files
rst_file_names = []
# Find lua files and search for RST comments
for filename in glob(p.join(base_dir, directory, '*.lua')):
with open(p.join(base_dir, filename), 'r') as f:
data = f.read()
res = re.findall(r"-- RST\s(.*?)(?:^(?!--))", data, re.M | re.DOTALL)
if res:
# File with RST commet found
if file_prefix:
toc = file_prefix + '_' + toc
outname = 'autogen_' + toc + '_%s.rst' % os.path.basename(
os.path.splitext(filename)[0])
rst_file_names.append(outname)
outname = p.join(source_dir, outname)
output = ''
for r in res:
r = re.subn(re.compile(r'^-- ?', re.M | re.DOTALL), '', r)[0]
output += r + '\n'
if output.strip():
out = sys.stdout if not outname else open(outname, 'w')
out.write(output)
return rst_file_names
def replace_tocs(toc_rst_dict):
"""Open predefined toc files, add the produced filenames from
extract_rst_from_lua() and store it as regular .rst file."""
for toc_name, f_names in toc_rst_dict.items():
# Open original toc file
with open(p.join(source_dir, toc_name + '.rst.org'), 'r') as f:
f_content = f.read()
# Add the names to the content of original toc
f_content = f_content.replace('REPLACE_ME',
'\n'.join(' ' + name for name in f_names))
# Save modified content as new file
open(p.join(source_dir, 'autogen_toc_' +
toc_name + '.rst'), 'w').write(f_content)
if __name__ == '__main__':
def main():
doc_enh.init(base_dir, cpp_pairs)
for inf, outf in cpp_pairs:
extract_rst_from_cpp(inf, outf)
# Search the given dirs for rst-comments in every lua files
# Store key:value as toc:list_of_files
toc_fnames = {}
for directory, file_prefix, toc in lua_dirs:
rst_file_names = extract_rst_from_lua(directory, file_prefix, toc)
if rst_file_names:
if toc in toc_fnames:
# toc key exists, extend the value list
toc_fnames[toc].extend(rst_file_names)
else:
# no toc found, create it and add value list
toc_fnames[toc] = rst_file_names
# Replace the predefined tocs with all found files
replace_tocs(toc_fnames)
main()
|