docs/doxygen/doxymlparser.py

   1 """
   2 Name: doxymlparser.py
   3 Author: Kevin Ollivier
   4 License: wxWidgets License
   5 """
   6
   7 __description__ = """
   8 Takes the output of Doxygen XML and parses it to retrieve metadata about the classes and methods.
   9
  10 To create the Doxygen XML files, from the wxWidgets/docs/doxygen directory, do:
  11
  12 ./regen.sh xml
  13
  14 To see the results from parsing a particular class, do:
  15
  16 python doxymlparser.py --report out/xml/classwx_<whatever>.xml
  17 """
  18
  19 #!/usr/bin/env python
  20 import optparse
  21 import os
  22 import string
  23
  24 import sys
  25 import types
  26 from xml.dom import minidom
  27
  28 option_dict = {
  29             "report"        : (False, "Print out the classes and methods found by this script."),
  30             "verbose"       : (False, "Provide status updates and other information."),
  31           }
  32
  33 parser = optparse.OptionParser(usage="usage: %prog [options] <doxyml files to parse>\n" + __description__, version="%prog 1.0")
  34
  35 for opt in option_dict:
  36     default = option_dict[opt][0]
  37
  38     action = "store"
  39     if type(default) == types.BooleanType:
  40         action = "store_true"
  41     parser.add_option("--" + opt, default=default, action=action, dest=opt, help=option_dict[opt][1])
  42
  43 options, arguments = parser.parse_args()
  44
  45 class ClassDefinition:
  46     def __init__(self):
  47         self.name = ""
  48         self.constructors = []
  49         self.destructors = []
  50         self.methods = []
  51         self.brief_description = ""
  52         self.detailed_description = ""
  53         self.includes = []
  54         self.bases = []
  55         self.enums = {}
  56
  57     def __str__(self):
  58         str_repr = """
  59 Class: %s
  60 Bases: %s
  61 Includes: %s
  62 Brief Description:
  63 %s
  64
  65 Detailed Description:
  66 %s
  67 """ % (self.name, string.join(self.bases, ", "), self.includes, self.brief_description, self.detailed_description)
  68         str_repr += "Methods:\n"
  69
  70         for method in self.methods:
  71             str_repr += str(method)
  72
  73         return str_repr
  74
  75 class MethodDefinition:
  76     def __init__(self):
  77         self.name = ""
  78         self.return_type = ""
  79         self.argsstring = ""
  80         self.definition = ""
  81         self.params = []
  82         self.brief_description = ""
  83         self.detailed_description = ""
  84
  85     def __str__(self):
  86         str_repr = """
  87 Method: %s
  88 Return Type: %s
  89 Params: %r
  90 Prototype: %s
  91 Brief Description:
  92 %s
  93
  94 Detailed Description:
  95 %s
  96 """ % (self.name, self.return_type, self.params, self.definition + self.argsstring, self.brief_description, self.detailed_description)
  97         return str_repr
  98
  99 def getTextValue(node, recursive=False):
 100     text = ""
 101     for child in node.childNodes:
 102         if child.nodeType == child.ELEMENT_NODE and child.nodeName == "ref":
 103             text += getTextValue(child)
 104         if child.nodeType == child.TEXT_NODE:
 105             # Add a space to ensure we have a space between qualifiers and parameter names
 106             text += child.nodeValue.strip() + " "
 107
 108     return text.strip()
 109
 110 def doxyMLToText(node):
 111     return text
 112
 113 class DoxyMLParser:
 114     def __init__(self):
 115         self.classes = []
 116
 117     def parse(self, filename):
 118         self.xmldoc = minidom.parse(filename).documentElement
 119         for node in self.xmldoc.getElementsByTagName("compounddef"):
 120             new_class = self.parse_class(node)
 121             self.classes.append(new_class)
 122             self.get_enums_and_functions(filename, new_class)
 123
 124     def parse_class(self, class_node):
 125         new_class = ClassDefinition()
 126         new_class.name = getTextValue(class_node.getElementsByTagName("compoundname")[0])
 127         for node in class_node.childNodes:
 128             if node.nodeName == "basecompoundref":
 129                 new_class.bases.append(getTextValue(node))
 130             elif node.nodeName == "briefdescription":
 131                 # let the post-processor determ
 132                 new_class.brief_description = node.toxml()
 133             elif node.nodeName == "detaileddescription":
 134                 new_class.detailed_description = node.toxml()
 135             elif node.nodeName == "includes":
 136                 new_class.includes.append(getTextValue(node))
 137
 138         self.parse_methods(new_class, class_node)
 139
 140         return new_class
 141
 142     def get_enums_and_functions(self, filename, aclass):
 143         file_path = os.path.dirname(filename)
 144         enum_filename = os.path.join(file_path, aclass.name[2:] + "_8h.xml")
 145         if os.path.exists(enum_filename):
 146             root = minidom.parse(enum_filename).documentElement
 147             for method in root.getElementsByTagName("memberdef"):
 148                 if method.getAttribute("kind") == "enum":
 149                     self.parse_enum(aclass, method, root)
 150
 151     def parse_enum(self, new_class, enum, root):
 152         enum_name = ""
 153         enum_values = []
 154
 155         for node in enum.childNodes:
 156             if node.nodeName == "name":
 157                 enum_name = getTextValue(node)
 158             elif node.nodeName == "enumvalue":
 159                 enum_values.append(getTextValue(node.getElementsByTagName("name")[0]))
 160
 161         new_class.enums[enum_name] = enum_values
 162
 163     def parse_methods(self, new_class, root):
 164         for method in root.getElementsByTagName("memberdef"):
 165             new_method = MethodDefinition()
 166             for node in method.childNodes:
 167                 if node.nodeName == "name":
 168                     new_method.name = getTextValue(node)
 169                 elif node.nodeName == "type":
 170                     new_method.return_type = getTextValue(node)
 171                 elif node.nodeName == "definition":
 172                     new_method.definition = getTextValue(node)
 173                 elif node.nodeName == "argsstring":
 174                     new_method.argsstring = getTextValue(node)
 175                 elif node.nodeName == "param":
 176                     param = {}
 177                     for child in node.childNodes:
 178                         if child.nodeType == child.ELEMENT_NODE:
 179                             param[child.nodeName] = getTextValue(child)
 180                     new_method.params.append(param)
 181
 182             if options.verbose:
 183                 print "Adding %s" % (new_method.name + new_method.argsstring)
 184
 185             if new_method.name == new_class.name:
 186                 new_class.constructors.append(new_method)
 187             elif new_method.name == "~" + new_class.name:
 188                 new_class.destructors.append(new_method)
 189             else:
 190                 new_class.methods.append(new_method)
 191
 192 if __name__ == "__main__":
 193     if len(arguments) < 1:
 194         parser.print_usage()
 195         sys.exit(1)
 196
 197     doxyparse = DoxyMLParser()
 198     for arg in arguments:
 199         doxyparse.parse(arg)
 200
 201     if options.report:
 202         for aclass in doxyparse.classes:
 203             print str(aclass)
 204