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

/** @file\r
\r
 The file is used to init workspace and get basic information of workspace\r
 \r
 Copyright (c) 2006, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
package org.tianocore.frameworkwizard.workspace;\r
\r
import java.io.IOException;\r
import java.util.Vector;\r
\r
import org.apache.xmlbeans.XmlException;\r
import org.tianocore.DbPathAndFilename;\r
import org.tianocore.FrameworkDatabaseDocument;\r
import org.tianocore.ModuleSurfaceAreaDocument.ModuleSurfaceArea;\r
import org.tianocore.MsaFilesDocument.MsaFiles;\r
import org.tianocore.MsaHeaderDocument.MsaHeader;\r
import org.tianocore.PackageSurfaceAreaDocument.PackageSurfaceArea;\r
import org.tianocore.PlatformHeaderDocument.PlatformHeader;\r
import org.tianocore.PlatformSurfaceAreaDocument.PlatformSurfaceArea;\r
import org.tianocore.SourceFilesDocument.SourceFiles;\r
import org.tianocore.SpdHeaderDocument.SpdHeader;\r
import org.tianocore.frameworkwizard.common.DataType;\r
import org.tianocore.frameworkwizard.common.Log;\r
import org.tianocore.frameworkwizard.common.SaveFile;\r
import org.tianocore.frameworkwizard.common.Tools;\r
import org.tianocore.frameworkwizard.common.Identifications.Identification;\r
import org.tianocore.frameworkwizard.common.Identifications.OpenFile;\r
import org.tianocore.frameworkwizard.module.Identifications.ModuleIdentification;\r
import org.tianocore.frameworkwizard.packaging.PackageIdentification;\r
import org.tianocore.frameworkwizard.platform.PlatformIdentification;\r
\r
public class WorkspaceTools {\r
    //\r
    // Define class members\r
    //\r
    private FrameworkDatabaseDocument.FrameworkDatabase fdb = null;\r
\r
    private Vector<ModuleIdentification> vModuleList = new Vector<ModuleIdentification>();\r
\r
    private Vector<PackageIdentification> vPackageList = new Vector<PackageIdentification>();\r
\r
    private Vector<PlatformIdentification> vPlatformList = new Vector<PlatformIdentification>();\r
\r
    /**\r
     \r
     Open Framework Database file\r
     \r
     */\r
    private void openFrameworkDb() {\r
        String strFrameworkDbFilePath = Workspace.getCurrentWorkspace() + Workspace.getStrWorkspaceDatabaseFile();\r
        strFrameworkDbFilePath = Tools.convertPathToCurrentOsType(strFrameworkDbFilePath);\r
        try {\r
            fdb = OpenFile.openFrameworkDb(strFrameworkDbFilePath);\r
        } catch (XmlException e) {\r
            Log.err("Open Framework Database " + strFrameworkDbFilePath, e.getMessage());\r
            return;\r
        } catch (Exception e) {\r
            Log.err("Open Framework Database " + strFrameworkDbFilePath, "Invalid file type");\r
            return;\r
        }\r
    }\r
\r
    /**\r
     Get all modules' paths from one package\r
     \r
     @return a Vector with all modules' path\r
     \r
     **/\r
    public Vector<String> getAllModulesOfPackage(String path) {\r
        Vector<String> modulePath = new Vector<String>();\r
        try {\r
            MsaFiles files = OpenFile.openSpdFile(path).getMsaFiles();\r
            if (files != null) {\r
                for (int index = 0; index < files.getFilenameList().size(); index++) {\r
                    String msaPath = files.getFilenameList().get(index);\r
                    msaPath = Tools.addFileSeparator(Tools.getFilePathOnly(path)) + msaPath;\r
                    msaPath = Tools.convertPathToCurrentOsType(msaPath);\r
                    modulePath.addElement(msaPath);\r
                }\r
            }\r
        } catch (IOException e) {\r
            e.printStackTrace();\r
        } catch (XmlException e) {\r
            e.printStackTrace();\r
        } catch (Exception e) {\r
            e.printStackTrace();\r
        }\r
        return modulePath;\r
    }\r
