4 # This file is part of BeRTOS.
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.
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.
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
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.
29 # Copyright 2008 Develer S.r.l. (http://www.develer.com/)
33 # Author: Lorenzo Berni <duplo@develer.com>
41 import DefineException
43 from LoadException import VersionException, ToolchainException
47 from bertos_utils import (
49 isBertosDir, getTagSet, setEnabledModules, getInfos,
50 loadConfigurationInfos, loadDefineLists, loadModuleDefinition,
51 getCommentList, updateConfigurationValues,
54 ParseError, SupportedException
57 class BProject(object):
59 Simple class for store and retrieve project informations.
62 def __init__(self, project_file="", info_dict={}):
64 self._cached_queries = {}
66 self.loadBertosProject(project_file, info_dict)
68 def loadBertosProject(self, project_file, info_dict):
69 project_dir = os.path.dirname(project_file)
70 project_data = pickle.loads(open(project_file, "r").read())
71 # If PROJECT_NAME is not defined it use the directory name as PROJECT_NAME
72 # NOTE: this can throw an Exception if the user has changed the directory containing the project
73 self.infos["PROJECT_NAME"] = project_data.get("PROJECT_NAME", os.path.basename(project_dir))
74 self.infos["PROJECT_PATH"] = os.path.dirname(project_file)
75 # Check for the Wizard version
76 wizard_version = project_data.get("WIZARD_VERSION", 0)
77 # Ignore the SOURCES_PATH inside the project file
78 project_data["SOURCES_PATH"] = project_dir
79 if "SOURCES_PATH" in info_dict:
80 project_data["SOURCES_PATH"] = info_dict["SOURCES_PATH"]
81 if os.path.exists(project_data["SOURCES_PATH"]):
82 self.infos["SOURCES_PATH"] = project_data["SOURCES_PATH"]
84 raise VersionException(self)
85 if not isBertosDir(project_dir):
86 version_file = open(os.path.join(const.DATA_DIR, "vtemplates/VERSION"), "r").read()
87 open(os.path.join(project_dir, "VERSION"), "w").write(version_file.replace("$version", "").strip())
89 cpu_name = project_data["CPU_NAME"]
90 self.infos["CPU_NAME"] = cpu_name
91 cpu_info = self.loadCpuInfos()
93 if cpu["CPU_NAME"] == cpu_name:
94 self.infos["CPU_INFOS"] = cpu
96 tag_list = getTagSet(cpu_info)
97 # Create, fill and store the dict with the tags
99 for element in tag_list:
100 tag_dict[element] = False
101 infos = self.info("CPU_INFOS")
103 if tag in infos["CPU_TAGS"] + [infos["CPU_NAME"], infos["TOOLCHAIN"]]:
106 tag_dict[tag] = False
107 self.infos["ALL_CPU_TAGS"] = tag_dict
108 if "TOOLCHAIN" in info_dict:
109 project_data["TOOLCHAIN"] = info_dict["TOOLCHAIN"]
110 if os.path.exists(project_data["TOOLCHAIN"]["path"]):
111 self.infos["TOOLCHAIN"] = project_data["TOOLCHAIN"]
113 raise ToolchainException(self)
114 self.infos["SELECTED_FREQ"] = project_data["SELECTED_FREQ"]
115 self.infos["OUTPUT"] = project_data["OUTPUT"]
116 self.loadModuleData(True)
117 setEnabledModules(self, project_data["ENABLED_MODULES"])
119 def loadProjectFromPreset(self, preset):
121 Load a project from a preset.
123 self.loadBertosProject(os.path.join(preset, 'project.bertos'), {})
125 def loadProjectPresets(self):
127 Load the default presets (into the const.PREDEFINED_BOARDS_DIR).
129 # NOTE: this method does nothing (for now).
130 preset_path = os.path.join(self.infos["SOURCES_PATH"], const.PREDEFINED_BOARDS_DIR)
132 if os.path.exists(preset_path):
133 preset_tree = self._loadProjectPresetTree(preset_path)
134 self.infos["PRESET_TREE"] = preset_tree
136 def _loadProjectPresetTree(self, path):
138 _tree['info'] = self._loadPresetInfo(os.path.join(path, const.PREDEFINED_BOARD_SPEC_FILE))
139 _tree['info']['filename'] = os.path.basename(path)
140 _tree['info']['path'] = path
141 _tree['children'] = []
142 entries = set(os.listdir(path))
143 for entry in entries:
144 _path = os.path.join(path, entry)
145 if os.path.isdir(_path):
146 sub_entries = set(os.listdir(_path))
147 if const.PREDEFINED_BOARD_SPEC_FILE in sub_entries:
148 _tree['children'].append(self._loadProjectPresetTree(_path))
149 # Add into the info dict the dir type (dir/project)
150 if _tree['children']:
151 _tree['info']['type'] = 'dir'
153 _tree['info']['type'] = 'project'
156 def _loadPresetInfo(self, preset_spec_file):
158 execfile(preset_spec_file, {}, D)
161 def loadModuleData(self, edit=False):
162 module_info_dict = {}
164 configuration_info_dict = {}
166 for filename, path in self.findDefinitions("*.h") + self.findDefinitions("*.c") + self.findDefinitions("*.s") + self.findDefinitions("*.S"):
167 comment_list = getCommentList(open(path + "/" + filename, "r").read())
168 if len(comment_list) > 0:
170 configuration_info = {}
172 to_be_parsed, module_dict = loadModuleDefinition(comment_list[0])
173 except ParseError, err:
174 raise DefineException.ModuleDefineException(path, err.line_number, err.line)
175 for module, information in module_dict.items():
176 if "depends" not in information:
177 information["depends"] = ()
178 information["depends"] += (filename.split(".")[0],)
179 information["category"] = os.path.basename(path)
180 if "configuration" in information and len(information["configuration"]):
181 configuration = module_dict[module]["configuration"]
183 configuration_info[configuration] = loadConfigurationInfos(self.infos["SOURCES_PATH"] + "/" + configuration)
184 except ParseError, err:
185 raise DefineException.ConfigurationDefineException(self.infos["SOURCES_PATH"] + "/" + configuration, err.line_number, err.line)
188 path = self.infos["PROJECT_NAME"]
189 directory = self.infos["PROJECT_PATH"]
190 user_configuration = loadConfigurationInfos(directory + "/" + configuration.replace("bertos", path))
191 configuration_info[configuration] = updateConfigurationValues(configuration_info[configuration], user_configuration)
192 except ParseError, err:
193 raise DefineException.ConfigurationDefineException(directory + "/" + configuration.replace("bertos", path))
194 module_info_dict.update(module_dict)
195 configuration_info_dict.update(configuration_info)
198 list_dict = loadDefineLists(comment_list[1:])
199 list_info_dict.update(list_dict)
200 except ParseError, err:
201 raise DefineException.EnumDefineException(path, err.line_number, err.line)
202 for tag in self.infos["CPU_INFOS"]["CPU_TAGS"]:
203 for filename, path in self.findDefinitions("*_" + tag + ".h"):
204 comment_list = getCommentList(open(path + "/" + filename, "r").read())
205 list_info_dict.update(loadDefineLists(comment_list))
206 self.infos["MODULES"] = module_info_dict
207 self.infos["LISTS"] = list_info_dict
208 self.infos["CONFIGURATIONS"] = configuration_info_dict
209 self.infos["FILES"] = file_dict
211 def loadCpuInfos(self):
213 for definition in self.findDefinitions(const.CPU_DEFINITION):
214 cpuInfos.append(getInfos(definition))
217 def reloadCpuInfo(self):
218 for cpu_info in self.loadCpuInfos():
219 if cpu_info["CPU_NAME"] == self.infos["CPU_NAME"]:
220 self.infos["CPU_INFOS"] = cpu_info
222 def setInfo(self, key, value):
224 Store the given value with the name key.
226 self.infos[key] = value
228 def info(self, key, default=None):
230 Retrieve the value associated with the name key.
232 if key in self.infos:
233 return copy.deepcopy(self.infos[key])
236 def loadSourceTree(self):
237 # Index only the SOURCES_PATH/bertos content
238 bertos_sources_dir = os.path.join(self.info("SOURCES_PATH"), 'bertos')
240 if os.path.exists(bertos_sources_dir):
241 for element in os.walk(bertos_sources_dir):
243 file_dict[f] = file_dict.get(f, []) + [element[0]]
244 self.infos["FILE_DICT"] = file_dict
246 def searchFiles(self, filename):
247 file_dict = self.infos["FILE_DICT"]
248 return [(filename, dirname) for dirname in file_dict.get(filename, [])]
250 def findDefinitions(self, ftype):
251 # Maintain a cache for every scanned SOURCES_PATH
252 definitions_dict = self._cached_queries.get(self.infos["SOURCES_PATH"], {})
253 definitions = definitions_dict.get(ftype, None)
254 if definitions is not None:
256 file_dict = self.infos["FILE_DICT"]
258 for filename in file_dict:
259 if fnmatch.fnmatch(filename, ftype):
260 definitions += [(filename, dirname) for dirname in file_dict.get(filename, [])]
262 # If no cache for the current SOURCES_PATH create an empty one
263 if not definitions_dict:
264 self._cached_queries[self.infos["SOURCES_PATH"]] = {}
265 # Fill the empty cache with the result
266 self._cached_queries[self.infos["SOURCES_PATH"]][ftype] = definitions
270 return repr(self.infos)