1) Applied ToolArg and FileArg class to represent tool arguments

[mirror_edk2.git] / Tools / Source / FrameworkTasks / org / tianocore / framework / tasks / GuidChkTask.java

diff --git a/Tools/Source/FrameworkTasks/org/tianocore/framework/tasks/GuidChkTask.java b/Tools/Source/FrameworkTasks/org/tianocore/framework/tasks/GuidChkTask.java
index 8b6943229fd1f9ce89c923e8ef1c3175dc8f310e..2f892a7cd4abfd4fa2dffe6752bc5fd53844d708 100644 (file)
--- a/Tools/Source/FrameworkTasks/org/tianocore/framework/tasks/GuidChkTask.java
+++ b/Tools/Source/FrameworkTasks/org/tianocore/framework/tasks/GuidChkTask.java
@@ -23,6 +23,8 @@ import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.Project;\r
 import org.apache.tools.ant.Task;\r
 \r
+import org.tianocore.common.logger.EdkLog;\r
+\r
 /**\r
   GuidChkTask\r
   \r
@@ -46,49 +48,53 @@ public class GuidChkTask extends Task implements EfiDefine{
      *    -fos     : out put redirect to this file \r
      *    \r
      */\r
-    ///\r
-    /// Directory name of exclusion searching \r
-    ///\r
-    private String exDir = "";\r
-    ///\r
-    /// File name of exclusion searching.\r
-    ///\r
-    private String exFile = "";\r
-    ///\r
-    /// Extension name of exclusion searching.\r
-    ///\r
-    private String exExt = "";\r
-    ///\r
-    /// Extesnion name of sub dir which excluded searching.\r
-    ///\r
-    private String exSubDir = "";\r
-    ///\r
-    /// Out put file wrote internal GUID+basename list\r
-    ///\r
-    private String outFile = "";\r
-    ///\r
-    /// Check for duplicate guids.\r
-    ///\r
-    private String chkGui = "";\r
-    ///\r
-    /// Check for duplicate signatures\r
-    ///\r
-    private String chkSign = "";\r
-    ///\r
-    /// If set will print guid+defined symbol name\r
-    ///\r
-    private String printGuiDef = "";\r
-    ///\r
-    /// If set will print all GUIDS found\r
-    ///\r
-    private String printAllGuid = "";\r
-    ///\r
-    /// redirection file name.\r
-    ///\r
+    //\r
+    // Tool name\r
+    // \r
+    private static String toolName = "GuidChk";\r
+    //\r
+    // Directory name of exclusion searching \r
+    //\r
+    private FileArg exDir = new FileArg();\r
+    //\r
+    // File name of exclusion searching.\r
+    //\r
+    private FileArg exFile = new FileArg();\r
+    //\r
+    // Extension name of exclusion searching.\r
+    //\r
+    private FileArg exExt = new FileArg();\r
+    //\r
+    // Extesnion name of sub dir which excluded searching.\r
+    //\r
+    private FileArg exSubDir = new FileArg();\r
+    //\r
+    // Out put file wrote internal GUID+basename list\r
+    //\r
+    private FileArg outFile = new FileArg();\r
+    //\r
+    // Check for duplicate guids.\r
+    //\r
+    private ToolArg chkGui = new ToolArg();\r
+    //\r
+    // Check for duplicate signatures\r
+    //\r
+    private ToolArg chkSign = new ToolArg();\r
+    //\r
+    // If set will print guid+defined symbol name\r
+    //\r
+    private ToolArg printGuiDef = new ToolArg();\r
+    //\r
+    // If set will print all GUIDS found\r
+    //\r
+    private ToolArg printAllGuid = new ToolArg();\r
+    //\r
+    // redirection file name.\r
+    //\r
     private String outPut = "";\r
-    ///\r
-    /// out put redirect to this file.\r
-    ///\r
+    //\r
+    // out put redirect to this file.\r
+    //\r
     protected PrintWriter fos = null;\r
     \r
     //\r
