tools/make-man-index.py

   1 #!/usr/bin/env python3
   2 #  -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
   3 # SPDX-License-Identifier: LGPL-2.1+
   4 #
   5 #  Copyright © 2013 Zbigniew Jędrzejewski-Szmek
   6
   7 import collections
   8 import sys
   9 import re
  10 from xml_helper import xml_parse, xml_print, tree
  11
  12 MDASH = ' — ' if sys.version_info.major >= 3 else ' -- '
  13
  14 TEMPLATE = '''\
  15 <refentry id="systemd.index" conditional="HAVE_PYTHON">
  16
  17   <refentryinfo>
  18     <title>systemd.index</title>
  19     <productname>systemd</productname>
  20   </refentryinfo>
  21
  22   <refmeta>
  23     <refentrytitle>systemd.index</refentrytitle>
  24     <manvolnum>7</manvolnum>
  25   </refmeta>
  26
  27   <refnamediv>
  28     <refname>systemd.index</refname>
  29     <refpurpose>List all manpages from the systemd project</refpurpose>
  30   </refnamediv>
  31 </refentry>
  32 '''
  33
  34 SUMMARY = '''\
  35   <refsect1>
  36     <title>See Also</title>
  37     <para>
  38       <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  39     </para>
  40
  41     <para id='counts' />
  42   </refsect1>
  43 '''
  44
  45 COUNTS = '\
  46 This index contains {count} entries, referring to {pages} individual manual pages.'
  47
  48
  49 def check_id(page, t):
  50     id = t.getroot().get('id')
  51     if not re.search('/' + id + '[.]', page):
  52         raise ValueError("id='{}' is not the same as page name '{}'".format(id, page))
  53
  54 def make_index(pages):
  55     index = collections.defaultdict(list)
  56     for p in pages:
  57         t = xml_parse(p)
  58         check_id(p, t)
  59         section = t.find('./refmeta/manvolnum').text
  60         refname = t.find('./refnamediv/refname').text
  61         purpose = ' '.join(t.find('./refnamediv/refpurpose').text.split())
  62         for f in t.findall('./refnamediv/refname'):
  63             infos = (f.text, section, purpose, refname)
  64             index[f.text[0].upper()].append(infos)
  65     return index
  66
  67 def add_letter(template, letter, pages):
  68     refsect1 = tree.SubElement(template, 'refsect1')
  69     title = tree.SubElement(refsect1, 'title')
  70     title.text = letter
  71     para = tree.SubElement(refsect1, 'para')
  72     for info in sorted(pages, key=lambda info: str.lower(info[0])):
  73         refname, section, purpose, realname = info
  74
  75         b = tree.SubElement(para, 'citerefentry')
  76         c = tree.SubElement(b, 'refentrytitle')
  77         c.text = refname
  78         d = tree.SubElement(b, 'manvolnum')
  79         d.text = section
  80
  81         b.tail = MDASH + purpose # + ' (' + p + ')'
  82
  83         tree.SubElement(para, 'sbr')
  84
  85 def add_summary(template, indexpages):
  86     count = 0
  87     pages = set()
  88     for group in indexpages:
  89         count += len(group)
  90         for info in group:
  91             refname, section, purpose, realname = info
  92             pages.add((realname, section))
  93
  94     refsect1 = tree.fromstring(SUMMARY)
  95     template.append(refsect1)
  96
  97     para = template.find(".//para[@id='counts']")
  98     para.text = COUNTS.format(count=count, pages=len(pages))
  99
 100 def make_page(*xml_files):
 101     template = tree.fromstring(TEMPLATE)
 102     index = make_index(xml_files)
 103
 104     for letter in sorted(index):
 105         add_letter(template, letter, index[letter])
 106
 107     add_summary(template, index.values())
 108
 109     return template
 110
 111 if __name__ == '__main__':
 112     with open(sys.argv[1], 'wb') as f:
 113         f.write(xml_print(make_page(*sys.argv[2:])))