Reformulate conditional inclusions in configuration file

After review

Author: albert-github

addon/doxywizard/expert.cpp

@@ -107,15 +107,15 @@ static void translateEnumDescription(QDomElement &valueElem,const QDomElement &t
   }
 }
 
-static bool getFilter(QDomElement docsVal)
+static bool getFilter(QDomElement docsVal, QString &mode)
 {
   QString attr = docsVal.attribute(SA("filter"));
   if (attr.isEmpty()) return true;
-  if (attr.contains(SA("doxywizard"))) return true;
+  if (attr.contains(mode)) return true;
   return false;
 }
 
-static void translateOption(QDomElement &configRoot,const QDomElement &translationRoot)
+static void translateOption(QDomElement &configRoot,const QDomElement &translationRoot, QString &mode)
 {
   QDomElement docsVal   = configRoot.firstChildElement();
   QDomElement trDocsVal = translationRoot.firstChildElement();
@@ -131,7 +131,7 @@ static void translateOption(QDomElement &configRoot,const QDomElement &translati
   while (!docsVal.isNull())
   {
     //qDebug() << "tagName" << docsVal.tagName();
-    if (docsVal.tagName()==SA("docs") && getFilter(docsVal))
+    if (docsVal.tagName()==SA("docs") && getFilter(docsVal, mode))
     {
       docsVal.removeAttribute(SA("filter"));
       // we just need a value so we don't have an empty filter (and thus potential a match on doxywizard later on).
@@ -146,7 +146,7 @@ static void translateOption(QDomElement &configRoot,const QDomElement &translati
   }
 }
 
-static void translateTopics(QDomElement &configRoot,const QDomElement &translationRoot)
+static void translateTopics(QDomElement &configRoot,const QDomElement &translationRoot, QString &mode)
 {
   struct GroupInfo
   {
@@ -206,7 +206,7 @@ static void translateTopics(QDomElement &configRoot,const QDomElement &translati
           QString id = optionElem.attribute(SA("id"));
           if (groupMap[name].options.contains(id))
           {
-            translateOption(groupMap[name].options[id],optionElem);
+            translateOption(groupMap[name].options[id],optionElem,mode);
           }
           else
           {
@@ -297,6 +297,8 @@ Expert::Expert()
   mainLayout->addWidget(m_searchBox);
   mainLayout->addWidget(m_splitter);
 
+  QString mode = SA("doxywizard");
+
   QFile file(SA(":/config.xml"));
   QString err = tr("Error");
   int errLine=0,errCol=0;
@@ -340,7 +342,7 @@ Expert::Expert()
         childElem = childElem.nextSiblingElement();
       }
       // overrule english text with translations
-      translateTopics(m_rootElement,trConfigXml.documentElement());
+      translateTopics(m_rootElement,trConfigXml.documentElement(),mode);
     }
     else
     {
@@ -352,7 +354,7 @@ Expert::Expert()
   // createGroups() activates group 0 (lazy), but the Wizard needs all m_options
   // populated before it is constructed, so we create all cards eagerly here.
   createGroups(m_rootElement);
-  ensureAllGroupsCreated();
+  ensureAllGroupsCreated(mode);
 
   // --- Wire up signals ---
   m_filterTimer = new QTimer(this);
@@ -446,14 +448,14 @@ void Expert::createGroups(const QDomElement &rootElem)
   }
 }
 
-void Expert::createOptionCard(GroupEntry &group, const QDomElement &child)
+void Expert::createOptionCard(GroupEntry &group, const QDomElement &child, QString &mode)
 {
   QString setting = child.attribute(SA("setting"));
   if (!setting.isEmpty() && !IS_SUPPORTED(setting.toLatin1())) return;
 
   QString type = child.attribute(SA("type"));
   QString id   = child.attribute(SA("id"));
-  QString docs = getDocsForNode(child);
+  QString docs = getDocsForNode(child, mode);
 
   // Each option gets its own control layout
   QWidget     *ctrlWidget = new QWidget;
@@ -668,7 +670,7 @@ void Expert::wireDependencies()
 }
 
 // Create option cards for 'group' if they haven't been created yet.
-void Expert::ensureGroupCardsCreated(GroupEntry &group)
+void Expert::ensureGroupCardsCreated(GroupEntry &group, QString &mode)
 {
   if (group.cardsCreated) return;
   group.cardsCreated = true;
@@ -678,7 +680,7 @@ void Expert::ensureGroupCardsCreated(GroupEntry &group)
   {
     if (optElem.tagName() == SA("option"))
     {
-      createOptionCard(group, optElem);
+      createOptionCard(group, optElem, mode);
     }
     optElem = optElem.nextSiblingElement();
   }
@@ -730,11 +732,11 @@ void Expert::setDocumentationVisibility(bool hidden)
 
 // Create cards for every group that hasn't been created yet, then do a full
 // dependency update (needed when cross-group deps span newly-created groups).
-void Expert::ensureAllGroupsCreated()
+void Expert::ensureAllGroupsCreated(QString &mode)
 {
   for (GroupEntry &group : m_groups)
   {
-    ensureGroupCardsCreated(group);
+    ensureGroupCardsCreated(group, mode);
   }
 
   // Re-run update so cross-group dependencies are fully applied
@@ -783,7 +785,7 @@ void Expert::nextGroup()
 }
 
 
-QString Expert::getDocsForNode(const QDomElement &child) const
+QString Expert::getDocsForNode(const QDomElement &child, QString &mode) const
 {
   QString type = child.attribute(SA("type"));
   QString docs = SA("");
@@ -792,7 +794,7 @@ QString Expert::getDocsForNode(const QDomElement &child) const
   bool first = true;
   while (!docsVal.isNull())
   {
-    if (docsVal.tagName()==SA("docs") && getFilter(docsVal))
+    if (docsVal.tagName()==SA("docs") && getFilter(docsVal, mode))
     {
       if (!first) docs += SA("<br/>");
       first = false;

addon/doxywizard/expert.h

@@ -104,14 +104,14 @@ class Expert : public QWidget, public DocIntf
     };
 
     void createGroups(const QDomElement &rootElem);
-    void createOptionCard(GroupEntry &group, const QDomElement &child);
-    void ensureGroupCardsCreated(GroupEntry &group);
-    void ensureAllGroupsCreated();
+    void createOptionCard(GroupEntry &group, const QDomElement &child, QString &mode);
+    void ensureGroupCardsCreated(GroupEntry &group, QString &mode);
+    void ensureAllGroupsCreated(QString &mode);
     void wireDependencies();
     void activateGroup(int index);
     void saveTopic(QTextStream &t, QDomElement &elem, TextCodecAdapter *codec,
                    bool brief, bool condensed, bool convert);
-    QString getDocsForNode(const QDomElement &child) const;
+    QString getDocsForNode(const QDomElement &child, QString &mode) const;
 
     QSplitter              *m_splitter;
     QTreeWidget            *m_treeWidget;

src/configgen.py

@@ -21,7 +21,6 @@
 import glob
 
 messages = {}
-mode = ""
 
 # wrapper class to write to file/output in UTF-8 format
 class OutputWriter:
@@ -145,8 +144,7 @@ def addValues(var, node):
                 print("  %s->addValue(\"%s\");" % (var, name))
 
 
-def getFilter(node):
-    global mode
+def getFilter(node, mode):
     attr = node.getAttribute('filter')
     if not attr:
         return True
@@ -155,12 +153,12 @@ def getFilter(node):
     return False
 
 
-def parseHeader(node,objName):
+def parseHeader(node, objName, mode):
     doc = ""
     for n in node.childNodes:
         if n.nodeType == Node.ELEMENT_NODE:
             if (n.nodeName == "docs"):
-                if getFilter(n):
+                if getFilter(n, mode):
                     doc += parseDocs(n)
     docC = transformDocs(doc)
     print("  %s->setHeader(" % (objName))
@@ -174,15 +172,15 @@ def parseHeader(node,objName):
     print("             );")
 
 
-def prepCDocs(node):
+def prepCDocs(node, mode):
     type = node.getAttribute('type')
     format = node.getAttribute('format')
     defval = node.getAttribute('defval')
     doc = ""
     if (type != 'obsolete'):
         for n in node.childNodes:
             if (n.nodeName == "docs"):
-                if getFilter(n):
+                if getFilter(n, mode):
                     if n.nodeType == Node.ELEMENT_NODE:
                         doc += parseDocs(n)
         if (type == 'enum'):
@@ -253,7 +251,7 @@ def prepCDocs(node):
     return docC
 
 
-def parseOption(node):
+def parseOption(node, mode):
     # Handling part for Doxyfile
     name = node.getAttribute('id')
     if len(name)>23:
@@ -264,7 +262,7 @@ def parseOption(node):
     depends = node.getAttribute('depends')
     setting = node.getAttribute('setting')
     orgtype = node.getAttribute('orgtype')
-    docC = prepCDocs(node)
+    docC = prepCDocs(node, mode)
     if len(setting) > 0:
         print("#if %s" % (setting))
     print("  //----")
@@ -374,7 +372,7 @@ def parseOption(node):
         print("#endif")
 
 
-def parseGroups(node):
+def parseGroups(node, mode):
     name = node.getAttribute('name')
     doc = node.getAttribute('docs')
     setting = node.getAttribute('setting')
@@ -390,7 +388,7 @@ def parseGroups(node):
     print("")
     for n in node.childNodes:
         if n.nodeType == Node.ELEMENT_NODE:
-            parseOption(n)
+            parseOption(n, mode)
 
 def parseGroupMapEnums(node):
     def escape(value):
@@ -541,12 +539,12 @@ def parseGroupMapInit(node):
             if len(setting) > 0:
                 print("#endif")
 
-def parseGroupCDocs(node):
+def parseGroupCDocs(node, mode):
     for n in node.childNodes:
         if n.nodeType == Node.ELEMENT_NODE:
             type = n.getAttribute('type')
             name = n.getAttribute('id')
-            docC = prepCDocs(n)
+            docC = prepCDocs(n, mode)
             if type != 'obsolete':
                 print("  doc->add(")
                 print("              \"%s\"," % (name))
@@ -559,7 +557,7 @@ def parseGroupCDocs(node):
                         print("              \"%s\"" % (line))
                 print("          );")
 
-def parseOptionDoc(node, first):
+def parseOptionDoc(node, first, mode):
     # Handling part for documentation
     name = node.getAttribute('id')
     type = node.getAttribute('type')
@@ -571,7 +569,7 @@ def parseOptionDoc(node, first):
     if (type != 'obsolete'):
         for n in node.childNodes:
             if (n.nodeName == "docs"):
-                if getFilter(n):
+                if getFilter(n, mode):
                     if n.nodeType == Node.ELEMENT_NODE:
                         doc += parseDocs(n)
         if (first):
@@ -669,7 +667,7 @@ def parseOptionDoc(node, first):
         return False
 
 
-def parseGroupsDoc(node):
+def parseGroupsDoc(node, mode):
     name = node.getAttribute('name')
     doc = node.getAttribute('docs')
     print("\\section config_%s %s" % (name.lower(), doc))
@@ -680,7 +678,7 @@ def parseGroupsDoc(node):
     first = True
     for n in node.childNodes:
         if n.nodeType == Node.ELEMENT_NODE:
-            first = parseOptionDoc(n, first)
+            first = parseOptionDoc(n, first, mode)
     if (not first):
         print("</dl>")
 
@@ -704,22 +702,22 @@ def parseDocs(node):
     #doc += "<br>"
     return doc
 
-def parseHeaderDoc(node):
+def parseHeaderDoc(node, mode):
     doc = ""
     for n in node.childNodes:
         if n.nodeType == Node.ELEMENT_NODE:
             if (n.nodeName == "docs"):
-                if getFilter(n):
+                if getFilter(n, mode):
                     doc += parseDocs(n)
     print(doc)
 
 
-def parseFooterDoc(node):
+def parseFooterDoc(node, mode):
     doc = ""
     for n in node.childNodes:
         if n.nodeType == Node.ELEMENT_NODE:
             if (n.nodeName == "docs"):
-                if getFilter(n):
+                if getFilter(n, mode):
                     doc += parseDocs(n)
     print(doc)
 
@@ -1123,7 +1121,6 @@ def main():
     if len(messages)==0:
         sys.exit('<generator> section missing in %s' % configFile)
 
-    global mode
     if (sys.argv[1] == "-doc"):
         mode = "documentation"
         print("/* WARNING: This file is generated!")
@@ -1134,7 +1131,7 @@ def main():
         for n in elem.childNodes:
             if n.nodeType == Node.ELEMENT_NODE:
                 if (n.nodeName == "header"):
-                    parseHeaderDoc(n)
+                    parseHeaderDoc(n, mode)
         # generate list with all commands
         commandsList = ()
         for n in elem.childNodes:
@@ -1149,14 +1146,13 @@ def main():
         for n in elem.childNodes:
             if n.nodeType == Node.ELEMENT_NODE:
                 if (n.nodeName == "group"):
-                    parseGroupsDoc(n)
+                    parseGroupsDoc(n, mode)
         # process footers
         for n in elem.childNodes:
             if n.nodeType == Node.ELEMENT_NODE:
                 if (n.nodeName == "footer"):
-                    parseFooterDoc(n)
+                    parseFooterDoc(n, mode)
     elif (sys.argv[1] == "-maph"):
-        mode = "doxyfile"
         print("/* WARNING: This file is generated!")
         print(" * Do not edit this file, but edit %s instead and run" % configFile)
         print(" * python configgen.py -maph %s to regenerate this file!" % configFile)
@@ -1227,7 +1223,6 @@ def main():
         print("")
         print("#endif")
     elif (sys.argv[1] == "-maps"):
-        mode = "doxyfile"
         print("/* WARNING: This file is generated!")
         print(" * Do not edit this file, but edit %s instead and run" % configFile)
         print(" * python configgen.py -maps %s to regenerate this file!" % configFile)
@@ -1318,11 +1313,11 @@ def main():
         for n in elem.childNodes:
             if n.nodeType == Node.ELEMENT_NODE:
                 if (n.nodeName == "header"):
-                    parseHeader(n,'cfg')
+                    parseHeader(n,'cfg', mode)
         for n in elem.childNodes:
             if n.nodeType == Node.ELEMENT_NODE:
                 if (n.nodeName == "group"):
-                    parseGroups(n)
+                    parseGroups(n, mode)
         print("}")
     elif (sys.argv[1] == "-wiz"):
         mode = "doxywizard"
@@ -1342,11 +1337,11 @@ def main():
         for n in elem.childNodes:
             if n.nodeType == Node.ELEMENT_NODE:
                 if (n.nodeName == "header"):
-                    parseHeader(n,'doc')
+                    parseHeader(n,'doc', mode)
         for n in elem.childNodes:
             if n.nodeType == Node.ELEMENT_NODE:
                 if (n.nodeName == "group"):
-                    parseGroupCDocs(n)
+                    parseGroupCDocs(n, mode)
         print("}")
     elif (sys.argv[1] == "-wizswitch"):
         print("#ifndef CONFIGSWITCHER_H")