]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/UPT/Object/POM/CommonObject.py
BaseTools: Clean up source files
[mirror_edk2.git] / BaseTools / Source / Python / UPT / Object / POM / CommonObject.py
index ec8a8d44ce5c45aba19426a62336c3bc69b4dc3e..a4fc5876e6405f95e6224c7bb6dab665dc852fcf 100644 (file)
@@ -1,11 +1,11 @@
 ## @file\r
 # This file is used to define common items of class object\r
 #\r
-# Copyright (c) 2011 - 2014, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2011 - 2018, 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
+# 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
@@ -23,10 +23,10 @@ from Library.DataType import TAB_LANGUAGE_EN_US
 class HelpTextObject(object):\r
     def __init__(self):\r
         self.HelpText = TextObject()\r
-    \r
+\r
     def SetHelpText(self, HelpText):\r
         self.HelpText = HelpText\r
-    \r
+\r
     def GetHelpText(self):\r
         return self.HelpText\r
 \r
@@ -37,10 +37,10 @@ class HelpTextObject(object):
 class HelpTextListObject(object):\r
     def __init__(self):\r
         self.HelpTextList = []\r
-    \r
+\r
     def SetHelpTextList(self, HelpTextList):\r
         self.HelpTextList = HelpTextList\r
-    \r
+\r
     def GetHelpTextList(self):\r
         return self.HelpTextList\r
 \r
@@ -51,13 +51,13 @@ class HelpTextListObject(object):
 class PromptListObject(object):\r
     def __init__(self):\r
         self.PromptList = []\r
-    \r
+\r
     def SetPromptList(self, PromptList):\r
         self.PromptList = PromptList\r
-    \r
+\r
     def GetPromptList(self):\r
         return self.PromptList\r
-    \r
+\r
 ## CommonPropertiesObject\r
 #\r
 # This class defined common attribution used in Module/Platform/Package files\r
@@ -77,7 +77,7 @@ class CommonPropertiesObject(HelpTextObject, HelpTextListObject):
         self.GuidValue = ''\r
         HelpTextObject.__init__(self)\r
         HelpTextListObject.__init__(self)\r
-        \r
+\r
     def SetUsage(self, Usage):\r
         self.Usage = Usage\r
 \r
@@ -95,10 +95,10 @@ class CommonPropertiesObject(HelpTextObject, HelpTextListObject):
 \r
     def GetSupArchList(self):\r
         return self.SupArchList\r
-    \r
+\r
     def SetGuidValue(self, GuidValue):\r
         self.GuidValue = GuidValue\r
-        \r
+\r
     def GetGuidValue(self):\r
         return self.GuidValue\r
 \r
@@ -199,11 +199,11 @@ class BinaryHeaderObject(object):
 \r
     def GetBinaryHeaderLicense(self):\r
         return self.BinaryHeaderLicenseList\r
-    \r
+\r
 ## ClonedRecordObject\r
 #\r
 # This class defined ClonedRecord items used in Module/Platform/Package files\r
-# \r
+#\r
 # @param object:        Inherited from object class\r
 #\r
 class ClonedRecordObject(object):\r
@@ -285,7 +285,7 @@ class FileNameObject(CommonPropertiesObject):
         self.FileType = ''\r
         self.Filename = ''\r
         CommonPropertiesObject.__init__(self)\r
-        \r
+\r
     def SetFileType(self, FileType):\r
         self.FileType = FileType\r
 \r
@@ -306,10 +306,10 @@ class FileNameObject(CommonPropertiesObject):
 #\r
 class FileObject(object):\r
     def __init__(self):\r
-        self.Executable = '' \r
+        self.Executable = ''\r
         self.Uri = ''\r
         self.OsType = ''\r
-        \r
+\r
     def SetExecutable(self, Executable):\r
         self.Executable = Executable\r
 \r
@@ -327,8 +327,8 @@ class FileObject(object):
 \r
     def GetOS(self):\r
         return self.OsType\r
