1. Restructure module description on main UI

[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / workspace / WorkspaceTools.java

diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/workspace/WorkspaceTools.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/workspace/WorkspaceTools.java
index 73fba9a86140a8082b2c2758a1f95119d8592a3e..e4800816cb6264b9e8ab66d188addc5a4fc6c1c4 100644 (file)
--- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/workspace/WorkspaceTools.java
+++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/workspace/WorkspaceTools.java
@@ -20,6 +20,7 @@ import java.util.Vector;
 import org.apache.xmlbeans.XmlException;\r
 import org.tianocore.DbPathAndFilename;\r
 import org.tianocore.FrameworkDatabaseDocument;\r
+import org.tianocore.IndustryStdIncludesDocument.IndustryStdIncludes;\r
 import org.tianocore.ModuleSurfaceAreaDocument.ModuleSurfaceArea;\r
 import org.tianocore.MsaFilesDocument.MsaFiles;\r
 import org.tianocore.MsaHeaderDocument.MsaHeader;\r
@@ -88,14 +89,42 @@ public class WorkspaceTools {
                 }\r
             }\r
         } catch (IOException e) {\r
-            e.printStackTrace();\r
+\r
         } catch (XmlException e) {\r
-            e.printStackTrace();\r
+\r
         } catch (Exception e) {\r
-            e.printStackTrace();\r
+\r
         }\r
         return modulePath;\r
     }\r
+    \r
+    /**\r
+    Get all Industry Std Includes' paths from one package\r
+    \r
+    @return a Vector with all paths\r
+    \r
+    **/\r
+   public Vector<String> getAllIndustryStdIncludesOfPackage(String path) {\r
+       Vector<String> includePath = new Vector<String>();\r
+       try {\r
+           IndustryStdIncludes files = OpenFile.openSpdFile(path).getIndustryStdIncludes();\r
+           if (files != null) {\r
+               for (int index = 0; index < files.getIndustryStdHeaderList().size(); index++) {\r
+                   String temp = files.getIndustryStdHeaderList().get(index).getName();\r
+                   temp = Tools.addFileSeparator(Tools.getFilePathOnly(path)) + temp;\r
+                   temp = Tools.convertPathToCurrentOsType(temp);\r
+                   includePath.addElement(temp);\r
+               }\r
+           }\r
+       } catch (IOException e) {\r
+\r
+       } catch (XmlException e) {\r
+\r
+       } catch (Exception e) {\r
+\r
+       }\r
+       return includePath;\r
+   }\r
 \r
     /**\r
      Get all package basic information form the FrameworkDatabase.db file\r
@@ -118,22 +147,54 @@ public class WorkspaceTools {
                 vPackageList.addElement(new PackageIdentification(id));\r
             } catch (IOException e) {\r
                 Log.err("Open Package Surface Area " + path, e.getMessage());\r
-                e.printStackTrace();\r
+\r
             } catch (XmlException e) {\r
                 Log.err("Open Package Surface Area " + path, e.getMessage());\r
-                e.printStackTrace();\r
+\r
             } catch (Exception e) {\r
                 Log.err("Open Package Surface Area " + path, "Invalid file type");\r
-                e.printStackTrace();\r
+\r
             }\r
         }\r
+        Tools.sortPackages(vPackageList, DataType.SORT_TYPE_ASCENDING);\r
         return vPackageList;\r
     }\r
+    \r
+    /**\r
+     Get all module basic information from a package\r
+    \r
+     @param id Package id\r
+     @return A vector includes all modules' basic information\r
+    \r
+    **/\r
+    public Vector<ModuleIdentification> getAllModules(PackageIdentification pid) {\r
+        Vector<ModuleIdentification> v = new Vector<ModuleIdentification>();\r
+        Vector<String> modulePaths = this.getAllModulesOfPackage(pid.getPath());\r
+        Identification id = null;\r
+        String modulePath = null;\r
+        \r
+        for (int index = 0; index < modulePaths.size(); index++) {\r
+            try {\r
+                modulePath = modulePaths.get(index);\r
+                id = getId(modulePath, OpenFile.openMsaFile(modulePath));\r
+            } catch (IOException e) {\r
+                Log.log("Error when Open Module Surface Area " + modulePath, e.getMessage());\r
+            } catch (XmlException e) {\r
+                Log.log("Error when Open Module Surface Area " + modulePath, e.getMessage());\r
+            } catch (Exception e) {\r
+                Log.log("Error when Open Module Surface Area " + modulePath, "Invalid file type " + e.getMessage());\r
+            }\r
+            v.addElement(new ModuleIdentification(id, pid));\r
+        }\r
+        Tools.sortModules(v, DataType.SORT_TYPE_ASCENDING);\r
+        return v;\r
+        \r
+    }\r
 \r
     /**\r
-     Get all package basic information form the FrameworkDatabase.db file\r
+     Get all module basic information form the FrameworkDatabase.db file\r
      \r
-     @return vPackageList A vector includes all packages' basic information\r
+     @return vModuleList A vector includes all modules' basic information\r
      \r
      */\r
     public Vector<ModuleIdentification> getAllModules() {\r
@@ -161,17 +222,14 @@ public class WorkspaceTools {
                     vModuleList.addElement(new ModuleIdentification(id, vPackageList.elementAt(indexI)));\r
                 } catch (IOException e) {\r
                     Log.err("Open Module Surface Area " + modulePath, e.getMessage());\r
-                    e.printStackTrace();\r
                 } catch (XmlException e) {\r
                     Log.err("Open Module Surface Area " + modulePath, e.getMessage());\r
-                    e.printStackTrace();\r
                 } catch (Exception e) {\r
                     Log.err("Open Module Surface Area " + modulePath, "Invalid file type");\r
-                    e.printStackTrace();\r
                 }\r
             }\r
         }\r
