Re #6630. Refactor minidom stuff.

mantidproject · Mar 5, 2013 · e30c297 · e30c297
1 parent 92794a9
commit e30c297
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 25 deletions.
diff --git a/Code/Mantid/docs/qtassistant/assistant_common.py b/Code/Mantid/docs/qtassistant/assistant_common.py
@@ -23,3 +23,20 @@ def assertDirs(outputdir, verbose=False):
             if verbose:
                 print "creating '%s'" % direc
             os.makedirs(direc)
+
+def addEle(doc, parent, tag, attrs={}):
+    """Assumes that the 'doc' that comes in is a xml.dom.minidom.Document
+    """
+    ele = doc.createElement(tag)
+    for key in attrs.keys():
+        ele.setAttribute(key, attrs[key])
+    parent.appendChild(ele)
+    return ele
+
+def addTxtEle(doc, parent, tag, text, attrs={}):
+    """Assumes that the 'doc' that comes in is a xml.dom.minidom.Document
+    """
+    ele = addEle(doc, parent, tag, attrs)
+    text = doc.createTextNode(text)
+    ele.appendChild(text)
+    return ele
diff --git a/Code/Mantid/docs/qtassistant/qhpfile.py b/Code/Mantid/docs/qtassistant/qhpfile.py
@@ -1,18 +1,18 @@
 #!/usr/bin/env python
 from xml.dom.minidom import Document
+from assistant_common import addEle, addTxtEle
 
 class QHPFile:
     def __init__(self, namespace, folder="doc"):
         self.__doc = Document()
-        self.__root = self.__addele(self.__doc,"QtHelpProject",
-                                    {"version":"1.0"})
-        self.__doc.appendChild(self.__root)
+        self.__root = addEle(self.__doc, self.__doc,"QtHelpProject",
+                             {"version":"1.0"})
 
-        self.__addtxtele(self.__root, "namespace", namespace)
-        self.__addtxtele(self.__root, "virtualFolder", folder)
+        addTxtEle(self.__doc, self.__root, "namespace", namespace)
+        addTxtEle(self.__doc, self.__root, "virtualFolder", folder)
 
 
-        self.__filterSect =  self.__addele(self.__root, "filterSection")
+        self.__filterSect =  addEle(self.__doc, self.__root, "filterSection")
 
         self.__keywordsEle = None # should have 'keywords' section
         self.__keywords = []
@@ -32,33 +32,20 @@ def addTOC(self, contents):
     def addFile(self, filename, keyword=None):
         if not keyword is None:
             if self.__keywordsEle is None:
-                self.__keywordsEle = self.__addele(self.__filterSect, "keywords")
+                self.__keywordsEle = addEle(self.__doc, self.__filterSect,
+                                            "keywords")
             if not keyword in self.__keywords:
-                self.__addele(self.__keywordsEle, "keyword",
-                              {"name":keyword, "ref":filename})
+                addEle(self.__doc, self.__keywordsEle, "keyword",
+                       {"name":keyword, "ref":filename})
                 self.__keywords.append(keyword)
         if self.__filesEle is None:
-            self.__filesEle = self.__addele(self.__filterSect, "files")
+            self.__filesEle = addEle(self.__doc, self.__filterSect, "files")
         if not filename in self.__files:
-            self.__addtxtele(self.__filesEle, "file", filename)
+            addTxtEle(self.__doc, self.__filesEle, "file", filename)
             self.__files.append(filename)
 
-    def __addtxtele(self, parent, tag, text):
-        ele = self.__addele(parent, tag)
-        text = self.__doc.createTextNode(text)
-        ele.appendChild(text)
-        return ele
-
-    def __addele(self, parent, tag, attrs={}):
-        ele = self.__doc.createElement(tag)
-        for key in attrs.keys():
-            ele.setAttribute(key, attrs[key])
-        parent.appendChild(ele)
-        return ele
-
     def __str__(self):
         return self.__doc.toprettyxml(indent="  ")
-    #xml_declaration=True)
 
     def write(self, filename):
         """