-    \r
-## \r
+\r
+##\r
 # MiscFileObject is used for xml\r
 #\r
 # @param CommonHeaderObject:   Inherited from CommonHeaderObject class\r
@@ -336,18 +336,18 @@ class FileObject(object):
 class MiscFileObject(CommonHeaderObject):\r
     def __init__(self):\r
         self.Name = ''\r
-        self.FileList = [] \r
+        self.FileList = []\r
         CommonHeaderObject.__init__(self)\r
-        \r
+\r
     def SetName(self, Name):\r
         self.Name = Name\r
-    \r
+\r
     def GetName(self):\r
         return self.Name\r
-    \r
+\r
     def SetFileList(self, FileList):\r
         self.FileList = FileList\r
-        \r
+\r
     def GetFileList(self):\r
         return self.FileList\r
 \r
@@ -397,7 +397,7 @@ class IdentificationObject(GuidVersionObject):
         self.ModulePath = ''\r
         self.CombinePath = ''\r
         GuidVersionObject.__init__(self)\r
-        \r
+\r
     def SetName(self, Name):\r
         self.Name = Name\r
 \r
@@ -448,7 +448,7 @@ class IdentificationObject(GuidVersionObject):
 \r
 ## GuidProtocolPpiCommonObject\r
 #\r
-# This class defined Guid, Protocol and Ppi like items used in \r
+# This class defined Guid, Protocol and Ppi like items used in\r
 # Module/Platform/Package files\r
 #\r
 # @param CommonPropertiesObject:    Inherited from CommonPropertiesObject class\r
@@ -460,7 +460,7 @@ class GuidProtocolPpiCommonObject(CommonPropertiesObject):
         self.Guid = ''\r
         self.SupModuleList = []\r
         CommonPropertiesObject.__init__(self)\r
-        \r
+\r
     def SetName(self, Name):\r
         self.Name = Name\r
 \r
@@ -512,7 +512,7 @@ class GuidObject(GuidProtocolPpiCommonObject):
 #\r
 # This class defined Protocol item used in Module/Platform/Package files\r
 #\r
-# @param GuidProtocolPpiCommonObject:  Inherited from \r
+# @param GuidProtocolPpiCommonObject:  Inherited from\r
 #                                      GuidProtocolPpiCommonObject\r
 #\r
 class ProtocolObject(GuidProtocolPpiCommonObject):\r
@@ -529,7 +529,7 @@ class ProtocolObject(GuidProtocolPpiCommonObject):
 #\r
 # This class defined Ppi item used in Module/Platform/Package files\r
 #\r
-# @param GuidProtocolPpiCommonObject:  Inherited from \r
+# @param GuidProtocolPpiCommonObject:  Inherited from\r
 #                                      GuidProtocolPpiCommonObject\r
 #\r
 class PpiObject(GuidProtocolPpiCommonObject):\r
@@ -566,13 +566,13 @@ class UserExtensionObject(object):
         self.BinaryLicenseList = []\r
         self.UniLangDefsList = []\r
         #\r
-        # { Statement : Arch , ... }    \r
+        # { Statement : Arch , ... }\r
         #\r
-        self.DefinesDict = {} \r
+        self.DefinesDict = {}\r
         #\r
         # { Arch : Statement , ... }\r
         #\r
-        self.BuildOptionDict = {} \r
+        self.BuildOptionDict = {}\r
         self.IncludesDict = {}\r
         self.SourcesDict = {}\r
         self.BinariesDict = {}\r
@@ -581,40 +581,40 @@ class UserExtensionObject(object):
         #\r
         self.Statement = ''\r
         self.SupArchList = []\r
-        \r
+\r
     def SetStatement(self, Statement):\r
         self.Statement = Statement\r
-    \r
+\r
     def GetStatement(self):\r
         return self.Statement\r
 \r
     def SetSupArchList(self, ArchList):\r
         self.SupArchList = ArchList\r
-    \r
+\r
     def GetSupArchList(self):\r
         return self.SupArchList\r
