Add functions for get the all the bertos modules and define lists

[bertos.git] / wizard / bertos_utils.py

diff --git a/wizard/bertos_utils.py b/wizard/bertos_utils.py
index fc225d0a4ebf5e7e331a024c2a1bb1fdd9d17210..479f88eea08cd3727f86cb3afcb29038cdb491ec 100644 (file)
--- a/wizard/bertos_utils.py
+++ b/wizard/bertos_utils.py
@@ -95,9 +95,104 @@ 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("^/\*+\s*(.*?)\s*?\*/\s*#define\s+(\w+[\s\w]*?)\s*$", text, re.DOTALL | re.MULTILINE)
+    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("^\s*\*?\s*(.*?)\s*?$", comment, re.MULTILINE)), define))
-    block += re.findall("/{3}<?\s*(.*)\s*#define\s+(.*)\s*?$", text, re.MULTILINE)
-    return block
\ No newline at end of file
+        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 formatParamNameValue(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 loadConfigurationInfos(path):
+    """
+    Return the module configurations found in the given file as a dict with the
+    parameter name as key and a dict containig the fields above as value:
+        "value": the value of the parameter
+        "description": the description of the parameter
+        "informations": a dict containig optional informations:
+            "type": "int" | "boolean" | "enum"
+            "min": the minimum value for integer parameters
+            "max": the maximum value for integer parameters
+            "long": boolean indicating if the num is a long
+            "value_list": the name of the enum for enum parameters
+    """
+    configurationInfos = {}
+    for comment, define in getDefinitionBlocks(open(path, "r").read()):
+        name, value = formatParamNameValue(define)
+        description, informations = getDescriptionInformations(comment)
+        configurationInfos[name] = {}
+        configurationInfos[name]["value"] = value
+        configurationInfos[name]["informations"] = informations
+        configurationInfos[name]["description"] = description
+    return configurationInfos
+
+def loadModuleInfos(path):
+    """
+    Return the module infos found in the given file as a dict with the module
+    name as key and a dict containig the fields above as value or an empty dict
+    if the given file is not a BeRTOS module:
+        "depends": a list of modules needed by this module
+        "configuration": the cfg_*.h with the module configurations
+    """
+    moduleInfos = {}
+    string = open(path, "r").read()
+    commentList = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/", string)
+    commentList = [" ".join(re.findall(r"^\s*\*?\s*(.*?)\s*?(?:/{2}.*?)?$", comment, re.MULTILINE)).strip() for comment in commentList]
+    for comment in commentList:
+        index = comment.find("$WIZARD_MODULE")
+        if index != -1:
+            exec(comment[index + 1:])
+            moduleInfos[WIZARD_MODULE["name"]] = {"depends": WIZARD_MODULE["depends"], "configuration": WIZARD_MODULE["configuration"]}
+            return moduleInfos
+    return {}
+
+def loadModuleInfosDict(path):
+    moduleInfosDict = {}
+    for filename, path in findDefinitions("*.h", path):
+        moduleInfosDict.update(loadModuleInfos(path + "/" + filename))
+    return moduleInfosDict
+
+def loadDefineLists(path):
+    """
+    Return a dict with the name of the list as key and a list of string as value
+    """
+    string = open(path, "r").read()
+    commentList = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/", string)
+    commentList = [" ".join(re.findall(r"^\s*\*?\s*(.*?)\s*?(?:/{2}.*?)?$", comment, re.MULTILINE)).strip() for comment in commentList]
+    listDict = {}
+    for comment in commentList:
+        index = comment.find("$WIZARD_LIST")
+        if index != -1:
+            exec(comment[index + 1:])
+            listDict.update(WIZARD_LIST)
+    return listDict
+
+def loadDefineListsDict(path):
+    defineListsDict = {}
+    for filename, path in findDefinitions("*.h", path):
+        defineListsDict.update(loadDefineLists(path + "/" + filename))
+    return defineListsDict
\ No newline at end of file