Fixed EDKT102;
[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / FrameworkBuildTask.java
CommitLineData
de4bb9f6 1/** @file FrameworkBuildTask.java\r
2 \r
3 The file is ANT task to find MSA or FPD file and build them. \r
4 \r
5 Copyright (c) 2006, Intel Corporation\r
6 All rights reserved. This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13 **/\r
a29c47e0 14package org.tianocore.build;\r
15\r
16import java.io.BufferedReader;\r
17import java.io.File;\r
18import java.io.InputStreamReader;\r
19import java.util.Iterator;\r
20import java.util.LinkedHashSet;\r
21import java.util.Map;\r
22import java.util.Set;\r
23\r
24import org.apache.tools.ant.BuildException;\r
25import org.apache.tools.ant.Task;\r
26import org.tianocore.build.fpd.FpdParserTask;\r
27import org.tianocore.build.global.GlobalData;\r
de4bb9f6 28import org.tianocore.build.toolchain.ConfigReader;\r
a29c47e0 29import org.tianocore.build.toolchain.ToolChainInfo;\r
30\r
31public class FrameworkBuildTask extends Task{\r
32\r
33 private Set<File> buildFiles = new LinkedHashSet<File>();\r
34 \r
35 private Set<File> fpdFiles = new LinkedHashSet<File>();\r
36 \r
37 private Set<File> msaFiles = new LinkedHashSet<File>();\r
38 \r
de4bb9f6 39 String toolsDefFilename = "Tools" + File.separatorChar + "Conf" + File.separatorChar + "tools_def.txt";\r
40 \r
41 String targetFilename = "target.txt";\r
42 \r
43 String activePlatform = null;\r
44 \r
a29c47e0 45 ///\r
46 /// there are three type: all (build), clean and cleanall\r
47 ///\r
48 private String type = "all";\r
49 \r
50 public void execute() throws BuildException {\r
51 //\r
52 // Seach build.xml -> .FPD -> .MSA file\r
53 //\r
54 try {\r
55 //\r
56 // Gen Current Working Directory\r
57 //\r
58 File dummyFile = new File(".");\r
59 File cwd = dummyFile.getCanonicalFile();\r
60 File[] files = cwd.listFiles();\r
61 for (int i = 0; i < files.length; i++) {\r
62 if (files[i].isFile()) {\r
63 if (files[i].getName().equalsIgnoreCase("build.xml")) {\r
64 //\r
65 // First, search build.xml, if found, ANT call it\r
66 //\r
67 buildFiles.add(files[i]);\r
68\r
69 } else if (files[i].getName().endsWith(".fpd")) {\r
70 //\r
71 // Second, search FPD file, if found, build it\r
72 //\r
73 fpdFiles.add(files[i]);\r
74 } else if (files[i].getName().endsWith(".msa")) {\r
75 //\r
76 // Third, search MSA file, if found, build it\r
77 //\r
78 msaFiles.add(files[i]);\r
79 }\r
80 }\r
81 }\r
82 } catch (Exception e) {\r
a29c47e0 83 throw new BuildException(e.getMessage());\r
84 }\r
85 \r
a29c47e0 86 //\r
87 // Deal with all environment variable (Add them to properties)\r
88 //\r
89 backupSystemProperties();\r
90 \r
91 //\r
de4bb9f6 92 // Read target.txt file\r
a29c47e0 93 //\r
de4bb9f6 94 readTargetFile();\r
95\r
a29c47e0 96 //\r
97 // Global Data initialization\r
98 //\r
a29c47e0 99 GlobalData.initInfo("Tools" + File.separatorChar + "Conf" + File.separatorChar + "FrameworkDatabase.db",\r
100 getProject().getProperty("WORKSPACE_DIR"), toolsDefFilename);\r
101 \r
de4bb9f6 102\r
103 \r
104 //\r
105 // If find MSA file and ACTIVE_PLATFORM is set, build the module; \r
106 // else fail build. \r
107 // If without MSA file, and ACTIVE_PLATFORM is set, build the ACTIVE_PLATFORM. \r
108 // If ACTIVE_PLATFORM is not set, and only find one FPD file, build the platform; \r
109 // If find more than one FPD files, let user select one. \r
110 //\r
111 File buildFile = null;\r
112 if (msaFiles.size() > 1) {\r
113 throw new BuildException("More than one MSA file under current directory. It is not allowd. ");\r
114 }\r
115 else if (msaFiles.size() == 1 && activePlatform == null) {\r
116 throw new BuildException("If try to build a single module, please set ACTIVE_PLATFORM in file [Tool/Conf/target.txt]. ");\r
117 }\r
118 else if (msaFiles.size() == 1 && activePlatform != null) {\r
119 //\r
120 // Build the single module\r
121 //\r
122 buildFile = msaFiles.toArray(new File[1])[0];\r
123 }\r
124 else if (activePlatform != null) {\r
125 buildFile = new File(GlobalData.getWorkspacePath() + File.separatorChar + activePlatform);\r
126 }\r
127 else if (fpdFiles.size() == 1) {\r
128 buildFile = fpdFiles.toArray(new File[1])[0];\r
129 }\r
130 else if (fpdFiles.size() > 1) {\r
131 buildFile = intercommuniteWithUser();\r
132 }\r
133 //\r
134 // If there is no build files or FPD files or MSA files, stop build\r
135 //\r
136 else {\r
137 throw new BuildException("Can't find any FPD files or MSA files in current directory. ");\r
138 }\r
139\r
a29c47e0 140 //\r
141 // Build every FPD files (PLATFORM build)\r
142 //\r
143 if (buildFile.getName().endsWith(".fpd")) {\r
de4bb9f6 144 System.out.println("Start to build FPD file [" + buildFile.getPath() + "] ..>> ");\r
a29c47e0 145 FpdParserTask fpdParserTask = new FpdParserTask();\r
146 fpdParserTask.setType(type);\r
147 fpdParserTask.setProject(getProject());\r
148 fpdParserTask.setFpdFile(buildFile);\r
149 fpdParserTask.execute();\r
150 }\r
151 \r
152 //\r
153 // Build every MSA files (SINGLE MODULE BUILD)\r
154 //\r
155 else if (buildFile.getName().endsWith(".msa")) {\r
de4bb9f6 156 System.out.println("Start to build MSA file [" + buildFile.getPath() + "] ..>> ");\r
a29c47e0 157 GenBuildTask genBuildTask = new GenBuildTask();\r
de4bb9f6 158 genBuildTask.setSingleModuleBuild(true);\r
a29c47e0 159 genBuildTask.setType(type);\r
de4bb9f6 160 getProject().setProperty("PLATFORM_FILE", activePlatform);\r
a29c47e0 161 genBuildTask.setProject(getProject());\r
162 genBuildTask.setMsaFile(buildFile);\r
163 genBuildTask.execute();\r
164 }\r
165 }\r
166 \r
167 /**\r
168 Transfer system environment variables to ANT properties. If system variable \r
169 already exiests in ANT properties, skip it.\r
170 \r
171 **/\r
172 private void backupSystemProperties() {\r
173 Map<String, String> sysProperties = System.getenv();\r
174 Set<String> keys = sysProperties.keySet();\r
175 Iterator<String> iter = keys.iterator();\r
176 while (iter.hasNext()) {\r
177 String name = iter.next();\r
178 \r
179 //\r
180 // If system environment variable is not in ANT properties, add it\r
181 //\r
182 if (getProject().getProperty(name) == null) {\r
183 getProject().setProperty(name, sysProperties.get(name));\r
184 }\r
185 }\r
186 }\r
187\r
188 private File intercommuniteWithUser(){\r
189 File file = null;\r
190 if (fpdFiles.size() + msaFiles.size() > 1) {\r
191 File[] allFiles = new File[fpdFiles.size() + msaFiles.size()];\r
192 int index = 0;\r
193 Iterator<File> iter = fpdFiles.iterator();\r
194 while (iter.hasNext()) {\r
195 allFiles[index] = iter.next();\r
196 index++;\r
197 }\r
198 iter = msaFiles.iterator();\r
199 while (iter.hasNext()) {\r
200 allFiles[index] = iter.next();\r
201 index++;\r
202 }\r
203 System.out.println("Find " + allFiles.length + " FPD and MSA files: ");\r
204 for (int i = 0; i < allFiles.length; i++) {\r
205 System.out.println("[" + (i + 1) + "]: " + allFiles[i].getName());\r
206 }\r
207 \r
208 boolean flag = true;\r
209 System.out.print("Please select one file to build:[1] ");\r
210 do{\r
211 BufferedReader br = new BufferedReader(new InputStreamReader(System.in));\r
212 try {\r
213 String str = br.readLine();\r
214 if (str.trim().length() == 0) {\r
215 file = allFiles[0];\r
216 flag = false;\r
217 continue ;\r
218 }\r
219 int indexSelect = Integer.parseInt(str);\r
220 if (indexSelect <=0 || indexSelect > allFiles.length) {\r
221 System.out.print("Please enter a number between [1.." + allFiles.length + "]:[1] ");\r
222 continue ;\r
223 } else {\r
224 file = allFiles[indexSelect - 1];\r
225 flag = false;\r
226 continue ;\r
227 }\r
228 } catch (Exception e) {\r
229 System.out.print("Please enter a valid number:[1] ");\r
230 flag = true;\r
231 }\r
232 } while (flag);\r
233 }\r
234 else if (fpdFiles.size() == 1) {\r
235 file = fpdFiles.toArray(new File[1])[0];\r
236 }\r
237 else if (msaFiles.size() == 1) {\r
238 file = msaFiles.toArray(new File[1])[0];\r
239 }\r
240 return file;\r
241 }\r
242 \r
243 \r
244 public void setType(String type) {\r
245 if (type.equalsIgnoreCase("clean") || type.equalsIgnoreCase("cleanall")) {\r
246 this.type = type.toLowerCase();\r
247 }\r
248 else {\r
249 this.type = "all";\r
250 }\r
251 }\r
de4bb9f6 252 \r
253 private void readTargetFile(){\r
254 try {\r
255 String[][] targetFileInfo = ConfigReader.parse(getProject().getProperty("WORKSPACE_DIR"), "Tools" + File.separatorChar + "Conf" + File.separatorChar + targetFilename);\r
256 \r
257 //\r
258 // Get ToolChain Info from target.txt\r
259 //\r
260 ToolChainInfo envToolChainInfo = new ToolChainInfo(); \r
261 String str = getValue("TARGET", targetFileInfo);\r
262 if (str == null || str.trim().equals("")) {\r
263 envToolChainInfo.addTargets("*");\r
264 }\r
265 else {\r
266 envToolChainInfo.addTargets(str);\r
267 }\r
c773bec0 268 str = getValue("TOOL_CHAIN_TAG", targetFileInfo);\r
de4bb9f6 269 if (str == null || str.trim().equals("")) {\r
270 envToolChainInfo.addTagnames("*");\r
271 }\r
272 else {\r
273 envToolChainInfo.addTagnames(str);\r
274 }\r
275 str = getValue("TARGET_ARCH", targetFileInfo);\r
276 if (str == null || str.trim().equals("")) {\r
277 envToolChainInfo.addArchs("*");\r
278 }\r
279 else {\r
280 envToolChainInfo.addArchs(str);\r
281 }\r
282 GlobalData.setToolChainEnvInfo(envToolChainInfo);\r
283 \r
c773bec0 284 str = getValue("TOOL_CHAIN_CONF", targetFileInfo);\r
196ad8d7 285 if (str != null && str.trim().length() > 0) {\r
de4bb9f6 286 toolsDefFilename = str;\r
287 }\r
288 \r
289 str = getValue("ACTIVE_PLATFORM", targetFileInfo);\r
290 if (str != null && ! str.trim().equals("")) {\r
291 if ( ! str.endsWith(".fpd")) {\r
292 throw new BuildException("FPD file's file extension must be \".fpd\"");\r
293 }\r
294 activePlatform = str;\r
295 }\r
296 }\r
297 catch (Exception ex) {\r
298 throw new BuildException(ex.getMessage());\r
299 }\r
300 }\r
301 \r
302 private String getValue(String key, String[][] map) {\r
303 for (int i = 0; i < map[0].length; i++){\r
304 if (key.equalsIgnoreCase(map[0][i])) {\r
305 return map[1][i];\r
306 }\r
307 }\r
308 return null;\r
309 }\r
a29c47e0 310}\r