## @file\r
# This file is used to parse meta files\r
#\r
-# Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2008 - 2015, 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
import Common.EdkLogger as EdkLogger\r
import Common.GlobalData as GlobalData\r
import EccGlobalData\r
+import EccToolError\r
\r
from CommonDataClass.DataClass import *\r
from Common.DataType import *\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
\r
## A decorator used to parse macro definition\r
def ParseMacro(Parser):\r
self._PostProcessed = False\r
# Different version of meta-file has different way to parse.\r
self._Version = 0\r
+ # UNI object and extra UNI object\r
+ self._UniObj = None\r
+ self._UniExtraObj = None\r
\r
## Store the parsed data in table\r
def _Store(self, *Args):\r
self.Start()\r
\r
# No specific ARCH or Platform given, use raw data\r
- if self._RawTable and (len(DataInfo) == 1 or DataInfo[1] == None):\r
+ if self._RawTable and (len(DataInfo) == 1 or DataInfo[1] is None):\r
return self._RawTable.Query(*DataInfo)\r
\r
# Do post-process if necessary\r
\r
## Skip unsupported data\r
def _Skip(self):\r
- EdkLogger.warn("Parser", "Unrecognized content", File=self.MetaFile,\r
- Line=self._LineIndex+1, ExtraData=self._CurrentLine);\r
+ if self._SectionName == TAB_USER_EXTENSIONS.upper() and self._CurrentLine.upper().endswith('.UNI'):\r
+ if EccGlobalData.gConfig.UniCheckHelpInfo == '1' or EccGlobalData.gConfig.UniCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
+ ExtraUni = self._CurrentLine.strip()\r
+ ExtraUniFile = os.path.join(os.path.dirname(self.MetaFile), ExtraUni)\r
+ IsModuleUni = self.MetaFile.upper().endswith('.INF')\r
+ self._UniExtraObj = UniParser(ExtraUniFile, IsExtraUni=True, IsModuleUni=IsModuleUni)\r
+ self._UniExtraObj.Start()\r
+ else:\r
+ EdkLogger.warn("Parser", "Unrecognized content", File=self.MetaFile,\r
+ Line=self._LineIndex + 1, ExtraData=self._CurrentLine);\r
self._ValueList[0:1] = [self._CurrentLine]\r
\r
## Section header parser\r
except:\r
EdkLogger.error('Parser', FORMAT_INVALID, "Invalid version number",\r
ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex+1)\r
-\r
+ elif Name == 'MODULE_UNI_FILE':\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=True)\r
+ self._UniObj.Start()\r
+ else:\r
+ EdkLogger.error('Parser', FILE_NOT_FOUND, "Module UNI file %s is missing." % Value,\r
+ ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex+1,\r
+ RaiseError=False)\r
+ elif Name == 'PACKAGE_UNI_FILE':\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
# EDK module allows using defines as macros\r
self._FileLocalMacros[Name] = Value\r
def Start(self):\r
NmakeLine = ''\r
Content = ''\r
+ Usage = ''\r
try:\r
Content = open(str(self.MetaFile), 'r').readlines()\r
except:\r
IsFindBlockComment = False\r
\r
for Index in range(0, len(Content)):\r
+ if self._SectionType in [MODEL_EFI_GUID,\r
+ MODEL_EFI_PROTOCOL,\r
+ MODEL_EFI_PPI,\r
+ MODEL_PCD_FIXED_AT_BUILD,\r
+ MODEL_PCD_PATCHABLE_IN_MODULE,\r
+ MODEL_PCD_FEATURE_FLAG,\r
+ MODEL_PCD_DYNAMIC_EX,\r
+ MODEL_PCD_DYNAMIC]:\r
+ Line = Content[Index].strip()\r
+ if Line.startswith(TAB_SPECIAL_COMMENT):\r
+ Usage += ' ' + Line[Line.find(TAB_SPECIAL_COMMENT):]\r
+ continue\r
+ elif Line.startswith(TAB_COMMENT_SPLIT):\r
+ continue\r
+ elif Line.find(TAB_COMMENT_SPLIT) > 0:\r
+ Usage += ' ' + Line[Line.find(TAB_COMMENT_SPLIT):]\r
+ Line = Line[:Line.find(TAB_COMMENT_SPLIT)]\r
+ else:\r
# skip empty, commented, block commented lines\r
- Line = CleanString(Content[Index], AllowCppStyleComment=True)\r
+ Line = CleanString(Content[Index], AllowCppStyleComment=True)\r
+ Usage = ''\r
NextLine = ''\r
if Index + 1 < len(Content):\r
NextLine = CleanString(Content[Index + 1])\r
self._ValueList = ['','','']\r
# parse current line, result will be put in self._ValueList\r
self._SectionParser[self._SectionType](self)\r
- if self._ValueList == None or self._ItemType == MODEL_META_DATA_DEFINE:\r
+ if self._ValueList is None or self._ItemType == MODEL_META_DATA_DEFINE:\r
self._ItemType = -1\r
continue\r
#\r
# LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1\r
#\r
self._ValueList[0] = self._ValueList[0].replace('/', '\\')\r
+ Usage = Usage.strip()\r
for Arch, Platform in self._Scope:\r
self._Store(self._SectionType,\r
self._ValueList[0],\r
-1,\r
self._LineIndex+1,\r
-1,\r
- 0\r
+ 0,\r
+ Usage\r
)\r
+ Usage = ''\r
if IsFindBlockComment:\r
EdkLogger.error("Parser", FORMAT_INVALID, "Open block comments (starting with /*) are expected to end with */", \r
File=self.MetaFile)\r
TAB_ELSE_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF,\r
TAB_ELSE.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE,\r
TAB_END_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF,\r
+ TAB_ERROR.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR,\r
}\r
\r
# Valid names in define section\r
"FIX_LOAD_TOP_MEMORY_ADDRESS"\r
]\r
\r
+ SubSectionDefineKeywords = [\r
+ "FILE_GUID"\r
+ ]\r
+\r
SymbolPattern = ValueExpression.SymbolPattern\r
\r
## Constructor of DscParser\r
\r
self._ValueList = ['', '', '']\r
self._SectionParser[SectionType](self)\r
- if self._ValueList == None:\r
+ if self._ValueList is None:\r
continue\r
#\r
# Model, Value1, Value2, Value3, Arch, ModuleType, BelongsToItem=-1, BelongsToFile=-1,\r
if not self._ValueList[2]:\r
EdkLogger.error('Parser', FORMAT_INVALID, "No value specified",\r
ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex+1)\r
- if not self._ValueList[1] in self.DefineKeywords:\r
+ if (not self._ValueList[1] in self.DefineKeywords and\r
+ (self._InSubsection and self._ValueList[1] not in self.SubSectionDefineKeywords)):\r
EdkLogger.error('Parser', FORMAT_INVALID,\r
"Unknown keyword found: %s. "\r
"If this is a macro you must "\r
MODEL_META_DATA_BUILD_OPTION : self.__ProcessBuildOption,\r
MODEL_UNKNOWN : self._Skip,\r
MODEL_META_DATA_USER_EXTENSION : self._Skip,\r
+ MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR : self._Skip,\r
}\r
\r
self._RawTable = self._Table\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
+ pass\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
EdkLogger.error('Parser', FORMAT_INVALID, str(Excpt),\r
File=self._FileWithError, ExtraData=' '.join(self._ValueList), \r
Line=self._LineIndex+1)\r
\r
- if self._ValueList == None:\r
+ if self._ValueList is None:\r
continue \r
\r
NewOwner = self._IdMapping.get(Owner, -1)\r
File=self._FileWithError, ExtraData=' '.join(self._ValueList), \r
Line=self._LineIndex+1)\r
Result = Excpt.result\r
+ except BadExpression, Exc:\r
+ EdkLogger.debug(EdkLogger.DEBUG_5, str(Exc), self._ValueList[1])\r
+ Result = False\r
\r
if self._ItemType in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,\r
MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,\r
# section content\r
self._ValueList = ['','','']\r
self._SectionParser[self._SectionType[0]](self)\r
- if self._ValueList == None or self._ItemType == MODEL_META_DATA_DEFINE:\r
+ if self._ValueList is None or self._ItemType == MODEL_META_DATA_DEFINE:\r
self._ItemType = -1\r
self._Comments = []\r
continue\r
continue\r
else:\r
if GuidValue.startswith('{'):\r
- HexList.append('0x' + str(GuidValue[3:]))\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
else:\r
if not IsValid:\r
EdkLogger.error('Parser', FORMAT_INVALID, Cause, ExtraData=self._CurrentLine,\r
File=self.MetaFile, Line=self._LineIndex+1)\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
+ PatternPrompt = re.compile('#\s+@Prompt\s+([\x21-\x7E\s]*)', re.S)\r
+ Description = None\r
+ Prompt = None\r
+ # check @ValidRange, @ValidList and @Expression format valid\r
+ ErrorCodeValid = '0x0 <= %s <= 0xFFFFFFFF'\r
+ PatternValidRangeIn = '(NOT)?\s*(\d+\s*-\s*\d+|0[xX][a-fA-F0-9]+\s*-\s*0[xX][a-fA-F0-9]+|LT\s*\d+|LT\s*0[xX][a-fA-F0-9]+|GT\s*\d+|GT\s*0[xX][a-fA-F0-9]+|LE\s*\d+|LE\s*0[xX][a-fA-F0-9]+|GE\s*\d+|GE\s*0[xX][a-fA-F0-9]+|XOR\s*\d+|XOR\s*0[xX][a-fA-F0-9]+|EQ\s*\d+|EQ\s*0[xX][a-fA-F0-9]+)'\r
+ PatternValidRng = re.compile('^' + '(NOT)?\s*' + PatternValidRangeIn + '$')\r
+ for Comment in self._Comments:\r
+ Comm = Comment[0].strip()\r
+ if not Comm:\r
+ continue\r
+ if not Description:\r
+ Description = PatternDesc.findall(Comm)\r
+ if not Prompt:\r
+ Prompt = PatternPrompt.findall(Comm)\r
+ if Comm[0] == '#':\r
+ ValidFormt = Comm.lstrip('#')\r
+ ValidFormt = ValidFormt.lstrip()\r
+ if ValidFormt[0:11] == '@ValidRange':\r
+ ValidFormt = ValidFormt[11:]\r
+ ValidFormt = ValidFormt.lstrip()\r
+ try:\r
+ ErrorCode, Expression = ValidFormt.split('|', 1)\r
+ except ValueError:\r
+ ErrorCode = '0x0'\r
+ Expression = ValidFormt\r
+ ErrorCode, Expression = ErrorCode.strip(), Expression.strip()\r
+ try:\r
+ if not eval(ErrorCodeValid % ErrorCode):\r
+ EdkLogger.warn('Parser', '@ValidRange ErrorCode(%s) of PCD %s is not valid UINT32 value.' % (ErrorCode, TokenList[0]))\r
+ except:\r
+ EdkLogger.warn('Parser', '@ValidRange ErrorCode(%s) of PCD %s is not valid UINT32 value.' % (ErrorCode, TokenList[0]))\r
+ if not PatternValidRng.search(Expression):\r
+ EdkLogger.warn('Parser', '@ValidRange Expression(%s) of PCD %s is incorrect format.' % (Expression, TokenList[0]))\r
+ if ValidFormt[0:10] == '@ValidList':\r
+ ValidFormt = ValidFormt[10:]\r
+ ValidFormt = ValidFormt.lstrip()\r
+ try:\r
+ ErrorCode, Expression = ValidFormt.split('|', 1)\r
+ except ValueError:\r
+ ErrorCode = '0x0'\r
+ Expression = ValidFormt\r
+ ErrorCode, Expression = ErrorCode.strip(), Expression.strip()\r
+ try:\r
+ if not eval(ErrorCodeValid % ErrorCode):\r
+ EdkLogger.warn('Parser', '@ValidList ErrorCode(%s) of PCD %s is not valid UINT32 value.' % (ErrorCode, TokenList[0]))\r
+ except:\r
+ EdkLogger.warn('Parser', '@ValidList ErrorCode(%s) of PCD %s is not valid UINT32 value.' % (ErrorCode, TokenList[0]))\r
+ Values = Expression.split(',')\r
+ for Value in Values:\r
+ Value = Value.strip()\r
+ try:\r
+ eval(Value)\r
+ except:\r
+ EdkLogger.warn('Parser', '@ValidList Expression of PCD %s include a invalid value(%s).' % (TokenList[0], Value))\r
+ break\r
+ if ValidFormt[0:11] == '@Expression':\r
+ ValidFormt = ValidFormt[11:]\r
+ ValidFormt = ValidFormt.lstrip()\r
+ try:\r
+ ErrorCode, Expression = ValidFormt.split('|', 1)\r
+ except ValueError:\r
+ ErrorCode = '0x0'\r
+ Expression = ValidFormt\r
+ ErrorCode, Expression = ErrorCode.strip(), Expression.strip()\r
+ try:\r
+ if not eval(ErrorCodeValid % ErrorCode):\r
+ EdkLogger.warn('Parser', '@Expression ErrorCode(%s) of PCD %s is not valid UINT32 value.' % (ErrorCode, TokenList[0]))\r
+ except:\r
+ EdkLogger.warn('Parser', '@Expression ErrorCode(%s) of PCD %s is not valid UINT32 value.' % (ErrorCode, TokenList[0]))\r
+ if not Expression:\r
+ EdkLogger.warn('Parser', '@Expression Expression of PCD %s is incorrect format.' % TokenList[0])\r
+ if not Description:\r
+ EdkLogger.warn('Parser', 'PCD %s Description information is not provided.' % TokenList[0])\r
+ if not Prompt:\r
+ EdkLogger.warn('Parser', 'PCD %s Prompt information is not provided.' % TokenList[0])\r
+ # check Description, Prompt localization information\r
+ if self._UniObj:\r
+ self._UniObj.CheckPcdInfo(TokenList[0])\r
\r
if ValueList[0] in ['True', 'true', 'TRUE']:\r
ValueList[0] = '1'\r
}\r
\r
\r
-## FdfObject\r
-#\r
-# This class defined basic Fdf object which is used by inheriting\r
-# \r
-# @param object: Inherited from object class\r
-#\r
-class FdfObject(object):\r
- def __init__(self):\r
- object.__init__()\r
-\r
## Fdf\r
#\r
# This class defined the structure used in Fdf object\r
# \r
-# @param FdfObject: Inherited from FdfObject class\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
-class Fdf(FdfObject):\r
+class Fdf(object):\r
def __init__(self, Filename = None, IsToDatabase = False, WorkspaceDir = None, Database = None):\r
self.WorkspaceDir = WorkspaceDir\r
self.IsToDatabase = IsToDatabase\r
#\r
# Load Fdf file if filename is not None\r
#\r
- if Filename != None:\r
- self.LoadFdfFile(Filename)\r
+ if Filename is not None:\r
+ try:\r
+ self.LoadFdfFile(Filename)\r
+ except Exception:\r
+ pass\r
\r
#\r
# Insert a FDF file record into database\r
BelongsToFile = self.InsertFile(FileName)\r
self.TblFdf.Insert(Model, Value1, Value2, Value3, Scope1, Scope2, BelongsToItem, BelongsToFile, StartLine, StartColumn, EndLine, EndColumn, Enabled)\r
\r
+class UniParser(object):\r
+ # IsExtraUni defined the UNI file is Module UNI or extra Module UNI\r
+ # IsModuleUni defined the UNI file is Module UNI or Package UNI\r
+ def __init__(self, FilePath, IsExtraUni=False, IsModuleUni=True):\r
+ self.FilePath = FilePath\r
+ self.FileName = os.path.basename(FilePath)\r
+ self.IsExtraUni = IsExtraUni\r
+ self.IsModuleUni = IsModuleUni\r
+ self.FileIn = None\r
+ self.Missing = []\r
+ self.__read()\r
+ \r
+ def __read(self):\r
+ try:\r
+ self.FileIn = CodecOpenLongFilePath(self.FilePath, Mode='rb', Encoding='utf_8').read()\r
+ except UnicodeError:\r
+ self.FileIn = CodecOpenLongFilePath(self.FilePath, Mode='rb', Encoding='utf_16').read()\r
+ except UnicodeError:\r
+ self.FileIn = CodecOpenLongFilePath(self.FilePath, Mode='rb', Encoding='utf_16_le').read()\r
+ except IOError:\r
+ self.FileIn = ""\r
+ \r
+ def Start(self):\r
+ if self.IsModuleUni:\r
+ if self.IsExtraUni:\r
+ ModuleName = self.CheckKeyValid('STR_PROPERTIES_MODULE_NAME')\r
+ self.PrintLog('STR_PROPERTIES_MODULE_NAME', ModuleName)\r
+ else:\r
+ ModuleAbstract = self.CheckKeyValid('STR_MODULE_ABSTRACT')\r
+ self.PrintLog('STR_MODULE_ABSTRACT', ModuleAbstract)\r
+ ModuleDescription = self.CheckKeyValid('STR_MODULE_DESCRIPTION')\r
+ self.PrintLog('STR_MODULE_DESCRIPTION', ModuleDescription)\r
+ else:\r
+ if self.IsExtraUni:\r
+ PackageName = self.CheckKeyValid('STR_PROPERTIES_PACKAGE_NAME')\r
+ self.PrintLog('STR_PROPERTIES_PACKAGE_NAME', PackageName)\r
+ else:\r
+ PackageAbstract = self.CheckKeyValid('STR_PACKAGE_ABSTRACT')\r
+ self.PrintLog('STR_PACKAGE_ABSTRACT', PackageAbstract)\r
+ PackageDescription = self.CheckKeyValid('STR_PACKAGE_DESCRIPTION')\r
+ self.PrintLog('STR_PACKAGE_DESCRIPTION', PackageDescription)\r
+ \r
+ def CheckKeyValid(self, Key, Contents=None):\r
+ if not Contents:\r
+ Contents = self.FileIn\r
+ KeyPattern = re.compile('#string\s+%s\s+.*?#language.*?".*?"' % Key, re.S)\r
+ if KeyPattern.search(Contents):\r
+ return True\r
+ return False\r
+ \r
+ def CheckPcdInfo(self, PcdCName):\r
+ PromptKey = 'STR_%s_PROMPT' % PcdCName.replace('.', '_')\r
+ PcdPrompt = self.CheckKeyValid(PromptKey)\r
+ self.PrintLog(PromptKey, PcdPrompt)\r
+ HelpKey = 'STR_%s_HELP' % PcdCName.replace('.', '_')\r
+ PcdHelp = self.CheckKeyValid(HelpKey)\r
+ self.PrintLog(HelpKey, PcdHelp)\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
+ EdkLogger.warn('Parser', Msg)\r
+ EccGlobalData.gDb.TblReport.Insert(EccToolError.ERROR_GENERAL_CHECK_UNI_HELP_INFO, OtherMsg=Msg, BelongsToTable='File', BelongsToItem=-2)\r
+ self.Missing.append(Key)\r
+\r
##\r
#\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
projects / mirror_edk2.git / blobdiff