-        \r
+\r
     def SetUserID(self, UserID):\r
         self.UserID = UserID\r
-    \r
+\r
     def GetUserID(self):\r
         return self.UserID\r
-    \r
+\r
     def SetIdentifier(self, Identifier):\r
         self.Identifier = Identifier\r
-        \r
+\r
     def GetIdentifier(self):\r
         return self.Identifier\r
-    \r
+\r
     def SetUniLangDefsList(self, UniLangDefsList):\r
         self.UniLangDefsList = UniLangDefsList\r
-        \r
+\r
     def GetUniLangDefsList(self):\r
         return self.UniLangDefsList\r
-    \r
+\r
     def SetBinaryAbstract(self, BinaryAbstractList):\r
         self.BinaryAbstractList = BinaryAbstractList\r
-    \r
+\r
     def GetBinaryAbstract(self, Lang=None):\r
         if Lang:\r
             for (Key, Value) in self.BinaryAbstractList:\r
@@ -623,10 +623,10 @@ class UserExtensionObject(object):
             return None\r
         else:\r
             return self.BinaryAbstractList\r
-    \r
+\r
     def SetBinaryDescription(self, BinaryDescriptionList):\r
         self.BinaryDescriptionList = BinaryDescriptionList\r
-    \r
+\r
     def GetBinaryDescription(self, Lang=None):\r
         if Lang:\r
             for (Key, Value) in self.BinaryDescriptionList:\r
@@ -635,10 +635,10 @@ class UserExtensionObject(object):
             return None\r
         else:\r
             return self.BinaryDescriptionList\r
-    \r
+\r
     def SetBinaryCopyright(self, BinaryCopyrightList):\r
         self.BinaryCopyrightList = BinaryCopyrightList\r
-    \r
+\r
     def GetBinaryCopyright(self, Lang=None):\r
         if Lang:\r
             for (Key, Value) in self.BinaryCopyrightList:\r
@@ -647,10 +647,10 @@ class UserExtensionObject(object):
             return None\r
         else:\r
             return self.BinaryCopyrightList\r
-    \r
+\r
     def SetBinaryLicense(self, BinaryLicenseList):\r
         self.BinaryLicenseList = BinaryLicenseList\r
-    \r
+\r
     def GetBinaryLicense(self, Lang=None):\r
         if Lang:\r
             for (Key, Value) in self.BinaryLicenseList:\r
@@ -659,34 +659,34 @@ class UserExtensionObject(object):
             return None\r
         else:\r
             return self.BinaryLicenseList\r
-    \r
+\r
     def SetDefinesDict(self, DefinesDict):\r
         self.DefinesDict = DefinesDict\r
-    \r
+\r
     def GetDefinesDict(self):\r
         return self.DefinesDict\r
-    \r
+\r
     def SetBuildOptionDict(self, BuildOptionDict):\r
         self.BuildOptionDict = BuildOptionDict\r
-        \r
+\r
     def GetBuildOptionDict(self):\r
         return self.BuildOptionDict\r
 \r
     def SetIncludesDict(self, IncludesDict):\r
         self.IncludesDict = IncludesDict\r
-        \r
+\r
     def GetIncludesDict(self):\r
         return self.IncludesDict\r
 \r
     def SetSourcesDict(self, SourcesDict):\r
         self.SourcesDict = SourcesDict\r
-        \r
+\r
     def GetSourcesDict(self):\r
         return self.SourcesDict\r
 \r
     def SetBinariesDict(self, BinariesDict):\r
         self.BinariesDict = BinariesDict\r
-        \r
+\r
     def GetBinariesDict(self):\r
         return self.BinariesDict\r
 \r
@@ -703,28 +703,28 @@ class LibraryClassObject(CommonPropertiesObject):
         self.SupModuleList = []\r
         self.RecommendedInstance = GuidVersionObject()\r
         CommonPropertiesObject.__init__(self)\r
-        \r
+\r
     def SetLibraryClass(self, LibraryClass):\r
         self.LibraryClass = LibraryClass\r
