build-aux/xml2nroff

   1 #! /usr/bin/python
   2
   3 # Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
   4 #
   5 # Licensed under the Apache License, Version 2.0 (the "License");
   6 # you may not use this file except in compliance with the License.
   7 # You may obtain a copy of the License at:
   8 #
   9 #     http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing, software
  12 # distributed under the License is distributed on an "AS IS" BASIS,
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16
  17 import getopt
  18 import sys
  19 import xml.dom.minidom
  20
  21 import build.nroff
  22
  23 argv0 = sys.argv[0]
  24
  25
  26 def usage():
  27     print("""\
  28 %(argv0)s: XML to nroff converter
  29 Converts the XML format supplied as input into an nroff-formatted manpage.
  30 usage: %(argv0)s [OPTIONS] INPUT.XML [VAR=VALUE]...
  31 where INPUT.XML is a manpage in an OVS-specific XML format.
  32
  33 Each VAR, when enclosed by "@"s in the input, is replaced by its
  34 corresponding VALUE, with characters &<>"' in VALUE escaped.
  35
  36 The following options are also available:
  37   -I, --include=DIR           search DIR for include files (default: .)
  38   --version=VERSION           use VERSION to display on document footer
  39   -h, --help                  display this help message\
  40 """ % {'argv0': argv0})
  41     sys.exit(0)
  42
  43
  44 def manpage_to_nroff(xml_file, subst, include_path, version=None):
  45     with open(xml_file) as f:
  46         content = f.read()
  47     for k, v in subst.items():
  48         content = content.replace(k, v)
  49     doc = xml.dom.minidom.parseString(content).documentElement
  50
  51     xi_nodes = doc.getElementsByTagName("xi:include")
  52     for node in xi_nodes:
  53         fn = node.getAttribute("href")
  54         content = None
  55         for dir in include_path:
  56             try:
  57                 with open("%s/%s" % (dir, fn)) as xi_f:
  58                     content = xi_f.read()
  59             except IOError:
  60                 pass
  61         if not content:
  62             sys.stderr.write("%s: could not open include file %s\n"
  63                              % (argv0, fn))
  64             sys.exit(1)
  65         for k, v in subst.items():
  66             content = content.replace(k, v)
  67         xi_doc = xml.dom.minidom.parseString(content).documentElement
  68         doc.replaceChild(xi_doc, node)
  69
  70     if version is None:
  71         version = "UNKNOWN"
  72     program = doc.attributes['program'].nodeValue
  73     title = doc.attributes['title'].nodeValue
  74     section = doc.attributes['section'].nodeValue
  75
  76     # Putting '\" p as the first line tells "man" that the manpage
  77     # needs to be preprocessed by "pic".
  78     s = r''''\" p
  79 .\" -*- nroff -*-
  80 .TH "%s" %s "%s" "Open vSwitch %s" "Open vSwitch Manual"
  81 .fp 5 L CR              \\" Make fixed-width font available as \\fL.
  82 .de TQ
  83 .  br
  84 .  ns
  85 .  TP "\\$1"
  86 ..
  87 .de ST
  88 .  PP
  89 .  RS -0.15in
  90 .  I "\\$1"
  91 .  RE
  92 ..
  93 ''' % (build.nroff.text_to_nroff(program), build.nroff.text_to_nroff(section),
  94        build.nroff.text_to_nroff(title), build.nroff.text_to_nroff(version))
  95
  96     s += build.nroff.block_xml_to_nroff(doc.childNodes) + "\n"
  97
  98     return s
  99
 100
 101 if __name__ == "__main__":
 102     try:
 103         options, args = getopt.gnu_getopt(sys.argv[1:], 'hVI:',
 104                                           ['version=', 'help', 'include='])
 105     except getopt.GetoptError as geo:
 106         sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
 107         sys.exit(1)
 108
 109     er_diagram = None
 110     title = None
 111     version = None
 112     include_path = []
 113     for key, value in options:
 114         if key == '--version':
 115             version = value
 116         elif key in ['-h', '--help']:
 117             usage()
 118         elif key in ['-I', '--include']:
 119             include_path.append(value)
 120         else:
 121             sys.exit(0)
 122     if not include_path:
 123         include_path = ['.']
 124
 125     if len(args) < 1:
 126         sys.stderr.write("%s: exactly 1 non-option arguments required "
 127                          "(use --help for help)\n" % argv0)
 128         sys.exit(1)
 129
 130     subst = {}
 131     for s in args[1:]:
 132         var, value = s.split('=', 1)
 133         value = value.replace('&', '&amp;')
 134         value = value.replace('<', '&lt;')
 135         value = value.replace('>', '&gt;')
 136         value = value.replace('"', '&quot;')
 137         value = value.replace("'", '&apos;')
 138         subst['@%s@' % var] = value
 139
 140     try:
 141         s = manpage_to_nroff(args[0], subst, include_path, version)
 142     except build.nroff.error.Error as e:
 143         sys.stderr.write("%s: %s\n" % (argv0, e.msg))
 144         sys.exit(1)
 145     for line in s.splitlines():
 146         line = line.strip()
 147         if line:
 148             print(line)
 149
 150
 151 # Local variables:
 152 # mode: python
 153 # End: