]>
Commit | Line | Data |
---|---|---|
a29c47e0 | 1 | /** @file\r |
2 | \r | |
3 | Copyright (c) 2006, Intel Corporation\r | |
4 | All rights reserved. This program and the accompanying materials\r | |
5 | are licensed and made available under the terms and conditions of the BSD License\r | |
6 | which accompanies this distribution. The full text of the license may be found at\r | |
7 | http://opensource.org/licenses/bsd-license.php\r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
11 | **/\r | |
12 | package org.tianocore.build;\r | |
13 | \r | |
14 | import java.io.File;\r | |
15 | import java.util.LinkedHashMap;\r | |
a29c47e0 | 16 | import java.util.Map;\r |
991d660b | 17 | import java.io.FileOutputStream;\r |
18 | import java.io.OutputStreamWriter;\r | |
a29c47e0 | 19 | \r |
20 | import javax.xml.parsers.DocumentBuilder;\r | |
21 | import javax.xml.parsers.DocumentBuilderFactory;\r | |
22 | import javax.xml.transform.OutputKeys;\r | |
23 | import javax.xml.transform.Result;\r | |
24 | import javax.xml.transform.Source;\r | |
25 | import javax.xml.transform.Transformer;\r | |
26 | import javax.xml.transform.TransformerFactory;\r | |
27 | import javax.xml.transform.dom.DOMSource;\r | |
28 | import javax.xml.transform.stream.StreamResult;\r | |
29 | \r | |
30 | import org.apache.tools.ant.BuildException;\r | |
31 | import org.apache.tools.ant.Project;\r | |
32 | import org.tianocore.build.fpd.FpdParserTask;\r | |
a29c47e0 | 33 | import org.tianocore.build.global.SurfaceAreaQuery;\r |
34 | import org.tianocore.build.id.FpdModuleIdentification;\r | |
35 | import org.tianocore.build.id.ModuleIdentification;\r | |
36 | import org.tianocore.build.id.PackageIdentification;\r | |
37 | import org.w3c.dom.Comment;\r | |
38 | import org.w3c.dom.Document;\r | |
39 | import org.w3c.dom.Element;\r | |
40 | import org.w3c.dom.Node;\r | |
41 | \r | |
42 | public class ModuleBuildFileGenerator {\r | |
43 | \r | |
44 | ///\r | |
45 | /// Pass: TARGET, TOOLCHAIN, ARCH\r | |
46 | /// PACKAGE, PACKAGE_GUID, PACKAGE_VERSION\r | |
47 | ///\r | |
aca6c736 | 48 | String[] inheritProperties = {"ARCH", "MODULE_GUID", "MODULE_VERSION", "PACKAGE_GUID", "PACKAGE_VERSION"};\r |
a29c47e0 | 49 | \r |
50 | ///\r | |
51 | /// The information at the header of <em>build.xml</em>.\r | |
52 | ///\r | |
53 | private String info = "DO NOT EDIT \n"\r | |
391dbbb1 | 54 | + "This file is auto-generated by the build utility\n"\r |
a29c47e0 | 55 | + "\n"\r |
56 | + "Abstract:\n"\r | |
391dbbb1 | 57 | + "Auto-generated ANT build file for build EFI Modules and Platforms\n";\r |
a29c47e0 | 58 | \r |
59 | private FpdModuleIdentification fpdModuleId;\r | |
60 | \r | |
61 | private Project project;\r | |
62 | \r | |
63 | private String ffsKeyword;\r | |
64 | \r | |
bf3a7173 | 65 | private String[] includes;\r |
66 | \r | |
83fba802 | 67 | private SurfaceAreaQuery saq = null;\r |
68 | \r | |
69 | public ModuleBuildFileGenerator(Project project, String ffsKeyword, FpdModuleIdentification fpdModuleId, String[] includes, SurfaceAreaQuery saq) {\r | |
a29c47e0 | 70 | this.project = project;\r |
71 | this.fpdModuleId = fpdModuleId;\r | |
72 | this.ffsKeyword = ffsKeyword;\r | |
bf3a7173 | 73 | this.includes = includes;\r |
83fba802 | 74 | this.saq = saq;\r |
a29c47e0 | 75 | }\r |
76 | \r | |
77 | /**\r | |
78 | The whole BaseName_build.xml is composed of seven part. \r | |
79 | <ul>\r | |
80 | <li> ANT properties; </li>\r | |
81 | <li> Dependent module (dependent library instances in most case); </li>\r | |
82 | <li> Source files; </li>\r | |
83 | <li> Sections if module is not library; </li>\r | |
84 | <li> Output (different for library module and driver module); </li>\r | |
85 | <li> Clean; </li>\r | |
86 | <li> Clean all. </li>\r | |
87 | </ul>\r | |
88 | \r | |
89 | @throws BuildException\r | |
90 | Error throws during BaseName_build.xml generating. \r | |
91 | **/\r | |
92 | public void genBuildFile(String buildFilename) throws BuildException {\r | |
19bf6b15 | 93 | FfsProcess fp = new FfsProcess();\r |
a29c47e0 | 94 | DocumentBuilderFactory domfac = DocumentBuilderFactory.newInstance();\r |
95 | try {\r | |
96 | DocumentBuilder dombuilder = domfac.newDocumentBuilder();\r | |
97 | Document document = dombuilder.newDocument();\r | |
98 | Comment rootComment = document.createComment(info);\r | |
99 | \r | |
100 | //\r | |
101 | // create root element and its attributes\r | |
102 | //\r | |
103 | Element root = document.createElement("project");\r | |
104 | root.setAttribute("name", fpdModuleId.getModule().getName());\r | |
105 | root.setAttribute("default", "all");\r | |
106 | root.setAttribute("basedir", ".");\r | |
107 | \r | |
108 | //\r | |
109 | // element for External ANT tasks\r | |
110 | //\r | |
111 | root.appendChild(document.createComment("Apply external ANT tasks"));\r | |
112 | Element ele = document.createElement("taskdef");\r | |
113 | ele.setAttribute("resource", "frameworktasks.tasks");\r | |
114 | root.appendChild(ele);\r | |
115 | ele = document.createElement("taskdef");\r | |
116 | ele.setAttribute("resource", "cpptasks.tasks");\r | |
117 | root.appendChild(ele);\r | |
118 | ele = document.createElement("typedef");\r | |
119 | ele.setAttribute("resource", "cpptasks.types");\r | |
120 | root.appendChild(ele);\r | |
121 | ele = document.createElement("taskdef");\r | |
122 | ele.setAttribute("resource", "net/sf/antcontrib/antlib.xml");\r | |
123 | root.appendChild(ele);\r | |
124 | \r | |
125 | //\r | |
126 | // Generate the default target,\r | |
127 | // which depends on init, sections and output target\r | |
128 | //\r | |
129 | root.appendChild(document.createComment("Default target"));\r | |
130 | ele = document.createElement("target");\r | |
131 | ele.setAttribute("name", "all");\r | |
132 | ele.setAttribute("depends", "libraries, sourcefiles, sections, output");\r | |
133 | root.appendChild(ele);\r | |
134 | \r | |
135 | //\r | |
136 | // compile all source files\r | |
137 | //\r | |
138 | root.appendChild(document.createComment("Compile all dependency Library instances."));\r | |
139 | ele = document.createElement("target");\r | |
140 | ele.setAttribute("name", "libraries");\r | |
141 | \r | |
142 | //\r | |
143 | // Parse all sourfiles but files specified in sections\r | |
144 | //\r | |
19bf6b15 | 145 | if (!FrameworkBuildTask.multithread) {\r |
146 | applyLibraryInstance(document, ele);\r | |
147 | }\r | |
a29c47e0 | 148 | root.appendChild(ele);\r |
149 | \r | |
150 | //\r | |
151 | // compile all source files\r | |
152 | //\r | |
153 | root.appendChild(document.createComment("sourcefiles target"));\r | |
154 | ele = document.createElement("target");\r | |
155 | ele.setAttribute("name", "sourcefiles");\r | |
156 | \r | |
157 | //\r | |
158 | // Parse all sourfiles but files specified in sections\r | |
159 | //\r | |
160 | applyCompileElement(document, ele);\r | |
161 | root.appendChild(ele);\r | |
162 | \r | |
163 | //\r | |
164 | // generate the init target\r | |
165 | // main purpose is create all nessary pathes\r | |
166 | // generate the sections target\r | |
167 | //\r | |
168 | root.appendChild(document.createComment("sections target"));\r | |
169 | ele = document.createElement("target");\r | |
170 | ele.setAttribute("name", "sections");\r | |
171 | applySectionsElement(document, ele, fp);\r | |
172 | root.appendChild(ele);\r | |
173 | \r | |
174 | //\r | |
175 | // generate the output target\r | |
176 | //\r | |
177 | root.appendChild(document.createComment("output target"));\r | |
178 | ele = document.createElement("target");\r | |
179 | ele.setAttribute("name", "output");\r | |
180 | applyOutputElement(document, ele, fp);\r | |
181 | root.appendChild(ele);\r | |
182 | \r | |
183 | \r | |
184 | //\r | |
185 | // generate the clean target\r | |
186 | //\r | |
187 | root.appendChild(document.createComment("clean target"));\r | |
188 | ele = document.createElement("target");\r | |
189 | ele.setAttribute("name", "clean");\r | |
190 | applyCleanElement(document, ele);\r | |
191 | root.appendChild(ele);\r | |
192 | \r | |
193 | //\r | |
194 | // generate the Clean All target\r | |
195 | //\r | |
196 | root.appendChild(document.createComment("Clean All target"));\r | |
197 | ele = document.createElement("target");\r | |
198 | ele.setAttribute("name", "cleanall");\r | |
199 | applyDeepcleanElement(document, ele);\r | |
200 | root.appendChild(ele);\r | |
201 | \r | |
202 | //\r | |
203 | // add the root element to the document\r | |
204 | //\r | |
205 | document.appendChild(rootComment);\r | |
206 | document.appendChild(root);\r | |
207 | //\r | |
208 | // Prepare the DOM document for writing\r | |
209 | //\r | |
210 | Source source = new DOMSource(document);\r | |
211 | \r | |
212 | //\r | |
213 | // Prepare the output file\r | |
214 | //\r | |
215 | File file = new File(buildFilename);\r | |
216 | \r | |
217 | //\r | |
218 | // generate all directory path\r | |
219 | //\r | |
220 | (new File(file.getParent())).mkdirs();\r | |
991d660b | 221 | FileOutputStream outputStream = new FileOutputStream(file);\r |
222 | Result result = new StreamResult(new OutputStreamWriter(outputStream));\r | |
a29c47e0 | 223 | \r |
224 | //\r | |
225 | // Write the DOM document to the file\r | |
226 | //\r | |
227 | Transformer xformer = TransformerFactory.newInstance().newTransformer();\r | |
228 | xformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");\r | |
229 | xformer.setOutputProperty(OutputKeys.INDENT, "yes");\r | |
230 | xformer.transform(source, result);\r | |
231 | } catch (Exception ex) {\r | |
391dbbb1 | 232 | throw new BuildException("Generating the module [" + fpdModuleId.getModule().getName() + "] build.xml file failed!.\n" + ex.getMessage());\r |
a29c47e0 | 233 | }\r |
234 | }\r | |
235 | \r | |
236 | /**\r | |
237 | Generate the clean elements for BaseName_build.xml. \r | |
238 | \r | |
239 | @param document current BaseName_build.xml XML document\r | |
240 | @param root Root element for current\r | |
241 | **/\r | |
242 | private void applyCleanElement(Document document, Node root) {\r | |
a29c47e0 | 243 | //\r |
244 | // <delete includeemptydirs="true">\r | |
245 | // <fileset dir="${DEST_DIR_OUTPUT}" includes="" excludes="" />\r | |
246 | // </delete>\r | |
247 | //\r | |
248 | Element deleteEle = document.createElement("delete");\r | |
249 | deleteEle.setAttribute("includeemptydirs", "true");\r | |
250 | Element filesetEle = document.createElement("fileset");\r | |
251 | filesetEle.setAttribute("dir", "${DEST_DIR_OUTPUT}");\r | |
252 | filesetEle.setAttribute("includes", "**/*");\r | |
253 | filesetEle.setAttribute("excludes", "*.xml");\r | |
254 | deleteEle.appendChild(filesetEle);\r | |
255 | root.appendChild(deleteEle);\r | |
256 | }\r | |
257 | \r | |
258 | /**\r | |
259 | Generate the cleanall elements for BaseName_build.xml. \r | |
260 | \r | |
261 | @param document current BaseName_build.xml XML document\r | |
262 | @param root Root element for current\r | |
263 | **/\r | |
264 | private void applyDeepcleanElement(Document document, Node root) {\r | |
a29c47e0 | 265 | //\r |
266 | // <delete includeemptydirs="true">\r | |
267 | // <fileset dir="${DEST_DIR_OUTPUT}" includes="" excludes="" />\r | |
268 | // </delete>\r | |
269 | //\r | |
270 | Element deleteEle = document.createElement("delete");\r | |
271 | deleteEle.setAttribute("includeemptydirs", "true");\r | |
272 | Element filesetEle = document.createElement("fileset");\r | |
273 | filesetEle.setAttribute("dir", "${DEST_DIR_OUTPUT}");\r | |
274 | filesetEle.setAttribute("includes", "**/*");\r | |
275 | filesetEle.setAttribute("excludes", "*.xml");\r | |
276 | deleteEle.appendChild(filesetEle);\r | |
277 | root.appendChild(deleteEle);\r | |
278 | \r | |
279 | //\r | |
280 | // <delete includeemptydirs="true">\r | |
281 | // <fileset dir="${DEST_DIR_DEBUG}" includes="" />\r | |
282 | // </delete>\r | |
283 | //\r | |
284 | deleteEle = document.createElement("delete");\r | |
285 | deleteEle.setAttribute("includeemptydirs", "true");\r | |
286 | filesetEle = document.createElement("fileset");\r | |
287 | filesetEle.setAttribute("dir", "${DEST_DIR_DEBUG}");\r | |
288 | filesetEle.setAttribute("includes", "**/*");\r | |
289 | deleteEle.appendChild(filesetEle);\r | |
290 | root.appendChild(deleteEle);\r | |
291 | }\r | |
292 | \r | |
293 | /**\r | |
294 | Generate the dependent library instances elements for BaseName_build.xml. \r | |
295 | \r | |
296 | @param document current BaseName_build.xml XML document\r | |
297 | @param root Root element for current\r | |
298 | **/\r | |
299 | private void applyLibraryInstance(Document document, Node root) {\r | |
83fba802 | 300 | ModuleIdentification[] libinstances = saq.getLibraryInstance(fpdModuleId.getArch());\r |
a29c47e0 | 301 | for (int i = 0; i < libinstances.length; i++) {\r |
302 | //\r | |
303 | // Put package file path to module identification\r | |
304 | //\r | |
305 | PackageIdentification packageId = libinstances[i].getPackage();\r | |
306 | \r | |
307 | //\r | |
308 | // Generate ANT script to build library instances\r | |
309 | //\r | |
310 | Element ele = document.createElement("GenBuild");\r | |
311 | ele.setAttribute("type", "build");\r | |
a29c47e0 | 312 | \r |
313 | //\r | |
314 | // Prepare pass down information\r | |
315 | //\r | |
316 | Map<String, String> passDownMap = new LinkedHashMap<String, String>();\r | |
317 | for (int j = 0; j < inheritProperties.length; j ++){\r | |
318 | passDownMap.put(inheritProperties[j], "${" + inheritProperties[j] + "}");\r | |
319 | }\r | |
320 | \r | |
321 | passDownMap.put("MODULE_GUID", libinstances[i].getGuid());\r | |
322 | passDownMap.put("MODULE_VERSION", libinstances[i].getVersion());\r | |
323 | \r | |
324 | passDownMap.put("PACKAGE_GUID", packageId.getGuid());\r | |
325 | passDownMap.put("PACKAGE_VERSION", packageId.getVersion());\r | |
326 | \r | |
327 | for (int j = 0; j < inheritProperties.length; j ++){\r | |
328 | Element property = document.createElement("property");\r | |
329 | property.setAttribute("name", inheritProperties[j]);\r | |
330 | property.setAttribute("value", passDownMap.get(inheritProperties[j]));\r | |
331 | ele.appendChild(property);\r | |
332 | }\r | |
333 | \r | |
334 | root.appendChild(ele);\r | |
a29c47e0 | 335 | }\r |
a29c47e0 | 336 | }\r |
a33f3dd1 | 337 | \r |
a29c47e0 | 338 | /**\r |
339 | Generate the build source files elements for BaseName_build.xml. \r | |
340 | \r | |
341 | @param document current BaseName_build.xml XML document\r | |
342 | @param root Root element for current\r | |
343 | **/\r | |
344 | private void applyCompileElement(Document document, Node root) {\r | |
a29c47e0 | 345 | //\r |
346 | // sourceFiles[][0] is FileType, [][1] is File name relative to Module_Dir\r | |
347 | //\r | |
83fba802 | 348 | String[][] sourceFiles = saq.getSourceFiles(fpdModuleId.getArch());\r |
a29c47e0 | 349 | \r |
350 | FileProcess fileProcess = new FileProcess();\r | |
351 | fileProcess.init(project, includes, document);\r | |
88f858a1 | 352 | \r |
353 | //\r | |
354 | // Initialize some properties by user\r | |
355 | //\r | |
356 | Element initEle = document.createElement("Build_Init");\r | |
357 | root.appendChild(initEle);\r | |
a29c47e0 | 358 | \r |
359 | String moduleDir = project.getProperty("MODULE_DIR");\r | |
360 | //\r | |
361 | // Parse all Unicode files\r | |
362 | //\r | |
363 | for (int i = 0; i < sourceFiles.length; i++) {\r | |
364 | //\r | |
365 | // Go through all source files. Add MODULE_DIR to preffix\r | |
366 | //\r | |
367 | File sourceFile = new File(moduleDir + File.separatorChar + sourceFiles[i][1]);\r | |
368 | sourceFiles[i][1] = sourceFile.getPath();\r | |
369 | String filetype = sourceFiles[i][0];\r | |
370 | if (filetype != null) {\r | |
371 | fileProcess.parseFile(sourceFiles[i][1], filetype, root, true);\r | |
372 | } else {\r | |
373 | fileProcess.parseFile(sourceFiles[i][1], root, true);\r | |
374 | }\r | |
375 | }\r | |
376 | \r | |
377 | //\r | |
378 | // If exist Unicode file\r | |
379 | //\r | |
380 | if (fileProcess.isUnicodeExist()) {\r | |
381 | Element ele = document.createElement("Build_Unicode_Database");\r | |
382 | ele.setAttribute("FILEPATH", ".");\r | |
383 | ele.setAttribute("FILENAME", "${BASE_NAME}");\r | |
a29c47e0 | 384 | Element includesEle = document.createElement("EXTRA.INC");\r |
bf3a7173 | 385 | for (int i = 0; i < includes.length; i++) {\r |
a29c47e0 | 386 | Element includeEle = document.createElement("includepath");\r |
bf3a7173 | 387 | includeEle.setAttribute("path", includes[i]);\r |
a29c47e0 | 388 | includesEle.appendChild(includeEle);\r |
389 | }\r | |
390 | ele.appendChild(includesEle);\r | |
391 | root.appendChild(ele);\r | |
392 | }\r | |
393 | \r | |
394 | //\r | |
395 | // Parse AutoGen.c & AutoGen.h\r | |
396 | //\r | |
397 | if ( ! fpdModuleId.getModule().getName().equalsIgnoreCase("Shell")) {\r | |
398 | fileProcess.parseFile(project.getProperty("DEST_DIR_DEBUG") + File.separatorChar + "AutoGen.c", root, false);\r | |
399 | }\r | |
400 | \r | |
401 | //\r | |
402 | // Parse all source files but Unicode files\r | |
403 | //\r | |
404 | for (int i = 0; i < sourceFiles.length; i++) {\r | |
405 | String filetype = sourceFiles[i][0];\r | |
406 | if (filetype != null) {\r | |
407 | fileProcess.parseFile(sourceFiles[i][1], filetype, root, false);\r | |
408 | } else {\r | |
409 | fileProcess.parseFile(sourceFiles[i][1], root, false);\r | |
410 | }\r | |
411 | }\r | |
412 | \r | |
413 | //\r | |
414 | // Initialize SOURCE_FILES for dependcy check use\r | |
415 | //\r | |
416 | String str = "";\r | |
417 | for (int i = 0; i < sourceFiles.length; i++) {\r | |
418 | str += " " + sourceFiles[i][1];\r | |
419 | }\r | |
aca6c736 | 420 | project.setProperty("SOURCE_FILES", str.replaceAll("(\\\\)", "/"));\r |
a29c47e0 | 421 | }\r |
422 | \r | |
423 | /**\r | |
424 | Generate the section elements for BaseName_build.xml. Library module will\r | |
425 | skip this process. \r | |
426 | \r | |
427 | @param document current BaseName_build.xml XML document\r | |
428 | @param root Root element for current\r | |
429 | **/\r | |
430 | private void applySectionsElement(Document document, Node root, FfsProcess fp) {\r | |
431 | if (fpdModuleId.getModule().isLibrary()) {\r | |
432 | return ;\r | |
433 | }\r | |
434 | if (fp.initSections(ffsKeyword, project, fpdModuleId)) {\r | |
196ad8d7 | 435 | String targetFilename = fpdModuleId.getModule().getGuid() + "-" + "${BASE_NAME}" + FpdParserTask.getSuffix(fpdModuleId.getModule().getModuleType());\r |
a29c47e0 | 436 | String[] list = fp.getGenSectionElements(document, "${BASE_NAME}", fpdModuleId.getModule().getGuid(), targetFilename);\r |
437 | \r | |
438 | for (int i = 0; i < list.length; i++) {\r | |
439 | Element ele = document.createElement(list[i]);\r | |
440 | ele.setAttribute("FILEPATH", ".");\r | |
441 | ele.setAttribute("FILENAME", "${BASE_NAME}");\r | |
442 | root.appendChild(ele);\r | |
443 | }\r | |
444 | }\r | |
445 | }\r | |
446 | \r | |
447 | /**\r | |
448 | Generate the output elements for BaseName_build.xml. If module is library,\r | |
449 | call the <em>LIB</em> command, else call the <em>GenFfs</em> command. \r | |
450 | \r | |
451 | @param document current BaseName_build.xml XML document\r | |
452 | @param root Root element for current\r | |
453 | **/\r | |
454 | private void applyOutputElement(Document document, Node root, FfsProcess fp) {\r | |
455 | if (fpdModuleId.getModule().isLibrary()) {\r | |
456 | //\r | |
457 | // call Lib command\r | |
458 | //\r | |
459 | Element cc = document.createElement("Build_Library");\r | |
460 | cc.setAttribute("FILENAME", fpdModuleId.getModule().getName());\r | |
461 | root.appendChild(cc);\r | |
462 | }\r | |
463 | //\r | |
464 | // if it is a module but library\r | |
465 | //\r | |
466 | else {\r | |
467 | if (fp.getFfsNode() != null) {\r | |
468 | root.appendChild(fp.getFfsNode());\r | |
469 | }\r | |
470 | }\r | |
471 | }\r | |
472 | \r | |
473 | }\r |