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["PROJECT_SRC_PATH_FROM_MAKEFILE"] = project_info.info("PROJECT_SRC_PATH_FROM_MAKEFILE")
 137     project_data["TOOLCHAIN"] = {'path': project_info.info("TOOLCHAIN")['path']}
 138     project_data["CPU_NAME"] = project_info.info("CPU_NAME")
 139     project_data["SELECTED_FREQ"] = project_info.info("SELECTED_FREQ")
 140     project_data["OUTPUT"] = project_info.info("OUTPUT")
 141     project_data["WIZARD_VERSION"] = WIZARD_VERSION
 142     project_data["PRESET"] = project_info.info("PRESET")
 143     project_data["PROJECT_HW_PATH"] = relpath.relpath(project_info.info("PROJECT_HW_PATH"), directory)
 144     project_data["PROJECT_HW_PATH_FROM_MAKEFILE"] = project_info.info("PROJECT_HW_PATH_FROM_MAKEFILE")
 145     return pickle.dumps(project_data)
 146
 147 def loadPlugin(plugin):
 148     """
 149     Returns the given plugin module.
 150     """
 151     return getattr(__import__("plugins", {}, {}, [plugin]), plugin)
 152
 153 def versionFileGenerator(project_info, version_file):
 154     version = bertosVersion(project_info.info("BERTOS_PATH"))
 155     return version_file.replace('$version', version)
 156
 157 def userMkGeneratorFromPreset(project_info):
 158     project_name = project_info.info("PROJECT_NAME")
 159     preset_path = project_info.info("PRESET_PATH")
 160     preset_name = project_info.info("PRESET_NAME")
 161     preset_src_dir = project_info.info("PRESET_SRC_PATH")
 162     makefile = open(os.path.join(preset_path, preset_src_dir, "%s_user.mk" %preset_name), 'r').read()
 163     destination = os.path.join(project_info.prjdir, "%s_user.mk" %project_info.info("PROJECT_NAME"))
 164     # Temporary code.
 165     # TODO: write it using regular expressions to secure this function
 166     makefile = makefile.replace(preset_name + "_", project_name + "_")
 167     open(destination, "w").write(makefile)
 168
 169 def userMkGenerator(project_info):
 170     makefile = open(os.path.join(const.DATA_DIR, "mktemplates/template_user.mk"), "r").read()
 171     destination = os.path.join(project_info.prjdir, os.path.basename(project_info.prjdir) + "_user.mk")
 172     # Deadly performances loss was here :(
 173     mk_data = {}
 174     mk_data["$pname"] = os.path.basename(project_info.info("PROJECT_PATH"))
 175     mk_data["$ppath"] = project_info.info("PROJECT_SRC_PATH_FROM_MAKEFILE")
 176     mk_data["$main"] = "/".join(["$(%s_SRC_PATH)" %project_info.info("PROJECT_NAME"), "main.c"])
 177     for key in mk_data:
 178         makefile = makefile.replace(key, mk_data[key])
 179     open(destination, "w").write(makefile)
 180
 181 def mkGenerator(project_info):
 182     """
 183     Generates the mk file for the current project.
 184     """
 185     makefile = open(os.path.join(const.DATA_DIR, "mktemplates/template.mk"), "r").read()
 186     prjdir = os.path.abspath(project_info.prjdir)
 187     destination = os.path.join(prjdir, os.path.basename(prjdir) + ".mk")
 188     mk_data = {}
 189     mk_data["$pname"] = project_info.info("PROJECT_NAME")
 190     mk_data["$ppath"] = project_info.info("PROJECT_SRC_PATH_FROM_MAKEFILE")
 191     mk_data["$cpuclockfreq"] = project_info.info("SELECTED_FREQ")
 192     cpu_mk_parameters = []
 193     for key, value in project_info.info("CPU_INFOS").items():
 194         if key.startswith(const.MK_PARAM_ID):
 195             cpu_mk_parameters.append("%s = %s" %(key.replace("MK", mk_data["$pname"]), value))
 196     mk_data["$cpuparameters"] = "\n".join(cpu_mk_parameters)
 197     mk_data["$csrc"], mk_data["$pcsrc"], mk_data["$cppasrc"], mk_data["$cxxsrc"], mk_data["$asrc"], mk_data["$constants"] = csrcGenerator(project_info)
 198     mk_data["$prefix"] = replaceSeparators(project_info.info("TOOLCHAIN")["path"].rsplit("gcc", 1)[0])
 199     mk_data["$suffix"] = replaceSeparators(project_info.info("TOOLCHAIN")["path"].rsplit("gcc", 1)[1])
 200     mk_data["$hwpath"] = project_info.info("PROJECT_HW_PATH_FROM_MAKEFILE")
 201     for key in mk_data:
 202         makefile = makefile.replace(key, mk_data[key])
 203     open(destination, "w").write(makefile)
 204
 205 def makefileGenerator(project_info):
 206     """
 207     Generate the Makefile for the current project.
 208     """
 209     makefile = open(os.path.join(const.DATA_DIR, "mktemplates/Makefile"), "r").read()
 210     destination = os.path.join(project_info.maindir, "Makefile")
 211     # TODO write a general function that works for both the mk file and the Makefile
 212     mk_data = {}
 213     mk_data["$pname"] = project_info.info("PROJECT_NAME")
 214     mk_data["$ppath"] = project_info.info("PROJECT_SRC_PATH_FROM_MAKEFILE")
 215     for key in mk_data:
 216         makefile = makefile.replace(key, mk_data[key])
 217     open(destination, "w").write(makefile)
 218
 219 def csrcGenerator(project_info):
 220     modules = project_info.info("MODULES")
 221     files = project_info.info("FILES")
 222     if "harvard" in project_info.info("CPU_INFOS")["CPU_TAGS"]:
 223         harvard = True
 224     else:
 225         harvard = False
 226     # file to be included in CSRC variable
 227     csrc = []
 228     # file to be included in PCSRC variable
 229     pcsrc = []
 230     # files to be included in CPPASRC variable
 231     cppasrc = []
 232     # files to be included in CXXSRC variable
 233     cxxsrc = []
 234     # files to be included in ASRC variable
 235     asrc = []
 236     # constants to be included at the beginning of the makefile
 237     constants = {}
 238     for module, information in modules.items():
 239         module_files = set([])
 240         dependency_files = set([])
 241         # assembly sources
 242         asm_files = set([])
 243         hwdir = os.path.basename(project_info.info("PROJECT_PATH")) + "/hw"
 244         if information["enabled"]:
 245             if "constants" in information:
 246                 constants.update(information["constants"])
 247             cfiles, sfiles = findModuleFiles(module, project_info)
 248             module_files |= set(cfiles)
 249             asm_files |= set(sfiles)
 250             for file in information["hw"]:
 251                 if file.endswith(".c"):
 252                     module_files |= set([hwdir + "/" + os.path.basename(file)])
 253             for file_dependency in information["depends"] + tuple(files.keys()):
 254                     dependencyCFiles, dependencySFiles = findModuleFiles(file_dependency, project_info)
 255                     dependency_files |= set(dependencyCFiles)
 256                     asm_files |= set(dependencySFiles)
 257             for file in module_files:
 258                 if not harvard or information.get("harvard", "both") == "both":
 259                     csrc.append(file)
 260                 if harvard and "harvard" in information:
 261                     pcsrc.append(file)
 262             for file in dependency_files:
 263                 csrc.append(file)
 264             for file in project_info.info("CPU_INFOS")["C_SRC"]:
 265                 csrc.append(file)
 266             for file in project_info.info("CPU_INFOS")["PC_SRC"]:
 267                 pcsrc.append(file)
 268             for file in asm_files:
 269                 cppasrc.append(file)
 270     for file in project_info.info("CPU_INFOS")["CPPA_SRC"]:
 271         cppasrc.append(file)
 272     for file in project_info.info("CPU_INFOS")["CXX_SRC"]:
 273         cxxsrc.append(file)
 274     for file in project_info.info("CPU_INFOS")["ASRC"]:
 275         asrc.append(file)
 276     csrc = set(csrc)
 277     csrc = " \\\n\t".join(csrc) + " \\"
 278     pcsrc = set(pcsrc)
 279     pcsrc = " \\\n\t".join(pcsrc) + " \\"
 280     cppasrc = set(cppasrc)
 281     cppasrc = " \\\n\t".join(cppasrc) + " \\"
 282     cxxsrc = set(cxxsrc)
 283     cxxsrc = " \\\n\t".join(cxxsrc) + " \\"
 284     asrc = set(asrc)
 285     asrc = " \\\n\t".join(asrc) + " \\"
 286     constants = "\n".join([os.path.basename(project_info.info("PROJECT_PATH")) + "_" + key + " = " + unicode(value) for key, value in constants.items()])
 287     return csrc, pcsrc, cppasrc, cxxsrc, asrc, constants
 288
 289 def findModuleFiles(module, project_info):
 290     # Find the files related to the selected module
 291     cfiles = []
 292     sfiles = []
 293     # .c files related to the module and the cpu architecture
 294     for filename, path in project_info.searchFiles(module + ".c"):
 295         path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
 296         path = replaceSeparators(path)
 297         cfiles.append(path + "/" + filename)
 298     # .s files related to the module and the cpu architecture
 299     for filename, path in project_info.searchFiles(module + ".s") + \
 300             project_info.searchFiles(module + ".S"):
 301         path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
 302         path = replaceSeparators(path)
 303         sfiles.append(path + "/" + filename)
 304     # .c and .s files related to the module and the cpu tags
 305     tags = project_info.info("CPU_INFOS")["CPU_TAGS"]
 306
 307     # Awful, but secure check for version
 308     # TODO: split me in a method/function
 309     try:
 310         version_string = bertosVersion(project_info.info("BERTOS_PATH"))
 311         version_list = [int(i) for i in version_string.split()[1].split('.')]
 312     except ValueError:
 313         # If the version file hasn't a valid version number assume it's an older
 314         # project.
 315         version_list = [0, 0]
 316     if version_list < [2, 5]:
 317         # For older versions of BeRTOS add the toolchain to the tags
 318         tags.append(project_info.info("CPU_INFOS")["TOOLCHAIN"])
 319
 320     for tag in tags:
 321         for filename, path in project_info.searchFiles(module + "_" + tag + ".c"):
 322             path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
 323             if os.sep != "/":
 324                 path = replaceSeparators(path)
 325             cfiles.append(path + "/" + filename)
 326         for filename, path in project_info.searchFiles(module + "_" + tag + ".s") + \
 327                 project_info.searchFiles(module + "_" + tag + ".S"):
 328             path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
 329             path = replaceSeparators(path)
 330             sfiles.append(path + "/" + filename)
 331     return cfiles, sfiles
 332
 333 def replaceSeparators(path):
 334     """
 335     Replace the separators in the given path with unix standard separator.
 336     """
 337     if os.sep != "/":
 338         path = path.replace(os.sep, "/")
 339     return path
 340
 341 def getSystemPath():
 342     path = os.environ["PATH"]
 343     if os.name == "nt":
 344         path = path.split(";")
 345     else:
 346         path = path.split(":")
 347     return path
 348
 349 def findToolchains(path_list):
 350     toolchains = []
 351     for element in path_list:
 352         for toolchain in glob.glob(element+ "/" + const.GCC_NAME):
 353             if not os.path.isdir(toolchain):
 354                 toolchains.append(toolchain)
 355     return list(set(toolchains))
 356
 357 def getToolchainInfo(output):
 358     info = {}
 359     expr = re.compile("Target: .*")
 360     target = expr.findall(output)
 361     if len(target) == 1:
 362         info["target"] = target[0].split("Target: ")[1]
 363     expr = re.compile("gcc version [0-9,.]*")
 364     version = expr.findall(output)
 365     if len(version) == 1:
 366         info["version"] = version[0].split("gcc version ")[1]
 367     expr = re.compile("gcc version [0-9,.]* \(.*\)")
 368     build = expr.findall(output)
 369     if len(build) == 1:
 370         build = build[0].split("gcc version ")[1]
 371         build = build[build.find("(") + 1 : build.find(")")]
 372         info["build"] = build
 373     expr = re.compile("Configured with: .*")
 374     configured = expr.findall(output)
 375     if len(configured) == 1:
 376         info["configured"] = configured[0].split("Configured with: ")[1]
 377     expr = re.compile("Thread model: .*")
 378     thread = expr.findall(output)
 379     if len(thread) == 1:
 380         info["thread"] = thread[0].split("Thread model: ")[1]
 381     return info
 382
 383 def getToolchainName(toolchain_info):
 384     name = "GCC " + toolchain_info["version"] + " - " + toolchain_info["target"].strip()
 385     return name
 386
 387 def getTagSet(cpu_info):
 388     tag_set = set([])
 389     for cpu in cpu_info:
 390         tag_set |= set([cpu["CPU_NAME"]])
 391         tag_set |= set(cpu["CPU_TAGS"])
 392         tag_set |= set([cpu["TOOLCHAIN"]])
 393     return tag_set
 394
 395
 396 def getInfos(definition):
 397     D = {}
 398     D.update(const.CPU_DEF)
 399     def include(filename, dict = D, directory=definition[1]):
 400         execfile(directory + "/" + filename, {}, D)
 401     D["include"] = include
 402     include(definition[0], D)
 403     D["CPU_NAME"] = definition[0].split(".")[0]
 404     D["DEFINITION_PATH"] = definition[1] + "/" + definition[0]
 405     del D["include"]
 406     return D
 407
 408 def getCommentList(string):
 409     comment_list = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/", string)
 410     comment_list = [re.findall(r"^\s*\* *(.*?)$", comment, re.MULTILINE) for comment in comment_list]
 411     return comment_list
 412
 413 def loadModuleDefinition(first_comment):
 414     to_be_parsed = False
 415     module_definition = {}
 416     for num, line in enumerate(first_comment):
 417         index = line.find("$WIZ$")
 418         if index != -1:
 419             to_be_parsed = True
 420             try:
 421                 exec line[index + len("$WIZ$ "):] in {}, module_definition
 422             except:
 423                 raise ParseError(num, line[index:])
 424         elif line.find("\\brief") != -1:
 425             module_definition["module_description"] = line[line.find("\\brief") + len("\\brief "):]
 426     module_dict = {}
 427     if "module_name" in module_definition:
 428         module_name = module_definition[const.MODULE_DEFINITION["module_name"]]
 429         del module_definition[const.MODULE_DEFINITION["module_name"]]
 430         module_dict[module_name] = {}
 431         if const.MODULE_DEFINITION["module_depends"] in module_definition:
 432             depends = module_definition[const.MODULE_DEFINITION["module_depends"]]
 433             del module_definition[const.MODULE_DEFINITION["module_depends"]]
 434             if type(depends) == str:
 435                 depends = (depends,)
 436             module_dict[module_name]["depends"] = depends
 437         else:
 438             module_dict[module_name]["depends"] = ()
 439         if const.MODULE_DEFINITION["module_configuration"] in module_definition:
 440             module_dict[module_name]["configuration"] = module_definition[const.MODULE_DEFINITION["module_configuration"]]
 441             del module_definition[const.MODULE_DEFINITION["module_configuration"]]
 442         else:
 443             module_dict[module_name]["configuration"] = ""
 444         if "module_description" in module_definition:
 445             module_dict[module_name]["description"] = module_definition["module_description"]
 446             del module_definition["module_description"]
 447         if const.MODULE_DEFINITION["module_harvard"] in module_definition:
 448             harvard = module_definition[const.MODULE_DEFINITION["module_harvard"]]
 449             module_dict[module_name]["harvard"] = harvard
 450             del module_definition[const.MODULE_DEFINITION["module_harvard"]]
 451         if const.MODULE_DEFINITION["module_hw"] in module_definition:
 452             hw = module_definition[const.MODULE_DEFINITION["module_hw"]]
 453             del module_definition[const.MODULE_DEFINITION["module_hw"]]
 454             if type(hw) == str:
 455                 hw = (hw, )
 456             module_dict[module_name]["hw"] = hw
 457         else:
 458             module_dict[module_name]["hw"] = ()
 459         if const.MODULE_DEFINITION["module_supports"] in module_definition:
 460             supports = module_definition[const.MODULE_DEFINITION["module_supports"]]
 461             del module_definition[const.MODULE_DEFINITION["module_supports"]]
 462             module_dict[module_name]["supports"] = supports
 463         module_dict[module_name]["constants"] = module_definition
 464         module_dict[module_name]["enabled"] = False
 465     return to_be_parsed, module_dict
 466
 467 def isSupported(project, module=None, property_id=None):
 468     if not module and property_id:
 469         item = project.info("CONFIGURATIONS")[property_id[0]][property_id[1]]["informations"]
 470     else:
 471         item = project.info("MODULES")[module]
 472     tag_dict = project.info("ALL_CPU_TAGS")
 473     if "supports" in item:
 474         support_string = item["supports"]
 475         supported = {}
 476         try:
 477             exec "supported = " + support_string in tag_dict, supported
 478         except:
 479             raise SupportedException(support_string)
 480         return supported["supported"]
 481     else:
 482         return True
 483
 484 def loadDefineLists(comment_list):
 485     define_list = {}
 486     for comment in comment_list:
 487         for num, line in enumerate(comment):
 488             index = line.find("$WIZ$")
 489             if index != -1:
 490                 try:
 491                     exec line[index + len("$WIZ$ "):] in {}, define_list
 492                 except:
 493                     raise ParseError(num, line[index:])
 494     for key, value in define_list.items():
 495         if type(value) == str:
 496             define_list[key] = (value,)
 497     return define_list
 498
 499 def getDescriptionInformations(comment):
 500     """
 501     Take the doxygen comment and strip the wizard informations, returning the tuple
 502     (comment, wizard_information)
 503     """
 504     brief = ""
 505     description = ""
 506     information = {}
 507     for num, line in enumerate(comment):
 508         index = line.find("$WIZ$")
 509         if index != -1:
 510             if len(brief) == 0:
 511                 brief += line[:index].strip()
 512             else:
 513                 description += " " + line[:index]
 514             try:
 515                 exec line[index + len("$WIZ$ "):] in {}, information
 516             except:
 517                 raise ParseError(num, line[index:])
 518         else:
 519             if len(brief) == 0:
 520                 brief += line.strip()
 521             else:
 522                 description += " " + line
 523                 description = description.strip()
 524     return brief.strip(), description.strip(), information
 525
 526 def getDefinitionBlocks(text):
 527     """
 528     Take a text and return a list of tuple (description, name-value).
 529     """
 530     block = []
 531     block_tmp = re.finditer(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
 532     for match in block_tmp:
 533         # Only the first element is needed
 534         comment = match.group(1)
 535         define = match.group(2)
 536         start = match.start()
 537         block.append(([re.findall(r"^\s*\* *(.*?)$", line, re.MULTILINE)[0] for line in comment.splitlines()], define, start))
 538     for match in re.finditer(r"/{3}\s*([^<].*?)\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
 539         comment = match.group(1)
 540         define = match.group(2)
 541         start = match.start()
 542         block.append(([comment], define, start))
 543     for match in re.finditer(r"#define\s*(.*?)\s*/{3}<\s*(.+?)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
 544         comment = match.group(2)
 545         define = match.group(1)
 546         start = match.start()
 547         block.append(([comment], define, start))
 548     return block
 549
 550 def formatParamNameValue(text):
 551     """
 552     Take the given string and return a tuple with the name of the parameter in the first position
 553     and the value in the second.
 554     """
 555     block = re.findall("\s*([^\s]+)\s*(.+?)\s*$", text, re.MULTILINE)
 556     return block[0]
 557
 558 def loadConfigurationInfos(path):
 559     """
 560     Return the module configurations found in the given file as a dict with the
 561     parameter name as key and a dict containig the fields above as value:
 562         "value": the value of the parameter
 563         "description": the description of the parameter
 564         "informations": a dict containig optional informations:
 565             "type": "int" | "boolean" | "enum"
 566             "min": the minimum value for integer parameters
 567             "max": the maximum value for integer parameters
 568             "long": boolean indicating if the num is a long
 569             "unsigned": boolean indicating if the num is an unsigned
 570             "value_list": the name of the enum for enum parameters
 571             "conditional_deps": the list of conditional dependencies for boolean parameters
 572     """
 573     configuration_infos = {}
 574     configuration_infos["paramlist"] = []
 575     for comment, define, start in getDefinitionBlocks(open(path, "r").read()):
 576         name, value = formatParamNameValue(define)
 577         brief, description, informations = getDescriptionInformations(comment)
 578         configuration_infos["paramlist"].append((start, name))
 579         configuration_infos[name] = {}
 580         configuration_infos[name]["value"] = value
 581         configuration_infos[name]["informations"] = informations
 582         if not "type" in configuration_infos[name]["informations"]:
 583             configuration_infos[name]["informations"]["type"] = findParameterType(configuration_infos[name])
 584         if ("type" in configuration_infos[name]["informations"] and
 585                 configuration_infos[name]["informations"]["type"] == "int" and
 586                 configuration_infos[name]["value"].find("L") != -1):
 587             configuration_infos[name]["informations"]["long"] = True
 588             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("L", "")
 589         if ("type" in configuration_infos[name]["informations"] and
 590                 configuration_infos[name]["informations"]["type"] == "int" and
 591                 configuration_infos[name]["value"].find("U") != -1):
 592             configuration_infos[name]["informations"]["unsigned"] = True
 593             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("U", "")
 594         if "conditional_deps" in configuration_infos[name]["informations"]:
 595             if (type(configuration_infos[name]["informations"]["conditional_deps"]) == str or
 596                     type(configuration_infos[name]["informations"]["conditional_deps"]) == unicode):
 597                 configuration_infos[name]["informations"]["conditional_deps"] = (configuration_infos[name]["informations"]["conditional_deps"], )
 598             elif type(configuration_infos[name]["informations"]["conditional_deps"]) == tuple:
 599                 pass
 600             else:
 601                 configuration_infos[name]["informations"]["conditional_deps"] = ()
 602         configuration_infos[name]["description"] = description
 603         configuration_infos[name]["brief"] = brief
 604     return configuration_infos
 605
 606 def updateConfigurationValues(def_conf, user_conf):
 607     for param in def_conf["paramlist"]:
 608         if param[1] in user_conf and "value" in user_conf[param[1]]:
 609             def_conf[param[1]]["value"] = user_conf[param[1]]["value"]
 610     return def_conf
 611
 612 def findParameterType(parameter):
 613     if "value_list" in parameter["informations"]:
 614         return "enum"
 615     if "min" in parameter["informations"] or "max" in parameter["informations"] or re.match(r"^\d+U?L?$", parameter["value"]) != None:
 616         return "int"
 617
 618 def sub(string, parameter, value):
 619     """
 620     Substitute the given value at the given parameter define in the given string
 621     """
 622     return re.sub(r"(?P<define>#define\s+" + parameter + r"\s+)([^\s]+)", r"\g<define>" + value, string)
 623
 624 def isInt(informations):
 625     """
 626     Return True if the value is a simple int.
 627     """
 628     if ("long" not in informatios or not informations["long"]) and ("unsigned" not in informations or informations["unsigned"]):
 629         return True
 630     else:
 631         return False
 632
 633 def isLong(informations):
 634     """
 635     Return True if the value is a long.
 636     """
 637     if "long" in informations and informations["long"] and "unsigned" not in informations:
 638         return True
 639     else:
 640         return False
 641
 642 def isUnsigned(informations):
 643     """
 644     Return True if the value is an unsigned.
 645     """
 646     if "unsigned" in informations and informations["unsigned"] and "long" not in informations:
 647         return True
 648     else:
 649         return False
 650
 651 def isUnsignedLong(informations):
 652     """
 653     Return True if the value is an unsigned long.
 654     """
 655     if "unsigned" in informations and "long" in informations and informations["unsigned"] and informations["long"]:
 656         return True
 657     else:
 658         return False
 659
 660 class ParseError(Exception):
 661     def __init__(self, line_number, line):
 662         Exception.__init__(self)
 663         self.line_number = line_number
 664         self.line = line
 665
 666 class SupportedException(Exception):
 667     def __init__(self, support_string):
 668         Exception.__init__(self)
 669         self.support_string = support_string