## @file\r
# This file is used to parse meta files\r
#\r
-# Copyright (c) 2008 - 2015, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution. The full text of the license may be found at\r
##\r
# Import Modules\r
#\r
+from __future__ import absolute_import\r
import Common.LongFilePathOs as os\r
import re\r
import time\r
\r
from CommonDataClass.DataClass import *\r
from Common.DataType import *\r
-from Common.String import *\r
+from Common.StringUtils import *\r
from Common.Misc import GuidStructureStringToGuidString, CheckPcdDatum, PathClass, AnalyzePcdData\r
from Common.Expression import *\r
from CommonDataClass.Exceptions import *\r
\r
-from MetaFileTable import MetaFileStorage\r
+from .MetaFileTable import MetaFileStorage\r
from GenFds.FdfParser import FdfParser\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
from Common.LongFilePathSupport import CodecOpenLongFilePath\r
self._ItemType = MODEL_META_DATA_DEFINE\r
# DEFINE defined macros\r
if Type == TAB_DSC_DEFINES_DEFINE:\r
- if type(self) == DecParser:\r
+ if isinstance(self, DecParser):\r
if MODEL_META_DATA_HEADER in self._SectionType:\r
self._FileLocalMacros[Name] = Value\r
else:\r
SectionLocalMacros = self._SectionsMacroDict[SectionDictKey]\r
SectionLocalMacros[Name] = Value\r
# EDK_GLOBAL defined macros\r
- elif type(self) != DscParser:\r
+ elif not isinstance(self, DscParser):\r
EdkLogger.error('Parser', FORMAT_INVALID, "EDK_GLOBAL can only be used in .dsc file",\r
ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex+1)\r
elif self._SectionType != MODEL_META_DATA_HEADER:\r
elif (Name in self._FileLocalMacros) and (self._FileLocalMacros[Name] != Value):\r
EdkLogger.error('Parser', FORMAT_INVALID, "EDK_GLOBAL defined a macro with the same name and different value as one defined by 'DEFINE'",\r
ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex+1)\r
- \r
+\r
self._ValueList = [Type, Name, Value]\r
\r
return MacroParser\r
# DataInfo = [data_type, scope1(arch), scope2(platform/moduletype)]\r
#\r
def __getitem__(self, DataInfo):\r
- if type(DataInfo) != type(()):\r
+ if not isinstance(DataInfo, type(())):\r
DataInfo = (DataInfo,)\r
\r
# Parse the file first, if necessary\r
TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)\r
self._ValueList[0:len(TokenList)] = TokenList\r
# Don't do macro replacement for dsc file at this point\r
- if type(self) != DscParser:\r
+ if not isinstance(self, DscParser):\r
Macros = self._Macros\r
self._ValueList = [ReplaceMacro(Value, Macros) for Value in self._ValueList]\r
\r
\r
self._ValueList = [ReplaceMacro(Value, self._Macros) for Value in self._ValueList]\r
Name, Value = self._ValueList[1], self._ValueList[2]\r
- # Sometimes, we need to make differences between EDK and EDK2 modules \r
+ # Sometimes, we need to make differences between EDK and EDK2 modules\r
if Name == 'INF_VERSION':\r
try:\r
self._Version = int(Value, 0)\r
UniFile = os.path.join(os.path.dirname(self.MetaFile), Value)\r
if os.path.exists(UniFile):\r
self._UniObj = UniParser(UniFile, IsExtraUni=False, IsModuleUni=False)\r
- \r
- if type(self) == InfParser and self._Version < 0x00010005:\r
+\r
+ if isinstance(self, InfParser) and self._Version < 0x00010005:\r
# EDK module allows using defines as macros\r
self._FileLocalMacros[Name] = Value\r
self._Defines[Name] = Value\r
self._ValueList[1] = TokenList2[1] # keys\r
else:\r
self._ValueList[1] = TokenList[0]\r
- if len(TokenList) == 2 and type(self) != DscParser: # value\r
+ if len(TokenList) == 2 and not isinstance(self, DscParser): # value\r
self._ValueList[2] = ReplaceMacro(TokenList[1], self._Macros)\r
\r
if self._ValueList[1].count('_') != 4:\r
return Macros\r
\r
\r
- ## Get section Macros that are applicable to current line, which may come from other sections \r
+ ## Get section Macros that are applicable to current line, which may come from other sections\r
## that share the same name while scope is wider\r
def _GetApplicableSectionMacro(self):\r
Macros = {}\r
self.FileID = FileID\r
else:\r
self.FileID = self.TblFile.InsertFile(Filename, MODEL_FILE_INF)\r
- \r
+\r
# parse the file line by line\r
IsFindBlockComment = False\r
\r
NmakeLine = ''\r
\r
# section content\r
- self._ValueList = ['','','']\r
+ self._ValueList = ['', '', '']\r
# parse current line, result will be put in self._ValueList\r
self._SectionParser[self._SectionType](self)\r
if self._ValueList is None or self._ItemType == MODEL_META_DATA_DEFINE:\r
)\r
Usage = ''\r
if IsFindBlockComment:\r
- EdkLogger.error("Parser", FORMAT_INVALID, "Open block comments (starting with /*) are expected to end with */", \r
+ EdkLogger.error("Parser", FORMAT_INVALID, "Open block comments (starting with /*) are expected to end with */",\r
File=self.MetaFile)\r
self._Done()\r
\r
# the owner item\r
#\r
self._IdMapping = {-1:-1}\r
- \r
+\r
self.TblFile = EccGlobalData.gDb.TblFile\r
self.FileID = -1\r
\r
self.FileID = FileID\r
else:\r
self.FileID = self.TblFile.InsertFile(Filename, MODEL_FILE_DSC)\r
- \r
- \r
+\r
+\r
for Index in range(0, len(Content)):\r
Line = CleanString(Content[Index])\r
# skip empty line\r
self._LineIndex = Index\r
if self._InSubsection and self._Owner[-1] == -1:\r
self._Owner.append(self._LastItem)\r
- \r
+\r
# section header\r
if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:\r
self._SectionType = MODEL_META_DATA_SECTION_HEADER\r
\r
## Directive statement parser\r
def _DirectiveParser(self):\r
- self._ValueList = ['','','']\r
+ self._ValueList = ['', '', '']\r
TokenList = GetSplitValueList(self._CurrentLine, ' ', 1)\r
self._ValueList[0:len(TokenList)] = TokenList\r
\r
elif self._From > 0:\r
EdkLogger.error('Parser', FORMAT_INVALID,\r
"No '!include' allowed in included file",\r
- ExtraData=self._CurrentLine, File=self.MetaFile, \r
+ ExtraData=self._CurrentLine, File=self.MetaFile,\r
Line=self._LineIndex+1)\r
\r
#\r
\r
## Override parent's method since we'll do all macro replacements in parser\r
def _GetMacros(self):\r
- Macros = dict( [('ARCH','IA32'), ('FAMILY','MSFT'),('TOOL_CHAIN_TAG','VS2008x86'),('TARGET','DEBUG')])\r
+ Macros = dict( [('ARCH', 'IA32'), ('FAMILY', 'MSFT'), ('TOOL_CHAIN_TAG', 'VS2008x86'), ('TARGET', 'DEBUG')])\r
Macros.update(self._FileLocalMacros)\r
Macros.update(self._GetApplicableSectionMacro())\r
Macros.update(GlobalData.gEdkGlobal)\r
MODEL_META_DATA_USER_EXTENSION : self._Skip,\r
MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR : self._Skip,\r
}\r
- \r
+\r
self._RawTable = self._Table\r
self._Table = MetaFileStorage(self._RawTable.Cur, self.MetaFile, MODEL_FILE_DSC, True)\r
self._DirectiveStack = []\r
\r
try:\r
Processer[self._ItemType]()\r
- except EvaluationException, Excpt:\r
- # \r
+ except EvaluationException as Excpt:\r
+ #\r
# Only catch expression evaluation error here. We need to report\r
# the precise number of line on which the error occurred\r
#\r
# EdkLogger.error('Parser', FORMAT_INVALID, "Invalid expression: %s" % str(Excpt),\r
# File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
# Line=self._LineIndex+1)\r
- except MacroException, Excpt:\r
+ except MacroException as Excpt:\r
EdkLogger.error('Parser', FORMAT_INVALID, str(Excpt),\r
- File=self._FileWithError, ExtraData=' '.join(self._ValueList), \r
+ File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
Line=self._LineIndex+1)\r
\r
if self._ValueList is None:\r
- continue \r
+ continue\r
\r
NewOwner = self._IdMapping.get(Owner, -1)\r
self._Enabled = int((not self._DirectiveEvalStack) or (False not in self._DirectiveEvalStack))\r
self._IdMapping[Id] = self._LastItem\r
\r
RecordList = self._Table.GetAll()\r
- \r
+\r
self._RawTable.Drop()\r
self._Table.Drop()\r
for Record in RecordList:\r
- EccGlobalData.gDb.TblDsc.Insert(Record[1],Record[2],Record[3],Record[4],Record[5],Record[6],Record[7],Record[8],Record[9],Record[10],Record[11],Record[12],Record[13],Record[14])\r
+ EccGlobalData.gDb.TblDsc.Insert(Record[1], Record[2], Record[3], Record[4], Record[5], Record[6], Record[7], Record[8], Record[9], Record[10], Record[11], Record[12], Record[13], Record[14])\r
GlobalData.gPlatformDefines.update(self._FileLocalMacros)\r
self._PostProcessed = True\r
self._Content = None\r
\r
def __RetrievePcdValue(self):\r
Records = self._RawTable.Query(MODEL_PCD_FEATURE_FLAG, BelongsToItem=-1.0)\r
- for TokenSpaceGuid,PcdName,Value,Dummy2,Dummy3,ID,Line in Records:\r
+ for TokenSpaceGuid, PcdName, Value, Dummy2, Dummy3, ID, Line in Records:\r
Value, DatumType, MaxDatumSize = AnalyzePcdData(Value)\r
# Only use PCD whose value is straitforward (no macro and PCD)\r
if self.SymbolPattern.findall(Value):\r
# Don't use PCD with different values.\r
if Name in self._Symbols and self._Symbols[Name] != Value:\r
self._Symbols.pop(Name)\r
- continue \r
+ continue\r
self._Symbols[Name] = Value\r
\r
Records = self._RawTable.Query(MODEL_PCD_FIXED_AT_BUILD, BelongsToItem=-1.0)\r
- for TokenSpaceGuid,PcdName,Value,Dummy2,Dummy3,ID,Line in Records:\r
+ for TokenSpaceGuid, PcdName, Value, Dummy2, Dummy3, ID, Line in Records:\r
Value, DatumType, MaxDatumSize = AnalyzePcdData(Value)\r
# Only use PCD whose value is straitforward (no macro and PCD)\r
if self.SymbolPattern.findall(Value):\r
- continue \r
+ continue\r
Name = TokenSpaceGuid+'.'+PcdName\r
# Don't use PCD with different values.\r
if Name in self._Symbols and self._Symbols[Name] != Value:\r
self._Symbols.pop(Name)\r
- continue \r
+ continue\r
self._Symbols[Name] = Value\r
\r
def __ProcessDefine(self):\r
SectionLocalMacros[Name] = Value\r
elif self._ItemType == MODEL_META_DATA_GLOBAL_DEFINE:\r
GlobalData.gEdkGlobal[Name] = Value\r
- \r
+\r
#\r
# Keyword in [Defines] section can be used as Macros\r
#\r
if (self._ItemType == MODEL_META_DATA_HEADER) and (self._SectionType == MODEL_META_DATA_HEADER):\r
self._FileLocalMacros[Name] = Value\r
- \r
+\r
self._ValueList = [Type, Name, Value]\r
\r
def __ProcessDirective(self):\r
Macros.update(GlobalData.gGlobalDefines)\r
try:\r
Result = ValueExpression(self._ValueList[1], Macros)()\r
- except SymbolNotFound, Exc:\r
+ except SymbolNotFound as Exc:\r
EdkLogger.debug(EdkLogger.DEBUG_5, str(Exc), self._ValueList[1])\r
Result = False\r
- except WrnExpression, Excpt:\r
- # \r
+ except WrnExpression as Excpt:\r
+ #\r
# Catch expression evaluation warning here. We need to report\r
# the precise number of line and return the evaluation result\r
#\r
EdkLogger.warn('Parser', "Suspicious expression: %s" % str(Excpt),\r
- File=self._FileWithError, ExtraData=' '.join(self._ValueList), \r
+ File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
Line=self._LineIndex+1)\r
Result = Excpt.result\r
- except BadExpression, Exc:\r
+ except BadExpression as Exc:\r
EdkLogger.debug(EdkLogger.DEBUG_5, str(Exc), self._ValueList[1])\r
Result = False\r
\r
#\r
elif "ECP_SOURCE" in GlobalData.gCommandLineDefines.keys():\r
__IncludeMacros['ECP_SOURCE'] = GlobalData.gCommandLineDefines['ECP_SOURCE']\r
- \r
+\r
__IncludeMacros['EFI_SOURCE'] = GlobalData.gGlobalDefines['EFI_SOURCE']\r
__IncludeMacros['EDK_SOURCE'] = GlobalData.gGlobalDefines['EDK_SOURCE']\r
#\r
- # Allow using MACROs comes from [Defines] section to keep compatible. \r
+ # Allow using MACROs comes from [Defines] section to keep compatible.\r
#\r
__IncludeMacros.update(self._Macros)\r
- \r
+\r
IncludedFile = NormPath(ReplaceMacro(self._ValueList[1], __IncludeMacros, RaiseError=True))\r
#\r
# First search the include file under the same directory as DSC file\r
IncludedFile1 = PathClass(IncludedFile, GlobalData.gWorkspace)\r
ErrorCode, ErrorInfo2 = IncludedFile1.Validate()\r
if ErrorCode != 0:\r
- EdkLogger.error('parser', ErrorCode, File=self._FileWithError, \r
+ EdkLogger.error('parser', ErrorCode, File=self._FileWithError,\r
Line=self._LineIndex+1, ExtraData=ErrorInfo1 + "\n"+ ErrorInfo2)\r
\r
self._FileWithError = IncludedFile1\r
\r
IncludedFileTable = MetaFileStorage(self._Table.Cur, IncludedFile1, MODEL_FILE_DSC, True)\r
Owner = self._Content[self._ContentIndex-1][0]\r
- Parser = DscParser(IncludedFile1, self._FileType, IncludedFileTable, \r
+ Parser = DscParser(IncludedFile1, self._FileType, IncludedFileTable,\r
Owner=Owner, From=Owner)\r
\r
# set the parser status with current status\r
self._Content.pop(self._ContentIndex-1)\r
self._ValueList = None\r
self._ContentIndex -= 1\r
- \r
+\r
def __ProcessSkuId(self):\r
self._ValueList = [ReplaceMacro(Value, self._Macros, RaiseError=True)\r
for Value in self._ValueList]\r
#\r
# PCD value can be an expression\r
#\r
- if len(ValueList) > 1 and ValueList[1] == 'VOID*':\r
- PcdValue = ValueList[0] \r
+ if len(ValueList) > 1 and ValueList[1] == TAB_VOID:\r
+ PcdValue = ValueList[0]\r
try:\r
ValueList[0] = ValueExpression(PcdValue, self._Macros)(True)\r
- except WrnExpression, Value:\r
- ValueList[0] = Value.result \r
+ except WrnExpression as Value:\r
+ ValueList[0] = Value.result\r
else:\r
PcdValue = ValueList[-1]\r
try:\r
ValueList[-1] = ValueExpression(PcdValue, self._Macros)(True)\r
- except WrnExpression, Value:\r
+ except WrnExpression as Value:\r
ValueList[-1] = Value.result\r
- \r
+\r
if ValueList[-1] == 'True':\r
ValueList[-1] = '1'\r
if ValueList[-1] == 'False':\r
- ValueList[-1] = '0' \r
+ ValueList[-1] = '0'\r
\r
self._ValueList[2] = '|'.join(ValueList)\r
\r
self.FileID = FileID\r
else:\r
self.FileID = self.TblFile.InsertFile(Filename, MODEL_FILE_DEC)\r
- \r
+\r
for Index in range(0, len(Content)):\r
Line, Comment = CleanString2(Content[Index])\r
self._CurrentLine = Line\r
continue\r
\r
# section content\r
- self._ValueList = ['','','']\r
+ self._ValueList = ['', '', '']\r
self._SectionParser[self._SectionType[0]](self)\r
if self._ValueList is None or self._ItemType == MODEL_META_DATA_DEFINE:\r
self._ItemType = -1\r
GuidValue = GuidValue.lstrip(' {')\r
HexList.append('0x' + str(GuidValue[2:]))\r
Index += 1\r
- self._ValueList[1] = "{ %s, %s, %s, { %s, %s, %s, %s, %s, %s, %s, %s }}" % (HexList[0], HexList[1], HexList[2],HexList[3],HexList[4],HexList[5],HexList[6],HexList[7],HexList[8],HexList[9],HexList[10])\r
+ self._ValueList[1] = "{ %s, %s, %s, { %s, %s, %s, %s, %s, %s, %s, %s }}" % (HexList[0], HexList[1], HexList[2], HexList[3], HexList[4], HexList[5], HexList[6], HexList[7], HexList[8], HexList[9], HexList[10])\r
else:\r
EdkLogger.error('Parser', FORMAT_INVALID, "Invalid GUID value format",\r
ExtraData=self._CurrentLine + \\r
" (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
File=self.MetaFile, Line=self._LineIndex+1)\r
\r
- \r
+\r
ValueRe = re.compile(r'^\s*L?\".*\|.*\"')\r
PtrValue = ValueRe.findall(TokenList[1])\r
- \r
- # Has VOID* type string, may contain "|" character in the string. \r
+\r
+ # Has VOID* type string, may contain "|" character in the string.\r
if len(PtrValue) != 0:\r
ptrValueList = re.sub(ValueRe, '', TokenList[1])\r
ValueList = GetSplitValueList(ptrValueList)\r
ValueList[0] = PtrValue[0]\r
else:\r
ValueList = GetSplitValueList(TokenList[1])\r
- \r
- \r
+\r
+\r
# check if there's enough datum information given\r
if len(ValueList) != 3:\r
EdkLogger.error('Parser', FORMAT_INVALID, "Invalid PCD Datum information given",\r
if not IsValid:\r
EdkLogger.error('Parser', FORMAT_INVALID, Cause, ExtraData=self._CurrentLine,\r
File=self.MetaFile, Line=self._LineIndex+1)\r
- \r
+\r
if EccGlobalData.gConfig.UniCheckPCDInfo == '1' or EccGlobalData.gConfig.UniCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
# check Description, Prompt information\r
PatternDesc = re.compile('##\s*([\x21-\x7E\s]*)', re.S)\r
## Fdf\r
#\r
# This class defined the structure used in Fdf object\r
-# \r
+#\r
# @param Filename: Input value for Ffilename of Fdf file, default is None\r
# @param WorkspaceDir: Input value for current workspace directory, default is None\r
#\r
def __init__(self, Filename = None, IsToDatabase = False, WorkspaceDir = None, Database = None):\r
self.WorkspaceDir = WorkspaceDir\r
self.IsToDatabase = IsToDatabase\r
- \r
+\r
self.Cur = Database.Cur\r
self.TblFile = Database.TblFile\r
self.TblFdf = Database.TblFdf\r
self.FileList[Filename] = FileID\r
\r
return self.FileList[Filename]\r
- \r
- \r
+\r
+\r
## Load Fdf file\r
#\r
# Load the file if it exists\r
#\r
# @param Filename: Input value for filename of Fdf file\r
#\r
- def LoadFdfFile(self, Filename): \r
+ def LoadFdfFile(self, Filename):\r
FileList = []\r
#\r
# Parse Fdf file\r
self.FileIn = None\r
self.Missing = []\r
self.__read()\r
- \r
+\r
def __read(self):\r
try:\r
self.FileIn = CodecOpenLongFilePath(self.FilePath, Mode='rb', Encoding='utf_8').read()\r
self.FileIn = CodecOpenLongFilePath(self.FilePath, Mode='rb', Encoding='utf_16_le').read()\r
except IOError:\r
self.FileIn = ""\r
- \r
+\r
def Start(self):\r
if self.IsModuleUni:\r
if self.IsExtraUni:\r
self.PrintLog('STR_PACKAGE_ABSTRACT', PackageAbstract)\r
PackageDescription = self.CheckKeyValid('STR_PACKAGE_DESCRIPTION')\r
self.PrintLog('STR_PACKAGE_DESCRIPTION', PackageDescription)\r
- \r
+\r
def CheckKeyValid(self, Key, Contents=None):\r
if not Contents:\r
Contents = self.FileIn\r
if KeyPattern.search(Contents):\r
return True\r
return False\r
- \r
+\r
def CheckPcdInfo(self, PcdCName):\r
PromptKey = 'STR_%s_PROMPT' % PcdCName.replace('.', '_')\r
PcdPrompt = self.CheckKeyValid(PromptKey)\r
HelpKey = 'STR_%s_HELP' % PcdCName.replace('.', '_')\r
PcdHelp = self.CheckKeyValid(HelpKey)\r
self.PrintLog(HelpKey, PcdHelp)\r
- \r
+\r
def PrintLog(self, Key, Value):\r
if not Value and Key not in self.Missing:\r
Msg = '%s is missing in the %s file.' % (Key, self.FileName)\r