]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/Workspace/BuildClassObject.py
BaseTools: Enable structure pcd in FDF file
[mirror_edk2.git] / BaseTools / Source / Python / Workspace / BuildClassObject.py
index da265b68f1af510e844dc3d804e53e1c3ff2c446..3b47715cbc956091f8a03007928eb703d16baaf2 100644 (file)
@@ -1,7 +1,7 @@
 ## @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
+# Copyright (c) 2007 - 2018, 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
 \r
 import Common.LongFilePathOs as os\r
 \r
-from Common.Misc import sdict\r
+from collections import OrderedDict\r
 from Common.Misc import RealPath2\r
 from Common.BuildToolError import *\r
+from Common.DataType import *\r
 import collections\r
 \r
 ## PcdClassObject\r
@@ -54,6 +55,7 @@ class PcdClassObject(object):
         self.DefaultValue = Value\r
         self.TokenValue = Token\r
         self.MaxDatumSize = MaxDatumSize\r
+        self.MaxSizeUserSet = None\r
         self.SkuInfoList = SkuInfoList\r
         self.Phase = "DXE"\r
         self.Pending = False\r
@@ -64,9 +66,54 @@ class PcdClassObject(object):
         self.validlists = validlists\r
         self.expressions = expressions\r
         self.DscDefaultValue = None\r
+        self.DscRawValue = None\r
         if IsDsc:\r
             self.DscDefaultValue = Value\r
-        \r
+        self.PcdValueFromComm = ""\r
+        self.PcdValueFromFdf = ""\r
+        self.DefinitionPosition = ("","")\r
+\r
+    ## Get the maximum number of bytes\r
+    def GetPcdMaxSize(self):\r
+        if self.DatumType in TAB_PCD_NUMERIC_TYPES:\r
+            return MAX_SIZE_TYPE[self.DatumType]\r
+\r
+        MaxSize = int(self.MaxDatumSize, 10) if self.MaxDatumSize else 0\r
+        if self.PcdValueFromFdf:\r
+            if self.PcdValueFromFdf.startswith("{") and self.PcdValueFromFdf.endswith("}"):\r
+                MaxSize =  max([len(self.PcdValueFromFdf.split(",")),MaxSize])\r
+            elif self.PcdValueFromFdf.startswith("\"") or self.PcdValueFromFdf.startswith("\'"):\r
+                MaxSize =  max([len(self.PcdValueFromFdf)-2+1,MaxSize])\r
+            elif self.PcdValueFromFdf.startswith("L\""):\r
+                MaxSize =  max([2*(len(self.PcdValueFromFdf)-3+1),MaxSize])\r
+            else:\r
+                MaxSize = max([len(self.PcdValueFromFdf),MaxSize])\r
+\r
+        if self.PcdValueFromComm:\r
+            if self.PcdValueFromComm.startswith("{") and self.PcdValueFromComm.endswith("}"):\r
+                return max([len(self.PcdValueFromComm.split(",")), MaxSize])\r
+            elif self.PcdValueFromComm.startswith("\"") or self.PcdValueFromComm.startswith("\'"):\r
+                return max([len(self.PcdValueFromComm)-2+1, MaxSize])\r
+            elif self.PcdValueFromComm.startswith("L\""):\r
+                return max([2*(len(self.PcdValueFromComm)-3+1), MaxSize])\r
+            else:\r
+                return max([len(self.PcdValueFromComm), MaxSize])\r
+        return MaxSize\r
+\r
+    ## Get the number of bytes\r
+    def GetPcdSize(self):\r
+        if self.DatumType in TAB_PCD_NUMERIC_TYPES:\r
+            return MAX_SIZE_TYPE[self.DatumType]\r
+        if not self.DefaultValue:\r
+            return 1\r
+        elif self.DefaultValue[0] == 'L':\r
+            return (len(self.DefaultValue) - 2) * 2\r
+        elif self.DefaultValue[0] == '{':\r
+            return len(self.DefaultValue.split(','))\r
+        else:\r
+            return len(self.DefaultValue) - 1\r
+\r
+\r
     ## Convert the class to a string\r
     #\r
     #  Convert each member of the class to string\r
@@ -108,28 +155,52 @@ class PcdClassObject(object):
         return hash((self.TokenCName, self.TokenSpaceGuidCName))\r
 \r
 class StructurePcd(PcdClassObject):\r