-    \r
+\r
     def GetLibraryClass(self):\r
         return self.LibraryClass\r
-    \r
+\r
     def SetSupModuleList(self, SupModuleList):\r
         self.SupModuleList = SupModuleList\r
-    \r
+\r
     def GetSupModuleList(self):\r
         return self.SupModuleList\r
-    \r
+\r
     def SetIncludeHeader(self, IncludeHeader):\r
         self.IncludeHeader = IncludeHeader\r
-        \r
+\r
     def GetIncludeHeader(self):\r
         return self.IncludeHeader\r
-    \r
+\r
     def SetRecommendedInstance(self, RecommendedInstance):\r
         self.RecommendedInstance = RecommendedInstance\r
-    \r
+\r
     def GetRecommendedInstance(self):\r
         return self.RecommendedInstance\r
 \r
@@ -748,69 +748,69 @@ class PcdErrorObject(object):
 \r
     def SetValidValue(self, ValidValue):\r
         self.ValidValue = ValidValue\r
-    \r
+\r
     def GetValidValue(self):\r
         return self.ValidValue\r
-    \r
+\r
     def SetValidValueLang(self, ValidValueLang):\r
         self.ValidValueLang = ValidValueLang\r
-        \r
+\r
     def GetValidValueLang(self):\r
         return self.ValidValueLang\r
-    \r
+\r
     def SetValidValueRange(self, ValidValueRange):\r
         self.ValidValueRange = ValidValueRange\r
-        \r
+\r
     def GetValidValueRange(self):\r
         return self.ValidValueRange\r
-    \r
+\r
     def SetExpression(self, Expression):\r
         self.Expression = Expression\r
-    \r
+\r
     def GetExpression(self):\r
         return self.Expression\r
-    \r
+\r
     def SetErrorNumber(self, ErrorNumber):\r
         self.ErrorNumber = ErrorNumber\r
-        \r
+\r
     def GetErrorNumber(self):\r
         return self.ErrorNumber\r
-    \r
+\r
     def SetErrorMessageList(self, ErrorMessageList):\r
         self.ErrorMessageList = ErrorMessageList\r
-        \r
+\r
     def GetErrorMessageList(self):\r
         return self.ErrorMessageList\r
-    \r
+\r
     def SetTokenSpaceGuidCName(self, TokenSpaceGuidCName):\r
         self.TokenSpaceGuidCName = TokenSpaceGuidCName\r
-        \r
+\r
     def GetTokenSpaceGuidCName(self):\r
         return self.TokenSpaceGuidCName\r
-    \r
+\r
     def SetCName(self, CName):\r
         self.CName = CName\r
-        \r
+\r
     def GetCName(self):\r
         return self.CName\r
-    \r
+\r
     def SetFileLine(self, FileLine):\r
         self.FileLine = FileLine\r
-        \r
+\r
     def GetFileLine(self):\r
         return self.FileLine\r
-    \r
+\r
     def SetLineNum(self, LineNum):\r
         self.LineNum = LineNum\r
-        \r
+\r
     def GetLineNum(self):\r
         return self.LineNum\r
-    \r
-    \r
+\r
+\r
 ## IncludeObject\r
 #\r
 # This class defined Include item used in Module/Platform/Package files\r
-# \r
+#\r
 # @param CommonPropertiesObject:  Inherited from CommonPropertiesObject class\r
 #\r
 class IncludeObject(CommonPropertiesObject):\r
@@ -820,31 +820,31 @@ class IncludeObject(CommonPropertiesObject):
         self.SupModuleList = []\r
         self.Comment = ''\r
         CommonPropertiesObject.__init__(self)\r
-    \r
+\r
     def SetFilePath(self, FilePath):\r
         self.FilePath = FilePath\r
-    \r
+\r
     def GetFilePath(self):\r
         return self.FilePath\r
-    \r
+\r
     def SetModuleType(self, ModuleType):\r
         self.ModuleType = ModuleType\r
-    \r
+\r
     def GetModuleType(self):\r
         return self.ModuleType\r
