1 /** @file FrameworkBuildTask.java
3 The file is ANT task to find MSA or FPD file and build them.
5 Copyright (c) 2006, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 package org
.tianocore
.build
;
16 import java
.io
.BufferedReader
;
18 import java
.io
.InputStreamReader
;
19 import java
.util
.Iterator
;
20 import java
.util
.LinkedHashSet
;
24 import org
.apache
.tools
.ant
.BuildException
;
25 import org
.apache
.tools
.ant
.Task
;
26 import org
.tianocore
.build
.fpd
.FpdParserTask
;
27 import org
.tianocore
.build
.global
.GlobalData
;
28 import org
.tianocore
.build
.toolchain
.ConfigReader
;
29 import org
.tianocore
.build
.toolchain
.ToolChainInfo
;
31 public class FrameworkBuildTask
extends Task
{
33 private Set
<File
> buildFiles
= new LinkedHashSet
<File
>();
35 private Set
<File
> fpdFiles
= new LinkedHashSet
<File
>();
37 private Set
<File
> msaFiles
= new LinkedHashSet
<File
>();
39 String toolsDefFilename
= "Tools" + File
.separatorChar
+ "Conf" + File
.separatorChar
+ "tools_def.txt";
41 String targetFilename
= "target.txt";
43 String activePlatform
= null;
46 /// there are three type: all (build), clean and cleanall
48 private String type
= "all";
50 public void execute() throws BuildException
{
52 // Seach build.xml -> .FPD -> .MSA file
56 // Gen Current Working Directory
58 File dummyFile
= new File(".");
59 File cwd
= dummyFile
.getCanonicalFile();
60 File
[] files
= cwd
.listFiles();
61 for (int i
= 0; i
< files
.length
; i
++) {
62 if (files
[i
].isFile()) {
63 if (files
[i
].getName().equalsIgnoreCase("build.xml")) {
65 // First, search build.xml, if found, ANT call it
67 buildFiles
.add(files
[i
]);
69 } else if (files
[i
].getName().endsWith(".fpd")) {
71 // Second, search FPD file, if found, build it
73 fpdFiles
.add(files
[i
]);
74 } else if (files
[i
].getName().endsWith(".msa")) {
76 // Third, search MSA file, if found, build it
78 msaFiles
.add(files
[i
]);
82 } catch (Exception e
) {
83 throw new BuildException(e
.getMessage());
87 // Deal with all environment variable (Add them to properties)
89 backupSystemProperties();
92 // Read target.txt file
97 // Global Data initialization
99 File workspacePath
= new File(getProject().getProperty("WORKSPACE"));
100 getProject().setProperty("WORKSPACE_DIR", workspacePath
.getPath().replaceAll("(\\\\)", "/"));
101 GlobalData
.initInfo("Tools" + File
.separatorChar
+ "Conf" + File
.separatorChar
+ "FrameworkDatabase.db",
102 workspacePath
.getPath(), toolsDefFilename
);
107 // If find MSA file and ACTIVE_PLATFORM is set, build the module;
109 // If without MSA file, and ACTIVE_PLATFORM is set, build the ACTIVE_PLATFORM.
110 // If ACTIVE_PLATFORM is not set, and only find one FPD file, build the platform;
111 // If find more than one FPD files, let user select one.
113 File buildFile
= null;
114 if (msaFiles
.size() > 1) {
115 throw new BuildException("More than one MSA file under current directory. It is not allowd. ");
117 else if (msaFiles
.size() == 1 && activePlatform
== null) {
118 throw new BuildException("If try to build a single module, please set ACTIVE_PLATFORM in file [Tool/Conf/target.txt]. ");
120 else if (msaFiles
.size() == 1 && activePlatform
!= null) {
122 // Build the single module
124 buildFile
= msaFiles
.toArray(new File
[1])[0];
126 else if (activePlatform
!= null) {
127 buildFile
= new File(GlobalData
.getWorkspacePath() + File
.separatorChar
+ activePlatform
);
129 else if (fpdFiles
.size() == 1) {
130 buildFile
= fpdFiles
.toArray(new File
[1])[0];
132 else if (fpdFiles
.size() > 1) {
133 buildFile
= intercommuniteWithUser();
136 // If there is no build files or FPD files or MSA files, stop build
139 throw new BuildException("Can't find any FPD files or MSA files in current directory. ");
143 // Build every FPD files (PLATFORM build)
145 if (buildFile
.getName().endsWith(".fpd")) {
146 System
.out
.println("Start to build FPD file [" + buildFile
.getPath() + "] ..>> ");
147 FpdParserTask fpdParserTask
= new FpdParserTask();
148 fpdParserTask
.setType(type
);
149 fpdParserTask
.setProject(getProject());
150 fpdParserTask
.setFpdFile(buildFile
);
151 fpdParserTask
.execute();
155 // Build every MSA files (SINGLE MODULE BUILD)
157 else if (buildFile
.getName().endsWith(".msa")) {
158 File tmpFile
= new File(GlobalData
.getWorkspacePath() + File
.separatorChar
+ activePlatform
);
159 System
.out
.println("Using FPD file [" + tmpFile
.getPath() + "] as active platform. ");
160 System
.out
.println("Start to build MSA file [" + buildFile
.getPath() + "] ..>> ");
161 GenBuildTask genBuildTask
= new GenBuildTask();
162 genBuildTask
.setSingleModuleBuild(true);
163 genBuildTask
.setType(type
);
164 getProject().setProperty("PLATFORM_FILE", activePlatform
);
165 genBuildTask
.setProject(getProject());
166 genBuildTask
.setMsaFile(buildFile
);
167 genBuildTask
.execute();
172 Transfer system environment variables to ANT properties. If system variable
173 already exiests in ANT properties, skip it.
176 private void backupSystemProperties() {
177 Map
<String
, String
> sysProperties
= System
.getenv();
178 Set
<String
> keys
= sysProperties
.keySet();
179 Iterator
<String
> iter
= keys
.iterator();
180 while (iter
.hasNext()) {
181 String name
= iter
.next();
184 // If system environment variable is not in ANT properties, add it
186 if (getProject().getProperty(name
) == null) {
187 getProject().setProperty(name
, sysProperties
.get(name
));
192 private File
intercommuniteWithUser(){
194 if (fpdFiles
.size() + msaFiles
.size() > 1) {
195 File
[] allFiles
= new File
[fpdFiles
.size() + msaFiles
.size()];
197 Iterator
<File
> iter
= fpdFiles
.iterator();
198 while (iter
.hasNext()) {
199 allFiles
[index
] = iter
.next();
202 iter
= msaFiles
.iterator();
203 while (iter
.hasNext()) {
204 allFiles
[index
] = iter
.next();
207 System
.out
.println("Find " + allFiles
.length
+ " FPD and MSA files: ");
208 for (int i
= 0; i
< allFiles
.length
; i
++) {
209 System
.out
.println("[" + (i
+ 1) + "]: " + allFiles
[i
].getName());
213 System
.out
.print("Please select one file to build:[1] ");
215 BufferedReader br
= new BufferedReader(new InputStreamReader(System
.in
));
217 String str
= br
.readLine();
218 if (str
.trim().length() == 0) {
223 int indexSelect
= Integer
.parseInt(str
);
224 if (indexSelect
<=0 || indexSelect
> allFiles
.length
) {
225 System
.out
.print("Please enter a number between [1.." + allFiles
.length
+ "]:[1] ");
228 file
= allFiles
[indexSelect
- 1];
232 } catch (Exception e
) {
233 System
.out
.print("Please enter a valid number:[1] ");
238 else if (fpdFiles
.size() == 1) {
239 file
= fpdFiles
.toArray(new File
[1])[0];
241 else if (msaFiles
.size() == 1) {
242 file
= msaFiles
.toArray(new File
[1])[0];
248 public void setType(String type
) {
249 if (type
.equalsIgnoreCase("clean") || type
.equalsIgnoreCase("cleanall")) {
250 this.type
= type
.toLowerCase();
257 private void readTargetFile(){
259 String targetFile
= getProject().getProperty("WORKSPACE_DIR") + File
.separatorChar
260 + "Tools" + File
.separatorChar
+ "Conf" + File
.separatorChar
+ targetFilename
;
261 String
[][] targetFileInfo
= ConfigReader
.parse(targetFile
);
264 // Get ToolChain Info from target.txt
266 ToolChainInfo envToolChainInfo
= new ToolChainInfo();
267 String str
= getValue("TARGET", targetFileInfo
);
268 if (str
== null || str
.trim().equals("")) {
269 envToolChainInfo
.addTargets("*");
272 envToolChainInfo
.addTargets(str
);
274 str
= getValue("TOOL_CHAIN_TAG", targetFileInfo
);
275 if (str
== null || str
.trim().equals("")) {
276 envToolChainInfo
.addTagnames("*");
279 envToolChainInfo
.addTagnames(str
);
281 str
= getValue("TARGET_ARCH", targetFileInfo
);
282 if (str
== null || str
.trim().equals("")) {
283 envToolChainInfo
.addArchs("*");
286 envToolChainInfo
.addArchs(str
);
288 GlobalData
.setToolChainEnvInfo(envToolChainInfo
);
290 str
= getValue("TOOL_CHAIN_CONF", targetFileInfo
);
291 if (str
!= null && str
.trim().length() > 0) {
292 toolsDefFilename
= str
;
295 str
= getValue("ACTIVE_PLATFORM", targetFileInfo
);
296 if (str
!= null && ! str
.trim().equals("")) {
297 if ( ! str
.endsWith(".fpd")) {
298 throw new BuildException("FPD file's file extension must be \".fpd\"");
300 activePlatform
= str
;
303 catch (Exception ex
) {
304 throw new BuildException(ex
.getMessage());
308 private String
getValue(String key
, String
[][] map
) {
309 for (int i
= 0; i
< map
[0].length
; i
++){
310 if (key
.equalsIgnoreCase(map
[0][i
])) {