indfix.py 2.27 KB
Newer Older
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
#! /usr/bin/env python

"""Combine similar index entries into an entry and subentries.

For example:

    \item {foobar} (in module flotz), 23
    \item {foobar} (in module whackit), 4323

becomes

    \item {foobar}
      \subitem in module flotz, 23
      \subitem in module whackit, 4323

Note that an item which matches the format of a collapsable item but which
isn't part of a group of similar items is not modified.
"""
__version__ = '$Revision$'

import re
import string
import StringIO
import sys


Fred Drake's avatar
Fred Drake committed
27
def cmp_entries(e1, e2, lower=string.lower):
28 29 30
    return cmp(lower(e1[1]), lower(e2[1])) or cmp(e1, e2)


Fred Drake's avatar
Fred Drake committed
31
def dump_entries(write, entries):
32
    if len(entries) == 1:
Fred Drake's avatar
Fred Drake committed
33 34
        write("  \\item %s (%s)%s\n" % entries[0])
        return
Fred Drake's avatar
Fred Drake committed
35
    write("  \item %s\n" % entries[0][0])
36
    # now sort these in a case insensitive manner:
Fred Drake's avatar
Fred Drake committed
37
    if len(entries) > 0:
Fred Drake's avatar
Fred Drake committed
38
        entries.sort(cmp_entries)
39
    for xxx, subitem, pages in entries:
Fred Drake's avatar
Fred Drake committed
40
        write("    \subitem %s%s\n" % (subitem, pages))
41 42


43 44
breakable_re = re.compile(
    r"  \\item (.*) [(](.*)[)]((?:(?:, \d+)|(?:, \\[a-z]*\{\d+\}))+)")
45

46 47 48 49

def process(ifn, ofn=None):
    if ifn == "-":
        ifp = sys.stdin
50
    else:
51 52 53
        ifp = open(ifn)
    if ofn is None:
        ofn = ifn
54 55
    ofp = StringIO.StringIO()
    entries = []
Fred Drake's avatar
Fred Drake committed
56 57
    match = breakable_re.match
    write = ofp.write
58
    while 1:
Fred Drake's avatar
Fred Drake committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
        line = ifp.readline()
        if not line:
            break
        m = match(line)
        if m:
            entry = m.group(1, 2, 3)
            if entries and entries[-1][0] != entry[0]:
                dump_entries(write, entries)
                entries = []
            entries.append(entry)
        elif entries:
            dump_entries(write, entries)
            entries = []
            write(line)
        else:
            write(line)
Fred Drake's avatar
Fred Drake committed
75 76
    del write
    del match
77 78 79 80
    ifp.close()
    data = ofp.getvalue()
    ofp.close()
    if ofn == "-":
Fred Drake's avatar
Fred Drake committed
81
        ofp = sys.stdout
82
    else:
Fred Drake's avatar
Fred Drake committed
83
        ofp = open(ofn, "w")
84 85 86 87 88 89 90 91 92
    ofp.write(data)
    ofp.close()


def main():
    import getopt
    outfile = None
    opts, args = getopt.getopt(sys.argv[1:], "o:")
    for opt, val in opts:
Fred Drake's avatar
Fred Drake committed
93 94
        if opt in ("-o", "--output"):
            outfile = val
95 96 97
    filename = args[0]
    outfile = outfile or filename
    process(filename, outfile)
98 99 100 101


if __name__ == "__main__":
    main()