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 from datetime import date
  18 import getopt
  19 import os
  20 import sys
  21 import xml.dom.minidom
  22
  23 from build.nroff import *
  24
  25 argv0 = sys.argv[0]
  26
  27 def usage():
  28     print """\
  29 %(argv0)s: XML to nroff converter
  30 Converts the XML format supplied as input into an nroff-formatted manpage.
  31 usage: %(argv0)s [OPTIONS] INPUT.XML [VAR=VALUE]...
  32 where INPUT.XML is a manpage in an OVS-specific XML format.
  33
  34 Each VAR, when enclosed by "@"s in the input, is replaced by its
  35 corresponding VALUE, with characters &<>"' in VALUE escaped.
  36
  37 The following options are also available:
  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 def manpage_to_nroff(xml_file, subst, version=None):
  44     f = open(xml_file)
  45     input = []
  46     for line in f:
  47         for k, v in subst.iteritems():
  48             line = line.replace(k, v)
  49         input += [line]
  50     doc = xml.dom.minidom.parseString(''.join(input)).documentElement
  51     d = date.fromtimestamp(os.stat(xml_file).st_mtime)
  52
  53     if version == None:
  54         version = "UNKNOWN"
  55     program = doc.attributes['program'].nodeValue
  56     title = doc.attributes['title'].nodeValue
  57     section = doc.attributes['section'].nodeValue
  58
  59     # Putting '\" p as the first line tells "man" that the manpage
  60     # needs to be preprocessed by "pic".
  61     s = r''''\" p
  62 .\" -*- nroff -*-
  63 .TH "%s" %s "%s" "Open vSwitch %s" "Open vSwitch Manual"
  64 .fp 5 L CR              \\" Make fixed-width font available as \\fL.
  65 .de TQ
  66 .  br
  67 .  ns
  68 .  TP "\\$1"
  69 ..
  70 .de ST
  71 .  PP
  72 .  RS -0.15in
  73 .  I "\\$1"
  74 .  RE
  75 ..
  76 ''' % (text_to_nroff(program), text_to_nroff(section),
  77        text_to_nroff(title), text_to_nroff(version))
  78
  79     s += block_xml_to_nroff(doc.childNodes) + "\n"
  80
  81     return s
  82
  83
  84 if __name__ == "__main__":
  85     try:
  86         options, args = getopt.gnu_getopt(sys.argv[1:], 'hV',
  87                                           ['version=', 'help'])
  88     except getopt.GetoptError, geo:
  89         sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
  90         sys.exit(1)
  91
  92     er_diagram = None
  93     title = None
  94     version = None
  95     for key, value in options:
  96         if key == '--version':
  97             version = value
  98         elif key in ['-h', '--help']:
  99             usage()
 100         else:
 101             sys.exit(0)
 102
 103     if len(args) < 1:
 104         sys.stderr.write("%s: exactly 1 non-option arguments required "
 105                          "(use --help for help)\n" % argv0)
 106         sys.exit(1)
 107
 108     subst = {}
 109     for s in args[1:]:
 110         var, value = s.split('=', 1)
 111         value = value.replace('&', '&amp;')
 112         value = value.replace('<', '&lt;')
 113         value = value.replace('>', '&gt;')
 114         value = value.replace('"', '&quot;')
 115         value = value.replace("'", '&apos;')
 116         subst['@%s@' % var] = value
 117
 118     try:
 119         s = manpage_to_nroff(args[0], subst, version)
 120     except error.Error, e:
 121         sys.stderr.write("%s: %s\n" % (argv0, e.msg))
 122         sys.exit(1)
 123     for line in s.splitlines():
 124         line = line.strip()
 125         if line:
 126             print line
 127
 128
 129 # Local variables:
 130 # mode: python
 131 # End: