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
) {
84 throw new BuildException(e
.getMessage());
88 // Deal with all environment variable (Add them to properties)
90 backupSystemProperties();
93 // Read target.txt file
98 // Global Data initialization
100 GlobalData
.initInfo("Tools" + File
.separatorChar
+ "Conf" + File
.separatorChar
+ "FrameworkDatabase.db",
101 getProject().getProperty("WORKSPACE_DIR"), toolsDefFilename
);
106 // If find MSA file and ACTIVE_PLATFORM is set, build the module;
108 // If without MSA file, and ACTIVE_PLATFORM is set, build the ACTIVE_PLATFORM.
109 // If ACTIVE_PLATFORM is not set, and only find one FPD file, build the platform;
110 // If find more than one FPD files, let user select one.
112 File buildFile
= null;
113 if (msaFiles
.size() > 1) {
114 throw new BuildException("More than one MSA file under current directory. It is not allowd. ");
116 else if (msaFiles
.size() == 1 && activePlatform
== null) {
117 throw new BuildException("If try to build a single module, please set ACTIVE_PLATFORM in file [Tool/Conf/target.txt]. ");
119 else if (msaFiles
.size() == 1 && activePlatform
!= null) {
121 // Build the single module
123 buildFile
= msaFiles
.toArray(new File
[1])[0];
125 else if (activePlatform
!= null) {
126 buildFile
= new File(GlobalData
.getWorkspacePath() + File
.separatorChar
+ activePlatform
);
128 else if (fpdFiles
.size() == 1) {
129 buildFile
= fpdFiles
.toArray(new File
[1])[0];
131 else if (fpdFiles
.size() > 1) {
132 buildFile
= intercommuniteWithUser();
135 // If there is no build files or FPD files or MSA files, stop build
138 throw new BuildException("Can't find any FPD files or MSA files in current directory. ");
142 // Build every FPD files (PLATFORM build)
144 if (buildFile
.getName().endsWith(".fpd")) {
145 System
.out
.println("Start to build FPD file [" + buildFile
.getPath() + "] ..>> ");
146 FpdParserTask fpdParserTask
= new FpdParserTask();
147 fpdParserTask
.setType(type
);
148 fpdParserTask
.setProject(getProject());
149 fpdParserTask
.setFpdFile(buildFile
);
150 fpdParserTask
.execute();
154 // Build every MSA files (SINGLE MODULE BUILD)
156 else if (buildFile
.getName().endsWith(".msa")) {
157 System
.out
.println("Start to build MSA file [" + buildFile
.getPath() + "] ..>> ");
158 GenBuildTask genBuildTask
= new GenBuildTask();
159 genBuildTask
.setSingleModuleBuild(true);
160 genBuildTask
.setType(type
);
161 getProject().setProperty("PLATFORM_FILE", activePlatform
);
162 genBuildTask
.setProject(getProject());
163 genBuildTask
.setMsaFile(buildFile
);
164 genBuildTask
.execute();
169 Transfer system environment variables to ANT properties. If system variable
170 already exiests in ANT properties, skip it.
173 private void backupSystemProperties() {
174 Map
<String
, String
> sysProperties
= System
.getenv();
175 Set
<String
> keys
= sysProperties
.keySet();
176 Iterator
<String
> iter
= keys
.iterator();
177 while (iter
.hasNext()) {
178 String name
= iter
.next();
181 // If system environment variable is not in ANT properties, add it
183 if (getProject().getProperty(name
) == null) {
184 getProject().setProperty(name
, sysProperties
.get(name
));
189 private File
intercommuniteWithUser(){
191 if (fpdFiles
.size() + msaFiles
.size() > 1) {
192 File
[] allFiles
= new File
[fpdFiles
.size() + msaFiles
.size()];
194 Iterator
<File
> iter
= fpdFiles
.iterator();
195 while (iter
.hasNext()) {
196 allFiles
[index
] = iter
.next();
199 iter
= msaFiles
.iterator();
200 while (iter
.hasNext()) {
201 allFiles
[index
] = iter
.next();
204 System
.out
.println("Find " + allFiles
.length
+ " FPD and MSA files: ");
205 for (int i
= 0; i
< allFiles
.length
; i
++) {
206 System
.out
.println("[" + (i
+ 1) + "]: " + allFiles
[i
].getName());
210 System
.out
.print("Please select one file to build:[1] ");
212 BufferedReader br
= new BufferedReader(new InputStreamReader(System
.in
));
214 String str
= br
.readLine();
215 if (str
.trim().length() == 0) {
220 int indexSelect
= Integer
.parseInt(str
);
221 if (indexSelect
<=0 || indexSelect
> allFiles
.length
) {
222 System
.out
.print("Please enter a number between [1.." + allFiles
.length
+ "]:[1] ");
225 file
= allFiles
[indexSelect
- 1];
229 } catch (Exception e
) {
230 System
.out
.print("Please enter a valid number:[1] ");
235 else if (fpdFiles
.size() == 1) {
236 file
= fpdFiles
.toArray(new File
[1])[0];
238 else if (msaFiles
.size() == 1) {
239 file
= msaFiles
.toArray(new File
[1])[0];
245 public void setType(String type
) {
246 if (type
.equalsIgnoreCase("clean") || type
.equalsIgnoreCase("cleanall")) {
247 this.type
= type
.toLowerCase();
254 private void readTargetFile(){
256 String
[][] targetFileInfo
= ConfigReader
.parse(getProject().getProperty("WORKSPACE_DIR"), "Tools" + File
.separatorChar
+ "Conf" + File
.separatorChar
+ targetFilename
);
259 // Get ToolChain Info from target.txt
261 ToolChainInfo envToolChainInfo
= new ToolChainInfo();
262 String str
= getValue("TARGET", targetFileInfo
);
263 if (str
== null || str
.trim().equals("")) {
264 envToolChainInfo
.addTargets("*");
267 envToolChainInfo
.addTargets(str
);
269 str
= getValue("TOOL_CHAIN_TAG", targetFileInfo
);
270 if (str
== null || str
.trim().equals("")) {
271 envToolChainInfo
.addTagnames("*");
274 envToolChainInfo
.addTagnames(str
);
276 str
= getValue("TARGET_ARCH", targetFileInfo
);
277 if (str
== null || str
.trim().equals("")) {
278 envToolChainInfo
.addArchs("*");
281 envToolChainInfo
.addArchs(str
);
283 GlobalData
.setToolChainEnvInfo(envToolChainInfo
);
285 str
= getValue("TOOL_CHAIN_CONF", targetFileInfo
);
287 toolsDefFilename
= str
;
290 str
= getValue("ACTIVE_PLATFORM", targetFileInfo
);
291 if (str
!= null && ! str
.trim().equals("")) {
292 if ( ! str
.endsWith(".fpd")) {
293 throw new BuildException("FPD file's file extension must be \".fpd\"");
295 activePlatform
= str
;
298 catch (Exception ex
) {
299 throw new BuildException(ex
.getMessage());
303 private String
getValue(String key
, String
[][] map
) {
304 for (int i
= 0; i
< map
[0].length
; i
++){
305 if (key
.equalsIgnoreCase(map
[0][i
])) {