Modify code according suggestion from code review meeting.

[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / autogen / CommonDefinition.java

diff --git a/Tools/Source/GenBuild/org/tianocore/build/autogen/CommonDefinition.java b/Tools/Source/GenBuild/org/tianocore/build/autogen/CommonDefinition.java
index 3d0bf7ab3437a30c32d457348cac98ef5c2418c2..cb750ffd479296c27ddf62448cd387a050f1ea54 100644 (file)
--- a/Tools/Source/GenBuild/org/tianocore/build/autogen/CommonDefinition.java
+++ b/Tools/Source/GenBuild/org/tianocore/build/autogen/CommonDefinition.java
@@ -18,7 +18,8 @@ package org.tianocore.build.autogen;
 import java.util.Iterator;\r
 import java.util.LinkedHashSet;\r
 import java.util.Set;\r
 import java.util.Iterator;\r
 import java.util.LinkedHashSet;\r
 import java.util.Set;\r

-\r
+import org.tianocore.common.definitions.EdkDefinitions;\r
+import org.tianocore.common.definitions.ToolDefinitions;\r

 /**\r
   CommonDefinition\r
   \r
 /**\r
   CommonDefinition\r
   \r


@@ -27,88 +28,119 @@ import java.util.Set;
 **/\r
 public class CommonDefinition {\r
 \r
 **/\r
 public class CommonDefinition {\r
 \r

-    public final static String LibraryStr = "LIBRARY";\r
-    public final static String autoGenHbegin = "extern int __make_me_compile_correctly;\r\n";\r
-    public final static String include = "#include";\r
-    public final static String autoGenCLine1 = "\r\n";\r
+       ///\r
+       ///  final static string\r
+       /// \r
+    public final static String LIBRARY            = "LIBRARY";\r
+\r
+    public final static String AUTOGENHBEGIN      = "extern int __make_me_compile_correctly;"\r
+                                                                                             + ToolDefinitions.LINE_SEPARATOR;\r
+\r
+    public final static String INCLUDE            = "#include";\r
+\r
+    //public final static String DEBUGPROPERYMASK   = "const UINT8  _gDebugPropertyMask "\r
+    //                                              + "= DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED"\r
+    //                                              + "  | DEBUG_PROPERTY_DEBUG_PRINT_ENABLED"\r
+    //                                              + "  | DEBUG_PROPERTY_DEBUG_CODE_ENABLED;" \r
+    //                                                   + ToolDefinitions.LINE_SEPARATOR;\r
+\r
+    //public final static String DEFAULERROLEVEL    = "const UINTN  _gModuleDefaultErrorLevel"\r
+    //                                              + " = EFI_D_ERROR | EFI_D_LOAD;"\r
+       //                                                                                    + ToolDefinitions.LINE_SEPARATOR;\r
+\r
+\r
+    public final static String INCLUDEAUTOGENH    = INCLUDE \r
+                                                         + "    <AutoGen.h>"\r
+                                                                                                 + ToolDefinitions.LINE_SEPARATOR;\r
+\r
+    public final static String DEFINE             = "#define         ";\r
+\r
+    public final static String GEFI               = "gEfi";\r

 \r
 \r

-    public final static String autoGenCLine2 = "const UINT8  _gDebugPropertyMask "\r
-                                               + "= DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED"\r
-                                               + "  | DEBUG_PROPERTY_DEBUG_PRINT_ENABLED"\r
-                                               + "  | DEBUG_PROPERTY_DEBUG_CODE_ENABLED;\r\n";\r
+    public final static String PRTOCOLGUID        = "ProtocolGuid";\r

 \r
 \r

-    public final static String autoGenCLine3 = "const UINTN  _gModuleDefaultErrorLevel"\r
-                                               + " = EFI_D_ERROR | EFI_D_LOAD;\r\n";\r
+    public final static String PPIGUID            = "PpiGuid";\r

 \r
 \r

-    public final static String autoGenHLine1          = "#define EFI_SPECIFICATION_VERSION    0x00020000\r\n";\r
-    public final static String autoGenHVersionDefault = "#define EFI_SPECIFICATION_VERSION    0x00000000\r\n";\r
-    public final static String autoGenHLine2          = "#define EDK_RELEASE_VERSION        0x00090000\r\n";\r
-    public final static String autoGenHReleaseDefault = "#define EDK_RELEASE_VERSION        0x00000000\r\n";\r
+    public final static String GUID               = "Guid";\r

 \r
 \r

-    public final static String includeAutogenH        = "#include    <AutoGen.h>\r\n" ;\r
-    public final static String marcDefineStr          = "#define ";\r
+    public final static String TIANOR8PLASHMAPH   = "TianoR8FlashMap.h";\r

 \r
 \r

-    public final static String gEfi = "gEfi";\r
-    public final static String protocolGuid = "ProtocolGuid";\r
-    public final static String ppiGuid = "PpiGuid";\r
-    public final static String guidGuid = "Guid";\r
+    public final static String FLASHMAPH          = "FlashMap.h";\r

 \r
 \r

-    public final static String tianoR8FlashMapH = "TianoR8FlashMap.h";\r
-    public final static String flashMapH = "FlashMap.h";\r
+       public final static String IFNDEF             = "#ifndef          ";\r
+\r
+       public final static String AUTOGENH            = "_AUTOGENH_";\r
+\r
+                                                                 \r
+    ///\r
+    /// AutoGen.h and AutoGen.c file's header\r
+    ///\r
+    public final static String AUTOGENHNOTATION   = "/**"\r
+                                                     + ToolDefinitions.LINE_SEPARATOR\r
+                                                     + "  DO NOT EDIT"\r
+                                                  + ToolDefinitions.LINE_SEPARATOR\r
+                                                     + "  FILE auto-generated by GenBuild tasks"\r
+                                                     + ToolDefinitions.LINE_SEPARATOR \r
+                                                     + "  Module name:"\r
+                                                     + ToolDefinitions.LINE_SEPARATOR\r
+                                                     + "       AutoGen.h"\r
+                                                     + ToolDefinitions.LINE_SEPARATOR \r
+                                                     + "  Abstract:" \r
+                                                     + "       Auto-generated AutoGen.h for building module or library."\r
+                                                     + ToolDefinitions.LINE_SEPARATOR\r
+                                                  + "**/"\r
+                                                  + ToolDefinitions.LINE_SEPARATOR \r
+                                                  + ToolDefinitions.LINE_SEPARATOR;\r
+\r
+    public final static String AUTOGENCNOTATION   = "/**"\r
+                                                         + ToolDefinitions.LINE_SEPARATOR\r
+                                                         + "  DO NOT EDIT"\r
+                                                                                                 + ToolDefinitions.LINE_SEPARATOR\r
+                                                         + "  FILE auto-generated by GenBuild tasks"\r
+                                                                                                 + ToolDefinitions.LINE_SEPARATOR \r
+                                                         + "  Module name:"\r
+                                                         + ToolDefinitions.LINE_SEPARATOR \r
+                                                         + "       AutoGen.c"\r
+                                                         + ToolDefinitions.LINE_SEPARATOR \r
+                                                         + "  Abstract:" \r
+                                                         + "       Auto-generated AutoGen.c for building module or library."\r
+                                                                                                 + ToolDefinitions.LINE_SEPARATOR \r
+                                                         + "**/"\r
+                                                         + ToolDefinitions.LINE_SEPARATOR\r
+                                                         + ToolDefinitions.LINE_SEPARATOR;\r

 \r
     ///\r
     /// The defintions for identifying current module\r
     /// is PEI Pcd driver or Dxe Pcd driver.\r
     /// \r
     public static enum   PCD_DRIVER_TYPE { NOT_PCD_DRIVER,\r
 \r
     ///\r
     /// The defintions for identifying current module\r
     /// is PEI Pcd driver or Dxe Pcd driver.\r
     /// \r
     public static enum   PCD_DRIVER_TYPE { NOT_PCD_DRIVER,\r

-        PEI_PCD_DRIVER, \r
-        DXE_PCD_DRIVER,\r
-        UNKNOWN_PCD_DRIVER};\r
+                                           PEI_PCD_DRIVER, \r
+                                           DXE_PCD_DRIVER,\r
+                                           UNKNOWN_PCD_DRIVER\r
+                                                };\r

 \r
 \r

-    ///\r
-    /// AutoGen.h and AutoGen.c file's header\r
-    ///\r
-    public final static String autogenHNotation = \r
-    "/**\r\n" +\r
-    "  DO NOT EDIT\r\n" +\r
-    "  FILE auto-generated by GenBuild tasks\r\n" +\r
-    "  Module name:\r\n" +\r
-    "       AutoGen.h\r\n" +\r
-    "  Abstract:" +\r
-    "       Auto-generated AutoGen.h for building module or library.\r\n" +\r
-    "**/\r\n\r\n";\r
-\r
-    public final static String autogenCNotation = \r
-    "/**\r\n" +\r
-    "  DO NOT EDIT\r\n" +\r
-    "  FILE auto-generated by GenBuild tasks\r\n" +\r
-    "  Module name:\r\n" +\r
-    "       AutoGen.c\r\n" +\r
-    "  Abstract:" +\r
-    "       Auto-generated AutoGen.c for building module or library.\r\n" +\r
-    "**/\r\n\r\n";\r

 \r
     ///\r
     /// module type\r
     ///\r
 \r
     ///\r
     /// module type\r
     ///\r

-    public final static int ModuleTypeBase = 0;\r
-    public final static int ModuleTypeSec = 1;\r
-    public final static int ModuleTypePeiCore = 2;\r
-    public final static int ModuleTypePeim = 3;\r
-    public final static int ModuleTypeDxeCore = 4;\r
-    public final static int ModuleTypeDxeDriver = 5;\r
+    public final static int ModuleTypeBase             = 0;\r
+    public final static int ModuleTypeSec              = 1;\r
+    public final static int ModuleTypePeiCore          = 2;\r
+    public final static int ModuleTypePeim             = 3;\r
+    public final static int ModuleTypeDxeCore          = 4;\r
+    public final static int ModuleTypeDxeDriver        = 5;\r

     public final static int ModuleTypeDxeRuntimeDriver = 6;\r
     public final static int ModuleTypeDxeRuntimeDriver = 6;\r

-    public final static int ModuleTypeDxeSmmDriver = 7;\r
-    public final static int ModuleTypeDxeSalDriver = 8;\r
-    public final static int ModuleTypeUefiDriver = 9;\r
-    public final static int ModuleTypeUefiApplication = 10;\r
-    public final static int ModuleTypeUnknown = 11;\r
+    public final static int ModuleTypeDxeSmmDriver     = 7;\r
+    public final static int ModuleTypeDxeSalDriver     = 8;\r
+    public final static int ModuleTypeUefiDriver       = 9;\r
+    public final static int ModuleTypeUefiApplication  = 10;\r
+    public final static int ModuleTypeUnknown          = 11;\r

 \r
     ///\r
     /// Usaged style\r
     ///\r
 \r
     ///\r
     /// Usaged style\r
     ///\r

-    public final static String AlwaysConsumed = "ALWAYS_CONSUMED";\r
-    public final static String AlwaysProduced = "ALWAYS_PRODUCED";\r
+    public final static String ALWAYSCONSUMED = "ALWAYS_CONSUMED";\r
+    public final static String ALWAYSPRODUCED = "ALWAYS_PRODUCED";\r

 \r
 \r
     public static class MyEnum {\r
 \r
 \r
     public static class MyEnum {\r


@@ -132,17 +164,17 @@ public class CommonDefinition {
     /// Module type\r
     ///\r
     public static final MyEnum[] moduleEnum = new MyEnum[] {\r
     /// Module type\r
     ///\r
     public static final MyEnum[] moduleEnum = new MyEnum[] {\r

-        new MyEnum("BASE", ModuleTypeBase),\r
-        new MyEnum("SEC", ModuleTypeSec),\r
-        new MyEnum("PEI_CORE", ModuleTypePeiCore),\r
-        new MyEnum("PEIM", ModuleTypePeim),\r
-        new MyEnum("DXE_CORE", ModuleTypeDxeCore),\r
-        new MyEnum("DXE_DRIVER", ModuleTypeDxeDriver),\r
-        new MyEnum("DXE_RUNTIME_DRIVER", ModuleTypeDxeRuntimeDriver),\r
-        new MyEnum("DXE_SAL_DRIVER", ModuleTypeDxeSalDriver),\r
-        new MyEnum("DXE_SMM_DRIVER", ModuleTypeDxeSmmDriver),\r
-        new MyEnum("UEFI_DRIVER", ModuleTypeUefiDriver),\r
-        new MyEnum("UEFI_APPLICATION", ModuleTypeUefiApplication)};\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_BASE, ModuleTypeBase),\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_SEC, ModuleTypeSec),\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_PEI_CORE, ModuleTypePeiCore),\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_PEIM, ModuleTypePeim),\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_DXE_CORE, ModuleTypeDxeCore),\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_DXE_DRIVER, ModuleTypeDxeDriver),\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_DXE_RUNTIME_DRIVER, ModuleTypeDxeRuntimeDriver),\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_DXE_SAL_DRIVER, ModuleTypeDxeSalDriver),\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_DXE_SMM_DRIVER, ModuleTypeDxeSmmDriver),\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_UEFI_DRIVER, ModuleTypeUefiDriver),\r
+        new MyEnum(EdkDefinitions.MODULE_TYPE_UEFI_APPLICATION, ModuleTypeUefiApplication)};\r

 \r
     /**\r
       getModuleType\r
 \r
     /**\r
       getModuleType\r


@@ -152,7 +184,7 @@ public class CommonDefinition {
       @param  moduleTypeStr     String of modlue type.\r
       @return                   \r
     **/\r
       @param  moduleTypeStr     String of modlue type.\r
       @return                   \r
     **/\r

-    static public int getModuleType(String moduleTypeStr) {\r
+    public static int getModuleType(String moduleTypeStr) {\r

         int returnValue = -1;\r
         for (int i = 0; i < CommonDefinition.moduleEnum.length; i++) {\r
             returnValue = CommonDefinition.moduleEnum[i].ForInt(moduleTypeStr);\r
         int returnValue = -1;\r
         for (int i = 0; i < CommonDefinition.moduleEnum.length; i++) {\r
             returnValue = CommonDefinition.moduleEnum[i].ForInt(moduleTypeStr);\r