]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Workspace/MetaFileParser.py
OvmfPkg/PlatformPei: provide 10 * 4KB of PCI IO Port space on Q35
[mirror_edk2.git] / BaseTools / Source / Python / Workspace / MetaFileParser.py
CommitLineData
f51461c8
LG
1## @file\r
2# This file is used to parse meta files\r
3#\r
f0dc69e6 4# Copyright (c) 2008 - 2016, Intel Corporation. All rights reserved.<BR>\r
cdd1b5e5 5# (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>\r
f51461c8
LG
6# This program and the accompanying materials\r
7# are licensed and made available under the terms and conditions of the BSD License\r
8# which accompanies this distribution. The full text of the license may be found at\r
9# http://opensource.org/licenses/bsd-license.php\r
10#\r
11# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13#\r
14\r
15##\r
16# Import Modules\r
17#\r
1be2ed90 18import Common.LongFilePathOs as os\r
f51461c8
LG
19import re\r
20import time\r
21import copy\r
22\r
23import Common.EdkLogger as EdkLogger\r
24import Common.GlobalData as GlobalData\r
25\r
26from CommonDataClass.DataClass import *\r
27from Common.DataType import *\r
28from Common.String import *\r
29from Common.Misc import GuidStructureStringToGuidString, CheckPcdDatum, PathClass, AnalyzePcdData, AnalyzeDscPcd\r
30from Common.Expression import *\r
31from CommonDataClass.Exceptions import *\r
1be2ed90 32from Common.LongFilePathSupport import OpenLongFilePath as open\r
f51461c8
LG
33\r
34from MetaFileTable import MetaFileStorage\r
97fa0ee9 35from MetaFileCommentParser import CheckInfComment\r
f51461c8
LG
36\r
37## A decorator used to parse macro definition\r
38def ParseMacro(Parser):\r
39 def MacroParser(self):\r
40 Match = gMacroDefPattern.match(self._CurrentLine)\r
41 if not Match:\r
42 # Not 'DEFINE/EDK_GLOBAL' statement, call decorated method\r
43 Parser(self)\r
44 return\r
45\r
46 TokenList = GetSplitValueList(self._CurrentLine[Match.end(1):], TAB_EQUAL_SPLIT, 1)\r
47 # Syntax check\r
48 if not TokenList[0]:\r
49 EdkLogger.error('Parser', FORMAT_INVALID, "No macro name given",\r
50 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
51 if len(TokenList) < 2:\r
52 TokenList.append('')\r
53\r
54 Type = Match.group(1)\r
55 Name, Value = TokenList\r
56 # Global macros can be only defined via environment variable\r
57 if Name in GlobalData.gGlobalDefines:\r
58 EdkLogger.error('Parser', FORMAT_INVALID, "%s can only be defined via environment variable" % Name,\r
59 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
60 # Only upper case letters, digit and '_' are allowed\r
61 if not gMacroNamePattern.match(Name):\r
62 EdkLogger.error('Parser', FORMAT_INVALID, "The macro name must be in the pattern [A-Z][A-Z0-9_]*",\r
63 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
64\r
65 Value = ReplaceMacro(Value, self._Macros)\r
66 if Type in self.DataType:\r
67 self._ItemType = self.DataType[Type]\r
68 else:\r
69 self._ItemType = MODEL_META_DATA_DEFINE\r
70 # DEFINE defined macros\r
71 if Type == TAB_DSC_DEFINES_DEFINE:\r
72 #\r
73 # First judge whether this DEFINE is in conditional directive statements or not.\r
74 #\r
75 if type(self) == DscParser and self._InDirective > -1:\r
76 pass\r
77 else:\r
78 if type(self) == DecParser:\r
79 if MODEL_META_DATA_HEADER in self._SectionType:\r
80 self._FileLocalMacros[Name] = Value\r
81 else:\r
82 self._ConstructSectionMacroDict(Name, Value)\r
83 elif self._SectionType == MODEL_META_DATA_HEADER:\r
84 self._FileLocalMacros[Name] = Value\r
85 else:\r
86 self._ConstructSectionMacroDict(Name, Value)\r
87\r
88 # EDK_GLOBAL defined macros\r
89 elif type(self) != DscParser:\r
90 EdkLogger.error('Parser', FORMAT_INVALID, "EDK_GLOBAL can only be used in .dsc file",\r
91 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
92 elif self._SectionType != MODEL_META_DATA_HEADER:\r
93 EdkLogger.error('Parser', FORMAT_INVALID, "EDK_GLOBAL can only be used under [Defines] section",\r
94 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
95 elif (Name in self._FileLocalMacros) and (self._FileLocalMacros[Name] != Value):\r
96 EdkLogger.error('Parser', FORMAT_INVALID, "EDK_GLOBAL defined a macro with the same name and different value as one defined by 'DEFINE'",\r
97 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
98\r
99 self._ValueList = [Type, Name, Value]\r
100\r
101 return MacroParser\r
102\r
103## Base class of parser\r
104#\r
105# This class is used for derivation purpose. The specific parser for one kind\r
106# type file must derive this class and implement some public interfaces.\r
107#\r
108# @param FilePath The path of platform description file\r
109# @param FileType The raw data of DSC file\r
110# @param Table Database used to retrieve module/package information\r
111# @param Macros Macros used for replacement in file\r
112# @param Owner Owner ID (for sub-section parsing)\r
113# @param From ID from which the data comes (for !INCLUDE directive)\r
114#\r
115class MetaFileParser(object):\r
116 # data type (file content) for specific file type\r
117 DataType = {}\r
118\r
119 # Parser objects used to implement singleton\r
120 MetaFiles = {}\r
121\r
122 ## Factory method\r
123 #\r
124 # One file, one parser object. This factory method makes sure that there's\r
125 # only one object constructed for one meta file.\r
126 #\r
127 # @param Class class object of real AutoGen class\r
128 # (InfParser, DecParser or DscParser)\r
129 # @param FilePath The path of meta file\r
130 # @param *args The specific class related parameters\r
131 # @param **kwargs The specific class related dict parameters\r
132 #\r
133 def __new__(Class, FilePath, *args, **kwargs):\r
134 if FilePath in Class.MetaFiles:\r
135 return Class.MetaFiles[FilePath]\r
136 else:\r
137 ParserObject = super(MetaFileParser, Class).__new__(Class)\r
138 Class.MetaFiles[FilePath] = ParserObject\r
139 return ParserObject\r
140\r
141 ## Constructor of MetaFileParser\r
142 #\r
143 # Initialize object of MetaFileParser\r
144 #\r
145 # @param FilePath The path of platform description file\r
146 # @param FileType The raw data of DSC file\r
cdd1b5e5 147 # @param Arch Default Arch value for filtering sections\r
f51461c8 148 # @param Table Database used to retrieve module/package information\r
f51461c8
LG
149 # @param Owner Owner ID (for sub-section parsing)\r
150 # @param From ID from which the data comes (for !INCLUDE directive)\r
151 #\r
cdd1b5e5 152 def __init__(self, FilePath, FileType, Arch, Table, Owner= -1, From= -1):\r
f51461c8
LG
153 self._Table = Table\r
154 self._RawTable = Table\r
cdd1b5e5 155 self._Arch = Arch\r
f51461c8
LG
156 self._FileType = FileType\r
157 self.MetaFile = FilePath\r
158 self._FileDir = self.MetaFile.Dir\r
159 self._Defines = {}\r
160 self._FileLocalMacros = {}\r
161 self._SectionsMacroDict = {}\r
162\r
163 # for recursive parsing\r
164 self._Owner = [Owner]\r
165 self._From = From\r
166\r
167 # parsr status for parsing\r
168 self._ValueList = ['', '', '', '', '']\r
169 self._Scope = []\r
170 self._LineIndex = 0\r
171 self._CurrentLine = ''\r
172 self._SectionType = MODEL_UNKNOWN\r
173 self._SectionName = ''\r
174 self._InSubsection = False\r
175 self._SubsectionType = MODEL_UNKNOWN\r
176 self._SubsectionName = ''\r
177 self._ItemType = MODEL_UNKNOWN\r
178 self._LastItem = -1\r
179 self._Enabled = 0\r
180 self._Finished = False\r
181 self._PostProcessed = False\r
182 # Different version of meta-file has different way to parse.\r
183 self._Version = 0\r
184\r
185 ## Store the parsed data in table\r
186 def _Store(self, *Args):\r
187 return self._Table.Insert(*Args)\r
188\r
189 ## Virtual method for starting parse\r
190 def Start(self):\r
191 raise NotImplementedError\r
192\r
193 ## Notify a post-process is needed\r
194 def DoPostProcess(self):\r
195 self._PostProcessed = False\r
196\r
197 ## Set parsing complete flag in both class and table\r
198 def _Done(self):\r
199 self._Finished = True\r
200 ## Do not set end flag when processing included files\r
201 if self._From == -1:\r
202 self._Table.SetEndFlag()\r
203\r
204 def _PostProcess(self):\r
205 self._PostProcessed = True\r
206\r
207 ## Get the parse complete flag\r
208 def _GetFinished(self):\r
209 return self._Finished\r
210\r
211 ## Set the complete flag\r
212 def _SetFinished(self, Value):\r
213 self._Finished = Value\r
214\r
cdd1b5e5
TP
215 ## Remove records that do not match given Filter Arch\r
216 def _FilterRecordList(self, RecordList, FilterArch):\r
217 NewRecordList = []\r
218 for Record in RecordList:\r
219 Arch = Record[3]\r
220 if Arch == 'COMMON' or Arch == FilterArch:\r
221 NewRecordList.append(Record)\r
222 return NewRecordList\r
223\r
f51461c8
LG
224 ## Use [] style to query data in table, just for readability\r
225 #\r
226 # DataInfo = [data_type, scope1(arch), scope2(platform/moduletype)]\r
227 #\r
228 def __getitem__(self, DataInfo):\r
229 if type(DataInfo) != type(()):\r
230 DataInfo = (DataInfo,)\r
231\r
232 # Parse the file first, if necessary\r
233 if not self._Finished:\r
234 if self._RawTable.IsIntegrity():\r
235 self._Finished = True\r
236 else:\r
237 self._Table = self._RawTable\r
238 self._PostProcessed = False\r
239 self.Start()\r
240\r
241 # No specific ARCH or Platform given, use raw data\r
242 if self._RawTable and (len(DataInfo) == 1 or DataInfo[1] == None):\r
cdd1b5e5 243 return self._FilterRecordList(self._RawTable.Query(*DataInfo), self._Arch)\r
f51461c8
LG
244\r
245 # Do post-process if necessary\r
246 if not self._PostProcessed:\r
247 self._PostProcess()\r
248\r
cdd1b5e5 249 return self._FilterRecordList(self._Table.Query(*DataInfo), DataInfo[1])\r
f51461c8
LG
250\r
251 ## Data parser for the common format in different type of file\r
252 #\r
253 # The common format in the meatfile is like\r
254 #\r
255 # xxx1 | xxx2 | xxx3\r
256 #\r
257 @ParseMacro\r
258 def _CommonParser(self):\r
259 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
260 self._ValueList[0:len(TokenList)] = TokenList\r
261\r
262 ## Data parser for the format in which there's path\r
263 #\r
264 # Only path can have macro used. So we need to replace them before use.\r
265 #\r
266 @ParseMacro\r
267 def _PathParser(self):\r
268 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
269 self._ValueList[0:len(TokenList)] = TokenList\r
270 # Don't do macro replacement for dsc file at this point\r
271 if type(self) != DscParser:\r
272 Macros = self._Macros\r
273 self._ValueList = [ReplaceMacro(Value, Macros) for Value in self._ValueList]\r
274\r
275 ## Skip unsupported data\r
276 def _Skip(self):\r
277 EdkLogger.warn("Parser", "Unrecognized content", File=self.MetaFile,\r
278 Line=self._LineIndex + 1, ExtraData=self._CurrentLine);\r
279 self._ValueList[0:1] = [self._CurrentLine]\r
280\r
0923aa1c
HC
281 ## Skip unsupported data for UserExtension Section\r
282 def _SkipUserExtension(self):\r
283 self._ValueList[0:1] = [self._CurrentLine]\r
284\r
f51461c8
LG
285 ## Section header parser\r
286 #\r
287 # The section header is always in following format:\r
288 #\r
289 # [section_name.arch<.platform|module_type>]\r
290 #\r
291 def _SectionHeaderParser(self):\r
292 self._Scope = []\r
293 self._SectionName = ''\r
294 ArchList = set()\r
295 for Item in GetSplitValueList(self._CurrentLine[1:-1], TAB_COMMA_SPLIT):\r
296 if Item == '':\r
297 continue\r
298 ItemList = GetSplitValueList(Item, TAB_SPLIT,2)\r
299 # different section should not mix in one section\r
300 if self._SectionName != '' and self._SectionName != ItemList[0].upper():\r
301 EdkLogger.error('Parser', FORMAT_INVALID, "Different section names in the same section",\r
302 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)\r
303 self._SectionName = ItemList[0].upper()\r
304 if self._SectionName in self.DataType:\r
305 self._SectionType = self.DataType[self._SectionName]\r
306 # Check if the section name is valid\r
307 if self._SectionName not in SECTIONS_HAVE_ITEM_AFTER_ARCH and len(ItemList) > 3:\r
308 EdkLogger.error("Parser", FORMAT_UNKNOWN_ERROR, "%s is not a valid section name" % Item,\r
309 self.MetaFile, self._LineIndex + 1, self._CurrentLine)\r
310 elif self._Version >= 0x00010005:\r
311 EdkLogger.error("Parser", FORMAT_UNKNOWN_ERROR, "%s is not a valid section name" % Item,\r
312 self.MetaFile, self._LineIndex + 1, self._CurrentLine)\r
313 else:\r
314 self._SectionType = MODEL_UNKNOWN\r
315\r
316 # S1 is always Arch\r
317 if len(ItemList) > 1:\r
318 S1 = ItemList[1].upper()\r
319 else:\r
320 S1 = 'COMMON'\r
321 ArchList.add(S1)\r
322\r
323 # S2 may be Platform or ModuleType\r
324 if len(ItemList) > 2:\r
325 if self._SectionName.upper() in SECTIONS_HAVE_ITEM_PCD:\r
326 S2 = ItemList[2]\r
327 else:\r
328 S2 = ItemList[2].upper()\r
329 else:\r
330 S2 = 'COMMON'\r
331 self._Scope.append([S1, S2])\r
332\r
333 # 'COMMON' must not be used with specific ARCHs at the same section\r
334 if 'COMMON' in ArchList and len(ArchList) > 1:\r
335 EdkLogger.error('Parser', FORMAT_INVALID, "'common' ARCH must not be used with specific ARCHs",\r
336 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)\r
337 # If the section information is needed later, it should be stored in database\r
338 self._ValueList[0] = self._SectionName\r
339\r
340 ## [defines] section parser\r
341 @ParseMacro\r
342 def _DefineParser(self):\r
343 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
344 self._ValueList[1:len(TokenList)] = TokenList\r
345 if not self._ValueList[1]:\r
346 EdkLogger.error('Parser', FORMAT_INVALID, "No name specified",\r
347 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
348 if not self._ValueList[2]:\r
349 EdkLogger.error('Parser', FORMAT_INVALID, "No value specified",\r
350 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
351\r
352 self._ValueList = [ReplaceMacro(Value, self._Macros) for Value in self._ValueList]\r
353 Name, Value = self._ValueList[1], self._ValueList[2]\r
354 # Sometimes, we need to make differences between EDK and EDK2 modules \r
355 if Name == 'INF_VERSION':\r
3ab1434a
YZ
356 if re.match(r'0[xX][\da-f-A-F]{5,8}', Value):\r
357 self._Version = int(Value, 0) \r
358 elif re.match(r'\d+\.\d+', Value):\r
359 ValueList = Value.split('.')\r
360 Major = '%04o' % int(ValueList[0], 0)\r
361 Minor = '%04o' % int(ValueList[1], 0)\r
362 self._Version = int('0x' + Major + Minor, 0)\r
363 else:\r
f51461c8
LG
364 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid version number",\r
365 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
366\r
367 if type(self) == InfParser and self._Version < 0x00010005:\r
368 # EDK module allows using defines as macros\r
369 self._FileLocalMacros[Name] = Value\r
370 self._Defines[Name] = Value\r
371\r
372 ## [BuildOptions] section parser\r
373 @ParseMacro\r
374 def _BuildOptionParser(self):\r
375 self._CurrentLine = CleanString(self._CurrentLine, BuildOption=True)\r
376 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
377 TokenList2 = GetSplitValueList(TokenList[0], ':', 1)\r
378 if len(TokenList2) == 2:\r
379 self._ValueList[0] = TokenList2[0] # toolchain family\r
380 self._ValueList[1] = TokenList2[1] # keys\r
381 else:\r
382 self._ValueList[1] = TokenList[0]\r
383 if len(TokenList) == 2 and type(self) != DscParser: # value\r
384 self._ValueList[2] = ReplaceMacro(TokenList[1], self._Macros)\r
385\r
386 if self._ValueList[1].count('_') != 4:\r
387 EdkLogger.error(\r
388 'Parser',\r
389 FORMAT_INVALID,\r
390 "'%s' must be in format of <TARGET>_<TOOLCHAIN>_<ARCH>_<TOOL>_FLAGS" % self._ValueList[1],\r
391 ExtraData=self._CurrentLine,\r
392 File=self.MetaFile,\r
393 Line=self._LineIndex + 1\r
394 )\r
82a6a960
BF
395 def GetValidExpression(self, TokenSpaceGuid, PcdCName):\r
396 return self._Table.GetValidExpression(TokenSpaceGuid, PcdCName)\r
f51461c8
LG
397 def _GetMacros(self):\r
398 Macros = {}\r
399 Macros.update(self._FileLocalMacros)\r
400 Macros.update(self._GetApplicableSectionMacro())\r
401 return Macros\r
402\r
403 ## Construct section Macro dict \r
404 def _ConstructSectionMacroDict(self, Name, Value):\r
405 ScopeKey = [(Scope[0], Scope[1]) for Scope in self._Scope]\r
406 ScopeKey = tuple(ScopeKey)\r
407 SectionDictKey = self._SectionType, ScopeKey\r
408 #\r
409 # DecParser SectionType is a list, will contain more than one item only in Pcd Section\r
410 # As Pcd section macro usage is not alllowed, so here it is safe\r
411 #\r
412 if type(self) == DecParser:\r
413 SectionDictKey = self._SectionType[0], ScopeKey\r
414 if SectionDictKey not in self._SectionsMacroDict:\r
415 self._SectionsMacroDict[SectionDictKey] = {}\r
416 SectionLocalMacros = self._SectionsMacroDict[SectionDictKey]\r
417 SectionLocalMacros[Name] = Value\r
418\r
419 ## Get section Macros that are applicable to current line, which may come from other sections \r
420 ## that share the same name while scope is wider\r
421 def _GetApplicableSectionMacro(self):\r
422 Macros = {}\r
423\r
424 ComComMacroDict = {}\r
425 ComSpeMacroDict = {}\r
426 SpeSpeMacroDict = {}\r
427\r
428 ActiveSectionType = self._SectionType\r
429 if type(self) == DecParser:\r
430 ActiveSectionType = self._SectionType[0]\r
431\r
432 for (SectionType, Scope) in self._SectionsMacroDict:\r
433 if SectionType != ActiveSectionType:\r
434 continue\r
435\r
436 for ActiveScope in self._Scope:\r
437 Scope0, Scope1 = ActiveScope[0], ActiveScope[1]\r
438 if(Scope0, Scope1) not in Scope:\r
439 break\r
440 else:\r
441 SpeSpeMacroDict.update(self._SectionsMacroDict[(SectionType, Scope)])\r
442\r
443 for ActiveScope in self._Scope:\r
444 Scope0, Scope1 = ActiveScope[0], ActiveScope[1]\r
445 if(Scope0, Scope1) not in Scope and (Scope0, "COMMON") not in Scope and ("COMMON", Scope1) not in Scope:\r
446 break\r
447 else:\r
448 ComSpeMacroDict.update(self._SectionsMacroDict[(SectionType, Scope)])\r
449\r
450 if ("COMMON", "COMMON") in Scope:\r
451 ComComMacroDict.update(self._SectionsMacroDict[(SectionType, Scope)])\r
452\r
453 Macros.update(ComComMacroDict)\r
454 Macros.update(ComSpeMacroDict)\r
455 Macros.update(SpeSpeMacroDict)\r
456\r
457 return Macros\r
458\r
459 _SectionParser = {}\r
460 Finished = property(_GetFinished, _SetFinished)\r
461 _Macros = property(_GetMacros)\r
462\r
463\r
464## INF file parser class\r
465#\r
466# @param FilePath The path of platform description file\r
467# @param FileType The raw data of DSC file\r
468# @param Table Database used to retrieve module/package information\r
469# @param Macros Macros used for replacement in file\r
470#\r
471class InfParser(MetaFileParser):\r
472 # INF file supported data types (one type per section)\r
473 DataType = {\r
474 TAB_UNKNOWN.upper() : MODEL_UNKNOWN,\r
475 TAB_INF_DEFINES.upper() : MODEL_META_DATA_HEADER,\r
476 TAB_DSC_DEFINES_DEFINE : MODEL_META_DATA_DEFINE,\r
477 TAB_BUILD_OPTIONS.upper() : MODEL_META_DATA_BUILD_OPTION,\r
478 TAB_INCLUDES.upper() : MODEL_EFI_INCLUDE,\r
479 TAB_LIBRARIES.upper() : MODEL_EFI_LIBRARY_INSTANCE,\r
480 TAB_LIBRARY_CLASSES.upper() : MODEL_EFI_LIBRARY_CLASS,\r
481 TAB_PACKAGES.upper() : MODEL_META_DATA_PACKAGE,\r
482 TAB_NMAKE.upper() : MODEL_META_DATA_NMAKE,\r
483 TAB_INF_FIXED_PCD.upper() : MODEL_PCD_FIXED_AT_BUILD,\r
484 TAB_INF_PATCH_PCD.upper() : MODEL_PCD_PATCHABLE_IN_MODULE,\r
485 TAB_INF_FEATURE_PCD.upper() : MODEL_PCD_FEATURE_FLAG,\r
486 TAB_INF_PCD_EX.upper() : MODEL_PCD_DYNAMIC_EX,\r
487 TAB_INF_PCD.upper() : MODEL_PCD_DYNAMIC,\r
488 TAB_SOURCES.upper() : MODEL_EFI_SOURCE_FILE,\r
489 TAB_GUIDS.upper() : MODEL_EFI_GUID,\r
490 TAB_PROTOCOLS.upper() : MODEL_EFI_PROTOCOL,\r
491 TAB_PPIS.upper() : MODEL_EFI_PPI,\r
492 TAB_DEPEX.upper() : MODEL_EFI_DEPEX,\r
493 TAB_BINARIES.upper() : MODEL_EFI_BINARY_FILE,\r
494 TAB_USER_EXTENSIONS.upper() : MODEL_META_DATA_USER_EXTENSION\r
495 }\r
496\r
497 ## Constructor of InfParser\r
498 #\r
499 # Initialize object of InfParser\r
500 #\r
501 # @param FilePath The path of module description file\r
502 # @param FileType The raw data of DSC file\r
cdd1b5e5 503 # @param Arch Default Arch value for filtering sections\r
f51461c8 504 # @param Table Database used to retrieve module/package information\r
f51461c8 505 #\r
cdd1b5e5 506 def __init__(self, FilePath, FileType, Arch, Table):\r
f51461c8
LG
507 # prevent re-initialization\r
508 if hasattr(self, "_Table"):\r
509 return\r
cdd1b5e5 510 MetaFileParser.__init__(self, FilePath, FileType, Arch, Table)\r
f51461c8
LG
511 self.PcdsDict = {}\r
512\r
513 ## Parser starter\r
514 def Start(self):\r
515 NmakeLine = ''\r
516 Content = ''\r
517 try:\r
518 Content = open(str(self.MetaFile), 'r').readlines()\r
519 except:\r
520 EdkLogger.error("Parser", FILE_READ_FAILURE, ExtraData=self.MetaFile)\r
521\r
522 # parse the file line by line\r
523 IsFindBlockComment = False\r
524 GetHeaderComment = False\r
525 TailComments = []\r
526 SectionComments = []\r
527 Comments = []\r
528\r
529 for Index in range(0, len(Content)):\r
530 # skip empty, commented, block commented lines\r
531 Line, Comment = CleanString2(Content[Index], AllowCppStyleComment=True)\r
532 NextLine = ''\r
533 if Index + 1 < len(Content):\r
534 NextLine, NextComment = CleanString2(Content[Index + 1])\r
535 if Line == '':\r
536 if Comment:\r
537 Comments.append((Comment, Index + 1))\r
538 elif GetHeaderComment:\r
539 SectionComments.extend(Comments)\r
540 Comments = []\r
541 continue\r
542 if Line.find(DataType.TAB_COMMENT_EDK_START) > -1:\r
543 IsFindBlockComment = True\r
544 continue\r
545 if Line.find(DataType.TAB_COMMENT_EDK_END) > -1:\r
546 IsFindBlockComment = False\r
547 continue\r
548 if IsFindBlockComment:\r
549 continue\r
550\r
551 self._LineIndex = Index\r
552 self._CurrentLine = Line\r
553\r
554 # section header\r
555 if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:\r
556 if not GetHeaderComment:\r
557 for Cmt, LNo in Comments:\r
558 self._Store(MODEL_META_DATA_HEADER_COMMENT, Cmt, '', '', 'COMMON',\r
559 'COMMON', self._Owner[-1], LNo, -1, LNo, -1, 0)\r
560 GetHeaderComment = True\r
561 else:\r
562 TailComments.extend(SectionComments + Comments)\r
563 Comments = []\r
564 self._SectionHeaderParser()\r
565 # Check invalid sections\r
566 if self._Version < 0x00010005:\r
567 if self._SectionType in [MODEL_META_DATA_BUILD_OPTION,\r
568 MODEL_EFI_LIBRARY_CLASS,\r
569 MODEL_META_DATA_PACKAGE,\r
570 MODEL_PCD_FIXED_AT_BUILD,\r
571 MODEL_PCD_PATCHABLE_IN_MODULE,\r
572 MODEL_PCD_FEATURE_FLAG,\r
573 MODEL_PCD_DYNAMIC_EX,\r
574 MODEL_PCD_DYNAMIC,\r
575 MODEL_EFI_GUID,\r
576 MODEL_EFI_PROTOCOL,\r
577 MODEL_EFI_PPI,\r
578 MODEL_META_DATA_USER_EXTENSION]:\r
579 EdkLogger.error('Parser', FORMAT_INVALID,\r
580 "Section [%s] is not allowed in inf file without version" % (self._SectionName),\r
581 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
582 elif self._SectionType in [MODEL_EFI_INCLUDE,\r
583 MODEL_EFI_LIBRARY_INSTANCE,\r
584 MODEL_META_DATA_NMAKE]:\r
585 EdkLogger.error('Parser', FORMAT_INVALID,\r
586 "Section [%s] is not allowed in inf file with version 0x%08x" % (self._SectionName, self._Version),\r
587 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
588 continue\r
589 # merge two lines specified by '\' in section NMAKE\r
590 elif self._SectionType == MODEL_META_DATA_NMAKE:\r
591 if Line[-1] == '\\':\r
592 if NextLine == '':\r
593 self._CurrentLine = NmakeLine + Line[0:-1]\r
594 NmakeLine = ''\r
595 else:\r
596 if NextLine[0] == TAB_SECTION_START and NextLine[-1] == TAB_SECTION_END:\r
597 self._CurrentLine = NmakeLine + Line[0:-1]\r
598 NmakeLine = ''\r
599 else:\r
600 NmakeLine = NmakeLine + ' ' + Line[0:-1]\r
601 continue\r
602 else:\r
603 self._CurrentLine = NmakeLine + Line\r
604 NmakeLine = ''\r
605\r
606 # section content\r
607 self._ValueList = ['', '', '']\r
608 # parse current line, result will be put in self._ValueList\r
609 self._SectionParser[self._SectionType](self)\r
610 if self._ValueList == None or self._ItemType == MODEL_META_DATA_DEFINE:\r
611 self._ItemType = -1\r
612 Comments = []\r
613 continue\r
614 if Comment:\r
615 Comments.append((Comment, Index + 1))\r
97fa0ee9
YL
616 if GlobalData.gOptions and GlobalData.gOptions.CheckUsage:\r
617 CheckInfComment(self._SectionType, Comments, str(self.MetaFile), Index + 1, self._ValueList)\r
f51461c8
LG
618 #\r
619 # Model, Value1, Value2, Value3, Arch, Platform, BelongsToItem=-1,\r
620 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1\r
621 #\r
622 for Arch, Platform in self._Scope:\r
623 LastItem = self._Store(self._SectionType,\r
624 self._ValueList[0],\r
625 self._ValueList[1],\r
626 self._ValueList[2],\r
627 Arch,\r
628 Platform,\r
629 self._Owner[-1],\r
630 self._LineIndex + 1,\r
631 - 1,\r
632 self._LineIndex + 1,\r
633 - 1,\r
634 0\r
635 )\r
636 for Comment, LineNo in Comments:\r
637 self._Store(MODEL_META_DATA_COMMENT, Comment, '', '', Arch, Platform,\r
638 LastItem, LineNo, -1, LineNo, -1, 0)\r
639 Comments = []\r
640 SectionComments = []\r
641 TailComments.extend(SectionComments + Comments)\r
642 if IsFindBlockComment:\r
643 EdkLogger.error("Parser", FORMAT_INVALID, "Open block comments (starting with /*) are expected to end with */",\r
644 File=self.MetaFile)\r
645\r
646 # If there are tail comments in INF file, save to database whatever the comments are\r
647 for Comment in TailComments:\r
648 self._Store(MODEL_META_DATA_TAIL_COMMENT, Comment[0], '', '', 'COMMON',\r
649 'COMMON', self._Owner[-1], -1, -1, -1, -1, 0)\r
650 self._Done()\r
651\r
652 ## Data parser for the format in which there's path\r
653 #\r
654 # Only path can have macro used. So we need to replace them before use.\r
655 #\r
656 def _IncludeParser(self):\r
657 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
658 self._ValueList[0:len(TokenList)] = TokenList\r
659 Macros = self._Macros\r
660 if Macros:\r
661 for Index in range(0, len(self._ValueList)):\r
662 Value = self._ValueList[Index]\r
663 if not Value:\r
664 continue\r
665\r
666 if Value.upper().find('$(EFI_SOURCE)\Edk'.upper()) > -1 or Value.upper().find('$(EFI_SOURCE)/Edk'.upper()) > -1:\r
667 Value = '$(EDK_SOURCE)' + Value[17:]\r
668 if Value.find('$(EFI_SOURCE)') > -1 or Value.find('$(EDK_SOURCE)') > -1:\r
669 pass\r
670 elif Value.startswith('.'):\r
671 pass\r
672 elif Value.startswith('$('):\r
673 pass\r
674 else:\r
675 Value = '$(EFI_SOURCE)/' + Value\r
676\r
677 self._ValueList[Index] = ReplaceMacro(Value, Macros)\r
678\r
679 ## Parse [Sources] section\r
680 #\r
681 # Only path can have macro used. So we need to replace them before use.\r
682 #\r
683 @ParseMacro\r
684 def _SourceFileParser(self):\r
685 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
686 self._ValueList[0:len(TokenList)] = TokenList\r
687 Macros = self._Macros\r
688 # For Acpi tables, remove macro like ' TABLE_NAME=Sata1'\r
689 if 'COMPONENT_TYPE' in Macros:\r
690 if self._Defines['COMPONENT_TYPE'].upper() == 'ACPITABLE':\r
691 self._ValueList[0] = GetSplitValueList(self._ValueList[0], ' ', 1)[0]\r
692 if self._Defines['BASE_NAME'] == 'Microcode':\r
693 pass\r
694 self._ValueList = [ReplaceMacro(Value, Macros) for Value in self._ValueList]\r
695\r
696 ## Parse [Binaries] section\r
697 #\r
698 # Only path can have macro used. So we need to replace them before use.\r
699 #\r
700 @ParseMacro\r
701 def _BinaryFileParser(self):\r
702 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 2)\r
703 if len(TokenList) < 2:\r
704 EdkLogger.error('Parser', FORMAT_INVALID, "No file type or path specified",\r
705 ExtraData=self._CurrentLine + " (<FileType> | <FilePath> [| <Target>])",\r
706 File=self.MetaFile, Line=self._LineIndex + 1)\r
707 if not TokenList[0]:\r
708 EdkLogger.error('Parser', FORMAT_INVALID, "No file type specified",\r
709 ExtraData=self._CurrentLine + " (<FileType> | <FilePath> [| <Target>])",\r
710 File=self.MetaFile, Line=self._LineIndex + 1)\r
711 if not TokenList[1]:\r
712 EdkLogger.error('Parser', FORMAT_INVALID, "No file path specified",\r
713 ExtraData=self._CurrentLine + " (<FileType> | <FilePath> [| <Target>])",\r
714 File=self.MetaFile, Line=self._LineIndex + 1)\r
715 self._ValueList[0:len(TokenList)] = TokenList\r
716 self._ValueList[1] = ReplaceMacro(self._ValueList[1], self._Macros)\r
717\r
718 ## [nmake] section parser (Edk.x style only)\r
719 def _NmakeParser(self):\r
720 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
721 self._ValueList[0:len(TokenList)] = TokenList\r
722 # remove macros\r
723 self._ValueList[1] = ReplaceMacro(self._ValueList[1], self._Macros)\r
724 # remove self-reference in macro setting\r
725 #self._ValueList[1] = ReplaceMacro(self._ValueList[1], {self._ValueList[0]:''})\r
726\r
727 ## [FixedPcd], [FeaturePcd], [PatchPcd], [Pcd] and [PcdEx] sections parser\r
728 @ParseMacro\r
729 def _PcdParser(self):\r
730 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 1)\r
731 ValueList = GetSplitValueList(TokenList[0], TAB_SPLIT)\r
732 if len(ValueList) != 2:\r
733 EdkLogger.error('Parser', FORMAT_INVALID, "Illegal token space GUID and PCD name format",\r
734 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<PcdCName>)",\r
735 File=self.MetaFile, Line=self._LineIndex + 1)\r
736 self._ValueList[0:1] = ValueList\r
737 if len(TokenList) > 1:\r
738 self._ValueList[2] = TokenList[1]\r
739 if self._ValueList[0] == '' or self._ValueList[1] == '':\r
740 EdkLogger.error('Parser', FORMAT_INVALID, "No token space GUID or PCD name specified",\r
741 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<PcdCName>)",\r
742 File=self.MetaFile, Line=self._LineIndex + 1)\r
743\r
744 # if value are 'True', 'true', 'TRUE' or 'False', 'false', 'FALSE', replace with integer 1 or 0.\r
745 if self._ValueList[2] != '':\r
746 InfPcdValueList = GetSplitValueList(TokenList[1], TAB_VALUE_SPLIT, 1)\r
747 if InfPcdValueList[0] in ['True', 'true', 'TRUE']:\r
748 self._ValueList[2] = TokenList[1].replace(InfPcdValueList[0], '1', 1);\r
749 elif InfPcdValueList[0] in ['False', 'false', 'FALSE']:\r
750 self._ValueList[2] = TokenList[1].replace(InfPcdValueList[0], '0', 1);\r
751 if (self._ValueList[0], self._ValueList[1]) not in self.PcdsDict:\r
752 self.PcdsDict[self._ValueList[0], self._ValueList[1]] = self._SectionType\r
753 elif self.PcdsDict[self._ValueList[0], self._ValueList[1]] != self._SectionType:\r
754 EdkLogger.error('Parser', FORMAT_INVALID, "It is not permissible to list a specified PCD in different PCD type sections.",\r
755 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<PcdCName>)",\r
756 File=self.MetaFile, Line=self._LineIndex + 1)\r
757\r
758 ## [depex] section parser\r
759 @ParseMacro\r
760 def _DepexParser(self):\r
761 self._ValueList[0:1] = [self._CurrentLine]\r
762\r
763 _SectionParser = {\r
764 MODEL_UNKNOWN : MetaFileParser._Skip,\r
765 MODEL_META_DATA_HEADER : MetaFileParser._DefineParser,\r
766 MODEL_META_DATA_BUILD_OPTION : MetaFileParser._BuildOptionParser,\r
767 MODEL_EFI_INCLUDE : _IncludeParser, # for Edk.x modules\r
768 MODEL_EFI_LIBRARY_INSTANCE : MetaFileParser._CommonParser, # for Edk.x modules\r
769 MODEL_EFI_LIBRARY_CLASS : MetaFileParser._PathParser,\r
770 MODEL_META_DATA_PACKAGE : MetaFileParser._PathParser,\r
771 MODEL_META_DATA_NMAKE : _NmakeParser, # for Edk.x modules\r
772 MODEL_PCD_FIXED_AT_BUILD : _PcdParser,\r
773 MODEL_PCD_PATCHABLE_IN_MODULE : _PcdParser,\r
774 MODEL_PCD_FEATURE_FLAG : _PcdParser,\r
775 MODEL_PCD_DYNAMIC_EX : _PcdParser,\r
776 MODEL_PCD_DYNAMIC : _PcdParser,\r
777 MODEL_EFI_SOURCE_FILE : _SourceFileParser,\r
778 MODEL_EFI_GUID : MetaFileParser._CommonParser,\r
779 MODEL_EFI_PROTOCOL : MetaFileParser._CommonParser,\r
780 MODEL_EFI_PPI : MetaFileParser._CommonParser,\r
781 MODEL_EFI_DEPEX : _DepexParser,\r
782 MODEL_EFI_BINARY_FILE : _BinaryFileParser,\r
0923aa1c 783 MODEL_META_DATA_USER_EXTENSION : MetaFileParser._SkipUserExtension,\r
f51461c8
LG
784 }\r
785\r
786## DSC file parser class\r
787#\r
788# @param FilePath The path of platform description file\r
789# @param FileType The raw data of DSC file\r
790# @param Table Database used to retrieve module/package information\r
791# @param Macros Macros used for replacement in file\r
792# @param Owner Owner ID (for sub-section parsing)\r
793# @param From ID from which the data comes (for !INCLUDE directive)\r
794#\r
795class DscParser(MetaFileParser):\r
796 # DSC file supported data types (one type per section)\r
797 DataType = {\r
798 TAB_SKUIDS.upper() : MODEL_EFI_SKU_ID,\r
799 TAB_LIBRARIES.upper() : MODEL_EFI_LIBRARY_INSTANCE,\r
800 TAB_LIBRARY_CLASSES.upper() : MODEL_EFI_LIBRARY_CLASS,\r
801 TAB_BUILD_OPTIONS.upper() : MODEL_META_DATA_BUILD_OPTION,\r
802 TAB_PCDS_FIXED_AT_BUILD_NULL.upper() : MODEL_PCD_FIXED_AT_BUILD,\r
803 TAB_PCDS_PATCHABLE_IN_MODULE_NULL.upper() : MODEL_PCD_PATCHABLE_IN_MODULE,\r
804 TAB_PCDS_FEATURE_FLAG_NULL.upper() : MODEL_PCD_FEATURE_FLAG,\r
805 TAB_PCDS_DYNAMIC_DEFAULT_NULL.upper() : MODEL_PCD_DYNAMIC_DEFAULT,\r
806 TAB_PCDS_DYNAMIC_HII_NULL.upper() : MODEL_PCD_DYNAMIC_HII,\r
807 TAB_PCDS_DYNAMIC_VPD_NULL.upper() : MODEL_PCD_DYNAMIC_VPD,\r
808 TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL.upper() : MODEL_PCD_DYNAMIC_EX_DEFAULT,\r
809 TAB_PCDS_DYNAMIC_EX_HII_NULL.upper() : MODEL_PCD_DYNAMIC_EX_HII,\r
810 TAB_PCDS_DYNAMIC_EX_VPD_NULL.upper() : MODEL_PCD_DYNAMIC_EX_VPD,\r
811 TAB_COMPONENTS.upper() : MODEL_META_DATA_COMPONENT,\r
812 TAB_COMPONENTS_SOURCE_OVERRIDE_PATH.upper() : MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH,\r
813 TAB_DSC_DEFINES.upper() : MODEL_META_DATA_HEADER,\r
814 TAB_DSC_DEFINES_DEFINE : MODEL_META_DATA_DEFINE,\r
815 TAB_DSC_DEFINES_EDKGLOBAL : MODEL_META_DATA_GLOBAL_DEFINE,\r
816 TAB_INCLUDE.upper() : MODEL_META_DATA_INCLUDE,\r
817 TAB_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
818 TAB_IF_DEF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,\r
819 TAB_IF_N_DEF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF,\r
820 TAB_ELSE_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF,\r
821 TAB_ELSE.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE,\r
822 TAB_END_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF,\r
0923aa1c 823 TAB_USER_EXTENSIONS.upper() : MODEL_META_DATA_USER_EXTENSION,\r
f51461c8
LG
824 }\r
825\r
826 # Valid names in define section\r
827 DefineKeywords = [\r
828 "DSC_SPECIFICATION",\r
829 "PLATFORM_NAME",\r
830 "PLATFORM_GUID",\r
831 "PLATFORM_VERSION",\r
832 "SKUID_IDENTIFIER",\r
833 "PCD_INFO_GENERATION",\r
82a6a960 834 "PCD_VAR_CHECK_GENERATION",\r
f51461c8
LG
835 "SUPPORTED_ARCHITECTURES",\r
836 "BUILD_TARGETS",\r
837 "OUTPUT_DIRECTORY",\r
838 "FLASH_DEFINITION",\r
839 "BUILD_NUMBER",\r
840 "RFC_LANGUAGES",\r
841 "ISO_LANGUAGES",\r
842 "TIME_STAMP_FILE",\r
843 "VPD_TOOL_GUID",\r
f0dc69e6
YZ
844 "FIX_LOAD_TOP_MEMORY_ADDRESS",\r
845 "PREBUILD",\r
846 "POSTBUILD"\r
f51461c8
LG
847 ]\r
848\r
97fa0ee9
YL
849 SubSectionDefineKeywords = [\r
850 "FILE_GUID"\r
851 ]\r
852\r
f51461c8
LG
853 SymbolPattern = ValueExpression.SymbolPattern\r
854\r
855 ## Constructor of DscParser\r
856 #\r
857 # Initialize object of DscParser\r
858 #\r
859 # @param FilePath The path of platform description file\r
860 # @param FileType The raw data of DSC file\r
cdd1b5e5 861 # @param Arch Default Arch value for filtering sections\r
f51461c8 862 # @param Table Database used to retrieve module/package information\r
f51461c8
LG
863 # @param Owner Owner ID (for sub-section parsing)\r
864 # @param From ID from which the data comes (for !INCLUDE directive)\r
865 #\r
cdd1b5e5 866 def __init__(self, FilePath, FileType, Arch, Table, Owner= -1, From= -1):\r
f51461c8
LG
867 # prevent re-initialization\r
868 if hasattr(self, "_Table"):\r
869 return\r
cdd1b5e5 870 MetaFileParser.__init__(self, FilePath, FileType, Arch, Table, Owner, From)\r
f51461c8
LG
871 self._Version = 0x00010005 # Only EDK2 dsc file is supported\r
872 # to store conditional directive evaluation result\r
873 self._DirectiveStack = []\r
874 self._DirectiveEvalStack = []\r
875 self._Enabled = 1\r
876\r
877 #\r
878 # Specify whether current line is in uncertain condition\r
879 #\r
880 self._InDirective = -1\r
881\r
882 # Final valid replacable symbols\r
883 self._Symbols = {}\r
884 #\r
885 # Map the ID between the original table and new table to track\r
886 # the owner item\r
887 #\r
888 self._IdMapping = {-1:-1}\r
889\r
890 ## Parser starter\r
891 def Start(self):\r
892 Content = ''\r
893 try:\r
894 Content = open(str(self.MetaFile), 'r').readlines()\r
895 except:\r
896 EdkLogger.error("Parser", FILE_READ_FAILURE, ExtraData=self.MetaFile)\r
897\r
898 OwnerId = {}\r
899 for Index in range(0, len(Content)):\r
900 Line = CleanString(Content[Index])\r
901 # skip empty line\r
902 if Line == '':\r
903 continue\r
904\r
905 self._CurrentLine = Line\r
906 self._LineIndex = Index\r
907 if self._InSubsection and self._Owner[-1] == -1:\r
908 self._Owner.append(self._LastItem)\r
909\r
910 # section header\r
911 if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:\r
912 self._SectionType = MODEL_META_DATA_SECTION_HEADER\r
913 # subsection ending\r
914 elif Line[0] == '}' and self._InSubsection:\r
915 self._InSubsection = False\r
916 self._SubsectionType = MODEL_UNKNOWN\r
917 self._SubsectionName = ''\r
918 self._Owner[-1] = -1\r
919 OwnerId = {}\r
920 continue\r
921 # subsection header\r
922 elif Line[0] == TAB_OPTION_START and Line[-1] == TAB_OPTION_END:\r
923 self._SubsectionType = MODEL_META_DATA_SUBSECTION_HEADER\r
924 # directive line\r
925 elif Line[0] == '!':\r
926 self._DirectiveParser()\r
927 continue\r
d429fcd0
YZ
928 if Line[0] == TAB_OPTION_START and not self._InSubsection:\r
929 EdkLogger.error("Parser", FILE_READ_FAILURE, "Missing the '{' before %s in Line %s" % (Line, Index+1),ExtraData=self.MetaFile)\r
f51461c8
LG
930\r
931 if self._InSubsection:\r
932 SectionType = self._SubsectionType\r
933 else:\r
934 SectionType = self._SectionType\r
935 self._ItemType = SectionType\r
936\r
937 self._ValueList = ['', '', '']\r
938 self._SectionParser[SectionType](self)\r
939 if self._ValueList == None:\r
940 continue\r
941 #\r
942 # Model, Value1, Value2, Value3, Arch, ModuleType, BelongsToItem=-1, BelongsToFile=-1,\r
943 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1\r
944 #\r
945 for Arch, ModuleType in self._Scope:\r
946 Owner = self._Owner[-1]\r
947 if self._SubsectionType != MODEL_UNKNOWN:\r
948 Owner = OwnerId[Arch]\r
949 self._LastItem = self._Store(\r
950 self._ItemType,\r
951 self._ValueList[0],\r
952 self._ValueList[1],\r
953 self._ValueList[2],\r
954 Arch,\r
955 ModuleType,\r
956 Owner,\r
957 self._From,\r
958 self._LineIndex + 1,\r
959 - 1,\r
960 self._LineIndex + 1,\r
961 - 1,\r
962 self._Enabled\r
963 )\r
964 if self._SubsectionType == MODEL_UNKNOWN and self._InSubsection:\r
965 OwnerId[Arch] = self._LastItem\r
966\r
967 if self._DirectiveStack:\r
968 Type, Line, Text = self._DirectiveStack[-1]\r
969 EdkLogger.error('Parser', FORMAT_INVALID, "No matching '!endif' found",\r
970 ExtraData=Text, File=self.MetaFile, Line=Line)\r
971 self._Done()\r
972\r
973 ## <subsection_header> parser\r
974 def _SubsectionHeaderParser(self):\r
975 self._SubsectionName = self._CurrentLine[1:-1].upper()\r
976 if self._SubsectionName in self.DataType:\r
977 self._SubsectionType = self.DataType[self._SubsectionName]\r
978 else:\r
979 self._SubsectionType = MODEL_UNKNOWN\r
980 EdkLogger.warn("Parser", "Unrecognized sub-section", File=self.MetaFile,\r
981 Line=self._LineIndex + 1, ExtraData=self._CurrentLine)\r
982 self._ValueList[0] = self._SubsectionName\r
983\r
984 ## Directive statement parser\r
985 def _DirectiveParser(self):\r
986 self._ValueList = ['', '', '']\r
987 TokenList = GetSplitValueList(self._CurrentLine, ' ', 1)\r
988 self._ValueList[0:len(TokenList)] = TokenList\r
989\r
990 # Syntax check\r
991 DirectiveName = self._ValueList[0].upper()\r
992 if DirectiveName not in self.DataType:\r
993 EdkLogger.error("Parser", FORMAT_INVALID, "Unknown directive [%s]" % DirectiveName,\r
994 File=self.MetaFile, Line=self._LineIndex + 1)\r
995\r
996 if DirectiveName in ['!IF', '!IFDEF', '!IFNDEF']:\r
997 self._InDirective += 1\r
998\r
999 if DirectiveName in ['!ENDIF']:\r
1000 self._InDirective -= 1\r
1001\r
1002 if DirectiveName in ['!IF', '!IFDEF', '!INCLUDE', '!IFNDEF', '!ELSEIF'] and self._ValueList[1] == '':\r
1003 EdkLogger.error("Parser", FORMAT_INVALID, "Missing expression",\r
1004 File=self.MetaFile, Line=self._LineIndex + 1,\r
1005 ExtraData=self._CurrentLine)\r
1006\r
1007 ItemType = self.DataType[DirectiveName]\r
1008 Scope = [['COMMON', 'COMMON']]\r
1009 if ItemType == MODEL_META_DATA_INCLUDE:\r
1010 Scope = self._Scope\r
1011 if ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF:\r
1012 # Remove all directives between !if and !endif, including themselves\r
1013 while self._DirectiveStack:\r
1014 # Remove any !else or !elseif\r
1015 DirectiveInfo = self._DirectiveStack.pop()\r
1016 if DirectiveInfo[0] in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
1017 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,\r
1018 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF]:\r
1019 break\r
1020 else:\r
1021 EdkLogger.error("Parser", FORMAT_INVALID, "Redundant '!endif'",\r
1022 File=self.MetaFile, Line=self._LineIndex + 1,\r
1023 ExtraData=self._CurrentLine)\r
1024 elif ItemType != MODEL_META_DATA_INCLUDE:\r
1025 # Break if there's a !else is followed by a !elseif\r
1026 if ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF and \\r
1027 self._DirectiveStack and \\r
1028 self._DirectiveStack[-1][0] == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE:\r
1029 EdkLogger.error("Parser", FORMAT_INVALID, "'!elseif' after '!else'",\r
1030 File=self.MetaFile, Line=self._LineIndex + 1,\r
1031 ExtraData=self._CurrentLine)\r
1032 self._DirectiveStack.append((ItemType, self._LineIndex + 1, self._CurrentLine))\r
f51461c8
LG
1033\r
1034 #\r
1035 # Model, Value1, Value2, Value3, Arch, ModuleType, BelongsToItem=-1, BelongsToFile=-1,\r
1036 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1\r
1037 #\r
1038 for Arch, ModuleType in Scope:\r
1039 self._LastItem = self._Store(\r
1040 ItemType,\r
1041 self._ValueList[0],\r
1042 self._ValueList[1],\r
1043 self._ValueList[2],\r
1044 Arch,\r
1045 ModuleType,\r
1046 self._Owner[-1],\r
1047 self._From,\r
1048 self._LineIndex + 1,\r
1049 - 1,\r
1050 self._LineIndex + 1,\r
1051 - 1,\r
1052 0\r
1053 )\r
1054\r
1055 ## [defines] section parser\r
1056 @ParseMacro\r
1057 def _DefineParser(self):\r
1058 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
1059 self._ValueList[1:len(TokenList)] = TokenList\r
1060\r
1061 # Syntax check\r
1062 if not self._ValueList[1]:\r
1063 EdkLogger.error('Parser', FORMAT_INVALID, "No name specified",\r
1064 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
1065 if not self._ValueList[2]:\r
1066 EdkLogger.error('Parser', FORMAT_INVALID, "No value specified",\r
1067 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
97fa0ee9
YL
1068 if (not self._ValueList[1] in self.DefineKeywords and\r
1069 (self._InSubsection and self._ValueList[1] not in self.SubSectionDefineKeywords)):\r
f51461c8
LG
1070 EdkLogger.error('Parser', FORMAT_INVALID,\r
1071 "Unknown keyword found: %s. "\r
1072 "If this is a macro you must "\r
1073 "add it as a DEFINE in the DSC" % self._ValueList[1],\r
1074 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
97fa0ee9
YL
1075 if not self._InSubsection:\r
1076 self._Defines[self._ValueList[1]] = self._ValueList[2]\r
f51461c8
LG
1077 self._ItemType = self.DataType[TAB_DSC_DEFINES.upper()]\r
1078\r
1079 @ParseMacro\r
1080 def _SkuIdParser(self):\r
1081 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
1082 if len(TokenList) != 2:\r
1083 EdkLogger.error('Parser', FORMAT_INVALID, "Correct format is '<Integer>|<UiName>'",\r
1084 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
1085 self._ValueList[0:len(TokenList)] = TokenList\r
1086\r
1087 ## Parse Edk style of library modules\r
1088 @ParseMacro\r
1089 def _LibraryInstanceParser(self):\r
1090 self._ValueList[0] = self._CurrentLine\r
1091\r
1092 ## PCD sections parser\r
1093 #\r
1094 # [PcdsFixedAtBuild]\r
1095 # [PcdsPatchableInModule]\r
1096 # [PcdsFeatureFlag]\r
1097 # [PcdsDynamicEx\r
1098 # [PcdsDynamicExDefault]\r
1099 # [PcdsDynamicExVpd]\r
1100 # [PcdsDynamicExHii]\r
1101 # [PcdsDynamic]\r
1102 # [PcdsDynamicDefault]\r
1103 # [PcdsDynamicVpd]\r
1104 # [PcdsDynamicHii]\r
1105 #\r
1106 @ParseMacro\r
1107 def _PcdParser(self):\r
1108 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 1)\r
1109 self._ValueList[0:1] = GetSplitValueList(TokenList[0], TAB_SPLIT)\r
1110 if len(TokenList) == 2:\r
1111 self._ValueList[2] = TokenList[1]\r
1112 if self._ValueList[0] == '' or self._ValueList[1] == '':\r
1113 EdkLogger.error('Parser', FORMAT_INVALID, "No token space GUID or PCD name specified",\r
1114 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<TokenCName>|<PcdValue>)",\r
1115 File=self.MetaFile, Line=self._LineIndex + 1)\r
1116 if self._ValueList[2] == '':\r
1117 #\r
1118 # The PCD values are optional for FIXEDATBUILD and PATCHABLEINMODULE\r
1119 #\r
1120 if self._SectionType in (MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_PATCHABLE_IN_MODULE):\r
1121 return\r
1122 EdkLogger.error('Parser', FORMAT_INVALID, "No PCD value given",\r
1123 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<TokenCName>|<PcdValue>)",\r
1124 File=self.MetaFile, Line=self._LineIndex + 1)\r
1125\r
1126 # Validate the datum type of Dynamic Defaul PCD and DynamicEx Default PCD\r
1127 ValueList = GetSplitValueList(self._ValueList[2])\r
1128 if len(ValueList) > 1 and ValueList[1] != TAB_VOID \\r
1129 and self._ItemType in [MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_EX_DEFAULT]:\r
1130 EdkLogger.error('Parser', FORMAT_INVALID, "The datum type '%s' of PCD is wrong" % ValueList[1],\r
1131 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
1132\r
1133 # if value are 'True', 'true', 'TRUE' or 'False', 'false', 'FALSE', replace with integer 1 or 0.\r
1134 DscPcdValueList = GetSplitValueList(TokenList[1], TAB_VALUE_SPLIT, 1)\r
1135 if DscPcdValueList[0] in ['True', 'true', 'TRUE']:\r
1136 self._ValueList[2] = TokenList[1].replace(DscPcdValueList[0], '1', 1);\r
1137 elif DscPcdValueList[0] in ['False', 'false', 'FALSE']:\r
1138 self._ValueList[2] = TokenList[1].replace(DscPcdValueList[0], '0', 1);\r
1139\r
1140\r
1141 ## [components] section parser\r
1142 @ParseMacro\r
1143 def _ComponentParser(self):\r
1144 if self._CurrentLine[-1] == '{':\r
1145 self._ValueList[0] = self._CurrentLine[0:-1].strip()\r
1146 self._InSubsection = True\r
1147 else:\r
1148 self._ValueList[0] = self._CurrentLine\r
1149\r
1150 ## [LibraryClasses] section\r
1151 @ParseMacro\r
1152 def _LibraryClassParser(self):\r
1153 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
1154 if len(TokenList) < 2:\r
1155 EdkLogger.error('Parser', FORMAT_INVALID, "No library class or instance specified",\r
1156 ExtraData=self._CurrentLine + " (<LibraryClassName>|<LibraryInstancePath>)",\r
1157 File=self.MetaFile, Line=self._LineIndex + 1)\r
1158 if TokenList[0] == '':\r
1159 EdkLogger.error('Parser', FORMAT_INVALID, "No library class specified",\r
1160 ExtraData=self._CurrentLine + " (<LibraryClassName>|<LibraryInstancePath>)",\r
1161 File=self.MetaFile, Line=self._LineIndex + 1)\r
1162 if TokenList[1] == '':\r
1163 EdkLogger.error('Parser', FORMAT_INVALID, "No library instance specified",\r
1164 ExtraData=self._CurrentLine + " (<LibraryClassName>|<LibraryInstancePath>)",\r
1165 File=self.MetaFile, Line=self._LineIndex + 1)\r
1166\r
1167 self._ValueList[0:len(TokenList)] = TokenList\r
1168\r
1169 def _CompponentSourceOverridePathParser(self):\r
1170 self._ValueList[0] = self._CurrentLine\r
1171\r
1172 ## [BuildOptions] section parser\r
1173 @ParseMacro\r
1174 def _BuildOptionParser(self):\r
1175 self._CurrentLine = CleanString(self._CurrentLine, BuildOption=True)\r
1176 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
1177 TokenList2 = GetSplitValueList(TokenList[0], ':', 1)\r
1178 if len(TokenList2) == 2:\r
1179 self._ValueList[0] = TokenList2[0] # toolchain family\r
1180 self._ValueList[1] = TokenList2[1] # keys\r
1181 else:\r
1182 self._ValueList[1] = TokenList[0]\r
1183 if len(TokenList) == 2: # value\r
1184 self._ValueList[2] = TokenList[1]\r
1185\r
1186 if self._ValueList[1].count('_') != 4:\r
1187 EdkLogger.error(\r
1188 'Parser',\r
1189 FORMAT_INVALID,\r
1190 "'%s' must be in format of <TARGET>_<TOOLCHAIN>_<ARCH>_<TOOL>_FLAGS" % self._ValueList[1],\r
1191 ExtraData=self._CurrentLine,\r
1192 File=self.MetaFile,\r
1193 Line=self._LineIndex + 1\r
1194 )\r
1195\r
1196 ## Override parent's method since we'll do all macro replacements in parser\r
1197 def _GetMacros(self):\r
1198 Macros = {}\r
1199 Macros.update(self._FileLocalMacros)\r
1200 Macros.update(self._GetApplicableSectionMacro())\r
1201 Macros.update(GlobalData.gEdkGlobal)\r
1202 Macros.update(GlobalData.gPlatformDefines)\r
1203 Macros.update(GlobalData.gCommandLineDefines)\r
1204 # PCD cannot be referenced in macro definition\r
1205 if self._ItemType not in [MODEL_META_DATA_DEFINE, MODEL_META_DATA_GLOBAL_DEFINE]:\r
1206 Macros.update(self._Symbols)\r
1207 return Macros\r
1208\r
1209 def _PostProcess(self):\r
1210 Processer = {\r
1211 MODEL_META_DATA_SECTION_HEADER : self.__ProcessSectionHeader,\r
1212 MODEL_META_DATA_SUBSECTION_HEADER : self.__ProcessSubsectionHeader,\r
1213 MODEL_META_DATA_HEADER : self.__ProcessDefine,\r
1214 MODEL_META_DATA_DEFINE : self.__ProcessDefine,\r
1215 MODEL_META_DATA_GLOBAL_DEFINE : self.__ProcessDefine,\r
1216 MODEL_META_DATA_INCLUDE : self.__ProcessDirective,\r
1217 MODEL_META_DATA_CONDITIONAL_STATEMENT_IF : self.__ProcessDirective,\r
1218 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE : self.__ProcessDirective,\r
1219 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF : self.__ProcessDirective,\r
1220 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF : self.__ProcessDirective,\r
1221 MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF : self.__ProcessDirective,\r
1222 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF : self.__ProcessDirective,\r
1223 MODEL_EFI_SKU_ID : self.__ProcessSkuId,\r
1224 MODEL_EFI_LIBRARY_INSTANCE : self.__ProcessLibraryInstance,\r
1225 MODEL_EFI_LIBRARY_CLASS : self.__ProcessLibraryClass,\r
1226 MODEL_PCD_FIXED_AT_BUILD : self.__ProcessPcd,\r
1227 MODEL_PCD_PATCHABLE_IN_MODULE : self.__ProcessPcd,\r
1228 MODEL_PCD_FEATURE_FLAG : self.__ProcessPcd,\r
1229 MODEL_PCD_DYNAMIC_DEFAULT : self.__ProcessPcd,\r
1230 MODEL_PCD_DYNAMIC_HII : self.__ProcessPcd,\r
1231 MODEL_PCD_DYNAMIC_VPD : self.__ProcessPcd,\r
1232 MODEL_PCD_DYNAMIC_EX_DEFAULT : self.__ProcessPcd,\r
1233 MODEL_PCD_DYNAMIC_EX_HII : self.__ProcessPcd,\r
1234 MODEL_PCD_DYNAMIC_EX_VPD : self.__ProcessPcd,\r
1235 MODEL_META_DATA_COMPONENT : self.__ProcessComponent,\r
1236 MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH : self.__ProcessSourceOverridePath,\r
1237 MODEL_META_DATA_BUILD_OPTION : self.__ProcessBuildOption,\r
1238 MODEL_UNKNOWN : self._Skip,\r
0923aa1c 1239 MODEL_META_DATA_USER_EXTENSION : self._SkipUserExtension,\r
f51461c8
LG
1240 }\r
1241\r
1242 self._Table = MetaFileStorage(self._RawTable.Cur, self.MetaFile, MODEL_FILE_DSC, True)\r
1243 self._Table.Create()\r
1244 self._DirectiveStack = []\r
1245 self._DirectiveEvalStack = []\r
1246 self._FileWithError = self.MetaFile\r
1247 self._FileLocalMacros = {}\r
1248 self._SectionsMacroDict = {}\r
1249 GlobalData.gPlatformDefines = {}\r
1250\r
1251 # Get all macro and PCD which has straitforward value\r
1252 self.__RetrievePcdValue()\r
1253 self._Content = self._RawTable.GetAll()\r
1254 self._ContentIndex = 0\r
97fa0ee9 1255 self._InSubsection = False\r
f51461c8
LG
1256 while self._ContentIndex < len(self._Content) :\r
1257 Id, self._ItemType, V1, V2, V3, S1, S2, Owner, self._From, \\r
1258 LineStart, ColStart, LineEnd, ColEnd, Enabled = self._Content[self._ContentIndex]\r
1259\r
1260 if self._From < 0:\r
1261 self._FileWithError = self.MetaFile\r
1262\r
1263 self._ContentIndex += 1\r
1264\r
1265 self._Scope = [[S1, S2]]\r
1266 #\r
1267 # For !include directive, handle it specially,\r
1268 # merge arch and module type in case of duplicate items\r
1269 #\r
1270 while self._ItemType == MODEL_META_DATA_INCLUDE:\r
1271 if self._ContentIndex >= len(self._Content):\r
1272 break\r
1273 Record = self._Content[self._ContentIndex]\r
1274 if LineStart == Record[9] and LineEnd == Record[11]:\r
1275 if [Record[5], Record[6]] not in self._Scope:\r
1276 self._Scope.append([Record[5], Record[6]])\r
1277 self._ContentIndex += 1\r
1278 else:\r
1279 break\r
1280\r
1281 self._LineIndex = LineStart - 1\r
1282 self._ValueList = [V1, V2, V3]\r
1283\r
97fa0ee9
YL
1284 if Owner > 0 and Owner in self._IdMapping:\r
1285 self._InSubsection = True\r
1286 else:\r
1287 self._InSubsection = False\r
f51461c8
LG
1288 try:\r
1289 Processer[self._ItemType]()\r
1290 except EvaluationException, Excpt:\r
1291 # \r
1292 # Only catch expression evaluation error here. We need to report\r
1293 # the precise number of line on which the error occurred\r
1294 #\r
1295 if hasattr(Excpt, 'Pcd'):\r
1296 if Excpt.Pcd in GlobalData.gPlatformOtherPcds:\r
1297 Info = GlobalData.gPlatformOtherPcds[Excpt.Pcd]\r
1298 EdkLogger.error('Parser', FORMAT_INVALID, "Cannot use this PCD (%s) in an expression as"\r
1299 " it must be defined in a [PcdsFixedAtBuild] or [PcdsFeatureFlag] section"\r
1300 " of the DSC file, and it is currently defined in this section:"\r
1301 " %s, line #: %d." % (Excpt.Pcd, Info[0], Info[1]),\r
1302 File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
1303 Line=self._LineIndex + 1)\r
1304 else:\r
1305 EdkLogger.error('Parser', FORMAT_INVALID, "PCD (%s) is not defined in DSC file" % Excpt.Pcd,\r
1306 File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
1307 Line=self._LineIndex + 1)\r
1308 else:\r
1309 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid expression: %s" % str(Excpt),\r
1310 File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
1311 Line=self._LineIndex + 1)\r
1312 except MacroException, Excpt:\r
1313 EdkLogger.error('Parser', FORMAT_INVALID, str(Excpt),\r
1314 File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
1315 Line=self._LineIndex + 1)\r
1316\r
1317 if self._ValueList == None:\r
1318 continue\r
1319\r
1320 NewOwner = self._IdMapping.get(Owner, -1)\r
1321 self._Enabled = int((not self._DirectiveEvalStack) or (False not in self._DirectiveEvalStack))\r
1322 self._LastItem = self._Store(\r
1323 self._ItemType,\r
1324 self._ValueList[0],\r
1325 self._ValueList[1],\r
1326 self._ValueList[2],\r
1327 S1,\r
1328 S2,\r
1329 NewOwner,\r
1330 self._From,\r
1331 self._LineIndex + 1,\r
1332 - 1,\r
1333 self._LineIndex + 1,\r
1334 - 1,\r
1335 self._Enabled\r
1336 )\r
1337 self._IdMapping[Id] = self._LastItem\r
1338\r
1339 GlobalData.gPlatformDefines.update(self._FileLocalMacros)\r
1340 self._PostProcessed = True\r
1341 self._Content = None\r
1342\r
1343 def __ProcessSectionHeader(self):\r
1344 self._SectionName = self._ValueList[0]\r
1345 if self._SectionName in self.DataType:\r
1346 self._SectionType = self.DataType[self._SectionName]\r
1347 else:\r
1348 self._SectionType = MODEL_UNKNOWN\r
1349\r
1350 def __ProcessSubsectionHeader(self):\r
1351 self._SubsectionName = self._ValueList[0]\r
1352 if self._SubsectionName in self.DataType:\r
1353 self._SubsectionType = self.DataType[self._SubsectionName]\r
1354 else:\r
1355 self._SubsectionType = MODEL_UNKNOWN\r
1356\r
1357 def __RetrievePcdValue(self):\r
f51461c8
LG
1358 Content = open(str(self.MetaFile), 'r').readlines()\r
1359 GlobalData.gPlatformOtherPcds['DSCFILE'] = str(self.MetaFile)\r
1360 for PcdType in (MODEL_PCD_PATCHABLE_IN_MODULE, MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_HII,\r
1361 MODEL_PCD_DYNAMIC_VPD, MODEL_PCD_DYNAMIC_EX_DEFAULT, MODEL_PCD_DYNAMIC_EX_HII,\r
1362 MODEL_PCD_DYNAMIC_EX_VPD):\r
1363 Records = self._RawTable.Query(PcdType, BelongsToItem= -1.0)\r
1364 for TokenSpaceGuid, PcdName, Value, Dummy2, Dummy3, ID, Line in Records:\r
1365 Name = TokenSpaceGuid + '.' + PcdName\r
1366 if Name not in GlobalData.gPlatformOtherPcds:\r
1367 PcdLine = Line\r
1368 while not Content[Line - 1].lstrip().startswith(TAB_SECTION_START):\r
1369 Line -= 1\r
1370 GlobalData.gPlatformOtherPcds[Name] = (CleanString(Content[Line - 1]), PcdLine, PcdType)\r
1371\r
1372 def __ProcessDefine(self):\r
1373 if not self._Enabled:\r
1374 return\r
1375\r
1376 Type, Name, Value = self._ValueList\r
1377 Value = ReplaceMacro(Value, self._Macros, False)\r
97fa0ee9
YL
1378 #\r
1379 # If it is <Defines>, return\r
1380 #\r
1381 if self._InSubsection:\r
1382 self._ValueList = [Type, Name, Value]\r
1383 return\r
1384\r
f51461c8
LG
1385 if self._ItemType == MODEL_META_DATA_DEFINE:\r
1386 if self._SectionType == MODEL_META_DATA_HEADER:\r
1387 self._FileLocalMacros[Name] = Value\r
1388 else:\r
1389 self._ConstructSectionMacroDict(Name, Value)\r
1390 elif self._ItemType == MODEL_META_DATA_GLOBAL_DEFINE:\r
1391 GlobalData.gEdkGlobal[Name] = Value\r
1392\r
1393 #\r
1394 # Keyword in [Defines] section can be used as Macros\r
1395 #\r
1396 if (self._ItemType == MODEL_META_DATA_HEADER) and (self._SectionType == MODEL_META_DATA_HEADER):\r
1397 self._FileLocalMacros[Name] = Value\r
1398\r
1399 self._ValueList = [Type, Name, Value]\r
1400\r
1401 def __ProcessDirective(self):\r
1402 Result = None\r
1403 if self._ItemType in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
1404 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF]:\r
1405 Macros = self._Macros\r
1406 Macros.update(GlobalData.gGlobalDefines)\r
1407 try:\r
1408 Result = ValueExpression(self._ValueList[1], Macros)()\r
1409 except SymbolNotFound, Exc:\r
1410 EdkLogger.debug(EdkLogger.DEBUG_5, str(Exc), self._ValueList[1])\r
1411 Result = False\r
1412 except WrnExpression, Excpt:\r
1413 # \r
1414 # Catch expression evaluation warning here. We need to report\r
1415 # the precise number of line and return the evaluation result\r
1416 #\r
1417 EdkLogger.warn('Parser', "Suspicious expression: %s" % str(Excpt),\r
1418 File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
1419 Line=self._LineIndex + 1)\r
1420 Result = Excpt.result\r
1421\r
1422 if self._ItemType in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
1423 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,\r
1424 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF]:\r
1425 self._DirectiveStack.append(self._ItemType)\r
1426 if self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_IF:\r
1427 Result = bool(Result)\r
1428 else:\r
1429 Macro = self._ValueList[1]\r
1430 Macro = Macro[2:-1] if (Macro.startswith("$(") and Macro.endswith(")")) else Macro\r
1431 Result = Macro in self._Macros\r
1432 if self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF:\r
1433 Result = not Result\r
1434 self._DirectiveEvalStack.append(Result)\r
1435 elif self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF:\r
1436 self._DirectiveStack.append(self._ItemType)\r
1437 self._DirectiveEvalStack[-1] = not self._DirectiveEvalStack[-1]\r
1438 self._DirectiveEvalStack.append(bool(Result))\r
1439 elif self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE:\r
1440 self._DirectiveStack.append(self._ItemType)\r
1441 self._DirectiveEvalStack[-1] = not self._DirectiveEvalStack[-1]\r
1442 self._DirectiveEvalStack.append(True)\r
1443 elif self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF:\r
1444 # Back to the nearest !if/!ifdef/!ifndef\r
1445 while self._DirectiveStack:\r
1446 self._DirectiveEvalStack.pop()\r
1447 Directive = self._DirectiveStack.pop()\r
1448 if Directive in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
1449 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,\r
1450 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF]:\r
1451 break\r
1452 elif self._ItemType == MODEL_META_DATA_INCLUDE:\r
1453 # The included file must be relative to workspace or same directory as DSC file\r
1454 __IncludeMacros = {}\r
1455 #\r
1456 # Allow using system environment variables in path after !include\r
1457 #\r
1458 __IncludeMacros['WORKSPACE'] = GlobalData.gGlobalDefines['WORKSPACE']\r
1459 if "ECP_SOURCE" in GlobalData.gGlobalDefines.keys():\r
1460 __IncludeMacros['ECP_SOURCE'] = GlobalData.gGlobalDefines['ECP_SOURCE']\r
1461 #\r
1462 # During GenFds phase call DSC parser, will go into this branch.\r
1463 #\r
1464 elif "ECP_SOURCE" in GlobalData.gCommandLineDefines.keys():\r
1465 __IncludeMacros['ECP_SOURCE'] = GlobalData.gCommandLineDefines['ECP_SOURCE']\r
1466\r
1467 __IncludeMacros['EFI_SOURCE'] = GlobalData.gGlobalDefines['EFI_SOURCE']\r
1468 __IncludeMacros['EDK_SOURCE'] = GlobalData.gGlobalDefines['EDK_SOURCE']\r
1469 #\r
1470 # Allow using MACROs comes from [Defines] section to keep compatible. \r
1471 #\r
1472 __IncludeMacros.update(self._Macros)\r
1473\r
1474 IncludedFile = NormPath(ReplaceMacro(self._ValueList[1], __IncludeMacros, RaiseError=True))\r
1475 #\r
1476 # First search the include file under the same directory as DSC file\r
1477 #\r
1478 IncludedFile1 = PathClass(IncludedFile, self.MetaFile.Dir)\r
1479 ErrorCode, ErrorInfo1 = IncludedFile1.Validate()\r
1480 if ErrorCode != 0:\r
1481 #\r
1482 # Also search file under the WORKSPACE directory\r
1483 #\r
1484 IncludedFile1 = PathClass(IncludedFile, GlobalData.gWorkspace)\r
1485 ErrorCode, ErrorInfo2 = IncludedFile1.Validate()\r
1486 if ErrorCode != 0:\r
1487 EdkLogger.error('parser', ErrorCode, File=self._FileWithError,\r
1488 Line=self._LineIndex + 1, ExtraData=ErrorInfo1 + "\n" + ErrorInfo2)\r
1489\r
1490 self._FileWithError = IncludedFile1\r
1491\r
1492 IncludedFileTable = MetaFileStorage(self._Table.Cur, IncludedFile1, MODEL_FILE_DSC, False)\r
1493 Owner = self._Content[self._ContentIndex - 1][0]\r
cdd1b5e5 1494 Parser = DscParser(IncludedFile1, self._FileType, self._Arch, IncludedFileTable,\r
f51461c8
LG
1495 Owner=Owner, From=Owner)\r
1496\r
118bf096
CS
1497 # Does not allow lower level included file to include upper level included file\r
1498 if Parser._From != Owner and int(Owner) > int (Parser._From):\r
1499 EdkLogger.error('parser', FILE_ALREADY_EXIST, File=self._FileWithError,\r
1500 Line=self._LineIndex + 1, ExtraData="{0} is already included at a higher level.".format(IncludedFile1))\r
1501\r
1502\r
f51461c8
LG
1503 # set the parser status with current status\r
1504 Parser._SectionName = self._SectionName\r
1505 Parser._SectionType = self._SectionType\r
1506 Parser._Scope = self._Scope\r
1507 Parser._Enabled = self._Enabled\r
1508 # Parse the included file\r
1509 Parser.Start()\r
1510\r
1511 # update current status with sub-parser's status\r
1512 self._SectionName = Parser._SectionName\r
1513 self._SectionType = Parser._SectionType\r
1514 self._Scope = Parser._Scope\r
1515 self._Enabled = Parser._Enabled\r
1516\r
1517 # Insert all records in the table for the included file into dsc file table\r
1518 Records = IncludedFileTable.GetAll()\r
1519 if Records:\r
1520 self._Content[self._ContentIndex:self._ContentIndex] = Records\r
1521 self._Content.pop(self._ContentIndex - 1)\r
1522 self._ValueList = None\r
1523 self._ContentIndex -= 1\r
1524\r
1525 def __ProcessSkuId(self):\r
1526 self._ValueList = [ReplaceMacro(Value, self._Macros, RaiseError=True)\r
1527 for Value in self._ValueList]\r
1528\r
1529 def __ProcessLibraryInstance(self):\r
1530 self._ValueList = [ReplaceMacro(Value, self._Macros) for Value in self._ValueList]\r
1531\r
1532 def __ProcessLibraryClass(self):\r
1533 self._ValueList[1] = ReplaceMacro(self._ValueList[1], self._Macros, RaiseError=True)\r
1534\r
1535 def __ProcessPcd(self):\r
1536 if self._ItemType not in [MODEL_PCD_FEATURE_FLAG, MODEL_PCD_FIXED_AT_BUILD]:\r
1537 self._ValueList[2] = ReplaceMacro(self._ValueList[2], self._Macros, RaiseError=True)\r
1538 return\r
1539\r
1540 ValList, Valid, Index = AnalyzeDscPcd(self._ValueList[2], self._ItemType)\r
1541 if not Valid:\r
47fea6af 1542 EdkLogger.error('build', FORMAT_INVALID, "Pcd format incorrect.", File=self._FileWithError, Line=self._LineIndex + 1,\r
f51461c8
LG
1543 ExtraData="%s.%s|%s" % (self._ValueList[0], self._ValueList[1], self._ValueList[2]))\r
1544 PcdValue = ValList[Index]\r
1545 if PcdValue:\r
1546 try:\r
1547 ValList[Index] = ValueExpression(PcdValue, self._Macros)(True)\r
1548 except WrnExpression, Value:\r
1549 ValList[Index] = Value.result\r
1550\r
1551 if ValList[Index] == 'True':\r
1552 ValList[Index] = '1'\r
1553 if ValList[Index] == 'False':\r
1554 ValList[Index] = '0'\r
1555\r
22a99b87
YL
1556 if (not self._DirectiveEvalStack) or (False not in self._DirectiveEvalStack):\r
1557 GlobalData.gPlatformPcds[TAB_SPLIT.join(self._ValueList[0:2])] = PcdValue\r
1558 self._Symbols[TAB_SPLIT.join(self._ValueList[0:2])] = PcdValue\r
f51461c8
LG
1559 self._ValueList[2] = '|'.join(ValList)\r
1560\r
1561 def __ProcessComponent(self):\r
1562 self._ValueList[0] = ReplaceMacro(self._ValueList[0], self._Macros)\r
1563\r
1564 def __ProcessSourceOverridePath(self):\r
1565 self._ValueList[0] = ReplaceMacro(self._ValueList[0], self._Macros)\r
1566\r
1567 def __ProcessBuildOption(self):\r
1568 self._ValueList = [ReplaceMacro(Value, self._Macros, RaiseError=False)\r
1569 for Value in self._ValueList]\r
1570\r
1571 _SectionParser = {\r
1572 MODEL_META_DATA_HEADER : _DefineParser,\r
1573 MODEL_EFI_SKU_ID : _SkuIdParser,\r
1574 MODEL_EFI_LIBRARY_INSTANCE : _LibraryInstanceParser,\r
1575 MODEL_EFI_LIBRARY_CLASS : _LibraryClassParser,\r
1576 MODEL_PCD_FIXED_AT_BUILD : _PcdParser,\r
1577 MODEL_PCD_PATCHABLE_IN_MODULE : _PcdParser,\r
1578 MODEL_PCD_FEATURE_FLAG : _PcdParser,\r
1579 MODEL_PCD_DYNAMIC_DEFAULT : _PcdParser,\r
1580 MODEL_PCD_DYNAMIC_HII : _PcdParser,\r
1581 MODEL_PCD_DYNAMIC_VPD : _PcdParser,\r
1582 MODEL_PCD_DYNAMIC_EX_DEFAULT : _PcdParser,\r
1583 MODEL_PCD_DYNAMIC_EX_HII : _PcdParser,\r
1584 MODEL_PCD_DYNAMIC_EX_VPD : _PcdParser,\r
1585 MODEL_META_DATA_COMPONENT : _ComponentParser,\r
1586 MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH : _CompponentSourceOverridePathParser,\r
1587 MODEL_META_DATA_BUILD_OPTION : _BuildOptionParser,\r
1588 MODEL_UNKNOWN : MetaFileParser._Skip,\r
0923aa1c 1589 MODEL_META_DATA_USER_EXTENSION : MetaFileParser._SkipUserExtension,\r
f51461c8
LG
1590 MODEL_META_DATA_SECTION_HEADER : MetaFileParser._SectionHeaderParser,\r
1591 MODEL_META_DATA_SUBSECTION_HEADER : _SubsectionHeaderParser,\r
1592 }\r
1593\r
1594 _Macros = property(_GetMacros)\r
1595\r
1596## DEC file parser class\r
1597#\r
1598# @param FilePath The path of platform description file\r
1599# @param FileType The raw data of DSC file\r
1600# @param Table Database used to retrieve module/package information\r
1601# @param Macros Macros used for replacement in file\r
1602#\r
1603class DecParser(MetaFileParser):\r
1604 # DEC file supported data types (one type per section)\r
1605 DataType = {\r
1606 TAB_DEC_DEFINES.upper() : MODEL_META_DATA_HEADER,\r
1607 TAB_DSC_DEFINES_DEFINE : MODEL_META_DATA_DEFINE,\r
1608 TAB_INCLUDES.upper() : MODEL_EFI_INCLUDE,\r
1609 TAB_LIBRARY_CLASSES.upper() : MODEL_EFI_LIBRARY_CLASS,\r
1610 TAB_GUIDS.upper() : MODEL_EFI_GUID,\r
1611 TAB_PPIS.upper() : MODEL_EFI_PPI,\r
1612 TAB_PROTOCOLS.upper() : MODEL_EFI_PROTOCOL,\r
1613 TAB_PCDS_FIXED_AT_BUILD_NULL.upper() : MODEL_PCD_FIXED_AT_BUILD,\r
1614 TAB_PCDS_PATCHABLE_IN_MODULE_NULL.upper() : MODEL_PCD_PATCHABLE_IN_MODULE,\r
1615 TAB_PCDS_FEATURE_FLAG_NULL.upper() : MODEL_PCD_FEATURE_FLAG,\r
1616 TAB_PCDS_DYNAMIC_NULL.upper() : MODEL_PCD_DYNAMIC,\r
1617 TAB_PCDS_DYNAMIC_EX_NULL.upper() : MODEL_PCD_DYNAMIC_EX,\r
0923aa1c 1618 TAB_USER_EXTENSIONS.upper() : MODEL_META_DATA_USER_EXTENSION,\r
f51461c8
LG
1619 }\r
1620\r
1621 ## Constructor of DecParser\r
1622 #\r
1623 # Initialize object of DecParser\r
1624 #\r
1625 # @param FilePath The path of platform description file\r
1626 # @param FileType The raw data of DSC file\r
cdd1b5e5 1627 # @param Arch Default Arch value for filtering sections\r
f51461c8 1628 # @param Table Database used to retrieve module/package information\r
f51461c8 1629 #\r
cdd1b5e5 1630 def __init__(self, FilePath, FileType, Arch, Table):\r
f51461c8
LG
1631 # prevent re-initialization\r
1632 if hasattr(self, "_Table"):\r
1633 return\r
cdd1b5e5 1634 MetaFileParser.__init__(self, FilePath, FileType, Arch, Table, -1)\r
f51461c8
LG
1635 self._Comments = []\r
1636 self._Version = 0x00010005 # Only EDK2 dec file is supported\r
1637 self._AllPCDs = [] # Only for check duplicate PCD\r
1638\r
1639 ## Parser starter\r
1640 def Start(self):\r
1641 Content = ''\r
1642 try:\r
1643 Content = open(str(self.MetaFile), 'r').readlines()\r
1644 except:\r
1645 EdkLogger.error("Parser", FILE_READ_FAILURE, ExtraData=self.MetaFile)\r
1646\r
1647 for Index in range(0, len(Content)):\r
1648 Line, Comment = CleanString2(Content[Index])\r
1649 self._CurrentLine = Line\r
1650 self._LineIndex = Index\r
1651\r
1652 # save comment for later use\r
1653 if Comment:\r
1654 self._Comments.append((Comment, self._LineIndex + 1))\r
1655 # skip empty line\r
1656 if Line == '':\r
1657 continue\r
1658\r
1659 # section header\r
1660 if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:\r
1661 self._SectionHeaderParser()\r
1662 self._Comments = []\r
1663 continue\r
1664 elif len(self._SectionType) == 0:\r
1665 self._Comments = []\r
1666 continue\r
1667\r
1668 # section content\r
1669 self._ValueList = ['', '', '']\r
1670 self._SectionParser[self._SectionType[0]](self)\r
1671 if self._ValueList == None or self._ItemType == MODEL_META_DATA_DEFINE:\r
1672 self._ItemType = -1\r
1673 self._Comments = []\r
1674 continue\r
1675\r
1676 #\r
1677 # Model, Value1, Value2, Value3, Arch, BelongsToItem=-1, LineBegin=-1,\r
1678 # ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, FeatureFlag='', Enabled=-1\r
1679 #\r
1680 for Arch, ModuleType, Type in self._Scope:\r
1681 self._LastItem = self._Store(\r
1682 Type,\r
1683 self._ValueList[0],\r
1684 self._ValueList[1],\r
1685 self._ValueList[2],\r
1686 Arch,\r
1687 ModuleType,\r
1688 self._Owner[-1],\r
1689 self._LineIndex + 1,\r
1690 - 1,\r
1691 self._LineIndex + 1,\r
1692 - 1,\r
1693 0\r
1694 )\r
1695 for Comment, LineNo in self._Comments:\r
1696 self._Store(\r
1697 MODEL_META_DATA_COMMENT,\r
1698 Comment,\r
1699 self._ValueList[0],\r
1700 self._ValueList[1],\r
1701 Arch,\r
1702 ModuleType,\r
1703 self._LastItem,\r
1704 LineNo,\r
1705 - 1,\r
1706 LineNo,\r
1707 - 1,\r
1708 0\r
1709 )\r
1710 self._Comments = []\r
1711 self._Done()\r
1712\r
1713\r
1714 ## Section header parser\r
1715 #\r
1716 # The section header is always in following format:\r
1717 #\r
1718 # [section_name.arch<.platform|module_type>]\r
1719 #\r
1720 def _SectionHeaderParser(self):\r
1721 self._Scope = []\r
1722 self._SectionName = ''\r
1723 self._SectionType = []\r
1724 ArchList = set()\r
1725 Line = self._CurrentLine.replace("%s%s" % (TAB_COMMA_SPLIT, TAB_SPACE_SPLIT), TAB_COMMA_SPLIT)\r
1726 for Item in Line[1:-1].split(TAB_COMMA_SPLIT):\r
1727 if Item == '':\r
1728 EdkLogger.error("Parser", FORMAT_UNKNOWN_ERROR,\r
1729 "section name can NOT be empty or incorrectly use separator comma",\r
1730 self.MetaFile, self._LineIndex + 1, self._CurrentLine)\r
1731 ItemList = Item.split(TAB_SPLIT)\r
1732\r
1733 # different types of PCD are permissible in one section\r
1734 self._SectionName = ItemList[0].upper()\r
1735 if self._SectionName in self.DataType:\r
1736 if self.DataType[self._SectionName] not in self._SectionType:\r
1737 self._SectionType.append(self.DataType[self._SectionName])\r
1738 else:\r
1739 EdkLogger.error("Parser", FORMAT_UNKNOWN_ERROR, "%s is not a valid section name" % Item,\r
1740 self.MetaFile, self._LineIndex + 1, self._CurrentLine)\r
1741\r
1742 if MODEL_PCD_FEATURE_FLAG in self._SectionType and len(self._SectionType) > 1:\r
1743 EdkLogger.error(\r
1744 'Parser',\r
1745 FORMAT_INVALID,\r
1746 "%s must not be in the same section of other types of PCD" % TAB_PCDS_FEATURE_FLAG_NULL,\r
1747 File=self.MetaFile,\r
1748 Line=self._LineIndex + 1,\r
1749 ExtraData=self._CurrentLine\r
1750 )\r
1751 # S1 is always Arch\r
1752 if len(ItemList) > 1:\r
1753 S1 = ItemList[1].upper()\r
1754 else:\r
1755 S1 = 'COMMON'\r
1756 ArchList.add(S1)\r
1757 # S2 may be Platform or ModuleType\r
1758 if len(ItemList) > 2:\r
1759 S2 = ItemList[2].upper()\r
1760 else:\r
1761 S2 = 'COMMON'\r
1762 if [S1, S2, self.DataType[self._SectionName]] not in self._Scope:\r
1763 self._Scope.append([S1, S2, self.DataType[self._SectionName]])\r
1764\r
1765 # 'COMMON' must not be used with specific ARCHs at the same section\r
1766 if 'COMMON' in ArchList and len(ArchList) > 1:\r
1767 EdkLogger.error('Parser', FORMAT_INVALID, "'common' ARCH must not be used with specific ARCHs",\r
1768 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)\r
1769\r
1770 ## [guids], [ppis] and [protocols] section parser\r
1771 @ParseMacro\r
1772 def _GuidParser(self):\r
1773 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
1774 if len(TokenList) < 2:\r
1775 EdkLogger.error('Parser', FORMAT_INVALID, "No GUID name or value specified",\r
1776 ExtraData=self._CurrentLine + " (<CName> = <GuidValueInCFormat>)",\r
1777 File=self.MetaFile, Line=self._LineIndex + 1)\r
1778 if TokenList[0] == '':\r
1779 EdkLogger.error('Parser', FORMAT_INVALID, "No GUID name specified",\r
1780 ExtraData=self._CurrentLine + " (<CName> = <GuidValueInCFormat>)",\r
1781 File=self.MetaFile, Line=self._LineIndex + 1)\r
1782 if TokenList[1] == '':\r
1783 EdkLogger.error('Parser', FORMAT_INVALID, "No GUID value specified",\r
1784 ExtraData=self._CurrentLine + " (<CName> = <GuidValueInCFormat>)",\r
1785 File=self.MetaFile, Line=self._LineIndex + 1)\r
1786 if TokenList[1][0] != '{' or TokenList[1][-1] != '}' or GuidStructureStringToGuidString(TokenList[1]) == '':\r
1787 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid GUID value format",\r
1788 ExtraData=self._CurrentLine + \\r
1789 " (<CName> = <GuidValueInCFormat:{8,4,4,{2,2,2,2,2,2,2,2}}>)",\r
1790 File=self.MetaFile, Line=self._LineIndex + 1)\r
1791 self._ValueList[0] = TokenList[0]\r
1792 self._ValueList[1] = TokenList[1]\r
1793\r
1794 ## PCD sections parser\r
1795 #\r
1796 # [PcdsFixedAtBuild]\r
1797 # [PcdsPatchableInModule]\r
1798 # [PcdsFeatureFlag]\r
1799 # [PcdsDynamicEx\r
1800 # [PcdsDynamic]\r
1801 #\r
1802 @ParseMacro\r
1803 def _PcdParser(self):\r
1804 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 1)\r
1805 self._ValueList[0:1] = GetSplitValueList(TokenList[0], TAB_SPLIT)\r
1806 ValueRe = re.compile(r'^[a-zA-Z_][a-zA-Z0-9_]*')\r
1807 # check PCD information\r
1808 if self._ValueList[0] == '' or self._ValueList[1] == '':\r
1809 EdkLogger.error('Parser', FORMAT_INVALID, "No token space GUID or PCD name specified",\r
1810 ExtraData=self._CurrentLine + \\r
1811 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1812 File=self.MetaFile, Line=self._LineIndex + 1)\r
1813 # check format of token space GUID CName\r
1814 if not ValueRe.match(self._ValueList[0]):\r
1815 EdkLogger.error('Parser', FORMAT_INVALID, "The format of the token space GUID CName is invalid. The correct format is '(a-zA-Z_)[a-zA-Z0-9_]*'",\r
1816 ExtraData=self._CurrentLine + \\r
1817 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1818 File=self.MetaFile, Line=self._LineIndex + 1)\r
1819 # check format of PCD CName\r
1820 if not ValueRe.match(self._ValueList[1]):\r
1821 EdkLogger.error('Parser', FORMAT_INVALID, "The format of the PCD CName is invalid. The correct format is '(a-zA-Z_)[a-zA-Z0-9_]*'",\r
1822 ExtraData=self._CurrentLine + \\r
1823 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1824 File=self.MetaFile, Line=self._LineIndex + 1)\r
1825 # check PCD datum information\r
1826 if len(TokenList) < 2 or TokenList[1] == '':\r
1827 EdkLogger.error('Parser', FORMAT_INVALID, "No PCD Datum information given",\r
1828 ExtraData=self._CurrentLine + \\r
1829 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1830 File=self.MetaFile, Line=self._LineIndex + 1)\r
1831\r
1832\r
1833 ValueRe = re.compile(r'^\s*L?\".*\|.*\"')\r
1834 PtrValue = ValueRe.findall(TokenList[1])\r
1835\r
1836 # Has VOID* type string, may contain "|" character in the string. \r
1837 if len(PtrValue) != 0:\r
1838 ptrValueList = re.sub(ValueRe, '', TokenList[1])\r
1839 ValueList = GetSplitValueList(ptrValueList)\r
1840 ValueList[0] = PtrValue[0]\r
1841 else:\r
1842 ValueList = GetSplitValueList(TokenList[1])\r
1843\r
1844\r
1845 # check if there's enough datum information given\r
1846 if len(ValueList) != 3:\r
1847 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid PCD Datum information given",\r
1848 ExtraData=self._CurrentLine + \\r
1849 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1850 File=self.MetaFile, Line=self._LineIndex + 1)\r
1851 # check default value\r
1852 if ValueList[0] == '':\r
1853 EdkLogger.error('Parser', FORMAT_INVALID, "Missing DefaultValue in PCD Datum information",\r
1854 ExtraData=self._CurrentLine + \\r
1855 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1856 File=self.MetaFile, Line=self._LineIndex + 1)\r
1857 # check datum type\r
1858 if ValueList[1] == '':\r
1859 EdkLogger.error('Parser', FORMAT_INVALID, "Missing DatumType in PCD Datum information",\r
1860 ExtraData=self._CurrentLine + \\r
1861 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1862 File=self.MetaFile, Line=self._LineIndex + 1)\r
1863 # check token of the PCD\r
1864 if ValueList[2] == '':\r
1865 EdkLogger.error('Parser', FORMAT_INVALID, "Missing Token in PCD Datum information",\r
1866 ExtraData=self._CurrentLine + \\r
1867 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1868 File=self.MetaFile, Line=self._LineIndex + 1)\r
1869 # check format of default value against the datum type\r
1870 IsValid, Cause = CheckPcdDatum(ValueList[1], ValueList[0])\r
1871 if not IsValid:\r
1872 EdkLogger.error('Parser', FORMAT_INVALID, Cause, ExtraData=self._CurrentLine,\r
1873 File=self.MetaFile, Line=self._LineIndex + 1)\r
1874\r
1875 if ValueList[0] in ['True', 'true', 'TRUE']:\r
1876 ValueList[0] = '1'\r
1877 elif ValueList[0] in ['False', 'false', 'FALSE']:\r
1878 ValueList[0] = '0'\r
1879\r
1880 # check for duplicate PCD definition\r
1881 if (self._Scope[0], self._ValueList[0], self._ValueList[1]) in self._AllPCDs:\r
1882 EdkLogger.error('Parser', FORMAT_INVALID,\r
1883 "The same PCD name and GUID have been already defined",\r
1884 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
1885 else:\r
1886 self._AllPCDs.append((self._Scope[0], self._ValueList[0], self._ValueList[1]))\r
1887\r
1888 self._ValueList[2] = ValueList[0].strip() + '|' + ValueList[1].strip() + '|' + ValueList[2].strip()\r
1889\r
1890 _SectionParser = {\r
1891 MODEL_META_DATA_HEADER : MetaFileParser._DefineParser,\r
1892 MODEL_EFI_INCLUDE : MetaFileParser._PathParser,\r
1893 MODEL_EFI_LIBRARY_CLASS : MetaFileParser._PathParser,\r
1894 MODEL_EFI_GUID : _GuidParser,\r
1895 MODEL_EFI_PPI : _GuidParser,\r
1896 MODEL_EFI_PROTOCOL : _GuidParser,\r
1897 MODEL_PCD_FIXED_AT_BUILD : _PcdParser,\r
1898 MODEL_PCD_PATCHABLE_IN_MODULE : _PcdParser,\r
1899 MODEL_PCD_FEATURE_FLAG : _PcdParser,\r
1900 MODEL_PCD_DYNAMIC : _PcdParser,\r
1901 MODEL_PCD_DYNAMIC_EX : _PcdParser,\r
1902 MODEL_UNKNOWN : MetaFileParser._Skip,\r
0923aa1c 1903 MODEL_META_DATA_USER_EXTENSION : MetaFileParser._SkipUserExtension,\r
f51461c8
LG
1904 }\r
1905\r
1906##\r
1907#\r
1908# This acts like the main() function for the script, unless it is 'import'ed into another\r
1909# script.\r
1910#\r
1911if __name__ == '__main__':\r
1912 pass\r
1913\r