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 import BProject
  49
  50 def isBertosDir(directory):
  51    return os.path.exists(directory + "/VERSION")
  52
  53 def bertosVersion(directory):
  54    return open(directory + "/VERSION").readline().strip()
  55
  56 def loadBertosProject(project_file):
  57     project_data = pickle.loads(open(project_file, "r").read())
  58     project_info = BProject.BProject()
  59     project_info.setInfo("PROJECT_PATH", os.path.dirname(project_file))
  60     project_info.setInfo("SOURCES_PATH", project_data["SOURCES_PATH"])
  61     project_info.setInfo("TOOLCHAIN", project_data["TOOLCHAIN"])
  62     project_info.setInfo("SELECTED_FREQ", project_data["SELECTED_FREQ"])
  63     project_info.setInfo("OUTPUT", project_data["OUTPUT"])
  64     loadSourceTree(project_info)
  65     cpu_name = project_data["CPU_NAME"]
  66     project_info.setInfo("CPU_NAME", cpu_name)
  67     cpu_info = loadCpuInfos(project_info)
  68     for cpu in cpu_info:
  69         if cpu["CPU_NAME"] == cpu_name:
  70             project_info.setInfo("CPU_INFOS", cpu)
  71             break
  72     tag_list = getTagSet(cpu_info)
  73     # Create, fill and store the dict with the tags
  74     tag_dict = {}
  75     for element in tag_list:
  76         tag_dict[element] = False
  77     infos = project_info.info("CPU_INFOS")
  78     for tag in tag_dict:
  79         if tag in infos["CPU_TAGS"] + [infos["CPU_NAME"], infos["TOOLCHAIN"]]:
  80             tag_dict[tag] = True
  81         else:
  82             tag_dict[tag] = False
  83     project_info.setInfo("ALL_CPU_TAGS", tag_dict)
  84     loadModuleData(project_info, True)
  85     setEnabledModules(project_info, project_data["ENABLED_MODULES"])
  86     return project_info
  87
  88 def setEnabledModules(project_info, enabled_modules):
  89     modules = project_info.info("MODULES")
  90     files = {}
  91     for module, information in modules.items():
  92         information["enabled"] = module in enabled_modules
  93         for dependency in information["depends"]:
  94             if not dependency in modules:
  95                 if dependency in files:
  96                     files[dependency] += 1
  97                 else:
  98                     files[dependency] = 1
  99     project_info.setInfo("MODULES", modules)
 100     project_info.setInfo("FILES", files)
 101
 102 def enabledModules(project_info):
 103     enabled_modules = []
 104     for name, module in project_info.info("MODULES").items():
 105         if module["enabled"]:
 106             enabled_modules.append(name)
 107     return enabled_modules
 108
 109 def mergeSources(srcdir, new_sources, old_sources):
 110     # The current mergeSources function provide only a raw copy of the sources in the
 111     # created project.
 112     #
 113     # TODO: implement the three way merge algorithm
 114     #
 115     shutil.rmtree(srcdir, True)
 116     copytree.copytree(sources_dir + "/bertos", srcdir, ignore_list=const.IGNORE_LIST)
 117
 118 def projectFileGenerator(project_info):
 119     directory = project_info.info("PROJECT_PATH")
 120     project_data = {}
 121     enabled_modules = []
 122     for module, information in project_info.info("MODULES").items():
 123         if information["enabled"]:
 124             enabled_modules.append(module)
 125     project_data["ENABLED_MODULES"] = enabled_modules
 126     project_data["SOURCES_PATH"] = project_info.info("SOURCES_PATH")
 127     project_data["TOOLCHAIN"] = project_info.info("TOOLCHAIN")
 128     project_data["CPU_NAME"] = project_info.info("CPU_NAME")
 129     project_data["SELECTED_FREQ"] = project_info.info("SELECTED_FREQ")
 130     project_data["OUTPUT"] = project_info.info("OUTPUT")
 131     return pickle.dumps(project_data)
 132
 133 def createBertosProject(project_info, edit=False):
 134     directory = project_info.info("PROJECT_PATH")
 135     sources_dir = project_info.info("SOURCES_PATH")
 136     old_sources_dir = project_info.info("OLD_SOURCES_PATH")
 137     if not edit:
 138         if os.path.isdir(directory):
 139             shutil.rmtree(directory, True)
 140         os.makedirs(directory)
 141     # Write the project file
 142     f = open(directory + "/project.bertos", "w")
 143     f.write(projectFileGenerator(project_info))
 144     f.close()
 145     # Destination source dir
 146     srcdir = directory + "/bertos"
 147     if not edit:
 148         # If not in editing mode it copies all the bertos sources in the /bertos subdirectory of the project
 149         shutil.rmtree(srcdir, True)
 150         copytree.copytree(sources_dir + "/bertos", srcdir, ignore_list=const.IGNORE_LIST)
 151     elif old_sources_dir:
 152         # If in editing mode it merges the current bertos sources with the selected ones
 153         # TODO: implement the three way merge algotihm
 154         #
 155         mergeSources(srcdir, sources_dir, old_sources_dir)
 156     # Destination makefile
 157     makefile = directory + "/Makefile"
 158     makefile = open("mktemplates/Makefile").read()
 159     makefile = makefileGenerator(project_info, makefile)
 160     open(directory + "/Makefile", "w").write(makefile)
 161     # Destination project dir
 162     prjdir = directory + "/" + os.path.basename(directory)
 163     if not edit:
 164         shutil.rmtree(prjdir, True)
 165         os.mkdir(prjdir)
 166     # Destination hw files
 167     hwdir = prjdir + "/hw"
 168     if not edit:
 169         shutil.rmtree(hwdir, True)
 170         os.mkdir(hwdir)
 171     # Copy all the hw files
 172     for module, information in project_info.info("MODULES").items():
 173         for hwfile in information["hw"]:
 174             string = open(sources_dir + "/" + hwfile, "r").read()
 175             hwfile_path = hwdir + "/" + os.path.basename(hwfile)
 176             if not edit or not os.path.exists(hwfile_path):
 177                 # If not in editing mode it copies all the hw files. If in
 178                 # editing mode it copies only the files that don't exist yet
 179                 open(hwdir + "/" + os.path.basename(hwfile), "w").write(string)
 180     # Destination configurations files
 181     cfgdir = prjdir + "/cfg"
 182     if not edit:
 183         shutil.rmtree(cfgdir, True)
 184         os.mkdir(cfgdir)
 185     # Set properly the autoenabled parameters
 186     for module, information in project_info.info("MODULES").items():
 187         if "configuration" in information and information["configuration"] != "":
 188             configurations = project_info.info("CONFIGURATIONS")
 189             configuration = configurations[information["configuration"]]
 190             for start, parameter in configuration["paramlist"]:
 191                 if "type" in configuration[parameter]["informations"] and configuration[parameter]["informations"]["type"] == "autoenabled":
 192                     configuration[parameter]["value"] = "1" if information["enabled"] else "0"
 193             project_info.setInfo("CONFIGURATIONS", configurations)
 194     # Copy all the configuration files
 195     for configuration, information in project_info.info("CONFIGURATIONS").items():
 196         string = open(sources_dir + "/" + configuration, "r").read()
 197         for start, parameter in information["paramlist"]:
 198             infos = information[parameter]
 199             value = infos["value"]
 200             if "unsigned" in infos["informations"] and infos["informations"]["unsigned"]:
 201                 value += "U"
 202             if "long" in infos["informations"] and infos["informations"]["long"]:
 203                 value += "L"
 204             string = sub(string, parameter, value)
 205         f = open(cfgdir + "/" + os.path.basename(configuration), "w")
 206         f.write(string)
 207         f.close()
 208     if not edit:
 209         # Destination user mk file (only on project creation)
 210         makefile = open("mktemplates/template.mk", "r").read()
 211         makefile = mkGenerator(project_info, makefile)
 212         open(prjdir + "/" + os.path.basename(prjdir) + ".mk", "w").write(makefile)
 213     # Destination wizard mk file
 214     makefile = open("mktemplates/template_wiz.mk", "r").read()
 215     makefile = mkGenerator(project_info, makefile)
 216     open(prjdir + "/" + os.path.basename(prjdir) + "_wiz.mk", "w").write(makefile)
 217     # Destination main.c file
 218     if not edit:
 219         main = open("srctemplates/main.c", "r").read()
 220         open(prjdir + "/main.c", "w").write(main)
 221     # Files for selected plugins
 222     relevants_files = {}
 223     for plugin in project_info.info("OUTPUT"):
 224         module = loadPlugin(plugin)
 225         relevants_files[plugin] = module.createProject(project_info)
 226     project_info.setInfo("RELEVANT_FILES", relevants_files)
 227
 228 def loadPlugin(plugin):
 229     """
 230     Returns the given plugin module.
 231     """
 232     return getattr(__import__("plugins", {}, {}, [plugin]), plugin)
 233
 234 def mkGenerator(project_info, makefile):
 235     """
 236     Generates the mk file for the current project.
 237     """
 238     mk_data = {}
 239     mk_data["$pname"] = os.path.basename(project_info.info("PROJECT_PATH"))
 240     mk_data["$cpuclockfreq"] = project_info.info("SELECTED_FREQ")
 241     cpu_mk_parameters = []
 242     for key, value in project_info.info("CPU_INFOS").items():
 243         if key.startswith(const.MK_PARAM_ID):
 244             cpu_mk_parameters.append("%s = %s" %(key.replace("MK", mk_data["$pname"]), value))
 245     mk_data["$cpuparameters"] = "\n".join(cpu_mk_parameters)
 246     mk_data["$csrc"], mk_data["$pcsrc"], mk_data["$cppasrc"], mk_data["$cxxsrc"], mk_data["$asrc"], mk_data["$constants"] = csrcGenerator(project_info)
 247     mk_data["$prefix"] = replaceSeparators(project_info.info("TOOLCHAIN")["path"].split("gcc")[0])
 248     mk_data["$suffix"] = replaceSeparators(project_info.info("TOOLCHAIN")["path"].split("gcc")[1])
 249     mk_data["$main"] = os.path.basename(project_info.info("PROJECT_PATH")) + "/main.c"
 250     for key in mk_data:
 251         while makefile.find(key) != -1:
 252             makefile = makefile.replace(key, mk_data[key])
 253     return makefile
 254
 255 def makefileGenerator(project_info, makefile):
 256     """
 257     Generate the Makefile for the current project.
 258     """
 259     # TODO write a general function that works for both the mk file and the Makefile
 260     while makefile.find("$pname") != -1:
 261         makefile = makefile.replace("$pname", os.path.basename(project_info.info("PROJECT_PATH")))
 262     return makefile
 263
 264 def csrcGenerator(project_info):
 265     modules = project_info.info("MODULES")
 266     files = project_info.info("FILES")
 267     if "harvard" in project_info.info("CPU_INFOS")["CPU_TAGS"]:
 268         harvard = True
 269     else:
 270         harvard = False
 271     # file to be included in CSRC variable
 272     csrc = []
 273     # file to be included in PCSRC variable
 274     pcsrc = []
 275     # files to be included in CPPASRC variable
 276     cppasrc = []
 277     # files to be included in CXXSRC variable
 278     cxxsrc = []
 279     # files to be included in ASRC variable
 280     asrc = []
 281     # constants to be included at the beginning of the makefile
 282     constants = {}
 283     for module, information in modules.items():
 284         module_files = set([])
 285         dependency_files = set([])
 286         # assembly sources
 287         asm_files = set([])
 288         hwdir = os.path.basename(project_info.info("PROJECT_PATH")) + "/hw"
 289         if information["enabled"]:
 290             if "constants" in information:
 291                 constants.update(information["constants"])
 292             cfiles, sfiles = findModuleFiles(module, project_info)
 293             module_files |= set(cfiles)
 294             asm_files |= set(sfiles)
 295             for file in information["hw"]:
 296                 if file.endswith(".c"):
 297                     module_files |= set([hwdir + "/" + os.path.basename(file)])
 298             for file_dependency in information["depends"]:
 299                 if file_dependency in files:
 300                     dependencyCFiles, dependencySFiles = findModuleFiles(file_dependency, project_info)
 301                     dependency_files |= set(dependencyCFiles)
 302                     asm_files |= set(dependencySFiles)
 303             for file in module_files:
 304                 if not harvard or information.get("harvard", "both") == "both":
 305                     csrc.append(file)
 306                 if harvard and "harvard" in information:
 307                     pcsrc.append(file)
 308             for file in dependency_files:
 309                 csrc.append(file)
 310             for file in project_info.info("CPU_INFOS")["C_SRC"]:
 311                 csrc.append(file)
 312             for file in project_info.info("CPU_INFOS")["PC_SRC"]:
 313                 pcsrc.append(file)
 314             for file in asm_files:
 315                 cppasrc.append(file)
 316     for file in project_info.info("CPU_INFOS")["CPPA_SRC"]:
 317         cppasrc.append(file)
 318     for file in project_info.info("CPU_INFOS")["CXX_SRC"]:
 319         cxxsrc.append(file)
 320     for file in project_info.info("CPU_INFOS")["ASRC"]:
 321         asrc.append(file)
 322     csrc = " \\\n\t".join(csrc) + " \\"
 323     pcsrc = " \\\n\t".join(pcsrc) + " \\"
 324     cppasrc = " \\\n\t".join(cppasrc) + " \\"
 325     cxxsrc = " \\\n\t".join(cxxsrc) + " \\"
 326     asrc = " \\\n\t".join(asrc) + " \\"
 327     constants = "\n".join([os.path.basename(project_info.info("PROJECT_PATH")) + "_" + key + " = " + unicode(value) for key, value in constants.items()])
 328     return csrc, pcsrc, cppasrc, cxxsrc, asrc, constants
 329
 330 def findModuleFiles(module, project_info):
 331     # Find the files related to the selected module
 332     cfiles = []
 333     sfiles = []
 334     # .c files related to the module and the cpu architecture
 335     for filename, path in findDefinitions(module + ".c", project_info) + \
 336             findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".c", project_info):
 337         path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
 338         path = replaceSeparators(path)
 339         cfiles.append(path + "/" + filename)
 340     # .s files related to the module and the cpu architecture
 341     for filename, path in findDefinitions(module + ".s", project_info) + \
 342             findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".s", project_info) + \
 343             findDefinitions(module + ".S", project_info) + \
 344             findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".S", project_info):
 345         path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
 346         path = replaceSeparators(path)
 347         sfiles.append(path + "/" + filename)
 348     # .c and .s files related to the module and the cpu tags
 349     for tag in project_info.info("CPU_INFOS")["CPU_TAGS"]:
 350         for filename, path in findDefinitions(module + "_" + tag + ".c", project_info):
 351             path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
 352             if os.sep != "/":
 353                 path = replaceSeparators(path)
 354             cfiles.append(path + "/" + filename)
 355         for filename, path in findDefinitions(module + "_" + tag + ".s", project_info) + \
 356                 findDefinitions(module + "_" + tag + ".S", project_info):
 357             path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
 358             path = replaceSeparators(path)
 359             sfiles.append(path + "/" + filename)
 360     return cfiles, sfiles
 361
 362 def replaceSeparators(path):
 363     """
 364     Replace the separators in the given path with unix standard separator.
 365     """
 366     if os.sep != "/":
 367         while path.find(os.sep) != -1:
 368             path = path.replace(os.sep, "/")
 369     return path
 370
 371 def getSystemPath():
 372     path = os.environ["PATH"]
 373     if os.name == "nt":
 374         path = path.split(";")
 375     else:
 376         path = path.split(":")
 377     return path
 378
 379 def findToolchains(path_list):
 380     toolchains = []
 381     for element in path_list:
 382         for toolchain in glob.glob(element+ "/" + const.GCC_NAME):
 383             toolchains.append(toolchain)
 384     return list(set(toolchains))
 385
 386 def getToolchainInfo(output):
 387     info = {}
 388     expr = re.compile("Target: .*")
 389     target = expr.findall(output)
 390     if len(target) == 1:
 391         info["target"] = target[0].split("Target: ")[1]
 392     expr = re.compile("gcc version [0-9,.]*")
 393     version = expr.findall(output)
 394     if len(version) == 1:
 395         info["version"] = version[0].split("gcc version ")[1]
 396     expr = re.compile("gcc version [0-9,.]* \(.*\)")
 397     build = expr.findall(output)
 398     if len(build) == 1:
 399         build = build[0].split("gcc version ")[1]
 400         build = build[build.find("(") + 1 : build.find(")")]
 401         info["build"] = build
 402     expr = re.compile("Configured with: .*")
 403     configured = expr.findall(output)
 404     if len(configured) == 1:
 405         info["configured"] = configured[0].split("Configured with: ")[1]
 406     expr = re.compile("Thread model: .*")
 407     thread = expr.findall(output)
 408     if len(thread) == 1:
 409         info["thread"] = thread[0].split("Thread model: ")[1]
 410     return info
 411
 412 def getToolchainName(toolchain_info):
 413     name = "GCC " + toolchain_info["version"] + " - " + toolchain_info["target"].strip()
 414     return name
 415
 416 def loadSourceTree(project):
 417     fileList = [f for f in os.walk(project.info("SOURCES_PATH"))]
 418     project.setInfo("FILE_LIST", fileList)
 419
 420 def findDefinitions(ftype, project):
 421     L = project.info("FILE_LIST")
 422     definitions = []
 423     for element in L:
 424         for filename in element[2]:
 425             if fnmatch.fnmatch(filename, ftype):
 426                 definitions.append((filename, element[0]))
 427     return definitions
 428
 429 def loadCpuInfos(project):
 430     cpuInfos = []
 431     for definition in findDefinitions(const.CPU_DEFINITION, project):
 432         cpuInfos.append(getInfos(definition))
 433     return cpuInfos
 434
 435 def getTagSet(cpu_info):
 436     tag_set = set([])
 437     for cpu in cpu_info:
 438         tag_set |= set([cpu["CPU_NAME"]])
 439         tag_set |= set(cpu["CPU_TAGS"])
 440         tag_set |= set([cpu["TOOLCHAIN"]])
 441     return tag_set
 442
 443
 444 def getInfos(definition):
 445     D = {}
 446     D.update(const.CPU_DEF)
 447     def include(filename, dict = D, directory=definition[1]):
 448         execfile(directory + "/" + filename, {}, D)
 449     D["include"] = include
 450     include(definition[0], D)
 451     D["CPU_NAME"] = definition[0].split(".")[0]
 452     D["DEFINITION_PATH"] = definition[1] + "/" + definition[0]
 453     del D["include"]
 454     return D
 455
 456 def getCommentList(string):
 457     comment_list = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/", string)
 458     comment_list = [re.findall(r"^\s*\* *(.*?)$", comment, re.MULTILINE) for comment in comment_list]
 459     return comment_list
 460
 461 def loadModuleDefinition(first_comment):
 462     to_be_parsed = False
 463     module_definition = {}
 464     for num, line in enumerate(first_comment):
 465         index = line.find("$WIZ$")
 466         if index != -1:
 467             to_be_parsed = True
 468             try:
 469                 exec line[index + len("$WIZ$ "):] in {}, module_definition
 470             except:
 471                 raise ParseError(num, line[index:])
 472         elif line.find("\\brief") != -1:
 473             module_definition["module_description"] = line[line.find("\\brief") + len("\\brief "):]
 474     module_dict = {}
 475     if "module_name" in module_definition:
 476         module_name = module_definition[const.MODULE_DEFINITION["module_name"]]
 477         del module_definition[const.MODULE_DEFINITION["module_name"]]
 478         module_dict[module_name] = {}
 479         if const.MODULE_DEFINITION["module_depends"] in module_definition:
 480             depends = module_definition[const.MODULE_DEFINITION["module_depends"]]
 481             del module_definition[const.MODULE_DEFINITION["module_depends"]]
 482             if type(depends) == str:
 483                 depends = (depends,)
 484             module_dict[module_name]["depends"] = depends
 485         else:
 486             module_dict[module_name]["depends"] = ()
 487         if const.MODULE_DEFINITION["module_configuration"] in module_definition:
 488             module_dict[module_name]["configuration"] = module_definition[const.MODULE_DEFINITION["module_configuration"]]
 489             del module_definition[const.MODULE_DEFINITION["module_configuration"]]
 490         else:
 491             module_dict[module_name]["configuration"] = ""
 492         if "module_description" in module_definition:
 493             module_dict[module_name]["description"] = module_definition["module_description"]
 494             del module_definition["module_description"]
 495         if const.MODULE_DEFINITION["module_harvard"] in module_definition:
 496             harvard = module_definition[const.MODULE_DEFINITION["module_harvard"]]
 497             module_dict[module_name]["harvard"] = harvard
 498             del module_definition[const.MODULE_DEFINITION["module_harvard"]]
 499         if const.MODULE_DEFINITION["module_hw"] in module_definition:
 500             hw = module_definition[const.MODULE_DEFINITION["module_hw"]]
 501             del module_definition[const.MODULE_DEFINITION["module_hw"]]
 502             if type(hw) == str:
 503                 hw = (hw, )
 504             module_dict[module_name]["hw"] = hw
 505         else:
 506             module_dict[module_name]["hw"] = ()
 507         if const.MODULE_DEFINITION["module_supports"] in module_definition:
 508             supports = module_definition[const.MODULE_DEFINITION["module_supports"]]
 509             del module_definition[const.MODULE_DEFINITION["module_supports"]]
 510             module_dict[module_name]["supports"] = supports
 511         module_dict[module_name]["constants"] = module_definition
 512         module_dict[module_name]["enabled"] = False
 513     return to_be_parsed, module_dict
 514
 515 def isSupported(project, module=None, property_id=None):
 516     if not module and property_id:
 517         item = project.info("CONFIGURATIONS")[property_id[0]][property_id[1]]["informations"]
 518     else:
 519         item = project.info("MODULES")[module]
 520     tag_dict = project.info("ALL_CPU_TAGS")
 521     if "supports" in item:
 522         support_string = item["supports"]
 523         supported = {}
 524         try:
 525             exec "supported = " + support_string in tag_dict, supported
 526         except:
 527             raise SupportedException(support_string)
 528         return supported["supported"]
 529     else:
 530         return True
 531
 532 def loadDefineLists(comment_list):
 533     define_list = {}
 534     for comment in comment_list:
 535         for num, line in enumerate(comment):
 536             index = line.find("$WIZ$")
 537             if index != -1:
 538                 try:
 539                     exec line[index + len("$WIZ$ "):] in {}, define_list
 540                 except:
 541                     raise ParseError(num, line[index:])
 542     for key, value in define_list.items():
 543         if type(value) == str:
 544             define_list[key] = (value,)
 545     return define_list
 546
 547 def getDescriptionInformations(comment):
 548     """
 549     Take the doxygen comment and strip the wizard informations, returning the tuple
 550     (comment, wizard_information)
 551     """
 552     brief = ""
 553     description = ""
 554     information = {}
 555     for num, line in enumerate(comment):
 556         index = line.find("$WIZ$")
 557         if index != -1:
 558             if len(brief) == 0:
 559                 brief += line[:index].strip()
 560             else:
 561                 description += " " + line[:index]
 562             try:
 563                 exec line[index + len("$WIZ$ "):] in {}, information
 564             except:
 565                 raise ParseError(num, line[index:])
 566         else:
 567             if len(brief) == 0:
 568                 brief += line.strip()
 569             else:
 570                 description += " " + line
 571                 description = description.strip()
 572     return brief.strip(), description.strip(), information
 573
 574 def getDefinitionBlocks(text):
 575     """
 576     Take a text and return a list of tuple (description, name-value).
 577     """
 578     block = []
 579     block_tmp = re.finditer(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
 580     for match in block_tmp:
 581         # Only the first element is needed
 582         comment = match.group(1)
 583         define = match.group(2)
 584         start = match.start()
 585         block.append(([re.findall(r"^\s*\* *(.*?)$", line, re.MULTILINE)[0] for line in comment.splitlines()], define, start))
 586     for match in re.finditer(r"/{3}\s*([^<].*?)\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
 587         comment = match.group(1)
 588         define = match.group(2)
 589         start = match.start()
 590         block.append(([comment], define, start))
 591     for match in re.finditer(r"#define\s*(.*?)\s*/{3}<\s*(.+?)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
 592         comment = match.group(2)
 593         define = match.group(1)
 594         start = match.start()
 595         block.append(([comment], define, start))
 596     return block
 597
 598 def loadModuleData(project, edit=False):
 599     module_info_dict = {}
 600     list_info_dict = {}
 601     configuration_info_dict = {}
 602     file_dict = {}
 603     for filename, path in findDefinitions("*.h", project) + findDefinitions("*.c", project) + findDefinitions("*.s", project) + findDefinitions("*.S", project):
 604         comment_list = getCommentList(open(path + "/" + filename, "r").read())
 605         if len(comment_list) > 0:
 606             module_info = {}
 607             configuration_info = {}
 608             try:
 609                 to_be_parsed, module_dict = loadModuleDefinition(comment_list[0])
 610             except ParseError, err:
 611                 raise DefineException.ModuleDefineException(path, err.line_number, err.line)
 612             for module, information in module_dict.items():
 613                 if "depends" not in information:
 614                     information["depends"] = ()
 615                 information["depends"] += (filename.split(".")[0],)
 616                 information["category"] = os.path.basename(path)
 617                 if "configuration" in information and len(information["configuration"]):
 618                     configuration = module_dict[module]["configuration"]
 619                     try:
 620                         configuration_info[configuration] = loadConfigurationInfos(project.info("SOURCES_PATH") + "/" + configuration)
 621                     except ParseError, err:
 622                         raise DefineException.ConfigurationDefineException(project.info("SOURCES_PATH") + "/" + configuration, err.line_number, err.line)
 623                     if edit:
 624                         try:
 625                             path = os.path.basename(project.info("PROJECT_PATH"))
 626                             directory = project.info("PROJECT_PATH")
 627                             user_configuration = loadConfigurationInfos(directory + "/" + configuration.replace("bertos", path))
 628                             configuration_info[configuration] = updateConfigurationValues(configuration_info[configuration], user_configuration)
 629                         except ParseError, err:
 630                             raise DefineException.ConfigurationDefineException(directory + "/" + configuration.replace("bertos", path))
 631             module_info_dict.update(module_dict)
 632             configuration_info_dict.update(configuration_info)
 633             if to_be_parsed:
 634                 try:
 635                     list_dict = loadDefineLists(comment_list[1:])
 636                     list_info_dict.update(list_dict)
 637                 except ParseError, err:
 638                     raise DefineException.EnumDefineException(path, err.line_number, err.line)
 639     for filename, path in findDefinitions("*_" + project.info("CPU_INFOS")["TOOLCHAIN"] + ".h", project):
 640         comment_list = getCommentList(open(path + "/" + filename, "r").read())
 641         list_info_dict.update(loadDefineLists(comment_list))
 642     for tag in project.info("CPU_INFOS")["CPU_TAGS"]:
 643         for filename, path in findDefinitions("*_" + tag + ".h", project):
 644             comment_list = getCommentList(open(path + "/" + filename, "r").read())
 645             list_info_dict.update(loadDefineLists(comment_list))
 646     project.setInfo("MODULES", module_info_dict)
 647     project.setInfo("LISTS", list_info_dict)
 648     project.setInfo("CONFIGURATIONS", configuration_info_dict)
 649     project.setInfo("FILES", file_dict)
 650
 651 def formatParamNameValue(text):
 652     """
 653     Take the given string and return a tuple with the name of the parameter in the first position
 654     and the value in the second.
 655     """
 656     block = re.findall("\s*([^\s]+)\s*(.+?)\s*$", text, re.MULTILINE)
 657     return block[0]
 658
 659 def loadConfigurationInfos(path):
 660     """
 661     Return the module configurations found in the given file as a dict with the
 662     parameter name as key and a dict containig the fields above as value:
 663         "value": the value of the parameter
 664         "description": the description of the parameter
 665         "informations": a dict containig optional informations:
 666             "type": "int" | "boolean" | "enum"
 667             "min": the minimum value for integer parameters
 668             "max": the maximum value for integer parameters
 669             "long": boolean indicating if the num is a long
 670             "unsigned": boolean indicating if the num is an unsigned
 671             "value_list": the name of the enum for enum parameters
 672     """
 673     configuration_infos = {}
 674     configuration_infos["paramlist"] = []
 675     for comment, define, start in getDefinitionBlocks(open(path, "r").read()):
 676         name, value = formatParamNameValue(define)
 677         brief, description, informations = getDescriptionInformations(comment)
 678         configuration_infos["paramlist"].append((start, name))
 679         configuration_infos[name] = {}
 680         configuration_infos[name]["value"] = value
 681         configuration_infos[name]["informations"] = informations
 682         if not "type" in configuration_infos[name]["informations"]:
 683             configuration_infos[name]["informations"]["type"] = findParameterType(configuration_infos[name])
 684         if ("type" in configuration_infos[name]["informations"] and
 685                 configuration_infos[name]["informations"]["type"] == "int" and
 686                 configuration_infos[name]["value"].find("L") != -1):
 687             configuration_infos[name]["informations"]["long"] = True
 688             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("L", "")
 689         if ("type" in configuration_infos[name]["informations"] and
 690                 configuration_infos[name]["informations"]["type"] == "int" and
 691                 configuration_infos[name]["value"].find("U") != -1):
 692             configuration_infos[name]["informations"]["unsigned"] = True
 693             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("U", "")
 694         configuration_infos[name]["description"] = description
 695         configuration_infos[name]["brief"] = brief
 696     return configuration_infos
 697
 698 def updateConfigurationValues(def_conf, user_conf):
 699     for param in def_conf["paramlist"]:
 700         if param[1] in user_conf and "value" in user_conf[param[1]]:
 701             def_conf[param[1]]["value"] = user_conf[param[1]]["value"]
 702     return def_conf
 703
 704 def findParameterType(parameter):
 705     if "value_list" in parameter["informations"]:
 706         return "enum"
 707     if "min" in parameter["informations"] or "max" in parameter["informations"] or re.match(r"^\d+U?L?$", parameter["value"]) != None:
 708         return "int"
 709
 710 def sub(string, parameter, value):
 711     """
 712     Substitute the given value at the given parameter define in the given string
 713     """
 714     return re.sub(r"(?P<define>#define\s+" + parameter + r"\s+)([^\s]+)", r"\g<define>" + value, string)
 715
 716 def isInt(informations):
 717     """
 718     Return True if the value is a simple int.
 719     """
 720     if ("long" not in informatios or not informations["long"]) and ("unsigned" not in informations or informations["unsigned"]):
 721         return True
 722     else:
 723         return False
 724
 725 def isLong(informations):
 726     """
 727     Return True if the value is a long.
 728     """
 729     if "long" in informations and informations["long"] and "unsigned" not in informations:
 730         return True
 731     else:
 732         return False
 733
 734 def isUnsigned(informations):
 735     """
 736     Return True if the value is an unsigned.
 737     """
 738     if "unsigned" in informations and informations["unsigned"] and "long" not in informations:
 739         return True
 740     else:
 741         return False
 742
 743 def isUnsignedLong(informations):
 744     """
 745     Return True if the value is an unsigned long.
 746     """
 747     if "unsigned" in informations and "long" in informations and informations["unsigned"] and informations["long"]:
 748         return True
 749     else:
 750         return False
 751
 752 class ParseError(Exception):
 753     def __init__(self, line_number, line):
 754         Exception.__init__(self)
 755         self.line_number = line_number
 756         self.line = line
 757
 758 class SupportedException(Exception):
 759     def __init__(self, support_string):
 760         Exception.__init__(self)
 761         self.support_string = support_string