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
|
"""
Handling of custom tags. This script can be used as is or as a basis for
your own documentation tags.
The list of custom tags is:
- description
- summary
- parameter (attribute "name" is expected)
- exception
- seealso
- c_version
- group (this builds a custom index from all <group>A Group</group> tags)
- screenshot (this builds a custom index with all screenshots, and also
display the actual image instead of the tag).
"""
import GPS, re, os
class ParameterTagHandler (GPS.DocgenTagHandler):
"""Handling for <parameter name="param">Description of the paramter</parameter>"""
def __init__ (self):
GPS.DocgenTagHandler.__init__ (self, "parameter", on_match = self.on_match)
def on_match (self, docgen, attrs, value, entity_name, entity_href):
res = re.split ('name=\"([^"]*)\"', attrs)
if len (res) > 1:
return """<div class="parameter"><span class="name">%s :</span>%s</div>""" % (res[1], value)
else:
return """<div class="parameter" %s>%s</div>""" % (attrs, value)
class CVersionTagHandler (GPS.DocgenTagHandler):
"""Handling for <c_version>xx.yy</c_version>"""
def __init__ (self):
GPS.DocgenTagHandler.__init__ (self, "c_version", on_match = self.on_match)
def on_match (self, docgen, attrs, value, entity_name, entity_href):
return """<p>Binding from C File version <b>%s</b></p>""" % (value)
class ScreenshotTagHandler (GPS.DocgenTagHandler):
"""Handling for screenshots"""
def __init__ (self):
GPS.DocgenTagHandler.__init__ (
self, "screenshot",
on_match = self.on_match,
on_start=self.on_start,
on_exit=self.on_exit)
def on_start (self, docgen):
self.pictureslist = {}
def on_match (self, docgen, attrs, value, entity_name, entity_href):
file = docgen.get_current_file()
dir = os.path.normpath (
os.path.join (file.project().file().directory(),
"../../share/doc/gtkada/gtkada_rm/"))
fullfile = os.path.join (dir, value)
try:
os.stat(fullfile)
pict = value
except:
try:
os.stat(fullfile+".png")
pict = value + ".png"
except:
try:
os.stat(fullfile+".jpg")
pict = value + ".jpg"
except:
GPS.Console ("Messages").write ("could not find screenshot %s\n" % (fullfile))
return ""
img = """<img src="file://%s" alt="%s" style="border: 0px;"/>""" % (os.path.join (dir, pict), pict)
self.pictureslist[entity_name] = [entity_href, img]
return """</div>
<div class='profile'>
<h3>Screenshot</h3>
%s
</div>
<div class='comment'>""" % (img)
def on_exit (self, docgen):
if len (self.pictureslist) == 0:
return
# first print the right-side box containing the group index
content=""
content += """<div class='default' id='rightSide'>"""
content += """<div id='rightSideInside'>"""
content += """<div id='Index'>"""
content += """<h2>Index</h2>"""
content += """<ul>"""
n = 0
for pict in sorted(self.pictureslist.keys()):
content += """<li><a href="#%d">%s</a></li>""" % (n, pict)
n += 1
content += """</ul></div></div></div>"""
content += """<div class='default' id='documentation'>"""
content += """<div class="title">Widget Screenshots</div>"""
n = 0
for pict in sorted(self.pictureslist.keys()):
content += """
<div class='subprograms'>
<div class='class'>
<a name="%d"></a>
<h3>%s</h3>
<div class='comment'>
<a href="%s">%s</a>
</div>
</div>
</div>""" % (n, pict, self.pictureslist[pict][0], self.pictureslist[pict][1])
n += 1
content += """</div>"""
docgen.generate_index_file ("Widget Screenshots", "screenshots.html", content);
class GroupTagHandler (GPS.DocgenTagHandler):
"""Handling for <group>A Group of packages</group>"""
def __init__ (self):
GPS.DocgenTagHandler.__init__ \
(self, "group",
on_match=self.on_match,
on_start=self.on_start,
on_exit=self.on_exit)
def on_start (self, docgen):
self.groups = {}
def on_match (self, docgen, attrs, value, entity_name, entity_href):
if not self.groups.has_key (value):
self.groups[value] = []
self.groups[value].append ("""<a href="%s">%s</a>""" % (entity_href,entity_name));
return " "
def on_exit (self, docgen):
if len (self.groups) == 0:
return
# first print the right-side box containing the group index
content=""
content += """<div class='default' id='rightSide'>"""
content += """<div id='rightSideInside'>"""
content += """<div id='Index'>"""
content += """<h2>Index</h2>"""
content += """<ul>"""
n = 0
for group in sorted(self.groups.keys()):
content += """<li><a href="#%d">%s</a></li>""" % (n, group)
n += 1
content += """</ul></div></div></div>"""
content += """<div class="title">Widget Groups</div>"""
n = 0
for group in sorted(self.groups.keys()):
content += """<p><a name="%d"></a><h1>%s</h1>\n""" % (n, group)
n += 1
for href in sorted(self.groups[group]):
content += "%s<br/>\n" % (href)
content += "</p>\n"
if content != "":
docgen.generate_index_file ("Widget groups", "groups.html", content);
def on_gps_start (hook):
# use default tag handling for description, summary, exception and seealso
GPS.Docgen.register_tag_handler (GPS.DocgenTagHandler ("description"))
GPS.Docgen.register_tag_handler (GPS.DocgenTagHandler ("summary"))
GPS.Docgen.register_tag_handler (GPS.DocgenTagHandler ("exception"))
GPS.Docgen.register_tag_handler (GPS.DocgenTagHandler ("seealso"))
# register <parameter>, <c_version> and <group> tags.
GPS.Docgen.register_tag_handler (ParameterTagHandler ())
GPS.Docgen.register_tag_handler (CVersionTagHandler ())
GPS.Docgen.register_tag_handler (GroupTagHandler ())
GPS.Docgen.register_tag_handler (ScreenshotTagHandler ())
GPS.Hook ("gps_started").add (on_gps_start)
|
