File: dtddoc.py

package info (click to toggle)
qm 1.1.3-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 8,628 kB
  • ctags: 10,249
  • sloc: python: 41,482; ansic: 20,611; xml: 12,837; sh: 485; makefile: 226
file content (141 lines) | stat: -rw-r--r-- 3,015 bytes parent folder | download | duplicates (2)
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

from xml.parsers.xmlproc import dtdparser,xmlapp,xmldtd,utils

import sys

# --- Utility functions

def print_cm(out,cm):
    if cm==None:
        out.write("ANY")
        return
    elif cm[1]==[]:
        out.write("EMPTY")
        return
        
    (sep,cont,mod)=cm
    out.write("(")
    for item in cont[:-1]:
        if len(item)==2:
            out.write('<A HREF="#%s">%s</A>%s %s ' % (item[0],item[0],item[1],
                                                      sep))
        else:
            print_cm(out,item)
            out.write(sep+" ")

    item=cont[-1]
    if len(item)==2:
        out.write('<A HREF="#%s">%s</A>%s' % (item[0],item[0],item[1]))
    else:
        print_cm(out,item) 
        out.write(sep+" ")
            
    out.write(")%s " % mod)

# --- Main program

if len(sys.argv) != 2:
    print "Usage: dtddoc.py [file name of DTD file]"
    sys.exit(1)

# Parsing the DTD

print "Parsing DTD"
dp=dtdparser.DTDParser()
dp.set_error_handler(utils.ErrorPrinter(dp))
dtd=xmldtd.CompleteDTD(dp)
#dtd.compile_content_models(0)
dp.set_dtd_consumer(dtd)
dp.parse_resource(sys.argv[1])

# Processing the DTD

print "Processing DTD"

parents={}

def traverse_cm(cur,cm):
    if cm==None:
        return

    for item in cm[1]:
        if len(item)==2:
            try:
                parents[item[0]][cur]=1
            except KeyError:
                print "ERROR: Undeclared element '%s'" % item[0]
        else:
            traverse_cm(cur,item)

parents["#PCDATA"]={}
for elem_name in dtd.get_elements():
    parents[elem_name]={}    
    
for elem_name in dtd.get_elements():
    elem=dtd.get_elem(elem_name)
    traverse_cm(elem_name,elem.get_content_model())
        
# Printing documentation

print "Printing documentation"

out=open("out.html","w")
out.write(
"""
<HTML>
<HEAD>
  <TITLE>DTD Documentation</TITLE>
  <LINK REL=stylesheet HREF="dtd.css" TYPE="text/css">
</HEAD>

<BODY>
<H1>DTD Documentation</H1>
""")

elems=dtd.get_elements()
elems.sort()
for elem_name in elems:
    out.write('<H2><A NAME="%s">%s</A></H2>' % (elem_name,elem_name))
    out.write("<H3>Parents<H3>")

    out.write("<P>")
    ps=parents[elem_name].keys()
    ps.sort()
    for p in ps:
        out.write('<A HREF="#%s">%s</A> ' % (p,p))
        
    out.write("</P>")

    elem=dtd.get_elem(elem_name)
    
    out.write("<H3>Content model</H3>")

    print_cm(out,elem.get_content_model())

    out.write("<H3>Attributes</H3>")
    out.write("<TABLE>")
    out.write("<TR><TH>Name <TH>Type <TH>Declaration <TH>Default")
    attrs=elem.get_attr_list()
    attrs.sort()
    for attr_name in attrs:
        attr=elem.get_attr(attr_name)        
        out.write("  <TR><TD>%s <TD>%s <TD>%s <TD>" %
                  (attr_name,attr.get_type(),attr.get_decl()))
        if attr.get_default()!=None:
            out.write("'%s'" % attr.get_default())
    out.write("</TABLE>")
    

out.write(
"""
<HR>

<ADDRESS>
Produced by dtddoc.py, using xmlproc.
</ADDRESS>

</BODY>
</HTML>
""")

out.close()