\r
    /**\r
     Get all package basic information form the FrameworkDatabase.db file\r
     \r
     @return vPackageList A vector includes all packages' basic information\r
     \r
     */\r
    public Vector<PackageIdentification> getAllPackages() {\r
        Identification id = null;\r
        vPackageList.removeAllElements();\r
\r
        openFrameworkDb();\r
\r
        for (int index = 0; index < fdb.getPackageList().getFilenameList().size(); index++) {\r
            String path = Workspace.getCurrentWorkspace() + DataType.FILE_SEPARATOR\r
                          + fdb.getPackageList().getFilenameArray(index).getStringValue();\r
            path = Tools.convertPathToCurrentOsType(path);\r
            try {\r
                id = getId(path, OpenFile.openSpdFile(path));\r
                vPackageList.addElement(new PackageIdentification(id));\r
            } catch (IOException e) {\r
                Log.err("Open Package Surface Area " + path, e.getMessage());\r
                e.printStackTrace();\r
            } catch (XmlException e) {\r
                Log.err("Open Package Surface Area " + path, e.getMessage());\r
                e.printStackTrace();\r
            } catch (Exception e) {\r
                Log.err("Open Package Surface Area " + path, "Invalid file type");\r
                e.printStackTrace();\r
            }\r
        }\r
        return vPackageList;\r
    }\r