-    def __init__(self, StructuredPcdIncludeFile="", Packages=None, Name=None, Guid=None, Type=None, DatumType=None, Value=None, Token=None, MaxDatumSize=None, SkuInfoList={}, IsOverrided=False, GuidValue=None, validateranges=[], validlists=[], expressions=[]):\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:\r
+            SkuInfoList = {}\r
+        if validateranges is None:\r
+            validateranges = []\r
+        if validlists is None:\r
+            validlists = []\r
+        if expressions is None:\r
+            expressions = []\r
+        if Packages is None:\r
+            Packages = []\r
         super(StructurePcd, self).__init__(Name, Guid, Type, DatumType, Value, Token, MaxDatumSize, SkuInfoList, IsOverrided, GuidValue, validateranges, validlists, expressions)\r
-        self.StructuredPcdIncludeFile = StructuredPcdIncludeFile\r
+        self.StructuredPcdIncludeFile = [] if StructuredPcdIncludeFile is None else StructuredPcdIncludeFile\r
         self.PackageDecs = Packages\r
-        self.DefaultStoreName = ['STANDARD']\r
-        self.DefaultValues = collections.OrderedDict({})\r
+        self.DefaultStoreName = [default_store]\r
+        self.DefaultValues = collections.OrderedDict()\r
         self.PcdMode = None\r
-        self.SkuOverrideValues = collections.OrderedDict({})\r
+        self.SkuOverrideValues = collections.OrderedDict()\r
         self.FlexibleFieldName = None\r
-\r
+        self.StructName = None\r
+        self.PcdDefineLineNo = 0\r
+        self.PkgPath = ""\r
+        self.DefaultValueFromDec = ""\r
+        self.ValueChain = set()\r
+        self.PcdFieldValueFromComm = collections.OrderedDict()\r
+        self.PcdFieldValueFromFdf = collections.OrderedDict()\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, FileName="", LineNo=0):\r
+    def SetDecDefaultValue(self, DefaultValue):\r
+        self.DefaultValueFromDec = DefaultValue\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
-        self.SkuOverrideValues[SkuName][FieldName] = [Value.strip(), FileName, LineNo]\r
-        return self.SkuOverrideValues[SkuName][FieldName]\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
@@ -155,14 +226,25 @@ class StructurePcd(PcdClassObject):
         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.DscRawValue = PcdObject.DscRawValue if PcdObject.DscRawValue else self.DscRawValue\r
+        self.PcdValueFromComm = PcdObject.PcdValueFromComm if PcdObject.PcdValueFromComm else self.PcdValueFromComm\r
+        self.PcdValueFromFdf = PcdObject.PcdValueFromFdf if PcdObject.PcdValueFromFdf else self.PcdValueFromFdf\r
+        self.DefinitionPosition = PcdObject.DefinitionPosition if PcdObject.DefinitionPosition else self.DefinitionPosition\r
+        if isinstance(PcdObject, 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.OverrideValues = PcdObject.SkuOverrideValues if PcdObject.SkuOverrideValues else self.SkuOverrideValues\r
+            self.DefaultValueFromDec = PcdObject.DefaultValueFromDec if PcdObject.DefaultValueFromDec else self.DefaultValueFromDec\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
+            self.ValueChain = PcdObject.ValueChain if PcdObject.ValueChain else self.ValueChain\r
+            self.PcdFieldValueFromComm = PcdObject.PcdFieldValueFromComm if PcdObject.PcdFieldValueFromComm else self.PcdFieldValueFromComm\r
+            self.PcdFieldValueFromFdf = PcdObject.PcdFieldValueFromFdf if PcdObject.PcdFieldValueFromFdf else self.PcdFieldValueFromFdf\r
 \r
 ## LibraryClassObject\r
 #\r
@@ -181,7 +263,7 @@ class LibraryClassObject(object):
     def __init__(self, Name = None, SupModList = [], Type = None):\r
         self.LibraryClass = Name\r
         self.SupModList = SupModList\r
-        if Type != None:\r
+        if Type is not None:\r
             self.SupModList = CleanString(Type).split(DataType.TAB_SPACE_SPLIT)\r
 \r
 ## ModuleBuildClassObject\r
@@ -250,7 +332,7 @@ class ModuleBuildClassObject(object):
 \r
         self.Binaries                = []\r
         self.Sources                 = []\r
-        self.LibraryClasses          = sdict()\r
+        self.LibraryClasses          = OrderedDict()\r
         self.Libraries               = []\r
         self.Protocols               = []\r
         self.Ppis                    = []\r
@@ -429,4 +511,3 @@ class PlatformBuildClassObject(object):
     #\r
     def __hash__(self):\r
         return hash(self.MetaFile)\r
-\r