Initial import.

[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / global / Spd.java

/** @file\r
 Spd class.\r
\r
 This class is to generate a global table for the content of spd file.\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.build.global;\r
import java.util.HashMap;\r
import java.util.List;\r
import java.util.Map;\r
\r
import org.tianocore.PackageSurfaceAreaDocument;\r
import org.tianocore.GuidDeclarationsDocument.GuidDeclarations;\r
import org.tianocore.IncludeHeaderDocument.IncludeHeader;\r
import org.tianocore.LibraryClassDeclarationDocument.LibraryClassDeclaration;\r
import org.tianocore.LibraryClassDeclarationsDocument.LibraryClassDeclarations;\r
import org.tianocore.PackageHeadersDocument.PackageHeaders;\r
import org.tianocore.PackageSurfaceAreaDocument.PackageSurfaceArea;\r
import org.tianocore.PpiDeclarationsDocument.PpiDeclarations;\r
import org.tianocore.ProtocolDeclarationsDocument.ProtocolDeclarations;\r
\r
/**\r
 \r
  This class is to generate a global table for the content of spd file.\r
  \r
**/\r
public class Spd {\r
    ///\r
    /// Map of module name and package it belongs to.\r
    /// Key : Module BaseName\r
    /// Value: Relative Path to Package\r
    ///\r
    Map<String, String[]> msaInfo = new HashMap<String, String[]>();\r
\r
    ///\r
    /// Map of module info. \r
    /// Key : moduletype\r
    /// Value: moduletype related include file\r
    ///\r
    Map<String, String> moduleInfo = new HashMap<String, String>();\r
\r
    ///\r
    /// Map of PPI info.\r
    /// Key : PPI name\r
    /// value: String[] a. PPI C_NAME; b. PPI GUID;\r
    ///\r
    Map<String, String[]> ppiInfo = new HashMap<String, String[]>();\r
\r
    ///\r
    /// Map of Protocol info.\r
    /// Key : Protocol name\r
    /// value: String[] a. Protocol C_NAME; b. Protocol GUID;\r
    ///\r
    Map<String, String[]> protocolInfo = new HashMap<String, String[]>();\r
\r
    ///\r
    /// Map of Guid info.\r
    /// Key : Guid name\r
    /// value: String[] a. Guid C_NAME; b. Guid's GUID;\r
    ///\r
    Map<String, String[]> guidInfo = new HashMap<String, String[]>();\r
\r
\r
    ///\r
    /// Map of library class and its exposed header file.\r
    /// Key : library class name\r
    /// value : library class corresponding header file\r
    ///\r
    Map<String, String> libClassHeaderList = new HashMap<String, String>();\r
\r
    ///\r
    /// Package path.\r
    ///\r
    String packagePath = null;\r
\r
    /**\r
      Constructor function\r
      \r
      This function mainly initialize some member variables. \r
   \r
      @param spdDoc      Handle of spd document.\r
      @param spdPath     Path of spd file.\r
     **/\r
    Spd (PackageSurfaceAreaDocument spdDoc, String spdPath) {\r
\r
        PackageSurfaceArea spd = spdDoc.getPackageSurfaceArea();\r
        this.packagePath = spdPath;\r
\r
        GuidDeclarations spdGuidInfo = spd.getGuidDeclarations();\r
        genGuidInfoList(spdGuidInfo);\r
\r
        PpiDeclarations spdPpiInfo = spd.getPpiDeclarations();\r
        genPpiInfoList(spdPpiInfo);\r
\r
        ProtocolDeclarations spdProtocolInfo = spd.getProtocolDeclarations();\r
        genProtocolInfoList(spdProtocolInfo);\r
\r
        LibraryClassDeclarations spdLibClassDeclare = spd\r
                        .getLibraryClassDeclarations();\r
        genLibClassDeclare(spdLibClassDeclare);\r
\r
        PackageHeaders spdPackageHeaderInfo = spd.getPackageHeaders();\r
        genModuleInfoList(spdPackageHeaderInfo);\r
\r
    }\r
\r
    /**\r
      genModuleInfoList\r
      \r
      This function is to generate Module info map.\r
      \r
      @param packageHeader   The information of packageHeader which descripted\r
                             in spd file.    \r
    **/\r
    public void genModuleInfoList(PackageHeaders packageHeader) {\r
\r
        if (packageHeader != null) {\r
            List<IncludeHeader> headerList = packageHeader.getIncludeHeaderList();\r
            for (int i = 0; i < headerList.size(); i++) {\r
                try {\r
                    this.moduleInfo\r
                                    .put(headerList.get(i).getModuleType()\r
                                                    .toString(), headerList.get(i)\r
                                                    .getStringValue());\r
                } catch (Exception e) {\r
                    System.out\r
                                    .print("can't find ModuleHeaders ModuleType & includeHeader!\n");\r
                }\r
            }\r
        }\r
    }\r
\r
  /**\r
    genPpiInfoList\r
    \r
    This function is to generate Ppi info map.\r
    \r
    @param  ppiInfo           The information of PpiDeclarations which descripted\r
                              in spd file.    \r
  **/\r
    public void genPpiInfoList(PpiDeclarations ppiInfo) {\r
        String[] cNameGuid = new String[2];\r
\r
        if (ppiInfo != null) {\r
            List<PpiDeclarations.Entry> ppiEntryList = ppiInfo.getEntryList();\r
            for (int i = 0; i < ppiEntryList.size(); i++) {\r
                try {\r
                    cNameGuid[0] = ppiEntryList.get(i).getCName();\r
                    cNameGuid[1] = formatGuidName(ppiEntryList.get(i)\r
                                    .getGuid().getStringValue());\r
                    this.ppiInfo.put(ppiEntryList.get(i).getName(), new String[] {\r
                                    cNameGuid[0], cNameGuid[1] });\r
                } catch (Exception e) {\r
                    System.out\r
                                    .print("can't find GuidDeclarations C_Name & Guid!\n");\r
                }\r
            }\r
        }\r
    }\r
\r
    /**\r
      genProtocolInfoList \r
      \r
      This function is to generate Protocol info map.\r
      \r
      @param   proInfo    The information of ProtocolDeclarations which \r
                          descripted in spd file.\r
    **/\r
    public void genProtocolInfoList(ProtocolDeclarations proInfo) {\r
        String[] cNameGuid = new String[2];\r
        if (proInfo != null) {\r
            List<ProtocolDeclarations.Entry> protocolEntryList = proInfo.getEntryList();\r
            for (int i = 0; i < protocolEntryList.size(); i++) {\r
                try {\r
                    cNameGuid[0] = protocolEntryList.get(i).getCName();\r
                    cNameGuid[1] = formatGuidName(protocolEntryList.get(i)\r
                                    .getGuid().getStringValue());\r
\r
                    String temp = new String(protocolEntryList.get(i).getName());\r
                    this.protocolInfo.put(temp, new String[] { cNameGuid[0],\r
                                    cNameGuid[1] });\r
                } catch (Exception e) {\r
                    System.out\r
                                    .print("can't find ProtocolDeclarations C_Name & Guid!\n");\r
                }\r
            }\r
        }\r
    }\r
\r
    /**\r
      genGuidInfoList\r
      \r
      This function is to generate GUID inf map.\r
      \r
      @param guidInfo     The information of GuidDeclarations which descripted\r
                          in spd file.\r
      \r
    **/\r
    public void genGuidInfoList(GuidDeclarations guidInfo) {\r
        String[] cNameGuid = new String[2];\r
        if (guidInfo != null) {\r
            \r
            List<GuidDeclarations.Entry> guidEntryList = guidInfo.getEntryList();\r
            for (int i = 0; i < guidEntryList.size(); i++) {\r
                cNameGuid[0] = guidEntryList.get(i).getCName();\r
                cNameGuid[1] = formatGuidName(guidEntryList.get(i)\r
                                .getGuid().getStringValue());\r
                this.guidInfo.put(guidEntryList.get(i).getName(), new String[] {\r
                                cNameGuid[0], cNameGuid[1] });\r
            }\r
        }\r
    }\r
\r
    /**\r
      genLibClassDeclare\r
      \r
      This function is to generate the libClassHeader list.\r
      \r
      @param libClassDeclares  The information of LibraryClassDeclarations which\r
                               descripted in spd file.\r
    **/\r
    public void genLibClassDeclare(LibraryClassDeclarations libClassDeclares) {\r
        if (libClassDeclares != null && libClassDeclares.getLibraryClassDeclarationList() != null) {\r
            if (libClassDeclares.getLibraryClassDeclarationList().size() > 0) {\r
                List<LibraryClassDeclaration> libDeclareList = libClassDeclares.getLibraryClassDeclarationList();\r
                for (int i = 0; i < libDeclareList.size(); i++) {\r
                    libClassHeaderList.put(libDeclareList.get(i).getLibraryClass()\r
                                    .getStringValue(), libDeclareList.get(i)\r
                                    .getIncludeHeader().getStringValue());\r
                }\r
            }\r
        }\r
    }\r
\r
    /**\r
      getPpiGuid\r
      \r
      This function is to get ppi GUID according ppi name.\r
    \r
      @param   ppiStr    Name of ppi.\r
      @return            PPi's GUID.\r
    **/\r
    public String getPpiGuid(String ppiStr) {\r
        if (ppiInfo.get(ppiStr) != null) {\r
            return ppiInfo.get(ppiStr)[1];\r
        } else {\r
            return null;\r
        }\r
\r
    }\r
\r
    /**\r
      getPpiCnameGuidArray\r
      \r
      This function is to get the ppi CName and it's GUID according to ppi name.\r
      \r
      @param   ppiName      Name of ppi.\r
      @return               Ppi CName and it's GUID.\r
    **/\r
    public String[] getPpiCnameGuidArray(String ppiName) {\r
        return this.ppiInfo.get(ppiName);\r
    }\r
\r
    /**\r
      getProtocolGuid\r
      \r
      This function is to get the protocol GUID according to protocol's name.\r
      \r
      @param   protocolStr    Name of protocol.\r
      @return                 Protocol's GUID.\r
    **/\r
    public String getProtocolGuid(String protocolStr) {\r
        if (protocolInfo.get(protocolStr) != null) {\r
            return this.protocolInfo.get(protocolStr)[0];\r
        } else {\r
            return null;\r
        }\r
    }\r
\r
    /**\r
      getProtocolNameGuidArray\r
      \r
      This function is to get the protocol's CName ant it's GUID according to\r
      protocol's namej.\r
      \r
      @param  protocolName   Name of protocl.\r
      @return                Protocol's CName and it's GUID.\r
    **/\r
    public String[] getProtocolNameGuidArray(String protocolName) {\r
        return this.protocolInfo.get(protocolName);\r
    }\r
\r
    /**\r
      getGUIDGuid\r
      \r
      This function is to get the GUID according to GUID's name\r
      \r
      @param  guidStr        Name of GUID\r
      @return                GUID.\r
    **/\r
    public String getGUIDGuid(String guidStr) {\r
        if (guidInfo.get(guidStr) != null) {\r
            return guidInfo.get(guidStr)[1];\r
        } else {\r
            return null;\r
        }\r
\r
    }\r
\r
    /**\r
      getGuidNameArray\r
      \r
      This function is to get the GUID's CName and it's GUID according to \r
      GUID's name\r
      \r
      @param   guidName     Name of GUID\r
      @return               CName and GUID.\r
    **/\r
    public String[] getGuidNameArray(String guidName) {\r
        return this.guidInfo.get(guidName);\r
    }\r
\r
    /**\r
      getLibClassInclude \r
      \r
      This function is to get the library exposed header file name according \r
      library class name.\r
      \r
      @param     libName    Name of library class   \r
      @return               Name of header file\r
    **/\r
    String getLibClassIncluder(String libName) {\r
        return libClassHeaderList.get(libName);\r
    }\r
\r
    /**\r
      getModuleTypeIncluder\r
      \r
      This function is to get the header file name from module info map \r
      according to module type.\r
     \r
      @param   moduleType    Module type.\r
      @return                Name of header file.\r
    **/\r
    String getModuleTypeIncluder(String moduleType) {\r
        return moduleInfo.get(moduleType);\r
    }\r
\r
    /**\r
      formateGuidName\r
      \r
      This function is to formate GUID to ANSI c form.\r
     \r
      @param  guidNameCon      String of GUID.\r
      @return                  Formated GUID.\r
    **/\r
    public static String formatGuidName (String guidNameConv) {\r
        String[] strList;\r
        String guid = "";\r
        int index = 0;\r
        if (guidNameConv\r
                        .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}")) {\r
            strList = guidNameConv.split("-");\r
            guid = "0x" + strList[0] + ", ";\r
            guid = guid + "0x" + strList[1] + ", ";\r
            guid = guid + "0x" + strList[2] + ", ";\r
            guid = guid + "{";\r
            guid = guid + "0x" + strList[3].substring(0, 2) + ", ";\r
            guid = guid + "0x" + strList[3].substring(2, 4);\r
\r
            while (index < strList[4].length()) {\r
                guid = guid + ", ";\r
                guid = guid + "0x" + strList[4].substring(index, index + 2);\r
                index = index + 2;\r
            }\r
            guid = guid + "}";\r
            return guid;\r
        } else if (guidNameConv\r
                        .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}( )*(\\})?")) {\r
            strList = guidNameConv.split(",");\r
            \r
            //\r
            // chang Microsoft specific form to ANSI c form\r
            //\r
            for (int i = 0; i < 3; i++){\r
                guid = guid + strList[i] + ",";\r
            }\r
            guid = guid + "{";\r
            \r
            for (int i = 3; i < strList.length; i++){\r
                if (i == strList.length - 1){\r
                    guid = guid + strList[i];\r
                } else {\r
                    guid = guid + strList[i] + ",";\r
                }\r
            }\r
            guid = guid + "}";            \r
            return guid;\r
        } else {\r
            System.out.println("Check GUID Value, it don't conform to the schema!!!");\r
            return "0";\r
\r
        }\r
    }\r
}\r