Use pickle module for store project settings
[bertos.git] / 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 import pickle
18
19 import const
20 import codelite_project
21 import DefineException
22
23 def isBertosDir(directory):
24    return os.path.exists(directory + "/VERSION")
25
26 def bertosVersion(directory):
27    return open(directory + "/VERSION").readline().strip()
28
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):
33         os.mkdir(directory)
34     f = open(directory + "/project.bertos", "w")
35     f.write(pickle.dumps(project_info))
36     f.close()
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):
44         os.remove(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)
51     os.mkdir(prjdir)
52     ## Destination configurations files
53     cfgdir = prjdir + "/cfg"
54     shutil.rmtree(cfgdir, True)
55     os.mkdir(cfgdir)
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":
62                 value = "1"
63             if "unsigned" in infos["informations"].keys() and infos["informations"]["unsigned"]:
64                 value += "U"
65             if "long" in infos["informations"].keys() and infos["informations"]["long"]:
66                 value += "L"
67             string = sub(string, parameter, value)
68         f = open(cfgdir + "/" + os.path.basename(configuration), "w")
69         f.write(string)
70         f.close()
71     ## Destinatio mk file
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         workspace = codeliteWorkspaceGenerator(project_info)
81         open(directory + "/" + os.path.basename(prjdir) + ".workspace", "w").write(workspace)
82         project = codeliteProjectGenerator(project_info)
83         open(directory + "/" + os.path.basename(prjdir) + ".project", "w").write(project)
84
85 def mkGenerator(project_info, makefile):
86     """
87     Generates the mk file for the current project.
88     """
89     mk_data = {}
90     mk_data["$pname"] = os.path.basename(project_info.info("PROJECT_PATH"))
91     mk_data["$cpuname"] = project_info.info("CPU_INFOS")["CORE_CPU"]
92     mk_data["$cflags"] = " ".join(project_info.info("CPU_INFOS")["C_FLAGS"])
93     mk_data["$ldflags"] = " ".join(project_info.info("CPU_INFOS")["LD_FLAGS"])
94     mk_data["$csrc"], mk_data["$pcsrc"], mk_data["$asrc"], mk_data["$constants"] = csrcGenerator(project_info)
95     mk_data["$prefix"] = project_info.info("TOOLCHAIN")["path"].split("gcc")[0]
96     mk_data["$suffix"] = project_info.info("TOOLCHAIN")["path"].split("gcc")[1]
97     mk_data["$cross"] = project_info.info("TOOLCHAIN")["path"].split("gcc")[0]
98     mk_data["$main"] = os.path.basename(project_info.info("PROJECT_PATH")) + "/main.c"
99     for key in mk_data:
100         while makefile.find(key) != -1:
101             makefile = makefile.replace(key, mk_data[key])
102     return makefile
103
104 def makefileGenerator(project_info, makefile):
105     """
106     Generate the Makefile for the current project.
107     """
108     # TODO: write a general function that works for both the mk file and the Makefile
109     while makefile.find("project_name") != -1:
110         makefile = makefile.replace("project_name", os.path.basename(project_info.info("PROJECT_PATH")))
111     return makefile
112
113 def csrcGenerator(project_info):
114     modules = project_info.info("MODULES")
115     files = project_info.info("FILES")
116     if "harvard" in project_info.info("CPU_INFOS")["CPU_TAGS"]:
117         harvard = True
118     else:
119         harvard = False
120     ## file to be included in CSRC variable
121     csrc = []
122     ## file to be included in PCSRC variable
123     pcsrc = []
124     ## files to be included in CPPASRC variable
125     asrc = []
126     ## constants to be included at the beginning of the makefile
127     constants = {}
128     for module, information in modules.items():
129         module_files = set([])
130         dependency_files = set([])
131         ## assembly sources
132         asm_files = set([])
133         if information["enabled"]:
134             if "constants" in information:
135                 constants.update(information["constants"])
136             cfiles, sfiles = findModuleFiles(module, project_info)
137             module_files |= set(cfiles)
138             asm_files |= set(sfiles)
139             for file_dependency in information["depends"]:
140                 if file_dependency in files:
141                     dependencyCFiles, dependencySFiles = findModuleFiles(file_dependency, project_info)
142                     dependency_files |= set(dependencyCFiles)
143                     asm_files |= set(dependencySFiles)
144             for file in module_files:
145                 if not harvard or "harvard" not in information or information["harvard"] == "both":
146                     csrc.append(os.path.normpath(file))
147                 if harvard and "harvard" in information:
148                     pcsrc.append(os.path.normpath(file))
149             for file in dependency_files:
150                 csrc.append(os.path.normpath(file))
151             for file in asm_files:
152                 asrc.append(os.path.normpath(file))
153     csrc = " \\\n\t".join(csrc) + " \\"
154     pcsrc = " \\\n\t".join(pcsrc) + " \\"
155     asrc = " \\\n\t".join(asrc) + " \\"
156     constants = "\n".join([os.path.basename(project_info.info("PROJECT_PATH")) + "_" + key + " = " + str(value) for key, value in constants.items()])
157     return csrc, pcsrc, asrc, constants
158     
159 def findModuleFiles(module, project_info):
160     ## Find the files related to the selected module
161     cfiles = []
162     sfiles = []
163     ## .c files related to the module and the cpu architecture
164     for filename, path in findDefinitions(module + ".c", project_info) + \
165             findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".c", project_info):
166         path = path.replace(project_info.info("SOURCES_PATH") + "/", "")
167         cfiles.append(path + "/" + filename)
168     ## .s files related to the module and the cpu architecture
169     for filename, path in findDefinitions(module + ".s", project_info) + \
170             findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".s", project_info) + \
171             findDefinitions(module + ".S", project_info) + \
172             findDefinitions(module + "_" + project_info.info("CPU_INFOS")["TOOLCHAIN"] + ".S", project_info):
173         path = path.replace(project_info.info("SOURCES_PATH") + "/", "")
174         sfiles.append(path + "/" + filename)
175     ## .c and .s files related to the module and the cpu tags
176     for tag in project_info.info("CPU_INFOS")["CPU_TAGS"]:
177         for filename, path in findDefinitions(module + "_" + tag + ".c", project_info):
178             path = path.replace(project_info.info("SOURCES_PATH") + "/", "")
179             cfiles.append(path + "/" + filename)
180         for filename, path in findDefinitions(module + "_" + tag + ".s", project_info) + \
181                 findDefinitions(module + "_" + tag + ".S", project_info):
182             path = path.replace(project_info.info("SOURCES_PATH") + "/", "")
183             sfiles.append(path + "/" + filename)
184     return cfiles, sfiles
185
186 def codeliteProjectGenerator(project_info):
187     template = open("cltemplates/bertos.project").read()
188     filelist = "\n".join(codelite_project.clFiles(codelite_project.findSources(project_info.info("PROJECT_PATH")), project_info.info("PROJECT_PATH")))
189     while template.find("$filelist") != -1:
190         template = template.replace("$filelist", filelist)
191     project_name = os.path.basename(project_info.info("PROJECT_PATH"))
192     while template.find("$project") != -1:
193         template = template.replace("$project", project_name)
194     return template
195
196 def codeliteWorkspaceGenerator(project_info):
197     template = open("cltemplates/bertos.workspace").read()
198     project_name = os.path.basename(project_info.info("PROJECT_PATH"))
199     while template.find("$project") != -1:
200         template = template.replace("$project", project_name)
201     return template
202     
203 def getSystemPath():
204     path = os.environ["PATH"]
205     if os.name == "nt":
206         path = path.split(";")
207     else:
208         path = path.split(":")
209     return path
210
211 def findToolchains(path_list):
212     toolchains = []
213     for element in path_list:
214         for toolchain in glob.glob(element+ "/" + const.GCC_NAME):
215             toolchains.append(toolchain)
216     return list(set(toolchains))
217
218 def getToolchainInfo(output):
219     info = {}
220     expr = re.compile("Target: .*")
221     target = expr.findall(output)
222     if len(target) == 1:
223         info["target"] = target[0].split("Target: ")[1]
224     expr = re.compile("gcc version [0-9,.]*")
225     version = expr.findall(output)
226     if len(version) == 1:
227         info["version"] = version[0].split("gcc version ")[1]
228     expr = re.compile("gcc version [0-9,.]* \(.*\)")
229     build = expr.findall(output)
230     if len(build) == 1:
231         build = build[0].split("gcc version ")[1]
232         build = build[build.find("(") + 1 : build.find(")")]
233         info["build"] = build
234     expr = re.compile("Configured with: .*")
235     configured = expr.findall(output)
236     if len(configured) == 1:
237         info["configured"] = configured[0].split("Configured with: ")[1]
238     expr = re.compile("Thread model: .*")
239     thread = expr.findall(output)
240     if len(thread) == 1:
241         info["thread"] = thread[0].split("Thread model: ")[1]
242     return info
243
244 def loadSourceTree(project):
245     fileList = [f for f in os.walk(project.info("SOURCES_PATH"))]
246     project.setInfo("FILE_LIST", fileList)
247
248 def findDefinitions(ftype, project):
249     L = project.info("FILE_LIST")
250     definitions = []
251     for element in L:
252         for filename in element[2]:
253             if fnmatch.fnmatch(filename, ftype):
254                 definitions.append((filename, element[0]))
255     return definitions
256
257 def loadCpuInfos(project):
258     cpuInfos = []
259     for definition in findDefinitions(const.CPU_DEFINITION, project):
260         cpuInfos.append(getInfos(definition))
261     return cpuInfos
262
263 def getInfos(definition):
264     D = {}
265     D.update(const.CPU_DEF)
266     def include(filename, dict = D, directory=definition[1]):
267         execfile(directory + "/" + filename, {}, D)
268     D["include"] = include
269     include(definition[0], D)
270     D["CPU_NAME"] = definition[0].split(".")[0]
271     D["DEFINITION_PATH"] = definition[1] + "/" + definition[0]
272     del D["include"]
273     return D
274
275 def getCommentList(string):
276     comment_list = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/", string)
277     comment_list = [re.findall(r"^\s*\* *(.*?)$", comment, re.MULTILINE) for comment in comment_list]
278     return comment_list
279
280 def loadModuleDefinition(first_comment):
281     to_be_parsed = False
282     module_definition = {}
283     for num, line in enumerate(first_comment):
284         index = line.find("$WIZ$")
285         if index != -1:
286             to_be_parsed = True
287             try:
288                 exec line[index + len("$WIZ$ "):] in {}, module_definition
289             except:
290                 raise ParseError(num, line[index:])
291         elif line.find("\\brief") != -1:
292             module_definition["module_description"] = line[line.find("\\brief") + len("\\brief "):]
293     module_dict = {}
294     if "module_name" in module_definition.keys():
295         module_name = module_definition[const.MODULE_DEFINITION["module_name"]]
296         del module_definition[const.MODULE_DEFINITION["module_name"]]
297         module_dict[module_name] = {}
298         if const.MODULE_DEFINITION["module_depends"] in module_definition.keys():
299             if type(module_definition[const.MODULE_DEFINITION["module_depends"]]) == str:
300                 module_definition[const.MODULE_DEFINITION["module_depends"]] = (module_definition[const.MODULE_DEFINITION["module_depends"]],)
301             module_dict[module_name]["depends"] = module_definition[const.MODULE_DEFINITION["module_depends"]]
302             del module_definition[const.MODULE_DEFINITION["module_depends"]]
303         else:
304             module_dict[module_name]["depends"] = ()
305         if const.MODULE_DEFINITION["module_configuration"] in module_definition.keys():
306             module_dict[module_name]["configuration"] = module_definition[const.MODULE_DEFINITION["module_configuration"]]
307             del module_definition[const.MODULE_DEFINITION["module_configuration"]]
308         else:
309             module_dict[module_name]["configuration"] = ""
310         if "module_description" in module_definition.keys():
311             module_dict[module_name]["description"] = module_definition["module_description"]
312             del module_definition["module_description"]
313         if const.MODULE_DEFINITION["module_harvard"] in module_definition.keys():
314             harvard = module_definition[const.MODULE_DEFINITION["module_harvard"]]
315             if harvard == "both" or harvard == "pgm_memory":
316                 module_dict[module_name]["harvard"] = harvard
317             del module_definition[const.MODULE_DEFINITION["module_harvard"]]
318         module_dict[module_name]["constants"] = module_definition
319         module_dict[module_name]["enabled"] = False
320     return to_be_parsed, module_dict
321
322 def loadDefineLists(comment_list):
323     define_list = {}
324     for comment in comment_list:
325         for num, line in enumerate(comment):
326             index = line.find("$WIZ$")
327             if index != -1:
328                 try:
329                     exec line[index + len("$WIZ$ "):] in {}, define_list
330                 except:
331                     raise ParseError(num, line[index:])
332     for key, value in define_list.items():
333         if type(value) == str:
334             define_list[key] = (value,)
335     return define_list
336
337 def getDescriptionInformations(comment): 
338     """ 
339     Take the doxygen comment and strip the wizard informations, returning the tuple 
340     (comment, wizard_information) 
341     """
342     brief = ""
343     description = ""
344     information = {}
345     for num, line in enumerate(comment):
346         index = line.find("$WIZ$")
347         if index != -1:
348             if len(brief) == 0:
349                 brief += line[:index].strip()
350             else:
351                 description += " " + line[:index]
352             try:
353                 exec line[index + len("$WIZ$ "):] in {}, information
354             except:
355                 raise ParseError(num, line[index:])
356         else:
357             if len(brief) == 0:
358                 brief += line.strip()
359             else:
360                 description += " " + line
361                 description = description.strip()
362     return brief.strip(), description.strip(), information
363
364 def getDefinitionBlocks(text):
365     """
366     Take a text and return a list of tuple (description, name-value).
367     """
368     block = []
369     block_tmp = re.finditer(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
370     for match in block_tmp:
371         # Only the first element is needed
372         comment = match.group(1)
373         define = match.group(2)
374         start = match.start()
375         block.append(([re.findall(r"^\s*\* *(.*?)$", line, re.MULTILINE)[0] for line in comment.splitlines()], define, start))
376     for match in re.finditer(r"/{3}\s*([^<].*?)\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
377         comment = match.group(1)
378         define = match.group(2)
379         start = match.start()
380         block.append(([comment], define, start))
381     for match in re.finditer(r"#define\s*(.*?)\s*/{3}<\s*(.+?)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
382         comment = match.group(2)
383         define = match.group(1)
384         start = match.start()
385         block.append(([comment], define, start))
386     return block
387
388 def loadModuleData(project):
389     module_info_dict = {}
390     list_info_dict = {}
391     configuration_info_dict = {}
392     file_dict = {}
393     for filename, path in findDefinitions("*.h", project) + findDefinitions("*.c", project) + findDefinitions("*.s", project) + findDefinitions("*.S", project):
394         comment_list = getCommentList(open(path + "/" + filename, "r").read())
395         if len(comment_list) > 0:
396             module_info = {}
397             configuration_info = {}
398             try:
399                 to_be_parsed, module_dict = loadModuleDefinition(comment_list[0])
400             except ParseError, err:
401                 raise DefineException.ModuleDefineException(path, err.line_number, err.line)
402             for module, information in module_dict.items():
403                 if "depends" not in information:
404                     information["depends"] = ()
405                 information["depends"] += (filename.split(".")[0],)
406                 information["category"] = os.path.basename(path)
407                 if "configuration" in information.keys() and len(information["configuration"]):
408                     configuration = module_dict[module]["configuration"]
409                     try:
410                         configuration_info[configuration] = loadConfigurationInfos(project.info("SOURCES_PATH") + "/" + configuration)
411                     except ParseError, err:
412                         raise DefineException.ConfigurationDefineException(project.info("SOURCES_PATH") + "/" + configuration, err.line_number, err.line)
413             module_info_dict.update(module_dict)
414             configuration_info_dict.update(configuration_info)
415             if to_be_parsed:
416                 try:
417                     list_dict = loadDefineLists(comment_list[1:])
418                     list_info_dict.update(list_dict)
419                 except ParseError, err:
420                     raise DefineException.EnumDefineException(path, err.line_number, err.line)
421     for filename, path in findDefinitions("*_" + project.info("CPU_INFOS")["TOOLCHAIN"] + ".h", project):
422         comment_list = getCommentList(open(path + "/" + filename, "r").read())
423         list_info_dict.update(loadDefineLists(comment_list))
424     for tag in project.info("CPU_INFOS")["CPU_TAGS"]:
425         for filename, path in findDefinitions("*_" + tag + ".h", project):
426             comment_list = getCommentList(open(path + "/" + filename, "r").read())
427             list_info_dict.update(loadDefineLists(comment_list))
428     project.setInfo("MODULES", module_info_dict)
429     project.setInfo("LISTS", list_info_dict)
430     project.setInfo("CONFIGURATIONS", configuration_info_dict)
431     project.setInfo("FILES", file_dict)
432     
433 def formatParamNameValue(text):
434     """
435     Take the given string and return a tuple with the name of the parameter in the first position
436     and the value in the second.
437     """
438     block = re.findall("\s*([^\s]+)\s*(.+?)\s*$", text, re.MULTILINE)
439     return block[0]
440
441 def loadConfigurationInfos(path):
442     """
443     Return the module configurations found in the given file as a dict with the
444     parameter name as key and a dict containig the fields above as value:
445         "value": the value of the parameter
446         "description": the description of the parameter
447         "informations": a dict containig optional informations:
448             "type": "int" | "boolean" | "enum"
449             "min": the minimum value for integer parameters
450             "max": the maximum value for integer parameters
451             "long": boolean indicating if the num is a long
452             "unsigned": boolean indicating if the num is an unsigned
453             "value_list": the name of the enum for enum parameters
454     """
455     configuration_infos = {}
456     configuration_infos["paramlist"] = []
457     for comment, define, start in getDefinitionBlocks(open(path, "r").read()):
458         name, value = formatParamNameValue(define)
459         brief, description, informations = getDescriptionInformations(comment)
460         configuration_infos["paramlist"].append((start, name))
461         configuration_infos[name] = {}
462         configuration_infos[name]["value"] = value
463         configuration_infos[name]["informations"] = informations
464         if not "type" in configuration_infos[name]["informations"]:
465             configuration_infos[name]["informations"]["type"] = findParameterType(configuration_infos[name])
466         if ("type" in configuration_infos[name]["informations"].keys() and
467                 configuration_infos[name]["informations"]["type"] == "int" and
468                 configuration_infos[name]["value"].find("L") != -1):
469             configuration_infos[name]["informations"]["long"] = True
470             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("L", "")
471         if ("type" in configuration_infos[name]["informations"].keys() and
472                 configuration_infos[name]["informations"]["type"] == "int" and
473                 configuration_infos[name]["value"].find("U") != -1):
474             configuration_infos[name]["informations"]["unsigned"] = True
475             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("U", "")
476         configuration_infos[name]["description"] = description
477         configuration_infos[name]["brief"] = brief
478     return configuration_infos
479
480 def findParameterType(parameter):
481     if "value_list" in parameter["informations"]:
482         return "enum"
483     if "min" in parameter["informations"] or "max" in parameter["informations"] or re.match(r"^\d+U?L?$", parameter["value"]) != None:
484         return "int"
485
486 def sub(string, parameter, value):
487     """
488     Substitute the given value at the given parameter define in the given string
489     """
490     return re.sub(r"(?P<define>#define\s+" + parameter + r"\s+)([^\s]+)", r"\g<define>" + value, string)
491
492 def isInt(informations):
493     """
494     Return True if the value is a simple int.
495     """
496     if ("long" not in informatios.keys() or not informations["long"]) and ("unsigned" not in informations.keys() or informations["unsigned"]):
497         return True
498     else:
499         return False
500
501 def isLong(informations):
502     """
503     Return True if the value is a long.
504     """
505     if "long" in informations.keys() and informations["long"] and "unsigned" not in informations.keys():
506         return True
507     else:
508         return False
509
510 def isUnsigned(informations):
511     """
512     Return True if the value is an unsigned.
513     """
514     if "unsigned" in informations.keys() and informations["unsigned"] and "long" not in informations.keys():
515         return True
516     else:
517         return False
518
519 def isUnsignedLong(informations):
520     """
521     Return True if the value is an unsigned long.
522     """
523     if "unsigned" in informations.keys() and "long" in informations.keys() and informations["unsigned"] and informations["long"]:
524         return True
525     else:
526         return False
527
528 class ParseError(Exception):
529     def __init__(self, line_number, line):
530         Exception.__init__(self)
531         self.line_number = line_number
532         self.line = line