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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
|
#! /usr/bin/python3
import sys
from zzipdoc.match import *
from zzipdoc.options import *
from zzipdoc.textfile import *
from zzipdoc.textfileheader import *
from zzipdoc.functionheader import *
from zzipdoc.functionprototype import *
from zzipdoc.commentmarkup import *
from zzipdoc.functionlisthtmlpage import *
from zzipdoc.functionlistreference import *
from zzipdoc.dbk2htm import *
from zzipdoc.htmldocument import *
from zzipdoc.docbookdocument import *
def _src_to_xml(text):
return text.replace("&", "&").replace("<", "<").replace(">", ">")
def _email_to_xml(text):
return text & Match("<([^<>]*@[^<>]*)>") >> "<\\1>"
class PerFileEntry:
def __init__(self, header, comment):
self.textfileheader = header
self.filecomment = comment
class PerFile:
def __init__(self):
self.textfileheaders = []
self.filecomments = []
self.entries = []
def add(self, textfileheader, filecomment):
self.textfileheaders += [ textfileheader ]
self.filecomments += [ filecomment ]
self.entries += [ PerFileEntry(textfileheader, filecomment) ]
def where_filename(self, filename):
for entry in self.entries:
if entry.textfileheader.get_filename() == filename:
return entry
return None
def print_list_mainheader(self):
for t_fileheader in self.headers:
print(t_fileheader.get_filename(), t_fileheader.src_mainheader())
class PerFunctionEntry:
def __init__(self, header, comment, prototype):
self.header = header
self.comment = comment
self.prototype = prototype
def get_name(self):
return self.prototype.get_name()
def get_titleline(self):
return self.header.get_titleline()
def get_head(self):
return self.prototype
def get_body(self):
return self.comment
class PerFunction:
def __init__(self):
self.headers = []
self.comments = []
self.prototypes = []
self.entries = []
def add(self, functionheader, functioncomment, functionprototype):
self.headers += [ functionheader ]
self.comments += [ functionprototype ]
self.prototypes += [ functionprototype ]
self.entries += [ PerFunctionEntry(functionheader, functioncomment,
functionprototype) ]
def print_list_titleline(self):
for funcheader in self.headers:
print(funcheader.get_filename(), "[=>]", funcheader.get_titleline())
def print_list_name(self):
for funcheader in self.prototypes:
print(funcheader.get_filename(), "[>>]", funcheader.get_name())
class PerFunctionFamilyEntry:
def __init__(self, leader):
self.leader = leader
self.functions = []
def contains(self, func):
for item in self.functions:
if item == func: return True
return False
def add(self, func):
if not self.contains(func):
self.functions += [ func ]
def get_name(self):
if self.leader is None: return None
return self.leader.get_name()
class PerFunctionFamily:
def __init__(self):
self.functions = []
self.families = []
self.retarget = {}
self.entries = []
def add_PerFunction(self, per_list):
for item in per_list.entries:
add_PerFunctionEntry(item)
def add_PerFunctionEntry(self, item):
self.functions += [ item ]
def get_function(self, name):
for item in self.functions:
if item.get_name() == name:
return item
return None
def get_entry(self, name):
for item in self.entries:
if item.get_name() == name:
return item
return None
def fill_families(self):
name_list = {}
for func in self.functions:
name = func.get_name()
name_list[name] = func
for func in self.functions:
name = func.get_name()
line = func.get_titleline()
is_retarget = Match("=>\s*(\w+)")
if line & is_retarget:
into = is_retarget[1]
self.retarget[name] = is_retarget[1]
lead_list = []
for name in self.retarget:
into = self.retarget[name]
if into not in name_list:
print("function '"+name+"' retarget into '"+into+
"' does not exist - keep alone")
if into in self.retarget:
other = self.retarget[into]
print("function '"+name+"' retarget into '"+into+
"' which is itself a retarget into '"+other+"'")
if into not in lead_list:
lead_list += [ into ]
for func in self.functions:
name = func.get_name()
if name not in lead_list and name not in self.retarget:
lead_list += [ name ]
for name in lead_list:
func = self.get_function(name)
if func is not None:
entry = PerFunctionFamilyEntry(func)
entry.add(func) # the first
self.entries += [ entry ]
else:
print("head function '"+name+" has no entry")
for func in self.functions:
name = func.get_name()
if name in self.retarget:
into = self.retarget[name]
entry = self.get_entry(into)
if entry is not None:
entry.add(func) # will not add duplicates
else:
print("into function '"+name+" has no entry")
def print_list_name(self):
for family in self.entries:
name = family.get_name()
print(name, ":", end = " ")
for item in family.functions:
print(item.get_name(), ",", end = " ")
print("")
class HtmlManualPageAdapter:
def __init__(self, entry):
""" usually takes a PerFunctionEntry """
self.entry = entry
def get_name(self):
return self.entry.get_name()
def _head(self):
return self.entry.get_head()
def _body(self):
return self.entry.get_body()
def head_xml_text(self):
return self._head().xml_text()
def body_xml_text(self, name):
return self._body().xml_text(name)
def head_get_prespec(self):
return self._head().get_prespec()
def head_get_namespec(self):
return self._head().get_namespec()
def head_get_callspec(self):
return self._head().get_callspec()
def get_title(self):
return self._body().header.get_title()
def get_filename(self):
return self._body().header.get_filename()
def src_mainheader(self):
return self._body().header.parent.textfile.src_mainheader()
def get_mainheader(self):
return _src_to_xml(self.src_mainheader())
class RefEntryManualPageAdapter:
def __init__(self, entry, per_file = None):
""" usually takes a PerFunctionEntry """
self.entry = entry
self.per_file = per_file
def get_name(self):
return self.entry.get_name()
def _head(self):
return self.entry.get_head()
def _body(self):
return self.entry.get_body()
def _textfile(self):
return self._body().header.parent.textfile
def head_xml_text(self):
return self._head().xml_text()
def body_xml_text(self, name):
return self._body().xml_text(name)
def get_title(self):
return self._body().header.get_title()
def get_filename(self):
return self._body().header.get_filename()
def src_mainheader(self):
return self._textfile().src_mainheader()
def get_mainheader(self):
return _src_to_xml(self.src_mainheader())
def get_includes(self):
return ""
def list_seealso(self):
return self._body().header.get_alsolist()
def get_authors(self):
comment = None
if self.per_file:
entry = self.per_file.where_filename(self.get_filename())
if entry:
comment = entry.filecomment.xml_text()
if comment:
check = Match(r"(?s)<para>\s*[Aa]uthors*\b:*"
r"((?:.(?!</para>))*.)</para>")
if comment & check: return _email_to_xml(check[1])
return None
def get_copyright(self):
comment = None
if self.per_file:
entry = self.per_file.where_filename(self.get_filename())
if entry:
comment = entry.filecomment.xml_text()
if comment:
check = Match(r"(?s)<para>\s*[Cc]opyright\b"
r"((?:.(?!</para>))*.)</para>")
if comment & check: return _email_to_xml(check[0])
return None
def makedocs(filenames, o):
textfiles = []
for filename in filenames:
textfile = TextFile(filename)
textfile.parse()
textfiles += [ textfile ]
per_file = PerFile()
for textfile in textfiles:
textfileheader = TextFileHeader(textfile)
textfileheader.parse()
filecomment = CommentMarkup(textfileheader)
filecomment.parse()
per_file.add(textfileheader, filecomment)
funcheaders = []
for textfile in per_file.textfileheaders:
funcheader = FunctionHeaderList(textfile)
funcheader.parse()
funcheaders += [ funcheader ]
per_function = PerFunction()
for funcheader in funcheaders:
for child in funcheader.get_children():
funcprototype = FunctionPrototype(child)
funcprototype.parse()
funccomment = CommentMarkup(child)
funccomment.parse()
per_function.add(child, funccomment, funcprototype)
per_family = PerFunctionFamily()
for item in per_function.entries:
per_family.add_PerFunctionEntry(item)
per_family.fill_families()
# debug output....
# per_file.print_list_mainheader()
# per_function.print_list_titleline()
# per_function.print_list_name()
# per_family.print_list_name()
#
html = FunctionListHtmlPage(o)
for item in per_family.entries:
for func in item.functions:
func_adapter = HtmlManualPageAdapter(func)
if o.onlymainheader and not (Match("<"+o.onlymainheader+">")
& func_adapter.src_mainheader()):
continue
html.add(func_adapter)
html.cut()
html.cut()
class _Html_:
def __init__(self, html):
self.html = html
def html_text(self):
return section2html(paramdef2html(self.html.xml_text()))
def get_title(self):
return self.html.get_title()
HtmlDocument(o).add(_Html_(html)).save(o.output+o.suffix)
#
man3 = FunctionListReference(o)
for item in per_family.entries:
for func in item.functions:
func_adapter = RefEntryManualPageAdapter(func, per_file)
if o.onlymainheader and not (Match("<"+o.onlymainheader+">")
& func_adapter.src_mainheader()):
continue
man3.add(func_adapter)
man3.cut()
man3.cut()
DocbookDocument(o).add(man3).save(o.output+o.suffix)
if __name__ == "__main__":
filenames = []
o = Options()
o.package = "ZZipLib"
o.program = sys.argv[0]
o.html = "html"
o.docbook = "docbook"
o.output = "zziplib"
o.suffix = ""
for item in sys.argv[1:]:
if o.scan(item): continue
filenames += [ item ]
makedocs(filenames, o)
|