]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/GenBuild/org/tianocore/build/autogen/CommonDefinition.java
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Fix the IDE slave device missing bug.
[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / autogen / CommonDefinition.java
CommitLineData
878ddf1f 1/** @file\r
2 CommonDefinition class.\r
3\r
4 This class is to define some common marcos and funcions, which used by AutoGen.\r
5 \r
6 Copyright (c) 2006, Intel Corporation\r
7 All rights reserved. This program and the accompanying materials\r
8 are licensed and made available under the terms and conditions of the BSD License\r
9 which accompanies this distribution. The full text of the license may be found at\r
10 http://opensource.org/licenses/bsd-license.php\r
11 \r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15 **/\r
16package org.tianocore.build.autogen;\r
17\r
136adffc 18import java.util.Iterator;\r
58c5839f 19import java.util.LinkedHashSet;\r
136adffc 20import java.util.Set;\r
21\r
878ddf1f 22/**\r
23 CommonDefinition\r
24 \r
25 This class is to define some common marcos, which used by AutoGen.\r
26 \r
27**/\r
28public class CommonDefinition {\r
29 public final static String spdSuffix = ".spd";\r
30 public final static String mbdSuffix = ".mbd";\r
31 public final static String msaSuffix = ".msa";\r
32 public final static String LibraryStr = "LIBRARY";\r
33 public final static String autoGenHbegin = "extern int __make_me_compile_correctly;\r\n";\r
34 public final static String include = "#include";\r
35 public final static String autoGenCLine1 = "\r\n";\r
5f907e4a 36\r
878ddf1f 37 public final static String autoGenCLine2 = "const UINT8 _gDebugPropertyMask "\r
5f907e4a 38 + "= DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED"\r
39 + " | DEBUG_PROPERTY_DEBUG_PRINT_ENABLED"\r
40 + " | DEBUG_PROPERTY_DEBUG_CODE_ENABLED;\r\n";\r
878ddf1f 41\r
42 public final static String autoGenCLine3 = "const UINTN _gModuleDefaultErrorLevel"\r
5f907e4a 43 + " = EFI_D_ERROR | EFI_D_LOAD;\r\n";\r
44\r
878ddf1f 45 public final static String autoGenHLine1 = "#define EFI_SPECIFICATION_VERSION 0x00020000\r\n";\r
46 public final static String autoGenHVersionDefault = "#define EFI_SPECIFICATION_VERSION 0x00000000\r\n";\r
47 public final static String autoGenHLine2 = "#define EDK_RELEASE_VERSION 0x00090000\r\n";\r
48 public final static String autoGenHReleaseDefault = "#define EDK_RELEASE_VERSION 0x00000000\r\n";\r
49\r
50 public final static String includeAutogenH = "#include <AutoGen.h>\r\n" ;\r
a29c47e0 51 public final static String marcDefineStr = "#define ";\r
878ddf1f 52\r
53 public final static String gEfi = "gEfi";\r
54 public final static String protocolGuid = "ProtocolGuid";\r
55 public final static String ppiGuid = "PpiGuid";\r
56 public final static String guidGuid = "Guid";\r
73b4e31a 57\r
5f907e4a 58 public final static String tianoR8FlashMapH = "TianoR8FlashMap.h";\r
59 public final static String flashMapH = "FlashMap.h";\r
60\r
61 //\r
62 // The defintions for identifying current module\r
63 // is PEI Pcd driver or Dxe Pcd driver.\r
64 // \r
65 public static enum PCD_DRIVER_TYPE { NOT_PCD_DRIVER,\r
66 PEI_PCD_DRIVER, \r
67 DXE_PCD_DRIVER,\r
68 UNKNOWN_PCD_DRIVER};\r
69\r
878ddf1f 70 //\r
71 // AutoGen.h and AutoGen.c file's header\r
72 //\r
73 public final static String autogenHNotation = \r
5f907e4a 74 "/**\r\n" +\r
75 " DO NOT EDIT\r\n" +\r
76 " FILE auto-generated by GenBuild tasks\r\n" +\r
77 " Module name:\r\n" +\r
78 " AutoGen.h\r\n" +\r
79 " Abstract:" +\r
80 " Auto-generated AutoGen.h for building module or library.\r\n" +\r
81 "**/\r\n\r\n";\r
82\r
878ddf1f 83 public final static String autogenCNotation = \r
5f907e4a 84 "/**\r\n" +\r
85 " DO NOT EDIT\r\n" +\r
86 " FILE auto-generated by GenBuild tasks\r\n" +\r
87 " Module name:\r\n" +\r
88 " AutoGen.c\r\n" +\r
89 " Abstract:" +\r
90 " Auto-generated AutoGen.c for building module or library.\r\n" +\r
91 "**/\r\n\r\n";\r
92\r
878ddf1f 93 //\r
94 // module type\r
95 //\r
96 public final static int ModuleTypeBase = 0;\r
97 public final static int ModuleTypeSec = 1;\r
98 public final static int ModuleTypePeiCore = 2;\r
99 public final static int ModuleTypePeim = 3;\r
100 public final static int ModuleTypeDxeCore = 4;\r
101 public final static int ModuleTypeDxeDriver = 5;\r
102 public final static int ModuleTypeDxeRuntimeDriver = 6;\r
103 public final static int ModuleTypeDxeSmmDriver = 7;\r
104 public final static int ModuleTypeDxeSalDriver = 8;\r
105 public final static int ModuleTypeUefiDriver = 9;\r
106 public final static int ModuleTypeUefiApplication = 10;\r
107 public final static int ModuleTypeUnknown = 11;\r
5f907e4a 108\r
109\r
878ddf1f 110 //\r
111 // component type\r
112 // \r
113 public final static int ComponentTypeNull = 0;\r
114 public final static int ComponentTypeApriori = 1;\r
115 public final static int ComponentTypeSec = 2;\r
116 public final static int ComponentTypeLibrary = 3;\r
117 public final static int ComponentTypeFvImageFile = 4;\r
118 public final static int ComponentTypeBsDriver = 5;\r
119 public final static int ComponentTypeRtDriver = 6;\r
120 public final static int ComponentTypeSalRtDriver =7;\r
121 public final static int ComponentTypePe32Peim = 8;\r
122 public final static int ComponentTypePicPeim =9;\r
123 public final static int ComponentTypeCombinedPeimDriver =10;\r
124 public final static int ComponentTypePeiCore = 11;\r
125 public final static int ComponentTypeDxeCore = 12;\r
126 public final static int ComponentTypeApplication = 13;\r
127 public final static int ComponentTypeBsDriverEfi = 14;\r
128 public final static int ComponentTypeShellApp = 15;\r
129 public final static int ComponentTypeBinary =16;\r
130 public final static int ComponentTypeLogo = 17;\r
131 public final static int ComponentTypeCustomBuild = 18;\r
132 public final static int ComponentTypeUnknown = 19;\r
133\r
5f907e4a 134\r
878ddf1f 135 //\r
136 // Usaged style\r
137 //\r
138 public final static String AlwaysConsumed = "ALWAYS_CONSUMED";\r
139 public final static String AlwaysProduced = "ALWAYS_PRODUCED";\r
5f907e4a 140\r
878ddf1f 141\r
142 public static class MyEnum {\r
143 String moduleTypeStr;\r
144 int type;\r
145\r
146 MyEnum (String str, int type) {\r
147 this.type = type;\r
148 this.moduleTypeStr = str;\r
149 }\r
150\r
151 int ForInt(String str) {\r
152 if (str.equals(this.moduleTypeStr)) {\r
153 return this.type;\r
154 } else\r
155 return -1;\r
156 }\r
157 }\r
5f907e4a 158\r
878ddf1f 159 //\r
160 // Module type\r
161 //\r
162 public static final MyEnum[] moduleEnum = new MyEnum[] {\r
5f907e4a 163 new MyEnum("BASE", ModuleTypeBase),\r
164 new MyEnum("SEC", ModuleTypeSec),\r
165 new MyEnum("PEI_CORE", ModuleTypePeiCore),\r
166 new MyEnum("PEIM", ModuleTypePeim),\r
167 new MyEnum("DXE_CORE", ModuleTypeDxeCore),\r
168 new MyEnum("DXE_DRIVER", ModuleTypeDxeDriver),\r
169 new MyEnum("DXE_RUNTIME_DRIVER", ModuleTypeDxeRuntimeDriver),\r
170 new MyEnum("DXE_SAL_DRIVER", ModuleTypeDxeSalDriver),\r
171 new MyEnum("DXE_SMM_DRIVER", ModuleTypeDxeSmmDriver),\r
172 new MyEnum("UEFI_DRIVER", ModuleTypeUefiDriver),\r
173 new MyEnum("UEFI_APPLICATION", ModuleTypeUefiApplication)};\r
174\r
878ddf1f 175 //\r
176 // Component type\r
177 //\r
178 public static final MyEnum[] componentEnum = new MyEnum[]{\r
5f907e4a 179 new MyEnum("APRIORI", ComponentTypeApriori),\r
180 new MyEnum("SEC", ComponentTypeSec),\r
181 new MyEnum("LIBRARY", ComponentTypeLibrary),\r
182 new MyEnum("FV_IMAGE_FILE", ComponentTypeFvImageFile),\r
183 new MyEnum("BS_DRIVER", ComponentTypeBsDriver),\r
184 new MyEnum("RT_DRIVER", ComponentTypeRtDriver),\r
185 new MyEnum("SAL_RT_DRIVER", ComponentTypeSalRtDriver),\r
186 new MyEnum("PE32_PEIM", ComponentTypePe32Peim),\r
187 new MyEnum("PIC_PEIM", ComponentTypePicPeim),\r
188 new MyEnum("COMBINED_PEIM_DRIVER", ComponentTypeCombinedPeimDriver),\r
189 new MyEnum("PEI_CORE", ComponentTypePeiCore),\r
190 new MyEnum("DXE_CORE", ComponentTypeDxeCore),\r
191 new MyEnum("APPLICATION", ComponentTypeApplication),\r
192 new MyEnum("BS_DRIVER_EFI", ComponentTypeBsDriverEfi),\r
193 new MyEnum("SHELLAPP", ComponentTypeShellApp),\r
194 new MyEnum("BINARY", ComponentTypeBinary),\r
195 new MyEnum("LOGO", ComponentTypeLogo),\r
196 new MyEnum("CUSTOM_BUILD", ComponentTypeCustomBuild)\r
197 };\r
198\r
878ddf1f 199 /**\r
200 getModuleType\r
201 \r
202 This function get the module type value according module type string.\r
203 \r
204 @param moduleTypeStr String of modlue type.\r
205 @return \r
206 **/\r
207 static public int getModuleType(String moduleTypeStr) {\r
208 int returnValue = -1;\r
209 for (int i = 0; i < CommonDefinition.moduleEnum.length; i++) {\r
210 returnValue = CommonDefinition.moduleEnum[i].ForInt(moduleTypeStr);\r
211 if (returnValue != -1) {\r
212 return returnValue;\r
213 }\r
214 }\r
215 return CommonDefinition.ModuleTypeUnknown;\r
216 }\r
217\r
218 /**\r
219 getComponentType\r
220 \r
221 This function get the component type value according commponet type \r
222 string.\r
223 \r
224 @param componentTypeStr String of component type.\r
225 @return\r
226 **/\r
227 static public int getComponentType (String componentTypeStr){\r
228 int returnValue = -1;\r
229 for (int i = 0; i < CommonDefinition.componentEnum.length; i++) {\r
230 returnValue = CommonDefinition.componentEnum[i].ForInt(componentTypeStr);\r
231 if (returnValue != -1) {\r
232 return returnValue;\r
233 }\r
234 }\r
235 return CommonDefinition.ComponentTypeUnknown;\r
236 }\r
237\r
238 /**\r
239 getComponentTypeString\r
240 \r
241 This function get the commponet type string according component type value.\r
242 \r
243 @param componentType Integer value of component type.\r
244 @return\r
5f907e4a 245 **/\r
878ddf1f 246 static public String getComponentTypeString (int componentType) {\r
5f907e4a 247 if ((componentType > CommonDefinition.ComponentTypeUnknown) || \r
248 (componentType < CommonDefinition.ComponentTypeNull)) {\r
249 return null;\r
250 }\r
251 for (int index = 0; index < CommonDefinition.componentEnum.length; index ++) {\r
252 if (componentType == CommonDefinition.componentEnum[index].type) {\r
253 return CommonDefinition.componentEnum[index].moduleTypeStr;\r
254 }\r
878ddf1f 255 }\r
5f907e4a 256 return null;\r
878ddf1f 257 }\r
258\r
259 /**\r
260 isLibraryComponent \r
261 \r
262 This function is to check does componet is library according to commponet\r
263 type value.\r
264 \r
265 @param componentType Integer value of component type.\r
266 @return\r
267 **/\r
268 static public boolean isLibraryComponent (int componentType) {\r
5f907e4a 269 if (ComponentTypeLibrary == componentType) {\r
270 return true;\r
271 }\r
272 return false;\r
878ddf1f 273 }\r
5f907e4a 274\r
a29c47e0 275 /**\r
276 * formateGuidName\r
277 * \r
278 * This function is to formate GUID to ANSI c form.\r
279 * \r
280 * @param guidNameCon\r
281 * String of GUID.\r
282 * @return Formated GUID.\r
283 */\r
284 public static String formatGuidName(String guidNameConv) {\r
285 String[] strList;\r
286 String guid = "";\r
287 int index = 0;\r
288 if (guidNameConv\r
5f907e4a 289 .matches("[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}")) {\r
a29c47e0 290 strList = guidNameConv.split("-");\r
291 guid = "0x" + strList[0] + ", ";\r
292 guid = guid + "0x" + strList[1] + ", ";\r
293 guid = guid + "0x" + strList[2] + ", ";\r
294 guid = guid + "{";\r
295 guid = guid + "0x" + strList[3].substring(0, 2) + ", ";\r
296 guid = guid + "0x" + strList[3].substring(2, 4);\r
99d2c3c4 297\r
a29c47e0 298 while (index < strList[4].length()) {\r
299 guid = guid + ", ";\r
300 guid = guid + "0x" + strList[4].substring(index, index + 2);\r
301 index = index + 2;\r
302 }\r
303 guid = guid + "}";\r
304 return guid;\r
305 } else if (guidNameConv\r
5f907e4a 306 .matches("0x[a-fA-F0-9]{1,8},( )*0x[a-fA-F0-9]{1,4},( )*0x[a-fA-F0-9]{1,4}(,( )*\\{)?(,?( )*0x[a-fA-F0-9]{1,2}){8}( )*(\\})?")) {\r
a29c47e0 307 strList = guidNameConv.split(",");\r
99d2c3c4 308\r
a29c47e0 309 //\r
310 // chang Microsoft specific form to ANSI c form\r
311 //\r
312 for (int i = 0; i < 3; i++) {\r
313 guid = guid + strList[i] + ",";\r
314 }\r
315 guid = guid + "{";\r
99d2c3c4 316\r
a29c47e0 317 for (int i = 3; i < strList.length; i++) {\r
318 if (i == strList.length - 1) {\r
319 guid = guid + strList[i];\r
320 } else {\r
321 guid = guid + strList[i] + ",";\r
322 }\r
323 }\r
324 guid = guid + "}";\r
325 return guid;\r
326 } else {\r
327 System.out\r
5f907e4a 328 .println("Check GUID Value, It doesn't conform to the registry format specified in the schema!!!");\r
a29c47e0 329 return "0";\r
330\r
331 }\r
332 }\r
5f907e4a 333\r
136adffc 334 /**\r
335 * Remove deuplicat string in list\r
336 * \r
337 * This function is to duplicat string in list\r
338 * \r
339 * @param String[]\r
340 * String list.\r
341 * @return String[] String list which remove the duplicate string.\r
342 */\r
343 public static String[] remDupString (String[] orgList){\r
58c5839f 344 Set<String> strList = new LinkedHashSet<String>();\r
136adffc 345 String[] desList ;\r
5f907e4a 346 if (orgList == null) {\r
136adffc 347 return new String[0];\r
348 }\r
5f907e4a 349 for (int i = 0; i < orgList.length; i++) {\r
136adffc 350 strList.add(orgList[i]);\r
351 }\r
352 desList = new String[strList.size()];\r
353 Iterator item = strList.iterator();\r
354 int index = 0;\r
5f907e4a 355 while (item.hasNext()) {\r
136adffc 356 desList[index] = (String)item.next();\r
357 index++;\r
358 }\r
359 return desList;\r
360 }\r
5f907e4a 361\r
391dbbb1 362}\r
EFI Development Kit II mirror for PVE