wizard/bertos_utils.py

   1 #!/usr/bin/env python
   2 # encoding: utf-8
   3 #
   4 # This file is part of BeRTOS.
   5 #
   6 # Bertos is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19 #
  20 # As a special exception, you may use this file as part of a free software
  21 # library without restriction.  Specifically, if other files instantiate
  22 # templates or use macros or inline functions from this file, or you compile
  23 # this file and link it with other files to produce an executable, this
  24 # file does not by itself cause the resulting executable to be covered by
  25 # the GNU General Public License.  This exception does not however
  26 # invalidate any other reasons why the executable file might be covered by
  27 # the GNU General Public License.
  28 #
  29 # Copyright 2008 Develer S.r.l. (http://www.develer.com/)
  30 #
  31 #
  32 # Author: Lorenzo Berni <duplo@develer.com>
  33 #
  34
  35 import os
  36 import fnmatch
  37 import glob
  38 import re
  39 import shutil
  40 # Use custom copytree function
  41 import copytree
  42 import relpath
  43 import pickle
  44
  45 import const
  46 import plugins
  47 import DefineException
  48
  49 from _wizard_version import WIZARD_VERSION
  50
  51 from LoadException import VersionException, ToolchainException
  52
  53 def _cmp(x, y):
  54     result = cmp(x["info"].get('ord', 0), y["info"].get('ord', 0))
  55     if result == 0:
  56         result = cmp(
  57             x["info"].get("name", x["info"]["filename"]).lower(),
  58             y["info"].get("name", y["info"]["filename"]).lower()
  59         )
  60     return result
  61
  62 def isBertosDir(directory):
  63    return os.path.exists(directory + "/VERSION")
  64
  65 def bertosVersion(directory):
  66    return open(directory + "/VERSION").readline().strip()
  67
  68 def enabledModules(project_info):
  69     enabled_modules = []
  70     for name, module in project_info.info("MODULES").items():
  71         if module["enabled"]:
  72             enabled_modules.append(name)
  73     return enabled_modules
  74
  75 def presetList(directory):
  76     """
  77     Return the list of the preset found in the selected BeRTOS Version.
  78     """
  79     abspath = os.path.join(directory, const.PREDEFINED_BOARDS_DIR)
  80     preset_list = dict([
  81         (os.path.join(abspath, preset_dir), presetInfo(os.path.join(abspath, preset_dir)))
  82         for preset_dir in os.listdir(os.path.join(directory, const.PREDEFINED_BOARDS_DIR))
  83     ])
  84     return preset_list
  85
  86 def presetInfo(preset_dir):
  87     """
  88     Return the preset-relevant info contined into the project_file.
  89     """
  90     preset_info = pickle.loads(open(os.path.join(preset_dir, "project.bertos"), "r").read())
  91     try:
  92         description = open(os.path.join(preset_dir, "description"), "r").read()
  93     except IOError:
  94         # No description file found.
  95         description = ""
  96     relevant_info = {
  97         "CPU_NAME": preset_info.get("CPU_NAME"),
  98         "SELECTED_FREQ": preset_info.get("SELECTED_FREQ"),
  99         "WIZARD_VERSION": preset_info.get("WIZARD_VERSION", None),
 100         "PRESET_NAME": preset_info.get("PROJECT_NAME"),
 101         "PRESET_DESCRIPTION": description.decode("utf-8"),
 102     }
 103     return relevant_info
 104
 105 def mergeSources(srcdir, new_sources, old_sources):
 106     # The current mergeSources function provide only a raw copy of the sources in the
 107     # created project.
 108     #
 109     # TODO: implement the three way merge algorithm
 110     #
 111     shutil.rmtree(srcdir, True)
 112     copytree.copytree(os.path.join(new_sources, "bertos"), srcdir, ignore_list=const.IGNORE_LIST)
 113
 114 def projectFileGenerator(project_info):
 115     directory = project_info.info("PROJECT_PATH")
 116     project_data = {}
 117     enabled_modules = []
 118     for module, information in project_info.info("MODULES").items():
 119         if information["enabled"]:
 120             enabled_modules.append(module)
 121     project_data["ENABLED_MODULES"] = enabled_modules
 122     if project_info.info("PRESET"):
 123         # For presets save again the BERTOS_PATH into project file
 124         project_data["PRESET"] = True
 125         project_data["BERTOS_PATH"] = relpath.relpath(project_info.info("BERTOS_PATH"), directory)
 126     elif project_info.edit:
 127         # If in editing mode the BERTOS_PATH is maintained
 128         project_data["BERTOS_PATH"] = relpath.relpath(project_info.info("BERTOS_PATH"), directory)
 129     else:
 130         # Use the local BeRTOS version instead of the original one
 131         # project_data["BERTOS_PATH"] = project_info.info("BERTOS_PATH")
 132         project_data["BERTOS_PATH"] = "."
 133     project_data["PROJECT_NAME"] = project_info.info("PROJECT_NAME", os.path.basename(directory))
 134     project_src_relpath = relpath.relpath(project_info.info("PROJECT_SRC_PATH"), directory)
 135     project_data["PROJECT_SRC_PATH"] = project_src_relpath
 136     project_data["TOOLCHAIN"] = project_info.info("TOOLCHAIN")
 137     project_data["CPU_NAME"] = project_info.info("CPU_NAME")
 138     project_data["SELECTED_FREQ"] = project_info.info("SELECTED_FREQ")
 139     project_data["OUTPUT"] = project_info.info("OUTPUT")
 140     project_data["WIZARD_VERSION"] = WIZARD_VERSION
 141     project_data["PRESET"] = project_info.info("PRESET")
 142     project_data["PROJECT_HW_PATH"] = relpath.relpath(project_info.info("PROJECT_HW_PATH"), directory)
 143     return pickle.dumps(project_data)
 144
 145 def loadPlugin(plugin):
 146     """
 147     Returns the given plugin module.
 148     """
 149     return getattr(__import__("plugins", {}, {}, [plugin]), plugin)
 150
 151 def versionFileGenerator(project_info, version_file):
 152     version = bertosVersion(project_info.info("BERTOS_PATH"))
 153     return version_file.replace('$version', version)
 154
 155 def userMkGeneratorFromPreset(project_info):
 156     project_name = project_info.info("PROJECT_NAME")
 157     preset_path = project_info.info("PRESET_PATH")
 158     preset_name = project_info.info("PRESET_NAME")
 159     preset_src_dir = project_info.info("PRESET_SRC_PATH")
 160     makefile = open(os.path.join(preset_path, preset_src_dir, "%s_user.mk" %preset_name), 'r').read()
 161     destination = os.path.join(project_info.prjdir, "%s_user.mk" %project_info.info("PROJECT_NAME"))
 162     # Temporary code.
 163     # TODO: write it using regular expressions to secure this function
 164     makefile = makefile.replace(preset_name + "_", project_name + "_")
 165     open(destination, "w").write(makefile)
 166
 167 def userMkGenerator(project_info):
 168     makefile = open(os.path.join(const.DATA_DIR, "mktemplates/template_user.mk"), "r").read()
 169     destination = os.path.join(project_info.prjdir, os.path.basename(project_info.prjdir) + "_user.mk")
 170     # Deadly performances loss was here :(
 171     mk_data = {}
 172     mk_data["$pname"] = os.path.basename(project_info.info("PROJECT_PATH"))
 173     mk_data["$ppath"] = relpath.relpath(project_info.info("PROJECT_SRC_PATH"), project_info.info("PROJECT_PATH"))
 174     mk_data["$main"] = "/".join(["$(%s_SRC_PATH)" %project_info.info("PROJECT_NAME"), "main.c"])
 175     for key in mk_data:
 176         makefile = makefile.replace(key, mk_data[key])
 177     open(destination, "w").write(makefile)
 178
 179 def mkGenerator(project_info):
 180     """
 181     Generates the mk file for the current project.
 182     """
 183     makefile = open(os.path.join(const.DATA_DIR, "mktemplates/template.mk"), "r").read()
 184     destination = os.path.join(project_info.prjdir, os.path.basename(project_info.prjdir) + ".mk")
 185     mk_data = {}
 186     mk_data["$pname"] = project_info.info("PROJECT_NAME")
 187     mk_data["$ppath"] = relpath.relpath(project_info.info("PROJECT_SRC_PATH"), project_info.info("PROJECT_PATH"))
 188     mk_data["$cpuclockfreq"] = project_info.info("SELECTED_FREQ")
 189     cpu_mk_parameters = []
 190     for key, value in project_info.info("CPU_INFOS").items():
 191         if key.startswith(const.MK_PARAM_ID):
 192             cpu_mk_parameters.append("%s = %s" %(key.replace("MK", mk_data["$pname"]), value))
 193     mk_data["$cpuparameters"] = "\n".join(cpu_mk_parameters)
 194     mk_data["$csrc"], mk_data["$pcsrc"], mk_data["$cppasrc"], mk_data["$cxxsrc"], mk_data["$asrc"], mk_data["$constants"] = csrcGenerator(project_info)
 195     mk_data["$prefix"] = replaceSeparators(project_info.info("TOOLCHAIN")["path"].rsplit("gcc", 1)[0])
 196     mk_data["$suffix"] = replaceSeparators(project_info.info("TOOLCHAIN")["path"].rsplit("gcc", 1)[1])
 197     mk_data["$hwpath"] = relpath.relpath(project_info.info("PROJECT_HW_PATH"), project_info.info("PROJECT_PATH"))
 198     for key in mk_data:
 199         makefile = makefile.replace(key, mk_data[key])
 200     open(destination, "w").write(makefile)
 201
 202 def makefileGenerator(project_info):
 203     """
 204     Generate the Makefile for the current project.
 205     """
 206     makefile = open(os.path.join(const.DATA_DIR, "mktemplates/Makefile"), "r").read()
 207     destination = os.path.join(project_info.maindir, "Makefile")
 208     # TODO write a general function that works for both the mk file and the Makefile
 209     mk_data = {}
 210     mk_data["$pname"] = project_info.info("PROJECT_NAME")
 211     mk_data["$ppath"] = relpath.relpath(project_info.info("PROJECT_SRC_PATH"), project_info.info("PROJECT_PATH"))
 212     for key in mk_data:
 213         makefile = makefile.replace(key, mk_data[key])
 214     open(destination, "w").write(makefile)
 215
 216 def csrcGenerator(project_info):
 217     modules = project_info.info("MODULES")
 218     files = project_info.info("FILES")
 219     if "harvard" in project_info.info("CPU_INFOS")["CPU_TAGS"]:
 220         harvard = True
 221     else:
 222         harvard = False
 223     # file to be included in CSRC variable
 224     csrc = []
 225     # file to be included in PCSRC variable
 226     pcsrc = []
 227     # files to be included in CPPASRC variable
 228     cppasrc = []
 229     # files to be included in CXXSRC variable
 230     cxxsrc = []
 231     # files to be included in ASRC variable
 232     asrc = []
 233     # constants to be included at the beginning of the makefile
 234     constants = {}
 235     for module, information in modules.items():
 236         module_files = set([])
 237         dependency_files = set([])
 238         # assembly sources
 239         asm_files = set([])
 240         hwdir = os.path.basename(project_info.info("PROJECT_PATH")) + "/hw"
 241         if information["enabled"]:
 242             if "constants" in information:
 243                 constants.update(information["constants"])
 244             cfiles, sfiles = findModuleFiles(module, project_info)
 245             module_files |= set(cfiles)
 246             asm_files |= set(sfiles)
 247             for file in information["hw"]:
 248                 if file.endswith(".c"):
 249                     module_files |= set([hwdir + "/" + os.path.basename(file)])
 250             for file_dependency in information["depends"] + tuple(files.keys()):
 251                     dependencyCFiles, dependencySFiles = findModuleFiles(file_dependency, project_info)
 252                     dependency_files |= set(dependencyCFiles)
 253                     asm_files |= set(dependencySFiles)
 254             for file in module_files:
 255                 if not harvard or information.get("harvard", "both") == "both":
 256                     csrc.append(file)
 257                 if harvard and "harvard" in information:
 258                     pcsrc.append(file)
 259             for file in dependency_files:
 260                 csrc.append(file)
 261             for file in project_info.info("CPU_INFOS")["C_SRC"]:
 262                 csrc.append(file)
 263             for file in project_info.info("CPU_INFOS")["PC_SRC"]:
 264                 pcsrc.append(file)
 265             for file in asm_files:
 266                 cppasrc.append(file)
 267     for file in project_info.info("CPU_INFOS")["CPPA_SRC"]:
 268         cppasrc.append(file)
 269     for file in project_info.info("CPU_INFOS")["CXX_SRC"]:
 270         cxxsrc.append(file)
 271     for file in project_info.info("CPU_INFOS")["ASRC"]:
 272         asrc.append(file)
 273     csrc = set(csrc)
 274     csrc = " \\\n\t".join(csrc) + " \\"
 275     pcsrc = set(pcsrc)
 276     pcsrc = " \\\n\t".join(pcsrc) + " \\"
 277     cppasrc = set(cppasrc)
 278     cppasrc = " \\\n\t".join(cppasrc) + " \\"
 279     cxxsrc = set(cxxsrc)
 280     cxxsrc = " \\\n\t".join(cxxsrc) + " \\"
 281     asrc = set(asrc)
 282     asrc = " \\\n\t".join(asrc) + " \\"
 283     constants = "\n".join([os.path.basename(project_info.info("PROJECT_PATH")) + "_" + key + " = " + unicode(value) for key, value in constants.items()])
 284     return csrc, pcsrc, cppasrc, cxxsrc, asrc, constants
 285
 286 def findModuleFiles(module, project_info):
 287     # Find the files related to the selected module
 288     cfiles = []
 289     sfiles = []
 290     # .c files related to the module and the cpu architecture
 291     for filename, path in project_info.searchFiles(module + ".c"):
 292         path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
 293         path = replaceSeparators(path)
 294         cfiles.append(path + "/" + filename)
 295     # .s files related to the module and the cpu architecture
 296     for filename, path in project_info.searchFiles(module + ".s") + \
 297             project_info.searchFiles(module + ".S"):
 298         path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
 299         path = replaceSeparators(path)
 300         sfiles.append(path + "/" + filename)
 301     # .c and .s files related to the module and the cpu tags
 302     tags = project_info.info("CPU_INFOS")["CPU_TAGS"]
 303
 304     # Awful, but secure check for version
 305     # TODO: split me in a method/function
 306     try:
 307         version_string = bertosVersion(project_info.info("BERTOS_PATH"))
 308         version_list = [int(i) for i in version_string.split()[1].split('.')]
 309     except ValueError:
 310         # If the version file hasn't a valid version number assume it's an older
 311         # project.
 312         version_list = [0, 0]
 313     if version_list < [2, 5]:
 314         # For older versions of BeRTOS add the toolchain to the tags
 315         tags.append(project_info.info("CPU_INFOS")["TOOLCHAIN"])
 316
 317     for tag in tags:
 318         for filename, path in project_info.searchFiles(module + "_" + tag + ".c"):
 319             path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
 320             if os.sep != "/":
 321                 path = replaceSeparators(path)
 322             cfiles.append(path + "/" + filename)
 323         for filename, path in project_info.searchFiles(module + "_" + tag + ".s") + \
 324                 project_info.searchFiles(module + "_" + tag + ".S"):
 325             path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
 326             path = replaceSeparators(path)
 327             sfiles.append(path + "/" + filename)
 328     return cfiles, sfiles
 329
 330 def replaceSeparators(path):
 331     """
 332     Replace the separators in the given path with unix standard separator.
 333     """
 334     if os.sep != "/":
 335         path = path.replace(os.sep, "/")
 336     return path
 337
 338 def getSystemPath():
 339     path = os.environ["PATH"]
 340     if os.name == "nt":
 341         path = path.split(";")
 342     else:
 343         path = path.split(":")
 344     return path
 345
 346 def findToolchains(path_list):
 347     toolchains = []
 348     for element in path_list:
 349         for toolchain in glob.glob(element+ "/" + const.GCC_NAME):
 350             toolchains.append(toolchain)
 351     return list(set(toolchains))
 352
 353 def getToolchainInfo(output):
 354     info = {}
 355     expr = re.compile("Target: .*")
 356     target = expr.findall(output)
 357     if len(target) == 1:
 358         info["target"] = target[0].split("Target: ")[1]
 359     expr = re.compile("gcc version [0-9,.]*")
 360     version = expr.findall(output)
 361     if len(version) == 1:
 362         info["version"] = version[0].split("gcc version ")[1]
 363     expr = re.compile("gcc version [0-9,.]* \(.*\)")
 364     build = expr.findall(output)
 365     if len(build) == 1:
 366         build = build[0].split("gcc version ")[1]
 367         build = build[build.find("(") + 1 : build.find(")")]
 368         info["build"] = build
 369     expr = re.compile("Configured with: .*")
 370     configured = expr.findall(output)
 371     if len(configured) == 1:
 372         info["configured"] = configured[0].split("Configured with: ")[1]
 373     expr = re.compile("Thread model: .*")
 374     thread = expr.findall(output)
 375     if len(thread) == 1:
 376         info["thread"] = thread[0].split("Thread model: ")[1]
 377     return info
 378
 379 def getToolchainName(toolchain_info):
 380     name = "GCC " + toolchain_info["version"] + " - " + toolchain_info["target"].strip()
 381     return name
 382
 383 def getTagSet(cpu_info):
 384     tag_set = set([])
 385     for cpu in cpu_info:
 386         tag_set |= set([cpu["CPU_NAME"]])
 387         tag_set |= set(cpu["CPU_TAGS"])
 388         tag_set |= set([cpu["TOOLCHAIN"]])
 389     return tag_set
 390
 391
 392 def getInfos(definition):
 393     D = {}
 394     D.update(const.CPU_DEF)
 395     def include(filename, dict = D, directory=definition[1]):
 396         execfile(directory + "/" + filename, {}, D)
 397     D["include"] = include
 398     include(definition[0], D)
 399     D["CPU_NAME"] = definition[0].split(".")[0]
 400     D["DEFINITION_PATH"] = definition[1] + "/" + definition[0]
 401     del D["include"]
 402     return D
 403
 404 def getCommentList(string):
 405     comment_list = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/", string)
 406     comment_list = [re.findall(r"^\s*\* *(.*?)$", comment, re.MULTILINE) for comment in comment_list]
 407     return comment_list
 408
 409 def loadModuleDefinition(first_comment):
 410     to_be_parsed = False
 411     module_definition = {}
 412     for num, line in enumerate(first_comment):
 413         index = line.find("$WIZ$")
 414         if index != -1:
 415             to_be_parsed = True
 416             try:
 417                 exec line[index + len("$WIZ$ "):] in {}, module_definition
 418             except:
 419                 raise ParseError(num, line[index:])
 420         elif line.find("\\brief") != -1:
 421             module_definition["module_description"] = line[line.find("\\brief") + len("\\brief "):]
 422     module_dict = {}
 423     if "module_name" in module_definition:
 424         module_name = module_definition[const.MODULE_DEFINITION["module_name"]]
 425         del module_definition[const.MODULE_DEFINITION["module_name"]]
 426         module_dict[module_name] = {}
 427         if const.MODULE_DEFINITION["module_depends"] in module_definition:
 428             depends = module_definition[const.MODULE_DEFINITION["module_depends"]]
 429             del module_definition[const.MODULE_DEFINITION["module_depends"]]
 430             if type(depends) == str:
 431                 depends = (depends,)
 432             module_dict[module_name]["depends"] = depends
 433         else:
 434             module_dict[module_name]["depends"] = ()
 435         if const.MODULE_DEFINITION["module_configuration"] in module_definition:
 436             module_dict[module_name]["configuration"] = module_definition[const.MODULE_DEFINITION["module_configuration"]]
 437             del module_definition[const.MODULE_DEFINITION["module_configuration"]]
 438         else:
 439             module_dict[module_name]["configuration"] = ""
 440         if "module_description" in module_definition:
 441             module_dict[module_name]["description"] = module_definition["module_description"]
 442             del module_definition["module_description"]
 443         if const.MODULE_DEFINITION["module_harvard"] in module_definition:
 444             harvard = module_definition[const.MODULE_DEFINITION["module_harvard"]]
 445             module_dict[module_name]["harvard"] = harvard
 446             del module_definition[const.MODULE_DEFINITION["module_harvard"]]
 447         if const.MODULE_DEFINITION["module_hw"] in module_definition:
 448             hw = module_definition[const.MODULE_DEFINITION["module_hw"]]
 449             del module_definition[const.MODULE_DEFINITION["module_hw"]]
 450             if type(hw) == str:
 451                 hw = (hw, )
 452             module_dict[module_name]["hw"] = hw
 453         else:
 454             module_dict[module_name]["hw"] = ()
 455         if const.MODULE_DEFINITION["module_supports"] in module_definition:
 456             supports = module_definition[const.MODULE_DEFINITION["module_supports"]]
 457             del module_definition[const.MODULE_DEFINITION["module_supports"]]
 458             module_dict[module_name]["supports"] = supports
 459         module_dict[module_name]["constants"] = module_definition
 460         module_dict[module_name]["enabled"] = False
 461     return to_be_parsed, module_dict
 462
 463 def isSupported(project, module=None, property_id=None):
 464     if not module and property_id:
 465         item = project.info("CONFIGURATIONS")[property_id[0]][property_id[1]]["informations"]
 466     else:
 467         item = project.info("MODULES")[module]
 468     tag_dict = project.info("ALL_CPU_TAGS")
 469     if "supports" in item:
 470         support_string = item["supports"]
 471         supported = {}
 472         try:
 473             exec "supported = " + support_string in tag_dict, supported
 474         except:
 475             raise SupportedException(support_string)
 476         return supported["supported"]
 477     else:
 478         return True
 479
 480 def loadDefineLists(comment_list):
 481     define_list = {}
 482     for comment in comment_list:
 483         for num, line in enumerate(comment):
 484             index = line.find("$WIZ$")
 485             if index != -1:
 486                 try:
 487                     exec line[index + len("$WIZ$ "):] in {}, define_list
 488                 except:
 489                     raise ParseError(num, line[index:])
 490     for key, value in define_list.items():
 491         if type(value) == str:
 492             define_list[key] = (value,)
 493     return define_list
 494
 495 def getDescriptionInformations(comment):
 496     """
 497     Take the doxygen comment and strip the wizard informations, returning the tuple
 498     (comment, wizard_information)
 499     """
 500     brief = ""
 501     description = ""
 502     information = {}
 503     for num, line in enumerate(comment):
 504         index = line.find("$WIZ$")
 505         if index != -1:
 506             if len(brief) == 0:
 507                 brief += line[:index].strip()
 508             else:
 509                 description += " " + line[:index]
 510             try:
 511                 exec line[index + len("$WIZ$ "):] in {}, information
 512             except:
 513                 raise ParseError(num, line[index:])
 514         else:
 515             if len(brief) == 0:
 516                 brief += line.strip()
 517             else:
 518                 description += " " + line
 519                 description = description.strip()
 520     return brief.strip(), description.strip(), information
 521
 522 def getDefinitionBlocks(text):
 523     """
 524     Take a text and return a list of tuple (description, name-value).
 525     """
 526     block = []
 527     block_tmp = re.finditer(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
 528     for match in block_tmp:
 529         # Only the first element is needed
 530         comment = match.group(1)
 531         define = match.group(2)
 532         start = match.start()
 533         block.append(([re.findall(r"^\s*\* *(.*?)$", line, re.MULTILINE)[0] for line in comment.splitlines()], define, start))
 534     for match in re.finditer(r"/{3}\s*([^<].*?)\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
 535         comment = match.group(1)
 536         define = match.group(2)
 537         start = match.start()
 538         block.append(([comment], define, start))
 539     for match in re.finditer(r"#define\s*(.*?)\s*/{3}<\s*(.+?)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
 540         comment = match.group(2)
 541         define = match.group(1)
 542         start = match.start()
 543         block.append(([comment], define, start))
 544     return block
 545
 546 def formatParamNameValue(text):
 547     """
 548     Take the given string and return a tuple with the name of the parameter in the first position
 549     and the value in the second.
 550     """
 551     block = re.findall("\s*([^\s]+)\s*(.+?)\s*$", text, re.MULTILINE)
 552     return block[0]
 553
 554 def loadConfigurationInfos(path):
 555     """
 556     Return the module configurations found in the given file as a dict with the
 557     parameter name as key and a dict containig the fields above as value:
 558         "value": the value of the parameter
 559         "description": the description of the parameter
 560         "informations": a dict containig optional informations:
 561             "type": "int" | "boolean" | "enum"
 562             "min": the minimum value for integer parameters
 563             "max": the maximum value for integer parameters
 564             "long": boolean indicating if the num is a long
 565             "unsigned": boolean indicating if the num is an unsigned
 566             "value_list": the name of the enum for enum parameters
 567             "conditional_deps": the list of conditional dependencies for boolean parameters
 568     """
 569     configuration_infos = {}
 570     configuration_infos["paramlist"] = []
 571     for comment, define, start in getDefinitionBlocks(open(path, "r").read()):
 572         name, value = formatParamNameValue(define)
 573         brief, description, informations = getDescriptionInformations(comment)
 574         configuration_infos["paramlist"].append((start, name))
 575         configuration_infos[name] = {}
 576         configuration_infos[name]["value"] = value
 577         configuration_infos[name]["informations"] = informations
 578         if not "type" in configuration_infos[name]["informations"]:
 579             configuration_infos[name]["informations"]["type"] = findParameterType(configuration_infos[name])
 580         if ("type" in configuration_infos[name]["informations"] and
 581                 configuration_infos[name]["informations"]["type"] == "int" and
 582                 configuration_infos[name]["value"].find("L") != -1):
 583             configuration_infos[name]["informations"]["long"] = True
 584             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("L", "")
 585         if ("type" in configuration_infos[name]["informations"] and
 586                 configuration_infos[name]["informations"]["type"] == "int" and
 587                 configuration_infos[name]["value"].find("U") != -1):
 588             configuration_infos[name]["informations"]["unsigned"] = True
 589             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("U", "")
 590         if "conditional_deps" in configuration_infos[name]["informations"]:
 591             if (type(configuration_infos[name]["informations"]["conditional_deps"]) == str or
 592                     type(configuration_infos[name]["informations"]["conditional_deps"]) == unicode):
 593                 configuration_infos[name]["informations"]["conditional_deps"] = (configuration_infos[name]["informations"]["conditional_deps"], )
 594             elif type(configuration_infos[name]["informations"]["conditional_deps"]) == tuple:
 595                 pass
 596             else:
 597                 configuration_infos[name]["informations"]["conditional_deps"] = ()
 598         configuration_infos[name]["description"] = description
 599         configuration_infos[name]["brief"] = brief
 600     return configuration_infos
 601
 602 def updateConfigurationValues(def_conf, user_conf):
 603     for param in def_conf["paramlist"]:
 604         if param[1] in user_conf and "value" in user_conf[param[1]]:
 605             def_conf[param[1]]["value"] = user_conf[param[1]]["value"]
 606     return def_conf
 607
 608 def findParameterType(parameter):
 609     if "value_list" in parameter["informations"]:
 610         return "enum"
 611     if "min" in parameter["informations"] or "max" in parameter["informations"] or re.match(r"^\d+U?L?$", parameter["value"]) != None:
 612         return "int"
 613
 614 def sub(string, parameter, value):
 615     """
 616     Substitute the given value at the given parameter define in the given string
 617     """
 618     return re.sub(r"(?P<define>#define\s+" + parameter + r"\s+)([^\s]+)", r"\g<define>" + value, string)
 619
 620 def isInt(informations):
 621     """
 622     Return True if the value is a simple int.
 623     """
 624     if ("long" not in informatios or not informations["long"]) and ("unsigned" not in informations or informations["unsigned"]):
 625         return True
 626     else:
 627         return False
 628
 629 def isLong(informations):
 630     """
 631     Return True if the value is a long.
 632     """
 633     if "long" in informations and informations["long"] and "unsigned" not in informations:
 634         return True
 635     else:
 636         return False
 637
 638 def isUnsigned(informations):
 639     """
 640     Return True if the value is an unsigned.
 641     """
 642     if "unsigned" in informations and informations["unsigned"] and "long" not in informations:
 643         return True
 644     else:
 645         return False
 646
 647 def isUnsignedLong(informations):
 648     """
 649     Return True if the value is an unsigned long.
 650     """
 651     if "unsigned" in informations and "long" in informations and informations["unsigned"] and informations["long"]:
 652         return True
 653     else:
 654         return False
 655
 656 class ParseError(Exception):
 657     def __init__(self, line_number, line):
 658         Exception.__init__(self)
 659         self.line_number = line_number
 660         self.line = line
 661
 662 class SupportedException(Exception):
 663     def __init__(self, support_string):
 664         Exception.__init__(self)
 665         self.support_string = support_string