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