Merge remote-tracking branch 'origin/master' into 0.11

[platform/upstream/gst-common.git] / mangle-tmpl.py

diff --git a/mangle-tmpl.py b/mangle-tmpl.py
index 2c90f9d..bd4f948 100644 (file)
--- a/mangle-tmpl.py
+++ b/mangle-tmpl.py
@@ -6,15 +6,20 @@ use the output from gst-xmlinspect.py to mangle tmpl/*.sgml and
 insert/overwrite Short Description and Long Description
 """
 
+# FIXME: right now it uses pygst and scans on its own;
+# we really should use inspect/*.xml instead since the result of
+# gst-xmlinspect.py is committed by the docs maintainer, who can be
+# expected to have pygst, but this step should be done for every docs build,
+# so no pygst allowed
+
+# read in inspect/*.xml
+# for every tmpl/element-(name).xml: mangle with details from element
+
 import glob
 import re
 import sys
 import os
 
-import pygst
-pygst.require('0.9')
-import gst
-
 class Tmpl:
     def __init__(self, filename):
         self.filename = filename
@@ -77,31 +82,78 @@ class Tmpl:
         handle = open(self.filename, "w")
         handle.write(self.output())
         handle.close()
-        
+
+import xml.dom.minidom
+
+def get_elements(file):
+    elements = {}
+    doc = xml.dom.minidom.parse(file)
+
+    elem = None
+    for e in doc.childNodes:
+        if e.nodeType == e.ELEMENT_NODE and e.localName == 'plugin':
+            elem = e
+            break
+    if elem == None:
+        return None
+
+    elem2 = None
+    for e in elem.childNodes:
+        if e.nodeType == e.ELEMENT_NODE and e.localName == 'elements':
+            elem2 = e
+            break
+    if elem2 == None:
+        return None
+
+    elem = elem2
+
+    for e in elem.childNodes:
+        if e.nodeType == e.ELEMENT_NODE and e.localName == 'element':
+            name = None
+            description = None
+
+            for e2 in e.childNodes:
+                if e2.nodeType == e2.ELEMENT_NODE and e2.localName == 'name':
+                    name = e2.childNodes[0].nodeValue.encode("UTF-8")
+                elif e2.nodeType == e2.ELEMENT_NODE and e2.localName == 'description':
+                    if e2.childNodes:
+                      description = e2.childNodes[0].nodeValue.encode("UTF-8")
+                    else:
+                      description = 'No description'
+
+            if name != None and description != None:
+                elements[name] = {'description': description}
+
+    return elements
+
 def main():
-    if len(sys.argv) > 1 and sys.argv[1]:
-        os.chdir(sys.argv[1])
+    if not len(sys.argv) == 3:
+        sys.stderr.write('Please specify the inspect/ dir and the tmpl/ dir')
+        sys.exit(1)
 
+    inspectdir = sys.argv[1]
+    tmpldir = sys.argv[2]
+
+    # parse all .xml files; build map of element name -> short desc
+    #for file in glob.glob("inspect/plugin-*.xml"):
     elements = {}
-    all = gst.registry_pool_plugin_list()
-    for plugin in all:
-        for feature in plugin.get_feature_list():
-            if isinstance(feature, gst.ElementFactory):
-                elements[feature.get_name()] = feature
-                
-    for file in glob.glob("element-*.sgml"):
+    for file in glob.glob("%s/plugin-*.xml" % inspectdir):
+        elements.update(get_elements(file))
+
+    for file in glob.glob("%s/element-*.sgml" % tmpldir):
         base = os.path.basename(file)
         element = base[len("element-"):-len(".sgml")]
         tmpl = Tmpl(file)
         tmpl.read()
         if element in elements.keys():
-            feature = elements[element]
-            description = feature.get_description()
+            description = elements[element]['description']
             tmpl.set_section("Short_Description", "%s\n\n" % description)
 
         # put in an include if not yet there
         line = '<include xmlns="http://www.w3.org/2003/XInclude" href="' + \
-            'element-' + element + '-details.xml" />\n'
+            'element-' + element + '-details.xml">' + \
+            '<fallback xmlns="http://www.w3.org/2003/XInclude" />' + \
+            '</include>\n'
         section = tmpl.get_section("Long_Description")
         if not section[0]  == line:
             section.insert(0, line)