@@ -99,25 +105,25 @@ public class GuidChkTask extends Task implements EfiDefine{
         String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");\r
         String command;\r
         if (path == null) {\r
-            command = "GuidChk";\r
+            command = toolName;\r
         } else {\r
-            command = path + File.separatorChar + "GuidChk";\r
+            command = path + File.separatorChar + toolName;\r
         }\r
-        String argument = exDir +\r
-                          exFile +\r
-                          exExt +\r
-                          exSubDir +\r
-                          outFile +\r
-                          chkGui +\r
-                          chkSign +\r
-                          printGuiDef + \r
-                          printAllGuid;     \r
+        String argument = "" + exDir +\r
+                               exFile +\r
+                               exExt +\r
+                               exSubDir +\r
+                               outFile +\r
+                               chkGui +\r
+                               chkSign +\r
+                               printGuiDef + \r
+                               printAllGuid;     \r
         try {\r
-            log(command + " " + argument, Project.MSG_VERBOSE);\r
+            EdkLog.log(this, EdkLog.EDK_VERBOSE, command + " " + argument);\r
             //\r
             // execute command line \r
             //\r
-            Process proc = Runtime.getRuntime().exec(command + "" + argument);\r
+            Process proc = Runtime.getRuntime().exec(command + " " + argument);\r
             //\r
             // if set output, redirect out put to output file, else print output to screen\r
             //         \r
@@ -126,8 +132,8 @@ public class GuidChkTask extends Task implements EfiDefine{
                 BufferedReader bin = new BufferedReader(new InputStreamReader(proc.getInputStream()));\r
                 String line = bin.readLine();\r
                 while (line != null ){                  \r
-                fos.println(line);\r
-                line = bin.readLine();\r
+                    fos.println(line);\r
+                    line = bin.readLine();\r
                 }\r
                 fos.close();\r
             }\r
@@ -138,9 +144,9 @@ public class GuidChkTask extends Task implements EfiDefine{
                     line = bin.readLine();\r
                 }               \r
             }                      \r
-            log("GuidChkTask Succeeded!", Project.MSG_VERBOSE);\r
+            EdkLog.log(this, EdkLog.EDK_VERBOSE, toolName + " Succeeded!");\r
         } catch (Exception e) {\r
-            throw new BuildException("GuidChkTask failed!");\r
+            throw new BuildException(toolName + " failed!");\r
         }\r
     }\r
     /**\r
@@ -151,7 +157,7 @@ public class GuidChkTask extends Task implements EfiDefine{
       @return                     string of flag of ChkGui\r
     **/\r
     public String getChkGui() {\r
-        return chkGui;\r
+        return chkGui.getValue();\r
     }\r
     \r
     /**\r
@@ -161,11 +167,10 @@ public class GuidChkTask extends Task implements EfiDefine{
       \r
       @param chkGui               set class member of chkGui\r
     **/\r
