Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 1 | #! /usr/bin/env python |
| 2 | # -*- Python -*- |
| 3 | |
Fred Drake | 5f7832d | 1999-03-04 21:19:57 +0000 | [diff] [blame] | 4 | """usage: %(program)s [options] file... |
| 5 | |
| 6 | Supported options: |
| 7 | |
| 8 | --address addr |
| 9 | -a addr Set the address text to include at the end of the generated |
| 10 | HTML; this should be used for contact information. |
| 11 | --columns cols |
| 12 | -c cols Set the number of columns each index section should be |
| 13 | displayed in. The default is 1. |
| 14 | --help |
| 15 | -h Display this help message. |
| 16 | --letters |
| 17 | -l Split the output into sections by letter. |
| 18 | --output file |
| 19 | -o file Write output to 'file' instead of standard out. |
| 20 | --iconserver is Use 'is' as the directory containing icons for the |
| 21 | navigation bar. The default is 'icons'. |
| 22 | --title str Set the page title to 'str'. The default is 'Global |
| 23 | Module Index'. |
| 24 | --uplink url Set the upward link URL. The default is './'. |
| 25 | --uptitle str Set the upward link title. The default is 'Python |
| 26 | Documentation Index'. |
| 27 | """ |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 28 | import buildindex |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 29 | import os |
| 30 | import re |
| 31 | import string |
Fred Drake | 01a110b | 2000-10-05 05:14:26 +0000 | [diff] [blame] | 32 | import support |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 33 | import sys |
| 34 | |
| 35 | |
Fred Drake | 01a110b | 2000-10-05 05:14:26 +0000 | [diff] [blame] | 36 | class IndexOptions(support.Options): |
| 37 | def __init__(self): |
| 38 | support.Options.__init__(self) |
| 39 | self.add_args("l", ["letters"]) |
| 40 | self.letters = 0 |
Fred Drake | 5f7832d | 1999-03-04 21:19:57 +0000 | [diff] [blame] | 41 | |
Fred Drake | 01a110b | 2000-10-05 05:14:26 +0000 | [diff] [blame] | 42 | def handle_option(self, opt, val): |
| 43 | if opt in ("-l", "--letters"): |
| 44 | self.letters = 1 |
Fred Drake | 5f7832d | 1999-03-04 21:19:57 +0000 | [diff] [blame] | 45 | |
Fred Drake | 01a110b | 2000-10-05 05:14:26 +0000 | [diff] [blame] | 46 | def usage(self): |
| 47 | program = os.path.basename(sys.argv[0]) |
| 48 | print __doc__ % {"program": program} |
Fred Drake | 5f7832d | 1999-03-04 21:19:57 +0000 | [diff] [blame] | 49 | |
| 50 | |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 51 | _rx = re.compile( |
Fred Drake | ba82878 | 2000-04-03 04:19:14 +0000 | [diff] [blame] | 52 | "<dt><a href='(module-.*\.html)#l2h-\d+'><tt class='module'>" |
| 53 | "([a-zA-Z_][a-zA-Z0-9_.]*</tt>(\s*<em>" |
| 54 | "\(<span class='platform'>.*</span>\)</em>)?)</a>") |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 55 | |
| 56 | def main(): |
Fred Drake | 01a110b | 2000-10-05 05:14:26 +0000 | [diff] [blame] | 57 | options = IndexOptions() |
| 58 | options.variables["title"] = "Global Module Index" |
| 59 | options.parse(sys.argv[1:]) |
| 60 | args = options.args |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 61 | if not args: |
| 62 | args = ["-"] |
| 63 | # |
| 64 | # Collect the input data: |
| 65 | # |
| 66 | nodes = [] |
| 67 | seqno = 0 |
Fred Drake | 7f492ad | 1999-03-02 16:22:56 +0000 | [diff] [blame] | 68 | has_plat_flag = 0 |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 69 | for ifn in args: |
| 70 | if ifn == "-": |
| 71 | ifp = sys.stdin |
| 72 | dirname = '' |
| 73 | else: |
| 74 | ifp = open(ifn) |
| 75 | dirname = os.path.dirname(ifn) |
| 76 | while 1: |
| 77 | line = ifp.readline() |
| 78 | if not line: |
| 79 | break |
| 80 | m = _rx.match(line) |
| 81 | if m: |
| 82 | # This line specifies a module! |
| 83 | basename, modname = m.group(1, 2) |
Fred Drake | 7f492ad | 1999-03-02 16:22:56 +0000 | [diff] [blame] | 84 | has_plat_flag = has_plat_flag or m.group(3) |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 85 | linkfile = os.path.join(dirname, basename) |
Fred Drake | 7f492ad | 1999-03-02 16:22:56 +0000 | [diff] [blame] | 86 | nodes.append(buildindex.Node( |
| 87 | '<a href="%s">' % linkfile, |
| 88 | "<tt class=module>%s</tt>" % modname, |
| 89 | seqno)) |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 90 | seqno = seqno + 1 |
| 91 | ifp.close() |
Fred Drake | 7f492ad | 1999-03-02 16:22:56 +0000 | [diff] [blame] | 92 | # |
| 93 | # Generate all output: |
| 94 | # |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 95 | num_nodes = len(nodes) |
Fred Drake | 7f492ad | 1999-03-02 16:22:56 +0000 | [diff] [blame] | 96 | # Here's the HTML generation: |
Fred Drake | 01a110b | 2000-10-05 05:14:26 +0000 | [diff] [blame] | 97 | parts = [options.get_header(), |
| 98 | buildindex.process_nodes(nodes, options.columns, options.letters), |
| 99 | options.get_footer(), |
Fred Drake | 5f7832d | 1999-03-04 21:19:57 +0000 | [diff] [blame] | 100 | ] |
Fred Drake | 7f492ad | 1999-03-02 16:22:56 +0000 | [diff] [blame] | 101 | if has_plat_flag: |
| 102 | parts.insert(1, PLAT_DISCUSS) |
| 103 | html = string.join(parts, '') |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 104 | program = os.path.basename(sys.argv[0]) |
Fred Drake | 01a110b | 2000-10-05 05:14:26 +0000 | [diff] [blame] | 105 | fp = options.get_output_file() |
| 106 | print >>fp, html.rstrip() |
| 107 | if options.outputfile == "-": |
| 108 | print >>sys.stderr, "%s: %d index nodes" % (program, num_nodes) |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 109 | else: |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 110 | print |
| 111 | print "%s: %d index nodes" % (program, num_nodes) |
| 112 | |
| 113 | |
Fred Drake | 7f492ad | 1999-03-02 16:22:56 +0000 | [diff] [blame] | 114 | PLAT_DISCUSS = """ |
| 115 | <p> Some module names are followed by an annotation indicating what |
| 116 | platform they are available on.</p> |
| 117 | |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 118 | """ |
| 119 | |
Fred Drake | 2ef38a7 | 1999-02-24 17:33:07 +0000 | [diff] [blame] | 120 | |
| 121 | if __name__ == "__main__": |
| 122 | main() |