BaseTool: Enhance error handling.

[mirror_edk2.git] / BaseTools / Source / Python / Workspace / BuildClassObject.py

## @file\r
# This file is used to define each component of the build database\r
#\r
# Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>\r
# 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
import Common.LongFilePathOs as os\r
\r
from Common.Misc import sdict\r
from Common.Misc import RealPath2\r
from Common.BuildToolError import *\r
from Common.DataType import *\r
import collections\r
\r
## PcdClassObject\r
#\r
# This Class is used for PcdObject\r
#\r
# @param object:             Inherited from object class\r
# @param Name:               Input value for Name of Pcd, default is None\r
# @param Guid:               Input value for Guid of Pcd, default is None\r
# @param Type:               Input value for Type of Pcd, default is None\r
# @param DatumType:          Input value for DatumType of Pcd, default is None\r
# @param Value:              Input value for Value of Pcd, default is None\r
# @param Token:              Input value for Token of Pcd, default is None\r
# @param MaxDatumSize:       Input value for MaxDatumSize of Pcd, default is None\r
# @param SkuInfoList:        Input value for SkuInfoList of Pcd, default is {}\r
# @param IsOverrided:        Input value for IsOverrided of Pcd, default is False\r
# @param GuidValue:          Input value for TokenSpaceGuidValue of Pcd, default is None\r
#\r
# @var TokenCName:           To store value for TokenCName\r
# @var TokenSpaceGuidCName:  To store value for TokenSpaceGuidCName\r
# @var Type:                 To store value for Type\r
# @var DatumType:            To store value for DatumType\r
# @var TokenValue:           To store value for TokenValue\r
# @var MaxDatumSize:         To store value for MaxDatumSize\r
# @var SkuInfoList:          To store value for SkuInfoList\r
# @var IsOverrided:          To store value for IsOverrided\r
# @var Phase:                To store value for Phase, default is "DXE"\r
#\r
class PcdClassObject(object):\r
    def __init__(self, Name = None, Guid = None, Type = None, DatumType = None, Value = None, Token = None, MaxDatumSize = None, SkuInfoList = {}, IsOverrided = False, GuidValue = None, validateranges = [], validlists = [], expressions = [], IsDsc = False):\r
        self.TokenCName = Name\r
        self.TokenSpaceGuidCName = Guid\r
        self.TokenSpaceGuidValue = GuidValue\r
        self.Type = Type\r
        self.DatumType = DatumType\r
        self.DefaultValue = Value\r
        self.TokenValue = Token\r
        self.MaxDatumSize = MaxDatumSize\r
        self.SkuInfoList = SkuInfoList\r
        self.Phase = "DXE"\r
        self.Pending = False\r
        self.IsOverrided = IsOverrided\r
        self.IsFromBinaryInf = False\r
        self.IsFromDsc = False\r
        self.validateranges = validateranges\r
        self.validlists = validlists\r
        self.expressions = expressions\r
        self.DscDefaultValue = None\r
        if IsDsc:\r
            self.DscDefaultValue = Value\r
\r
    ## Convert the class to a string\r
    #\r
    #  Convert each member of the class to string\r
    #  Organize to a signle line format string\r
    #\r
    #  @retval Rtn Formatted String\r
    #\r
    def __str__(self):\r
        Rtn = '\tTokenCName=' + str(self.TokenCName) + ', ' + \\r
              'TokenSpaceGuidCName=' + str(self.TokenSpaceGuidCName) + ', ' + \\r
              'Type=' + str(self.Type) + ', ' + \\r
              'DatumType=' + str(self.DatumType) + ', ' + \\r
              'DefaultValue=' + str(self.DefaultValue) + ', ' + \\r
              'TokenValue=' + str(self.TokenValue) + ', ' + \\r
              'MaxDatumSize=' + str(self.MaxDatumSize) + ', '\r
        for Item in self.SkuInfoList.values():\r
            Rtn = Rtn + 'SkuId=' + Item.SkuId + ', ' + 'SkuIdName=' + Item.SkuIdName\r
        Rtn = Rtn + ', IsOverrided=' + str(self.IsOverrided)\r
\r
        return Rtn\r
\r
    ## Override __eq__ function\r
    #\r
    # Check whether pcds are the same\r
    #\r
    # @retval False The two pcds are different\r
    # @retval True  The two pcds are the same\r
    #\r
    def __eq__(self, Other):\r
        return Other and self.TokenCName == Other.TokenCName and self.TokenSpaceGuidCName == Other.TokenSpaceGuidCName\r