-    public void setChkGui(String chkGui) {\r
-        if (chkGui.equals("on")||(chkGui.equals("ON"))){\r
-            this.chkGui = " -g ";\r
-        }\r
-        \r
+    public void setChkGui(boolean chkGui) {\r
+        if (chkGui) {\r
+            this.chkGui.setArg(" -", "g");\r
+        }        \r
     }\r
     \r
     /**\r
@@ -176,7 +181,7 @@ public class GuidChkTask extends Task implements EfiDefine{
       @return                  chkSign\r
     **/\r
     public String getChkSign() {\r
-        return chkSign;\r
+        return chkSign.getValue();\r
     }\r
     \r
     /**\r
@@ -185,9 +190,9 @@ public class GuidChkTask extends Task implements EfiDefine{
       This function is to set class member of chkSign\r
      * @param chkSign\r
      */\r
-    public void setChkSign(String chkSign) {\r
-        if (chkSign.equals("on")|| chkSign.equals("ON")){\r
-            this.chkSign = " -s ";\r
+    public void setChkSign(boolean chkSign) {\r
+        if (chkSign){\r
+            this.chkSign.setArg(" -", "s");\r
         }       \r
     }\r
     /**\r
@@ -198,7 +203,7 @@ public class GuidChkTask extends Task implements EfiDefine{
       @return                 exDir\r
     **/\r
     public String getExDir() {\r
-        return exDir;\r
+        return exDir.getValue();\r
     }\r
     \r
     /**\r
@@ -209,7 +214,7 @@ public class GuidChkTask extends Task implements EfiDefine{
       @param                   exDir\r
     **/\r
     public void setExDir(String exDir) {\r
-        this.exDir = " -d " + exDir;\r
+        this.exDir.setArg(" -d ", exDir);\r
     }\r
     \r
     /**\r
@@ -220,7 +225,7 @@ public class GuidChkTask extends Task implements EfiDefine{
       @return                    exExt\r
     **/\r
     public String getExExt() {\r
-        return exExt;\r
+        return exExt.getValue();\r
     }\r
     \r
     /**\r
@@ -230,7 +235,7 @@ public class GuidChkTask extends Task implements EfiDefine{
       @param                      exExt\r
     **/\r
     public void setExExt(String exExt) {\r
-        this.exExt = " -e " + exExt;\r
+        this.exExt.setArg(" -e ", exExt);\r
     }\r
     \r
     /**\r
@@ -240,7 +245,7 @@ public class GuidChkTask extends Task implements EfiDefine{
       @return                    exFile\r
     **/\r
     public String getExFile() {\r
-        return exFile;\r
+        return exFile.getValue();\r
     }\r
     \r
     /**\r
@@ -251,7 +256,7 @@ public class GuidChkTask extends Task implements EfiDefine{
      @param                       exFile\r
     **/\r
     public void setExFile(String exFile) {\r
-        this.exFile = " -f " + exFile;\r
+        this.exFile.setArg(" -f ", exFile);\r
     }\r
     \r
     /**\r
@@ -262,7 +267,7 @@ public class GuidChkTask extends Task implements EfiDefine{
       @return                      exSubDir\r
     **/\r
     public String getExSubDir() {\r
-        return exSubDir;\r
+        return exSubDir.getValue();\r
     }\r
     \r
     /**\r
@@ -272,7 +277,7 @@ public class GuidChkTask extends Task implements EfiDefine{
      @param                         exSubDir\r
     **/\r
     public void setExSubDir(String exSubDir) {\r
-        this.exSubDir = " -u " + exSubDir;\r
+        this.exSubDir.setArg(" -u ", exSubDir);\r
     }\r
     \r
     /**\r
@@ -283,14 +288,14 @@ public class GuidChkTask extends Task implements EfiDefine{
      @return                        outFile\r
     **/\r
     public String getOutFile() {\r
-        return outFile;\r
+        return outFile.getValue();\r
     }\r
     /**\r
      * set class member of outFile\r
      * @param outFile\r
      */\r
     public void setOutFile(String outFile) {\r
-        this.outFile = " -b " + outFile;\r
+        this.outFile.setArg(" -b ", outFile);\r
     }\r
     /**\r
       getPrintGuidDef\r
@@ -300,7 +305,7 @@ public class GuidChkTask extends Task implements EfiDefine{
       @return     flage of printing (guid+defined symbol name)\r
     **/\r
     public String getPrintGuiDef() {\r
-        return printGuiDef;\r
+        return printGuiDef.getValue();\r
     }\r
     \r
     \r
@@ -310,9 +315,9 @@ public class GuidChkTask extends Task implements EfiDefine{
       This function is to set class member of printGuiDef.\r
       @param       printGuiDef\r
     **/\r
-    public void setPrintGuiDef(String printGuiDef) {\r
-        if (printGuiDef.equals("on")|| printGuiDef.equals("ON")){\r
-            this.printGuiDef = " -x ";\r
+    public void setPrintGuiDef(boolean printGuiDef) {\r
+        if (printGuiDef){\r
+            this.printGuiDef.setArg(" -", "x");\r
         }\r
         \r
     }\r
@@ -345,7 +350,7 @@ public class GuidChkTask extends Task implements EfiDefine{
       @return         printAllGuid\r
     **/\r
     public String getPrintAllGuid() {\r
-        return printAllGuid;\r
+        return printAllGuid.getValue();\r
     }\r
     \r
     /**\r
@@ -354,9 +359,9 @@ public class GuidChkTask extends Task implements EfiDefine{
       This function is to set class member of printAllGuid.\r
       @param          printAllGuid\r
     **/\r
-    public void setPrintAllGuid(String printAllGuid) {\r
-        if (printAllGuid.equals("on")||printAllGuid.equals("ON")) {\r
-            this.printAllGuid = " -p ";\r
+    public void setPrintAllGuid(boolean printAllGuid) {\r
+        if (printAllGuid) {\r
+            this.printAllGuid.setArg(" -", "p");\r
         }       \r
     }\r
 }\r