Change the doxygen comments to make them readable by the wizard

[bertos.git] / wizard / bertos_utils.py

diff --git a/wizard/bertos_utils.py b/wizard/bertos_utils.py
index de2597101a32ee2c71d9b6bdddc2d3951c7f3d96..50758645a78459a7336cecd5622ecf04baf24c0e 100644 (file)
--- a/wizard/bertos_utils.py
+++ b/wizard/bertos_utils.py
@@ -95,6 +95,9 @@ def getInfos(definition):
     return D
 
 def getDefinitionBlocks(text):
+    """
+    Take a text and return a list of tuple (description, name-value).
+    """
     block = []
     block_tmp = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
     for comment, define in block_tmp:
@@ -104,15 +107,41 @@ def getDefinitionBlocks(text):
     return block
 
 def formatModuleNameValue(text):
+    """
+    Take the given string and return a tuple with the name of the parameter in the first position
+    and the value in the second.
+    """
     block = re.findall("\s*([^\s]+)\s*(.+?)\s*$", text, re.MULTILINE)
     return block[0]
 
+def getDescriptionInformations(text): 
+    """ 
+    Take the doxygen comment and strip the wizard informations, returning the tuple 
+    (comment, wizard_informations) 
+    """ 
+    index = text.find("$WIZARD") 
+    if index != -1: 
+        exec(text[index + 1:]) 
+        informations = WIZARD 
+        return text[:index].strip(), informations
+    else:
+        return text.strip(), {}
+
 def loadModuleInfos(path):
+    """
+    Return the module configurations found in the given path as a dict with the name as key
+    and a dict as value. The value dict has the parameter name as key and has "value" and "description"
+    fields.
+    """
     moduleInfos = {}
     for definition in findDefinitions(const.MODULE_CONFIGURATION, path):
         moduleName = definition[0].replace("cfg_", "").replace(".h", "")
-        moduleInfos[moduleName] = []
-        for description, define in getDefinitionBlocks(open(definition[1] + "/" + definition[0], "r").read()):
+        moduleInfos[moduleName] = {}
+        for comment, define in getDefinitionBlocks(open(definition[1] + "/" + definition[0], "r").read()):
             name, value = formatModuleNameValue(define)
-            moduleInfos[moduleName].append((name, value, description))
+            description, informations = getDescriptionInformations(comment)
+            moduleInfos[moduleName][name] = {}
+            moduleInfos[moduleName][name]["value"] = value
+            moduleInfos[moduleName][name]["informations"] = informations
+            moduleInfos[moduleName][name]["description"] = description
     return moduleInfos