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