-\r
+        Tools.sortModules(vModuleList, DataType.SORT_TYPE_ASCENDING);\r
         return vModuleList;\r
     }\r
 \r
@@ -196,15 +254,13 @@ public class WorkspaceTools {
                 vPlatformList.addElement(new PlatformIdentification(id));\r
             } catch (IOException e) {\r
                 Log.err("Open Platform Surface Area " + path, e.getMessage());\r
-                e.printStackTrace();\r
             } catch (XmlException e) {\r
                 Log.err("Open Platform Surface Area " + path, e.getMessage());\r
-                e.printStackTrace();\r
             } catch (Exception e) {\r
                 Log.err("Open Platform Surface Area " + path, "Invalid file type");\r
-                e.printStackTrace();\r
             }\r
         }\r
+        Tools.sortPlatforms(vPlatformList, DataType.SORT_TYPE_ASCENDING);\r
         return vPlatformList;\r
     }\r
 \r
@@ -222,6 +278,7 @@ public class WorkspaceTools {
                 }\r
             }\r
         }\r
+        Tools.sortVectorString(vector, DataType.SORT_TYPE_ASCENDING);\r
         return vector;\r
     }\r
 \r
@@ -239,6 +296,7 @@ public class WorkspaceTools {
                 }\r
             }\r
         }\r
+        Tools.sortVectorString(vector, DataType.SORT_TYPE_ASCENDING);\r
         return vector;\r
     }\r
 \r
@@ -256,6 +314,7 @@ public class WorkspaceTools {
                 }\r
             }\r
         }\r
+        Tools.sortVectorString(vector, DataType.SORT_TYPE_ASCENDING);\r
         return vector;\r
     }\r
 \r
@@ -273,6 +332,7 @@ public class WorkspaceTools {
                 }\r
             }\r
         }\r
+        Tools.sortVectorString(vector, DataType.SORT_TYPE_ASCENDING);\r
         return vector;\r
     }\r
 \r
@@ -290,6 +350,7 @@ public class WorkspaceTools {
                 }\r
             }\r
         }\r
+        Tools.sortVectorString(vector, DataType.SORT_TYPE_ASCENDING);\r
         return vector;\r
     }\r
 \r
@@ -311,15 +372,13 @@ public class WorkspaceTools {
                 }\r
             } catch (IOException e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             } catch (XmlException e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             } catch (Exception e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             }\r
         }\r
