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
  18 import const
  19 import codelite_project
  20 import DefineException
  21
  22 def isBertosDir(directory):
  23    return os.path.exists(directory + "/VERSION")
  24
  25 def bertosVersion(directory):
  26    return open(directory + "/VERSION").readline().strip()
  27
  28 def createBertosProject(projectInfo):
  29     directory = projectInfo.info("PROJECT_PATH")
  30     sourcesDir = projectInfo.info("SOURCES_PATH")
  31     if not os.path.isdir(directory):
  32         os.mkdir(directory)
  33     f = open(directory + "/project.bertos", "w")
  34     f.write(repr(projectInfo))
  35     f.close()
  36     ## Destination source dir
  37     srcdir = directory + "/bertos"
  38     shutil.rmtree(srcdir, True)
  39     shutil.copytree(sourcesDir + "/bertos", srcdir)
  40     ## Destination makefile
  41     makefile = directory + "/Makefile"
  42     if os.path.exists(makefile):
  43         os.remove(makefile)
  44     makefile = open("mktemplates/Makefile").read()
  45     makefile = makefileGenerator(projectInfo, makefile)
  46     open(directory + "/Makefile", "w").write(makefile)
  47     ## Destination project dir
  48     prjdir = directory + "/" + os.path.basename(directory)
  49     shutil.rmtree(prjdir, True)
  50     os.mkdir(prjdir)
  51     ## Destination configurations files
  52     cfgdir = prjdir + "/cfg"
  53     shutil.rmtree(cfgdir, True)
  54     os.mkdir(cfgdir)
  55     for key, value in projectInfo.info("CONFIGURATIONS").items():
  56         string = open(sourcesDir + "/" + key, "r").read()
  57         for parameter, infos in value.items():
  58             value = infos["value"]
  59             if "unsigned" in infos["informations"].keys() and infos["informations"]["unsigned"]:
  60                 value += "U"
  61             if "long" in infos["informations"].keys() and infos["informations"]["long"]:
  62                 value += "L"
  63             string = sub(string, parameter, value)
  64         f = open(cfgdir + "/" + os.path.basename(key), "w")
  65         f.write(string)
  66         f.close()
  67     ## Destinatio mk file
  68     makefile = open("mktemplates/template.mk", "r").read()
  69     makefile = mkGenerator(projectInfo, makefile)
  70     open(prjdir + "/" + os.path.basename(prjdir) + ".mk", "w").write(makefile)
  71     ## Destination main.c file
  72     main = open("srctemplates/main.c", "r").read()
  73     open(prjdir + "/main.c", "w").write(main)
  74     if "codelite" in projectInfo.info("OUTPUT"):
  75         workspace = codeliteWorkspaceGenerator(projectInfo)
  76         open(directory + "/" + os.path.basename(prjdir) + ".workspace", "w").write(workspace)
  77         project = codeliteProjectGenerator(projectInfo)
  78         open(directory + "/" + os.path.basename(prjdir) + ".project", "w").write(project)
  79
  80 def mkGenerator(projectInfo, makefile):
  81     """
  82     Generates the mk file for the current project.
  83     """
  84     mkData = {}
  85     mkData["$pname"] = os.path.basename(projectInfo.info("PROJECT_PATH"))
  86     mkData["$cpuname"] = projectInfo.info("CPU_INFOS")["CORE_CPU"]
  87     mkData["$cflags"] = " ".join(projectInfo.info("CPU_INFOS")["C_FLAGS"])
  88     mkData["$ldflags"] = " ".join(projectInfo.info("CPU_INFOS")["LD_FLAGS"])
  89     mkData["$csrc"], mkData["$pcsrc"], mkData["$constants"] = csrcGenerator(projectInfo)
  90     mkData["$prefix"] = projectInfo.info("TOOLCHAIN")["path"].split("gcc")[0]
  91     mkData["$suffix"] = projectInfo.info("TOOLCHAIN")["path"].split("gcc")[1]
  92     mkData["$cross"] = projectInfo.info("TOOLCHAIN")["path"].split("gcc")[0]
  93     mkData["$main"] = projectInfo.info("PROJECT_PATH") + "/" + os.path.basename(projectInfo.info("PROJECT_PATH")) + "/main.c"
  94     for key in mkData:
  95         while makefile.find(key) != -1:
  96             makefile = makefile.replace(key, mkData[key])
  97     return makefile
  98
  99 def makefileGenerator(projectInfo, makefile):
 100     """
 101     Generate the Makefile for the current project.
 102     """
 103     # TODO: write a general function that works for both the mk file and the Makefile
 104     while makefile.find("project_name") != -1:
 105         makefile = makefile.replace("project_name", os.path.basename(projectInfo.info("PROJECT_PATH")))
 106     return makefile
 107
 108 def csrcGenerator(projectInfo):
 109     modules = projectInfo.info("MODULES")
 110     if "harvard" in projectInfo.info("CPU_INFOS")["CPU_TAGS"]:
 111         pcsrc_need = projectInfo.info("CPU_INFOS")["PC_SRC"]
 112     else:
 113         pcsrc_need = []
 114     csrc = []
 115     pcsrc = []
 116     constants = {}
 117     for module, information in modules.items():
 118         if information["enabled"]:
 119             if "constants" in information:
 120                 constants.update(information["constants"])
 121             for filename, path in findDefinitions(module + ".c", projectInfo):
 122                 path = path.replace(projectInfo.info("SOURCES_PATH"), projectInfo.info("PROJECT_PATH"))
 123                 csrc.append(path + "/" + filename)
 124                 if module in pcsrc_need:
 125                     pcsrc.append(path + "/" + filename)
 126             for filename, path in findDefinitions(module + "_" + projectInfo.info("CPU_INFOS")["TOOLCHAIN"] + ".c", projectInfo):
 127                 path = path.replace(projectInfo.info("SOURCES_PATH"), projectInfo.info("PROJECT_PATH"))
 128                 csrc.append(path + "/" + filename)
 129                 if module in pcsrc_need:
 130                     pcsrc.append(path + "/" + filename)
 131             for tag in projectInfo.info("CPU_INFOS")["CPU_TAGS"]:
 132                 for filename, path in findDefinitions(module + "_" + tag + ".c", projectInfo):
 133                     path = path.replace(projectInfo.info("SOURCES_PATH"), projectInfo.info("PROJECT_PATH"))
 134                     csrc.append(path + "/" + filename)
 135                     if module in pcsrc_need:
 136                         pcsrc.append(path + "/" + filename)
 137     csrc = " \\\n\t".join(csrc) + " \\"
 138     pcsrc = " \\\n\t".join(pcsrc) + " \\"
 139     constants = "\n".join([os.path.basename(projectInfo.info("PROJECT_PATH")) + "_" + key + " = " + str(value) for key, value in constants.items()])
 140     return csrc, pcsrc, constants
 141
 142 def codeliteProjectGenerator(projectInfo):
 143     template = open("cltemplates/bertos.project").read()
 144     filelist = "\n".join(codelite_project.clFiles(codelite_project.findSources(projectInfo.info("PROJECT_PATH")), projectInfo.info("PROJECT_PATH")))
 145     while template.find("$filelist") != -1:
 146         template = template.replace("$filelist", filelist)
 147     projectName = os.path.basename(projectInfo.info("PROJECT_PATH"))
 148     while template.find("$project") != -1:
 149         template = template.replace("$project", projectName)
 150     return template
 151
 152 def codeliteWorkspaceGenerator(projectInfo):
 153     template = open("cltemplates/bertos.workspace").read()
 154     projectName = os.path.basename(projectInfo.info("PROJECT_PATH"))
 155     while template.find("$project") != -1:
 156         template = template.replace("$project", projectName)
 157     return template
 158
 159 def getSystemPath():
 160     path = os.environ["PATH"]
 161     if os.name == "nt":
 162         path = path.split(";")
 163     else:
 164         path = path.split(":")
 165     return path
 166
 167 def findToolchains(pathList):
 168     toolchains = []
 169     for element in pathList:
 170         for toolchain in glob.glob(element+ "/" + const.GCC_NAME):
 171             toolchains.append(toolchain)
 172     return list(set(toolchains))
 173
 174 def getToolchainInfo(output):
 175     info = {}
 176     expr = re.compile("Target: .*")
 177     target = expr.findall(output)
 178     if len(target) == 1:
 179         info["target"] = target[0].split("Target: ")[1]
 180     expr = re.compile("gcc version [0-9,.]*")
 181     version = expr.findall(output)
 182     if len(version) == 1:
 183         info["version"] = version[0].split("gcc version ")[1]
 184     expr = re.compile("gcc version [0-9,.]* \(.*\)")
 185     build = expr.findall(output)
 186     if len(build) == 1:
 187         build = build[0].split("gcc version ")[1]
 188         build = build[build.find("(") + 1 : build.find(")")]
 189         info["build"] = build
 190     expr = re.compile("Configured with: .*")
 191     configured = expr.findall(output)
 192     if len(configured) == 1:
 193         info["configured"] = configured[0].split("Configured with: ")[1]
 194     expr = re.compile("Thread model: .*")
 195     thread = expr.findall(output)
 196     if len(thread) == 1:
 197         info["thread"] = thread[0].split("Thread model: ")[1]
 198     return info
 199
 200 def loadSourceTree(project):
 201     fileList = [f for f in os.walk(project.info("SOURCES_PATH"))]
 202     project.setInfo("FILE_LIST", fileList)
 203
 204 def findDefinitions(ftype, project):
 205     L = project.info("FILE_LIST")
 206     definitions = []
 207     for element in L:
 208         for filename in element[2]:
 209             if fnmatch.fnmatch(filename, ftype):
 210                 definitions.append((filename, element[0]))
 211     return definitions
 212
 213 def loadCpuInfos(project):
 214     cpuInfos = []
 215     for definition in findDefinitions(const.CPU_DEFINITION, project):
 216         cpuInfos.append(getInfos(definition))
 217     return cpuInfos
 218
 219 def getInfos(definition):
 220     D = {}
 221     D.update(const.CPU_DEF)
 222     def include(filename, dict = D, directory=definition[1]):
 223         execfile(directory + "/" + filename, {}, D)
 224     D["include"] = include
 225     include(definition[0], D)
 226     D["CPU_NAME"] = definition[0].split(".")[0]
 227     D["DEFINITION_PATH"] = definition[1] + "/" + definition[0]
 228     del D["include"]
 229     return D
 230
 231 def getCommentList(string):
 232     commentList = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/", string)
 233     commentList = [re.findall(r"^\s*\* *(.*?)$", comment, re.MULTILINE) for comment in commentList]
 234     return commentList
 235
 236 def loadModuleDefinition(first_comment):
 237     toBeParsed = False
 238     moduleDefinition = {}
 239     for num, line in enumerate(first_comment):
 240         index = line.find("$WIZ$")
 241         if index != -1:
 242             toBeParsed = True
 243             try:
 244                 exec line[index + len("$WIZ$ "):] in {}, moduleDefinition
 245             except:
 246                 raise ParseError(num, line[index:])
 247         elif line.find("\\brief") != -1:
 248             moduleDefinition["module_description"] = line[line.find("\\brief") + len("\\brief "):]
 249     moduleDict = {}
 250     if "module_name" in moduleDefinition.keys():
 251         moduleName = moduleDefinition[const.MODULE_DEFINITION["module_name"]]
 252         del moduleDefinition[const.MODULE_DEFINITION["module_name"]]
 253         moduleDict[moduleName] = {}
 254         if const.MODULE_DEFINITION["module_depends"] in moduleDefinition.keys():
 255             if type(moduleDefinition[const.MODULE_DEFINITION["module_depends"]]) == str:
 256                 moduleDefinition[const.MODULE_DEFINITION["module_depends"]] = (moduleDefinition[const.MODULE_DEFINITION["module_depends"]],)
 257             moduleDict[moduleName]["depends"] = moduleDefinition[const.MODULE_DEFINITION["module_depends"]]
 258             del moduleDefinition[const.MODULE_DEFINITION["module_depends"]]
 259         else:
 260             moduleDict[moduleName]["depends"] = ()
 261         if const.MODULE_DEFINITION["module_configuration"] in moduleDefinition.keys():
 262             moduleDict[moduleName]["configuration"] = moduleDefinition[const.MODULE_DEFINITION["module_configuration"]]
 263             del moduleDefinition[const.MODULE_DEFINITION["module_configuration"]]
 264         else:
 265             moduleDict[moduleName]["configuration"] = ""
 266         if "module_description" in moduleDefinition.keys():
 267             moduleDict[moduleName]["description"] = moduleDefinition["module_description"]
 268             del moduleDefinition["module_description"]
 269         moduleDict[moduleName]["constants"] = moduleDefinition
 270         moduleDict[moduleName]["enabled"] = False
 271     return toBeParsed, moduleDict
 272
 273 def loadDefineLists(commentList):
 274     defineList = {}
 275     for comment in commentList:
 276         for num, line in enumerate(comment):
 277             index = line.find("$WIZ$")
 278             if index != -1:
 279                 try:
 280                     exec line[index + len("$WIZ$ "):] in {}, defineList
 281                 except:
 282                     raise ParseError(num, line[index:])
 283     for key, value in defineList.items():
 284         if type(value) == str:
 285             defineList[key] = (value,)
 286     return defineList
 287
 288 def getDescriptionInformations(comment):
 289     """
 290     Take the doxygen comment and strip the wizard informations, returning the tuple
 291     (comment, wizard_information)
 292     """
 293     brief = ""
 294     description = ""
 295     information = {}
 296     for num, line in enumerate(comment):
 297         index = line.find("$WIZ$")
 298         if index != -1:
 299             if len(brief) == 0:
 300                 brief += line[:index].strip()
 301             else:
 302                 description += " " + line[:index]
 303             try:
 304                 exec line[index + len("$WIZ$ "):] in {}, information
 305             except:
 306                 raise ParseError(num, line[index:])
 307         else:
 308             if len(brief) == 0:
 309                 brief += line.strip()
 310             else:
 311                 description += " " + line
 312                 description = description.strip()
 313     return brief.strip(), description.strip(), information
 314
 315 def getDefinitionBlocks(text):
 316     """
 317     Take a text and return a list of tuple (description, name-value).
 318     """
 319     block = []
 320     block_tmp = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
 321     for comment, define in block_tmp:
 322         # Only the first element is needed
 323         block.append(([re.findall(r"^\s*\* *(.*?)$", line, re.MULTILINE)[0] for line in comment.splitlines()], define))
 324     for comment, define in re.findall(r"/{3}\s*([^<].*?)\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
 325         block.append(([comment], define))
 326     for define, comment in re.findall(r"#define\s*(.*?)\s*/{3}<\s*(.+?)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
 327         block.append(([comment], define))
 328     return block
 329
 330 def loadModuleData(project):
 331     moduleInfoDict = {}
 332     listInfoDict = {}
 333     configurationInfoDict = {}
 334     for filename, path in findDefinitions("*.h", project):
 335         commentList = getCommentList(open(path + "/" + filename, "r").read())
 336         if len(commentList) > 0:
 337             moduleInfo = {}
 338             configurationInfo = {}
 339             try:
 340                 toBeParsed, moduleDict = loadModuleDefinition(commentList[0])
 341             except ParseError, err:
 342                 raise DefineException.ModuleDefineException(path, err.line_number, err.line)
 343             for module, information in moduleDict.items():
 344                 information["category"] = os.path.basename(path)
 345                 if "configuration" in information.keys() and len(information["configuration"]):
 346                     configuration = moduleDict[module]["configuration"]
 347                     try:
 348                         configurationInfo[configuration] = loadConfigurationInfos(project.info("SOURCES_PATH") + "/" + configuration)
 349                     except ParseError, err:
 350                         raise DefineException.ConfigurationDefineException(project.info("SOURCES_PATH") + "/" + configuration, err.line_number, err.line)
 351             moduleInfoDict.update(moduleDict)
 352             configurationInfoDict.update(configurationInfo)
 353             if toBeParsed:
 354                 try:
 355                     listDict = loadDefineLists(commentList[1:])
 356                     listInfoDict.update(listDict)
 357                 except ParseError, err:
 358                     raise DefineException.EnumDefineException(path, err.line_number, err.line)
 359     for filename, path in findDefinitions("*_" + project.info("CPU_INFOS")["TOOLCHAIN"] + ".h", project):
 360         commentList = getCommentList(open(path + "/" + filename, "r").read())
 361         listInfoDict.update(loadDefineLists(commentList))
 362     for tag in project.info("CPU_INFOS")["CPU_TAGS"]:
 363         for filename, path in findDefinitions("*_" + tag + ".h", project):
 364             commentList = getCommentList(open(path + "/" + filename, "r").read())
 365             listInfoDict.update(loadDefineLists(commentList))
 366     project.setInfo("MODULES", moduleInfoDict)
 367     project.setInfo("LISTS", listInfoDict)
 368     project.setInfo("CONFIGURATIONS", configurationInfoDict)
 369
 370 def formatParamNameValue(text):
 371     """
 372     Take the given string and return a tuple with the name of the parameter in the first position
 373     and the value in the second.
 374     """
 375     block = re.findall("\s*([^\s]+)\s*(.+?)\s*$", text, re.MULTILINE)
 376     return block[0]
 377
 378 def loadConfigurationInfos(path):
 379     """
 380     Return the module configurations found in the given file as a dict with the
 381     parameter name as key and a dict containig the fields above as value:
 382         "value": the value of the parameter
 383         "description": the description of the parameter
 384         "informations": a dict containig optional informations:
 385             "type": "int" | "boolean" | "enum"
 386             "min": the minimum value for integer parameters
 387             "max": the maximum value for integer parameters
 388             "long": boolean indicating if the num is a long
 389             "value_list": the name of the enum for enum parameters
 390     """
 391     configurationInfos = {}
 392     for comment, define in getDefinitionBlocks(open(path, "r").read()):
 393         name, value = formatParamNameValue(define)
 394         brief, description, informations = getDescriptionInformations(comment)
 395         configurationInfos[name] = {}
 396         configurationInfos[name]["value"] = value
 397         configurationInfos[name]["informations"] = informations
 398         if ("type" in configurationInfos[name]["informations"].keys() and
 399                 configurationInfos[name]["informations"]["type"] == "int" and
 400                 configurationInfos[name]["value"].find("L") != -1):
 401             configurationInfos[name]["informations"]["long"] = True
 402             configurationInfos[name]["value"] = configurationInfos[name]["value"].replace("L", "")
 403         if ("type" in configurationInfos[name]["informations"].keys() and
 404                 configurationInfos[name]["informations"]["type"] == "int" and
 405                 configurationInfos[name]["value"].find("U") != -1):
 406             configurationInfos[name]["informations"]["unsigned"] = True
 407             configurationInfos[name]["value"] = configurationInfos[name]["value"].replace("U", "")
 408         configurationInfos[name]["description"] = description
 409         configurationInfos[name]["brief"] = brief
 410     return configurationInfos
 411
 412 def sub(string, parameter, value):
 413     """
 414     Substitute the given value at the given parameter define in the given string
 415     """
 416     return re.sub(r"(?P<define>#define\s+" + parameter + r"\s+)([^\s]+)", r"\g<define>" + value, string)
 417
 418 def isInt(informations):
 419     """
 420     Return True if the value is a simple int.
 421     """
 422     if ("long" not in informatios.keys() or not informations["long"]) and ("unsigned" not in informations.keys() or informations["unsigned"]):
 423         return True
 424     else:
 425         return False
 426
 427 def isLong(informations):
 428     """
 429     Return True if the value is a long.
 430     """
 431     if "long" in informations.keys() and informations["long"] and "unsigned" not in informations.keys():
 432         return True
 433     else:
 434         return False
 435
 436 def isUnsigned(informations):
 437     """
 438     Return True if the value is an unsigned.
 439     """
 440     if "unsigned" in informations.keys() and informations["unsigned"] and "long" not in informations.keys():
 441         return True
 442     else:
 443         return False
 444
 445 def isUnsignedLong(informations):
 446     """
 447     Return True if the value is an unsigned long.
 448     """
 449     if "unsigned" in informations.keys() and "long" in informations.keys() and informations["unsigned"] and informations["long"]:
 450         return True
 451     else:
 452         return False
 453
 454 class ParseError(Exception):
 455     def __init__(self, line_number, line):
 456         Exception.__init__(self)
 457         self.line_number = line_number
 458         self.line = line