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