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 import collections
   6 import sys
   7 import re
   8 from xml_helper import xml_parse, xml_print, tree
   9
  10 MDASH = ' — ' if sys.version_info.major >= 3 else ' -- '
  11
  12 TEMPLATE = '''\
  13 <refentry id="elogind.index" conditional="HAVE_PYTHON">
  14
  15   <refentryinfo>
  16     <title>elogind.index</title>
  17     <productname>elogind</productname>
  18
  19     <authorgroup>
  20       <author>
  21         <contrib>Developer</contrib>
  22         <firstname>Lennart</firstname>
  23         <surname>Poettering</surname>
  24         <email>lennart@poettering.net</email>
  25       </author>
  26       <!-- 1 /// Must add elogind authors for the additions and changes -->
  27       <author>
  28         <contrib>Developer</contrib>
  29         <firstname>Sven</firstname>
  30         <surname>Eden</surname>
  31         <email>sven.eden@gmx.de</email>
  32       </author>
  33       <!-- // 1 -->
  34     </authorgroup>
  35   </refentryinfo>
  36
  37   <refmeta>
  38     <refentrytitle>elogind.index</refentrytitle>
  39     <manvolnum>7</manvolnum>
  40   </refmeta>
  41
  42   <refnamediv>
  43     <refname>elogind.index</refname>
  44     <refpurpose>List all manpages from the elogind project</refpurpose>
  45   </refnamediv>
  46 </refentry>
  47 '''
  48
  49 SUMMARY = '''\
  50   <refsect1>
  51     <title>See Also</title>
  52     <para>
  53       <citerefentry><refentrytitle>elogind.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  54     </para>
  55
  56     <para id='counts' />
  57   </refsect1>
  58 '''
  59
  60 COUNTS = '\
  61 This index contains {count} entries, referring to {pages} individual manual pages.'
  62
  63
  64 def check_id(page, t):
  65     id = t.getroot().get('id')
  66     if not re.search('/' + id + '[.]', page):
  67         raise ValueError("id='{}' is not the same as page name '{}'".format(id, page))
  68
  69 def make_index(pages):
  70     index = collections.defaultdict(list)
  71     for p in pages:
  72         t = xml_parse(p)
  73         check_id(p, t)
  74         section = t.find('./refmeta/manvolnum').text
  75         refname = t.find('./refnamediv/refname').text
  76         purpose = ' '.join(t.find('./refnamediv/refpurpose').text.split())
  77         for f in t.findall('./refnamediv/refname'):
  78             infos = (f.text, section, purpose, refname)
  79             index[f.text[0].upper()].append(infos)
  80     return index
  81
  82 def add_letter(template, letter, pages):
  83     refsect1 = tree.SubElement(template, 'refsect1')
  84     title = tree.SubElement(refsect1, 'title')
  85     title.text = letter
  86     para = tree.SubElement(refsect1, 'para')
  87     for info in sorted(pages, key=lambda info: str.lower(info[0])):
  88         refname, section, purpose, realname = info
  89
  90         b = tree.SubElement(para, 'citerefentry')
  91         c = tree.SubElement(b, 'refentrytitle')
  92         c.text = refname
  93         d = tree.SubElement(b, 'manvolnum')
  94         d.text = section
  95
  96         b.tail = MDASH + purpose # + ' (' + p + ')'
  97
  98         tree.SubElement(para, 'sbr')
  99
 100 def add_summary(template, indexpages):
 101     count = 0
 102     pages = set()
 103     for group in indexpages:
 104         count += len(group)
 105         for info in group:
 106             refname, section, purpose, realname = info
 107             pages.add((realname, section))
 108
 109     refsect1 = tree.fromstring(SUMMARY)
 110     template.append(refsect1)
 111
 112     para = template.find(".//para[@id='counts']")
 113     para.text = COUNTS.format(count=count, pages=len(pages))
 114
 115 def make_page(*xml_files):
 116     template = tree.fromstring(TEMPLATE)
 117     index = make_index(xml_files)
 118
 119     for letter in sorted(index):
 120         add_letter(template, letter, index[letter])
 121
 122     add_summary(template, index.values())
 123
 124     return template
 125
 126 if __name__ == '__main__':
 127     with open(sys.argv[1], 'wb') as f:
 128         f.write(xml_print(make_page(*sys.argv[2:])))