If the project edited is a preset the wizard doesn't add the following stuff:
[bertos.git] / 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
49 from _wizard_version import WIZARD_VERSION
50
51 from LoadException import VersionException, ToolchainException
52
53 def isBertosDir(directory):
54    return os.path.exists(directory + "/VERSION")
55
56 def bertosVersion(directory):
57    return open(directory + "/VERSION").readline().strip()
58
59 def enabledModules(project_info):
60     enabled_modules = []
61     for name, module in project_info.info("MODULES").items():
62         if module["enabled"]:
63             enabled_modules.append(name)
64     return enabled_modules
65
66 def presetList(directory):
67     """
68     Return the list of the preset found in the selected BeRTOS Version.
69     """
70     abspath = os.path.join(directory, const.PREDEFINED_BOARDS_DIR)
71     preset_list = dict([
72         (os.path.join(abspath, preset_dir), presetInfo(os.path.join(abspath, preset_dir)))
73         for preset_dir in os.listdir(os.path.join(directory, const.PREDEFINED_BOARDS_DIR))
74     ])
75     return preset_list
76
77 def presetInfo(preset_dir):
78     """
79     Return the preset-relevant info contined into the project_file.
80     """
81     preset_info = pickle.loads(open(os.path.join(preset_dir, "project.bertos"), "r").read())
82     try:
83         description = open(os.path.join(preset_dir, "description"), "r").read()
84     except IOError:
85         # No description file found.
86         description = ""
87     relevant_info = {
88         "CPU_NAME": preset_info.get("CPU_NAME"),
89         "SELECTED_FREQ": preset_info.get("SELECTED_FREQ"),
90         "WIZARD_VERSION": preset_info.get("WIZARD_VERSION", None),
91         "PRESET_NAME": preset_info.get("PROJECT_NAME"),
92         "PRESET_DESCRIPTION": description.decode("utf-8"),
93     }
94     return relevant_info
95
96 def mergeSources(srcdir, new_sources, old_sources):
97     # The current mergeSources function provide only a raw copy of the sources in the
98     # created project.
99     #
100     # TODO: implement the three way merge algorithm
101     #
102     shutil.rmtree(srcdir, True)
103     copytree.copytree(os.path.join(new_sources, "bertos"), srcdir, ignore_list=const.IGNORE_LIST)
104
105 def projectFileGenerator(project_info):
106     directory = project_info.info("PROJECT_PATH")
107     project_data = {}
108     enabled_modules = []
109     for module, information in project_info.info("MODULES").items():
110         if information["enabled"]:
111             enabled_modules.append(module)
112     project_data["ENABLED_MODULES"] = enabled_modules
113     if project_info.info("PRESET"):
114         # For presets save again the BERTOS_PATH into project file
115         project_data["PRESET"] = True
116         project_data["BERTOS_PATH"] = project_info.info("BERTOS_PATH")
117     else:
118         # Use the local BeRTOS version instead of the original one
119         # project_data["BERTOS_PATH"] = project_info.info("BERTOS_PATH")
120         project_data["BERTOS_PATH"] = directory
121     project_data["PROJECT_NAME"] = project_info.info("PROJECT_NAME", os.path.basename(directory))
122     project_data["PROJECT_SRC_PATH"] = project_info.info("PROJECT_SRC_PATH")
123     project_data["TOOLCHAIN"] = project_info.info("TOOLCHAIN")
124     project_data["CPU_NAME"] = project_info.info("CPU_NAME")
125     project_data["SELECTED_FREQ"] = project_info.info("SELECTED_FREQ")
126     project_data["OUTPUT"] = project_info.info("OUTPUT")
127     project_data["WIZARD_VERSION"] = WIZARD_VERSION
128     project_data["PRESET"] = project_info.info("PRESET")
129     return pickle.dumps(project_data)
130
131 def loadPlugin(plugin):
132     """
133     Returns the given plugin module.
134     """
135     return getattr(__import__("plugins", {}, {}, [plugin]), plugin)
136
137 def versionFileGenerator(project_info, version_file):
138     version = bertosVersion(project_info.info("BERTOS_PATH"))
139     return version_file.replace('$version', version)
140
141 def userMkGenerator(project_info, makefile):
142     mk_data = {}
143     mk_data["$pname"] = os.path.basename(project_info.info("PROJECT_PATH"))
144     mk_data["$main"] = os.path.basename(project_info.info("PROJECT_PATH")) + "/main.c"
145     for key in mk_data:
146         while makefile.find(key) != -1:
147             makefile = makefile.replace(key, mk_data[key])
148     return makefile
149
150 def mkGenerator(project_info, makefile):
151     """
152     Generates the mk file for the current project.
153     """
154     mk_data = {}
155     mk_data["$pname"] = project_info.info("PROJECT_NAME")
156     mk_data["$cpuclockfreq"] = project_info.info("SELECTED_FREQ")
157     cpu_mk_parameters = []
158     for key, value in project_info.info("CPU_INFOS").items():
159         if key.startswith(const.MK_PARAM_ID):
160             cpu_mk_parameters.append("%s = %s" %(key.replace("MK", mk_data["$pname"]), value))
161     mk_data["$cpuparameters"] = "\n".join(cpu_mk_parameters)
162     mk_data["$csrc"], mk_data["$pcsrc"], mk_data["$cppasrc"], mk_data["$cxxsrc"], mk_data["$asrc"], mk_data["$constants"] = csrcGenerator(project_info)
163     mk_data["$prefix"] = replaceSeparators(project_info.info("TOOLCHAIN")["path"].split("gcc")[0])
164     mk_data["$suffix"] = replaceSeparators(project_info.info("TOOLCHAIN")["path"].split("gcc")[1])
165     mk_data["$main"] = os.path.basename(project_info.info("PROJECT_PATH")) + "/main.c"
166     for key in mk_data:
167         while makefile.find(key) != -1:
168             makefile = makefile.replace(key, mk_data[key])
169     return makefile
170
171 def makefileGenerator(project_info, makefile):
172     """
173     Generate the Makefile for the current project.
174     """
175     # TODO write a general function that works for both the mk file and the Makefile
176     while makefile.find("$pname") != -1:
177         makefile = makefile.replace("$pname", project_info.info("PROJECT_NAME"))
178     return makefile
179
180 def csrcGenerator(project_info):
181     modules = project_info.info("MODULES")
182     files = project_info.info("FILES")
183     if "harvard" in project_info.info("CPU_INFOS")["CPU_TAGS"]:
184         harvard = True
185     else:
186         harvard = False
187     # file to be included in CSRC variable
188     csrc = []
189     # file to be included in PCSRC variable
190     pcsrc = []
191     # files to be included in CPPASRC variable
192     cppasrc = []
193     # files to be included in CXXSRC variable
194     cxxsrc = []
195     # files to be included in ASRC variable
196     asrc = []
197     # constants to be included at the beginning of the makefile
198     constants = {}
199     for module, information in modules.items():
200         module_files = set([])
201         dependency_files = set([])
202         # assembly sources
203         asm_files = set([])
204         hwdir = os.path.basename(project_info.info("PROJECT_PATH")) + "/hw" 
205         if information["enabled"]:
206             if "constants" in information:
207                 constants.update(information["constants"])
208             cfiles, sfiles = findModuleFiles(module, project_info)
209             module_files |= set(cfiles)
210             asm_files |= set(sfiles)
211             for file in information["hw"]:
212                 if file.endswith(".c"):
213                     module_files |= set([hwdir + "/" + os.path.basename(file)])
214             for file_dependency in information["depends"] + tuple(files.keys()):
215                     dependencyCFiles, dependencySFiles = findModuleFiles(file_dependency, project_info)
216                     dependency_files |= set(dependencyCFiles)
217                     asm_files |= set(dependencySFiles)
218             for file in module_files:
219                 if not harvard or information.get("harvard", "both") == "both":
220                     csrc.append(file)
221                 if harvard and "harvard" in information:
222                     pcsrc.append(file)
223             for file in dependency_files:
224                 csrc.append(file)
225             for file in project_info.info("CPU_INFOS")["C_SRC"]:
226                 csrc.append(file)
227             for file in project_info.info("CPU_INFOS")["PC_SRC"]:
228                 pcsrc.append(file)
229             for file in asm_files:
230                 cppasrc.append(file)
231     for file in project_info.info("CPU_INFOS")["CPPA_SRC"]:
232         cppasrc.append(file)
233     for file in project_info.info("CPU_INFOS")["CXX_SRC"]:
234         cxxsrc.append(file)
235     for file in project_info.info("CPU_INFOS")["ASRC"]:
236         asrc.append(file)
237     csrc = set(csrc)
238     csrc = " \\\n\t".join(csrc) + " \\"
239     pcsrc = set(pcsrc)
240     pcsrc = " \\\n\t".join(pcsrc) + " \\"
241     cppasrc = set(cppasrc)
242     cppasrc = " \\\n\t".join(cppasrc) + " \\"
243     cxxsrc = set(cxxsrc)
244     cxxsrc = " \\\n\t".join(cxxsrc) + " \\"
245     asrc = set(asrc)
246     asrc = " \\\n\t".join(asrc) + " \\"
247     constants = "\n".join([os.path.basename(project_info.info("PROJECT_PATH")) + "_" + key + " = " + unicode(value) for key, value in constants.items()])
248     return csrc, pcsrc, cppasrc, cxxsrc, asrc, constants
249
250 def findModuleFiles(module, project_info):
251     # Find the files related to the selected module
252     cfiles = []
253     sfiles = []
254     # .c files related to the module and the cpu architecture
255     for filename, path in project_info.searchFiles(module + ".c"):
256         path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
257         path = replaceSeparators(path)
258         cfiles.append(path + "/" + filename)
259     # .s files related to the module and the cpu architecture
260     for filename, path in project_info.searchFiles(module + ".s") + \
261             project_info.searchFiles(module + ".S"):
262         path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
263         path = replaceSeparators(path)
264         sfiles.append(path + "/" + filename)
265     # .c and .s files related to the module and the cpu tags
266     tags = project_info.info("CPU_INFOS")["CPU_TAGS"]
267
268     # Awful, but secure check for version
269     # TODO: split me in a method/function
270     try:
271         version_string = bertosVersion(project_info.info("BERTOS_PATH"))
272         version_list = [int(i) for i in version_string.split()[-1].split('.')]
273         if version_list < [2, 5]:
274             # For older versions of BeRTOS add the toolchain to the tags
275             tags.append(project_info.info("CPU_INFOS")["TOOLCHAIN"])
276     except ValueError:
277         # If the version file hasn't a valid version number do nothing
278         pass
279
280     for tag in tags:
281         for filename, path in project_info.searchFiles(module + "_" + tag + ".c"):
282             path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
283             if os.sep != "/":
284                 path = replaceSeparators(path)
285             cfiles.append(path + "/" + filename)
286         for filename, path in project_info.searchFiles(module + "_" + tag + ".s") + \
287                 project_info.searchFiles(module + "_" + tag + ".S"):
288             path = path.replace(project_info.info("BERTOS_PATH") + os.sep, "")
289             path = replaceSeparators(path)
290             sfiles.append(path + "/" + filename)
291     return cfiles, sfiles
292
293 def replaceSeparators(path):
294     """
295     Replace the separators in the given path with unix standard separator.
296     """
297     if os.sep != "/":
298         while path.find(os.sep) != -1:
299             path = path.replace(os.sep, "/")
300     return path
301
302 def getSystemPath():
303     path = os.environ["PATH"]
304     if os.name == "nt":
305         path = path.split(";")
306     else:
307         path = path.split(":")
308     return path
309
310 def findToolchains(path_list):
311     toolchains = []
312     for element in path_list:
313         for toolchain in glob.glob(element+ "/" + const.GCC_NAME):
314             toolchains.append(toolchain)
315     return list(set(toolchains))
316
317 def getToolchainInfo(output):
318     info = {}
319     expr = re.compile("Target: .*")
320     target = expr.findall(output)
321     if len(target) == 1:
322         info["target"] = target[0].split("Target: ")[1]
323     expr = re.compile("gcc version [0-9,.]*")
324     version = expr.findall(output)
325     if len(version) == 1:
326         info["version"] = version[0].split("gcc version ")[1]
327     expr = re.compile("gcc version [0-9,.]* \(.*\)")
328     build = expr.findall(output)
329     if len(build) == 1:
330         build = build[0].split("gcc version ")[1]
331         build = build[build.find("(") + 1 : build.find(")")]
332         info["build"] = build
333     expr = re.compile("Configured with: .*")
334     configured = expr.findall(output)
335     if len(configured) == 1:
336         info["configured"] = configured[0].split("Configured with: ")[1]
337     expr = re.compile("Thread model: .*")
338     thread = expr.findall(output)
339     if len(thread) == 1:
340         info["thread"] = thread[0].split("Thread model: ")[1]
341     return info
342
343 def getToolchainName(toolchain_info):
344     name = "GCC " + toolchain_info["version"] + " - " + toolchain_info["target"].strip()
345     return name
346
347 def getTagSet(cpu_info):
348     tag_set = set([])
349     for cpu in cpu_info:
350         tag_set |= set([cpu["CPU_NAME"]])
351         tag_set |= set(cpu["CPU_TAGS"])
352         tag_set |= set([cpu["TOOLCHAIN"]])
353     return tag_set
354         
355
356 def getInfos(definition):
357     D = {}
358     D.update(const.CPU_DEF)
359     def include(filename, dict = D, directory=definition[1]):
360         execfile(directory + "/" + filename, {}, D)
361     D["include"] = include
362     include(definition[0], D)
363     D["CPU_NAME"] = definition[0].split(".")[0]
364     D["DEFINITION_PATH"] = definition[1] + "/" + definition[0]
365     del D["include"]
366     return D
367
368 def getCommentList(string):
369     comment_list = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/", string)
370     comment_list = [re.findall(r"^\s*\* *(.*?)$", comment, re.MULTILINE) for comment in comment_list]
371     return comment_list
372
373 def loadModuleDefinition(first_comment):
374     to_be_parsed = False
375     module_definition = {}
376     for num, line in enumerate(first_comment):
377         index = line.find("$WIZ$")
378         if index != -1:
379             to_be_parsed = True
380             try:
381                 exec line[index + len("$WIZ$ "):] in {}, module_definition
382             except:
383                 raise ParseError(num, line[index:])
384         elif line.find("\\brief") != -1:
385             module_definition["module_description"] = line[line.find("\\brief") + len("\\brief "):]
386     module_dict = {}
387     if "module_name" in module_definition:
388         module_name = module_definition[const.MODULE_DEFINITION["module_name"]]
389         del module_definition[const.MODULE_DEFINITION["module_name"]]
390         module_dict[module_name] = {}
391         if const.MODULE_DEFINITION["module_depends"] in module_definition:
392             depends = module_definition[const.MODULE_DEFINITION["module_depends"]]
393             del module_definition[const.MODULE_DEFINITION["module_depends"]]
394             if type(depends) == str:
395                 depends = (depends,)
396             module_dict[module_name]["depends"] = depends
397         else:
398             module_dict[module_name]["depends"] = ()
399         if const.MODULE_DEFINITION["module_configuration"] in module_definition:
400             module_dict[module_name]["configuration"] = module_definition[const.MODULE_DEFINITION["module_configuration"]]
401             del module_definition[const.MODULE_DEFINITION["module_configuration"]]
402         else:
403             module_dict[module_name]["configuration"] = ""
404         if "module_description" in module_definition:
405             module_dict[module_name]["description"] = module_definition["module_description"]
406             del module_definition["module_description"]
407         if const.MODULE_DEFINITION["module_harvard"] in module_definition:
408             harvard = module_definition[const.MODULE_DEFINITION["module_harvard"]]
409             module_dict[module_name]["harvard"] = harvard
410             del module_definition[const.MODULE_DEFINITION["module_harvard"]]
411         if const.MODULE_DEFINITION["module_hw"] in module_definition:
412             hw = module_definition[const.MODULE_DEFINITION["module_hw"]]
413             del module_definition[const.MODULE_DEFINITION["module_hw"]]
414             if type(hw) == str:
415                 hw = (hw, )
416             module_dict[module_name]["hw"] = hw
417         else:
418             module_dict[module_name]["hw"] = ()
419         if const.MODULE_DEFINITION["module_supports"] in module_definition:
420             supports = module_definition[const.MODULE_DEFINITION["module_supports"]]
421             del module_definition[const.MODULE_DEFINITION["module_supports"]]
422             module_dict[module_name]["supports"] = supports
423         module_dict[module_name]["constants"] = module_definition
424         module_dict[module_name]["enabled"] = False
425     return to_be_parsed, module_dict
426
427 def isSupported(project, module=None, property_id=None):
428     if not module and property_id:
429         item = project.info("CONFIGURATIONS")[property_id[0]][property_id[1]]["informations"]
430     else:
431         item = project.info("MODULES")[module]
432     tag_dict = project.info("ALL_CPU_TAGS")
433     if "supports" in item:
434         support_string = item["supports"]
435         supported = {}
436         try:
437             exec "supported = " + support_string in tag_dict, supported
438         except:
439             raise SupportedException(support_string)
440         return supported["supported"]
441     else:
442         return True
443
444 def loadDefineLists(comment_list):
445     define_list = {}
446     for comment in comment_list:
447         for num, line in enumerate(comment):
448             index = line.find("$WIZ$")
449             if index != -1:
450                 try:
451                     exec line[index + len("$WIZ$ "):] in {}, define_list
452                 except:
453                     raise ParseError(num, line[index:])
454     for key, value in define_list.items():
455         if type(value) == str:
456             define_list[key] = (value,)
457     return define_list
458
459 def getDescriptionInformations(comment):
460     """
461     Take the doxygen comment and strip the wizard informations, returning the tuple
462     (comment, wizard_information)
463     """
464     brief = ""
465     description = ""
466     information = {}
467     for num, line in enumerate(comment):
468         index = line.find("$WIZ$")
469         if index != -1:
470             if len(brief) == 0:
471                 brief += line[:index].strip()
472             else:
473                 description += " " + line[:index]
474             try:
475                 exec line[index + len("$WIZ$ "):] in {}, information
476             except:
477                 raise ParseError(num, line[index:])
478         else:
479             if len(brief) == 0:
480                 brief += line.strip()
481             else:
482                 description += " " + line
483                 description = description.strip()
484     return brief.strip(), description.strip(), information
485
486 def getDefinitionBlocks(text):
487     """
488     Take a text and return a list of tuple (description, name-value).
489     """
490     block = []
491     block_tmp = re.finditer(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
492     for match in block_tmp:
493         # Only the first element is needed
494         comment = match.group(1)
495         define = match.group(2)
496         start = match.start()
497         block.append(([re.findall(r"^\s*\* *(.*?)$", line, re.MULTILINE)[0] for line in comment.splitlines()], define, start))
498     for match in re.finditer(r"/{3}\s*([^<].*?)\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
499         comment = match.group(1)
500         define = match.group(2)
501         start = match.start()
502         block.append(([comment], define, start))
503     for match in re.finditer(r"#define\s*(.*?)\s*/{3}<\s*(.+?)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE):
504         comment = match.group(2)
505         define = match.group(1)
506         start = match.start()
507         block.append(([comment], define, start))
508     return block
509
510 def formatParamNameValue(text):
511     """
512     Take the given string and return a tuple with the name of the parameter in the first position
513     and the value in the second.
514     """
515     block = re.findall("\s*([^\s]+)\s*(.+?)\s*$", text, re.MULTILINE)
516     return block[0]
517
518 def loadConfigurationInfos(path):
519     """
520     Return the module configurations found in the given file as a dict with the
521     parameter name as key and a dict containig the fields above as value:
522         "value": the value of the parameter
523         "description": the description of the parameter
524         "informations": a dict containig optional informations:
525             "type": "int" | "boolean" | "enum"
526             "min": the minimum value for integer parameters
527             "max": the maximum value for integer parameters
528             "long": boolean indicating if the num is a long
529             "unsigned": boolean indicating if the num is an unsigned
530             "value_list": the name of the enum for enum parameters
531             "conditional_deps": the list of conditional dependencies for boolean parameters
532     """
533     configuration_infos = {}
534     configuration_infos["paramlist"] = []
535     for comment, define, start in getDefinitionBlocks(open(path, "r").read()):
536         name, value = formatParamNameValue(define)
537         brief, description, informations = getDescriptionInformations(comment)
538         configuration_infos["paramlist"].append((start, name))
539         configuration_infos[name] = {}
540         configuration_infos[name]["value"] = value
541         configuration_infos[name]["informations"] = informations
542         if not "type" in configuration_infos[name]["informations"]:
543             configuration_infos[name]["informations"]["type"] = findParameterType(configuration_infos[name])
544         if ("type" in configuration_infos[name]["informations"] and
545                 configuration_infos[name]["informations"]["type"] == "int" and
546                 configuration_infos[name]["value"].find("L") != -1):
547             configuration_infos[name]["informations"]["long"] = True
548             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("L", "")
549         if ("type" in configuration_infos[name]["informations"] and
550                 configuration_infos[name]["informations"]["type"] == "int" and
551                 configuration_infos[name]["value"].find("U") != -1):
552             configuration_infos[name]["informations"]["unsigned"] = True
553             configuration_infos[name]["value"] = configuration_infos[name]["value"].replace("U", "")
554         if "conditional_deps" in configuration_infos[name]["informations"]:
555             if (type(configuration_infos[name]["informations"]["conditional_deps"]) == str or
556                     type(configuration_infos[name]["informations"]["conditional_deps"]) == unicode):
557                 configuration_infos[name]["informations"]["conditional_deps"] = (configuration_infos[name]["informations"]["conditional_deps"], )
558             elif type(configuration_infos[name]["informations"]["conditional_deps"]) == tuple:
559                 pass
560             else:
561                 configuration_infos[name]["informations"]["conditional_deps"] = ()
562         configuration_infos[name]["description"] = description
563         configuration_infos[name]["brief"] = brief
564     return configuration_infos
565
566 def updateConfigurationValues(def_conf, user_conf):
567     for param in def_conf["paramlist"]:
568         if param[1] in user_conf and "value" in user_conf[param[1]]:
569             def_conf[param[1]]["value"] = user_conf[param[1]]["value"]
570     return def_conf
571
572 def findParameterType(parameter):
573     if "value_list" in parameter["informations"]:
574         return "enum"
575     if "min" in parameter["informations"] or "max" in parameter["informations"] or re.match(r"^\d+U?L?$", parameter["value"]) != None:
576         return "int"
577
578 def sub(string, parameter, value):
579     """
580     Substitute the given value at the given parameter define in the given string
581     """
582     return re.sub(r"(?P<define>#define\s+" + parameter + r"\s+)([^\s]+)", r"\g<define>" + value, string)
583
584 def isInt(informations):
585     """
586     Return True if the value is a simple int.
587     """
588     if ("long" not in informatios or not informations["long"]) and ("unsigned" not in informations or informations["unsigned"]):
589         return True
590     else:
591         return False
592
593 def isLong(informations):
594     """
595     Return True if the value is a long.
596     """
597     if "long" in informations and informations["long"] and "unsigned" not in informations:
598         return True
599     else:
600         return False
601
602 def isUnsigned(informations):
603     """
604     Return True if the value is an unsigned.
605     """
606     if "unsigned" in informations and informations["unsigned"] and "long" not in informations:
607         return True
608     else:
609         return False
610
611 def isUnsignedLong(informations):
612     """
613     Return True if the value is an unsigned long.
614     """
615     if "unsigned" in informations and "long" in informations and informations["unsigned"] and informations["long"]:
616         return True
617     else:
618         return False
619
620 class ParseError(Exception):
621     def __init__(self, line_number, line):
622         Exception.__init__(self)
623         self.line_number = line_number
624         self.line = line
625
626 class SupportedException(Exception):
627     def __init__(self, support_string):
628         Exception.__init__(self)
629         self.support_string = support_string