BaseTools: skip updating temporary variable.

[mirror_edk2.git] / BaseTools / Source / Python / UPT / InventoryWs.py

## @file\r
# Inventory workspace's distribution package information.\r
#\r
# Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>\r
#\r
# This program and the accompanying materials are licensed and made available \r
# under the terms and conditions of the BSD License which accompanies this \r
# 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
Inventory workspace's distribution package information.\r
"""\r
##\r
# Import Modules\r
#\r
from sys import platform\r
from traceback import format_exc\r
from platform import python_version\r
\r
from Logger import StringTable as ST\r
from Logger.ToolError import FatalError\r
from Logger.ToolError import ABORT_ERROR\r
from Logger.ToolError import CODE_ERROR\r
import Logger.Log as Logger\r
\r
from Library import GlobalData\r
\r
## InventoryDistInstalled\r
#\r
# This method retrieves the installed distribution information from the internal UPT database\r
#\r
# @param  DataBase: the UPT database\r
#\r
def InventoryDistInstalled(DataBase):\r
    DistInstalled = DataBase.InventoryDistInstalled()\r
    \r
    #\r
    # find the max length for each item\r
    #\r
    DpNameStr = "DpName"\r
    DpGuidStr = "DpGuid"\r
    DpVerStr = "DpVer"\r
    DpOriginalNameStr = "DpOriginalName"\r
    MaxGuidlen = len(DpGuidStr)\r
    MaxVerlen = len(DpVerStr)\r
    MaxDpAliasFileNameLen = len(DpNameStr) \r
    MaxDpOrigFileNamelen = len(DpOriginalNameStr)\r
    \r
    for (DpGuid, DpVersion, DpOriginalName, DpAliasFileName) in DistInstalled:\r
        MaxGuidlen = max(MaxGuidlen, len(DpGuid))\r
        MaxVerlen = max(MaxVerlen, len(DpVersion))\r
        MaxDpAliasFileNameLen = max(MaxDpAliasFileNameLen, len(DpAliasFileName))\r
        MaxDpOrigFileNamelen = max(MaxDpOrigFileNamelen, len(DpOriginalName))\r
\r
    OutMsgFmt = "%-*s\t%-*s\t%-*s\t%-s"\r
    OutMsg = OutMsgFmt % (MaxDpAliasFileNameLen, \r
                          DpNameStr, \r
                          MaxGuidlen, \r
                          DpGuidStr, \r
                          MaxVerlen, \r
                          DpVerStr, \r
                          DpOriginalNameStr)\r
    Logger.Info(OutMsg)\r
    \r
    for (DpGuid, DpVersion, DpFileName, DpAliasFileName) in DistInstalled:\r
        OutMsg = OutMsgFmt % (MaxDpAliasFileNameLen, \r
                            DpAliasFileName, \r
                            MaxGuidlen, \r
                            DpGuid, \r
                            MaxVerlen, \r
                            DpVersion, \r
                            DpFileName)\r
        Logger.Info(OutMsg)\r
\r
## Tool entrance method\r
#\r
# This method mainly dispatch specific methods per the command line options.\r
# If no error found, return zero value so the caller of this tool can know\r
# if it's executed successfully or not.\r
#\r
# @param  Options: command Options\r
#\r
def Main(Options = None):\r
    if Options:\r
        pass\r
\r
    try:\r
        DataBase = GlobalData.gDB\r
        InventoryDistInstalled(DataBase)     \r
        ReturnCode = 0       \r
    except FatalError, XExcept:\r
        ReturnCode = XExcept.args[0]\r
        if Logger.GetLevel() <= Logger.DEBUG_9:\r
            Logger.Quiet(ST.MSG_PYTHON_ON % (python_version(), platform) + format_exc())\r
    except KeyboardInterrupt: \r
        ReturnCode = ABORT_ERROR\r
        if Logger.GetLevel() <= Logger.DEBUG_9:\r
            Logger.Quiet(ST.MSG_PYTHON_ON % (python_version(), platform) + format_exc())\r
    except:\r
        ReturnCode = CODE_ERROR\r
        Logger.Error("\nInventoryWs",\r
                    CODE_ERROR,\r
                    ST.ERR_UNKNOWN_FATAL_INVENTORYWS_ERR,\r
                    ExtraData=ST.MSG_SEARCH_FOR_HELP,\r
                    RaiseError=False\r
                    )\r
        Logger.Quiet(ST.MSG_PYTHON_ON % (python_version(),\r
            platform) + format_exc())\r
\r
    if ReturnCode == 0:\r
        Logger.Quiet(ST.MSG_FINISH)\r
    \r
    return ReturnCode