fix some minor warning

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

/**@file\r
 AutogenLibOrder class.\r
\r
 This class is to reorder library instance sequence according to library \r
 dependence.\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.autogen;\r
\r
import java.util.ArrayList;\r
import java.util.HashMap;\r
import java.util.Iterator;\r
import java.util.LinkedList;\r
import java.util.List;\r
import java.util.Map;\r
import java.util.Stack;\r
import java.util.HashSet;\r
\r
import org.apache.xmlbeans.XmlObject;\r
import org.tianocore.build.exception.AutoGenException;\r
import org.tianocore.build.global.GlobalData;\r
import org.tianocore.build.global.SurfaceAreaQuery;\r
import org.tianocore.build.id.ModuleIdentification;\r
import org.tianocore.common.exception.EdkException;\r
import org.tianocore.common.logger.EdkLog;\r
/**\r
  This class This class is to reorder library instance sequence according to\r
  library dependence.\r
**/\r
public class AutogenLibOrder {\r
    ///\r
    /// The map of library class and its library instance.\r
    ///\r
    private Map<String, ModuleIdentification> libClassMap = new HashMap<String, ModuleIdentification>();\r
\r
    ///\r
    /// The map of library instance and its implemet libraryClass.\r
    ///\r
    private Map<ModuleIdentification, String[]> libInstanceMap = new HashMap<ModuleIdentification, String[]>();\r
\r
    ///\r
    /// List of library instance. It is String[3] list, String[0] is libraryName,\r
    /// String[1] is libraryConstructor name, String[2] is libDestructor name.\r
    ///\r
    private List<LibraryInstanceNode> libInstanceList = new ArrayList<LibraryInstanceNode>();\r
    \r
    /**\r
      Constructor function\r
    \r
      This function mainly initialize some member variable.\r
     \r
      @param  libraryList   List of the library instance.\r
      @throws Exception\r
    **/\r
    AutogenLibOrder(ModuleIdentification[] libraryList, String arch) throws EdkException {\r
        LibraryInstanceNode libInstanceNode;\r
        String[]       libClassDeclList = null;\r
        String[]       libClassConsmList = null;\r
        \r
        for (int i = 0; i < libraryList.length; i++) {\r
            //\r
            // Add libraryInstance in to libInstanceList.\r
            // \r
            Map<String, XmlObject> libDoc = GlobalData.getDoc(libraryList[i], arch);\r
            SurfaceAreaQuery saq = new SurfaceAreaQuery(libDoc);\r
            libInstanceNode = new LibraryInstanceNode (libraryList[i],saq.getLibConstructorName(), saq.getLibDestructorName());\r
            libInstanceList.add(libInstanceNode);\r
            \r
            //\r
            // Add library instance and consumed library class list to\r
            // libInstanceMap.\r
            //\r
            libClassConsmList = saq.getLibraryClasses(CommonDefinition.ALWAYSCONSUMED, arch);\r
            if (libClassConsmList != null) {\r
                String[] classStr = new String[libClassConsmList.length];\r
                for (int k = 0; k < libClassConsmList.length; k++) {\r
                    classStr[k] = libClassConsmList[k];\r
                }\r
                if (this.libInstanceMap.containsKey(libraryList[i])) {\r
                    throw new AutoGenException(\r
                            libraryList[i].getName()\r
                                    + "-- this library instance already exists, please check the library instance list!");\r
                } else {\r
                    this.libInstanceMap.put(libraryList[i], classStr);\r
                }\r
            }\r
\r
            //\r
            // Add library class and library instance map.\r
            //\r
            libClassDeclList = saq.getLibraryClasses(CommonDefinition.ALWAYSPRODUCED, arch);\r
            if (libClassDeclList != null) {\r
                for (int j = 0; j < libClassDeclList.length; j++) {\r
                    if (this.libClassMap.containsKey(libClassDeclList[j])) {\r
                        EdkLog.log(EdkLog.EDK_ERROR,libClassDeclList[j]\r
                                + " class is already implement by "\r
                                + this.libClassMap.get(libClassDeclList[j]));\r
                        throw new AutoGenException("Library Class: " + libClassDeclList\r
                                + " already has a library instance!");\r
                    } else {\r
                        this.libClassMap.put(libClassDeclList[j], libraryList[i]);\r
                    }\r
                }\r
            }\r
        }\r
    }\r
\r
    /**\r
      orderLibInstance\r
      \r
      This function reorder the library instance according the library class \r
      dependency.\r
      \r
      @return     List which content the ordered library instance.\r
    **/\r
    List<ModuleIdentification> orderLibInstance() {\r
        LinkedList<ModuleIdentification> orderList = new LinkedList<ModuleIdentification>();\r
        for (int i = 0; i < libInstanceList.size(); ++i) {\r
            ModuleIdentification current = libInstanceList.get(i).libId;\r
            int insertPoint = orderList.size();\r
            //\r
            // check current library instance against orderred ones in orderList\r
            // \r
            for (int j = 0; j < orderList.size(); ++j) {\r
                ModuleIdentification old = orderList.get(j);\r
                if (consumes(current, old)) {\r
                    //\r
                    // if current library instance consumes the one in orderList\r
                    // it must be put after\r
                    // \r
                    insertPoint = j + 1;\r
                } else if (consumes(old, current)) {\r
                    //\r
                    // if current library instance is consumed by the one in orderList\r
                    // it must be put before. And no further check is needed.\r
                    // \r
                    insertPoint = j;\r
                    break;\r
                }\r
            }\r
            orderList.add(insertPoint, current);\r
        }\r
\r
        return orderList;\r
    }\r
\r
    //\r
    // Test if one library consumes another library\r
    // \r
    private boolean consumes(ModuleIdentification lib1, ModuleIdentification lib2) {\r
        LinkedList<ModuleIdentification> stack = new LinkedList<ModuleIdentification>();\r
\r
        stack.add(lib1);\r
        int j = 0;\r
        while (j < stack.size()) {\r
            //\r
            // get the last library instance in stack, which hasn't been checked\r
            // \r
            ModuleIdentification lib = stack.get(j++);\r
            //\r
            // get the library classes consumed by it\r
            // \r
            String[] consumedClasses = libInstanceMap.get(lib);\r
            for (int i = 0; i < consumedClasses.length; ++i) {\r
                //\r
                // for each library class, find its corresponding library instance\r
                // \r
                ModuleIdentification consumedLib = libClassMap.get(consumedClasses[i]);\r
                //\r
                // if the corresponding instance is the "lib2", we can say that\r
                // "lib1"  consumes "lib2"\r
                // \r
                if (consumedLib == lib2) {\r
                    EdkLog.log(EdkLog.EDK_DEBUG, lib1 + "\n   consumes\n" + lib2 + "\n");\r
                    return true;\r
                }\r
                //\r
                // otherwise, we put it back into the stack to check it later\r
                // to see if it consumes "lib2" or not. If the library instance\r
                // consumed by "lib1" consumes "lib2", we can also say that "lib1"\r
                // consumes "lib2"\r
                // \r
                if (consumedLib != null && !stack.contains(consumedLib)) {\r
                    stack.offer(consumedLib);\r
                } else if (consumedLib == lib1) {\r
                    //\r
                    // found circular consume, do nothing now but just print\r
                    // out message for debugging\r
                    // \r
                    String msg = "!!! Library consumes circularly: ";\r
                    for (int k = 0; k < j; k++) {\r
                        msg += stack.get(k).getName() + "->";\r
                    }\r
                    msg += lib1.getName();\r
                    EdkLog.log(EdkLog.EDK_DEBUG, msg);\r
                }\r
            }\r
        }\r
        return false;\r
    }\r
\r
    /**\r
      isInLibInstance\r
    \r
      This function check does the library instance already in the list.\r
    \r
      @param list             List of the library instance.\r
      @param instanceName     Name of library instance.\r
      @return                 "true" the library instance in list |\r
                              "false" the library instance is not in list.\r
    **/\r
    private boolean isInLibInstance(List<ModuleIdentification> list, ModuleIdentification instanceId) {\r
        for (int i = 0; i < list.size(); i++) {\r
            \r
            if (instanceId.equals(list.get(i))) {\r
                return true;\r
            }\r
        }\r
        return false;\r
    }\r
\r
    /**\r
      isInStackList \r
      \r
      This function check if the node already in the stack.\r
       \r
      @param list        Stack.\r
      @param nodeName    Name of node.\r
      @return            "true" if node have in stack |\r
                         "false" if node don't in stack.\r
    **/ \r
    private boolean isInStackList(List<Node> list, ModuleIdentification instanceId) {\r
        for (int i = 0; i < list.size(); i++) {\r
            if (instanceId.equals(list.get(i).nodeId)) {\r
                return true;\r
            }\r
        }\r
        return false;\r
    }\r
    \r
    /**\r
      isHaveConsDestructor\r
      \r
      This function check if the library have constructor or destructor \r
      function.\r
      \r
      @param  libName    Name of library\r
      @return            "true" if library have constructor or desconstructor |\r
                         "false" if library don't have constructor \r
                         and desconstructor.\r
    **/\r
    private boolean isHaveConsDestructor (ModuleIdentification libNode){\r
        for (int i = 0; i < libInstanceList.size(); i++){\r
            if (libInstanceList.get(i).libId.equals(libNode)){\r
                if (libInstanceList.get(i).constructorName != null || libInstanceList.get(i).deconstructorName != null){\r
                    return true;\r
                }\r
            }\r
        }\r
        return false;\r
    }\r
}\r
\r
/**\r
  Node \r
 \r
  This class is used as stack node.\r
 \r
 **/\r
class Node {\r
    ModuleIdentification nodeId;\r
\r
    boolean isVisit;\r
\r
    Node(ModuleIdentification nodeId, boolean isVisit) {\r
        this.nodeId = nodeId;\r
        this.isVisit = false;\r
    }\r
}  \r
/**\r
  LibraryInstance Node   \r
  \r
  This class is used to store LibrayInstance and it's deconstructor and constructor\r
**/\r
    \r
class LibraryInstanceNode {\r
    ModuleIdentification libId;\r
    String deconstructorName;\r
    String constructorName;\r
    \r
    LibraryInstanceNode (ModuleIdentification libId, String deconstructor, String constructor){\r
        this.libId = libId;\r
        this.deconstructorName = deconstructor;\r
        this.constructorName   = constructor;\r
    }\r
}\r