2 CommonDefinition class.
4 This class is to define some common marcos and funcions, which used by AutoGen.
6 Copyright (c) 2006, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 package org
.tianocore
.build
.autogen
;
18 import java
.util
.HashSet
;
19 import java
.util
.Iterator
;
20 import java
.util
.LinkedHashSet
;
26 This class is to define some common marcos, which used by AutoGen.
29 public class CommonDefinition
{
30 public final static String spdSuffix
= ".spd";
31 public final static String mbdSuffix
= ".mbd";
32 public final static String msaSuffix
= ".msa";
33 public final static String LibraryStr
= "LIBRARY";
34 public final static String autoGenHbegin
= "extern int __make_me_compile_correctly;\r\n";
35 public final static String include
= "#include";
36 public final static String autoGenCLine1
= "\r\n";
38 public final static String autoGenCLine2
= "const UINT8 _gDebugPropertyMask "
39 + "= DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED"
40 + " | DEBUG_PROPERTY_DEBUG_PRINT_ENABLED"
41 + " | DEBUG_PROPERTY_DEBUG_CODE_ENABLED;\r\n";
43 public final static String autoGenCLine3
= "const UINTN _gModuleDefaultErrorLevel"
44 + " = EFI_D_ERROR | EFI_D_LOAD;\r\n";
46 public final static String autoGenHLine1
= "#define EFI_SPECIFICATION_VERSION 0x00020000\r\n";
47 public final static String autoGenHVersionDefault
= "#define EFI_SPECIFICATION_VERSION 0x00000000\r\n";
48 public final static String autoGenHLine2
= "#define EDK_RELEASE_VERSION 0x00090000\r\n";
49 public final static String autoGenHReleaseDefault
= "#define EDK_RELEASE_VERSION 0x00000000\r\n";
51 public final static String includeAutogenH
= "#include <AutoGen.h>\r\n" ;
52 public final static String marcDefineStr
= "#define ";
54 public final static String gEfi
= "gEfi";
55 public final static String protocolGuid
= "ProtocolGuid";
56 public final static String ppiGuid
= "PpiGuid";
57 public final static String guidGuid
= "Guid";
59 public final static String tianoR8FlashMapH
= "TianoR8FlashMap.h";
60 public final static String flashMapH
= "FlashMap.h";
63 // The defintions for identifying current module
64 // is PEI Pcd driver or Dxe Pcd driver.
66 public static enum PCD_DRIVER_TYPE
{ NOT_PCD_DRIVER
,
72 // AutoGen.h and AutoGen.c file's header
74 public final static String autogenHNotation
=
77 " FILE auto-generated by GenBuild tasks\r\n" +
81 " Auto-generated AutoGen.h for building module or library.\r\n" +
84 public final static String autogenCNotation
=
87 " FILE auto-generated by GenBuild tasks\r\n" +
91 " Auto-generated AutoGen.c for building module or library.\r\n" +
97 public final static int ModuleTypeBase
= 0;
98 public final static int ModuleTypeSec
= 1;
99 public final static int ModuleTypePeiCore
= 2;
100 public final static int ModuleTypePeim
= 3;
101 public final static int ModuleTypeDxeCore
= 4;
102 public final static int ModuleTypeDxeDriver
= 5;
103 public final static int ModuleTypeDxeRuntimeDriver
= 6;
104 public final static int ModuleTypeDxeSmmDriver
= 7;
105 public final static int ModuleTypeDxeSalDriver
= 8;
106 public final static int ModuleTypeUefiDriver
= 9;
107 public final static int ModuleTypeUefiApplication
= 10;
108 public final static int ModuleTypeUnknown
= 11;
114 public final static int ComponentTypeNull
= 0;
115 public final static int ComponentTypeApriori
= 1;
116 public final static int ComponentTypeSec
= 2;
117 public final static int ComponentTypeLibrary
= 3;
118 public final static int ComponentTypeFvImageFile
= 4;
119 public final static int ComponentTypeBsDriver
= 5;
120 public final static int ComponentTypeRtDriver
= 6;
121 public final static int ComponentTypeSalRtDriver
=7;
122 public final static int ComponentTypePe32Peim
= 8;
123 public final static int ComponentTypePicPeim
=9;
124 public final static int ComponentTypeCombinedPeimDriver
=10;
125 public final static int ComponentTypePeiCore
= 11;
126 public final static int ComponentTypeDxeCore
= 12;
127 public final static int ComponentTypeApplication
= 13;
128 public final static int ComponentTypeBsDriverEfi
= 14;
129 public final static int ComponentTypeShellApp
= 15;
130 public final static int ComponentTypeBinary
=16;
131 public final static int ComponentTypeLogo
= 17;
132 public final static int ComponentTypeCustomBuild
= 18;
133 public final static int ComponentTypeUnknown
= 19;
139 public final static String AlwaysConsumed
= "ALWAYS_CONSUMED";
140 public final static String AlwaysProduced
= "ALWAYS_PRODUCED";
143 public static class MyEnum
{
144 String moduleTypeStr
;
147 MyEnum (String str
, int type
) {
149 this.moduleTypeStr
= str
;
152 int ForInt(String str
) {
153 if (str
.equals(this.moduleTypeStr
)) {
163 public static final MyEnum
[] moduleEnum
= new MyEnum
[] {
164 new MyEnum("BASE", ModuleTypeBase
),
165 new MyEnum("SEC", ModuleTypeSec
),
166 new MyEnum("PEI_CORE", ModuleTypePeiCore
),
167 new MyEnum("PEIM", ModuleTypePeim
),
168 new MyEnum("DXE_CORE", ModuleTypeDxeCore
),
169 new MyEnum("DXE_DRIVER", ModuleTypeDxeDriver
),
170 new MyEnum("DXE_RUNTIME_DRIVER", ModuleTypeDxeRuntimeDriver
),
171 new MyEnum("DXE_SAL_DRIVER", ModuleTypeDxeSalDriver
),
172 new MyEnum("DXE_SMM_DRIVER", ModuleTypeDxeSmmDriver
),
173 new MyEnum("UEFI_DRIVER", ModuleTypeUefiDriver
),
174 new MyEnum("UEFI_APPLICATION", ModuleTypeUefiApplication
)};
179 public static final MyEnum
[] componentEnum
= new MyEnum
[]{
180 new MyEnum("APRIORI", ComponentTypeApriori
),
181 new MyEnum("SEC", ComponentTypeSec
),
182 new MyEnum("LIBRARY", ComponentTypeLibrary
),
183 new MyEnum("FV_IMAGE_FILE", ComponentTypeFvImageFile
),
184 new MyEnum("BS_DRIVER", ComponentTypeBsDriver
),
185 new MyEnum("RT_DRIVER", ComponentTypeRtDriver
),
186 new MyEnum("SAL_RT_DRIVER", ComponentTypeSalRtDriver
),
187 new MyEnum("PE32_PEIM", ComponentTypePe32Peim
),
188 new MyEnum("PIC_PEIM", ComponentTypePicPeim
),
189 new MyEnum("COMBINED_PEIM_DRIVER", ComponentTypeCombinedPeimDriver
),
190 new MyEnum("PEI_CORE", ComponentTypePeiCore
),
191 new MyEnum("DXE_CORE", ComponentTypeDxeCore
),
192 new MyEnum("APPLICATION", ComponentTypeApplication
),
193 new MyEnum("BS_DRIVER_EFI", ComponentTypeBsDriverEfi
),
194 new MyEnum("SHELLAPP", ComponentTypeShellApp
),
195 new MyEnum("BINARY", ComponentTypeBinary
),
196 new MyEnum("LOGO", ComponentTypeLogo
),
197 new MyEnum("CUSTOM_BUILD", ComponentTypeCustomBuild
)
203 This function get the module type value according module type string.
205 @param moduleTypeStr String of modlue type.
208 static public int getModuleType(String moduleTypeStr
) {
209 int returnValue
= -1;
210 for (int i
= 0; i
< CommonDefinition
.moduleEnum
.length
; i
++) {
211 returnValue
= CommonDefinition
.moduleEnum
[i
].ForInt(moduleTypeStr
);
212 if (returnValue
!= -1) {
216 return CommonDefinition
.ModuleTypeUnknown
;
222 This function get the component type value according commponet type
225 @param componentTypeStr String of component type.
228 static public int getComponentType (String componentTypeStr
){
229 int returnValue
= -1;
230 for (int i
= 0; i
< CommonDefinition
.componentEnum
.length
; i
++) {
231 returnValue
= CommonDefinition
.componentEnum
[i
].ForInt(componentTypeStr
);
232 if (returnValue
!= -1) {
236 return CommonDefinition
.ComponentTypeUnknown
;
240 getComponentTypeString
242 This function get the commponet type string according component type value.
244 @param componentType Integer value of component type.
247 static public String
getComponentTypeString (int componentType
) {
248 if ((componentType
> CommonDefinition
.ComponentTypeUnknown
) ||
249 (componentType
< CommonDefinition
.ComponentTypeNull
)) {
252 for (int index
= 0; index
< CommonDefinition
.componentEnum
.length
; index
++) {
253 if (componentType
== CommonDefinition
.componentEnum
[index
].type
) {
254 return CommonDefinition
.componentEnum
[index
].moduleTypeStr
;
263 This function is to check does componet is library according to commponet
266 @param componentType Integer value of component type.
269 static public boolean isLibraryComponent (int componentType
) {
270 if (ComponentTypeLibrary
== componentType
) {
279 * This function is to formate GUID to ANSI c form.
283 * @return Formated GUID.
285 public static String
formatGuidName(String guidNameConv
) {
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}")) {
291 strList
= guidNameConv
.split("-");
292 guid
= "0x" + strList
[0] + ", ";
293 guid
= guid
+ "0x" + strList
[1] + ", ";
294 guid
= guid
+ "0x" + strList
[2] + ", ";
296 guid
= guid
+ "0x" + strList
[3].substring(0, 2) + ", ";
297 guid
= guid
+ "0x" + strList
[3].substring(2, 4);
299 while (index
< strList
[4].length()) {
301 guid
= guid
+ "0x" + strList
[4].substring(index
, index
+ 2);
306 } else if (guidNameConv
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}( )*(\\})?")) {
308 strList
= guidNameConv
.split(",");
311 // chang Microsoft specific form to ANSI c form
313 for (int i
= 0; i
< 3; i
++) {
314 guid
= guid
+ strList
[i
] + ",";
318 for (int i
= 3; i
< strList
.length
; i
++) {
319 if (i
== strList
.length
- 1) {
320 guid
= guid
+ strList
[i
];
322 guid
= guid
+ strList
[i
] + ",";
329 .println("Check GUID Value, It doesn't conform to the registry format specified in the schema!!!");
336 * Remove deuplicat string in list
338 * This function is to duplicat string in list
342 * @return String[] String list which remove the duplicate string.
344 public static String
[] remDupString (String
[] orgList
){
345 Set
<String
> strList
= new LinkedHashSet
<String
>();
347 if (orgList
== null) {
348 return new String
[0];
350 for (int i
= 0; i
< orgList
.length
; i
++) {
351 strList
.add(orgList
[i
]);
353 desList
= new String
[strList
.size()];
354 Iterator item
= strList
.iterator();
356 while (item
.hasNext()) {
357 desList
[index
] = (String
)item
.next();