4 # Copyright 2008 Develer S.r.l. (http://www.develer.com/)
9 # Author: Lorenzo Berni <duplo@develer.com>
20 from plugins import codelite_project
21 import DefineException
23 def isBertosDir(directory):
24 return os.path.exists(directory + "/VERSION")
26 def bertosVersion(directory):
27 return open(directory + "/VERSION").readline().strip()
29 def createBertosProject(project_info):
30 directory = project_info.info("PROJECT_PATH")
31 sources_dir = project_info.info("SOURCES_PATH")
32 if not os.path.isdir(directory):
34 f = open(directory + "/project.bertos", "w")
35 f.write(pickle.dumps(project_info))
37 # Destination source dir
38 srcdir = directory + "/bertos"
39 shutil.rmtree(srcdir, True)
40 shutil.copytree(sources_dir + "/bertos", srcdir)
41 # Destination makefile
42 makefile = directory + "/Makefile"
43 if os.path.exists(makefile):
45 makefile = open("mktemplates/Makefile").read()
46 makefile = makefileGenerator(project_info, makefile)
47 open(directory + "/Makefile", "w").write(makefile)
48 # Destination project dir
49 prjdir = directory + "/" + os.path.basename(directory)
50 shutil.rmtree(prjdir, True)
52 # Destination configurations files
53 cfgdir = prjdir + "/cfg"
54 shutil.rmtree(cfgdir, True)
56 for configuration, information in project_info.info("CONFIGURATIONS").items():
57 string = open(sources_dir + "/" + configuration, "r").read()
58 for start, parameter in information["paramlist"]:
59 infos = information[parameter]
60 value = infos["value"]
61 if "type" in infos["informations"] and infos["informations"]["type"] == "autoenabled":
63 if "unsigned" in infos["informations"].keys() and infos["informations"]["unsigned"]:
65 if "long" in infos["informations"].keys() and infos["informations"]["long"]:
67 string = sub(string, parameter, value)
68 f = open(cfgdir + "/" + os.path.basename(configuration), "w")
72 makefile = open("mktemplates/template.mk", "r").read()
73 makefile = mkGenerator(project_info, makefile)
74 open(prjdir + "/" + os.path.basename(prjdir) + ".mk", "w").write(makefile)
75 # Destination main.c file
76 main = open("srctemplates/main.c", "r").read()
77 open(prjdir + "/main.c", "w").write(main)
78 # Codelite project files
79 if "codelite" in project_info.info("OUTPUT"):
80 codelite_project.createProject(project_info)
82 def mkGenerator(project_info, makefile):
84 Generates the mk file for the current project.
87 mk_data["$pname"] = os.path.basename(project_info.info("PROJECT_PATH"))
88 mk_data["$cpuname"] = project_info.info("CPU_INFOS")["CORE_CPU"]
89 mk_data["$cflags"] = " ".join(project_info.info("CPU_INFOS")["C_FLAGS"])
90 mk_data["$ldflags"] = " ".join(project_info.info("CPU_INFOS")["LD_FLAGS"])
91 mk_data["$csrc"], mk_data["$pcsrc"], mk_data["$asrc"], mk_data["$constants"] = csrcGenerator(project_info)
92 mk_data["$prefix"] = project_info.info("TOOLCHAIN")["path"].split("gcc")[0]
93 mk_data["$suffix"] = project_info.info("TOOLCHAIN")["path"].split("gcc")[1]
94 mk_data["$cross"] = project_info.info("TOOLCHAIN")["path"].split("gcc")[0]
95 mk_data["$main"] = os.path.basename(project_info.info("PROJECT_PATH")) + "/main.c"
97 while makefile.find(key) != -1:
98 makefile = makefile.replace(key, mk_data[key])
101 def makefileGenerator(project_info, makefile):
103 Generate the Makefile for the current project.
105 # TODO write a general function that works for both the mk file and the Makefile
106 while makefile.find("project_name") != -1:
107 makefile = makefile.replace("project_name", os.path.basename(project_info.info("PROJECT_PATH")))
110 def csrcGenerator(project_info):
111 modules = project_info.info("MODULES")
112 files = project_info.info("FILES")
113 if "harvard" in project_info.info("CPU_INFOS")["CPU_TAGS"]:
117 # file to be included in CSRC variable
119 # file to be included in PCSRC variable
121 # files to be included in CPPASRC variable
123 # constants to be included at the beginning of the makefile
125 for module, information in modules.items():
126 module_files = set([])
127 dependency_files = set([])
130 if information["enabled"]:
131 if "constants" in information:
132 constants.update(information["constants"])
133 cfiles, sfiles = findModuleFiles(module, project_info)
134 module_files |= set(cfiles)
135 asm_files |= set(sfiles)
136 for file_dependency in information["depends"]:
137 if file_dependency in files:
138 dependencyCFiles, dependencySFiles = findModuleFiles(file_dependency, project_info)
139 dependency_files |= set(dependencyCFiles)
140 asm_files |= set(dependencySFiles)
141 for file in module_files:
142 if not harvard or "harvard" not in information or information["harvard"] == "both":
144 if harvard and "harvard" in information:
146 for file in dependency_files:
148 for file in asm_files:
150 csrc = " \\\n\t".join(csrc) + " \\"
151 pcsrc = " \\\n\t".join(pcsrc) + " \\"
152 asrc = " \\\n\t".join(asrc) + " \\"
153 constants = "\n".join([os.path.basename(project_info.info("PROJECT_PATH")) + "_" + key + " = " + str(value) for key, value in constants.items()])
154 return csrc, pcsrc, asrc, constants
156 def findModuleFiles(module, project_info):
157 # Find the files related to the selected module
160 # .c files related to the module and the cpu architecture
161 for filename, path in findDefinitions(module + ".c", project_info) + \
162 findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".c", project_info):
163 path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
165 path = replaceSeparators(path)
166 cfiles.append(path + "/" + filename)
167 # .s files related to the module and the cpu architecture
168 for filename, path in findDefinitions(module + ".s", project_info) + \
169 findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".s", project_info) + \
170 findDefinitions(module + ".S", project_info) + \
171 findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".S", project_info):
172 path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
174 path = replaceSeparators(path)
175 sfiles.append(path + "/" + filename)
176 # .c and .s files related to the module and the cpu tags
177 for tag in project_info.info("CPU_INFOS")["CPU_TAGS"]:
178 for filename, path in findDefinitions(module + "_" + tag + ".c", project_info):
179 path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
181 path = replaceSeparators(path)
182 cfiles.append(path + "/" + filename)
183 for filename, path in findDefinitions(module + "_" + tag + ".s", project_info) + \
184 findDefinitions(module + "_" + tag + ".S", project_info):
185 path = path.replace(project_info.info("SOURCES_PATH") + os.sep, "")
187 path = replaceSeparators(path)
188 sfiles.append(path + "/" + filename)
189 return cfiles, sfiles
191 def replaceSeparators(path):
193 Replace the separators in the given path with unix standard separator.
195 while path.find(os.sep) != -1:
196 path = path.replace(os.sep, "/")
200 path = os.environ["PATH"]
202 path = path.split(";")
204 path = path.split(":")
207 def findToolchains(path_list):
209 for element in path_list:
210 for toolchain in glob.glob(element+ "/" + const.GCC_NAME):
211 toolchains.append(toolchain)
212 return list(set(toolchains))
214 def getToolchainInfo(output):
216 expr = re.compile("Target: .*")
217 target = expr.findall(output)
219 info["target"] = target[0].split("Target: ")[1]
220 expr = re.compile("gcc version [0-9,.]*")
221 version = expr.findall(output)
222 if len(version) == 1:
223 info["version"] = version[0].split("gcc version ")[1]
224 expr = re.compile("gcc version [0-9,.]* \(.*\)")
225 build = expr.findall(output)
227 build = build[0].split("gcc version ")[1]
228 build = build[build.find("(") + 1 : build.find(")")]
229 info["build"] = build
230 expr = re.compile("Configured with: .*")
231 configured = expr.findall(output)
232 if len(configured) == 1:
233 info["configured"] = configured[0].split("Configured with: ")[1]
234 expr = re.compile("Thread model: .*")
235 thread = expr.findall(output)
237 info["thread"] = thread[0].split("Thread model: ")[1]
240 def loadSourceTree(project):
241 fileList = [f for f in os.walk(project.info("SOURCES_PATH"))]
242 project.setInfo("FILE_LIST", fileList)
244 def findDefinitions(ftype, project):
245 L = project.info("FILE_LIST")
248 for filename in element[2]:
249 if fnmatch.fnmatch(filename, ftype):
250 definitions.append((filename, element[0]))
253 def loadCpuInfos(project):
255 for definition in findDefinitions(const.CPU_DEFINITION, project):
256 cpuInfos.append(getInfos(definition))
259 def getInfos(definition):
261 D.update(const.CPU_DEF)
262 def include(filename, dict = D, directory=definition[1]):
263 execfile(directory + "/" + filename, {}, D)
264 D["include"] = include
265 include(definition[0], D)
266 D["CPU_NAME"] = definition[0].split(".")[0]
267 D["DEFINITION_PATH"] = definition[1] + "/" + definition[0]
271 def getCommentList(string):
272 comment_list = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/", string)
273 comment_list = [re.findall(r"^\s*\* *(.*?)$", comment, re.MULTILINE) for comment in comment_list]
276 def loadModuleDefinition(first_comment):
278 module_definition = {}
279 for num, line in enumerate(first_comment):
280 index = line.find("$WIZ$")
284 exec line[index + len("$WIZ$ "):] in {}, module_definition
286 raise ParseError(num, line[index:])
287 elif line.find("\\brief") != -1:
288 module_definition["module_description"] = line[line.find("\\brief") + len("\\brief "):]
290 if "module_name" in module_definition.keys():
291 module_name = module_definition[const.MODULE_DEFINITION["module_name"]]
292 del module_definition[const.MODULE_DEFINITION["module_name"]]
293 module_dict[module_name] = {}
294 if const.MODULE_DEFINITION["module_depends"] in module_definition.keys():
295 if type(module_definition[const.MODULE_DEFINITION["module_depends"]]) == str:
296 module_definition[const.MODULE_DEFINITION["module_depends"]] = (module_definition[const.MODULE_DEFINITION["module_depends"]],)
297 module_dict[module_name]["depends"] = module_definition[const.MODULE_DEFINITION["module_depends"]]
298 del module_definition[const.MODULE_DEFINITION["module_depends"]]
300 module_dict[module_name]["depends"] = ()
301 if const.MODULE_DEFINITION["module_configuration"] in module_definition.keys():
302 module_dict[module_name]["configuration"] = module_definition[const.MODULE_DEFINITION["module_configuration"]]
303 del module_definition[const.MODULE_DEFINITION["module_configuration"]]
305 module_dict[module_name]["configuration"] = ""
306 if "module_description" in module_definition.keys():
307 module_dict[module_name]["description"] = module_definition["module_description"]
308 del module_definition["module_description"]
309 if const.MODULE_DEFINITION["module_harvard"] in module_definition.keys():
310 harvard = module_definition[const.MODULE_DEFINITION["module_harvard"]]
311 if harvard == "both" or harvard == "pgm_memory":
312 module_dict[module_name]["harvard"] = harvard
313 del module_definition[const.MODULE_DEFINITION["module_harvard"]]
314 module_dict[module_name]["constants"] = module_definition
315 module_dict[module_name]["enabled"] = False
316 return to_be_parsed, module_dict
318 def loadDefineLists(comment_list):
320 for comment in comment_list:
321 for num, line in enumerate(comment):
322 index = line.find("$WIZ$")
325 exec line[index + len("$WIZ$ "):] in {}, define_list
327 raise ParseError(num, line[index:])
328 for key, value in define_list.items():
329 if type(value) == str:
330 define_list[key] = (value,)
333 def getDescriptionInformations(comment):
335 Take the doxygen comment and strip the wizard informations, returning the tuple
336 (comment, wizard_information)
341 for num, line in enumerate(comment):
342 index = line.find("$WIZ$")
345 brief += line[:index].strip()
347 description += " " + line[:index]
349 exec line[index + len("$WIZ$ "):] in {}, information
351 raise ParseError(num, line[index:])
354 brief += line.strip()
356 description += " " + line
357 description = description.strip()
358 return brief.strip(), description.strip(), information
360 def getDefinitionBlocks(text):
362 Take a text and return a list of tuple (description, name-value).
365 block_tmp = re.finditer(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
366 for match in block_tmp:
367 # Only the first element is needed
368 comment = match.group(1)
369 define = match.group(2)
370 start = match.start()
371 block.append(([re.findall(r"^\s*\* *(.*?)$", line, re.MULTILINE)[0] for line in comment.splitlines()], define, start))
372 for match in re.finditer(r"/{3}\s*([^<].*?)\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
373 comment = match.group(1)
374 define = match.group(2)
375 start = match.start()
376 block.append(([comment], define, start))
377 for match in re.finditer(r"#define\s*(.*?)\s*/{3}<\s*(.+?)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
378 comment = match.group(2)
379 define = match.group(1)
380 start = match.start()
381 block.append(([comment], define, start))
384 def loadModuleData(project):
385 module_info_dict = {}
387 configuration_info_dict = {}
389 for filename, path in findDefinitions("*.h", project) + findDefinitions("*.c", project) + findDefinitions("*.s", project) + findDefinitions("*.S", project):
390 comment_list = getCommentList(open(path + "/" + filename, "r").read())
391 if len(comment_list) > 0:
393 configuration_info = {}
395 to_be_parsed, module_dict = loadModuleDefinition(comment_list[0])
396 except ParseError, err:
397 raise DefineException.ModuleDefineException(path, err.line_number, err.line)
398 for module, information in module_dict.items():
399 if "depends" not in information:
400 information["depends"] = ()
401 information["depends"] += (filename.split(".")[0],)
402 information["category"] = os.path.basename(path)
403 if "configuration" in information.keys() and len(information["configuration"]):
404 configuration = module_dict[module]["configuration"]
406 configuration_info[configuration] = loadConfigurationInfos(project.info("SOURCES_PATH") + "/" + configuration)
407 except ParseError, err:
408 raise DefineException.ConfigurationDefineException(project.info("SOURCES_PATH") + "/" + configuration, err.line_number, err.line)
409 module_info_dict.update(module_dict)
410 configuration_info_dict.update(configuration_info)
413 list_dict = loadDefineLists(comment_list[1:])
414 list_info_dict.update(list_dict)
415 except ParseError, err:
416 raise DefineException.EnumDefineException(path, err.line_number, err.line)
417 for filename, path in findDefinitions("*_" + project.info("CPU_INFOS")["TOOLCHAIN"] + ".h", project):
418 comment_list = getCommentList(open(path + "/" + filename, "r").read())
419 list_info_dict.update(loadDefineLists(comment_list))
420 for tag in project.info("CPU_INFOS")["CPU_TAGS"]:
421 for filename, path in findDefinitions("*_" + tag + ".h", project):
422 comment_list = getCommentList(open(path + "/" + filename, "r").read())
423 list_info_dict.update(loadDefineLists(comment_list))
424 project.setInfo("MODULES", module_info_dict)
425 project.setInfo("LISTS", list_info_dict)
426 project.setInfo("CONFIGURATIONS", configuration_info_dict)
427 project.setInfo("FILES", file_dict)
429 def formatParamNameValue(text):
431 Take the given string and return a tuple with the name of the parameter in the first position
432 and the value in the second.
434 block = re.findall("\s*([^\s]+)\s*(.+?)\s*$", text, re.MULTILINE)
437 def loadConfigurationInfos(path):
439 Return the module configurations found in the given file as a dict with the
440 parameter name as key and a dict containig the fields above as value:
441 "value": the value of the parameter
442 "description": the description of the parameter
443 "informations": a dict containig optional informations:
444 "type": "int" | "boolean" | "enum"
445 "min": the minimum value for integer parameters
446 "max": the maximum value for integer parameters
447 "long": boolean indicating if the num is a long
448 "unsigned": boolean indicating if the num is an unsigned
449 "value_list": the name of the enum for enum parameters
451 configuration_infos = {}
452 configuration_infos["paramlist"] = []
453 for comment, define, start in getDefinitionBlocks(open(path, "r").read()):
454 name, value = formatParamNameValue(define)
455 brief, description, informations = getDescriptionInformations(comment)
456 configuration_infos["paramlist"].append((start, name))
457 configuration_infos[name] = {}
458 configuration_infos[name]["value"] = value
459 configuration_infos[name]["informations"] = informations
460 if not "type" in configuration_infos[name]["informations"]:
461 configuration_infos[name]["informations"]["type"] = findParameterType(configuration_infos[name])
462 if ("type" in configuration_infos[name]["informations"].keys() and
463 configuration_infos[name]["informations"]["type"] == "int" and
464 configuration_infos[name]["value"].find("L") != -1):
465 configuration_infos[name]["informations"]["long"] = True
466 configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("L", "")
467 if ("type" in configuration_infos[name]["informations"].keys() and
468 configuration_infos[name]["informations"]["type"] == "int" and
469 configuration_infos[name]["value"].find("U") != -1):
470 configuration_infos[name]["informations"]["unsigned"] = True
471 configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("U", "")
472 configuration_infos[name]["description"] = description
473 configuration_infos[name]["brief"] = brief
474 return configuration_infos
476 def findParameterType(parameter):
477 if "value_list" in parameter["informations"]:
479 if "min" in parameter["informations"] or "max" in parameter["informations"] or re.match(r"^\d+U?L?$", parameter["value"]) != None:
482 def sub(string, parameter, value):
484 Substitute the given value at the given parameter define in the given string
486 return re.sub(r"(?P<define>#define\s+" + parameter + r"\s+)([^\s]+)", r"\g<define>" + value, string)
488 def isInt(informations):
490 Return True if the value is a simple int.
492 if ("long" not in informatios.keys() or not informations["long"]) and ("unsigned" not in informations.keys() or informations["unsigned"]):
497 def isLong(informations):
499 Return True if the value is a long.
501 if "long" in informations.keys() and informations["long"] and "unsigned" not in informations.keys():
506 def isUnsigned(informations):
508 Return True if the value is an unsigned.
510 if "unsigned" in informations.keys() and informations["unsigned"] and "long" not in informations.keys():
515 def isUnsignedLong(informations):
517 Return True if the value is an unsigned long.
519 if "unsigned" in informations.keys() and "long" in informations.keys() and informations["unsigned"] and informations["long"]:
524 class ParseError(Exception):
525 def __init__(self, line_number, line):
526 Exception.__init__(self)
527 self.line_number = line_number