\r
    ## Override __hash__ function\r
    #\r
    # Use (TokenCName, TokenSpaceGuidCName) as key in hash table\r
    #\r
    # @retval truple() Key for hash table\r
    #\r
    def __hash__(self):\r
        return hash((self.TokenCName, self.TokenSpaceGuidCName))\r
\r
class StructurePcd(PcdClassObject):\r
    def __init__(self, StructuredPcdIncludeFile=None, Packages=None, Name=None, Guid=None, Type=None, DatumType=None, Value=None, Token=None, MaxDatumSize=None, SkuInfoList=None, IsOverrided=False, GuidValue=None, validateranges=None, validlists=None, expressions=None,default_store = TAB_DEFAULT_STORES_DEFAULT):\r
        if SkuInfoList is None: SkuInfoList={}\r
        if validateranges is None: validateranges=[]\r
        if validlists is None: validlists=[]\r
        if expressions is None : expressions=[]\r
        super(StructurePcd, self).__init__(Name, Guid, Type, DatumType, Value, Token, MaxDatumSize, SkuInfoList, IsOverrided, GuidValue, validateranges, validlists, expressions)\r
        self.StructuredPcdIncludeFile = StructuredPcdIncludeFile\r
        self.PackageDecs = Packages\r
        self.DefaultStoreName = [default_store]\r
        self.DefaultValues = collections.OrderedDict({})\r
        self.PcdMode = None\r
        self.SkuOverrideValues = collections.OrderedDict({})\r
        self.FlexibleFieldName = None\r
        self.StructName = None\r
        self.PcdDefineLineNo = 0\r
        self.PkgPath = ""\r
    def __repr__(self):\r
        return self.TypeName\r
\r
    def AddDefaultValue (self, FieldName, Value, FileName="", LineNo=0):\r
        if FieldName in self.DefaultValues:\r
            del self.DefaultValues[FieldName]\r
        self.DefaultValues[FieldName] = [Value.strip(), FileName, LineNo]\r
        return self.DefaultValues[FieldName]\r
\r
    def AddOverrideValue (self, FieldName, Value, SkuName, DefaultStoreName, FileName="", LineNo=0):\r
        if SkuName not in self.SkuOverrideValues:\r
            self.SkuOverrideValues[SkuName] = collections.OrderedDict({})\r
        if DefaultStoreName not in self.SkuOverrideValues[SkuName]:\r
            self.SkuOverrideValues[SkuName][DefaultStoreName] = collections.OrderedDict({})\r
        if FieldName in self.SkuOverrideValues[SkuName][DefaultStoreName]:\r
            del self.SkuOverrideValues[SkuName][DefaultStoreName][FieldName]\r
        self.SkuOverrideValues[SkuName][DefaultStoreName][FieldName] = [Value.strip(), FileName, LineNo]\r
        return self.SkuOverrideValues[SkuName][DefaultStoreName][FieldName]\r
\r
    def SetPcdMode (self, PcdMode):\r
        self.PcdMode = PcdMode\r
\r
    def SetFlexibleFieldName (self, FlexibleFieldName):\r
        self.FlexibleFieldName = FlexibleFieldName\r
