2 This file is ANT task GenBuild.
4 The file is used to parse a specified Module, and generate its build time
5 ANT script build.xml, then call the the ANT script to build the module.
7 Copyright (c) 2006, Intel Corporation
8 All rights reserved. This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 package org
.tianocore
.build
;
19 import java
.util
.Hashtable
;
20 import java
.util
.Iterator
;
21 import java
.util
.LinkedHashSet
;
22 import java
.util
.List
;
25 import java
.util
.Vector
;
27 import org
.apache
.tools
.ant
.BuildException
;
28 import org
.apache
.tools
.ant
.BuildListener
;
29 import org
.apache
.tools
.ant
.Project
;
30 import org
.apache
.tools
.ant
.taskdefs
.Ant
;
31 import org
.apache
.tools
.ant
.taskdefs
.Property
;
32 import org
.apache
.xmlbeans
.XmlObject
;
34 import org
.tianocore
.common
.definitions
.ToolDefinitions
;
35 import org
.tianocore
.common
.exception
.EdkException
;
36 import org
.tianocore
.common
.logger
.EdkLog
;
37 import org
.tianocore
.build
.autogen
.AutoGen
;
38 import org
.tianocore
.build
.exception
.AutoGenException
;
39 import org
.tianocore
.build
.exception
.GenBuildException
;
40 import org
.tianocore
.build
.exception
.PcdAutogenException
;
41 import org
.tianocore
.build
.exception
.PlatformPcdPreprocessBuildException
;
42 import org
.tianocore
.build
.fpd
.FpdParserTask
;
43 import org
.tianocore
.build
.global
.GlobalData
;
44 import org
.tianocore
.build
.global
.OutputManager
;
45 import org
.tianocore
.build
.global
.SurfaceAreaQuery
;
46 import org
.tianocore
.build
.id
.FpdModuleIdentification
;
47 import org
.tianocore
.build
.id
.ModuleIdentification
;
48 import org
.tianocore
.build
.id
.PackageIdentification
;
49 import org
.tianocore
.build
.id
.PlatformIdentification
;
50 import org
.tianocore
.build
.tools
.ModuleItem
;
54 <code>GenBuildTask</code> is an ANT task that can be used in ANT build
57 <p>The main function of this task is to parse module's surface area (MSA),
58 then generate the corresponding <em>BaseName_build.xml</em> (the real ANT
59 build script) and call this to build the module. The whole process including:
62 1. generate AutoGen.c and AutoGen.h;
63 2. build all dependent library instances;
64 3. build all source files inlcude AutoGen.c;
66 5. generate FFS file if it is driver module while LIB file if it is Library module.
71 The usage is (take module <em>HelloWorld</em> for example):
76 msaFile="${PACKAGE_DIR}/Application/HelloWorld/HelloWorld.msa"
81 This task calls <code>AutoGen</code> to generate <em>AutoGen.c</em> and
86 This task will also set properties for current module, such as PACKAGE,
87 PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR
88 (relative to Workspace), MODULE or BASE_NAME, GUID, VERSION, MODULE_DIR,
89 MODULE_RELATIVE_DIR (relative to Package), CONFIG_DIR, BIN_DIR,
90 DEST_DIR_DEBUG, DEST_DIR_OUTPUT, TARGET, ARCH, TOOLCHAIN, TOOLCHAIN_FAMILY,
91 SUBSYSTEM, ENTRYPOINT, EBC_TOOL_LIB_PATH, all compiler command related
92 properties (CC, CC_FLAGS, CC_DPATH, CC_SPATH, CC_FAMILY, CC_EXT).
97 public class GenBuildTask
extends Ant
{
100 /// Module surface area file.
104 public ModuleIdentification parentId
;
106 private String type
= "all";
109 /// Module's Identification.
111 private ModuleIdentification moduleId
;
113 private Vector
<Property
> properties
= new Vector
<Property
>();
115 private boolean isSingleModuleBuild
= false;
117 private SurfaceAreaQuery saq
= null;
120 Public construct method. It is necessary for ANT task.
122 public GenBuildTask() {
127 @throws BuildException
128 From module build, exception from module surface area invalid.
130 public void execute() throws BuildException
{
131 this.setTaskName("GenBuild");
134 } catch (PcdAutogenException e
) {
135 BuildException buildException
= new BuildException(e
.getMessage());
136 buildException
.setStackTrace(e
.getStackTrace());
137 throw buildException
;
138 } catch (AutoGenException e
) {
139 BuildException buildException
= new BuildException(e
.getMessage());
140 buildException
.setStackTrace(e
.getStackTrace());
141 throw buildException
;
142 } catch (PlatformPcdPreprocessBuildException e
) {
143 BuildException buildException
= new BuildException(e
.getMessage());
144 buildException
.setStackTrace(e
.getStackTrace());
145 throw buildException
;
146 } catch (GenBuildException e
) {
147 BuildException buildException
= new BuildException(e
.getMessage());
148 buildException
.setStackTrace(e
.getStackTrace());
149 throw buildException
;
150 } catch (EdkException e
) {
151 BuildException buildException
= new BuildException(e
.getMessage());
152 buildException
.setStackTrace(e
.getStackTrace());
153 throw buildException
;
157 private void processGenBuild() throws EdkException
, BuildException
, GenBuildException
, AutoGenException
, PcdAutogenException
, PlatformPcdPreprocessBuildException
{
158 if (!FrameworkBuildTask
.multithread
) {
163 // Enable all specified properties
165 Iterator
<Property
> iter
= properties
.iterator();
166 while (iter
.hasNext()) {
167 Property item
= iter
.next();
168 getProject().setProperty(item
.getName(), item
.getValue());
172 // GenBuild should specify either msaFile or moduleGuid & packageGuid
174 if (msaFile
== null ) {
175 String moduleGuid
= getProject().getProperty("MODULE_GUID");
176 String moduleVersion
= getProject().getProperty("MODULE_VERSION");
177 String packageGuid
= getProject().getProperty("PACKAGE_GUID");
178 String packageVersion
= getProject().getProperty("PACKAGE_VERSION");
180 // If one of module Guid or package Guid is not specified, report error
182 if (moduleGuid
== null || packageGuid
== null) {
183 throw new BuildException("GenBuild parameter error.");
186 PackageIdentification packageId
= new PackageIdentification(packageGuid
, packageVersion
);
187 GlobalData
.refreshPackageIdentification(packageId
);
188 moduleId
= new ModuleIdentification(moduleGuid
, moduleVersion
);
189 moduleId
.setPackage(packageId
);
190 GlobalData
.refreshModuleIdentification(moduleId
);
191 Map
<String
, XmlObject
> doc
= GlobalData
.getNativeMsa(moduleId
);
192 saq
= new SurfaceAreaQuery(doc
);
194 Map
<String
, XmlObject
> doc
= GlobalData
.getNativeMsa(msaFile
);
195 saq
= new SurfaceAreaQuery(doc
);
196 moduleId
= saq
.getMsaHeader();
197 moduleId
.setMsaFile(msaFile
);
200 String
[] producedLibraryClasses
= saq
.getLibraryClasses("ALWAYS_PRODUCED",null);
201 if (producedLibraryClasses
.length
== 0) {
202 moduleId
.setLibrary(false);
204 moduleId
.setLibrary(true);
208 // Judge whether it is single module build or not
210 if (isSingleModuleBuild
) {
212 // Single Module build
214 prepareSingleModuleBuild();
218 // If single module : get arch from pass down, otherwise intersection MSA
219 // supported ARCHs and tools def
221 Set
<String
> archListSupByToolChain
= new LinkedHashSet
<String
>();
222 String
[] archs
= GlobalData
.getToolChainInfo().getArchs();
224 for (int i
= 0; i
< archs
.length
; i
++) {
225 archListSupByToolChain
.add(archs
[i
]);
228 Set
<String
> archSet
= new LinkedHashSet
<String
>();
230 if ( getProject().getProperty("ARCH") != null) {
231 String
[] fpdArchList
= getProject().getProperty("ARCH").split(" ");
233 for (int i
= 0; i
< fpdArchList
.length
; i
++) {
234 if (archListSupByToolChain
.contains(fpdArchList
[i
])) {
235 archSet
.add(fpdArchList
[i
]);
239 archSet
= archListSupByToolChain
;
242 String
[] archList
= archSet
.toArray(new String
[archSet
.size()]);
245 // Judge if arch is all supported by current module. If not, throw Exception.
247 List moduleSupportedArchs
= saq
.getModuleSupportedArchs();
248 if (moduleSupportedArchs
!= null) {
249 for (int k
= 0; k
< archList
.length
; k
++) {
250 if ( ! moduleSupportedArchs
.contains(archList
[k
])) {
251 throw new BuildException("Specified architecture [" + archList
[k
] + "] is not supported by " + moduleId
+ ". The module " + moduleId
+ " only supports [" + moduleSupportedArchs
+ "] architectures.");
256 if (archList
.length
== 0) {
257 EdkLog
.log(this, EdkLog
.EDK_WARNING
, "Warning: " + moduleId
+ " was not found in current platform FPD file!\n");
260 for (int k
= 0; k
< archList
.length
; k
++) {
262 getProject().setProperty("ARCH", archList
[k
]);
264 FpdModuleIdentification fpdModuleId
= new FpdModuleIdentification(moduleId
, archList
[k
]);
267 // Whether the module is built before
269 if (moduleId
.isLibrary() == false && GlobalData
.hasFpdModuleSA(fpdModuleId
) == false) {
270 EdkLog
.log(this, EdkLog
.EDK_WARNING
, "Warning: " + moduleId
+ " for " + archList
[k
] + " was not found in current platform FPD file!\n");
272 } else if (GlobalData
.isModuleBuilt(fpdModuleId
)) {
275 GlobalData
.registerBuiltModule(fpdModuleId
);
279 // For Every TOOLCHAIN, TARGET
281 String
[] targetList
= GlobalData
.getToolChainInfo().getTargets();
282 for (int i
= 0; i
< targetList
.length
; i
++){
284 // Prepare for target related common properties
287 getProject().setProperty("TARGET", targetList
[i
]);
288 String
[] toolchainList
= GlobalData
.getToolChainInfo().getTagnames();
289 for(int j
= 0; j
< toolchainList
.length
; j
++){
291 // check if any tool is defined for current target + toolchain + arch
292 // don't do anything if no tools found
294 if (GlobalData
.isCommandSet(targetList
[i
], toolchainList
[j
], archList
[k
]) == false) {
295 EdkLog
.log(this, EdkLog
.EDK_WARNING
, "Warning: No build issued. No tools found for [target=" + targetList
[i
] + " toolchain=" + toolchainList
[j
] + " arch=" + archList
[k
] + "]\n");
300 // Prepare for toolchain related common properties
303 getProject().setProperty("TOOLCHAIN", toolchainList
[j
]);
305 EdkLog
.log(this, "Build " + moduleId
+ " start >>>");
306 EdkLog
.log(this, "Target: " + targetList
[i
] + " Tagname: " + toolchainList
[j
] + " Arch: " + archList
[k
]);
307 saq
.push(GlobalData
.getDoc(fpdModuleId
));
310 // Prepare for all other common properties
311 // PACKAGE, PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR
312 // MODULE or BASE_NAME, GUID or FILE_GUID, VERSION, MODULE_TYPE
313 // MODULE_DIR, MODULE_RELATIVE_DIR
314 // SUBSYSTEM, ENTRYPOINT, EBC_TOOL_LIB_PATH
316 setModuleCommonProperties(archList
[k
]);
319 // OutputManage prepare for
320 // BIN_DIR, DEST_DIR_DEBUG, DEST_DIR_OUTPUT, BUILD_DIR, FV_DIR
322 OutputManager
.getInstance().update(getProject());
324 if (type
.equalsIgnoreCase("all") || type
.equalsIgnoreCase("build")) {
325 applyBuild(targetList
[i
], toolchainList
[j
], fpdModuleId
);
326 } else if (type
.equalsIgnoreCase("clean")) {
327 applyClean(fpdModuleId
);
328 } else if (type
.equalsIgnoreCase("cleanall")) {
329 applyCleanall(fpdModuleId
);
337 This method is used to prepare Platform-related information.
339 <p>In Single Module Build mode, platform-related information is not ready.
340 The method read the system environment variable <code>ACTIVE_PLATFORM</code>
341 and search in the Framework Database. Note that platform name in the Framework
342 Database must be unique. </p>
345 private void prepareSingleModuleBuild() throws EdkException
{
347 // Find out the package which the module belongs to
349 PackageIdentification packageId
= GlobalData
.getPackageForModule(moduleId
);
350 GlobalData
.refreshPackageIdentification(packageId
);
351 moduleId
.setPackage(packageId
);
352 GlobalData
.refreshModuleIdentification(moduleId
);
355 // Read ACTIVE_PLATFORM's FPD file
357 String filename
= getProject().getProperty("PLATFORM_FILE");
359 if (filename
== null){
360 throw new BuildException("Please set ACTIVE_PLATFORM in the file: Tools/Conf/target.txt if you want to build a single module!");
363 PlatformIdentification platformId
= GlobalData
.getPlatform(filename
);
366 // Read FPD file (Call FpdParserTask's method)
368 FpdParserTask fpdParser
= new FpdParserTask();
369 fpdParser
.setProject(getProject());
370 fpdParser
.parseFpdFile(platformId
.getFpdFile());
371 getProject().setProperty("ARCH", fpdParser
.getAllArchForModule(moduleId
));
374 private void cleanupProperties() {
375 Project newProject
= new Project();
377 Hashtable
<String
, String
> passdownProperties
= FrameworkBuildTask
.originalProperties
;
378 Iterator
<String
> iter
= passdownProperties
.keySet().iterator();
379 while (iter
.hasNext()) {
380 String item
= iter
.next();
381 newProject
.setProperty(item
, passdownProperties
.get(item
));
384 newProject
.setInputHandler(getProject().getInputHandler());
386 Iterator listenerIter
= getProject().getBuildListeners().iterator();
387 while (listenerIter
.hasNext()) {
388 newProject
.addBuildListener((BuildListener
) listenerIter
.next());
391 getProject().initSubProject(newProject
);
393 setProject(newProject
);
397 Set Module-Related information to properties.
399 @param arch current build ARCH
401 private void setModuleCommonProperties(String arch
) {
403 // Prepare for all other common properties
404 // PACKAGE, PACKAGE_GUID, PACKAGE_VERSION, PACKAGE_DIR, PACKAGE_RELATIVE_DIR
406 PackageIdentification packageId
= moduleId
.getPackage();
407 getProject().setProperty("PACKAGE", packageId
.getName());
408 getProject().setProperty("PACKAGE_GUID", packageId
.getGuid());
409 getProject().setProperty("PACKAGE_VERSION", packageId
.getVersion());
410 getProject().setProperty("PACKAGE_DIR", packageId
.getPackageDir().replaceAll("(\\\\)", "/"));
411 getProject().setProperty("PACKAGE_RELATIVE_DIR", packageId
.getPackageRelativeDir().replaceAll("(\\\\)", "/"));
414 // MODULE or BASE_NAME, GUID or FILE_GUID, VERSION, MODULE_TYPE
415 // MODULE_DIR, MODULE_RELATIVE_DIR
417 getProject().setProperty("MODULE", moduleId
.getName());
418 String baseName
= saq
.getModuleOutputFileBasename();
419 if (baseName
== null) {
420 getProject().setProperty("BASE_NAME", moduleId
.getName());
422 getProject().setProperty("BASE_NAME", baseName
);
424 getProject().setProperty("GUID", moduleId
.getGuid());
425 getProject().setProperty("FILE_GUID", moduleId
.getGuid());
426 getProject().setProperty("VERSION", moduleId
.getVersion());
427 getProject().setProperty("MODULE_TYPE", moduleId
.getModuleType());
428 getProject().setProperty("MODULE_DIR", moduleId
.getMsaFile().getParent().replaceAll("(\\\\)", "/"));
429 getProject().setProperty("MODULE_RELATIVE_DIR", moduleId
.getModuleRelativePath().replaceAll("(\\\\)", "/") + File
.separatorChar
+ moduleId
.getName());
434 String
[][] subsystemMap
= { { "BASE", "EFI_BOOT_SERVICE_DRIVER"},
435 { "SEC", "EFI_BOOT_SERVICE_DRIVER" },
436 { "PEI_CORE", "EFI_BOOT_SERVICE_DRIVER" },
437 { "PEIM", "EFI_BOOT_SERVICE_DRIVER" },
438 { "DXE_CORE", "EFI_BOOT_SERVICE_DRIVER" },
439 { "DXE_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },
440 { "DXE_RUNTIME_DRIVER", "EFI_RUNTIME_DRIVER" },
441 { "DXE_SAL_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },
442 { "DXE_SMM_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },
443 { "TOOL", "EFI_BOOT_SERVICE_DRIVER" },
444 { "UEFI_DRIVER", "EFI_BOOT_SERVICE_DRIVER" },
445 { "UEFI_APPLICATION", "EFI_APPLICATION" },
446 { "USER_DEFINED", "EFI_BOOT_SERVICE_DRIVER"} };
448 String subsystem
= "EFI_BOOT_SERVICE_DRIVER";
449 for (int i
= 0; i
< subsystemMap
.length
; i
++) {
450 if (moduleId
.getModuleType().equalsIgnoreCase(subsystemMap
[i
][0])) {
451 subsystem
= subsystemMap
[i
][1];
455 getProject().setProperty("SUBSYSTEM", subsystem
);
460 if (arch
.equalsIgnoreCase("EBC")) {
461 getProject().setProperty("ENTRYPOINT", "EfiStart");
463 getProject().setProperty("ENTRYPOINT", "_ModuleEntryPoint");
466 getProject().setProperty("OBJECTS", "");
469 private void getCompilerFlags(String target
, String toolchain
, FpdModuleIdentification fpdModuleId
) throws EdkException
{
470 String
[] cmd
= GlobalData
.getToolChainInfo().getCommands();
471 for ( int m
= 0; m
< cmd
.length
; m
++) {
473 // Set cmd, like CC, DLINK
475 String
[] key
= new String
[]{target
, toolchain
, fpdModuleId
.getArch(), cmd
[m
], null};
476 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_PATH
;
477 String cmdPath
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
478 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_NAME
;
479 String cmdName
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
480 if (cmdName
.length() == 0) {
481 EdkLog
.log(this, EdkLog
.EDK_VERBOSE
, "Warning: " + cmd
[m
] + " hasn't been defined!");
482 getProject().setProperty(cmd
[m
], "");
485 File cmdFile
= new File(cmdPath
+ File
.separatorChar
+ cmdName
);
486 getProject().setProperty(cmd
[m
], cmdFile
.getPath().replaceAll("(\\\\)", "/"));
491 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_FLAGS
;
492 String cmdFlags
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
493 if (cmdFlags
!= null)
495 getProject().setProperty(cmd
[m
] + "_FLAGS", cmdFlags
);
499 getProject().setProperty(cmd
[m
] + "_FLAGS", "");
505 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_EXT
;
506 String extName
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
507 if ( extName
!= null && ! extName
.equalsIgnoreCase("")) {
508 getProject().setProperty(cmd
[m
] + "_EXT", extName
);
510 getProject().setProperty(cmd
[m
] + "_EXT", "");
516 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_FAMILY
;
517 String toolChainFamily
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
518 if (toolChainFamily
!= null) {
519 getProject().setProperty(cmd
[m
] + "_FAMILY", toolChainFamily
);
525 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_SPATH
;
526 String spath
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
528 getProject().setProperty(cmd
[m
] + "_SPATH", spath
.replaceAll("(\\\\)", "/"));
530 getProject().setProperty(cmd
[m
] + "_SPATH", "");
536 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_DPATH
;
537 String dpath
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
539 getProject().setProperty(cmd
[m
] + "_DPATH", dpath
.replaceAll("(\\\\)", "/"));
541 getProject().setProperty(cmd
[m
] + "_DPATH", "");
547 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_LIBPATH
;
548 String libpath
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
549 if (libpath
!= null) {
550 getProject().setProperty(cmd
[m
] + "_LIBPATH", libpath
.replaceAll("(\\\\)", "/"));
552 getProject().setProperty(cmd
[m
] + "_LIBPATH", "");
556 // Set CC_INCLUDEPATH
558 key
[4] = ToolDefinitions
.TOOLS_DEF_ATTRIBUTE_INCLUDEPATH
;
559 String includepath
= GlobalData
.getCommandSetting(key
, fpdModuleId
);
561 getProject().setProperty(cmd
[m
] + "_INCLUDEPATH", includepath
.replaceAll("(\\\\)", "/"));
563 getProject().setProperty(cmd
[m
] + "_INCLUDEPATH", "");
568 public void setMsaFile(File msaFile
) {
569 this.msaFile
= msaFile
;
573 Method is for ANT to initialize MSA file.
575 @param msaFilename MSA file name
577 public void setMsaFile(String msaFilename
) {
578 String moduleDir
= getProject().getProperty("MODULE_DIR");
581 // If is Single Module Build, then use the Base Dir defined in build.xml
583 if (moduleDir
== null) {
584 moduleDir
= getProject().getBaseDir().getPath();
586 msaFile
= new File(moduleDir
+ File
.separatorChar
+ msaFilename
);
589 public void addConfiguredModuleItem(ModuleItem moduleItem
) {
590 PackageIdentification packageId
= new PackageIdentification(moduleItem
.getPackageGuid(), moduleItem
.getPackageVersion());
591 ModuleIdentification moduleId
= new ModuleIdentification(moduleItem
.getModuleGuid(), moduleItem
.getModuleVersion());
592 moduleId
.setPackage(packageId
);
593 this.moduleId
= moduleId
;
601 public void addProperty(Property p
) {
602 properties
.addElement(p
);
605 public void setType(String type
) {
609 private void applyBuild(String buildTarget
, String buildTagname
, FpdModuleIdentification fpdModuleId
) throws EdkException
{
611 // Call AutoGen to generate AutoGen.c and AutoGen.h
613 AutoGen autogen
= new AutoGen(getProject().getProperty("FV_DIR"), getProject().getProperty("DEST_DIR_DEBUG"), fpdModuleId
.getModule(),fpdModuleId
.getArch(), saq
, parentId
);
614 autogen
.genAutogen();
617 // Get compiler flags
620 getCompilerFlags(buildTarget
, buildTagname
, fpdModuleId
);
622 catch (EdkException ee
) {
623 throw new BuildException(ee
.getMessage());
629 ModuleIdentification
[] libinstances
= saq
.getLibraryInstance(fpdModuleId
.getArch());
630 String propertyLibs
= "";
631 for (int i
= 0; i
< libinstances
.length
; i
++) {
632 propertyLibs
+= getProject().getProperty("BIN_DIR") + File
.separatorChar
+ libinstances
[i
].getName() + ".lib" + " ";
634 getProject().setProperty("LIBS", propertyLibs
.replaceAll("(\\\\)", "/"));
637 // Get all includepath and set to INCLUDE_PATHS
639 String
[] includes
= prepareIncludePaths(fpdModuleId
);
642 // if it is CUSTOM_BUILD
643 // then call the exist BaseName_build.xml directly.
645 if (moduleId
.getModuleType().equalsIgnoreCase("USER_DEFINED")) {
646 EdkLog
.log(this, "Call user-defined " + moduleId
.getName() + "_build.xml");
648 String antFilename
= getProject().getProperty("MODULE_DIR") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
649 antCall(antFilename
, null);
655 // Generate ${BASE_NAME}_build.xml
658 String ffsKeyword
= saq
.getModuleFfsKeyword();
659 ModuleBuildFileGenerator fileGenerator
= new ModuleBuildFileGenerator(getProject(), ffsKeyword
, fpdModuleId
, includes
, saq
);
660 String buildFilename
= getProject().getProperty("DEST_DIR_OUTPUT") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
661 fileGenerator
.genBuildFile(buildFilename
);
664 // Ant call ${BASE_NAME}_build.xml
666 String antFilename
= getProject().getProperty("DEST_DIR_OUTPUT") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
667 antCall(antFilename
, null);
670 private void applyClean(FpdModuleIdentification fpdModuleId
){
672 // if it is CUSTOM_BUILD
673 // then call the exist BaseName_build.xml directly.
675 if (moduleId
.getModuleType().equalsIgnoreCase("USER_DEFINED")) {
676 EdkLog
.log(this, "Calling user-defined " + moduleId
.getName() + "_build.xml");
678 String antFilename
= getProject().getProperty("MODULE_DIR") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
679 antCall(antFilename
, "clean");
684 String antFilename
= getProject().getProperty("DEST_DIR_OUTPUT") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
685 antCall(antFilename
, "clean");
688 private void applyCleanall(FpdModuleIdentification fpdModuleId
){
690 // if it is CUSTOM_BUILD
691 // then call the exist BaseName_build.xml directly.
693 if (moduleId
.getModuleType().equalsIgnoreCase("USER_DEFINED")) {
694 EdkLog
.log(this, "Calling user-defined " + moduleId
.getName() + "_build.xml");
696 String antFilename
= getProject().getProperty("MODULE_DIR") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
697 antCall(antFilename
, "cleanall");
702 String antFilename
= getProject().getProperty("DEST_DIR_OUTPUT") + File
.separatorChar
+ moduleId
.getName() + "_build.xml";
703 antCall(antFilename
, "cleanall");
706 private void antCall(String antFilename
, String target
) {
708 ant
.setProject(getProject());
709 ant
.setAntfile(antFilename
);
710 if (target
!= null) {
711 ant
.setTarget(target
);
713 ant
.setInheritAll(true);
718 public void setSingleModuleBuild(boolean isSingleModuleBuild
) {
719 this.isSingleModuleBuild
= isSingleModuleBuild
;
722 private String
[] prepareIncludePaths(FpdModuleIdentification fpdModuleId
) throws EdkException
{
724 // Prepare the includes: PackageDependencies and Output debug direactory
726 Set
<String
> includes
= new LinkedHashSet
<String
>();
727 String arch
= fpdModuleId
.getArch();
732 includes
.add("${WORKSPACE_DIR}" + File
.separatorChar
);
737 includes
.add("${MODULE_DIR}");
738 includes
.add("${MODULE_DIR}" + File
.separatorChar
+ archDir(arch
));
741 // Packages in PackageDenpendencies
743 PackageIdentification
[] packageDependencies
= saq
.getDependencePkg(fpdModuleId
.getArch());
744 for (int i
= 0; i
< packageDependencies
.length
; i
++) {
745 GlobalData
.refreshPackageIdentification(packageDependencies
[i
]);
746 File packageFile
= packageDependencies
[i
].getSpdFile();
747 includes
.add(packageFile
.getParent() + File
.separatorChar
+ "Include");
748 includes
.add(packageFile
.getParent() + File
.separatorChar
+ "Include" + File
.separatorChar
+ archDir(arch
));
752 // All Dependency Library Instance's PackageDependencies
754 ModuleIdentification
[] libinstances
= saq
.getLibraryInstance(fpdModuleId
.getArch());
755 for (int i
= 0; i
< libinstances
.length
; i
++) {
756 saq
.push(GlobalData
.getDoc(libinstances
[i
], fpdModuleId
.getArch()));
757 PackageIdentification
[] libraryPackageDependencies
= saq
.getDependencePkg(fpdModuleId
.getArch());
758 for (int j
= 0; j
< libraryPackageDependencies
.length
; j
++) {
759 GlobalData
.refreshPackageIdentification(libraryPackageDependencies
[j
]);
760 File packageFile
= libraryPackageDependencies
[j
].getSpdFile();
761 includes
.add(packageFile
.getParent() + File
.separatorChar
+ "Include");
762 includes
.add(packageFile
.getParent() + File
.separatorChar
+ "Include" + File
.separatorChar
+ archDir(arch
));
769 // The package which the module belongs to
771 includes
.add(fpdModuleId
.getModule().getPackage().getPackageDir() + File
.separatorChar
+ "Include");
772 includes
.add(fpdModuleId
.getModule().getPackage().getPackageDir() + File
.separatorChar
+ "Include" + File
.separatorChar
+ archDir(arch
));
775 // Debug files output directory
777 includes
.add("${DEST_DIR_DEBUG}");
780 // set to INCLUDE_PATHS property
782 Iterator
<String
> iter
= includes
.iterator();
783 StringBuffer includePaths
= new StringBuffer();
784 while (iter
.hasNext()) {
785 includePaths
.append(iter
.next());
786 includePaths
.append("; ");
788 getProject().setProperty("INCLUDE_PATHS", getProject().replaceProperties(includePaths
.toString()).replaceAll("(\\\\)", "/"));
790 return includes
.toArray(new String
[includes
.size()]);
794 Return the name of the directory that corresponds to the architecture.
795 This is a translation from the XML Schema tag to a directory that
796 corresponds to our directory name coding convention.
799 private String
archDir(String arch
) {
800 return arch
.replaceFirst("X64", "x64")
801 .replaceFirst("IPF", "Ipf")
802 .replaceFirst("IA32", "Ia32")
803 .replaceFirst("ARM", "Arm")
804 .replaceFirst("EBC", "Ebc");
808 public void setExternalProperties(Vector
<Property
> v
) {