]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Workspace/BuildClassObject.py
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
BaseTools: Enable Module Scope Structure Pcd
[mirror_edk2.git] / BaseTools / Source / Python / Workspace / BuildClassObject.py
CommitLineData
30fdf114
LG		 1## @file\r
2# This file is used to define each component of the build database\r
3#\r
c33081c9 4# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
2e351cbe 5# SPDX-License-Identifier: BSD-2-Clause-Patent\r
30fdf114
LG		 6#\r
7\r
b0a26451 8from collections import OrderedDict, namedtuple\r
8518bf0b 9from Common.DataType import *\r
57ee97c0
B		 10import collections\r
11import re\r
12from collections import OrderedDict\r
afe8c411 13from Common.Misc import CopyDict,ArrayIndex\r
bf9e6366 14import copy\r
afe8c411
FZ		 15import Common.EdkLogger as EdkLogger\r
16from Common.BuildToolError import OPTION_VALUE_INVALID\r
000ab985 17from Common.caching import cached_property\r
57ee97c0 18StructPattern = re.compile(r'[_a-zA-Z][0-9A-Za-z_\[\]]*$')\r
afe8c411 19\r
30fdf114
LG		 20## PcdClassObject\r
21#\r
22# This Class is used for PcdObject\r
23#\r
24# @param object: Inherited from object class\r
25# @param Name: Input value for Name of Pcd, default is None\r
26# @param Guid: Input value for Guid of Pcd, default is None\r
27# @param Type: Input value for Type of Pcd, default is None\r
28# @param DatumType: Input value for DatumType of Pcd, default is None\r
29# @param Value: Input value for Value of Pcd, default is None\r
30# @param Token: Input value for Token of Pcd, default is None\r
31# @param MaxDatumSize: Input value for MaxDatumSize of Pcd, default is None\r
32# @param SkuInfoList: Input value for SkuInfoList of Pcd, default is {}\r
33# @param IsOverrided: Input value for IsOverrided of Pcd, default is False\r
e56468c0 34# @param GuidValue: Input value for TokenSpaceGuidValue of Pcd, default is None\r
30fdf114
LG		 35#\r
36# @var TokenCName: To store value for TokenCName\r
37# @var TokenSpaceGuidCName: To store value for TokenSpaceGuidCName\r
38# @var Type: To store value for Type\r
39# @var DatumType: To store value for DatumType\r
40# @var TokenValue: To store value for TokenValue\r
41# @var MaxDatumSize: To store value for MaxDatumSize\r
42# @var SkuInfoList: To store value for SkuInfoList\r
43# @var IsOverrided: To store value for IsOverrided\r
44# @var Phase: To store value for Phase, default is "DXE"\r
45#\r
46class PcdClassObject(object):\r
57ee97c0 47 def __init__(self, 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, IsDsc = False, UserDefinedDefaultStoresFlag = False):\r
30fdf114
LG		 48 self.TokenCName = Name\r
49 self.TokenSpaceGuidCName = Guid\r
50 self.TokenSpaceGuidValue = GuidValue\r
51 self.Type = Type\r
72a1d776 52 self._DatumType = DatumType\r
30fdf114
LG		 53 self.DefaultValue = Value\r
54 self.TokenValue = Token\r
55 self.MaxDatumSize = MaxDatumSize\r
c33081c9 56 self.MaxSizeUserSet = None\r
57ee97c0 57 self.SkuInfoList = SkuInfoList if SkuInfoList is not None else OrderedDict()\r
30fdf114
LG		 58 self.Phase = "DXE"\r
59 self.Pending = False\r
e56468c0 60 self.IsOverrided = IsOverrided\r
a0a2cd1e
FB		 61 self.IsFromBinaryInf = False\r
62 self.IsFromDsc = False\r
57ee97c0
B		 63 self.validateranges = validateranges if validateranges is not None else []\r
64 self.validlists = validlists if validlists is not None else []\r
65 self.expressions = expressions if expressions is not None else []\r
cc71d8b7 66 self.DscDefaultValue = None\r
71127ce8 67 self.DscRawValue = {}\r
afe8c411 68 self.DscRawValueInfo = {}\r
cc71d8b7
YZ		 69 if IsDsc:\r
70 self.DscDefaultValue = Value\r
0f228f19 71 self.PcdValueFromComm = ""\r
543f5ac3 72 self.PcdValueFromFdf = ""\r
09af9bd9 73 self.PcdValueFromComponents = {} #{ModuleGuid:value, file_path,lineNo}\r
6a147d6d 74 self.CustomAttribute = {}\r
ced86858 75 self.UserDefinedDefaultStoresFlag = UserDefinedDefaultStoresFlag\r
72a1d776 76 self._Capacity = None\r
77\r
78 @property\r
79 def Capacity(self):\r
afe8c411
FZ		 80 if self._Capacity is None:\r
81 self._Capacity = []\r
82 dimension = ArrayIndex.findall(self._DatumType)\r
83 for item in dimension:\r
84 maxsize = item.lstrip("[").rstrip("]").strip()\r
85 if not maxsize:\r
86 maxsize = "-1"\r
87 maxsize = str(int(maxsize,16)) if maxsize.startswith(("0x","0X")) else maxsize\r
88 self._Capacity.append(maxsize)\r
89 if hasattr(self, "SkuOverrideValues"):\r
90 for sku in self.SkuOverrideValues:\r
91 for defaultstore in self.SkuOverrideValues[sku]:\r
92 fields = self.SkuOverrideValues[sku][defaultstore]\r
93 for demesionattr in fields:\r
94 fieldinfo = fields[demesionattr]\r
95 deme = ArrayIndex.findall(demesionattr)\r
96 for i in range(len(deme)):\r
97 if int(deme[i].lstrip("[").rstrip("]").strip()) >= int(self._Capacity[i]):\r
98 if self._Capacity[i] != "-1":\r
99 firstfieldinfo = list(fieldinfo.values())[0]\r
100 EdkLogger.error('Build', OPTION_VALUE_INVALID, "For Pcd %s, Array Index exceed the Array size. From %s Line %s \n " %\r
101 (".".join((self.TokenSpaceGuidCName, self.TokenCName)), firstfieldinfo[1],firstfieldinfo[2] ))\r
102 if hasattr(self,"DefaultValues"):\r
103 for demesionattr in self.DefaultValues:\r
104 fieldinfo = self.DefaultValues[demesionattr]\r
105 deme = ArrayIndex.findall(demesionattr)\r
106 for i in range(len(deme)):\r
107 if int(deme[i].lstrip("[").rstrip("]").strip()) >= int(self._Capacity[i]):\r
108 if self._Capacity[i] != "-1":\r
109 firstfieldinfo = list(fieldinfo.values())[0]\r
110 EdkLogger.error('Build', OPTION_VALUE_INVALID, "For Pcd %s, Array Index exceed the Array size. From %s Line %s \n " %\r
111 (".".join((self.TokenSpaceGuidCName, self.TokenCName)), firstfieldinfo[1],firstfieldinfo[2] ))\r
72a1d776 112 return self._Capacity\r
afe8c411
FZ		 113\r
114 def PcdArraySize(self):\r
115 if self.Capacity[-1] == "-1":\r
116 return -1\r
117 size = 1\r
118 for de in self.Capacity:\r
119 size = size * int(de)\r
120 return size\r
72a1d776 121 @property\r
122 def DatumType(self):\r
123 return self._DatumType\r
124\r
125 @DatumType.setter\r
126 def DatumType(self,DataType):\r
127 self._DatumType = DataType\r
128 self._Capacity = None\r
129\r
130 @property\r
131 def BaseDatumType(self):\r
132 if self.IsArray():\r
133 return self._DatumType[:self._DatumType.index("[")]\r
134 else:\r
135 return self._DatumType\r
136 def IsArray(self):\r
137 return True if len(self.Capacity) else False\r
138\r
139 def IsAggregateDatumType(self):\r
140 if self.DatumType in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
141 return False\r
142 if self.IsArray() or StructPattern.match(self.DatumType):\r
143 return True\r
144 return False\r
145\r
146 def IsSimpleTypeArray(self):\r
147 if self.IsArray() and self.BaseDatumType in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, "BOOLEAN"]:\r
148 return True\r
149 return False\r
9904222d 150\r
cfed8a37
FB		 151 @staticmethod\r
152 def GetPcdMaxSizeWorker(PcdString, MaxSize):\r
153 if PcdString.startswith("{") and PcdString.endswith("}"):\r
154 return max([len(PcdString.split(",")),MaxSize])\r
155\r
156 if PcdString.startswith("\"") or PcdString.startswith("\'"):\r
157 return max([len(PcdString)-2+1,MaxSize])\r
158\r
159 if PcdString.startswith("L\""):\r
160 return max([2*(len(PcdString)-3+1),MaxSize])\r
161\r
162 return max([len(PcdString),MaxSize])\r
163\r
5565a8c4
CJ		 164 ## Get the maximum number of bytes\r
165 def GetPcdMaxSize(self):\r
166 if self.DatumType in TAB_PCD_NUMERIC_TYPES:\r
167 return MAX_SIZE_TYPE[self.DatumType]\r
168\r
ccaa7754 169 MaxSize = int(self.MaxDatumSize, 10) if self.MaxDatumSize else 0\r
543f5ac3 170 if self.PcdValueFromFdf:\r
cfed8a37 171 MaxSize = self.GetPcdMaxSizeWorker(self.PcdValueFromFdf,MaxSize)\r
5565a8c4 172 if self.PcdValueFromComm:\r
cfed8a37
FB		 173 MaxSize = self.GetPcdMaxSizeWorker(self.PcdValueFromComm,MaxSize)\r
174 if hasattr(self, "DefaultValueFromDec"):\r
175 MaxSize = self.GetPcdMaxSizeWorker(self.DefaultValueFromDec,MaxSize)\r
5565a8c4
CJ		 176 return MaxSize\r
177\r
178 ## Get the number of bytes\r
179 def GetPcdSize(self):\r
180 if self.DatumType in TAB_PCD_NUMERIC_TYPES:\r
181 return MAX_SIZE_TYPE[self.DatumType]\r
182 if not self.DefaultValue:\r
183 return 1\r
184 elif self.DefaultValue[0] == 'L':\r
185 return (len(self.DefaultValue) - 2) * 2\r
186 elif self.DefaultValue[0] == '{':\r
187 return len(self.DefaultValue.split(','))\r
188 else:\r
189 return len(self.DefaultValue) - 1\r
190\r
191\r
30fdf114
LG		 192 ## Convert the class to a string\r
193 #\r
194 # Convert each member of the class to string\r
fb0b35e0 195 # Organize to a single line format string\r
30fdf114
LG		 196 #\r
197 # @retval Rtn Formatted String\r
198 #\r
199 def __str__(self):\r
200 Rtn = '\tTokenCName=' + str(self.TokenCName) + ', ' + \\r
201 'TokenSpaceGuidCName=' + str(self.TokenSpaceGuidCName) + ', ' + \\r
202 'Type=' + str(self.Type) + ', ' + \\r
203 'DatumType=' + str(self.DatumType) + ', ' + \\r
204 'DefaultValue=' + str(self.DefaultValue) + ', ' + \\r
205 'TokenValue=' + str(self.TokenValue) + ', ' + \\r
206 'MaxDatumSize=' + str(self.MaxDatumSize) + ', '\r
207 for Item in self.SkuInfoList.values():\r
208 Rtn = Rtn + 'SkuId=' + Item.SkuId + ', ' + 'SkuIdName=' + Item.SkuIdName\r
e56468c0 209 Rtn = Rtn + ', IsOverrided=' + str(self.IsOverrided)\r
30fdf114
LG		 210\r
211 return Rtn\r
212\r
213 ## Override __eq__ function\r
214 #\r
215 # Check whether pcds are the same\r
216 #\r
217 # @retval False The two pcds are different\r
218 # @retval True The two pcds are the same\r
219 #\r
220 def __eq__(self, Other):\r
221 return Other and self.TokenCName == Other.TokenCName and self.TokenSpaceGuidCName == Other.TokenSpaceGuidCName\r
222\r
223 ## Override __hash__ function\r
224 #\r
225 # Use (TokenCName, TokenSpaceGuidCName) as key in hash table\r
226 #\r
227 # @retval truple() Key for hash table\r
228 #\r
229 def __hash__(self):\r
230 return hash((self.TokenCName, self.TokenSpaceGuidCName))\r
231\r
000ab985
FB		 232 @cached_property\r
233 def _fullname(self):\r
234 return ".".join((self.TokenSpaceGuidCName,self.TokenCName))\r
235\r
236 def __lt__(self,pcd):\r
237 return self._fullname < pcd._fullname\r
238 def __gt__(self,pcd):\r
239 return self._fullname > pcd._fullname\r
240\r
bf9e6366
B		 241 def sharedcopy(self,new_pcd):\r
242 new_pcd.TokenCName = self.TokenCName\r
243 new_pcd.TokenSpaceGuidCName = self.TokenSpaceGuidCName\r
244 new_pcd.TokenSpaceGuidValue = self.TokenSpaceGuidValue\r
245 new_pcd.Type = self.Type\r
246 new_pcd.DatumType = self.DatumType\r
247 new_pcd.DefaultValue = self.DefaultValue\r
248 new_pcd.TokenValue = self.TokenValue\r
249 new_pcd.MaxDatumSize = self.MaxDatumSize\r
91080395 250 new_pcd.MaxSizeUserSet = self.MaxSizeUserSet\r
bf9e6366
B		 251\r
252 new_pcd.Phase = self.Phase\r
253 new_pcd.Pending = self.Pending\r
254 new_pcd.IsOverrided = self.IsOverrided\r
255 new_pcd.IsFromBinaryInf = self.IsFromBinaryInf\r
256 new_pcd.IsFromDsc = self.IsFromDsc\r
257 new_pcd.PcdValueFromComm = self.PcdValueFromComm\r
258 new_pcd.PcdValueFromFdf = self.PcdValueFromFdf\r
259 new_pcd.UserDefinedDefaultStoresFlag = self.UserDefinedDefaultStoresFlag\r
260 new_pcd.DscRawValue = self.DscRawValue\r
afe8c411 261 new_pcd.DscRawValueInfo = self.DscRawValueInfo\r
bf9e6366
B		 262 new_pcd.CustomAttribute = self.CustomAttribute\r
263 new_pcd.validateranges = [item for item in self.validateranges]\r
264 new_pcd.validlists = [item for item in self.validlists]\r
265 new_pcd.expressions = [item for item in self.expressions]\r
266 new_pcd.SkuInfoList = {key: copy.deepcopy(skuobj) for key,skuobj in self.SkuInfoList.items()}\r
267 return new_pcd\r
268\r
269 def __deepcopy__(self,memo):\r
270 new_pcd = PcdClassObject()\r
271 self.sharedcopy(new_pcd)\r
272 return new_pcd\r
273\r
ae7b6df8 274class StructurePcd(PcdClassObject):\r
9904222d 275 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
8ac64c5b
CJ		 276 if SkuInfoList is None:\r
277 SkuInfoList = {}\r
278 if validateranges is None:\r
279 validateranges = []\r
280 if validlists is None:\r
281 validlists = []\r
282 if expressions is None:\r
283 expressions = []\r
284 if Packages is None:\r
285 Packages = []\r
1ccc4d89 286 super(StructurePcd, self).__init__(Name, Guid, Type, DatumType, Value, Token, MaxDatumSize, SkuInfoList, IsOverrided, GuidValue, validateranges, validlists, expressions)\r
81add864 287 self.StructuredPcdIncludeFile = [] if StructuredPcdIncludeFile is None else StructuredPcdIncludeFile\r
ae7b6df8 288 self.PackageDecs = Packages\r
8518bf0b 289 self.DefaultStoreName = [default_store]\r
b0a26451 290 self.DefaultValues = OrderedDict()\r
ae7b6df8 291 self.PcdMode = None\r
b0a26451 292 self.SkuOverrideValues = OrderedDict()\r
e651d06c 293 self.StructName = None\r
6a103440
FB		 294 self.PcdDefineLineNo = 0\r
295 self.PkgPath = ""\r
06140766 296 self.DefaultValueFromDec = ""\r
afe8c411 297 self.DefaultValueFromDecInfo = None\r
88252a90 298 self.ValueChain = set()\r
b0a26451
CJ		 299 self.PcdFieldValueFromComm = OrderedDict()\r
300 self.PcdFieldValueFromFdf = OrderedDict()\r
c417c1b3 301 self.DefaultFromDSC=None\r
09af9bd9 302 self.PcdFiledValueFromDscComponent = OrderedDict()\r
ae7b6df8
LG		 303 def __repr__(self):\r
304 return self.TypeName\r
305\r
72a1d776 306 def AddDefaultValue (self, FieldName, Value, FileName="", LineNo=0,DimensionAttr ="-1"):\r
307 if DimensionAttr not in self.DefaultValues:\r
308 self.DefaultValues[DimensionAttr] = collections.OrderedDict()\r
309 if FieldName in self.DefaultValues[DimensionAttr]:\r
310 del self.DefaultValues[DimensionAttr][FieldName]\r
311 self.DefaultValues[DimensionAttr][FieldName] = [Value.strip(), FileName, LineNo]\r
312 return self.DefaultValues[DimensionAttr][FieldName]\r
ae7b6df8 313\r
afe8c411 314 def SetDecDefaultValue(self, DefaultValue,decpath=None,lineno=None):\r
06140766 315 self.DefaultValueFromDec = DefaultValue\r
afe8c411 316 self.DefaultValueFromDecInfo = (decpath,lineno)\r
72a1d776 317 def AddOverrideValue (self, FieldName, Value, SkuName, DefaultStoreName, FileName="", LineNo=0, DimensionAttr = '-1'):\r
ae7b6df8 318 if SkuName not in self.SkuOverrideValues:\r
b0a26451 319 self.SkuOverrideValues[SkuName] = OrderedDict()\r
8518bf0b 320 if DefaultStoreName not in self.SkuOverrideValues[SkuName]:\r
b0a26451 321 self.SkuOverrideValues[SkuName][DefaultStoreName] = OrderedDict()\r
72a1d776 322 if DimensionAttr not in self.SkuOverrideValues[SkuName][DefaultStoreName]:\r
323 self.SkuOverrideValues[SkuName][DefaultStoreName][DimensionAttr] = collections.OrderedDict()\r
324 if FieldName in self.SkuOverrideValues[SkuName][DefaultStoreName][DimensionAttr]:\r
48e89045 325 del self.SkuOverrideValues[SkuName][DefaultStoreName][DimensionAttr][FieldName]\r
72a1d776 326 self.SkuOverrideValues[SkuName][DefaultStoreName][DimensionAttr][FieldName] = [Value.strip(), FileName, LineNo]\r
327 return self.SkuOverrideValues[SkuName][DefaultStoreName][DimensionAttr][FieldName]\r
ae7b6df8 328\r
09af9bd9
BF		 329 def AddComponentOverrideValue(self,FieldName, Value, ModuleGuid, FileName="", LineNo=0, DimensionAttr = '-1'):\r
330 self.PcdFiledValueFromDscComponent.setdefault(ModuleGuid, OrderedDict())\r
331 self.PcdFiledValueFromDscComponent[ModuleGuid].setdefault(DimensionAttr,OrderedDict())\r
332 self.PcdFiledValueFromDscComponent[ModuleGuid][DimensionAttr][FieldName] = [Value.strip(), FileName, LineNo]\r
333 return self.PcdFiledValueFromDscComponent[ModuleGuid][DimensionAttr][FieldName]\r
334\r
ae7b6df8
LG		 335 def SetPcdMode (self, PcdMode):\r
336 self.PcdMode = PcdMode\r
337\r
ae7b6df8
LG		 338 def copy(self, PcdObject):\r
339 self.TokenCName = PcdObject.TokenCName if PcdObject.TokenCName else self.TokenCName\r
340 self.TokenSpaceGuidCName = PcdObject.TokenSpaceGuidCName if PcdObject.TokenSpaceGuidCName else PcdObject.TokenSpaceGuidCName\r
341 self.TokenSpaceGuidValue = PcdObject.TokenSpaceGuidValue if PcdObject.TokenSpaceGuidValue else self.TokenSpaceGuidValue\r
342 self.Type = PcdObject.Type if PcdObject.Type else self.Type\r
72a1d776 343 self._DatumType = PcdObject.DatumType if PcdObject.DatumType else self.DatumType\r
ae7b6df8
LG		 344 self.DefaultValue = PcdObject.DefaultValue if PcdObject.DefaultValue else self.DefaultValue\r
345 self.TokenValue = PcdObject.TokenValue if PcdObject.TokenValue else self.TokenValue\r
346 self.MaxDatumSize = PcdObject.MaxDatumSize if PcdObject.MaxDatumSize else self.MaxDatumSize\r
347 self.SkuInfoList = PcdObject.SkuInfoList if PcdObject.SkuInfoList else self.SkuInfoList\r
348 self.Phase = PcdObject.Phase if PcdObject.Phase else self.Phase\r
349 self.Pending = PcdObject.Pending if PcdObject.Pending else self.Pending\r
350 self.IsOverrided = PcdObject.IsOverrided if PcdObject.IsOverrided else self.IsOverrided\r
351 self.IsFromBinaryInf = PcdObject.IsFromBinaryInf if PcdObject.IsFromBinaryInf else self.IsFromBinaryInf\r
352 self.IsFromDsc = PcdObject.IsFromDsc if PcdObject.IsFromDsc else self.IsFromDsc\r
353 self.validateranges = PcdObject.validateranges if PcdObject.validateranges else self.validateranges\r
354 self.validlists = PcdObject.validlists if PcdObject.validlists else self.validlists\r
355 self.expressions = PcdObject.expressions if PcdObject.expressions else self.expressions\r
f3b31433 356 self.DscRawValue = PcdObject.DscRawValue if PcdObject.DscRawValue else self.DscRawValue\r
afe8c411 357 self.DscRawValueInfo = PcdObject.DscRawValueInfo if PcdObject.DscRawValueInfo else self.DscRawValueInfo\r
0f228f19 358 self.PcdValueFromComm = PcdObject.PcdValueFromComm if PcdObject.PcdValueFromComm else self.PcdValueFromComm\r
543f5ac3 359 self.PcdValueFromFdf = PcdObject.PcdValueFromFdf if PcdObject.PcdValueFromFdf else self.PcdValueFromFdf\r
6a147d6d 360 self.CustomAttribute = PcdObject.CustomAttribute if PcdObject.CustomAttribute else self.CustomAttribute\r
ced86858 361 self.UserDefinedDefaultStoresFlag = PcdObject.UserDefinedDefaultStoresFlag if PcdObject.UserDefinedDefaultStoresFlag else self.UserDefinedDefaultStoresFlag\r
0d1f5b2b 362 if isinstance(PcdObject, StructurePcd):\r
ae7b6df8
LG		 363 self.StructuredPcdIncludeFile = PcdObject.StructuredPcdIncludeFile if PcdObject.StructuredPcdIncludeFile else self.StructuredPcdIncludeFile\r
364 self.PackageDecs = PcdObject.PackageDecs if PcdObject.PackageDecs else self.PackageDecs\r
365 self.DefaultValues = PcdObject.DefaultValues if PcdObject.DefaultValues else self.DefaultValues\r
366 self.PcdMode = PcdObject.PcdMode if PcdObject.PcdMode else self.PcdMode\r
06140766 367 self.DefaultValueFromDec = PcdObject.DefaultValueFromDec if PcdObject.DefaultValueFromDec else self.DefaultValueFromDec\r
afe8c411 368 self.DefaultValueFromDecInfo = PcdObject.DefaultValueFromDecInfo if PcdObject.DefaultValueFromDecInfo else self.DefaultValueFromDecInfo\r
65eff519 369 self.SkuOverrideValues = PcdObject.SkuOverrideValues if PcdObject.SkuOverrideValues else self.SkuOverrideValues\r
e651d06c 370 self.StructName = PcdObject.DatumType if PcdObject.DatumType else self.StructName\r
6a103440
FB		 371 self.PcdDefineLineNo = PcdObject.PcdDefineLineNo if PcdObject.PcdDefineLineNo else self.PcdDefineLineNo\r
372 self.PkgPath = PcdObject.PkgPath if PcdObject.PkgPath else self.PkgPath\r
f3b31433 373 self.ValueChain = PcdObject.ValueChain if PcdObject.ValueChain else self.ValueChain\r
b854e2bf 374 self.PcdFieldValueFromComm = PcdObject.PcdFieldValueFromComm if PcdObject.PcdFieldValueFromComm else self.PcdFieldValueFromComm\r
543f5ac3 375 self.PcdFieldValueFromFdf = PcdObject.PcdFieldValueFromFdf if PcdObject.PcdFieldValueFromFdf else self.PcdFieldValueFromFdf\r
09af9bd9 376 self.PcdFiledValueFromDscComponent = PcdObject.PcdFiledValueFromDscComponent if PcdObject.PcdFiledValueFromDscComponent else self.PcdFiledValueFromDscComponent\r
ae7b6df8 377\r
bf9e6366
B		 378 def __deepcopy__(self,memo):\r
379 new_pcd = StructurePcd()\r
380 self.sharedcopy(new_pcd)\r
381\r
382 new_pcd.DefaultValueFromDec = self.DefaultValueFromDec\r
afe8c411 383 new_pcd.DefaultValueFromDecInfo = self.DefaultValueFromDecInfo\r
bf9e6366
B		 384 new_pcd.PcdMode = self.PcdMode\r
385 new_pcd.StructName = self.DatumType\r
386 new_pcd.PcdDefineLineNo = self.PcdDefineLineNo\r
387 new_pcd.PkgPath = self.PkgPath\r
388 new_pcd.StructuredPcdIncludeFile = [item for item in self.StructuredPcdIncludeFile]\r
389 new_pcd.PackageDecs = [item for item in self.PackageDecs]\r
390 new_pcd.DefaultValues = CopyDict(self.DefaultValues)\r
391 new_pcd.DefaultFromDSC=CopyDict(self.DefaultFromDSC)\r
392 new_pcd.SkuOverrideValues = CopyDict(self.SkuOverrideValues)\r
393 new_pcd.PcdFieldValueFromComm = CopyDict(self.PcdFieldValueFromComm)\r
394 new_pcd.PcdFieldValueFromFdf = CopyDict(self.PcdFieldValueFromFdf)\r
09af9bd9 395 new_pcd.PcdFiledValueFromDscComponent = CopyDict(self.PcdFiledValueFromDscComponent)\r
bf9e6366
B		 396 new_pcd.ValueChain = {item for item in self.ValueChain}\r
397 return new_pcd\r
398\r
b56abd91 399LibraryClassObject = namedtuple('LibraryClassObject', ['LibraryClass','SupModList'])\r
30fdf114
LG		 400\r
401## ModuleBuildClassObject\r
402#\r
403# This Class defines ModuleBuildClass\r
404#\r
405# @param object: Inherited from object class\r
406#\r
407# @var MetaFile: To store value for module meta file path\r
408# @var BaseName: To store value for BaseName\r
409# @var ModuleType: To store value for ModuleType\r
410# @var Guid: To store value for Guid\r
411# @var Version: To store value for Version\r
412# @var PcdIsDriver: To store value for PcdIsDriver\r
413# @var BinaryModule: To store value for BinaryModule\r
414# @var CustomMakefile: To store value for CustomMakefile\r
415# @var Specification: To store value for Specification\r
416# @var Shadow To store value for Shadow\r
417# @var LibraryClass: To store value for LibraryClass, it is a list structure as\r
418# [ LibraryClassObject, ...]\r
419# @var ModuleEntryPointList: To store value for ModuleEntryPointList\r
420# @var ModuleUnloadImageList: To store value for ModuleUnloadImageList\r
421# @var ConstructorList: To store value for ConstructorList\r
422# @var DestructorList: To store value for DestructorList\r
423# @var Binaries: To store value for Binaries, it is a list structure as\r
424# [ ModuleBinaryClassObject, ...]\r
425# @var Sources: To store value for Sources, it is a list structure as\r
426# [ ModuleSourceFilesClassObject, ... ]\r
427# @var LibraryClasses: To store value for LibraryClasses, it is a set structure as\r
428# { [LibraryClassName, ModuleType] : LibraryClassInfFile }\r
429# @var Protocols: To store value for Protocols, it is a list structure as\r
430# [ ProtocolName, ... ]\r
431# @var Ppis: To store value for Ppis, it is a list structure as\r
432# [ PpiName, ... ]\r
433# @var Guids: To store value for Guids, it is a list structure as\r
434# [ GuidName, ... ]\r
435# @var Includes: To store value for Includes, it is a list structure as\r
436# [ IncludePath, ... ]\r
437# @var Packages: To store value for Packages, it is a list structure as\r
438# [ DecFileName, ... ]\r
439# @var Pcds: To store value for Pcds, it is a set structure as\r
440# { [(PcdCName, PcdGuidCName)] : PcdClassObject}\r
441# @var BuildOptions: To store value for BuildOptions, it is a set structure as\r
442# { [BuildOptionKey] : BuildOptionValue}\r
443# @var Depex: To store value for Depex\r
444#\r
445class ModuleBuildClassObject(object):\r
446 def __init__(self):\r
447 self.AutoGenVersion = 0\r
448 self.MetaFile = ''\r
449 self.BaseName = ''\r
450 self.ModuleType = ''\r
451 self.Guid = ''\r
452 self.Version = ''\r
453 self.PcdIsDriver = ''\r
454 self.BinaryModule = ''\r
455 self.Shadow = ''\r
30fdf114
LG		 456 self.CustomMakefile = {}\r
457 self.Specification = {}\r
458 self.LibraryClass = []\r
459 self.ModuleEntryPointList = []\r
460 self.ModuleUnloadImageList = []\r
461 self.ConstructorList = []\r
462 self.DestructorList = []\r
463\r
464 self.Binaries = []\r
465 self.Sources = []\r
b0a26451 466 self.LibraryClasses = OrderedDict()\r
30fdf114
LG		 467 self.Libraries = []\r
468 self.Protocols = []\r
469 self.Ppis = []\r
470 self.Guids = []\r
471 self.Includes = []\r
472 self.Packages = []\r
473 self.Pcds = {}\r
474 self.BuildOptions = {}\r
475 self.Depex = {}\r
09af9bd9
BF		 476 self.StrPcdSet = []\r
477 self.StrPcdOverallValue = {}\r
30fdf114
LG		 478\r
479 ## Convert the class to a string\r
480 #\r
481 # Convert member MetaFile of the class to a string\r
482 #\r
483 # @retval string Formatted String\r
484 #\r
485 def __str__(self):\r
486 return str(self.MetaFile)\r
487\r
488 ## Override __eq__ function\r
489 #\r
490 # Check whether ModuleBuildClassObjects are the same\r
491 #\r
492 # @retval False The two ModuleBuildClassObjects are different\r
493 # @retval True The two ModuleBuildClassObjects are the same\r
494 #\r
495 def __eq__(self, Other):\r
496 return self.MetaFile == Other\r
497\r
498 ## Override __hash__ function\r
499 #\r
500 # Use MetaFile as key in hash table\r
501 #\r
502 # @retval string Key for hash table\r
503 #\r
504 def __hash__(self):\r
505 return hash(self.MetaFile)\r
506\r
507## PackageBuildClassObject\r
508#\r
509# This Class defines PackageBuildClass\r
510#\r
511# @param object: Inherited from object class\r
512#\r
513# @var MetaFile: To store value for package meta file path\r
514# @var PackageName: To store value for PackageName\r
515# @var Guid: To store value for Guid\r
516# @var Version: To store value for Version\r
517# @var Protocols: To store value for Protocols, it is a set structure as\r
518# { [ProtocolName] : Protocol Guid, ... }\r
519# @var Ppis: To store value for Ppis, it is a set structure as\r
520# { [PpiName] : Ppi Guid, ... }\r
521# @var Guids: To store value for Guids, it is a set structure as\r
522# { [GuidName] : Guid, ... }\r
523# @var Includes: To store value for Includes, it is a list structure as\r
524# [ IncludePath, ... ]\r
525# @var LibraryClasses: To store value for LibraryClasses, it is a set structure as\r
526# { [LibraryClassName] : LibraryClassInfFile }\r
527# @var Pcds: To store value for Pcds, it is a set structure as\r
528# { [(PcdCName, PcdGuidCName)] : PcdClassObject}\r
529#\r
530class PackageBuildClassObject(object):\r
531 def __init__(self):\r
532 self.MetaFile = ''\r
533 self.PackageName = ''\r
534 self.Guid = ''\r
535 self.Version = ''\r
536\r
537 self.Protocols = {}\r
538 self.Ppis = {}\r
539 self.Guids = {}\r
540 self.Includes = []\r
541 self.LibraryClasses = {}\r
542 self.Pcds = {}\r
543\r
544 ## Convert the class to a string\r
545 #\r
546 # Convert member MetaFile of the class to a string\r
547 #\r
548 # @retval string Formatted String\r
549 #\r
550 def __str__(self):\r
551 return str(self.MetaFile)\r
552\r
553 ## Override __eq__ function\r
554 #\r
555 # Check whether PackageBuildClassObjects are the same\r
556 #\r
557 # @retval False The two PackageBuildClassObjects are different\r
558 # @retval True The two PackageBuildClassObjects are the same\r
559 #\r
560 def __eq__(self, Other):\r
561 return self.MetaFile == Other\r
562\r
563 ## Override __hash__ function\r
564 #\r
565 # Use MetaFile as key in hash table\r
566 #\r
567 # @retval string Key for hash table\r
568 #\r
569 def __hash__(self):\r
570 return hash(self.MetaFile)\r
571\r
572## PlatformBuildClassObject\r
573#\r
574# This Class defines PlatformBuildClass\r
575#\r
576# @param object: Inherited from object class\r
577#\r
578# @var MetaFile: To store value for platform meta-file path\r
579# @var PlatformName: To store value for PlatformName\r
580# @var Guid: To store value for Guid\r
581# @var Version: To store value for Version\r
582# @var DscSpecification: To store value for DscSpecification\r
583# @var OutputDirectory: To store value for OutputDirectory\r
584# @var FlashDefinition: To store value for FlashDefinition\r
585# @var BuildNumber: To store value for BuildNumber\r
586# @var MakefileName: To store value for MakefileName\r
587# @var SkuIds: To store value for SkuIds, it is a set structure as\r
588# { 'SkuName' : SkuId, '!include' : includefilename, ...}\r
589# @var Modules: To store value for Modules, it is a list structure as\r
590# [ InfFileName, ... ]\r
591# @var Libraries: To store value for Libraries, it is a list structure as\r
592# [ InfFileName, ... ]\r
593# @var LibraryClasses: To store value for LibraryClasses, it is a set structure as\r
594# { (LibraryClassName, ModuleType) : LibraryClassInfFile }\r
595# @var Pcds: To store value for Pcds, it is a set structure as\r
596# { [(PcdCName, PcdGuidCName)] : PcdClassObject }\r
597# @var BuildOptions: To store value for BuildOptions, it is a set structure as\r
598# { [BuildOptionKey] : BuildOptionValue }\r
599#\r
600class PlatformBuildClassObject(object):\r
601 def __init__(self):\r
602 self.MetaFile = ''\r
603 self.PlatformName = ''\r
604 self.Guid = ''\r
605 self.Version = ''\r
606 self.DscSpecification = ''\r
607 self.OutputDirectory = ''\r
608 self.FlashDefinition = ''\r
609 self.BuildNumber = ''\r
610 self.MakefileName = ''\r
611\r
612 self.SkuIds = {}\r
613 self.Modules = []\r
614 self.LibraryInstances = []\r
615 self.LibraryClasses = {}\r
616 self.Libraries = {}\r
617 self.Pcds = {}\r
618 self.BuildOptions = {}\r
619\r
620 ## Convert the class to a string\r
621 #\r
622 # Convert member MetaFile of the class to a string\r
623 #\r
624 # @retval string Formatted String\r
625 #\r
626 def __str__(self):\r
627 return str(self.MetaFile)\r
628\r
629 ## Override __eq__ function\r
630 #\r
631 # Check whether PlatformBuildClassObjects are the same\r
632 #\r
633 # @retval False The two PlatformBuildClassObjects are different\r
634 # @retval True The two PlatformBuildClassObjects are the same\r
635 #\r
636 def __eq__(self, Other):\r
637 return self.MetaFile == Other\r
638\r
639 ## Override __hash__ function\r
640 #\r
641 # Use MetaFile as key in hash table\r
642 #\r
643 # @retval string Key for hash table\r
644 #\r
645 def __hash__(self):\r
646 return hash(self.MetaFile)\r
EFI Development Kit II mirror for PVE