\r
    def copy(self, PcdObject):\r
        self.TokenCName = PcdObject.TokenCName if PcdObject.TokenCName else self.TokenCName\r
        self.TokenSpaceGuidCName = PcdObject.TokenSpaceGuidCName if PcdObject.TokenSpaceGuidCName else PcdObject.TokenSpaceGuidCName\r
        self.TokenSpaceGuidValue = PcdObject.TokenSpaceGuidValue if PcdObject.TokenSpaceGuidValue else self.TokenSpaceGuidValue\r
        self.Type = PcdObject.Type if PcdObject.Type else self.Type\r
        self.DatumType = PcdObject.DatumType if PcdObject.DatumType else self.DatumType\r
        self.DefaultValue = PcdObject.DefaultValue if  PcdObject.DefaultValue else self.DefaultValue\r
        self.TokenValue = PcdObject.TokenValue if PcdObject.TokenValue else self.TokenValue\r
        self.MaxDatumSize = PcdObject.MaxDatumSize if PcdObject.MaxDatumSize else self.MaxDatumSize\r
        self.SkuInfoList = PcdObject.SkuInfoList if PcdObject.SkuInfoList else self.SkuInfoList\r
        self.Phase = PcdObject.Phase if PcdObject.Phase else self.Phase\r
        self.Pending = PcdObject.Pending if PcdObject.Pending else self.Pending\r
        self.IsOverrided = PcdObject.IsOverrided if PcdObject.IsOverrided else self.IsOverrided\r
        self.IsFromBinaryInf = PcdObject.IsFromBinaryInf if PcdObject.IsFromBinaryInf else self.IsFromBinaryInf\r
        self.IsFromDsc = PcdObject.IsFromDsc if PcdObject.IsFromDsc else self.IsFromDsc\r
        self.validateranges = PcdObject.validateranges if PcdObject.validateranges else self.validateranges\r
        self.validlists = PcdObject.validlists if PcdObject.validlists else self.validlists\r
        self.expressions = PcdObject.expressions if PcdObject.expressions else self.expressions\r
        if type(PcdObject) is StructurePcd:\r
            self.StructuredPcdIncludeFile = PcdObject.StructuredPcdIncludeFile if PcdObject.StructuredPcdIncludeFile else self.StructuredPcdIncludeFile\r
            self.PackageDecs = PcdObject.PackageDecs if PcdObject.PackageDecs else self.PackageDecs\r
            self.DefaultValues = PcdObject.DefaultValues if PcdObject.DefaultValues else self.DefaultValues\r
            self.PcdMode = PcdObject.PcdMode if PcdObject.PcdMode else self.PcdMode\r
            self.DefaultFromDSC=None\r
            self.SkuOverrideValues = PcdObject.SkuOverrideValues if PcdObject.SkuOverrideValues else self.SkuOverrideValues\r
            self.FlexibleFieldName = PcdObject.FlexibleFieldName if PcdObject.FlexibleFieldName else self.FlexibleFieldName\r
            self.StructName = PcdObject.DatumType if PcdObject.DatumType else self.StructName\r
            self.PcdDefineLineNo = PcdObject.PcdDefineLineNo if PcdObject.PcdDefineLineNo else self.PcdDefineLineNo\r
            self.PkgPath = PcdObject.PkgPath if PcdObject.PkgPath else self.PkgPath\r
\r
## LibraryClassObject\r
#\r
# This Class defines LibraryClassObject used in BuildDatabase\r
#\r
# @param object:      Inherited from object class\r
# @param Name:        Input value for LibraryClassName, default is None\r
# @param SupModList:  Input value for SupModList, default is []\r
# @param Type:        Input value for Type, default is None\r
#\r
# @var LibraryClass:  To store value for LibraryClass\r
# @var SupModList:    To store value for SupModList\r
# @var Type:          To store value for Type\r
#\r
class LibraryClassObject(object):\r
    def __init__(self, Name = None, SupModList = [], Type = None):\r
        self.LibraryClass = Name\r
        self.SupModList = SupModList\r
        if Type != None:\r
            self.SupModList = CleanString(Type).split(DataType.TAB_SPACE_SPLIT)\r
