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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
#
# RTEMS Project Documentation
#
import datetime
import os
import xml.dom.minidom as xml
try:
import configparser
except:
import ConfigParser as configparser
def today():
now = datetime.date.today()
m = now.strftime('%b')
y = now.strftime('%Y')
if now.day == 11:
s = 'th'
elif now.day % 10 == 1:
s = 'st'
elif now.day == 12:
s = 'th'
elif now.day % 10 == 2:
s = 'nd'
elif now.day == 13:
s = 'th'
elif now.day == 3:
s = 'rd'
else:
s = 'th'
d = '%2d%s' % (now.day, s)
return '%s %s %s' % (d, m, y)
class configuration:
def __init__(self, ctx, config):
self.ctx = ctx
self.config = None
self.branches = None
self.releases = None
self.titles = None
self.name = None
self.load(config)
def __str__(self):
import pprint
s = self.name + os.linesep
s += 'Titles:' + os.linesep + \
pprint.pformat(self.titles, indent = 1, width = 80) + os.linesep
s += 'Branches:' + os.linesep + \
pprint.pformat(self.branches, indent = 1, width = 80) + os.linesep
s += 'Releases:' + os.linesep + \
pprint.pformat(self.releases, indent = 1, width = 80) + os.linesep
s += 'Legacy:' + os.linesep + \
pprint.pformat(self.get_legacy_releases(), indent = 1, width = 80) + os.linesep
return s
def _get_item(self, section, label, err = True):
try:
rec = self.config.get(section, label).replace(os.linesep, ' ')
return rec
except:
if err:
self.ctx.fatal('config: no %s found in %s' % (label, section))
return None
def _get_items(self, section, err = True):
try:
items = self.config.items(section)
return items
except:
if err:
self.ctx.fatal('config: section %s not found' % (section))
return []
def _comma_list(self, section, label, error = True, sort = False):
items = self._get_item(section, label, error)
if items is None:
return []
items = [a.strip() for a in items.split(',')]
if sort:
return sorted(set(items))
else:
return items
def _xml_create_doc(self, cat, name, legacy, release, html, pdf):
doc = cat.createElement('doc')
name_ = cat.createElement('name')
text = cat.createTextNode(name)
name_.appendChild(text)
doc.appendChild(name_)
title_ = cat.createElement('title')
text = cat.createTextNode(self.titles[name.lower()])
title_.appendChild(text)
doc.appendChild(title_)
if legacy:
legacy_ = cat.createElement('legacy')
text = cat.createTextNode('Yes')
legacy_.appendChild(text)
doc.appendChild(legacy_)
release_ = cat.createElement('release')
text = cat.createTextNode(release)
release_.appendChild(text)
doc.appendChild(release_)
version_ = cat.createElement('version')
text = cat.createTextNode(release)
version_.appendChild(text)
doc.appendChild(version_)
html_ = cat.createElement('html')
text = cat.createTextNode(html)
html_.appendChild(text)
doc.appendChild(html_)
pdf_ = cat.createElement('pdf')
text = cat.createTextNode(pdf)
pdf_.appendChild(text)
doc.appendChild(pdf_)
return doc
def load(self, name):
'''Load the configuration INI file. Create titles, branches, and releases.'''
self.name = name
self.config = configparser.ConfigParser()
try:
self.config.read(self.name)
except configparser.ParsingError as ce:
self.ctx.fatal('config: %s' % (ce))
self.titles = {}
for t in self._get_items('titles'):
title = t[1]
if title[0] == '"':
title = title[1:]
if title[-1] == '"':
title = title[:-1]
self.titles[t[0]] = title
self.latestes = {}
for l in self._get_items('latest'):
self.latestes[l[0]] = l[1]
self.branches = self._get_items('branches')
self.releases = {}
self.releases['releases'] = self._get_items('releases')
for r in self.releases['releases']:
label = r[1]
self.releases[label] = {}
rel = self.releases[label]
template = self._get_item(label, 'template', False)
if template is None:
template = label
rel['legacy'] = self._get_item(template, 'legacy', False)
if rel['legacy'] is None:
rel['legacy'] = self._get_item(label, 'legacy', False)
if rel['legacy'] == 'yes':
rel['manuals'] = self._comma_list(template, 'manuals')
rel['supplements'] = self._comma_list(template, 'supplements', False)
rel['index_per_doc'] = self._get_item(template, 'index_per_doc', False)
if rel['index_per_doc'] is None:
rel['index_per_doc'] = self._get_item(label, 'index_per_doc', False)
rel['html'] = self._get_item(label, 'html')
rel['pdf'] = self._get_item(label, 'pdf')
rel['date'] = self._get_item(label, 'date')
for d in rel['manuals'] + rel['supplements']:
if d.lower() not in self.titles:
self.ctx.fatal('title not found in %s: %s' % (label, d))
def get_release(self, release):
if self.releases is None:
self.ctx.fatal('no configuration loaded')
for r in self.releases['releases']:
if r[0] == release:
return r[0], r[1], self.releases[r[1]]
self.ctx.fatal('cannot find release: %s' % (release))
def is_legacy_releases(self, release):
if self.releases is None:
self.ctx.fatal('no configuration loaded')
name, label, rel = self.get_release(release)
return rel['legacy'] == 'yes'
def get_legacy_releases(self):
if self.releases is None:
self.ctx.fatal('no configuration loaded')
return sorted([r[0] for r in self.releases['releases'] if self.releases[r[1]]['legacy'] == 'yes'])
def get_releases(self):
if self.releases is None:
self.ctx.fatal('no configuration loaded')
return sorted([r[0] for r in self.releases['releases']])
def generate_xml(self):
if self.releases is None:
self.ctx.fatal('no configuration loaded')
for r in self.get_legacy_releases():
name, label, rel = self.get_release(r)
cat = xml.Document()
root = cat.createElement('rtems-docs')
root.setAttribute('date', rel['date'])
cat.appendChild(root)
heading = cat.createElement('catalogue')
text = cat.createTextNode(name)
heading.appendChild(text)
root.appendChild(heading)
for m in rel['manuals']:
if 'index_per_doc' in rel:
html = rel['html'] + '/' + m + '/index.html'
else:
html = rel['html'] + '/' + m + '.html'
pdf = rel['pdf'] + '/' + m + '.pdf'
legacy = rel['legacy']
doc = self._xml_create_doc(cat, m, legacy, name, html, pdf)
root.appendChild(doc)
catnode = self.ctx.get_cwd().make_node('%s.xml' % (name))
catnode.write(cat.toprettyxml(indent = ' ' * 2, newl = os.linesep))
def generate_html(self, what, indent = 5):
def _tag(tag):
for c in [' ','.',',','(','}','[',']']:
tag = tag.replace(c, '_')
return tag
def _branch_tag(branch):
return _tag(branch[0])
def _branch_script(branch):
path = branch[1]
tag = _branch_tag(branch)
return \
'<script> loadCatalogue("branches/%s/catalogue.xml", "branches/%s", "%s", false); </script>\n' \
% (path, path, tag)
def _release_tag(release):
return _tag(release[0])
def _release_script(release):
name = release[0]
label = release[1]
tag = _release_tag(release)
if self.is_legacy_releases(name):
catalogue = "releases/%s.xml" % (name)
else:
catalogue = "releases/%s/catalogue.xml" % (label)
return \
'<script> loadCatalogue("%s", "releases", "%s", false); </script>\n' \
% (catalogue, tag)
def _match_all(tag):
return True
def _match_latest_release(tag):
return tag == _tag(self.latest('release'))
if self.releases is None:
self.ctx.fatal('no configuration loaded')
if what == 'branches':
data = self.branches
tagger = _branch_tag
scripter = _branch_script
matcher = _match_all
elif what == 'releases':
data = self.releases['releases']
tagger = _release_tag
scripter = _release_script
matcher = _match_all
elif what == 'latest-release':
data = self.releases['releases']
tagger = _release_tag
scripter = _release_script
matcher = _match_latest_release
else:
self.ctx.fatal('invalid html type: ' + what)
scripts = ''
hindent = ' ' * indent
html = ''
for d in data:
tag = tagger(d)
if matcher(tag):
html += hindent + '<div id="rtems-catalogue-%s">\n' % (tag)
html += hindent + ' No catalogue found.\n'
html += hindent + '</div>\n'
scripts += ' ' * 3 + scripter(d)
html = html[:-1]
scripts = scripts[:-1]
return html, scripts
def latest(self, what):
if what not in self.latestes:
self.ctx.fatal(what + 'not found in latest')
return self.latestes[what]
|