+        Tools.sortVectorString(vector, DataType.SORT_TYPE_ASCENDING);\r
         return vector;\r
     }\r
 \r
@@ -339,15 +398,13 @@ public class WorkspaceTools {
                 }\r
             } catch (IOException e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             } catch (XmlException e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             } catch (Exception e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             }\r
         }\r
+        Tools.sortVectorString(vector, DataType.SORT_TYPE_ASCENDING);\r
         return vector;\r
     }\r
 \r
@@ -367,15 +424,13 @@ public class WorkspaceTools {
                 }\r
             } catch (IOException e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             } catch (XmlException e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             } catch (Exception e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             }\r
         }\r
+        Tools.sortVectorString(vector, DataType.SORT_TYPE_ASCENDING);\r
         return vector;\r
     }\r
 \r
@@ -395,15 +450,13 @@ public class WorkspaceTools {
                 }\r
             } catch (IOException e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             } catch (XmlException e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             } catch (Exception e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             }\r
         }\r
+        Tools.sortVectorString(vector, DataType.SORT_TYPE_ASCENDING);\r
         return vector;\r
     }\r
 \r
@@ -423,15 +476,13 @@ public class WorkspaceTools {
                 }\r
             } catch (IOException e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             } catch (XmlException e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             } catch (Exception e) {\r
                 // TODO Auto-generated catch block\r
-                e.printStackTrace();\r
             }\r
         }\r
+        Tools.sortVectorString(vector, DataType.SORT_TYPE_ASCENDING);\r
         return vector;\r
     }\r
 \r
@@ -466,11 +517,11 @@ public class WorkspaceTools {
                         return vPackageList.elementAt(indexI);\r
                     }\r
                 } catch (IOException e) {\r
-                    e.printStackTrace();\r
+\r
                 } catch (XmlException e) {\r
-                    e.printStackTrace();\r
+                \r
                 } catch (Exception e) {\r
-                    e.printStackTrace();\r
+\r
                 }\r
             }\r
         }\r
@@ -583,7 +634,7 @@ public class WorkspaceTools {
      @throws Exception\r
      \r
      **/\r
-    public Vector<String> getAllModuleFiles(String path) throws IOException, XmlException, Exception {\r
+    public Vector<String> getAllModuleFilesPath(String path) throws IOException, XmlException, Exception {\r
         Vector<String> v = new Vector<String>();\r
         path = Tools.convertPathToCurrentOsType(path);\r
         v.addElement(path);\r
@@ -615,7 +666,7 @@ public class WorkspaceTools {
      @throws Exception\r
      \r
      **/\r
-    public Vector<String> getAllPakcageFiles(String path) throws IOException, XmlException, Exception {\r
+    public Vector<String> getAllPakcageFilesPath(String path) throws IOException, XmlException, Exception {\r
         Vector<String> v = new Vector<String>();\r
         path = Tools.convertPathToCurrentOsType(path);\r
         //\r
@@ -624,17 +675,25 @@ public class WorkspaceTools {
         v.addElement(path);\r
         \r
         //\r
-        // Add module's files one by one\r
+        // Add the package's industry std includes one by one\r
         //\r
         Vector<String> f1 = new Vector<String>();\r
+        f1 = getAllIndustryStdIncludesOfPackage(path);\r
+        for (int index = 0; index < f1.size(); index++) {\r
+            v.addElement(f1.get(index));\r
+        }\r
+        \r
+        //\r
+        // Add module's files one by one\r
+        //\r
+        f1 = new Vector<String>();\r
         f1 = getAllModulesOfPackage(path);\r
         for (int indexI = 0; indexI < f1.size(); indexI++) {\r
-            Vector<String> f2 = getAllModuleFiles(f1.get(indexI));\r
+            Vector<String> f2 = getAllModuleFilesPath(f1.get(indexI));\r
             for (int indexJ = 0; indexJ < f2.size(); indexJ++) {\r
                 v.addElement(f2.get(indexJ));\r
             }\r
         }\r
-        //v.add(0, path);\r
 \r
         return v;\r
     }\r