\r
## ModuleBuildClassObject\r
#\r
# This Class defines ModuleBuildClass\r
#\r
# @param object:               Inherited from object class\r
#\r
# @var MetaFile:              To store value for module meta file path\r
# @var BaseName:               To store value for BaseName\r
# @var ModuleType:             To store value for ModuleType\r
# @var Guid:                   To store value for Guid\r
# @var Version:                To store value for Version\r
# @var PcdIsDriver:            To store value for PcdIsDriver\r
# @var BinaryModule:           To store value for BinaryModule\r
# @var CustomMakefile:         To store value for CustomMakefile\r
# @var Specification:          To store value for Specification\r
# @var Shadow                  To store value for Shadow\r
# @var LibraryClass:           To store value for LibraryClass, it is a list structure as\r
#                              [ LibraryClassObject, ...]\r
# @var ModuleEntryPointList:   To store value for ModuleEntryPointList\r
# @var ModuleUnloadImageList:  To store value for ModuleUnloadImageList\r
# @var ConstructorList:        To store value for ConstructorList\r
# @var DestructorList:         To store value for DestructorList\r
# @var Binaries:               To store value for Binaries, it is a list structure as\r
#                              [ ModuleBinaryClassObject, ...]\r
# @var Sources:                To store value for Sources, it is a list structure as\r
#                              [ ModuleSourceFilesClassObject, ... ]\r
# @var LibraryClasses:         To store value for LibraryClasses, it is a set structure as\r
#                              { [LibraryClassName, ModuleType] : LibraryClassInfFile }\r
# @var Protocols:              To store value for Protocols, it is a list structure as\r
#                              [ ProtocolName, ... ]\r
# @var Ppis:                   To store value for Ppis, it is a list structure as\r
#                              [ PpiName, ... ]\r
# @var Guids:                  To store value for Guids, it is a list structure as\r
#                              [ GuidName, ... ]\r
# @var Includes:               To store value for Includes, it is a list structure as\r
#                              [ IncludePath, ... ]\r
# @var Packages:               To store value for Packages, it is a list structure as\r
#                              [ DecFileName, ... ]\r
# @var Pcds:                   To store value for Pcds, it is a set structure as\r
#                              { [(PcdCName, PcdGuidCName)] : PcdClassObject}\r
# @var BuildOptions:           To store value for BuildOptions, it is a set structure as\r
#                              { [BuildOptionKey] : BuildOptionValue}\r
# @var Depex:                  To store value for Depex\r
#\r
class ModuleBuildClassObject(object):\r
    def __init__(self):\r
        self.AutoGenVersion          = 0\r
        self.MetaFile                = ''\r
        self.BaseName                = ''\r
        self.ModuleType              = ''\r
        self.Guid                    = ''\r
        self.Version                 = ''\r
        self.PcdIsDriver             = ''\r
        self.BinaryModule            = ''\r
        self.Shadow                  = ''\r
        self.SourceOverridePath      = ''\r
        self.CustomMakefile          = {}\r
        self.Specification           = {}\r
        self.LibraryClass            = []\r
        self.ModuleEntryPointList    = []\r
        self.ModuleUnloadImageList   = []\r
        self.ConstructorList         = []\r
        self.DestructorList          = []\r
\r
        self.Binaries                = []\r
        self.Sources                 = []\r
        self.LibraryClasses          = sdict()\r
        self.Libraries               = []\r
        self.Protocols               = []\r
        self.Ppis                    = []\r
        self.Guids                   = []\r
        self.Includes                = []\r
        self.Packages                = []\r
        self.Pcds                    = {}\r
        self.BuildOptions            = {}\r
        self.Depex                   = {}\r
\r
    ## Convert the class to a string\r
    #\r
    #  Convert member MetaFile of the class to a string\r
    #\r
    #  @retval string Formatted String\r
    #\r
    def __str__(self):\r
        return str(self.MetaFile)\r
\r
    ## Override __eq__ function\r
    #\r
    # Check whether ModuleBuildClassObjects are the same\r
    #\r
    # @retval False The two ModuleBuildClassObjects are different\r
    # @retval True  The two ModuleBuildClassObjects are the same\r
    #\r
    def __eq__(self, Other):\r
        return self.MetaFile == Other\r
\r
    ## Override __hash__ function\r
    #\r
    # Use MetaFile as key in hash table\r
    #\r
    # @retval string Key for hash table\r
    #\r
    def __hash__(self):\r
        return hash(self.MetaFile)\r
\r
## PackageBuildClassObject\r
#\r
# This Class defines PackageBuildClass\r
#\r
# @param object:        Inherited from object class\r
#\r
# @var MetaFile:       To store value for package meta file path\r
# @var PackageName:     To store value for PackageName\r
# @var Guid:            To store value for Guid\r
# @var Version:         To store value for Version\r
# @var Protocols:       To store value for Protocols, it is a set structure as\r
#                       { [ProtocolName] : Protocol Guid, ... }\r
# @var Ppis:            To store value for Ppis, it is a set structure as\r
#                       { [PpiName] : Ppi Guid, ... }\r
# @var Guids:           To store value for Guids, it is a set structure as\r
#                       { [GuidName] : Guid, ... }\r
# @var Includes:        To store value for Includes, it is a list structure as\r
#                       [ IncludePath, ... ]\r
# @var LibraryClasses:  To store value for LibraryClasses, it is a set structure as\r
#                       { [LibraryClassName] : LibraryClassInfFile }\r
# @var Pcds:            To store value for Pcds, it is a set structure as\r
#                       { [(PcdCName, PcdGuidCName)] : PcdClassObject}\r
#\r
class PackageBuildClassObject(object):\r
    def __init__(self):\r
        self.MetaFile                = ''\r
        self.PackageName             = ''\r
        self.Guid                    = ''\r
        self.Version                 = ''\r
