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