wizard/bertos_utils.py

   1 #!/usr/bin/env python
   2 # encoding: utf-8
   3 #
   4 # Copyright 2008 Develer S.r.l. (http://www.develer.com/)
   5 # All rights reserved.
   6 #
   7 # $Id$
   8 #
   9 # Author: Lorenzo Berni <duplo@develer.com>
  10 #
  11
  12 import os
  13 import fnmatch
  14 import glob
  15 import re
  16 import shutil
  17 # Use custom copytree function
  18 import copytree
  19 import pickle
  20
  21 import const
  22 from plugins import codelite_project
  23 import DefineException
  24
  25 def isBertosDir(directory):
  26    return os.path.exists(directory + "/VERSION")
  27
  28 def bertosVersion(directory):
  29    return open(directory + "/VERSION").readline().strip()
  30
  31 def createBertosProject(project_info):
  32     directory = project_info.info("PROJECT_PATH")
  33     sources_dir = project_info.info("SOURCES_PATH")
  34     if not os.path.isdir(directory):
  35         os.mkdir(directory)
  36     f = open(directory + "/project.bertos", "w")
  37     f.write(pickle.dumps(project_info))
  38     f.close()
  39     # Destination source dir
  40     srcdir = directory + "/bertos"
  41     shutil.rmtree(srcdir, True)
  42     copytree.copytree(sources_dir + "/bertos", srcdir, ignore_list=const.IGNORE_LIST)
  43     # Destination makefile
  44     makefile = directory + "/Makefile"
  45     if os.path.exists(makefile):
  46         os.remove(makefile)
  47     makefile = open("mktemplates/Makefile").read()
  48     makefile = makefileGenerator(project_info, makefile)
  49     open(directory + "/Makefile", "w").write(makefile)
  50     # Destination project dir
  51     prjdir = directory + "/" + os.path.basename(directory)
  52     shutil.rmtree(prjdir, True)
  53     os.mkdir(prjdir)
  54     # Destination hw files
  55     hwdir = prjdir + "/hw"
  56     shutil.rmtree(hwdir, True)
  57     os.mkdir(hwdir)
  58     # Copy all the hw files
  59     for module, information in project_info.info("MODULES").items():
  60         for hwfile in information["hw"]:
  61             string = open(sources_dir + "/" + hwfile, "r").read()
  62             open(hwdir + "/" + os.path.basename(hwfile), "w").write(string)
  63     # Destination configurations files
  64     cfgdir = prjdir + "/cfg"
  65     shutil.rmtree(cfgdir, True)
  66     os.mkdir(cfgdir)
  67     # Set to 1 the autoenabled for enabled modules
  68     for module, information in project_info.info("MODULES").items():
  69         if information["enabled"] and "configuration" in information and information["configuration"] != "":
  70             configurations = project_info.info("CONFIGURATIONS")
  71             configuration = configurations[information["configuration"]]
  72             for start, parameter in configuration["paramlist"]:
  73                 if "type" in configuration[parameter] and configuration[parameter]["type"] == "autoenabled":
  74                     configuration[parameter]["value"] = "1"
  75             project_info.setInfo("CONFIGURATIONS", configurations)
  76     # Copy all the configuration files
  77     for configuration, information in project_info.info("CONFIGURATIONS").items():
  78         string = open(sources_dir + "/" + configuration, "r").read()
  79         for start, parameter in information["paramlist"]:
  80             infos = information[parameter]
  81             value = infos["value"]
  82             if "unsigned" in infos["informations"] and infos["informations"]["unsigned"]:
  83                 value += "U"
  84             if "long" in infos["informations"] and infos["informations"]["long"]:
  85                 value += "L"
  86             string = sub(string, parameter, value)
  87         f = open(cfgdir + "/" + os.path.basename(configuration), "w")
  88         f.write(string)
  89         f.close()
  90     # Destinatio mk file
  91     makefile = open("mktemplates/template.mk", "r").read()
  92     makefile = mkGenerator(project_info, makefile)
  93     open(prjdir + "/" + os.path.basename(prjdir) + ".mk", "w").write(makefile)
  94     # Destination main.c file
  95     main = open("srctemplates/main.c", "r").read()
  96     open(prjdir + "/main.c", "w").write(main)
  97     # Codelite project files
  98     if "codelite" in project_info.info("OUTPUT"):
  99         codelite_project.createProject(project_info)
 100
 101 def mkGenerator(project_info, makefile):
 102     """
 103     Generates the mk file for the current project.
 104     """
 105     mk_data = {}
 106     mk_data["$pname"] = os.path.basename(project_info.info("PROJECT_PATH"))
 107     mk_data["$cpuflag"] = project_info.info("CPU_INFOS")["CPU_FLAG_NAME"]
 108     mk_data["$cpuname"] = project_info.info("CPU_INFOS")["CORE_CPU"]
 109     mk_data["$cpuclockfreq"] = project_info.info("SELECTED_FREQ")
 110     mk_data["$cflags"] = " ".join(project_info.info("CPU_INFOS")["C_FLAGS"])
 111     mk_data["$ldflags"] = " ".join(project_info.info("CPU_INFOS")["LD_FLAGS"])
 112     mk_data["$cppflags"] = " ".join(project_info.info("CPU_INFOS")["CPP_FLAGS"])
 113     mk_data["$cppaflags"] = " ".join(project_info.info("CPU_INFOS")["CPPA_FLAGS"])
 114     mk_data["$cxxflags"] = " ".join(project_info.info("CPU_INFOS")["CXX_FLAGS"])
 115     mk_data["$asflags"] = " ".join(project_info.info("CPU_INFOS")["AS_FLAGS"])
 116     mk_data["$arflags"] = " ".join(project_info.info("CPU_INFOS")["AR_FLAGS"])
 117     mk_data["$csrc"], mk_data["$pcsrc"], mk_data["$cppasrc"], mk_data["$cxxsrc"], mk_data["$asrc"], mk_data["$constants"] = csrcGenerator(project_info)
 118     mk_data["$prefix"] = project_info.info("TOOLCHAIN")["path"].split("gcc")[0]
 119     mk_data["$suffix"] = project_info.info("TOOLCHAIN")["path"].split("gcc")[1]
 120     mk_data["$main"] = os.path.basename(project_info.info("PROJECT_PATH")) + "/main.c"
 121     for key in mk_data:
 122         while makefile.find(key) != -1:
 123             makefile = makefile.replace(key, mk_data[key])
 124     return makefile
 125
 126 def makefileGenerator(project_info, makefile):
 127     """
 128     Generate the Makefile for the current project.
 129     """
 130     # TODO write a general function that works for both the mk file and the Makefile
 131     while makefile.find("project_name") != -1:
 132         makefile = makefile.replace("project_name", os.path.basename(project_info.info("PROJECT_PATH")))
 133     return makefile
 134
 135 def csrcGenerator(project_info):
 136     modules = project_info.info("MODULES")
 137     files = project_info.info("FILES")
 138     if "harvard" in project_info.info("CPU_INFOS")["CPU_TAGS"]:
 139         harvard = True
 140     else:
 141         harvard = False
 142     # file to be included in CSRC variable
 143     csrc = []
 144     # file to be included in PCSRC variable
 145     pcsrc = []
 146     # files to be included in CPPASRC variable
 147     cppasrc = []
 148     # files to be included in CXXSRC variable
 149     cxxsrc = []
 150     # files to be included in ASRC variable
 151     asrc = []
 152     # constants to be included at the beginning of the makefile
 153     constants = {}
 154     for module, information in modules.items():
 155         module_files = set([])
 156         dependency_files = set([])
 157         # assembly sources
 158         asm_files = set([])
 159         hwdir = os.path.basename(project_info.info("PROJECT_PATH")) + "/hw"
 160         if information["enabled"]:
 161             if "constants" in information:
 162                 constants.update(information["constants"])
 163             cfiles, sfiles = findModuleFiles(module, project_info)
 164             module_files |= set(cfiles)
 165             asm_files |= set(sfiles)
 166             for file in information["hw"]:
 167                 if file.endswith(".c"):
 168                     module_files |= set([hwdir + "/" + os.path.basename(file)])
 169             for file_dependency in information["depends"]:
 170                 if file_dependency in files:
 171                     dependencyCFiles, dependencySFiles = findModuleFiles(file_dependency, project_info)
 172                     dependency_files |= set(dependencyCFiles)
 173                     asm_files |= set(dependencySFiles)
 174             for file in module_files:
 175                 if not harvard or information.get("harvard", "both") == "both":
 176                     csrc.append(file)
 177                 if harvard and "harvard" in information:
 178                     pcsrc.append(file)
 179             for file in dependency_files:
 180                 csrc.append(file)
 181             for file in project_info.info("CPU_INFOS")["C_SRC"]:
 182                 csrc.append(file)
 183             for file in project_info.info("CPU_INFOS")["PC_SRC"]:
 184                 pcsrc.append(file)
 185             for file in asm_files:
 186                 cppasrc.append(file)
 187     for file in project_info.info("CPU_INFOS")["CPPA_SRC"]:
 188         cppasrc.append(file)
 189     for file in project_info.info("CPU_INFOS")["CXX_SRC"]:
 190         cxxsrc.append(file)
 191     for file in project_info.info("CPU_INFOS")["ASRC"]:
 192         asrc.append(file)
 193     csrc = " \\\n\t".join(csrc) + " \\"
 194     pcsrc = " \\\n\t".join(pcsrc) + " \\"
 195     cppasrc = " \\\n\t".join(cppasrc) + " \\"
 196     cxxsrc = " \\\n\t".join(cxxsrc) + " \\"
 197     asrc = " \\\n\t".join(asrc) + " \\"
 198     constants = "\n".join([os.path.basename(project_info.info("PROJECT_PATH")) + "_" + key + " = " + str(value) for key, value in constants.items()])
 199     return csrc, pcsrc, cppasrc, cxxsrc, asrc, constants
 200
 201 def findModuleFiles(module, project_info):
 202     # Find the files related to the selected module
 203     cfiles = []
 204     sfiles = []
 205     # .c files related to the module and the cpu architecture
 206     for filename, path in findDefinitions(module + ".c", project_info) + \
 207             findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".c", project_info):
 208         path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
 209         if os.sep != "/":
 210             path = replaceSeparators(path)
 211         cfiles.append(path + "/" + filename)
 212     # .s files related to the module and the cpu architecture
 213     for filename, path in findDefinitions(module + ".s", project_info) + \
 214             findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".s", project_info) + \
 215             findDefinitions(module + ".S", project_info) + \
 216             findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".S", project_info):
 217         path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
 218         if os.sep != "/":
 219             path = replaceSeparators(path)
 220         sfiles.append(path + "/" + filename)
 221     # .c and .s files related to the module and the cpu tags
 222     for tag in project_info.info("CPU_INFOS")["CPU_TAGS"]:
 223         for filename, path in findDefinitions(module + "_" + tag + ".c", project_info):
 224             path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
 225             if os.sep != "/":
 226                 path = replaceSeparators(path)
 227             cfiles.append(path + "/" + filename)
 228         for filename, path in findDefinitions(module + "_" + tag + ".s", project_info) + \
 229                 findDefinitions(module + "_" + tag + ".S", project_info):
 230             path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
 231             if os.sep != "/":
 232                 path = replaceSeparators(path)
 233             sfiles.append(path + "/" + filename)
 234     return cfiles, sfiles
 235
 236 def replaceSeparators(path):
 237     """
 238     Replace the separators in the given path with unix standard separator.
 239     """
 240     while path.find(os.sep) != -1:
 241         path = path.replace(os.sep, "/")
 242     return path
 243
 244 def getSystemPath():
 245     path = os.environ["PATH"]
 246     if os.name == "nt":
 247         path = path.split(";")
 248     else:
 249         path = path.split(":")
 250     return path
 251
 252 def findToolchains(path_list):
 253     toolchains = []
 254     for element in path_list:
 255         for toolchain in glob.glob(element+ "/" + const.GCC_NAME):
 256             toolchains.append(toolchain)
 257     return list(set(toolchains))
 258
 259 def getToolchainInfo(output):
 260     info = {}
 261     expr = re.compile("Target: .*")
 262     target = expr.findall(output)
 263     if len(target) == 1:
 264         info["target"] = target[0].split("Target: ")[1]
 265     expr = re.compile("gcc version [0-9,.]*")
 266     version = expr.findall(output)
 267     if len(version) == 1:
 268         info["version"] = version[0].split("gcc version ")[1]
 269     expr = re.compile("gcc version [0-9,.]* \(.*\)")
 270     build = expr.findall(output)
 271     if len(build) == 1:
 272         build = build[0].split("gcc version ")[1]
 273         build = build[build.find("(") + 1 : build.find(")")]
 274         info["build"] = build
 275     expr = re.compile("Configured with: .*")
 276     configured = expr.findall(output)
 277     if len(configured) == 1:
 278         info["configured"] = configured[0].split("Configured with: ")[1]
 279     expr = re.compile("Thread model: .*")
 280     thread = expr.findall(output)
 281     if len(thread) == 1:
 282         info["thread"] = thread[0].split("Thread model: ")[1]
 283     return info
 284
 285 def loadSourceTree(project):
 286     fileList = [f for f in os.walk(project.info("SOURCES_PATH"))]
 287     project.setInfo("FILE_LIST", fileList)
 288
 289 def findDefinitions(ftype, project):
 290     L = project.info("FILE_LIST")
 291     definitions = []
 292     for element in L:
 293         for filename in element[2]:
 294             if fnmatch.fnmatch(filename, ftype):
 295                 definitions.append((filename, element[0]))
 296     return definitions
 297
 298 def loadCpuInfos(project):
 299     cpuInfos = []
 300     for definition in findDefinitions(const.CPU_DEFINITION, project):
 301         cpuInfos.append(getInfos(definition))
 302     return cpuInfos
 303
 304 def getTagSet(cpu_info):
 305     tag_set = set([])
 306     for cpu in cpu_info:
 307         tag_set |= set([cpu["CPU_NAME"]])
 308         tag_set |= set(cpu["CPU_TAGS"])
 309         tag_set |= set([cpu["CORE_CPU"]])
 310         tag_set |= set([cpu["TOOLCHAIN"]])
 311     return tag_set
 312
 313
 314 def getInfos(definition):
 315     D = {}
 316     D.update(const.CPU_DEF)
 317     def include(filename, dict = D, directory=definition[1]):
 318         execfile(directory + "/" + filename, {}, D)
 319     D["include"] = include
 320     include(definition[0], D)
 321     D["CPU_NAME"] = definition[0].split(".")[0]
 322     D["DEFINITION_PATH"] = definition[1] + "/" + definition[0]
 323     del D["include"]
 324     return D
 325
 326 def getCommentList(string):
 327     comment_list = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/", string)
 328     comment_list = [re.findall(r"^\s*\* *(.*?)$", comment, re.MULTILINE) for comment in comment_list]
 329     return comment_list
 330
 331 def loadModuleDefinition(first_comment):
 332     to_be_parsed = False
 333     module_definition = {}
 334     for num, line in enumerate(first_comment):
 335         index = line.find("$WIZ$")
 336         if index != -1:
 337             to_be_parsed = True
 338             try:
 339                 exec line[index + len("$WIZ$ "):] in {}, module_definition
 340             except:
 341                 raise ParseError(num, line[index:])
 342         elif line.find("\\brief") != -1:
 343             module_definition["module_description"] = line[line.find("\\brief") + len("\\brief "):]
 344     module_dict = {}
 345     if "module_name" in module_definition:
 346         module_name = module_definition[const.MODULE_DEFINITION["module_name"]]
 347         del module_definition[const.MODULE_DEFINITION["module_name"]]
 348         module_dict[module_name] = {}
 349         if const.MODULE_DEFINITION["module_depends"] in module_definition:
 350             depends = module_definition[const.MODULE_DEFINITION["module_depends"]]
 351             del module_definition[const.MODULE_DEFINITION["module_depends"]]
 352             if type(depends) == str:
 353                 depends = (depends,)
 354             module_dict[module_name]["depends"] = depends
 355         else:
 356             module_dict[module_name]["depends"] = ()
 357         if const.MODULE_DEFINITION["module_configuration"] in module_definition:
 358             module_dict[module_name]["configuration"] = module_definition[const.MODULE_DEFINITION["module_configuration"]]
 359             del module_definition[const.MODULE_DEFINITION["module_configuration"]]
 360         else:
 361             module_dict[module_name]["configuration"] = ""
 362         if "module_description" in module_definition:
 363             module_dict[module_name]["description"] = module_definition["module_description"]
 364             del module_definition["module_description"]
 365         if const.MODULE_DEFINITION["module_harvard"] in module_definition:
 366             harvard = module_definition[const.MODULE_DEFINITION["module_harvard"]]
 367             if harvard == "both" or harvard == "pgm_memory":
 368                 module_dict[module_name]["harvard"] = harvard
 369             del module_definition[const.MODULE_DEFINITION["module_harvard"]]
 370         if const.MODULE_DEFINITION["module_hw"] in module_definition:
 371             hw = module_definition[const.MODULE_DEFINITION["module_hw"]]
 372             del module_definition[const.MODULE_DEFINITION["module_hw"]]
 373             if type(hw) == str:
 374                 hw = (hw, )
 375             module_dict[module_name]["hw"] = hw
 376         else:
 377             module_dict[module_name]["hw"] = ()
 378         if const.MODULE_DEFINITION["module_supports"] in module_definition:
 379             supports = module_definition[const.MODULE_DEFINITION["module_supports"]]
 380             del module_definition[const.MODULE_DEFINITION["module_supports"]]
 381             module_dict[module_name]["supports"] = supports
 382         module_dict[module_name]["constants"] = module_definition
 383         module_dict[module_name]["enabled"] = False
 384     return to_be_parsed, module_dict
 385
 386 def isSupported(project, module=None, property_id=None):
 387     if not module and property_id:
 388         item = project.info("CONFIGURATIONS")[property_id[0]][property_id[1]]["informations"]
 389     else:
 390         item = project.info("MODULES")[module]
 391     tag_dict = project.info("ALL_CPU_TAGS")
 392     if "supports" in item:
 393         support_string = item["supports"]
 394         supported = {}
 395         try:
 396             exec "supported = " + support_string in tag_dict, supported
 397         except:
 398             raise SupportedException(support_string)
 399         return supported["supported"]
 400     else:
 401         return True
 402
 403 def loadDefineLists(comment_list):
 404     define_list = {}
 405     for comment in comment_list:
 406         for num, line in enumerate(comment):
 407             index = line.find("$WIZ$")
 408             if index != -1:
 409                 try:
 410                     exec line[index + len("$WIZ$ "):] in {}, define_list
 411                 except:
 412                     raise ParseError(num, line[index:])
 413     for key, value in define_list.items():
 414         if type(value) == str:
 415             define_list[key] = (value,)
 416     return define_list
 417
 418 def getDescriptionInformations(comment):
 419     """
 420     Take the doxygen comment and strip the wizard informations, returning the tuple
 421     (comment, wizard_information)
 422     """
 423     brief = ""
 424     description = ""
 425     information = {}
 426     for num, line in enumerate(comment):
 427         index = line.find("$WIZ$")
 428         if index != -1:
 429             if len(brief) == 0:
 430                 brief += line[:index].strip()
 431             else:
 432                 description += " " + line[:index]
 433             try:
 434                 exec line[index + len("$WIZ$ "):] in {}, information
 435             except:
 436                 raise ParseError(num, line[index:])
 437         else:
 438             if len(brief) == 0:
 439                 brief += line.strip()
 440             else:
 441                 description += " " + line
 442                 description = description.strip()
 443     return brief.strip(), description.strip(), information
 444
 445 def getDefinitionBlocks(text):
 446     """
 447     Take a text and return a list of tuple (description, name-value).
 448     """
 449     block = []
 450     block_tmp = re.finditer(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
 451     for match in block_tmp:
 452         # Only the first element is needed
 453         comment = match.group(1)
 454         define = match.group(2)
 455         start = match.start()
 456         block.append(([re.findall(r"^\s*\* *(.*?)$", line, re.MULTILINE)[0] for line in comment.splitlines()], define, start))
 457     for match in re.finditer(r"/{3}\s*([^<].*?)\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
 458         comment = match.group(1)
 459         define = match.group(2)
 460         start = match.start()
 461         block.append(([comment], define, start))
 462     for match in re.finditer(r"#define\s*(.*?)\s*/{3}<\s*(.+?)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
 463         comment = match.group(2)
 464         define = match.group(1)
 465         start = match.start()
 466         block.append(([comment], define, start))
 467     return block
 468
 469 def loadModuleData(project):
 470     module_info_dict = {}
 471     list_info_dict = {}
 472     configuration_info_dict = {}
 473     file_dict = {}
 474     for filename, path in findDefinitions("*.h", project) + findDefinitions("*.c", project) + findDefinitions("*.s", project) + findDefinitions("*.S", project):
 475         comment_list = getCommentList(open(path + "/" + filename, "r").read())
 476         if len(comment_list) > 0:
 477             module_info = {}
 478             configuration_info = {}
 479             try:
 480                 to_be_parsed, module_dict = loadModuleDefinition(comment_list[0])
 481             except ParseError, err:
 482                 raise DefineException.ModuleDefineException(path, err.line_number, err.line)
 483             for module, information in module_dict.items():
 484                 if "depends" not in information:
 485                     information["depends"] = ()
 486                 information["depends"] += (filename.split(".")[0],)
 487                 information["category"] = os.path.basename(path)
 488                 if "configuration" in information and len(information["configuration"]):
 489                     configuration = module_dict[module]["configuration"]
 490                     try:
 491                         configuration_info[configuration] = loadConfigurationInfos(project.info("SOURCES_PATH") + "/" + configuration)
 492                     except ParseError, err:
 493                         raise DefineException.ConfigurationDefineException(project.info("SOURCES_PATH") + "/" + configuration, err.line_number, err.line)
 494             module_info_dict.update(module_dict)
 495             configuration_info_dict.update(configuration_info)
 496             if to_be_parsed:
 497                 try:
 498                     list_dict = loadDefineLists(comment_list[1:])
 499                     list_info_dict.update(list_dict)
 500                 except ParseError, err:
 501                     raise DefineException.EnumDefineException(path, err.line_number, err.line)
 502     for filename, path in findDefinitions("*_" + project.info("CPU_INFOS")["TOOLCHAIN"] + ".h", project):
 503         comment_list = getCommentList(open(path + "/" + filename, "r").read())
 504         list_info_dict.update(loadDefineLists(comment_list))
 505     for tag in project.info("CPU_INFOS")["CPU_TAGS"]:
 506         for filename, path in findDefinitions("*_" + tag + ".h", project):
 507             comment_list = getCommentList(open(path + "/" + filename, "r").read())
 508             list_info_dict.update(loadDefineLists(comment_list))
 509     project.setInfo("MODULES", module_info_dict)
 510     project.setInfo("LISTS", list_info_dict)
 511     project.setInfo("CONFIGURATIONS", configuration_info_dict)
 512     project.setInfo("FILES", file_dict)
 513
 514 def formatParamNameValue(text):
 515     """
 516     Take the given string and return a tuple with the name of the parameter in the first position
 517     and the value in the second.
 518     """
 519     block = re.findall("\s*([^\s]+)\s*(.+?)\s*$", text, re.MULTILINE)
 520     return block[0]
 521
 522 def loadConfigurationInfos(path):
 523     """
 524     Return the module configurations found in the given file as a dict with the
 525     parameter name as key and a dict containig the fields above as value:
 526         "value": the value of the parameter
 527         "description": the description of the parameter
 528         "informations": a dict containig optional informations:
 529             "type": "int" | "boolean" | "enum"
 530             "min": the minimum value for integer parameters
 531             "max": the maximum value for integer parameters
 532             "long": boolean indicating if the num is a long
 533             "unsigned": boolean indicating if the num is an unsigned
 534             "value_list": the name of the enum for enum parameters
 535     """
 536     configuration_infos = {}
 537     configuration_infos["paramlist"] = []
 538     for comment, define, start in getDefinitionBlocks(open(path, "r").read()):
 539         name, value = formatParamNameValue(define)
 540         brief, description, informations = getDescriptionInformations(comment)
 541         configuration_infos["paramlist"].append((start, name))
 542         configuration_infos[name] = {}
 543         configuration_infos[name]["value"] = value
 544         configuration_infos[name]["informations"] = informations
 545         if not "type" in configuration_infos[name]["informations"]:
 546             configuration_infos[name]["informations"]["type"] = findParameterType(configuration_infos[name])
 547         if ("type" in configuration_infos[name]["informations"] and
 548                 configuration_infos[name]["informations"]["type"] == "int" and
 549                 configuration_infos[name]["value"].find("L") != -1):
 550             configuration_infos[name]["informations"]["long"] = True
 551             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("L", "")
 552         if ("type" in configuration_infos[name]["informations"] and
 553                 configuration_infos[name]["informations"]["type"] == "int" and
 554                 configuration_infos[name]["value"].find("U") != -1):
 555             configuration_infos[name]["informations"]["unsigned"] = True
 556             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("U", "")
 557         configuration_infos[name]["description"] = description
 558         configuration_infos[name]["brief"] = brief
 559     return configuration_infos
 560
 561 def findParameterType(parameter):
 562     if "value_list" in parameter["informations"]:
 563         return "enum"
 564     if "min" in parameter["informations"] or "max" in parameter["informations"] or re.match(r"^\d+U?L?$", parameter["value"]) != None:
 565         return "int"
 566
 567 def sub(string, parameter, value):
 568     """
 569     Substitute the given value at the given parameter define in the given string
 570     """
 571     return re.sub(r"(?P<define>#define\s+" + parameter + r"\s+)([^\s]+)", r"\g<define>" + value, string)
 572
 573 def isInt(informations):
 574     """
 575     Return True if the value is a simple int.
 576     """
 577     if ("long" not in informatios or not informations["long"]) and ("unsigned" not in informations or informations["unsigned"]):
 578         return True
 579     else:
 580         return False
 581
 582 def isLong(informations):
 583     """
 584     Return True if the value is a long.
 585     """
 586     if "long" in informations and informations["long"] and "unsigned" not in informations:
 587         return True
 588     else:
 589         return False
 590
 591 def isUnsigned(informations):
 592     """
 593     Return True if the value is an unsigned.
 594     """
 595     if "unsigned" in informations and informations["unsigned"] and "long" not in informations:
 596         return True
 597     else:
 598         return False
 599
 600 def isUnsignedLong(informations):
 601     """
 602     Return True if the value is an unsigned long.
 603     """
 604     if "unsigned" in informations and "long" in informations and informations["unsigned"] and informations["long"]:
 605         return True
 606     else:
 607         return False
 608
 609 class ParseError(Exception):
 610     def __init__(self, line_number, line):
 611         Exception.__init__(self)
 612         self.line_number = line_number
 613         self.line = line
 614
 615 class SupportedException(Exception):
 616     def __init__(self, support_string):
 617         Exception.__init__(self)
 618         self.support_string = support_string