summaryrefslogtreecommitdiffstats
path: root/Doc/tools/mkmodindex
blob: 16aa109e656e669936ce1ed21d72b48a79625420 (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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
#! /usr/bin/env python
#  -*- Python -*-

import buildindex
import getopt
import os
import re
import string
import sys


_rx = re.compile(
    '<dt><a href="(module-.*\.html)">'
    '([a-zA-Z_][a-zA-Z0-9_.]*(\s*<em>\(.*\)</em>)?)</a>')

def main():
    outputfile = "-"
    columns = 1
    letters = 0
    opts, args = getopt.getopt(sys.argv[1:], "c:lo:",
                               ["columns=", "letters", "output="])
    for opt, val in opts:
        if opt in ("-o", "--output"):
            outputfile = val
        elif opt in ("-c", "--columns"):
            columns = string.atoi(val)
        elif opt in ("-l", "--letters"):
            letters = 1
    if not args:
        args = ["-"]
    #
    # Collect the input data:
    #
    nodes = []
    seqno = 0
    has_plat_flag = 0
    for ifn in args:
        if ifn == "-":
            ifp = sys.stdin
            dirname = ''
        else:
            ifp = open(ifn)
            dirname = os.path.dirname(ifn)
        while 1:
            line = ifp.readline()
            if not line:
                break
            m = _rx.match(line)
            if m:
                # This line specifies a module!
                basename, modname = m.group(1, 2)
                has_plat_flag = has_plat_flag or m.group(3)
                linkfile = os.path.join(dirname, basename)
                nodes.append(buildindex.Node(
                    '<a href="%s">' % linkfile,
                    "<tt class=module>%s</tt>" % modname,
                    seqno))
                seqno = seqno + 1
        ifp.close()
    #
    # Generate all output:
    #
    num_nodes = len(nodes)
    # Here's the HTML generation:
    parts = [HEAD, buildindex.process_nodes(nodes, columns, letters), TAIL]
    if has_plat_flag:
        parts.insert(1, PLAT_DISCUSS)
    html = string.join(parts, '')
    program = os.path.basename(sys.argv[0])
    if outputfile == "-":
        sys.stdout.write(html)
        sys.stderr.write("%s: %d index nodes\n" % (program, num_nodes))
    else:
        open(outputfile, "w").write(html)
        print
        print "%s: %d index nodes" % (program, num_nodes)


HEAD = """\
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Global Module Index</title>
<META NAME="description" CONTENT="Global Module Index">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<LINK REL="STYLESHEET" HREF="lib/lib.css">
<LINK REL="up" HREF="./">
</head>
<body bgcolor="#ffffff">
<div class=navigation>
<table width="100%" cellpadding=0 cellspacing=2>
<tr>
<td><img width=32 height=32 align=bottom border=0 alt="blank"
 src="icons/blank.gif"></td>
<td><a href="./"><img width=32 height=32 align=bottom border=0 alt="up"
 src="icons/up.gif"></A></td>
<td><img width=32 height=32 align=bottom border=0 alt="blank"
 src="icons/blank.gif"></td>
<td align=center bgcolor="#99CCFF" width="100%">
 <b class=title>Global Module Index</b></td>
<td><img width=32 height=32 align=bottom border=0 alt="blank"
 src="icons/blank.gif"></td>
<td><img width=32 height=32 align=bottom border=0 alt="blank"
 src="icons/blank.gif"></td>
<td><img width=32 height=32 align=bottom border=0 alt="blank"
 src="icons/blank.gif"></td>
</tr></table>
<b class=navlabel>Up:</b> <span class=sectref><A
 HREF="./">Python Documentation Index</A></span>
<br><hr></div>

<h2>Global Module Index</h2>

"""

PLAT_DISCUSS = """
<p> Some module names are followed by an annotation indicating what
platform they are available on.</p>

"""

TAIL = """
<div class=navigation>
<hr>
<table width="100%" cellpadding=0 cellspacing=2>
<tr>
<td><img width=32 height=32 align=bottom border=0 alt="blank"
 src="icons/blank.gif"></td>
<td><a href="./"><img width=32 height=32 align=bottom border=0 alt="up"
 src="icons/up.gif"></A></td>
<td><img width=32 height=32 align=bottom border=0 alt=""
 src="icons/blank.gif"></A></td>
<td align=center bgcolor="#99CCFF" width="100%">
 <b class=title>Global Module Index</b></td>
<td><img width=32 height=32 align=bottom border=0 alt=""
 src="icons/blank.gif"></td>
<td><img width=32 height=32 align=bottom border=0 alt=""
 src="icons/blank.gif"></td>
<td><img width=32 height=32 align=bottom border=0 alt=""
 src="icons/blank.gif"></td>
</tr></table>
<b class=navlabel>Up:</b> <span class=sectref><A
 HREF="./">Python Documentation Index</A></span>
</div>
<!--End of Navigation Panel-->
<ADDRESS>
<hr>Send comments to
<a href="mailto:python-docs@python.org">python-docs@python.org</a>.
</ADDRESS>
</BODY>
</HTML>
"""


if __name__ == "__main__":
    main()