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