tools/update-man-rules.py

   1 #!/usr/bin/env python3
   2 # SPDX-License-Identifier: LGPL-2.1+
   3
   4 from __future__ import print_function
   5 import collections
   6 import sys
   7 import pprint
   8 from os.path import basename
   9 from xml_helper import xml_parse
  10
  11 def man(page, number):
  12     return '{}.{}'.format(page, number)
  13
  14 def add_rules(rules, name):
  15     xml = xml_parse(name)
  16     # print('parsing {}'.format(name), file=sys.stderr)
  17     if xml.getroot().tag != 'refentry':
  18         return
  19     conditional = xml.getroot().get('conditional') or ''
  20     rulegroup = rules[conditional]
  21     refmeta = xml.find('./refmeta')
  22     title = refmeta.find('./refentrytitle').text
  23     number = refmeta.find('./manvolnum').text
  24     refnames = xml.findall('./refnamediv/refname')
  25     target = man(refnames[0].text, number)
  26     if title != refnames[0].text:
  27         raise ValueError('refmeta and refnamediv disagree: ' + name)
  28     for refname in refnames:
  29         assert all(refname not in group
  30                    for group in rules.values()), "duplicate page name"
  31         alias = man(refname.text, number)
  32         rulegroup[alias] = target
  33         # print('{} => {} [{}]'.format(alias, target, conditional), file=sys.stderr)
  34
  35 def create_rules(xml_files):
  36     " {conditional => {alias-name => source-name}} "
  37     rules = collections.defaultdict(dict)
  38     for name in xml_files:
  39         try:
  40             add_rules(rules, name)
  41         except Exception:
  42             print("Failed to process", name, file=sys.stderr)
  43             raise
  44     return rules
  45
  46 def mjoin(files):
  47     return ' \\\n\t'.join(sorted(files) or '#')
  48
  49 MESON_HEADER = '''\
  50 # Do not edit. Generated by update-man-rules.py.
  51 # Update with:
  52 #     ninja -C build man/update-man-rules
  53 manpages = ['''
  54
  55 MESON_FOOTER = '''\
  56 ]
  57 # Really, do not edit.'''
  58
  59 def make_mesonfile(rules, dist_files):
  60     # reformat rules as
  61     # grouped = [ [name, section, [alias...], condition], ...]
  62     #
  63     # but first create a dictionary like
  64     # lists = { (name, condition) => [alias...]
  65     grouped = collections.defaultdict(list)
  66     for condition, items in rules.items():
  67         for alias, name in items.items():
  68             group = grouped[(name, condition)]
  69             if name != alias:
  70                 group.append(alias)
  71
  72     lines = [ [p[0][:-2], p[0][-1], sorted(a[:-2] for a in aliases), p[1]]
  73               for p, aliases in sorted(grouped.items()) ]
  74     return '\n'.join((MESON_HEADER, pprint.pformat(lines)[1:-1], MESON_FOOTER))
  75
  76 if __name__ == '__main__':
  77     pages = sys.argv[1:]
  78     pages = (p for p in pages
  79              if basename(p) not in {
  80                      'systemd.directives.xml',
  81                      'systemd.index.xml',
  82                      'directives-template.xml'})
  83
  84     rules = create_rules(pages)
  85     dist_files = (basename(p) for p in pages)
  86     print(make_mesonfile(rules, dist_files))