\r
    /**\r
     Get all package basic information form the FrameworkDatabase.db file\r
     \r
     @return vPackageList A vector includes all packages' basic information\r
     \r
     */\r
    public Vector<ModuleIdentification> getAllModules() {\r
        vModuleList.removeAllElements();\r
        //\r
        // First get all packages\r
        //\r
        getAllPackages();\r
        Vector<String> modulePaths = new Vector<String>();\r
        Identification id = null;\r
        String packagePath = null;\r
        String modulePath = null;\r
\r
        //\r
        // For each package, get all modules list\r
        //\r
        for (int indexI = 0; indexI < vPackageList.size(); indexI++) {\r
            packagePath = vPackageList.elementAt(indexI).getPath();\r
            modulePaths = this.getAllModulesOfPackage(packagePath);\r
            \r
            for (int indexJ = 0; indexJ < modulePaths.size(); indexJ++) {\r
                try {\r
                    modulePath = modulePaths.get(indexJ);\r
                    id = getId(modulePath, OpenFile.openMsaFile(modulePath));\r
                    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
        return vModuleList;\r
    }\r
\r
    /**\r
     Get all platform basic information form the FrameworkDatabase.db file\r
     \r
     @return vplatformList A vector includes all platforms' basic information\r
     \r
     */\r
    public Vector<PlatformIdentification> getAllPlatforms() {\r
        Identification id = null;\r
        vPlatformList.removeAllElements();\r
\r
        openFrameworkDb();\r
\r
        for (int index = 0; index < fdb.getPlatformList().getFilenameList().size(); index++) {\r
            String path = Workspace.getCurrentWorkspace() + DataType.FILE_SEPARATOR\r
                          + fdb.getPlatformList().getFilenameArray(index).getStringValue();\r
            path = Tools.convertPathToCurrentOsType(path);\r
            try {\r
                id = getId(path, OpenFile.openFpdFile(path));\r
                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
        return vPlatformList;\r
    }\r
\r
    /**\r
     Get all Library Class Definitions from a package\r
     \r
     @return Vector\r
     **/\r
    public Vector<String> getAllLibraryClassDefinitionsFromPackage(PackageSurfaceArea spd) {\r
        Vector<String> vector = new Vector<String>();\r
        if (spd.getLibraryClassDeclarations() != null) {\r
            if (spd.getLibraryClassDeclarations().getLibraryClassList().size() > 0) {\r
                for (int index = 0; index < spd.getLibraryClassDeclarations().getLibraryClassList().size(); index++) {\r
                    vector.addElement(spd.getLibraryClassDeclarations().getLibraryClassList().get(index).getName());\r
                }\r
            }\r
        }\r
        return vector;\r
    }\r
\r
    /**\r
     Get all Protocol Definitions from a package\r
     \r
     @return Vector\r
     **/\r
    public Vector<String> getAllProtocolDeclarationsFromPackage(PackageSurfaceArea spd) {\r
        Vector<String> vector = new Vector<String>();\r
        if (spd.getProtocolDeclarations() != null) {\r
            if (spd.getProtocolDeclarations().getEntryList().size() > 0) {\r
                for (int index = 0; index < spd.getProtocolDeclarations().getEntryList().size(); index++) {\r
                    vector.addElement(spd.getProtocolDeclarations().getEntryList().get(index).getCName());\r
                }\r
            }\r
        }\r
        return vector;\r
    }\r
\r
    /**\r
     Get all Ppi Definitions from a package\r
     \r
     @return Vector\r
     **/\r
    public Vector<String> getAllPpiDeclarationsFromPackage(PackageSurfaceArea spd) {\r
        Vector<String> vector = new Vector<String>();\r
        if (spd.getPpiDeclarations() != null) {\r
            if (spd.getPpiDeclarations().getEntryList().size() > 0) {\r
                for (int index = 0; index < spd.getPpiDeclarations().getEntryList().size(); index++) {\r
                    vector.addElement(spd.getPpiDeclarations().getEntryList().get(index).getCName());\r
                }\r
            }\r
        }\r
        return vector;\r
    }\r
\r
    /**\r
     Get all Guid Definitions from a package\r
     \r
     @return Vector\r
     **/\r
    public Vector<String> getAllGuidDeclarationsFromPackage(PackageSurfaceArea spd) {\r
        Vector<String> vector = new Vector<String>();\r
        if (spd.getGuidDeclarations() != null) {\r
            if (spd.getGuidDeclarations().getEntryList().size() > 0) {\r
                for (int index = 0; index < spd.getGuidDeclarations().getEntryList().size(); index++) {\r
                    vector.addElement(spd.getGuidDeclarations().getEntryList().get(index).getCName());\r
                }\r
            }\r
        }\r
        return vector;\r
    }\r
\r
    /**\r
     Get all Pcd Definitions from a package\r
     \r
     @return Vector\r
     **/\r
    public Vector<String> getAllPcdDeclarationsFromPackage(PackageSurfaceArea spd) {\r
        Vector<String> vector = new Vector<String>();\r
        if (spd.getPcdDeclarations() != null) {\r
            if (spd.getPcdDeclarations().getPcdEntryList().size() > 0) {\r
                for (int index = 0; index < spd.getPcdDeclarations().getPcdEntryList().size(); index++) {\r
                    vector.addElement(spd.getPcdDeclarations().getPcdEntryList().get(index).getCName());\r
                }\r
            }\r
        }\r
        return vector;\r
    }\r
\r
    public Vector<String> getAllLibraryClassDefinitionsFromWorkspace() {\r
        //\r
        // First get all packages\r
        //\r
        this.getAllPackages();\r
\r
        Vector<String> vector = new Vector<String>();\r
        for (int index = 0; index < this.vPackageList.size(); index++) {\r
            try {\r
                Vector<String> v = getAllLibraryClassDefinitionsFromPackage(OpenFile\r
                                                                                    .openSpdFile(vPackageList\r
                                                                                                             .get(index)\r
                                                                                                             .getPath()));\r
                if (v != null && v.size() > 0) {\r
                    vector.addAll(v);\r
                }\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
        return vector;\r
    }\r
\r
    public Vector<String> getAllProtocolDeclarationsFromWorkspace() {\r
        //\r
        // First get all packages\r
        //\r
        this.getAllPackages();\r
\r
        Vector<String> vector = new Vector<String>();\r
        for (int index = 0; index < this.vPackageList.size(); index++) {\r
            try {\r
                Vector<String> v = getAllProtocolDeclarationsFromPackage(OpenFile.openSpdFile(vPackageList.get(index)\r
                                                                                                          .getPath()));\r
                if (v != null && v.size() > 0) {\r
                    vector.addAll(v);\r
                }\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
        return vector;\r
    }\r
\r
    public Vector<String> getAllPpiDeclarationsFromWorkspace() {\r
        //\r
        // First get all packages\r
        //\r
        this.getAllPackages();\r
\r
        Vector<String> vector = new Vector<String>();\r
        for (int index = 0; index < this.vPackageList.size(); index++) {\r
            try {\r
                Vector<String> v = getAllPpiDeclarationsFromPackage(OpenFile.openSpdFile(vPackageList.get(index)\r
                                                                                                     .getPath()));\r
                if (v != null && v.size() > 0) {\r
                    vector.addAll(v);\r
                }\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
        return vector;\r
    }\r
\r
    public Vector<String> getAllGuidDeclarationsFromWorkspace() {\r
        //\r
        // First get all packages\r
        //\r
        this.getAllPackages();\r
\r
        Vector<String> vector = new Vector<String>();\r
        for (int index = 0; index < this.vPackageList.size(); index++) {\r
            try {\r
                Vector<String> v = getAllGuidDeclarationsFromPackage(OpenFile.openSpdFile(vPackageList.get(index)\r
                                                                                                      .getPath()));\r
                if (v != null && v.size() > 0) {\r
                    vector.addAll(v);\r
                }\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
        return vector;\r
    }\r
\r
    public Vector<String> getAllPcdDeclarationsFromWorkspace() {\r
        //\r
        // First get all packages\r
        //\r
        this.getAllPackages();\r
\r
        Vector<String> vector = new Vector<String>();\r
        for (int index = 0; index < this.vPackageList.size(); index++) {\r
            try {\r
                Vector<String> v = getAllPcdDeclarationsFromPackage(OpenFile.openSpdFile(vPackageList.get(index)\r
                                                                                                     .getPath()));\r
                if (v != null && v.size() > 0) {\r
                    vector.addAll(v);\r
                }\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
        return vector;\r
    }\r
\r
    /**\r
     Find a module's package's id\r
     \r
     @param id input module id\r
     @return package id\r
     \r
     **/\r
    public PackageIdentification getPackageIdByModuleId(Identification id) {\r
        getAllPackages();\r
        Vector<String> modulePaths = new Vector<String>();\r
        Identification mid = null;\r
        String packagePath = null;\r
        String modulePath = null;\r
\r
        //\r
        // For each package, get all modules list\r
        //\r
        for (int indexI = 0; indexI < vPackageList.size(); indexI++) {\r
            packagePath = vPackageList.elementAt(indexI).getPath();\r
            modulePaths = this.getAllModulesOfPackage(packagePath);\r
            for (int indexJ = 0; indexJ < modulePaths.size(); indexJ++) {\r
                modulePath = modulePaths.get(indexJ);\r
                try {\r
                    mid = getId(modulePath, OpenFile.openMsaFile(modulePath));\r
                    //\r
                    // Check id\r
                    //\r
                    if (mid.equals(id)) {\r
                        return vPackageList.elementAt(indexI);\r
                    }\r
                } catch (IOException e) {\r
                    e.printStackTrace();\r
                } catch (XmlException e) {\r
                    e.printStackTrace();\r
                } catch (Exception e) {\r
                    e.printStackTrace();\r
                }\r
            }\r
        }\r
\r
        return null;\r
    }\r
\r
    public Identification getId(String path, ModuleSurfaceArea msa) {\r
        MsaHeader head = msa.getMsaHeader();\r
        String name = head.getModuleName();\r
        String guid = head.getGuidValue();\r
        String version = head.getVersion();\r
        Identification id = new Identification(name, guid, version, path);\r
        return id;\r
    }\r
\r
    public Identification getId(String path, PackageSurfaceArea spd) {\r
        SpdHeader head = spd.getSpdHeader();\r
        String name = head.getPackageName();\r
        String guid = head.getGuidValue();\r
        String version = head.getVersion();\r
        Identification id = new Identification(name, guid, version, path);\r
        return id;\r
    }\r
\r
    public Identification getId(String path, PlatformSurfaceArea fpd) {\r
        PlatformHeader head = fpd.getPlatformHeader();\r
        String name = head.getPlatformName();\r
        String guid = head.getGuidValue();\r
        String version = head.getVersion();\r
        Identification id = new Identification(name, guid, version, path);\r
        return id;\r
    }\r
\r
    /**\r
     Add module information to package surface area\r
     \r
     @param mid\r
     @throws IOException\r
     @throws XmlException\r
     @throws Exception\r
     \r
     **/\r
    public void addModuleToPackage(ModuleIdentification mid, PackageSurfaceArea spd) throws IOException, XmlException,\r
                                                                                    Exception {\r
        String packagePath = mid.getPackageId().getPath();\r
        String modulePath = mid.getPath();\r
        if (spd == null) {\r
            spd = OpenFile.openSpdFile(packagePath);\r
        }\r
        MsaFiles msaFile = spd.getMsaFiles();\r
        if (msaFile == null) {\r
            msaFile = MsaFiles.Factory.newInstance();\r
        }\r
        packagePath = packagePath.substring(0, packagePath.lastIndexOf(DataType.FILE_SEPARATOR));\r
        String fn = Tools.getRelativePath(modulePath, packagePath);\r
        msaFile.addNewFilename();\r
        msaFile.setFilenameArray(msaFile.getFilenameList().size() - 1, fn);\r
        spd.setMsaFiles(msaFile);\r
        SaveFile.saveSpdFile(mid.getPackageId().getPath(), spd);\r
    }\r
\r
    /**\r
     Add input package into database\r
     \r
     @param id\r
     * @throws Exception \r
     \r
     **/\r
    public void addPackageToDatabase(PackageIdentification id) throws Exception {\r
        String path = id.getPath();\r
        path = Tools.getRelativePath(path, Workspace.getCurrentWorkspace());\r
        this.openFrameworkDb();\r
        DbPathAndFilename filename = DbPathAndFilename.Factory.newInstance();\r
        filename.setStringValue(path);\r
        fdb.getPackageList().addNewFilename();\r
        fdb.getPackageList().setFilenameArray(fdb.getPackageList().sizeOfFilenameArray() - 1, filename);\r
        String strFrameworkDbFilePath = Workspace.getCurrentWorkspace() + Workspace.getStrWorkspaceDatabaseFile();\r
        strFrameworkDbFilePath = Tools.convertPathToCurrentOsType(strFrameworkDbFilePath);\r
        SaveFile.saveDbFile(strFrameworkDbFilePath, fdb);\r
    }\r
\r
    /**\r
     Add input package into database\r
     \r
     @param id\r
     * @throws Exception \r
     \r
     **/\r
    public void addPlatformToDatabase(PlatformIdentification id) throws Exception {\r
        String path = id.getPath();\r
        path = Tools.getRelativePath(path, Workspace.getCurrentWorkspace());\r
        this.openFrameworkDb();\r
        DbPathAndFilename filename = DbPathAndFilename.Factory.newInstance();\r
        filename.setStringValue(path);\r
        fdb.getPlatformList().addNewFilename();\r
        fdb.getPlatformList().setFilenameArray(fdb.getPlatformList().sizeOfFilenameArray() - 1, filename);\r
        String strFrameworkDbFilePath = Workspace.getCurrentWorkspace() + Workspace.getStrWorkspaceDatabaseFile();\r
        strFrameworkDbFilePath = Tools.convertPathToCurrentOsType(strFrameworkDbFilePath);\r
        SaveFile.saveDbFile(strFrameworkDbFilePath, fdb);\r
    }\r
\r
    /**\r
     Get all file's path from one module\r
     \r
     @param path\r
     @return\r
     @throws IOException\r
     @throws XmlException\r
     @throws Exception\r
     \r
     **/\r
    public Vector<String> getAllModuleFiles(String path) throws IOException, XmlException, Exception {\r
        Vector<String> v = new Vector<String>();\r
        path = Tools.convertPathToCurrentOsType(path);\r
        v.addElement(path);\r
        ModuleSurfaceArea msa = OpenFile.openMsaFile(path);\r
        if (msa != null) {\r
            //\r
            // Get all files' path of a module\r
            //\r
            SourceFiles sf = msa.getSourceFiles();\r
            if (sf != null) {\r
                for (int index = 0; index < sf.getFilenameList().size(); index++) {\r
                    String temp = sf.getFilenameList().get(index).getStringValue();\r
                    temp = Tools.addFileSeparator(Tools.getFilePathOnly(path)) + temp;\r
                    v.addElement(Tools.convertPathToCurrentOsType(temp));\r
                }\r
            }\r
        }\r
\r
        return v;\r
    }\r
\r
    /**\r
     Get all file's path from one package\r
     \r
     @param path\r
     @return\r
     @throws IOException\r
     @throws XmlException\r
     @throws Exception\r
     \r
     **/\r
    public Vector<String> getAllPakcageFiles(String path) throws IOException, XmlException, Exception {\r
        Vector<String> v = new Vector<String>();\r
        path = Tools.convertPathToCurrentOsType(path);\r
        //\r
        // First add package\r
        //\r
        v.addElement(path);\r
        \r
        //\r
        // Add module's files one by one\r
        //\r
        Vector<String> 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
            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
}\r