]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Workspace/MetaFileParser.py
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
BaseTools: Fix the bug that use '|' or '||' in DSC file's Pcd value
[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
dc4c7707 4# Copyright (c) 2008 - 2017, 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
67e11e4d 29from Common.Misc import GuidStructureStringToGuidString, CheckPcdDatum, PathClass, AnalyzePcdData, AnalyzeDscPcd, AnalyzePcdExpression\r
f51461c8
LG		 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
dc4c7707
YZ		 354 MacroUsed = GlobalData.gMacroRefPattern.findall(Value)\r
355 if len(MacroUsed) != 0:\r
356 for Macro in MacroUsed:\r
357 if Macro in GlobalData.gGlobalDefines:\r
358 EdkLogger.error("Parser", FORMAT_INVALID, "Global macro %s is not permitted." % (Macro), ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
359 else:\r
360 EdkLogger.error("Parser", FORMAT_INVALID, "%s not defined" % (Macro), ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
f51461c8
LG		 361 # Sometimes, we need to make differences between EDK and EDK2 modules \r
362 if Name == 'INF_VERSION':\r
3ab1434a
YZ		 363 if re.match(r'0[xX][\da-f-A-F]{5,8}', Value):\r
364 self._Version = int(Value, 0) \r
365 elif re.match(r'\d+\.\d+', Value):\r
366 ValueList = Value.split('.')\r
367 Major = '%04o' % int(ValueList[0], 0)\r
368 Minor = '%04o' % int(ValueList[1], 0)\r
369 self._Version = int('0x' + Major + Minor, 0)\r
370 else:\r
f51461c8
LG		 371 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid version number",\r
372 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
373\r
374 if type(self) == InfParser and self._Version < 0x00010005:\r
375 # EDK module allows using defines as macros\r
376 self._FileLocalMacros[Name] = Value\r
377 self._Defines[Name] = Value\r
378\r
379 ## [BuildOptions] section parser\r
380 @ParseMacro\r
381 def _BuildOptionParser(self):\r
382 self._CurrentLine = CleanString(self._CurrentLine, BuildOption=True)\r
383 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
384 TokenList2 = GetSplitValueList(TokenList[0], ':', 1)\r
385 if len(TokenList2) == 2:\r
386 self._ValueList[0] = TokenList2[0] # toolchain family\r
387 self._ValueList[1] = TokenList2[1] # keys\r
388 else:\r
389 self._ValueList[1] = TokenList[0]\r
390 if len(TokenList) == 2 and type(self) != DscParser: # value\r
391 self._ValueList[2] = ReplaceMacro(TokenList[1], self._Macros)\r
392\r
393 if self._ValueList[1].count('_') != 4:\r
394 EdkLogger.error(\r
395 'Parser',\r
396 FORMAT_INVALID,\r
397 "'%s' must be in format of <TARGET>_<TOOLCHAIN>_<ARCH>_<TOOL>_FLAGS" % self._ValueList[1],\r
398 ExtraData=self._CurrentLine,\r
399 File=self.MetaFile,\r
400 Line=self._LineIndex + 1\r
401 )\r
82a6a960
BF		 402 def GetValidExpression(self, TokenSpaceGuid, PcdCName):\r
403 return self._Table.GetValidExpression(TokenSpaceGuid, PcdCName)\r
f51461c8
LG		 404 def _GetMacros(self):\r
405 Macros = {}\r
406 Macros.update(self._FileLocalMacros)\r
407 Macros.update(self._GetApplicableSectionMacro())\r
408 return Macros\r
409\r
410 ## Construct section Macro dict \r
411 def _ConstructSectionMacroDict(self, Name, Value):\r
412 ScopeKey = [(Scope[0], Scope[1]) for Scope in self._Scope]\r
413 ScopeKey = tuple(ScopeKey)\r
414 SectionDictKey = self._SectionType, ScopeKey\r
415 #\r
416 # DecParser SectionType is a list, will contain more than one item only in Pcd Section\r
417 # As Pcd section macro usage is not alllowed, so here it is safe\r
418 #\r
419 if type(self) == DecParser:\r
420 SectionDictKey = self._SectionType[0], ScopeKey\r
421 if SectionDictKey not in self._SectionsMacroDict:\r
422 self._SectionsMacroDict[SectionDictKey] = {}\r
423 SectionLocalMacros = self._SectionsMacroDict[SectionDictKey]\r
424 SectionLocalMacros[Name] = Value\r
425\r
426 ## Get section Macros that are applicable to current line, which may come from other sections \r
427 ## that share the same name while scope is wider\r
428 def _GetApplicableSectionMacro(self):\r
429 Macros = {}\r
430\r
431 ComComMacroDict = {}\r
432 ComSpeMacroDict = {}\r
433 SpeSpeMacroDict = {}\r
434\r
435 ActiveSectionType = self._SectionType\r
436 if type(self) == DecParser:\r
437 ActiveSectionType = self._SectionType[0]\r
438\r
439 for (SectionType, Scope) in self._SectionsMacroDict:\r
440 if SectionType != ActiveSectionType:\r
441 continue\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:\r
446 break\r
447 else:\r
448 SpeSpeMacroDict.update(self._SectionsMacroDict[(SectionType, Scope)])\r
449\r
450 for ActiveScope in self._Scope:\r
451 Scope0, Scope1 = ActiveScope[0], ActiveScope[1]\r
452 if(Scope0, Scope1) not in Scope and (Scope0, "COMMON") not in Scope and ("COMMON", Scope1) not in Scope:\r
453 break\r
454 else:\r
455 ComSpeMacroDict.update(self._SectionsMacroDict[(SectionType, Scope)])\r
456\r
457 if ("COMMON", "COMMON") in Scope:\r
458 ComComMacroDict.update(self._SectionsMacroDict[(SectionType, Scope)])\r
459\r
460 Macros.update(ComComMacroDict)\r
461 Macros.update(ComSpeMacroDict)\r
462 Macros.update(SpeSpeMacroDict)\r
463\r
464 return Macros\r
465\r
466 _SectionParser = {}\r
467 Finished = property(_GetFinished, _SetFinished)\r
468 _Macros = property(_GetMacros)\r
469\r
470\r
471## INF file parser class\r
472#\r
473# @param FilePath The path of platform description file\r
474# @param FileType The raw data of DSC file\r
475# @param Table Database used to retrieve module/package information\r
476# @param Macros Macros used for replacement in file\r
477#\r
478class InfParser(MetaFileParser):\r
479 # INF file supported data types (one type per section)\r
480 DataType = {\r
481 TAB_UNKNOWN.upper() : MODEL_UNKNOWN,\r
482 TAB_INF_DEFINES.upper() : MODEL_META_DATA_HEADER,\r
483 TAB_DSC_DEFINES_DEFINE : MODEL_META_DATA_DEFINE,\r
484 TAB_BUILD_OPTIONS.upper() : MODEL_META_DATA_BUILD_OPTION,\r
485 TAB_INCLUDES.upper() : MODEL_EFI_INCLUDE,\r
486 TAB_LIBRARIES.upper() : MODEL_EFI_LIBRARY_INSTANCE,\r
487 TAB_LIBRARY_CLASSES.upper() : MODEL_EFI_LIBRARY_CLASS,\r
488 TAB_PACKAGES.upper() : MODEL_META_DATA_PACKAGE,\r
489 TAB_NMAKE.upper() : MODEL_META_DATA_NMAKE,\r
490 TAB_INF_FIXED_PCD.upper() : MODEL_PCD_FIXED_AT_BUILD,\r
491 TAB_INF_PATCH_PCD.upper() : MODEL_PCD_PATCHABLE_IN_MODULE,\r
492 TAB_INF_FEATURE_PCD.upper() : MODEL_PCD_FEATURE_FLAG,\r
493 TAB_INF_PCD_EX.upper() : MODEL_PCD_DYNAMIC_EX,\r
494 TAB_INF_PCD.upper() : MODEL_PCD_DYNAMIC,\r
495 TAB_SOURCES.upper() : MODEL_EFI_SOURCE_FILE,\r
496 TAB_GUIDS.upper() : MODEL_EFI_GUID,\r
497 TAB_PROTOCOLS.upper() : MODEL_EFI_PROTOCOL,\r
498 TAB_PPIS.upper() : MODEL_EFI_PPI,\r
499 TAB_DEPEX.upper() : MODEL_EFI_DEPEX,\r
500 TAB_BINARIES.upper() : MODEL_EFI_BINARY_FILE,\r
501 TAB_USER_EXTENSIONS.upper() : MODEL_META_DATA_USER_EXTENSION\r
502 }\r
503\r
504 ## Constructor of InfParser\r
505 #\r
506 # Initialize object of InfParser\r
507 #\r
508 # @param FilePath The path of module description file\r
509 # @param FileType The raw data of DSC file\r
cdd1b5e5 510 # @param Arch Default Arch value for filtering sections\r
f51461c8 511 # @param Table Database used to retrieve module/package information\r
f51461c8 512 #\r
cdd1b5e5 513 def __init__(self, FilePath, FileType, Arch, Table):\r
f51461c8
LG		 514 # prevent re-initialization\r
515 if hasattr(self, "_Table"):\r
516 return\r
cdd1b5e5 517 MetaFileParser.__init__(self, FilePath, FileType, Arch, Table)\r
f51461c8
LG		 518 self.PcdsDict = {}\r
519\r
520 ## Parser starter\r
521 def Start(self):\r
522 NmakeLine = ''\r
523 Content = ''\r
524 try:\r
525 Content = open(str(self.MetaFile), 'r').readlines()\r
526 except:\r
527 EdkLogger.error("Parser", FILE_READ_FAILURE, ExtraData=self.MetaFile)\r
528\r
529 # parse the file line by line\r
530 IsFindBlockComment = False\r
531 GetHeaderComment = False\r
532 TailComments = []\r
533 SectionComments = []\r
534 Comments = []\r
535\r
536 for Index in range(0, len(Content)):\r
537 # skip empty, commented, block commented lines\r
538 Line, Comment = CleanString2(Content[Index], AllowCppStyleComment=True)\r
539 NextLine = ''\r
540 if Index + 1 < len(Content):\r
541 NextLine, NextComment = CleanString2(Content[Index + 1])\r
542 if Line == '':\r
543 if Comment:\r
544 Comments.append((Comment, Index + 1))\r
545 elif GetHeaderComment:\r
546 SectionComments.extend(Comments)\r
547 Comments = []\r
548 continue\r
549 if Line.find(DataType.TAB_COMMENT_EDK_START) > -1:\r
550 IsFindBlockComment = True\r
551 continue\r
552 if Line.find(DataType.TAB_COMMENT_EDK_END) > -1:\r
553 IsFindBlockComment = False\r
554 continue\r
555 if IsFindBlockComment:\r
556 continue\r
557\r
558 self._LineIndex = Index\r
559 self._CurrentLine = Line\r
560\r
561 # section header\r
562 if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:\r
563 if not GetHeaderComment:\r
564 for Cmt, LNo in Comments:\r
565 self._Store(MODEL_META_DATA_HEADER_COMMENT, Cmt, '', '', 'COMMON',\r
566 'COMMON', self._Owner[-1], LNo, -1, LNo, -1, 0)\r
567 GetHeaderComment = True\r
568 else:\r
569 TailComments.extend(SectionComments + Comments)\r
570 Comments = []\r
571 self._SectionHeaderParser()\r
572 # Check invalid sections\r
573 if self._Version < 0x00010005:\r
574 if self._SectionType in [MODEL_META_DATA_BUILD_OPTION,\r
575 MODEL_EFI_LIBRARY_CLASS,\r
576 MODEL_META_DATA_PACKAGE,\r
577 MODEL_PCD_FIXED_AT_BUILD,\r
578 MODEL_PCD_PATCHABLE_IN_MODULE,\r
579 MODEL_PCD_FEATURE_FLAG,\r
580 MODEL_PCD_DYNAMIC_EX,\r
581 MODEL_PCD_DYNAMIC,\r
582 MODEL_EFI_GUID,\r
583 MODEL_EFI_PROTOCOL,\r
584 MODEL_EFI_PPI,\r
585 MODEL_META_DATA_USER_EXTENSION]:\r
586 EdkLogger.error('Parser', FORMAT_INVALID,\r
587 "Section [%s] is not allowed in inf file without version" % (self._SectionName),\r
588 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
589 elif self._SectionType in [MODEL_EFI_INCLUDE,\r
590 MODEL_EFI_LIBRARY_INSTANCE,\r
591 MODEL_META_DATA_NMAKE]:\r
592 EdkLogger.error('Parser', FORMAT_INVALID,\r
593 "Section [%s] is not allowed in inf file with version 0x%08x" % (self._SectionName, self._Version),\r
594 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
595 continue\r
596 # merge two lines specified by '\' in section NMAKE\r
597 elif self._SectionType == MODEL_META_DATA_NMAKE:\r
598 if Line[-1] == '\\':\r
599 if NextLine == '':\r
600 self._CurrentLine = NmakeLine + Line[0:-1]\r
601 NmakeLine = ''\r
602 else:\r
603 if NextLine[0] == TAB_SECTION_START and NextLine[-1] == TAB_SECTION_END:\r
604 self._CurrentLine = NmakeLine + Line[0:-1]\r
605 NmakeLine = ''\r
606 else:\r
607 NmakeLine = NmakeLine + ' ' + Line[0:-1]\r
608 continue\r
609 else:\r
610 self._CurrentLine = NmakeLine + Line\r
611 NmakeLine = ''\r
612\r
613 # section content\r
614 self._ValueList = ['', '', '']\r
615 # parse current line, result will be put in self._ValueList\r
616 self._SectionParser[self._SectionType](self)\r
617 if self._ValueList == None or self._ItemType == MODEL_META_DATA_DEFINE:\r
618 self._ItemType = -1\r
619 Comments = []\r
620 continue\r
621 if Comment:\r
622 Comments.append((Comment, Index + 1))\r
97fa0ee9
YL		 623 if GlobalData.gOptions and GlobalData.gOptions.CheckUsage:\r
624 CheckInfComment(self._SectionType, Comments, str(self.MetaFile), Index + 1, self._ValueList)\r
f51461c8
LG		 625 #\r
626 # Model, Value1, Value2, Value3, Arch, Platform, BelongsToItem=-1,\r
627 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1\r
628 #\r
629 for Arch, Platform in self._Scope:\r
630 LastItem = self._Store(self._SectionType,\r
631 self._ValueList[0],\r
632 self._ValueList[1],\r
633 self._ValueList[2],\r
634 Arch,\r
635 Platform,\r
636 self._Owner[-1],\r
637 self._LineIndex + 1,\r
638 - 1,\r
639 self._LineIndex + 1,\r
640 - 1,\r
641 0\r
642 )\r
643 for Comment, LineNo in Comments:\r
644 self._Store(MODEL_META_DATA_COMMENT, Comment, '', '', Arch, Platform,\r
645 LastItem, LineNo, -1, LineNo, -1, 0)\r
646 Comments = []\r
647 SectionComments = []\r
648 TailComments.extend(SectionComments + Comments)\r
649 if IsFindBlockComment:\r
650 EdkLogger.error("Parser", FORMAT_INVALID, "Open block comments (starting with /*) are expected to end with */",\r
651 File=self.MetaFile)\r
652\r
653 # If there are tail comments in INF file, save to database whatever the comments are\r
654 for Comment in TailComments:\r
655 self._Store(MODEL_META_DATA_TAIL_COMMENT, Comment[0], '', '', 'COMMON',\r
656 'COMMON', self._Owner[-1], -1, -1, -1, -1, 0)\r
657 self._Done()\r
658\r
659 ## Data parser for the format in which there's path\r
660 #\r
661 # Only path can have macro used. So we need to replace them before use.\r
662 #\r
663 def _IncludeParser(self):\r
664 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
665 self._ValueList[0:len(TokenList)] = TokenList\r
666 Macros = self._Macros\r
667 if Macros:\r
668 for Index in range(0, len(self._ValueList)):\r
669 Value = self._ValueList[Index]\r
670 if not Value:\r
671 continue\r
672\r
673 if Value.upper().find('$(EFI_SOURCE)\Edk'.upper()) > -1 or Value.upper().find('$(EFI_SOURCE)/Edk'.upper()) > -1:\r
674 Value = '$(EDK_SOURCE)' + Value[17:]\r
675 if Value.find('$(EFI_SOURCE)') > -1 or Value.find('$(EDK_SOURCE)') > -1:\r
676 pass\r
677 elif Value.startswith('.'):\r
678 pass\r
679 elif Value.startswith('$('):\r
680 pass\r
681 else:\r
682 Value = '$(EFI_SOURCE)/' + Value\r
683\r
684 self._ValueList[Index] = ReplaceMacro(Value, Macros)\r
685\r
686 ## Parse [Sources] section\r
687 #\r
688 # Only path can have macro used. So we need to replace them before use.\r
689 #\r
690 @ParseMacro\r
691 def _SourceFileParser(self):\r
692 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
693 self._ValueList[0:len(TokenList)] = TokenList\r
694 Macros = self._Macros\r
695 # For Acpi tables, remove macro like ' TABLE_NAME=Sata1'\r
696 if 'COMPONENT_TYPE' in Macros:\r
697 if self._Defines['COMPONENT_TYPE'].upper() == 'ACPITABLE':\r
698 self._ValueList[0] = GetSplitValueList(self._ValueList[0], ' ', 1)[0]\r
699 if self._Defines['BASE_NAME'] == 'Microcode':\r
700 pass\r
701 self._ValueList = [ReplaceMacro(Value, Macros) for Value in self._ValueList]\r
702\r
703 ## Parse [Binaries] section\r
704 #\r
705 # Only path can have macro used. So we need to replace them before use.\r
706 #\r
707 @ParseMacro\r
708 def _BinaryFileParser(self):\r
709 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 2)\r
710 if len(TokenList) < 2:\r
711 EdkLogger.error('Parser', FORMAT_INVALID, "No file type or path specified",\r
712 ExtraData=self._CurrentLine + " (<FileType> | <FilePath> [| <Target>])",\r
713 File=self.MetaFile, Line=self._LineIndex + 1)\r
714 if not TokenList[0]:\r
715 EdkLogger.error('Parser', FORMAT_INVALID, "No file type specified",\r
716 ExtraData=self._CurrentLine + " (<FileType> | <FilePath> [| <Target>])",\r
717 File=self.MetaFile, Line=self._LineIndex + 1)\r
718 if not TokenList[1]:\r
719 EdkLogger.error('Parser', FORMAT_INVALID, "No file path specified",\r
720 ExtraData=self._CurrentLine + " (<FileType> | <FilePath> [| <Target>])",\r
721 File=self.MetaFile, Line=self._LineIndex + 1)\r
722 self._ValueList[0:len(TokenList)] = TokenList\r
723 self._ValueList[1] = ReplaceMacro(self._ValueList[1], self._Macros)\r
724\r
725 ## [nmake] section parser (Edk.x style only)\r
726 def _NmakeParser(self):\r
727 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
728 self._ValueList[0:len(TokenList)] = TokenList\r
729 # remove macros\r
730 self._ValueList[1] = ReplaceMacro(self._ValueList[1], self._Macros)\r
731 # remove self-reference in macro setting\r
732 #self._ValueList[1] = ReplaceMacro(self._ValueList[1], {self._ValueList[0]:''})\r
733\r
734 ## [FixedPcd], [FeaturePcd], [PatchPcd], [Pcd] and [PcdEx] sections parser\r
735 @ParseMacro\r
736 def _PcdParser(self):\r
737 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 1)\r
738 ValueList = GetSplitValueList(TokenList[0], TAB_SPLIT)\r
739 if len(ValueList) != 2:\r
740 EdkLogger.error('Parser', FORMAT_INVALID, "Illegal token space GUID and PCD name format",\r
741 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<PcdCName>)",\r
742 File=self.MetaFile, Line=self._LineIndex + 1)\r
743 self._ValueList[0:1] = ValueList\r
744 if len(TokenList) > 1:\r
745 self._ValueList[2] = TokenList[1]\r
746 if self._ValueList[0] == '' or self._ValueList[1] == '':\r
747 EdkLogger.error('Parser', FORMAT_INVALID, "No token space GUID or PCD name specified",\r
748 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<PcdCName>)",\r
749 File=self.MetaFile, Line=self._LineIndex + 1)\r
750\r
751 # if value are 'True', 'true', 'TRUE' or 'False', 'false', 'FALSE', replace with integer 1 or 0.\r
752 if self._ValueList[2] != '':\r
753 InfPcdValueList = GetSplitValueList(TokenList[1], TAB_VALUE_SPLIT, 1)\r
754 if InfPcdValueList[0] in ['True', 'true', 'TRUE']:\r
755 self._ValueList[2] = TokenList[1].replace(InfPcdValueList[0], '1', 1);\r
756 elif InfPcdValueList[0] in ['False', 'false', 'FALSE']:\r
757 self._ValueList[2] = TokenList[1].replace(InfPcdValueList[0], '0', 1);\r
758 if (self._ValueList[0], self._ValueList[1]) not in self.PcdsDict:\r
759 self.PcdsDict[self._ValueList[0], self._ValueList[1]] = self._SectionType\r
760 elif self.PcdsDict[self._ValueList[0], self._ValueList[1]] != self._SectionType:\r
761 EdkLogger.error('Parser', FORMAT_INVALID, "It is not permissible to list a specified PCD in different PCD type sections.",\r
762 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<PcdCName>)",\r
763 File=self.MetaFile, Line=self._LineIndex + 1)\r
764\r
765 ## [depex] section parser\r
766 @ParseMacro\r
767 def _DepexParser(self):\r
768 self._ValueList[0:1] = [self._CurrentLine]\r
769\r
770 _SectionParser = {\r
771 MODEL_UNKNOWN : MetaFileParser._Skip,\r
772 MODEL_META_DATA_HEADER : MetaFileParser._DefineParser,\r
773 MODEL_META_DATA_BUILD_OPTION : MetaFileParser._BuildOptionParser,\r
774 MODEL_EFI_INCLUDE : _IncludeParser, # for Edk.x modules\r
775 MODEL_EFI_LIBRARY_INSTANCE : MetaFileParser._CommonParser, # for Edk.x modules\r
776 MODEL_EFI_LIBRARY_CLASS : MetaFileParser._PathParser,\r
777 MODEL_META_DATA_PACKAGE : MetaFileParser._PathParser,\r
778 MODEL_META_DATA_NMAKE : _NmakeParser, # for Edk.x modules\r
779 MODEL_PCD_FIXED_AT_BUILD : _PcdParser,\r
780 MODEL_PCD_PATCHABLE_IN_MODULE : _PcdParser,\r
781 MODEL_PCD_FEATURE_FLAG : _PcdParser,\r
782 MODEL_PCD_DYNAMIC_EX : _PcdParser,\r
783 MODEL_PCD_DYNAMIC : _PcdParser,\r
784 MODEL_EFI_SOURCE_FILE : _SourceFileParser,\r
785 MODEL_EFI_GUID : MetaFileParser._CommonParser,\r
786 MODEL_EFI_PROTOCOL : MetaFileParser._CommonParser,\r
787 MODEL_EFI_PPI : MetaFileParser._CommonParser,\r
788 MODEL_EFI_DEPEX : _DepexParser,\r
789 MODEL_EFI_BINARY_FILE : _BinaryFileParser,\r
0923aa1c 790 MODEL_META_DATA_USER_EXTENSION : MetaFileParser._SkipUserExtension,\r
f51461c8
LG		 791 }\r
792\r
793## DSC file parser class\r
794#\r
795# @param FilePath The path of platform description file\r
796# @param FileType The raw data of DSC file\r
797# @param Table Database used to retrieve module/package information\r
798# @param Macros Macros used for replacement in file\r
799# @param Owner Owner ID (for sub-section parsing)\r
800# @param From ID from which the data comes (for !INCLUDE directive)\r
801#\r
802class DscParser(MetaFileParser):\r
803 # DSC file supported data types (one type per section)\r
804 DataType = {\r
805 TAB_SKUIDS.upper() : MODEL_EFI_SKU_ID,\r
806 TAB_LIBRARIES.upper() : MODEL_EFI_LIBRARY_INSTANCE,\r
807 TAB_LIBRARY_CLASSES.upper() : MODEL_EFI_LIBRARY_CLASS,\r
808 TAB_BUILD_OPTIONS.upper() : MODEL_META_DATA_BUILD_OPTION,\r
809 TAB_PCDS_FIXED_AT_BUILD_NULL.upper() : MODEL_PCD_FIXED_AT_BUILD,\r
810 TAB_PCDS_PATCHABLE_IN_MODULE_NULL.upper() : MODEL_PCD_PATCHABLE_IN_MODULE,\r
811 TAB_PCDS_FEATURE_FLAG_NULL.upper() : MODEL_PCD_FEATURE_FLAG,\r
812 TAB_PCDS_DYNAMIC_DEFAULT_NULL.upper() : MODEL_PCD_DYNAMIC_DEFAULT,\r
813 TAB_PCDS_DYNAMIC_HII_NULL.upper() : MODEL_PCD_DYNAMIC_HII,\r
814 TAB_PCDS_DYNAMIC_VPD_NULL.upper() : MODEL_PCD_DYNAMIC_VPD,\r
815 TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL.upper() : MODEL_PCD_DYNAMIC_EX_DEFAULT,\r
816 TAB_PCDS_DYNAMIC_EX_HII_NULL.upper() : MODEL_PCD_DYNAMIC_EX_HII,\r
817 TAB_PCDS_DYNAMIC_EX_VPD_NULL.upper() : MODEL_PCD_DYNAMIC_EX_VPD,\r
818 TAB_COMPONENTS.upper() : MODEL_META_DATA_COMPONENT,\r
819 TAB_COMPONENTS_SOURCE_OVERRIDE_PATH.upper() : MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH,\r
820 TAB_DSC_DEFINES.upper() : MODEL_META_DATA_HEADER,\r
821 TAB_DSC_DEFINES_DEFINE : MODEL_META_DATA_DEFINE,\r
822 TAB_DSC_DEFINES_EDKGLOBAL : MODEL_META_DATA_GLOBAL_DEFINE,\r
823 TAB_INCLUDE.upper() : MODEL_META_DATA_INCLUDE,\r
824 TAB_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
825 TAB_IF_DEF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,\r
826 TAB_IF_N_DEF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF,\r
827 TAB_ELSE_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF,\r
828 TAB_ELSE.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE,\r
829 TAB_END_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF,\r
0923aa1c 830 TAB_USER_EXTENSIONS.upper() : MODEL_META_DATA_USER_EXTENSION,\r
f51461c8
LG		 831 }\r
832\r
833 # Valid names in define section\r
834 DefineKeywords = [\r
835 "DSC_SPECIFICATION",\r
836 "PLATFORM_NAME",\r
837 "PLATFORM_GUID",\r
838 "PLATFORM_VERSION",\r
839 "SKUID_IDENTIFIER",\r
840 "PCD_INFO_GENERATION",\r
82a6a960 841 "PCD_VAR_CHECK_GENERATION",\r
f51461c8
LG		 842 "SUPPORTED_ARCHITECTURES",\r
843 "BUILD_TARGETS",\r
844 "OUTPUT_DIRECTORY",\r
845 "FLASH_DEFINITION",\r
846 "BUILD_NUMBER",\r
847 "RFC_LANGUAGES",\r
848 "ISO_LANGUAGES",\r
849 "TIME_STAMP_FILE",\r
850 "VPD_TOOL_GUID",\r
f0dc69e6
YZ		 851 "FIX_LOAD_TOP_MEMORY_ADDRESS",\r
852 "PREBUILD",\r
853 "POSTBUILD"\r
f51461c8
LG		 854 ]\r
855\r
97fa0ee9
YL		 856 SubSectionDefineKeywords = [\r
857 "FILE_GUID"\r
858 ]\r
859\r
f51461c8
LG		 860 SymbolPattern = ValueExpression.SymbolPattern\r
861\r
c17956e0
DL		 862 IncludedFiles = set()\r
863\r
f51461c8
LG		 864 ## Constructor of DscParser\r
865 #\r
866 # Initialize object of DscParser\r
867 #\r
868 # @param FilePath The path of platform description file\r
869 # @param FileType The raw data of DSC file\r
cdd1b5e5 870 # @param Arch Default Arch value for filtering sections\r
f51461c8 871 # @param Table Database used to retrieve module/package information\r
f51461c8
LG		 872 # @param Owner Owner ID (for sub-section parsing)\r
873 # @param From ID from which the data comes (for !INCLUDE directive)\r
874 #\r
cdd1b5e5 875 def __init__(self, FilePath, FileType, Arch, Table, Owner= -1, From= -1):\r
f51461c8
LG		 876 # prevent re-initialization\r
877 if hasattr(self, "_Table"):\r
878 return\r
cdd1b5e5 879 MetaFileParser.__init__(self, FilePath, FileType, Arch, Table, Owner, From)\r
f51461c8
LG		 880 self._Version = 0x00010005 # Only EDK2 dsc file is supported\r
881 # to store conditional directive evaluation result\r
882 self._DirectiveStack = []\r
883 self._DirectiveEvalStack = []\r
884 self._Enabled = 1\r
885\r
886 #\r
887 # Specify whether current line is in uncertain condition\r
888 #\r
889 self._InDirective = -1\r
890\r
891 # Final valid replacable symbols\r
892 self._Symbols = {}\r
893 #\r
894 # Map the ID between the original table and new table to track\r
895 # the owner item\r
896 #\r
897 self._IdMapping = {-1:-1}\r
898\r
899 ## Parser starter\r
900 def Start(self):\r
901 Content = ''\r
902 try:\r
903 Content = open(str(self.MetaFile), 'r').readlines()\r
904 except:\r
905 EdkLogger.error("Parser", FILE_READ_FAILURE, ExtraData=self.MetaFile)\r
906\r
907 OwnerId = {}\r
908 for Index in range(0, len(Content)):\r
909 Line = CleanString(Content[Index])\r
910 # skip empty line\r
911 if Line == '':\r
912 continue\r
913\r
914 self._CurrentLine = Line\r
915 self._LineIndex = Index\r
916 if self._InSubsection and self._Owner[-1] == -1:\r
917 self._Owner.append(self._LastItem)\r
918\r
919 # section header\r
920 if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:\r
921 self._SectionType = MODEL_META_DATA_SECTION_HEADER\r
922 # subsection ending\r
923 elif Line[0] == '}' and self._InSubsection:\r
924 self._InSubsection = False\r
925 self._SubsectionType = MODEL_UNKNOWN\r
926 self._SubsectionName = ''\r
927 self._Owner[-1] = -1\r
928 OwnerId = {}\r
929 continue\r
930 # subsection header\r
931 elif Line[0] == TAB_OPTION_START and Line[-1] == TAB_OPTION_END:\r
932 self._SubsectionType = MODEL_META_DATA_SUBSECTION_HEADER\r
933 # directive line\r
934 elif Line[0] == '!':\r
935 self._DirectiveParser()\r
936 continue\r
d429fcd0
YZ		 937 if Line[0] == TAB_OPTION_START and not self._InSubsection:\r
938 EdkLogger.error("Parser", FILE_READ_FAILURE, "Missing the '{' before %s in Line %s" % (Line, Index+1),ExtraData=self.MetaFile)\r
f51461c8
LG		 939\r
940 if self._InSubsection:\r
941 SectionType = self._SubsectionType\r
942 else:\r
943 SectionType = self._SectionType\r
944 self._ItemType = SectionType\r
945\r
946 self._ValueList = ['', '', '']\r
947 self._SectionParser[SectionType](self)\r
948 if self._ValueList == None:\r
949 continue\r
950 #\r
951 # Model, Value1, Value2, Value3, Arch, ModuleType, BelongsToItem=-1, BelongsToFile=-1,\r
952 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1\r
953 #\r
954 for Arch, ModuleType in self._Scope:\r
955 Owner = self._Owner[-1]\r
956 if self._SubsectionType != MODEL_UNKNOWN:\r
957 Owner = OwnerId[Arch]\r
958 self._LastItem = self._Store(\r
959 self._ItemType,\r
960 self._ValueList[0],\r
961 self._ValueList[1],\r
962 self._ValueList[2],\r
963 Arch,\r
964 ModuleType,\r
965 Owner,\r
966 self._From,\r
967 self._LineIndex + 1,\r
968 - 1,\r
969 self._LineIndex + 1,\r
970 - 1,\r
971 self._Enabled\r
972 )\r
973 if self._SubsectionType == MODEL_UNKNOWN and self._InSubsection:\r
974 OwnerId[Arch] = self._LastItem\r
975\r
976 if self._DirectiveStack:\r
977 Type, Line, Text = self._DirectiveStack[-1]\r
978 EdkLogger.error('Parser', FORMAT_INVALID, "No matching '!endif' found",\r
979 ExtraData=Text, File=self.MetaFile, Line=Line)\r
980 self._Done()\r
981\r
982 ## <subsection_header> parser\r
983 def _SubsectionHeaderParser(self):\r
984 self._SubsectionName = self._CurrentLine[1:-1].upper()\r
985 if self._SubsectionName in self.DataType:\r
986 self._SubsectionType = self.DataType[self._SubsectionName]\r
987 else:\r
988 self._SubsectionType = MODEL_UNKNOWN\r
989 EdkLogger.warn("Parser", "Unrecognized sub-section", File=self.MetaFile,\r
990 Line=self._LineIndex + 1, ExtraData=self._CurrentLine)\r
991 self._ValueList[0] = self._SubsectionName\r
992\r
993 ## Directive statement parser\r
994 def _DirectiveParser(self):\r
995 self._ValueList = ['', '', '']\r
996 TokenList = GetSplitValueList(self._CurrentLine, ' ', 1)\r
997 self._ValueList[0:len(TokenList)] = TokenList\r
998\r
999 # Syntax check\r
1000 DirectiveName = self._ValueList[0].upper()\r
1001 if DirectiveName not in self.DataType:\r
1002 EdkLogger.error("Parser", FORMAT_INVALID, "Unknown directive [%s]" % DirectiveName,\r
1003 File=self.MetaFile, Line=self._LineIndex + 1)\r
1004\r
1005 if DirectiveName in ['!IF', '!IFDEF', '!IFNDEF']:\r
1006 self._InDirective += 1\r
1007\r
1008 if DirectiveName in ['!ENDIF']:\r
1009 self._InDirective -= 1\r
1010\r
1011 if DirectiveName in ['!IF', '!IFDEF', '!INCLUDE', '!IFNDEF', '!ELSEIF'] and self._ValueList[1] == '':\r
1012 EdkLogger.error("Parser", FORMAT_INVALID, "Missing expression",\r
1013 File=self.MetaFile, Line=self._LineIndex + 1,\r
1014 ExtraData=self._CurrentLine)\r
1015\r
1016 ItemType = self.DataType[DirectiveName]\r
1017 Scope = [['COMMON', 'COMMON']]\r
1018 if ItemType == MODEL_META_DATA_INCLUDE:\r
1019 Scope = self._Scope\r
1020 if ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF:\r
1021 # Remove all directives between !if and !endif, including themselves\r
1022 while self._DirectiveStack:\r
1023 # Remove any !else or !elseif\r
1024 DirectiveInfo = self._DirectiveStack.pop()\r
1025 if DirectiveInfo[0] in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
1026 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,\r
1027 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF]:\r
1028 break\r
1029 else:\r
1030 EdkLogger.error("Parser", FORMAT_INVALID, "Redundant '!endif'",\r
1031 File=self.MetaFile, Line=self._LineIndex + 1,\r
1032 ExtraData=self._CurrentLine)\r
1033 elif ItemType != MODEL_META_DATA_INCLUDE:\r
1034 # Break if there's a !else is followed by a !elseif\r
1035 if ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF and \\r
1036 self._DirectiveStack and \\r
1037 self._DirectiveStack[-1][0] == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE:\r
1038 EdkLogger.error("Parser", FORMAT_INVALID, "'!elseif' after '!else'",\r
1039 File=self.MetaFile, Line=self._LineIndex + 1,\r
1040 ExtraData=self._CurrentLine)\r
1041 self._DirectiveStack.append((ItemType, self._LineIndex + 1, self._CurrentLine))\r
f51461c8
LG		 1042\r
1043 #\r
1044 # Model, Value1, Value2, Value3, Arch, ModuleType, BelongsToItem=-1, BelongsToFile=-1,\r
1045 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1\r
1046 #\r
1047 for Arch, ModuleType in Scope:\r
1048 self._LastItem = self._Store(\r
1049 ItemType,\r
1050 self._ValueList[0],\r
1051 self._ValueList[1],\r
1052 self._ValueList[2],\r
1053 Arch,\r
1054 ModuleType,\r
1055 self._Owner[-1],\r
1056 self._From,\r
1057 self._LineIndex + 1,\r
1058 - 1,\r
1059 self._LineIndex + 1,\r
1060 - 1,\r
1061 0\r
1062 )\r
1063\r
1064 ## [defines] section parser\r
1065 @ParseMacro\r
1066 def _DefineParser(self):\r
1067 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
1068 self._ValueList[1:len(TokenList)] = TokenList\r
1069\r
1070 # Syntax check\r
1071 if not self._ValueList[1]:\r
1072 EdkLogger.error('Parser', FORMAT_INVALID, "No name specified",\r
1073 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
1074 if not self._ValueList[2]:\r
1075 EdkLogger.error('Parser', FORMAT_INVALID, "No value specified",\r
1076 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
97fa0ee9
YL		 1077 if (not self._ValueList[1] in self.DefineKeywords and\r
1078 (self._InSubsection and self._ValueList[1] not in self.SubSectionDefineKeywords)):\r
f51461c8
LG		 1079 EdkLogger.error('Parser', FORMAT_INVALID,\r
1080 "Unknown keyword found: %s. "\r
1081 "If this is a macro you must "\r
1082 "add it as a DEFINE in the DSC" % self._ValueList[1],\r
1083 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
97fa0ee9
YL		 1084 if not self._InSubsection:\r
1085 self._Defines[self._ValueList[1]] = self._ValueList[2]\r
f51461c8
LG		 1086 self._ItemType = self.DataType[TAB_DSC_DEFINES.upper()]\r
1087\r
1088 @ParseMacro\r
1089 def _SkuIdParser(self):\r
1090 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
1091 if len(TokenList) != 2:\r
1092 EdkLogger.error('Parser', FORMAT_INVALID, "Correct format is '<Integer>|<UiName>'",\r
1093 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
1094 self._ValueList[0:len(TokenList)] = TokenList\r
1095\r
1096 ## Parse Edk style of library modules\r
1097 @ParseMacro\r
1098 def _LibraryInstanceParser(self):\r
1099 self._ValueList[0] = self._CurrentLine\r
1100\r
1101 ## PCD sections parser\r
1102 #\r
1103 # [PcdsFixedAtBuild]\r
1104 # [PcdsPatchableInModule]\r
1105 # [PcdsFeatureFlag]\r
1106 # [PcdsDynamicEx\r
1107 # [PcdsDynamicExDefault]\r
1108 # [PcdsDynamicExVpd]\r
1109 # [PcdsDynamicExHii]\r
1110 # [PcdsDynamic]\r
1111 # [PcdsDynamicDefault]\r
1112 # [PcdsDynamicVpd]\r
1113 # [PcdsDynamicHii]\r
1114 #\r
1115 @ParseMacro\r
1116 def _PcdParser(self):\r
1117 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 1)\r
1118 self._ValueList[0:1] = GetSplitValueList(TokenList[0], TAB_SPLIT)\r
1119 if len(TokenList) == 2:\r
1120 self._ValueList[2] = TokenList[1]\r
1121 if self._ValueList[0] == '' or self._ValueList[1] == '':\r
1122 EdkLogger.error('Parser', FORMAT_INVALID, "No token space GUID or PCD name specified",\r
1123 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<TokenCName>|<PcdValue>)",\r
1124 File=self.MetaFile, Line=self._LineIndex + 1)\r
1125 if self._ValueList[2] == '':\r
1126 #\r
1127 # The PCD values are optional for FIXEDATBUILD and PATCHABLEINMODULE\r
1128 #\r
1129 if self._SectionType in (MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_PATCHABLE_IN_MODULE):\r
1130 return\r
1131 EdkLogger.error('Parser', FORMAT_INVALID, "No PCD value given",\r
1132 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<TokenCName>|<PcdValue>)",\r
1133 File=self.MetaFile, Line=self._LineIndex + 1)\r
1134\r
1135 # Validate the datum type of Dynamic Defaul PCD and DynamicEx Default PCD\r
1136 ValueList = GetSplitValueList(self._ValueList[2])\r
1137 if len(ValueList) > 1 and ValueList[1] != TAB_VOID \\r
1138 and self._ItemType in [MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_EX_DEFAULT]:\r
1139 EdkLogger.error('Parser', FORMAT_INVALID, "The datum type '%s' of PCD is wrong" % ValueList[1],\r
1140 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
1141\r
1142 # if value are 'True', 'true', 'TRUE' or 'False', 'false', 'FALSE', replace with integer 1 or 0.\r
1143 DscPcdValueList = GetSplitValueList(TokenList[1], TAB_VALUE_SPLIT, 1)\r
1144 if DscPcdValueList[0] in ['True', 'true', 'TRUE']:\r
1145 self._ValueList[2] = TokenList[1].replace(DscPcdValueList[0], '1', 1);\r
1146 elif DscPcdValueList[0] in ['False', 'false', 'FALSE']:\r
1147 self._ValueList[2] = TokenList[1].replace(DscPcdValueList[0], '0', 1);\r
1148\r
1149\r
1150 ## [components] section parser\r
1151 @ParseMacro\r
1152 def _ComponentParser(self):\r
1153 if self._CurrentLine[-1] == '{':\r
1154 self._ValueList[0] = self._CurrentLine[0:-1].strip()\r
1155 self._InSubsection = True\r
1156 else:\r
1157 self._ValueList[0] = self._CurrentLine\r
1158\r
1159 ## [LibraryClasses] section\r
1160 @ParseMacro\r
1161 def _LibraryClassParser(self):\r
1162 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
1163 if len(TokenList) < 2:\r
1164 EdkLogger.error('Parser', FORMAT_INVALID, "No library class or instance specified",\r
1165 ExtraData=self._CurrentLine + " (<LibraryClassName>|<LibraryInstancePath>)",\r
1166 File=self.MetaFile, Line=self._LineIndex + 1)\r
1167 if TokenList[0] == '':\r
1168 EdkLogger.error('Parser', FORMAT_INVALID, "No library class specified",\r
1169 ExtraData=self._CurrentLine + " (<LibraryClassName>|<LibraryInstancePath>)",\r
1170 File=self.MetaFile, Line=self._LineIndex + 1)\r
1171 if TokenList[1] == '':\r
1172 EdkLogger.error('Parser', FORMAT_INVALID, "No library instance specified",\r
1173 ExtraData=self._CurrentLine + " (<LibraryClassName>|<LibraryInstancePath>)",\r
1174 File=self.MetaFile, Line=self._LineIndex + 1)\r
1175\r
1176 self._ValueList[0:len(TokenList)] = TokenList\r
1177\r
1178 def _CompponentSourceOverridePathParser(self):\r
1179 self._ValueList[0] = self._CurrentLine\r
1180\r
1181 ## [BuildOptions] section parser\r
1182 @ParseMacro\r
1183 def _BuildOptionParser(self):\r
1184 self._CurrentLine = CleanString(self._CurrentLine, BuildOption=True)\r
1185 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
1186 TokenList2 = GetSplitValueList(TokenList[0], ':', 1)\r
1187 if len(TokenList2) == 2:\r
1188 self._ValueList[0] = TokenList2[0] # toolchain family\r
1189 self._ValueList[1] = TokenList2[1] # keys\r
1190 else:\r
1191 self._ValueList[1] = TokenList[0]\r
1192 if len(TokenList) == 2: # value\r
1193 self._ValueList[2] = TokenList[1]\r
1194\r
1195 if self._ValueList[1].count('_') != 4:\r
1196 EdkLogger.error(\r
1197 'Parser',\r
1198 FORMAT_INVALID,\r
1199 "'%s' must be in format of <TARGET>_<TOOLCHAIN>_<ARCH>_<TOOL>_FLAGS" % self._ValueList[1],\r
1200 ExtraData=self._CurrentLine,\r
1201 File=self.MetaFile,\r
1202 Line=self._LineIndex + 1\r
1203 )\r
1204\r
1205 ## Override parent's method since we'll do all macro replacements in parser\r
1206 def _GetMacros(self):\r
1207 Macros = {}\r
1208 Macros.update(self._FileLocalMacros)\r
1209 Macros.update(self._GetApplicableSectionMacro())\r
1210 Macros.update(GlobalData.gEdkGlobal)\r
1211 Macros.update(GlobalData.gPlatformDefines)\r
1212 Macros.update(GlobalData.gCommandLineDefines)\r
1213 # PCD cannot be referenced in macro definition\r
1214 if self._ItemType not in [MODEL_META_DATA_DEFINE, MODEL_META_DATA_GLOBAL_DEFINE]:\r
1215 Macros.update(self._Symbols)\r
1216 return Macros\r
1217\r
1218 def _PostProcess(self):\r
1219 Processer = {\r
1220 MODEL_META_DATA_SECTION_HEADER : self.__ProcessSectionHeader,\r
1221 MODEL_META_DATA_SUBSECTION_HEADER : self.__ProcessSubsectionHeader,\r
1222 MODEL_META_DATA_HEADER : self.__ProcessDefine,\r
1223 MODEL_META_DATA_DEFINE : self.__ProcessDefine,\r
1224 MODEL_META_DATA_GLOBAL_DEFINE : self.__ProcessDefine,\r
1225 MODEL_META_DATA_INCLUDE : self.__ProcessDirective,\r
1226 MODEL_META_DATA_CONDITIONAL_STATEMENT_IF : self.__ProcessDirective,\r
1227 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE : self.__ProcessDirective,\r
1228 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF : self.__ProcessDirective,\r
1229 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF : self.__ProcessDirective,\r
1230 MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF : self.__ProcessDirective,\r
1231 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF : self.__ProcessDirective,\r
1232 MODEL_EFI_SKU_ID : self.__ProcessSkuId,\r
1233 MODEL_EFI_LIBRARY_INSTANCE : self.__ProcessLibraryInstance,\r
1234 MODEL_EFI_LIBRARY_CLASS : self.__ProcessLibraryClass,\r
1235 MODEL_PCD_FIXED_AT_BUILD : self.__ProcessPcd,\r
1236 MODEL_PCD_PATCHABLE_IN_MODULE : self.__ProcessPcd,\r
1237 MODEL_PCD_FEATURE_FLAG : self.__ProcessPcd,\r
1238 MODEL_PCD_DYNAMIC_DEFAULT : self.__ProcessPcd,\r
1239 MODEL_PCD_DYNAMIC_HII : self.__ProcessPcd,\r
1240 MODEL_PCD_DYNAMIC_VPD : self.__ProcessPcd,\r
1241 MODEL_PCD_DYNAMIC_EX_DEFAULT : self.__ProcessPcd,\r
1242 MODEL_PCD_DYNAMIC_EX_HII : self.__ProcessPcd,\r
1243 MODEL_PCD_DYNAMIC_EX_VPD : self.__ProcessPcd,\r
1244 MODEL_META_DATA_COMPONENT : self.__ProcessComponent,\r
1245 MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH : self.__ProcessSourceOverridePath,\r
1246 MODEL_META_DATA_BUILD_OPTION : self.__ProcessBuildOption,\r
1247 MODEL_UNKNOWN : self._Skip,\r
0923aa1c 1248 MODEL_META_DATA_USER_EXTENSION : self._SkipUserExtension,\r
f51461c8
LG		 1249 }\r
1250\r
1251 self._Table = MetaFileStorage(self._RawTable.Cur, self.MetaFile, MODEL_FILE_DSC, True)\r
1252 self._Table.Create()\r
1253 self._DirectiveStack = []\r
1254 self._DirectiveEvalStack = []\r
1255 self._FileWithError = self.MetaFile\r
1256 self._FileLocalMacros = {}\r
1257 self._SectionsMacroDict = {}\r
1258 GlobalData.gPlatformDefines = {}\r
1259\r
1260 # Get all macro and PCD which has straitforward value\r
1261 self.__RetrievePcdValue()\r
1262 self._Content = self._RawTable.GetAll()\r
1263 self._ContentIndex = 0\r
97fa0ee9 1264 self._InSubsection = False\r
f51461c8
LG		 1265 while self._ContentIndex < len(self._Content) :\r
1266 Id, self._ItemType, V1, V2, V3, S1, S2, Owner, self._From, \\r
1267 LineStart, ColStart, LineEnd, ColEnd, Enabled = self._Content[self._ContentIndex]\r
1268\r
1269 if self._From < 0:\r
1270 self._FileWithError = self.MetaFile\r
1271\r
1272 self._ContentIndex += 1\r
1273\r
1274 self._Scope = [[S1, S2]]\r
1275 #\r
1276 # For !include directive, handle it specially,\r
1277 # merge arch and module type in case of duplicate items\r
1278 #\r
1279 while self._ItemType == MODEL_META_DATA_INCLUDE:\r
1280 if self._ContentIndex >= len(self._Content):\r
1281 break\r
1282 Record = self._Content[self._ContentIndex]\r
1283 if LineStart == Record[9] and LineEnd == Record[11]:\r
1284 if [Record[5], Record[6]] not in self._Scope:\r
1285 self._Scope.append([Record[5], Record[6]])\r
1286 self._ContentIndex += 1\r
1287 else:\r
1288 break\r
1289\r
1290 self._LineIndex = LineStart - 1\r
1291 self._ValueList = [V1, V2, V3]\r
1292\r
97fa0ee9
YL		 1293 if Owner > 0 and Owner in self._IdMapping:\r
1294 self._InSubsection = True\r
1295 else:\r
1296 self._InSubsection = False\r
f51461c8
LG		 1297 try:\r
1298 Processer[self._ItemType]()\r
1299 except EvaluationException, Excpt:\r
1300 # \r
1301 # Only catch expression evaluation error here. We need to report\r
1302 # the precise number of line on which the error occurred\r
1303 #\r
1304 if hasattr(Excpt, 'Pcd'):\r
1305 if Excpt.Pcd in GlobalData.gPlatformOtherPcds:\r
1306 Info = GlobalData.gPlatformOtherPcds[Excpt.Pcd]\r
1307 EdkLogger.error('Parser', FORMAT_INVALID, "Cannot use this PCD (%s) in an expression as"\r
1308 " it must be defined in a [PcdsFixedAtBuild] or [PcdsFeatureFlag] section"\r
1309 " of the DSC file, and it is currently defined in this section:"\r
1310 " %s, line #: %d." % (Excpt.Pcd, Info[0], Info[1]),\r
1311 File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
1312 Line=self._LineIndex + 1)\r
1313 else:\r
1314 EdkLogger.error('Parser', FORMAT_INVALID, "PCD (%s) is not defined in DSC file" % Excpt.Pcd,\r
1315 File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
1316 Line=self._LineIndex + 1)\r
1317 else:\r
1318 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid expression: %s" % str(Excpt),\r
1319 File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
1320 Line=self._LineIndex + 1)\r
1321 except MacroException, Excpt:\r
1322 EdkLogger.error('Parser', FORMAT_INVALID, str(Excpt),\r
1323 File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
1324 Line=self._LineIndex + 1)\r
1325\r
1326 if self._ValueList == None:\r
1327 continue\r
1328\r
1329 NewOwner = self._IdMapping.get(Owner, -1)\r
1330 self._Enabled = int((not self._DirectiveEvalStack) or (False not in self._DirectiveEvalStack))\r
1331 self._LastItem = self._Store(\r
1332 self._ItemType,\r
1333 self._ValueList[0],\r
1334 self._ValueList[1],\r
1335 self._ValueList[2],\r
1336 S1,\r
1337 S2,\r
1338 NewOwner,\r
1339 self._From,\r
1340 self._LineIndex + 1,\r
1341 - 1,\r
1342 self._LineIndex + 1,\r
1343 - 1,\r
1344 self._Enabled\r
1345 )\r
1346 self._IdMapping[Id] = self._LastItem\r
1347\r
1348 GlobalData.gPlatformDefines.update(self._FileLocalMacros)\r
1349 self._PostProcessed = True\r
1350 self._Content = None\r
1351\r
1352 def __ProcessSectionHeader(self):\r
1353 self._SectionName = self._ValueList[0]\r
1354 if self._SectionName in self.DataType:\r
1355 self._SectionType = self.DataType[self._SectionName]\r
1356 else:\r
1357 self._SectionType = MODEL_UNKNOWN\r
1358\r
1359 def __ProcessSubsectionHeader(self):\r
1360 self._SubsectionName = self._ValueList[0]\r
1361 if self._SubsectionName in self.DataType:\r
1362 self._SubsectionType = self.DataType[self._SubsectionName]\r
1363 else:\r
1364 self._SubsectionType = MODEL_UNKNOWN\r
1365\r
1366 def __RetrievePcdValue(self):\r
f51461c8
LG		 1367 Content = open(str(self.MetaFile), 'r').readlines()\r
1368 GlobalData.gPlatformOtherPcds['DSCFILE'] = str(self.MetaFile)\r
1369 for PcdType in (MODEL_PCD_PATCHABLE_IN_MODULE, MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_HII,\r
1370 MODEL_PCD_DYNAMIC_VPD, MODEL_PCD_DYNAMIC_EX_DEFAULT, MODEL_PCD_DYNAMIC_EX_HII,\r
1371 MODEL_PCD_DYNAMIC_EX_VPD):\r
1372 Records = self._RawTable.Query(PcdType, BelongsToItem= -1.0)\r
1373 for TokenSpaceGuid, PcdName, Value, Dummy2, Dummy3, ID, Line in Records:\r
1374 Name = TokenSpaceGuid + '.' + PcdName\r
1375 if Name not in GlobalData.gPlatformOtherPcds:\r
1376 PcdLine = Line\r
1377 while not Content[Line - 1].lstrip().startswith(TAB_SECTION_START):\r
1378 Line -= 1\r
1379 GlobalData.gPlatformOtherPcds[Name] = (CleanString(Content[Line - 1]), PcdLine, PcdType)\r
1380\r
1381 def __ProcessDefine(self):\r
1382 if not self._Enabled:\r
1383 return\r
1384\r
1385 Type, Name, Value = self._ValueList\r
1386 Value = ReplaceMacro(Value, self._Macros, False)\r
97fa0ee9
YL		 1387 #\r
1388 # If it is <Defines>, return\r
1389 #\r
1390 if self._InSubsection:\r
1391 self._ValueList = [Type, Name, Value]\r
1392 return\r
1393\r
f51461c8
LG		 1394 if self._ItemType == MODEL_META_DATA_DEFINE:\r
1395 if self._SectionType == MODEL_META_DATA_HEADER:\r
1396 self._FileLocalMacros[Name] = Value\r
1397 else:\r
1398 self._ConstructSectionMacroDict(Name, Value)\r
1399 elif self._ItemType == MODEL_META_DATA_GLOBAL_DEFINE:\r
1400 GlobalData.gEdkGlobal[Name] = Value\r
1401\r
1402 #\r
1403 # Keyword in [Defines] section can be used as Macros\r
1404 #\r
1405 if (self._ItemType == MODEL_META_DATA_HEADER) and (self._SectionType == MODEL_META_DATA_HEADER):\r
1406 self._FileLocalMacros[Name] = Value\r
1407\r
1408 self._ValueList = [Type, Name, Value]\r
1409\r
1410 def __ProcessDirective(self):\r
1411 Result = None\r
1412 if self._ItemType in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
1413 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF]:\r
1414 Macros = self._Macros\r
1415 Macros.update(GlobalData.gGlobalDefines)\r
1416 try:\r
1417 Result = ValueExpression(self._ValueList[1], Macros)()\r
1418 except SymbolNotFound, Exc:\r
1419 EdkLogger.debug(EdkLogger.DEBUG_5, str(Exc), self._ValueList[1])\r
1420 Result = False\r
1421 except WrnExpression, Excpt:\r
1422 # \r
1423 # Catch expression evaluation warning here. We need to report\r
1424 # the precise number of line and return the evaluation result\r
1425 #\r
1426 EdkLogger.warn('Parser', "Suspicious expression: %s" % str(Excpt),\r
1427 File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
1428 Line=self._LineIndex + 1)\r
1429 Result = Excpt.result\r
1430\r
1431 if self._ItemType in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
1432 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,\r
1433 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF]:\r
1434 self._DirectiveStack.append(self._ItemType)\r
1435 if self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_IF:\r
1436 Result = bool(Result)\r
1437 else:\r
1438 Macro = self._ValueList[1]\r
1439 Macro = Macro[2:-1] if (Macro.startswith("$(") and Macro.endswith(")")) else Macro\r
1440 Result = Macro in self._Macros\r
1441 if self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF:\r
1442 Result = not Result\r
1443 self._DirectiveEvalStack.append(Result)\r
1444 elif self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF:\r
1445 self._DirectiveStack.append(self._ItemType)\r
1446 self._DirectiveEvalStack[-1] = not self._DirectiveEvalStack[-1]\r
1447 self._DirectiveEvalStack.append(bool(Result))\r
1448 elif self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE:\r
1449 self._DirectiveStack.append(self._ItemType)\r
1450 self._DirectiveEvalStack[-1] = not self._DirectiveEvalStack[-1]\r
1451 self._DirectiveEvalStack.append(True)\r
1452 elif self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF:\r
1453 # Back to the nearest !if/!ifdef/!ifndef\r
1454 while self._DirectiveStack:\r
1455 self._DirectiveEvalStack.pop()\r
1456 Directive = self._DirectiveStack.pop()\r
1457 if Directive in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
1458 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,\r
1459 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF]:\r
1460 break\r
1461 elif self._ItemType == MODEL_META_DATA_INCLUDE:\r
1462 # The included file must be relative to workspace or same directory as DSC file\r
1463 __IncludeMacros = {}\r
1464 #\r
1465 # Allow using system environment variables in path after !include\r
1466 #\r
1467 __IncludeMacros['WORKSPACE'] = GlobalData.gGlobalDefines['WORKSPACE']\r
1468 if "ECP_SOURCE" in GlobalData.gGlobalDefines.keys():\r
1469 __IncludeMacros['ECP_SOURCE'] = GlobalData.gGlobalDefines['ECP_SOURCE']\r
1470 #\r
1471 # During GenFds phase call DSC parser, will go into this branch.\r
1472 #\r
1473 elif "ECP_SOURCE" in GlobalData.gCommandLineDefines.keys():\r
1474 __IncludeMacros['ECP_SOURCE'] = GlobalData.gCommandLineDefines['ECP_SOURCE']\r
1475\r
1476 __IncludeMacros['EFI_SOURCE'] = GlobalData.gGlobalDefines['EFI_SOURCE']\r
1477 __IncludeMacros['EDK_SOURCE'] = GlobalData.gGlobalDefines['EDK_SOURCE']\r
1478 #\r
1479 # Allow using MACROs comes from [Defines] section to keep compatible. \r
1480 #\r
1481 __IncludeMacros.update(self._Macros)\r
1482\r
1483 IncludedFile = NormPath(ReplaceMacro(self._ValueList[1], __IncludeMacros, RaiseError=True))\r
1484 #\r
1485 # First search the include file under the same directory as DSC file\r
1486 #\r
1487 IncludedFile1 = PathClass(IncludedFile, self.MetaFile.Dir)\r
1488 ErrorCode, ErrorInfo1 = IncludedFile1.Validate()\r
1489 if ErrorCode != 0:\r
1490 #\r
1491 # Also search file under the WORKSPACE directory\r
1492 #\r
1493 IncludedFile1 = PathClass(IncludedFile, GlobalData.gWorkspace)\r
1494 ErrorCode, ErrorInfo2 = IncludedFile1.Validate()\r
1495 if ErrorCode != 0:\r
1496 EdkLogger.error('parser', ErrorCode, File=self._FileWithError,\r
1497 Line=self._LineIndex + 1, ExtraData=ErrorInfo1 + "\n" + ErrorInfo2)\r
1498\r
1499 self._FileWithError = IncludedFile1\r
1500\r
1501 IncludedFileTable = MetaFileStorage(self._Table.Cur, IncludedFile1, MODEL_FILE_DSC, False)\r
1502 Owner = self._Content[self._ContentIndex - 1][0]\r
cdd1b5e5 1503 Parser = DscParser(IncludedFile1, self._FileType, self._Arch, IncludedFileTable,\r
f51461c8
LG		 1504 Owner=Owner, From=Owner)\r
1505\r
c17956e0
DL		 1506 self.IncludedFiles.add (IncludedFile1)\r
1507\r
118bf096
CS		 1508 # Does not allow lower level included file to include upper level included file\r
1509 if Parser._From != Owner and int(Owner) > int (Parser._From):\r
1510 EdkLogger.error('parser', FILE_ALREADY_EXIST, File=self._FileWithError,\r
1511 Line=self._LineIndex + 1, ExtraData="{0} is already included at a higher level.".format(IncludedFile1))\r
1512\r
1513\r
f51461c8
LG		 1514 # set the parser status with current status\r
1515 Parser._SectionName = self._SectionName\r
1516 Parser._SectionType = self._SectionType\r
1517 Parser._Scope = self._Scope\r
1518 Parser._Enabled = self._Enabled\r
1519 # Parse the included file\r
1520 Parser.Start()\r
1521\r
1522 # update current status with sub-parser's status\r
1523 self._SectionName = Parser._SectionName\r
1524 self._SectionType = Parser._SectionType\r
1525 self._Scope = Parser._Scope\r
1526 self._Enabled = Parser._Enabled\r
1527\r
1528 # Insert all records in the table for the included file into dsc file table\r
1529 Records = IncludedFileTable.GetAll()\r
1530 if Records:\r
1531 self._Content[self._ContentIndex:self._ContentIndex] = Records\r
1532 self._Content.pop(self._ContentIndex - 1)\r
1533 self._ValueList = None\r
1534 self._ContentIndex -= 1\r
1535\r
1536 def __ProcessSkuId(self):\r
1537 self._ValueList = [ReplaceMacro(Value, self._Macros, RaiseError=True)\r
1538 for Value in self._ValueList]\r
1539\r
1540 def __ProcessLibraryInstance(self):\r
1541 self._ValueList = [ReplaceMacro(Value, self._Macros) for Value in self._ValueList]\r
1542\r
1543 def __ProcessLibraryClass(self):\r
1544 self._ValueList[1] = ReplaceMacro(self._ValueList[1], self._Macros, RaiseError=True)\r
1545\r
1546 def __ProcessPcd(self):\r
1547 if self._ItemType not in [MODEL_PCD_FEATURE_FLAG, MODEL_PCD_FIXED_AT_BUILD]:\r
1548 self._ValueList[2] = ReplaceMacro(self._ValueList[2], self._Macros, RaiseError=True)\r
1549 return\r
1550\r
1551 ValList, Valid, Index = AnalyzeDscPcd(self._ValueList[2], self._ItemType)\r
1552 if not Valid:\r
47fea6af 1553 EdkLogger.error('build', FORMAT_INVALID, "Pcd format incorrect.", File=self._FileWithError, Line=self._LineIndex + 1,\r
f51461c8
LG		 1554 ExtraData="%s.%s|%s" % (self._ValueList[0], self._ValueList[1], self._ValueList[2]))\r
1555 PcdValue = ValList[Index]\r
1556 if PcdValue:\r
1557 try:\r
1558 ValList[Index] = ValueExpression(PcdValue, self._Macros)(True)\r
1559 except WrnExpression, Value:\r
1560 ValList[Index] = Value.result\r
1561\r
1562 if ValList[Index] == 'True':\r
1563 ValList[Index] = '1'\r
1564 if ValList[Index] == 'False':\r
1565 ValList[Index] = '0'\r
1566\r
22a99b87
YL		 1567 if (not self._DirectiveEvalStack) or (False not in self._DirectiveEvalStack):\r
1568 GlobalData.gPlatformPcds[TAB_SPLIT.join(self._ValueList[0:2])] = PcdValue\r
1569 self._Symbols[TAB_SPLIT.join(self._ValueList[0:2])] = PcdValue\r
f51461c8
LG		 1570 self._ValueList[2] = '|'.join(ValList)\r
1571\r
1572 def __ProcessComponent(self):\r
1573 self._ValueList[0] = ReplaceMacro(self._ValueList[0], self._Macros)\r
1574\r
1575 def __ProcessSourceOverridePath(self):\r
1576 self._ValueList[0] = ReplaceMacro(self._ValueList[0], self._Macros)\r
1577\r
1578 def __ProcessBuildOption(self):\r
1579 self._ValueList = [ReplaceMacro(Value, self._Macros, RaiseError=False)\r
1580 for Value in self._ValueList]\r
1581\r
1582 _SectionParser = {\r
1583 MODEL_META_DATA_HEADER : _DefineParser,\r
1584 MODEL_EFI_SKU_ID : _SkuIdParser,\r
1585 MODEL_EFI_LIBRARY_INSTANCE : _LibraryInstanceParser,\r
1586 MODEL_EFI_LIBRARY_CLASS : _LibraryClassParser,\r
1587 MODEL_PCD_FIXED_AT_BUILD : _PcdParser,\r
1588 MODEL_PCD_PATCHABLE_IN_MODULE : _PcdParser,\r
1589 MODEL_PCD_FEATURE_FLAG : _PcdParser,\r
1590 MODEL_PCD_DYNAMIC_DEFAULT : _PcdParser,\r
1591 MODEL_PCD_DYNAMIC_HII : _PcdParser,\r
1592 MODEL_PCD_DYNAMIC_VPD : _PcdParser,\r
1593 MODEL_PCD_DYNAMIC_EX_DEFAULT : _PcdParser,\r
1594 MODEL_PCD_DYNAMIC_EX_HII : _PcdParser,\r
1595 MODEL_PCD_DYNAMIC_EX_VPD : _PcdParser,\r
1596 MODEL_META_DATA_COMPONENT : _ComponentParser,\r
1597 MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH : _CompponentSourceOverridePathParser,\r
1598 MODEL_META_DATA_BUILD_OPTION : _BuildOptionParser,\r
1599 MODEL_UNKNOWN : MetaFileParser._Skip,\r
0923aa1c 1600 MODEL_META_DATA_USER_EXTENSION : MetaFileParser._SkipUserExtension,\r
f51461c8
LG		 1601 MODEL_META_DATA_SECTION_HEADER : MetaFileParser._SectionHeaderParser,\r
1602 MODEL_META_DATA_SUBSECTION_HEADER : _SubsectionHeaderParser,\r
1603 }\r
1604\r
1605 _Macros = property(_GetMacros)\r
1606\r
1607## DEC file parser class\r
1608#\r
1609# @param FilePath The path of platform description file\r
1610# @param FileType The raw data of DSC file\r
1611# @param Table Database used to retrieve module/package information\r
1612# @param Macros Macros used for replacement in file\r
1613#\r
1614class DecParser(MetaFileParser):\r
1615 # DEC file supported data types (one type per section)\r
1616 DataType = {\r
1617 TAB_DEC_DEFINES.upper() : MODEL_META_DATA_HEADER,\r
1618 TAB_DSC_DEFINES_DEFINE : MODEL_META_DATA_DEFINE,\r
1619 TAB_INCLUDES.upper() : MODEL_EFI_INCLUDE,\r
1620 TAB_LIBRARY_CLASSES.upper() : MODEL_EFI_LIBRARY_CLASS,\r
1621 TAB_GUIDS.upper() : MODEL_EFI_GUID,\r
1622 TAB_PPIS.upper() : MODEL_EFI_PPI,\r
1623 TAB_PROTOCOLS.upper() : MODEL_EFI_PROTOCOL,\r
1624 TAB_PCDS_FIXED_AT_BUILD_NULL.upper() : MODEL_PCD_FIXED_AT_BUILD,\r
1625 TAB_PCDS_PATCHABLE_IN_MODULE_NULL.upper() : MODEL_PCD_PATCHABLE_IN_MODULE,\r
1626 TAB_PCDS_FEATURE_FLAG_NULL.upper() : MODEL_PCD_FEATURE_FLAG,\r
1627 TAB_PCDS_DYNAMIC_NULL.upper() : MODEL_PCD_DYNAMIC,\r
1628 TAB_PCDS_DYNAMIC_EX_NULL.upper() : MODEL_PCD_DYNAMIC_EX,\r
0923aa1c 1629 TAB_USER_EXTENSIONS.upper() : MODEL_META_DATA_USER_EXTENSION,\r
f51461c8
LG		 1630 }\r
1631\r
1632 ## Constructor of DecParser\r
1633 #\r
1634 # Initialize object of DecParser\r
1635 #\r
1636 # @param FilePath The path of platform description file\r
1637 # @param FileType The raw data of DSC file\r
cdd1b5e5 1638 # @param Arch Default Arch value for filtering sections\r
f51461c8 1639 # @param Table Database used to retrieve module/package information\r
f51461c8 1640 #\r
cdd1b5e5 1641 def __init__(self, FilePath, FileType, Arch, Table):\r
f51461c8
LG		 1642 # prevent re-initialization\r
1643 if hasattr(self, "_Table"):\r
1644 return\r
cdd1b5e5 1645 MetaFileParser.__init__(self, FilePath, FileType, Arch, Table, -1)\r
f51461c8
LG		 1646 self._Comments = []\r
1647 self._Version = 0x00010005 # Only EDK2 dec file is supported\r
1648 self._AllPCDs = [] # Only for check duplicate PCD\r
67e11e4d 1649 self._AllPcdDict = {}\r
f51461c8
LG		 1650\r
1651 ## Parser starter\r
1652 def Start(self):\r
1653 Content = ''\r
1654 try:\r
1655 Content = open(str(self.MetaFile), 'r').readlines()\r
1656 except:\r
1657 EdkLogger.error("Parser", FILE_READ_FAILURE, ExtraData=self.MetaFile)\r
1658\r
778aad47 1659 self._DefinesCount = 0\r
f51461c8
LG		 1660 for Index in range(0, len(Content)):\r
1661 Line, Comment = CleanString2(Content[Index])\r
1662 self._CurrentLine = Line\r
1663 self._LineIndex = Index\r
1664\r
1665 # save comment for later use\r
1666 if Comment:\r
1667 self._Comments.append((Comment, self._LineIndex + 1))\r
1668 # skip empty line\r
1669 if Line == '':\r
1670 continue\r
1671\r
1672 # section header\r
1673 if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:\r
1674 self._SectionHeaderParser()\r
778aad47
YF		 1675 if self._SectionName == TAB_DEC_DEFINES.upper():\r
1676 self._DefinesCount += 1\r
f51461c8
LG		 1677 self._Comments = []\r
1678 continue\r
778aad47
YF		 1679 if self._SectionType == MODEL_UNKNOWN:\r
1680 EdkLogger.error("Parser", FORMAT_INVALID,\r
1681 ""\r
1682 "Not able to determine \"%s\" in which section."%self._CurrentLine,\r
1683 self.MetaFile, self._LineIndex + 1)\r
f51461c8
LG		 1684 elif len(self._SectionType) == 0:\r
1685 self._Comments = []\r
1686 continue\r
1687\r
1688 # section content\r
1689 self._ValueList = ['', '', '']\r
1690 self._SectionParser[self._SectionType[0]](self)\r
1691 if self._ValueList == None or self._ItemType == MODEL_META_DATA_DEFINE:\r
1692 self._ItemType = -1\r
1693 self._Comments = []\r
1694 continue\r
1695\r
1696 #\r
1697 # Model, Value1, Value2, Value3, Arch, BelongsToItem=-1, LineBegin=-1,\r
1698 # ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, FeatureFlag='', Enabled=-1\r
1699 #\r
1700 for Arch, ModuleType, Type in self._Scope:\r
1701 self._LastItem = self._Store(\r
1702 Type,\r
1703 self._ValueList[0],\r
1704 self._ValueList[1],\r
1705 self._ValueList[2],\r
1706 Arch,\r
1707 ModuleType,\r
1708 self._Owner[-1],\r
1709 self._LineIndex + 1,\r
1710 - 1,\r
1711 self._LineIndex + 1,\r
1712 - 1,\r
1713 0\r
1714 )\r
1715 for Comment, LineNo in self._Comments:\r
1716 self._Store(\r
1717 MODEL_META_DATA_COMMENT,\r
1718 Comment,\r
1719 self._ValueList[0],\r
1720 self._ValueList[1],\r
1721 Arch,\r
1722 ModuleType,\r
1723 self._LastItem,\r
1724 LineNo,\r
1725 - 1,\r
1726 LineNo,\r
1727 - 1,\r
1728 0\r
1729 )\r
1730 self._Comments = []\r
778aad47
YF		 1731 if self._DefinesCount > 1:\r
1732 EdkLogger.error('Parser', FORMAT_INVALID, 'Multiple [Defines] section is exist.', self.MetaFile )\r
1733 if self._DefinesCount == 0:\r
1734 EdkLogger.error('Parser', FORMAT_INVALID, 'No [Defines] section exist.',self.MetaFile)\r
f51461c8
LG		 1735 self._Done()\r
1736\r
1737\r
1738 ## Section header parser\r
1739 #\r
1740 # The section header is always in following format:\r
1741 #\r
1742 # [section_name.arch<.platform|module_type>]\r
1743 #\r
1744 def _SectionHeaderParser(self):\r
1745 self._Scope = []\r
1746 self._SectionName = ''\r
1747 self._SectionType = []\r
1748 ArchList = set()\r
c28d2e10 1749 PrivateList = set()\r
f51461c8
LG		 1750 Line = self._CurrentLine.replace("%s%s" % (TAB_COMMA_SPLIT, TAB_SPACE_SPLIT), TAB_COMMA_SPLIT)\r
1751 for Item in Line[1:-1].split(TAB_COMMA_SPLIT):\r
1752 if Item == '':\r
1753 EdkLogger.error("Parser", FORMAT_UNKNOWN_ERROR,\r
1754 "section name can NOT be empty or incorrectly use separator comma",\r
1755 self.MetaFile, self._LineIndex + 1, self._CurrentLine)\r
1756 ItemList = Item.split(TAB_SPLIT)\r
1757\r
1758 # different types of PCD are permissible in one section\r
1759 self._SectionName = ItemList[0].upper()\r
778aad47
YF		 1760 if self._SectionName == TAB_DEC_DEFINES.upper() and (len(ItemList) > 1 or len(Line.split(TAB_COMMA_SPLIT)) > 1):\r
1761 EdkLogger.error("Parser", FORMAT_INVALID, "Defines section format is invalid",\r
1762 self.MetaFile, self._LineIndex + 1, self._CurrentLine)\r
f51461c8
LG		 1763 if self._SectionName in self.DataType:\r
1764 if self.DataType[self._SectionName] not in self._SectionType:\r
1765 self._SectionType.append(self.DataType[self._SectionName])\r
1766 else:\r
1767 EdkLogger.error("Parser", FORMAT_UNKNOWN_ERROR, "%s is not a valid section name" % Item,\r
1768 self.MetaFile, self._LineIndex + 1, self._CurrentLine)\r
1769\r
1770 if MODEL_PCD_FEATURE_FLAG in self._SectionType and len(self._SectionType) > 1:\r
1771 EdkLogger.error(\r
1772 'Parser',\r
1773 FORMAT_INVALID,\r
1774 "%s must not be in the same section of other types of PCD" % TAB_PCDS_FEATURE_FLAG_NULL,\r
1775 File=self.MetaFile,\r
1776 Line=self._LineIndex + 1,\r
1777 ExtraData=self._CurrentLine\r
1778 )\r
1779 # S1 is always Arch\r
1780 if len(ItemList) > 1:\r
1781 S1 = ItemList[1].upper()\r
1782 else:\r
1783 S1 = 'COMMON'\r
1784 ArchList.add(S1)\r
1785 # S2 may be Platform or ModuleType\r
1786 if len(ItemList) > 2:\r
1787 S2 = ItemList[2].upper()\r
c28d2e10
YZ		 1788 # only Includes, GUIDs, PPIs, Protocols section have Private tag\r
1789 if self._SectionName in [TAB_INCLUDES.upper(), TAB_GUIDS.upper(), TAB_PROTOCOLS.upper(), TAB_PPIS.upper()]:\r
1790 if S2 != 'PRIVATE':\r
1791 EdkLogger.error("Parser", FORMAT_INVALID, 'Please use keyword "Private" as section tag modifier.',\r
1792 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)\r
f51461c8
LG		 1793 else:\r
1794 S2 = 'COMMON'\r
c28d2e10 1795 PrivateList.add(S2)\r
f51461c8
LG		 1796 if [S1, S2, self.DataType[self._SectionName]] not in self._Scope:\r
1797 self._Scope.append([S1, S2, self.DataType[self._SectionName]])\r
1798\r
1799 # 'COMMON' must not be used with specific ARCHs at the same section\r
1800 if 'COMMON' in ArchList and len(ArchList) > 1:\r
1801 EdkLogger.error('Parser', FORMAT_INVALID, "'common' ARCH must not be used with specific ARCHs",\r
1802 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)\r
c28d2e10
YZ		 1803\r
1804 # It is not permissible to mix section tags without the Private attribute with section tags with the Private attribute\r
1805 if 'COMMON' in PrivateList and len(PrivateList) > 1:\r
1806 EdkLogger.error('Parser', FORMAT_INVALID, "Can't mix section tags without the Private attribute with section tags with the Private attribute",\r
1807 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)\r
f51461c8
LG		 1808\r
1809 ## [guids], [ppis] and [protocols] section parser\r
1810 @ParseMacro\r
1811 def _GuidParser(self):\r
1812 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)\r
1813 if len(TokenList) < 2:\r
1814 EdkLogger.error('Parser', FORMAT_INVALID, "No GUID name or value specified",\r
1815 ExtraData=self._CurrentLine + " (<CName> = <GuidValueInCFormat>)",\r
1816 File=self.MetaFile, Line=self._LineIndex + 1)\r
1817 if TokenList[0] == '':\r
1818 EdkLogger.error('Parser', FORMAT_INVALID, "No GUID name specified",\r
1819 ExtraData=self._CurrentLine + " (<CName> = <GuidValueInCFormat>)",\r
1820 File=self.MetaFile, Line=self._LineIndex + 1)\r
1821 if TokenList[1] == '':\r
1822 EdkLogger.error('Parser', FORMAT_INVALID, "No GUID value specified",\r
1823 ExtraData=self._CurrentLine + " (<CName> = <GuidValueInCFormat>)",\r
1824 File=self.MetaFile, Line=self._LineIndex + 1)\r
1825 if TokenList[1][0] != '{' or TokenList[1][-1] != '}' or GuidStructureStringToGuidString(TokenList[1]) == '':\r
1826 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid GUID value format",\r
1827 ExtraData=self._CurrentLine + \\r
1828 " (<CName> = <GuidValueInCFormat:{8,4,4,{2,2,2,2,2,2,2,2}}>)",\r
1829 File=self.MetaFile, Line=self._LineIndex + 1)\r
1830 self._ValueList[0] = TokenList[0]\r
1831 self._ValueList[1] = TokenList[1]\r
1832\r
1833 ## PCD sections parser\r
1834 #\r
1835 # [PcdsFixedAtBuild]\r
1836 # [PcdsPatchableInModule]\r
1837 # [PcdsFeatureFlag]\r
1838 # [PcdsDynamicEx\r
1839 # [PcdsDynamic]\r
1840 #\r
1841 @ParseMacro\r
1842 def _PcdParser(self):\r
1843 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 1)\r
1844 self._ValueList[0:1] = GetSplitValueList(TokenList[0], TAB_SPLIT)\r
1845 ValueRe = re.compile(r'^[a-zA-Z_][a-zA-Z0-9_]*')\r
1846 # check PCD information\r
1847 if self._ValueList[0] == '' or self._ValueList[1] == '':\r
1848 EdkLogger.error('Parser', FORMAT_INVALID, "No token space GUID or PCD name specified",\r
1849 ExtraData=self._CurrentLine + \\r
1850 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1851 File=self.MetaFile, Line=self._LineIndex + 1)\r
1852 # check format of token space GUID CName\r
1853 if not ValueRe.match(self._ValueList[0]):\r
1854 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
1855 ExtraData=self._CurrentLine + \\r
1856 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1857 File=self.MetaFile, Line=self._LineIndex + 1)\r
1858 # check format of PCD CName\r
1859 if not ValueRe.match(self._ValueList[1]):\r
1860 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
1861 ExtraData=self._CurrentLine + \\r
1862 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1863 File=self.MetaFile, Line=self._LineIndex + 1)\r
1864 # check PCD datum information\r
1865 if len(TokenList) < 2 or TokenList[1] == '':\r
1866 EdkLogger.error('Parser', FORMAT_INVALID, "No PCD Datum information given",\r
1867 ExtraData=self._CurrentLine + \\r
1868 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1869 File=self.MetaFile, Line=self._LineIndex + 1)\r
1870\r
1871\r
1872 ValueRe = re.compile(r'^\s*L?\".*\|.*\"')\r
1873 PtrValue = ValueRe.findall(TokenList[1])\r
1874\r
1875 # Has VOID* type string, may contain "|" character in the string. \r
1876 if len(PtrValue) != 0:\r
1877 ptrValueList = re.sub(ValueRe, '', TokenList[1])\r
67e11e4d 1878 ValueList = AnalyzePcdExpression(ptrValueList)\r
f51461c8
LG		 1879 ValueList[0] = PtrValue[0]\r
1880 else:\r
67e11e4d 1881 ValueList = AnalyzePcdExpression(TokenList[1])\r
f51461c8
LG		 1882\r
1883\r
1884 # check if there's enough datum information given\r
1885 if len(ValueList) != 3:\r
1886 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid PCD Datum information given",\r
1887 ExtraData=self._CurrentLine + \\r
1888 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1889 File=self.MetaFile, Line=self._LineIndex + 1)\r
1890 # check default value\r
1891 if ValueList[0] == '':\r
1892 EdkLogger.error('Parser', FORMAT_INVALID, "Missing DefaultValue in PCD Datum information",\r
1893 ExtraData=self._CurrentLine + \\r
1894 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1895 File=self.MetaFile, Line=self._LineIndex + 1)\r
1896 # check datum type\r
1897 if ValueList[1] == '':\r
1898 EdkLogger.error('Parser', FORMAT_INVALID, "Missing DatumType in PCD Datum information",\r
1899 ExtraData=self._CurrentLine + \\r
1900 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1901 File=self.MetaFile, Line=self._LineIndex + 1)\r
1902 # check token of the PCD\r
1903 if ValueList[2] == '':\r
1904 EdkLogger.error('Parser', FORMAT_INVALID, "Missing Token in PCD Datum information",\r
1905 ExtraData=self._CurrentLine + \\r
1906 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
1907 File=self.MetaFile, Line=self._LineIndex + 1)\r
67e11e4d
YZ		 1908\r
1909 PcdValue = ValueList[0]\r
1910 if PcdValue:\r
1911 try:\r
1912 ValueList[0] = ValueExpression(PcdValue, self._AllPcdDict)(True)\r
1913 except WrnExpression, Value:\r
1914 ValueList[0] = Value.result\r
1915\r
1916 if ValueList[0] == 'True':\r
1917 ValueList[0] = '1'\r
1918 if ValueList[0] == 'False':\r
1919 ValueList[0] = '0'\r
1920\r
f51461c8
LG		 1921 # check format of default value against the datum type\r
1922 IsValid, Cause = CheckPcdDatum(ValueList[1], ValueList[0])\r
1923 if not IsValid:\r
1924 EdkLogger.error('Parser', FORMAT_INVALID, Cause, ExtraData=self._CurrentLine,\r
1925 File=self.MetaFile, Line=self._LineIndex + 1)\r
1926\r
1927 if ValueList[0] in ['True', 'true', 'TRUE']:\r
1928 ValueList[0] = '1'\r
1929 elif ValueList[0] in ['False', 'false', 'FALSE']:\r
1930 ValueList[0] = '0'\r
1931\r
1932 # check for duplicate PCD definition\r
1933 if (self._Scope[0], self._ValueList[0], self._ValueList[1]) in self._AllPCDs:\r
1934 EdkLogger.error('Parser', FORMAT_INVALID,\r
1935 "The same PCD name and GUID have been already defined",\r
1936 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)\r
1937 else:\r
1938 self._AllPCDs.append((self._Scope[0], self._ValueList[0], self._ValueList[1]))\r
67e11e4d 1939 self._AllPcdDict[TAB_SPLIT.join(self._ValueList[0:2])] = ValueList[0]\r
f51461c8
LG		 1940\r
1941 self._ValueList[2] = ValueList[0].strip() + '|' + ValueList[1].strip() + '|' + ValueList[2].strip()\r
1942\r
1943 _SectionParser = {\r
1944 MODEL_META_DATA_HEADER : MetaFileParser._DefineParser,\r
1945 MODEL_EFI_INCLUDE : MetaFileParser._PathParser,\r
1946 MODEL_EFI_LIBRARY_CLASS : MetaFileParser._PathParser,\r
1947 MODEL_EFI_GUID : _GuidParser,\r
1948 MODEL_EFI_PPI : _GuidParser,\r
1949 MODEL_EFI_PROTOCOL : _GuidParser,\r
1950 MODEL_PCD_FIXED_AT_BUILD : _PcdParser,\r
1951 MODEL_PCD_PATCHABLE_IN_MODULE : _PcdParser,\r
1952 MODEL_PCD_FEATURE_FLAG : _PcdParser,\r
1953 MODEL_PCD_DYNAMIC : _PcdParser,\r
1954 MODEL_PCD_DYNAMIC_EX : _PcdParser,\r
1955 MODEL_UNKNOWN : MetaFileParser._Skip,\r
0923aa1c 1956 MODEL_META_DATA_USER_EXTENSION : MetaFileParser._SkipUserExtension,\r
f51461c8
LG		 1957 }\r
1958\r
1959##\r
1960#\r
1961# This acts like the main() function for the script, unless it is 'import'ed into another\r
1962# script.\r
1963#\r
1964if __name__ == '__main__':\r
1965 pass\r
1966\r
EFI Development Kit II mirror for PVE