build-aux/xml2nroff

   1 #! /usr/bin/python
   2
   3 # Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015 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   --version=VERSION           use VERSION to display on document footer
  38   -h, --help                  display this help message\
  39 """ % {'argv0': argv0}
  40     sys.exit(0)
  41
  42
  43 def manpage_to_nroff(xml_file, subst, version=None):
  44     with open(xml_file) as f:
  45         content = f.read()
  46     for k, v in subst.iteritems():
  47         content = content.replace(k, v)
  48     doc = xml.dom.minidom.parseString(content).documentElement
  49
  50     if version is None:
  51         version = "UNKNOWN"
  52     program = doc.attributes['program'].nodeValue
  53     title = doc.attributes['title'].nodeValue
  54     section = doc.attributes['section'].nodeValue
  55
  56     # Putting '\" p as the first line tells "man" that the manpage
  57     # needs to be preprocessed by "pic".
  58     s = r''''\" p
  59 .\" -*- nroff -*-
  60 .TH "%s" %s "%s" "Open vSwitch %s" "Open vSwitch Manual"
  61 .fp 5 L CR              \\" Make fixed-width font available as \\fL.
  62 .de TQ
  63 .  br
  64 .  ns
  65 .  TP "\\$1"
  66 ..
  67 .de ST
  68 .  PP
  69 .  RS -0.15in
  70 .  I "\\$1"
  71 .  RE
  72 ..
  73 ''' % (build.nroff.text_to_nroff(program), build.nroff.text_to_nroff(section),
  74        build.nroff.text_to_nroff(title), build.nroff.text_to_nroff(version))
  75
  76     s += build.nroff.block_xml_to_nroff(doc.childNodes) + "\n"
  77
  78     return s
  79
  80
  81 if __name__ == "__main__":
  82     try:
  83         options, args = getopt.gnu_getopt(sys.argv[1:], 'hV',
  84                                           ['version=', 'help'])
  85     except getopt.GetoptError, geo:
  86         sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
  87         sys.exit(1)
  88
  89     er_diagram = None
  90     title = None
  91     version = None
  92     for key, value in options:
  93         if key == '--version':
  94             version = value
  95         elif key in ['-h', '--help']:
  96             usage()
  97         else:
  98             sys.exit(0)
  99
 100     if len(args) < 1:
 101         sys.stderr.write("%s: exactly 1 non-option arguments required "
 102                          "(use --help for help)\n" % argv0)
 103         sys.exit(1)
 104
 105     subst = {}
 106     for s in args[1:]:
 107         var, value = s.split('=', 1)
 108         value = value.replace('&', '&amp;')
 109         value = value.replace('<', '&lt;')
 110         value = value.replace('>', '&gt;')
 111         value = value.replace('"', '&quot;')
 112         value = value.replace("'", '&apos;')
 113         subst['@%s@' % var] = value
 114
 115     try:
 116         s = manpage_to_nroff(args[0], subst, version)
 117     except build.nroff.error.Error, e:
 118         sys.stderr.write("%s: %s\n" % (argv0, e.msg))
 119         sys.exit(1)
 120     for line in s.splitlines():
 121         line = line.strip()
 122         if line:
 123             print line
 124
 125
 126 # Local variables:
 127 # mode: python
 128 # End: