Add commento for the module info retrieve and format functions

[bertos.git] / wizard / bertos_utils.py

diff --git a/wizard/bertos_utils.py b/wizard/bertos_utils.py
index 8f91878d151a71fceea48b00f71494eeb9141741..5c6bf3c1f841ba9eafefbdbd8ada4b4f4c582973 100644 (file)
--- a/wizard/bertos_utils.py
+++ b/wizard/bertos_utils.py
@@ -93,3 +93,37 @@ def getInfos(definition):
     D["DEFINITION_PATH"] = definition[1] + "/" + definition[0]
     del D["include"]
     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:
+        block.append((" ".join(re.findall(r"^\s*\*?\s*(.*?)\s*?(?:/{2}.*?)?$", comment, re.MULTILINE)).strip(), define))
+    block += re.findall(r"/{3}\s*([^<].*?)\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
+    block += [(comment, define) for define, comment in re.findall(r"#define\s*(.*?)\s*/{3}<\s*(.+?)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)]
+    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 loadModuleInfos(path):
+    """
+    Return the module configurations found in the given path as a dict with the name as key
+    and a list of tuple as value. The tuple have the format (name, value, description).
+    """
+    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()):
+            name, value = formatModuleNameValue(define)
+            moduleInfos[moduleName].append((name, value, description))
+    return moduleInfos