summaryrefslogtreecommitdiff
path: root/Build/source/libs/zziplib/zziplib-src/docs/zzipdoc/functionlisthtmlpage.py
blob: 47dce7626cca4f526bddd6113245b4449af59e72 (plain)
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
from __future__ import print_function

from zzipdoc.options import *
from zzipdoc.match import Match

import os
import os.path

def short(filename):
    while filename.startswith("../"):
        filename = filename[3:]
    if filename.startswith(os.sep):
        parts = ["",""] + filename.split(os.sep)
        return os.path.join(parts[-2], parts[-1])
    return filename

class FunctionListHtmlPage:
    """ The main part here is to create a TOC (table of contents) at the
    start of the page - linking down to the descriptions of the functions.
    Sure we need to generate anchors on the fly. Additionally, all the
    non-html (docbook-like) markup needs to be converted for ouput. -
    each element to be added should implement get_name(), get_head() and
    get_body() with the latter two having a xml_text() method."""
    _null_table100 =  '<table border="0" width="100%"' \
                     ' cellpadding="0" cellspacing="0">'
    _ul_start = '<table width="100%">'
    _ul_end = '</table>' + "\n"
    _li_start = '<tr><td valign="top">'
    _li_end = '</td></tr>' + "\n"
    http_opengroup = "http://www.opengroup.org/onlinepubs/000095399/functions/"
    http_zlib = "http://www.zlib.net/manual.html"
    def __init__(self, o = None):
        self.toc = ""
        self.text = ""
        self.head = ""
        self.body = ""
        self.anchors = []
        self.o = o
        if self.o is None: self.o = Options()
        self.not_found_in_anchors = []
    def cut(self):
        self.text += ("<dt>"+self._ul_start+self.head+self._ul_end+"</dt>"+"\n"+
                      "<dd>"+self._ul_start+self.body+self._ul_end+"</dd>"+"\n")
        self.head = ""
        self.body = ""
    def add(self, entry):
        name = entry.get_name()
        head_text = entry.head_xml_text()
        body_text = entry.body_xml_text(name)
        if not head_text:
            print("no head_text for " + name)
            return
        try:
            prespec = entry.head_get_prespec()
            namespec = entry.head_get_namespec()
            callspec = entry.head_get_callspec()
            head_text = ("<code><b><function>"+namespec+"</function></b>"
                         +callspec+" : "+prespec+"</code>")
        except Exception as e:
            pass
        try:
            extraline = ""
            title = entry.get_title()
            filename = short(entry.get_filename())
            if title:
                subtitle = '&nbsp;<em>'+title+'</em>'
                extraline = (self._null_table100+'<td> '+subtitle+' </td>'+
                             '<td align="right"> '+
                             '<em><small>'+filename+'</small></em>'+
                             '</td></table>' + "\n")
            body_text = extraline + body_text
        except Exception as e:
            pass
        def link(text):
            return (text & Match("<function>(\w*)</function>")
                    >> "<link>\\1</link>")
        def here(text):
            has_function = Match("<function>(\w*)</function>")
            if text & has_function:
                func = has_function[1]
                self.anchors += [ func ]
                return (text & has_function
                        >> '<a name="'+"\\1"+'">'+"\\1"+'</a>')
            else:
                return text
        self.toc += self._li_start+self.sane(link(head_text))+self._li_end
        self.head += self._li_start+self.sane(here(head_text))+self._li_end
        self.body += self._li_start+self.sane(body_text)+self._li_end
    def get_title(self):
        return self.o.package+" Library Functions"
    def xml_text(self):
        self.cut()
        return ("<h2>"+self.get_title()+"</h2>"+
                self.version_line()+
                self.mainheader_line()+
                self._ul_start+
                self.resolve_links(self.toc)+
                self._ul_end+
                "<h3>Documentation</h3>"+
                "<dl>"+
                self.resolve_links(self.text)+
                "</dl>")
    def version_line(self):
        if self.o.version:
            return "<p>Version "+self.o.version+"</p>"
        return ""
    def mainheader_line(self):
        if self.o.onlymainheader:
            include = "#include &lt;"+self.o.onlymainheader+"&gt;"
            return "<p><big><b><code>"+include+"</code></b></big></p>"
        return ""
    def resolve_links(self, text):
        text &= (Match("(?s)<link>([^<>]*)(\(\d\))</link>")
                 >> (lambda x: self.resolve_external(x.group(1), x.group(2))))
        text &= (Match("(?s)<link>(\w+)</link>")
                 >> (lambda x: self.resolve_internal(x.group(1))))
        if len(self.not_found_in_anchors):
            print("not found in anchors: {}".format(self.not_found_in_anchors))
        return (text & Match("(?s)<link>([^<>]*)</link>")
                >> "<code>\\1</code>")
    def resolve_external(self, func, sect):
        x = Match()
        if func & x("^zlib(.*)"):
            return ('<a href="'+self.http_zlib+x[1]+'">'+
                    "<code>"+func+sect+"</code>"+'</a>')
        if sect & x("[23]"):
            return ('<a href="'+self.http_opengroup+func+'.html">'+
                     "<code>"+func+sect+"</code>"+'</a>')
        return "<code>"+func+"<em>"+sect+"</em></sect>"
    def resolve_internal(self, func):
        if func in self.anchors:
            return '<code><a href="#'+func+'">'+func+"</a></code>"
        if func not in self.not_found_in_anchors:
            self.not_found_in_anchors += [ func ]
        return "<code><u>"+func+"</u></code>"
    def sane(self, text):
        return (text 
                .replace("<function>", "<code>")
                .replace("</function>", "</code>"))