\r
        self.Protocols               = {}\r
        self.Ppis                    = {}\r
        self.Guids                   = {}\r
        self.Includes                = []\r
        self.LibraryClasses          = {}\r
        self.Pcds                    = {}\r
\r
    ## Convert the class to a string\r
    #\r
    #  Convert member MetaFile of the class to a string\r
    #\r
    #  @retval string Formatted String\r
    #\r
    def __str__(self):\r
        return str(self.MetaFile)\r
\r
    ## Override __eq__ function\r
    #\r
    # Check whether PackageBuildClassObjects are the same\r
    #\r
    # @retval False The two PackageBuildClassObjects are different\r
    # @retval True  The two PackageBuildClassObjects are the same\r
    #\r
    def __eq__(self, Other):\r
        return self.MetaFile == Other\r
\r
    ## Override __hash__ function\r
    #\r
    # Use MetaFile as key in hash table\r
    #\r
    # @retval string Key for hash table\r
    #\r
    def __hash__(self):\r
        return hash(self.MetaFile)\r
\r
## PlatformBuildClassObject\r
#\r
# This Class defines PlatformBuildClass\r
#\r
# @param object:          Inherited from object class\r
#\r
# @var MetaFile:         To store value for platform meta-file path\r
# @var PlatformName:      To store value for PlatformName\r
# @var Guid:              To store value for Guid\r
# @var Version:           To store value for Version\r
# @var DscSpecification:  To store value for DscSpecification\r
# @var OutputDirectory:   To store value for OutputDirectory\r
# @var FlashDefinition:   To store value for FlashDefinition\r
# @var BuildNumber:       To store value for BuildNumber\r
# @var MakefileName:      To store value for MakefileName\r
# @var SkuIds:            To store value for SkuIds, it is a set structure as\r
#                         { 'SkuName' : SkuId, '!include' : includefilename, ...}\r
# @var Modules:           To store value for Modules, it is a list structure as\r
#                         [ InfFileName, ... ]\r
# @var Libraries:         To store value for Libraries, it is a list structure as\r
#                         [ InfFileName, ... ]\r
# @var LibraryClasses:    To store value for LibraryClasses, it is a set structure as\r
#                         { (LibraryClassName, ModuleType) : LibraryClassInfFile }\r
# @var Pcds:              To store value for Pcds, it is a set structure as\r
#                         { [(PcdCName, PcdGuidCName)] : PcdClassObject }\r
# @var BuildOptions:      To store value for BuildOptions, it is a set structure as\r
#                         { [BuildOptionKey] : BuildOptionValue }\r
#\r
class PlatformBuildClassObject(object):\r
    def __init__(self):\r
        self.MetaFile                = ''\r
        self.PlatformName            = ''\r
        self.Guid                    = ''\r
        self.Version                 = ''\r
        self.DscSpecification        = ''\r
        self.OutputDirectory         = ''\r
        self.FlashDefinition         = ''\r
        self.BuildNumber             = ''\r
        self.MakefileName            = ''\r
\r
        self.SkuIds                  = {}\r
        self.Modules                 = []\r
        self.LibraryInstances        = []\r
        self.LibraryClasses          = {}\r
        self.Libraries               = {}\r
        self.Pcds                    = {}\r
        self.BuildOptions            = {}\r
\r
    ## Convert the class to a string\r
    #\r
    #  Convert member MetaFile of the class to a string\r
    #\r
    #  @retval string Formatted String\r
    #\r
    def __str__(self):\r
        return str(self.MetaFile)\r
\r
    ## Override __eq__ function\r
    #\r
    # Check whether PlatformBuildClassObjects are the same\r
    #\r
    # @retval False The two PlatformBuildClassObjects are different\r
    # @retval True  The two PlatformBuildClassObjects are the same\r
    #\r
    def __eq__(self, Other):\r
        return self.MetaFile == Other\r
\r
    ## Override __hash__ function\r
    #\r
    # Use MetaFile as key in hash table\r
    #\r
    # @retval string Key for hash table\r
    #\r
    def __hash__(self):\r
        return hash(self.MetaFile)\r