-    \r
+\r
     def SetSupModuleList(self, SupModuleList):\r
         self.SupModuleList = SupModuleList\r
\r
+\r
     def GetSupModuleList(self):\r
-        return self.SupModuleList              \r
-               \r
+        return self.SupModuleList\r
+\r
     def SetComment(self, Comment):\r
         self.Comment = Comment\r
\r
+\r
     def GetComment(self):\r
-        return self.Comment \r
-    \r
+        return self.Comment\r
+\r
 ## PcdObject\r
 #\r
 # This class defined Pcd item used in Module/Platform/Package files\r
@@ -874,86 +874,86 @@ class PcdObject(CommonPropertiesObject, HelpTextListObject, PromptListObject):
         self.Offset = ''\r
         self.ValidUsage = ''\r
         self.ItemType = ''\r
-        self.PcdErrorsList = [] \r
-        self.SupModuleList = []        \r
+        self.PcdErrorsList = []\r
+        self.SupModuleList = []\r
         CommonPropertiesObject.__init__(self)\r
         HelpTextListObject.__init__(self)\r
         PromptListObject.__init__(self)\r
-    \r
+\r
     def SetPcdCName(self, PcdCName):\r
         self.PcdCName = PcdCName\r
-        \r
+\r
     def GetPcdCName(self):\r
         return self.PcdCName\r
-    \r
+\r
     def SetCName(self, CName):\r
         self.CName = CName\r
-    \r
+\r
     def GetCName(self):\r
         return self.CName\r
-    \r
+\r
     def SetToken(self, Token):\r
         self.Token = Token\r
-    \r
+\r
     def GetOffset(self):\r
         return self.Offset\r
 \r
     def SetOffset(self, Offset):\r
         self.Offset = Offset\r
-    \r
+\r
     def GetToken(self):\r
         return self.Token\r
-    \r
+\r
     def SetTokenSpaceGuidCName(self, TokenSpaceGuidCName):\r
         self.TokenSpaceGuidCName = TokenSpaceGuidCName\r
-    \r
+\r
     def GetTokenSpaceGuidCName(self):\r
         return self.TokenSpaceGuidCName\r
-    \r
+\r
     def SetTokenSpaceGuidValue(self, TokenSpaceGuidValue):\r
         self.TokenSpaceGuidValue = TokenSpaceGuidValue\r
-    \r
+\r
     def GetTokenSpaceGuidValue(self):\r
         return self.TokenSpaceGuidValue\r
-    \r
+\r
     def SetDatumType(self, DatumType):\r
         self.DatumType = DatumType\r
-        \r
+\r
     def GetDatumType(self):\r
         return self.DatumType\r
-    \r
+\r
     def SetMaxDatumSize(self, MaxDatumSize):\r
         self.MaxDatumSize = MaxDatumSize\r
-    \r
+\r
     def GetMaxDatumSize(self):\r
         return self.MaxDatumSize\r
 \r
     def SetDefaultValue(self, DefaultValue):\r
         self.DefaultValue = DefaultValue\r
-        \r
+\r
     def GetDefaultValue(self):\r
         return self.DefaultValue\r
 \r
     def SetValidUsage(self, ValidUsage):\r
         self.ValidUsage = ValidUsage\r
-    \r
+\r
     def GetValidUsage(self):\r
         return self.ValidUsage\r
-    \r
+\r
     def SetPcdErrorsList(self, PcdErrorsList):\r
         self.PcdErrorsList = PcdErrorsList\r
-    \r
+\r
     def GetPcdErrorsList(self):\r
         return self.PcdErrorsList\r
 \r
     def SetItemType(self, ItemType):\r
         self.ItemType = ItemType\r
-        \r
+\r
     def GetItemType(self):\r
         return self.ItemType\r
 \r
     def SetSupModuleList(self, SupModuleList):\r
         self.SupModuleList = SupModuleList\r
-        \r
+\r
     def GetSupModuleList(self):\r
         return self.SupModuleList\r