[mirror_edk2.git] / BaseTools / Source / Python / GenFds / FdfParser.py

## @file\r
# parse FDF file\r
#\r
#  Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>\r
#\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
#  http://opensource.org/licenses/bsd-license.php\r
#\r
#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
\r
##\r
# Import Modules\r
#\r
import re\r
\r
import Fd\r
import Region\r
import Fv\r
import AprioriSection\r
import FfsInfStatement\r
import FfsFileStatement\r
import VerSection\r
import UiSection\r
import FvImageSection\r
import DataSection\r
import DepexSection\r
import CompressSection\r
import GuidSection\r
import Capsule\r
import CapsuleData\r
import Rule\r
import RuleComplexFile\r
import RuleSimpleFile\r
import EfiSection\r
import Vtf\r
import ComponentStatement\r
import OptionRom\r
import OptRomInfStatement\r
import OptRomFileStatement\r
\r
from GenFdsGlobalVariable import GenFdsGlobalVariable\r
from Common.BuildToolError import *\r
from Common import EdkLogger\r
from Common.Misc import PathClass\r
from Common.String import NormPath\r
import Common.GlobalData as GlobalData\r
from Common.Expression import *\r
from Common import GlobalData\r
from Common.String import ReplaceMacro\r
\r
from Common.Misc import tdict\r
\r
import re\r
import Common.LongFilePathOs as os\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
\r
##define T_CHAR_SPACE                ' '\r
##define T_CHAR_NULL                 '\0'\r
##define T_CHAR_CR                   '\r'\r
##define T_CHAR_TAB                  '\t'\r
##define T_CHAR_LF                   '\n'\r
##define T_CHAR_SLASH                '/'\r
##define T_CHAR_BACKSLASH            '\\'\r
##define T_CHAR_DOUBLE_QUOTE         '\"'\r
##define T_CHAR_SINGLE_QUOTE         '\''\r
##define T_CHAR_STAR                 '*'\r
##define T_CHAR_HASH                 '#'\r
\r
(T_CHAR_SPACE, T_CHAR_NULL, T_CHAR_CR, T_CHAR_TAB, T_CHAR_LF, T_CHAR_SLASH, \\r
T_CHAR_BACKSLASH, T_CHAR_DOUBLE_QUOTE, T_CHAR_SINGLE_QUOTE, T_CHAR_STAR, T_CHAR_HASH) = \\r
(' ', '\0', '\r', '\t', '\n', '/', '\\', '\"', '\'', '*', '#')\r
\r
SEPERATOR_TUPLE = ('=', '|', ',', '{', '}')\r
\r
RegionSizePattern = re.compile("\s*(?P<base>(?:0x|0X)?[a-fA-F0-9]+)\s*\|\s*(?P<size>(?:0x|0X)?[a-fA-F0-9]+)\s*")\r
RegionSizeGuidPattern = re.compile("\s*(?P<base>\w+\.\w+)\s*\|\s*(?P<size>\w+\.\w+)\s*")\r
RegionOffsetPcdPattern = re.compile("\s*(?P<base>\w+\.\w+)\s*$")\r
ShortcutPcdPattern = re.compile("\s*\w+\s*=\s*(?P<value>(?:0x|0X)?[a-fA-F0-9]+)\s*\|\s*(?P<name>\w+\.\w+)\s*")\r
\r
IncludeFileList = []\r
\r
def GetRealFileLine (File, Line):\r
\r
    InsertedLines = 0\r
    for Profile in IncludeFileList:\r
        if Line >= Profile.InsertStartLineNumber and Line < Profile.InsertStartLineNumber + Profile.InsertAdjust + len(Profile.FileLinesList):\r
            return (Profile.FileName, Line - Profile.InsertStartLineNumber + 1)\r
        if Line >= Profile.InsertStartLineNumber + Profile.InsertAdjust + len(Profile.FileLinesList):\r
            InsertedLines += Profile.InsertAdjust + len(Profile.FileLinesList)\r
\r
    return (File, Line - InsertedLines)\r
\r
## The exception class that used to report error messages when parsing FDF\r
#\r
# Currently the "ToolName" is set to be "FDF Parser".\r
#\r
class Warning (Exception):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Str         The message to record\r
    #   @param  File        The FDF name\r
    #   @param  Line        The Line number that error occurs\r
    #\r
    def __init__(self, Str, File = None, Line = None):\r
\r
        FileLineTuple = GetRealFileLine(File, Line)\r
        self.FileName = FileLineTuple[0]\r
        self.LineNumber = FileLineTuple[1]\r
        self.Message = Str\r
        self.ToolName = 'FdfParser'\r
\r
    def __str__(self):\r
        return self.Message\r
\r
## The MACRO class that used to record macro value data when parsing include file\r
#\r
#\r
class MacroProfile :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FileName    The file that to be parsed\r
    #\r
    def __init__(self, FileName, Line):\r
        self.FileName = FileName\r
        self.DefinedAtLine  = Line\r
        self.MacroName = None\r
        self.MacroValue = None\r
\r
## The Include file content class that used to record file data when parsing include file\r
#\r
# May raise Exception when opening file.\r
#\r
class IncludeFileProfile :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FileName    The file that to be parsed\r
    #\r
    def __init__(self, FileName):\r
        self.FileName = FileName\r
        self.FileLinesList = []\r
        try:\r
            fsock = open(FileName, "rb", 0)\r
            try:\r
                self.FileLinesList = fsock.readlines()\r
            finally:\r
                fsock.close()\r
\r
        except:\r
            EdkLogger.error("FdfParser", FILE_OPEN_FAILURE, ExtraData=FileName)\r
\r
        self.InsertStartLineNumber = None\r
        self.InsertAdjust = 0\r
\r
## The FDF content class that used to record file data when parsing FDF\r
#\r
# May raise Exception when opening file.\r
#\r
class FileProfile :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FileName    The file that to be parsed\r
    #\r
    def __init__(self, FileName):\r
        self.FileLinesList = []\r
        try:\r
            fsock = open(FileName, "rb", 0)\r
            try:\r
                self.FileLinesList = fsock.readlines()\r
            finally:\r
                fsock.close()\r
\r
        except:\r
            EdkLogger.error("FdfParser", FILE_OPEN_FAILURE, ExtraData=FileName)\r
\r
\r
        self.PcdDict = {}\r
        self.InfList = []\r
        # ECC will use this Dict and List information\r
        self.PcdFileLineDict = {}\r
        self.InfFileLineList = []\r
        \r
        self.FdDict = {}\r
        self.FdNameNotSet = False\r
        self.FvDict = {}\r
        self.CapsuleDict = {}\r
        self.VtfList = []\r
        self.RuleDict = {}\r
        self.OptRomDict = {}\r
\r
## The syntax parser for FDF\r
#\r
# PreprocessFile method should be called prior to ParseFile\r
# CycleReferenceCheck method can detect cycles in FDF contents\r
#\r
# GetNext*** procedures mean these procedures will get next token first, then make judgement.\r
# Get*** procedures mean these procedures will make judgement on current token only.\r
#\r
class FdfParser:\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FileName    The file that to be parsed\r
    #\r
    def __init__(self, FileName):\r
        self.Profile = FileProfile(FileName)\r
        self.FileName = FileName\r
        self.CurrentLineNumber = 1\r
        self.CurrentOffsetWithinLine = 0\r
        self.CurrentFdName = None\r
        self.CurrentFvName = None\r
        self.__Token = ""\r
        self.__SkippedChars = ""\r
\r
        # Used to section info\r
        self.__CurSection = []\r
        # Key: [section name, UI name, arch]\r
        # Value: {MACRO_NAME : MACRO_VALUE}\r
        self.__MacroDict = tdict(True, 3)\r
        self.__PcdDict = {}\r
\r
        self.__WipeOffArea = []\r
        if GenFdsGlobalVariable.WorkSpaceDir == '':\r
            GenFdsGlobalVariable.WorkSpaceDir = os.getenv("WORKSPACE")\r
\r
    ## __IsWhiteSpace() method\r
    #\r
    #   Whether char at current FileBufferPos is whitespace\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Char        The char to test\r
    #   @retval True        The char is a kind of white space\r
    #   @retval False       The char is NOT a kind of white space\r
    #\r
    def __IsWhiteSpace(self, Char):\r
        if Char in (T_CHAR_NULL, T_CHAR_CR, T_CHAR_SPACE, T_CHAR_TAB, T_CHAR_LF):\r
            return True\r
        else:\r
            return False\r
\r
    ## __SkipWhiteSpace() method\r
    #\r
    #   Skip white spaces from current char, return number of chars skipped\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval Count       The number of chars skipped\r
    #\r
    def __SkipWhiteSpace(self):\r
        Count = 0\r
        while not self.__EndOfFile():\r
            Count += 1\r
            if self.__CurrentChar() in (T_CHAR_NULL, T_CHAR_CR, T_CHAR_LF, T_CHAR_SPACE, T_CHAR_TAB):\r
                self.__SkippedChars += str(self.__CurrentChar())\r
                self.__GetOneChar()\r
\r
            else:\r
                Count = Count - 1\r
                return Count\r
\r
    ## __EndOfFile() method\r
    #\r
    #   Judge current buffer pos is at file end\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Current File buffer position is at file end\r
    #   @retval False       Current File buffer position is NOT at file end\r
    #\r
    def __EndOfFile(self):\r
        NumberOfLines = len(self.Profile.FileLinesList)\r
        SizeOfLastLine = len(self.Profile.FileLinesList[-1])\r
        if self.CurrentLineNumber == NumberOfLines and self.CurrentOffsetWithinLine >= SizeOfLastLine - 1:\r
            return True\r
        elif self.CurrentLineNumber > NumberOfLines:\r
            return True\r
        else:\r
            return False\r
\r
    ## __EndOfLine() method\r
    #\r
    #   Judge current buffer pos is at line end\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Current File buffer position is at line end\r
    #   @retval False       Current File buffer position is NOT at line end\r
    #\r
    def __EndOfLine(self):\r
        if self.CurrentLineNumber > len(self.Profile.FileLinesList):\r
            return True\r
        SizeOfCurrentLine = len(self.Profile.FileLinesList[self.CurrentLineNumber - 1])\r
        if self.CurrentOffsetWithinLine >= SizeOfCurrentLine:\r
            return True\r
        else:\r
            return False\r
\r
    ## Rewind() method\r
    #\r
    #   Reset file data buffer to the initial state\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def Rewind(self):\r
        self.CurrentLineNumber = 1\r
        self.CurrentOffsetWithinLine = 0\r
\r
    ## __UndoOneChar() method\r
    #\r
    #   Go back one char in the file buffer\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully go back one char\r
    #   @retval False       Not able to go back one char as file beginning reached\r
    #\r
    def __UndoOneChar(self):\r
\r
        if self.CurrentLineNumber == 1 and self.CurrentOffsetWithinLine == 0:\r
            return False\r
        elif self.CurrentOffsetWithinLine == 0:\r
            self.CurrentLineNumber -= 1\r
            self.CurrentOffsetWithinLine = len(self.__CurrentLine()) - 1\r
        else:\r
            self.CurrentOffsetWithinLine -= 1\r
        return True\r
\r
    ## __GetOneChar() method\r
    #\r
    #   Move forward one char in the file buffer\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __GetOneChar(self):\r
        if self.CurrentOffsetWithinLine == len(self.Profile.FileLinesList[self.CurrentLineNumber - 1]) - 1:\r
            self.CurrentLineNumber += 1\r
            self.CurrentOffsetWithinLine = 0\r
        else:\r
            self.CurrentOffsetWithinLine += 1\r
\r
    ## __CurrentChar() method\r
    #\r
    #   Get the char pointed to by the file buffer pointer\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval Char        Current char\r
    #\r
    def __CurrentChar(self):\r
        return self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine]\r
\r
    ## __NextChar() method\r
    #\r
    #   Get the one char pass the char pointed to by the file buffer pointer\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval Char        Next char\r
    #\r
    def __NextChar(self):\r
        if self.CurrentOffsetWithinLine == len(self.Profile.FileLinesList[self.CurrentLineNumber - 1]) - 1:\r
            return self.Profile.FileLinesList[self.CurrentLineNumber][0]\r
        else:\r
            return self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine + 1]\r
\r
    ## __SetCurrentCharValue() method\r
    #\r
    #   Modify the value of current char\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Value       The new value of current char\r
    #\r
    def __SetCurrentCharValue(self, Value):\r
        self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine] = Value\r
\r
    ## __CurrentLine() method\r
    #\r
    #   Get the list that contains current line contents\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval List        current line contents\r
    #\r
    def __CurrentLine(self):\r
        return self.Profile.FileLinesList[self.CurrentLineNumber - 1]\r
\r
    def __StringToList(self):\r
        self.Profile.FileLinesList = [list(s) for s in self.Profile.FileLinesList]\r
        self.Profile.FileLinesList[-1].append(' ')\r
\r
    def __ReplaceFragment(self, StartPos, EndPos, Value = ' '):\r
        if StartPos[0] == EndPos[0]:\r
            Offset = StartPos[1]\r
            while Offset <= EndPos[1]:\r
                self.Profile.FileLinesList[StartPos[0]][Offset] = Value\r
                Offset += 1\r
            return\r
\r
        Offset = StartPos[1]\r
        while self.Profile.FileLinesList[StartPos[0]][Offset] not in ('\r', '\n'):\r
            self.Profile.FileLinesList[StartPos[0]][Offset] = Value\r
            Offset += 1\r
\r
        Line = StartPos[0]\r
        while Line < EndPos[0]:\r
            Offset = 0\r
            while self.Profile.FileLinesList[Line][Offset] not in ('\r', '\n'):\r
                self.Profile.FileLinesList[Line][Offset] = Value\r
                Offset += 1\r
            Line += 1\r
\r
        Offset = 0\r
        while Offset <= EndPos[1]:\r
            self.Profile.FileLinesList[EndPos[0]][Offset] = Value\r
            Offset += 1\r
\r
\r
    def __GetMacroName(self):\r
        if not self.__GetNextToken():\r
            raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)\r
        MacroName = self.__Token\r
        NotFlag = False\r
        if MacroName.startswith('!'):\r
            NotFlag = True\r
            MacroName = MacroName[1:].strip()\r
         \r
        if not MacroName.startswith('$(') or not MacroName.endswith(')'):\r
            raise Warning("Macro name expected(Please use '$(%(Token)s)' if '%(Token)s' is a macro.)" % {"Token" : MacroName},\r
                          self.FileName, self.CurrentLineNumber)\r
        MacroName = MacroName[2:-1]\r
        return MacroName, NotFlag\r
\r
    def __SetMacroValue(self, Macro, Value):\r
        if not self.__CurSection:\r
            return\r
\r
        MacroDict = {}\r
        if not self.__MacroDict[self.__CurSection[0], self.__CurSection[1], self.__CurSection[2]]:\r
            self.__MacroDict[self.__CurSection[0], self.__CurSection[1], self.__CurSection[2]] = MacroDict\r
        else:\r
            MacroDict = self.__MacroDict[self.__CurSection[0], self.__CurSection[1], self.__CurSection[2]]\r
        MacroDict[Macro] = Value\r
\r
    def __GetMacroValue(self, Macro):\r
        # Highest priority\r
        if Macro in GlobalData.gCommandLineDefines:\r
            return GlobalData.gCommandLineDefines[Macro]\r
        if Macro in GlobalData.gGlobalDefines:\r
            return GlobalData.gGlobalDefines[Macro]\r
\r
        if self.__CurSection:\r
            MacroDict = self.__MacroDict[\r
                        self.__CurSection[0],\r
                        self.__CurSection[1],\r
                        self.__CurSection[2]\r
            ]\r
            if MacroDict and Macro in MacroDict:\r
                return MacroDict[Macro]\r
\r
        # Lowest priority\r
        if Macro in GlobalData.gPlatformDefines:\r
            return GlobalData.gPlatformDefines[Macro]\r
        return None\r
\r
    def __SectionHeaderParser(self, Section):\r
        # [Defines]\r
        # [FD.UiName]: use dummy instead if UI name is optional\r
        # [FV.UiName]\r
        # [Capsule.UiName]\r
        # [Rule]: don't take rule section into account, macro is not allowed in this section\r
        # [VTF.arch.UiName, arch]\r
        # [OptionRom.DriverName]\r
        self.__CurSection = []\r
        Section = Section.strip()[1:-1].upper().replace(' ', '').strip('.')\r
        ItemList = Section.split('.')\r
        Item = ItemList[0]\r
        if Item == '' or Item == 'RULE':\r
            return\r
\r
        if Item == 'DEFINES':\r
            self.__CurSection = ['COMMON', 'COMMON', 'COMMON']\r
        elif Item == 'VTF' and len(ItemList) == 3:\r
            UiName = ItemList[2]\r
            Pos = UiName.find(',')\r
            if Pos != -1:\r
                UiName = UiName[:Pos]\r
            self.__CurSection = ['VTF', UiName, ItemList[1]]\r
        elif len(ItemList) > 1:\r
            self.__CurSection = [ItemList[0], ItemList[1], 'COMMON']\r
        elif len(ItemList) > 0:\r
            self.__CurSection = [ItemList[0], 'DUMMY', 'COMMON']\r
\r
    ## PreprocessFile() method\r
    #\r
    #   Preprocess file contents, replace comments with spaces.\r
    #   In the end, rewind the file buffer pointer to the beginning\r
    #   BUGBUG: No !include statement processing contained in this procedure\r
    #   !include statement should be expanded at the same FileLinesList[CurrentLineNumber - 1]\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def PreprocessFile(self):\r
\r
        self.Rewind()\r
        InComment = False\r
        DoubleSlashComment = False\r
        HashComment = False\r
        # HashComment in quoted string " " is ignored.\r
        InString = False\r
\r
        while not self.__EndOfFile():\r
\r
            if self.__CurrentChar() == T_CHAR_DOUBLE_QUOTE and not InComment:\r
                InString = not InString\r
            # meet new line, then no longer in a comment for // and '#'\r
            if self.__CurrentChar() == T_CHAR_LF:\r
                self.CurrentLineNumber += 1\r
                self.CurrentOffsetWithinLine = 0\r
                if InComment and DoubleSlashComment:\r
                    InComment = False\r
                    DoubleSlashComment = False\r
                if InComment and HashComment:\r
                    InComment = False\r
                    HashComment = False\r
            # check for */ comment end\r
            elif InComment and not DoubleSlashComment and not HashComment and self.__CurrentChar() == T_CHAR_STAR and self.__NextChar() == T_CHAR_SLASH:\r
                self.__SetCurrentCharValue(T_CHAR_SPACE)\r
                self.__GetOneChar()\r
                self.__SetCurrentCharValue(T_CHAR_SPACE)\r
                self.__GetOneChar()\r
                InComment = False\r
            # set comments to spaces\r
            elif InComment:\r
                self.__SetCurrentCharValue(T_CHAR_SPACE)\r
                self.__GetOneChar()\r
            # check for // comment\r
            elif self.__CurrentChar() == T_CHAR_SLASH and self.__NextChar() == T_CHAR_SLASH and not self.__EndOfLine():\r
                InComment = True\r
                DoubleSlashComment = True\r
            # check for '#' comment\r
            elif self.__CurrentChar() == T_CHAR_HASH and not self.__EndOfLine() and not InString:\r
                InComment = True\r
                HashComment = True\r
            # check for /* comment start\r
            elif self.__CurrentChar() == T_CHAR_SLASH and self.__NextChar() == T_CHAR_STAR:\r
                self.__SetCurrentCharValue( T_CHAR_SPACE)\r
                self.__GetOneChar()\r
                self.__SetCurrentCharValue( T_CHAR_SPACE)\r
                self.__GetOneChar()\r
                InComment = True\r
            else:\r
                self.__GetOneChar()\r
\r
        # restore from ListOfList to ListOfString\r
        self.Profile.FileLinesList = ["".join(list) for list in self.Profile.FileLinesList]\r
        self.Rewind()\r
\r
    ## PreprocessIncludeFile() method\r
    #\r
    #   Preprocess file contents, replace !include statements with file contents.\r
    #   In the end, rewind the file buffer pointer to the beginning\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def PreprocessIncludeFile(self):\r
\r
        while self.__GetNextToken():\r
\r
            if self.__Token == '!include':\r
                IncludeLine = self.CurrentLineNumber\r
                IncludeOffset = self.CurrentOffsetWithinLine - len('!include')\r
                if not self.__GetNextToken():\r
                    raise Warning("expected include file name", self.FileName, self.CurrentLineNumber)\r
                IncFileName = self.__Token\r
                __IncludeMacros = {}\r
                for Macro in ['WORKSPACE', 'ECP_SOURCE', 'EFI_SOURCE', 'EDK_SOURCE']:\r
                    MacroVal = self.__GetMacroValue(Macro)\r
                    if MacroVal:\r
                        __IncludeMacros[Macro] = MacroVal\r
\r
                try:\r
                    IncludedFile = NormPath(ReplaceMacro(IncFileName, __IncludeMacros, RaiseError=True))\r
                except:\r
                    raise Warning("only these system environment variables are permitted to start the path of the included file: "\r
                                  "$(WORKSPACE), $(ECP_SOURCE), $(EFI_SOURCE), $(EDK_SOURCE)",\r
                                  self.FileName, self.CurrentLineNumber)\r
                #\r
                # First search the include file under the same directory as FDF file\r
                #\r
                IncludedFile1 = PathClass(IncludedFile, os.path.dirname(self.FileName))\r
                ErrorCode = IncludedFile1.Validate()[0]\r
                if ErrorCode != 0:\r
                    #\r
                    # Then search the include file under the same directory as DSC file\r
                    #\r
                    PlatformDir = ''\r
                    if GenFdsGlobalVariable.ActivePlatform:\r
                        PlatformDir = GenFdsGlobalVariable.ActivePlatform.Dir\r
                    elif GlobalData.gActivePlatform:\r
                        PlatformDir = GlobalData.gActivePlatform.MetaFile.Dir\r
                    IncludedFile1 = PathClass(IncludedFile, PlatformDir)\r
                    ErrorCode = IncludedFile1.Validate()[0]\r
                    if ErrorCode != 0:\r
                        #\r
                        # Also search file under the WORKSPACE directory\r
                        #\r
                        IncludedFile1 = PathClass(IncludedFile, GlobalData.gWorkspace)\r
                        ErrorCode = IncludedFile1.Validate()[0]\r
                        if ErrorCode != 0:\r
                            raise Warning("The include file does not exist under below directories: \n%s\n%s\n%s\n"%(os.path.dirname(self.FileName), PlatformDir, GlobalData.gWorkspace), \r
                                          self.FileName, self.CurrentLineNumber)\r
\r
                IncFileProfile = IncludeFileProfile(IncludedFile1.Path)\r
\r
                CurrentLine = self.CurrentLineNumber\r
                CurrentOffset = self.CurrentOffsetWithinLine\r
                # list index of the insertion, note that line number is 'CurrentLine + 1'\r
                InsertAtLine = CurrentLine\r
                IncFileProfile.InsertStartLineNumber = InsertAtLine + 1\r
                # deal with remaining portions after "!include filename", if exists.\r
                if self.__GetNextToken():\r
                    if self.CurrentLineNumber == CurrentLine:\r
                        RemainingLine = self.__CurrentLine()[CurrentOffset:]\r
                        self.Profile.FileLinesList.insert(self.CurrentLineNumber, RemainingLine)\r
                        IncFileProfile.InsertAdjust += 1\r
                        self.CurrentLineNumber += 1\r
                        self.CurrentOffsetWithinLine = 0\r
\r
                for Line in IncFileProfile.FileLinesList:\r
                    self.Profile.FileLinesList.insert(InsertAtLine, Line)\r
                    self.CurrentLineNumber += 1\r
                    InsertAtLine += 1\r
\r
                IncludeFileList.append(IncFileProfile)\r
\r
                # comment out the processed include file statement\r
                TempList = list(self.Profile.FileLinesList[IncludeLine - 1])\r
                TempList.insert(IncludeOffset, '#')\r
                self.Profile.FileLinesList[IncludeLine - 1] = ''.join(TempList)\r
\r
        self.Rewind()\r
        \r
    def __GetIfListCurrentItemStat(self, IfList):\r
        if len(IfList) == 0:\r
            return True\r
        \r
        for Item in IfList:\r
            if Item[1] == False:\r
                return False\r
        \r
        return True\r
    \r
    ## PreprocessConditionalStatement() method\r
    #\r
    #   Preprocess conditional statement.\r
    #   In the end, rewind the file buffer pointer to the beginning\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def PreprocessConditionalStatement(self):\r
        # IfList is a stack of if branches with elements of list [Pos, CondSatisfied, BranchDetermined]\r
        IfList = []\r
        RegionLayoutLine = 0\r
        ReplacedLine = -1\r
        while self.__GetNextToken():\r
            # Determine section name and the location dependent macro\r
            if self.__GetIfListCurrentItemStat(IfList):\r
                if self.__Token.startswith('['):\r
                    Header = self.__Token\r
                    if not self.__Token.endswith(']'):\r
                        self.__SkipToToken(']')\r
                        Header += self.__SkippedChars\r
                    if Header.find('$(') != -1:\r
                        raise Warning("macro cannot be used in section header", self.FileName, self.CurrentLineNumber)\r
                    self.__SectionHeaderParser(Header)\r
                    continue\r
                # Replace macros except in RULE section or out of section\r
                elif self.__CurSection and ReplacedLine != self.CurrentLineNumber:\r
                    ReplacedLine = self.CurrentLineNumber\r
                    self.__UndoToken()\r
                    CurLine = self.Profile.FileLinesList[ReplacedLine - 1]\r
                    PreIndex = 0\r
                    StartPos = CurLine.find('$(', PreIndex)\r
                    EndPos = CurLine.find(')', StartPos+2)\r
                    while StartPos != -1 and EndPos != -1 and self.__Token not in ['!ifdef', '!ifndef', '!if', '!elseif']:\r
                        MacroName = CurLine[StartPos+2 : EndPos]\r
                        MacorValue = self.__GetMacroValue(MacroName)\r
                        if MacorValue != None:\r
                            CurLine = CurLine.replace('$(' + MacroName + ')', MacorValue, 1)\r
                            if MacorValue.find('$(') != -1:\r
                                PreIndex = StartPos\r
                            else:\r
                                PreIndex = StartPos + len(MacorValue)\r
                        else:\r
                            PreIndex = EndPos + 1\r
                        StartPos = CurLine.find('$(', PreIndex)\r
                        EndPos = CurLine.find(')', StartPos+2)\r
                    self.Profile.FileLinesList[ReplacedLine - 1] = CurLine\r
                    continue\r
\r
            if self.__Token == 'DEFINE':\r
                if self.__GetIfListCurrentItemStat(IfList):\r
                    if not self.__CurSection:\r
                        raise Warning("macro cannot be defined in Rule section or out of section", self.FileName, self.CurrentLineNumber)\r
                    DefineLine = self.CurrentLineNumber - 1\r
                    DefineOffset = self.CurrentOffsetWithinLine - len('DEFINE')\r
                    if not self.__GetNextToken():\r
                        raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)\r
                    Macro = self.__Token\r
                    if not self.__IsToken( "="):\r
                        raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
    \r
                    Value = self.__GetExpression()\r
                    self.__SetMacroValue(Macro, Value)\r
                    self.__WipeOffArea.append(((DefineLine, DefineOffset), (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
            elif self.__Token == 'SET':\r
                SetLine = self.CurrentLineNumber - 1\r
                SetOffset = self.CurrentOffsetWithinLine - len('SET')\r
                PcdPair = self.__GetNextPcdName()\r
                PcdName = "%s.%s" % (PcdPair[1], PcdPair[0])\r
                if not self.__IsToken( "="):\r
                    raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
                Value = self.__GetExpression()\r
                Value = self.__EvaluateConditional(Value, self.CurrentLineNumber, 'eval', True)\r
\r
                self.__PcdDict[PcdName] = Value\r
\r
                self.Profile.PcdDict[PcdPair] = Value\r
                FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
                self.Profile.PcdFileLineDict[PcdPair] = FileLineTuple\r
\r
                self.__WipeOffArea.append(((SetLine, SetOffset), (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
            elif self.__Token in ('!ifdef', '!ifndef', '!if'):\r
                IfStartPos = (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - len(self.__Token))\r
                IfList.append([IfStartPos, None, None])\r
\r
                CondLabel = self.__Token\r
                Expression = self.__GetExpression()\r
                \r
                if CondLabel == '!if':\r
                    ConditionSatisfied = self.__EvaluateConditional(Expression, IfList[-1][0][0] + 1, 'eval')\r
                else:\r
                    ConditionSatisfied = self.__EvaluateConditional(Expression, IfList[-1][0][0] + 1, 'in')\r
                    if CondLabel == '!ifndef':\r
                        ConditionSatisfied = not ConditionSatisfied\r
\r
                BranchDetermined = ConditionSatisfied\r
                IfList[-1] = [IfList[-1][0], ConditionSatisfied, BranchDetermined]\r
                if ConditionSatisfied:\r
                    self.__WipeOffArea.append((IfList[-1][0], (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))                 \r
            elif self.__Token in ('!elseif', '!else'):\r
                ElseStartPos = (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - len(self.__Token))\r
                if len(IfList) <= 0:\r
                    raise Warning("Missing !if statement", self.FileName, self.CurrentLineNumber)\r
\r
                if IfList[-1][1]:\r
                    IfList[-1] = [ElseStartPos, False, True]\r
                    self.__WipeOffArea.append((ElseStartPos, (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
                else:\r
                    self.__WipeOffArea.append((IfList[-1][0], ElseStartPos))\r
                    IfList[-1] = [ElseStartPos, True, IfList[-1][2]]\r
                    if self.__Token == '!elseif':\r
                        Expression = self.__GetExpression()\r
                        ConditionSatisfied = self.__EvaluateConditional(Expression, IfList[-1][0][0] + 1, 'eval')\r
                        IfList[-1] = [IfList[-1][0], ConditionSatisfied, IfList[-1][2]]\r
\r
                    if IfList[-1][1]:\r
                        if IfList[-1][2]:\r
                            IfList[-1][1] = False\r
                        else:\r
                            IfList[-1][2] = True\r
                            self.__WipeOffArea.append((IfList[-1][0], (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
            elif self.__Token == '!endif':\r
                if len(IfList) <= 0:\r
                    raise Warning("Missing !if statement", self.FileName, self.CurrentLineNumber)\r
                if IfList[-1][1]:\r
                    self.__WipeOffArea.append(((self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - len('!endif')), (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
                else:\r
                    self.__WipeOffArea.append((IfList[-1][0], (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
\r
                IfList.pop()\r
            elif not IfList:    # Don't use PCDs inside conditional directive\r
                if self.CurrentLineNumber <= RegionLayoutLine:\r
                    # Don't try the same line twice\r
                    continue\r
                SetPcd = ShortcutPcdPattern.match(self.Profile.FileLinesList[self.CurrentLineNumber - 1])\r
                if SetPcd:\r
                    self.__PcdDict[SetPcd.group('name')] = SetPcd.group('value')\r
                    RegionLayoutLine = self.CurrentLineNumber\r
                    continue\r
                RegionSize = RegionSizePattern.match(self.Profile.FileLinesList[self.CurrentLineNumber - 1])\r
                if not RegionSize:\r
                    RegionLayoutLine = self.CurrentLineNumber\r
                    continue\r
                RegionSizeGuid = RegionSizeGuidPattern.match(self.Profile.FileLinesList[self.CurrentLineNumber])\r
                if not RegionSizeGuid:\r
                    RegionLayoutLine = self.CurrentLineNumber + 1\r
                    continue\r
                self.__PcdDict[RegionSizeGuid.group('base')] = RegionSize.group('base')\r
                self.__PcdDict[RegionSizeGuid.group('size')] = RegionSize.group('size')\r
                RegionLayoutLine = self.CurrentLineNumber + 1\r
\r
        if IfList:\r
            raise Warning("Missing !endif", self.FileName, self.CurrentLineNumber)\r
        self.Rewind()\r
\r
    def __CollectMacroPcd(self):\r
        MacroDict = {}\r
\r
        # PCD macro\r
        MacroDict.update(GlobalData.gPlatformPcds)\r
        MacroDict.update(self.__PcdDict)\r
\r
        # Lowest priority\r
        MacroDict.update(GlobalData.gPlatformDefines)\r
\r
        if self.__CurSection:\r
            # Defines macro\r
            ScopeMacro = self.__MacroDict['COMMON', 'COMMON', 'COMMON']\r
            if ScopeMacro:\r
                MacroDict.update(ScopeMacro)\r
    \r
            # Section macro\r
            ScopeMacro = self.__MacroDict[\r
                        self.__CurSection[0],\r
                        self.__CurSection[1],\r
                        self.__CurSection[2]\r
            ]\r
            if ScopeMacro:\r
                MacroDict.update(ScopeMacro)\r
\r
        MacroDict.update(GlobalData.gGlobalDefines)\r
        MacroDict.update(GlobalData.gCommandLineDefines)\r
        # Highest priority\r
\r
        return MacroDict\r
\r
    def __EvaluateConditional(self, Expression, Line, Op = None, Value = None):\r
        FileLineTuple = GetRealFileLine(self.FileName, Line)\r
        MacroPcdDict = self.__CollectMacroPcd()\r
        if Op == 'eval':\r
            try:\r
                if Value:\r
                    return ValueExpression(Expression, MacroPcdDict)(True)\r
                else:\r
                    return ValueExpression(Expression, MacroPcdDict)()\r
            except WrnExpression, 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.FileName, ExtraData=self.__CurrentLine(), \r
                                Line=Line)\r
                return Excpt.result\r
            except Exception, Excpt:\r
                if hasattr(Excpt, 'Pcd'):\r
                    if Excpt.Pcd in GlobalData.gPlatformOtherPcds:\r
                        Info = GlobalData.gPlatformOtherPcds[Excpt.Pcd]\r
                        raise Warning("Cannot use this PCD (%s) in an expression as"\r
                                      " it must be defined in a [PcdsFixedAtBuild] or [PcdsFeatureFlag] section"\r
                                      " of the DSC file (%s), and it is currently defined in this section:"\r
                                      " %s, line #: %d." % (Excpt.Pcd, GlobalData.gPlatformOtherPcds['DSCFILE'], Info[0], Info[1]),\r
                                      *FileLineTuple)\r
                    else:\r
                        raise Warning("PCD (%s) is not defined in DSC file (%s)" % (Excpt.Pcd, GlobalData.gPlatformOtherPcds['DSCFILE']),\r
                                      *FileLineTuple)\r
                else:\r
                    raise Warning(str(Excpt), *FileLineTuple)\r
        else:\r
            if Expression.startswith('$(') and Expression[-1] == ')':\r
                Expression = Expression[2:-1]            \r
            return Expression in MacroPcdDict\r
\r
    ## __IsToken() method\r
    #\r
    #   Check whether input string is found from current char position along\r
    #   If found, the string value is put into self.__Token\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  String      The string to search\r
    #   @param  IgnoreCase  Indicate case sensitive/non-sensitive search, default is case sensitive\r
    #   @retval True        Successfully find string, file buffer pointer moved forward\r
    #   @retval False       Not able to find string, file buffer pointer not changed\r
    #\r
    def __IsToken(self, String, IgnoreCase = False):\r
        self.__SkipWhiteSpace()\r
\r
        # Only consider the same line, no multi-line token allowed\r
        StartPos = self.CurrentOffsetWithinLine\r
        index = -1\r
        if IgnoreCase:\r
            index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].upper().find(String.upper())\r
        else:\r
            index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].find(String)\r
        if index == 0:\r
            self.CurrentOffsetWithinLine += len(String)\r
            self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]\r
            return True\r
        return False\r
\r
    ## __IsKeyword() method\r
    #\r
    #   Check whether input keyword is found from current char position along, whole word only!\r
    #   If found, the string value is put into self.__Token\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Keyword     The string to search\r
    #   @param  IgnoreCase  Indicate case sensitive/non-sensitive search, default is case sensitive\r
    #   @retval True        Successfully find string, file buffer pointer moved forward\r
    #   @retval False       Not able to find string, file buffer pointer not changed\r
    #\r
    def __IsKeyword(self, KeyWord, IgnoreCase = False):\r
        self.__SkipWhiteSpace()\r
\r
        # Only consider the same line, no multi-line token allowed\r
        StartPos = self.CurrentOffsetWithinLine\r
        index = -1\r
        if IgnoreCase:\r
            index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].upper().find(KeyWord.upper())\r
        else:\r
            index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].find(KeyWord)\r
        if index == 0:\r
            followingChar = self.__CurrentLine()[self.CurrentOffsetWithinLine + len(KeyWord)]\r
            if not str(followingChar).isspace() and followingChar not in SEPERATOR_TUPLE:\r
                return False\r
            self.CurrentOffsetWithinLine += len(KeyWord)\r
            self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]\r
            return True\r
        return False\r
\r
    def __GetExpression(self):\r
        Line = self.Profile.FileLinesList[self.CurrentLineNumber - 1]\r
        Index = len(Line) - 1\r
        while Line[Index] in ['\r', '\n']:\r
            Index -= 1\r
        ExpressionString = self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine:Index+1]\r
        self.CurrentOffsetWithinLine += len(ExpressionString)\r
        ExpressionString = ExpressionString.strip()\r
        return ExpressionString\r
\r
    ## __GetNextWord() method\r
    #\r
    #   Get next C name from file lines\r
    #   If found, the string value is put into self.__Token\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a C name string, file buffer pointer moved forward\r
    #   @retval False       Not able to find a C name string, file buffer pointer not changed\r
    #\r
    def __GetNextWord(self):\r
        self.__SkipWhiteSpace()\r
        if self.__EndOfFile():\r
            return False\r
\r
        TempChar = self.__CurrentChar()\r
        StartPos = self.CurrentOffsetWithinLine\r
        if (TempChar >= 'a' and TempChar <= 'z') or (TempChar >= 'A' and TempChar <= 'Z') or TempChar == '_':\r
            self.__GetOneChar()\r
            while not self.__EndOfLine():\r
                TempChar = self.__CurrentChar()\r
                if (TempChar >= 'a' and TempChar <= 'z') or (TempChar >= 'A' and TempChar <= 'Z') \\r
                or (TempChar >= '0' and TempChar <= '9') or TempChar == '_' or TempChar == '-':\r
                    self.__GetOneChar()\r
\r
                else:\r
                    break\r
\r
            self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]\r
            return True\r
\r
        return False\r
\r
    ## __GetNextToken() method\r
    #\r
    #   Get next token unit before a seperator\r
    #   If found, the string value is put into self.__Token\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a token unit, file buffer pointer moved forward\r
    #   @retval False       Not able to find a token unit, file buffer pointer not changed\r
    #\r
    def __GetNextToken(self):\r
        # Skip leading spaces, if exist.\r
        self.__SkipWhiteSpace()\r
        if self.__EndOfFile():\r
            return False\r
        # Record the token start position, the position of the first non-space char.\r
        StartPos = self.CurrentOffsetWithinLine\r
        StartLine = self.CurrentLineNumber\r
        while StartLine == self.CurrentLineNumber:\r
            TempChar = self.__CurrentChar()\r
            # Try to find the end char that is not a space and not in seperator tuple.\r
            # That is, when we got a space or any char in the tuple, we got the end of token.\r
            if not str(TempChar).isspace() and TempChar not in SEPERATOR_TUPLE:\r
                self.__GetOneChar()\r
            # if we happen to meet a seperator as the first char, we must proceed to get it.\r
            # That is, we get a token that is a seperator char. nomally it is the boundary of other tokens.\r
            elif StartPos == self.CurrentOffsetWithinLine and TempChar in SEPERATOR_TUPLE:\r
                self.__GetOneChar()\r
                break\r
            else:\r
                break\r
#        else:\r
#            return False\r
\r
        EndPos = self.CurrentOffsetWithinLine\r
        if self.CurrentLineNumber != StartLine:\r
            EndPos = len(self.Profile.FileLinesList[StartLine-1])\r
        self.__Token = self.Profile.FileLinesList[StartLine-1][StartPos : EndPos]\r
        if StartPos != self.CurrentOffsetWithinLine:\r
            return True\r
        else:\r
            return False\r
\r
    def __GetNextOp(self):\r
        # Skip leading spaces, if exist.\r
        self.__SkipWhiteSpace()\r
        if self.__EndOfFile():\r
            return False\r
        # Record the token start position, the position of the first non-space char.\r
        StartPos = self.CurrentOffsetWithinLine\r
        while not self.__EndOfLine():\r
            TempChar = self.__CurrentChar()\r
            # Try to find the end char that is not a space\r
            if not str(TempChar).isspace():\r
                self.__GetOneChar()\r
            else:\r
                break\r
        else:\r
            return False\r
\r
        if StartPos != self.CurrentOffsetWithinLine:\r
            self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]\r
            return True\r
        else:\r
            return False\r
    ## __GetNextGuid() method\r
    #\r
    #   Get next token unit before a seperator\r
    #   If found, the GUID string is put into self.__Token\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a registry format GUID, file buffer pointer moved forward\r
    #   @retval False       Not able to find a registry format GUID, file buffer pointer not changed\r
    #\r
    def __GetNextGuid(self):\r
\r
        if not self.__GetNextToken():\r
            return False\r
        p = re.compile('[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}')\r
        if p.match(self.__Token) != None:\r
            return True\r
        else:\r
            self.__UndoToken()\r
            return False\r
\r
    ## __UndoToken() method\r
    #\r
    #   Go back one token unit in file buffer\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __UndoToken(self):\r
        self.__UndoOneChar()\r
        while self.__CurrentChar().isspace():\r
            if not self.__UndoOneChar():\r
                self.__GetOneChar()\r
                return\r
\r
\r
        StartPos = self.CurrentOffsetWithinLine\r
        CurrentLine = self.CurrentLineNumber\r
        while CurrentLine == self.CurrentLineNumber:\r
\r
            TempChar = self.__CurrentChar()\r
            # Try to find the end char that is not a space and not in seperator tuple.\r
            # That is, when we got a space or any char in the tuple, we got the end of token.\r
            if not str(TempChar).isspace() and not TempChar in SEPERATOR_TUPLE:\r
                if not self.__UndoOneChar():\r
                    return\r
            # if we happen to meet a seperator as the first char, we must proceed to get it.\r
            # That is, we get a token that is a seperator char. nomally it is the boundary of other tokens.\r
            elif StartPos == self.CurrentOffsetWithinLine and TempChar in SEPERATOR_TUPLE:\r
                return\r
            else:\r
                break\r
\r
        self.__GetOneChar()\r
\r
    ## __HexDigit() method\r
    #\r
    #   Whether char input is a Hex data bit\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  TempChar    The char to test\r
    #   @retval True        The char is a Hex data bit\r
    #   @retval False       The char is NOT a Hex data bit\r
    #\r
    def __HexDigit(self, TempChar):\r
        if (TempChar >= 'a' and TempChar <= 'f') or (TempChar >= 'A' and TempChar <= 'F') \\r
                or (TempChar >= '0' and TempChar <= '9'):\r
                    return True\r
        else:\r
            return False\r
\r
    def __IsHex(self, HexStr):\r
        if not HexStr.upper().startswith("0X"):\r
            return False\r
        if len(self.__Token) <= 2:\r
            return False\r
        charList = [c for c in HexStr[2 : ] if not self.__HexDigit( c)]\r
        if len(charList) == 0:\r
            return True\r
        else:\r
            return False\r
    ## __GetNextHexNumber() method\r
    #\r
    #   Get next HEX data before a seperator\r
    #   If found, the HEX data is put into self.__Token\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a HEX data, file buffer pointer moved forward\r
    #   @retval False       Not able to find a HEX data, file buffer pointer not changed\r
    #\r
    def __GetNextHexNumber(self):\r
        if not self.__GetNextToken():\r
            return False\r
        if self.__IsHex(self.__Token):\r
            return True\r
        else:\r
            self.__UndoToken()\r
            return False\r
\r
    ## __GetNextDecimalNumber() method\r
    #\r
    #   Get next decimal data before a seperator\r
    #   If found, the decimal data is put into self.__Token\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a decimal data, file buffer pointer moved forward\r
    #   @retval False       Not able to find a decimal data, file buffer pointer not changed\r
    #\r
    def __GetNextDecimalNumber(self):\r
        if not self.__GetNextToken():\r
            return False\r
        if self.__Token.isdigit():\r
            return True\r
        else:\r
            self.__UndoToken()\r
            return False\r
\r
    ## __GetNextPcdName() method\r
    #\r
    #   Get next PCD token space C name and PCD C name pair before a seperator\r
    #   If found, the decimal data is put into self.__Token\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval Tuple       PCD C name and PCD token space C name pair\r
    #\r
    def __GetNextPcdName(self):\r
        if not self.__GetNextWord():\r
            raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)\r
        pcdTokenSpaceCName = self.__Token\r
\r
        if not self.__IsToken( "."):\r
            raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextWord():\r
            raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)\r
        pcdCName = self.__Token\r
\r
        return (pcdCName, pcdTokenSpaceCName)\r
\r
    ## __GetStringData() method\r
    #\r
    #   Get string contents quoted in ""\r
    #   If found, the decimal data is put into self.__Token\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a string data, file buffer pointer moved forward\r
    #   @retval False       Not able to find a string data, file buffer pointer not changed\r
    #\r
    def __GetStringData(self):\r
        if self.__Token.startswith("\"") or self.__Token.startswith("L\""):\r
            self.__UndoToken()\r
            self.__SkipToToken("\"")\r
            currentLineNumber = self.CurrentLineNumber\r
\r
            if not self.__SkipToToken("\""):\r
                raise Warning("Missing Quote \" for String", self.FileName, self.CurrentLineNumber)\r
            if currentLineNumber != self.CurrentLineNumber:\r
                raise Warning("Missing Quote \" for String", self.FileName, self.CurrentLineNumber)\r
            self.__Token = self.__SkippedChars.rstrip('\"')\r
            return True\r
\r
        elif self.__Token.startswith("\'") or self.__Token.startswith("L\'"):\r
            self.__UndoToken()\r
            self.__SkipToToken("\'")\r
            currentLineNumber = self.CurrentLineNumber\r
\r
            if not self.__SkipToToken("\'"):\r
                raise Warning("Missing Quote \' for String", self.FileName, self.CurrentLineNumber)\r
            if currentLineNumber != self.CurrentLineNumber:\r
                raise Warning("Missing Quote \' for String", self.FileName, self.CurrentLineNumber)\r
            self.__Token = self.__SkippedChars.rstrip('\'')\r
            return True\r
\r
        else:\r
            return False\r
\r
    ## __SkipToToken() method\r
    #\r
    #   Search forward in file buffer for the string\r
    #   The skipped chars are put into self.__SkippedChars\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  String      The string to search\r
    #   @param  IgnoreCase  Indicate case sensitive/non-sensitive search, default is case sensitive\r
    #   @retval True        Successfully find the string, file buffer pointer moved forward\r
    #   @retval False       Not able to find the string, file buffer pointer not changed\r
    #\r
    def __SkipToToken(self, String, IgnoreCase = False):\r
        StartPos = self.GetFileBufferPos()\r
\r
        self.__SkippedChars = ""\r
        while not self.__EndOfFile():\r
            index = -1\r
            if IgnoreCase:\r
                index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].upper().find(String.upper())\r
            else:\r
                index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].find(String)\r
            if index == 0:\r
                self.CurrentOffsetWithinLine += len(String)\r
                self.__SkippedChars += String\r
                return True\r
            self.__SkippedChars += str(self.__CurrentChar())\r
            self.__GetOneChar()\r
\r
        self.SetFileBufferPos( StartPos)\r
        self.__SkippedChars = ""\r
        return False\r
\r
    ## GetFileBufferPos() method\r
    #\r
    #   Return the tuple of current line and offset within the line\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval Tuple       Line number and offset pair\r
    #\r
    def GetFileBufferPos(self):\r
        return (self.CurrentLineNumber, self.CurrentOffsetWithinLine)\r
\r
    ## SetFileBufferPos() method\r
    #\r
    #   Restore the file buffer position\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Pos         The new file buffer position\r
    #\r
    def SetFileBufferPos(self, Pos):\r
        (self.CurrentLineNumber, self.CurrentOffsetWithinLine) = Pos\r
\r
    ## Preprocess() method\r
    #\r
    #   Preprocess comment, conditional directive, include directive, replace macro.\r
    #   Exception will be raised if syntax error found\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def Preprocess(self):\r
        self.__StringToList()\r
        self.PreprocessFile()\r
        self.PreprocessIncludeFile()\r
        self.__StringToList()\r
        self.PreprocessFile()\r
        self.PreprocessConditionalStatement()\r
        self.__StringToList()\r
        for Pos in self.__WipeOffArea:\r
            self.__ReplaceFragment(Pos[0], Pos[1])\r
        self.Profile.FileLinesList = ["".join(list) for list in self.Profile.FileLinesList]\r
\r
        while self.__GetDefines():\r
            pass\r
\r
    ## ParseFile() method\r
    #\r
    #   Parse the file profile buffer to extract fd, fv ... information\r
    #   Exception will be raised if syntax error found\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def ParseFile(self):\r
\r
        try:\r
            self.Preprocess()\r
            while self.__GetFd():\r
                pass\r
\r
            while self.__GetFv():\r
                pass\r
\r
            while self.__GetCapsule():\r
                pass\r
\r
            while self.__GetVtf():\r
                pass\r
\r
            while self.__GetRule():\r
                pass\r
            \r
            while self.__GetOptionRom():\r
                pass\r
\r
        except Warning, X:\r
            self.__UndoToken()\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            #'\n\tGot Token: \"%s\" from File %s\n' % (self.__Token, FileLineTuple[0]) + \\r
            X.Message += ' near line %d, column %d: %s' \\r
                % (FileLineTuple[1], self.CurrentOffsetWithinLine + 1, self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :].rstrip('\n').rstrip('\r'))\r
            raise\r
\r
    ## __GetDefines() method\r
    #\r
    #   Get Defines section contents and store its data into AllMacrosList\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a Defines\r
    #   @retval False       Not able to find a Defines\r
    #\r
    def __GetDefines(self):\r
\r
        if not self.__GetNextToken():\r
            return False\r
\r
        S = self.__Token.upper()\r
        if S.startswith("[") and not S.startswith("[DEFINES"):\r
            if not S.startswith("[FD.") and not S.startswith("[FV.") and not S.startswith("[CAPSULE.") \\r
                and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):\r
                raise Warning("Unknown section or section appear sequence error (The correct sequence should be [DEFINES], [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)\r
            self.__UndoToken()\r
            return False\r
\r
        self.__UndoToken()\r
        if not self.__IsToken("[DEFINES", True):\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
            #        % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
            raise Warning("expected [DEFINES", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken( "]"):\r
            raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
\r
        while self.__GetNextWord():\r
            # handle the SET statement\r
            if self.__Token == 'SET':\r
                self.__UndoToken()\r
                self.__GetSetStatement(None)\r
                continue\r
            \r
            Macro = self.__Token\r
            \r
            if not self.__IsToken("="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken() or self.__Token.startswith('['):\r
                raise Warning("expected MACRO value", self.FileName, self.CurrentLineNumber)\r
            Value = self.__Token\r
\r
        return False\r
\r
    ## __GetFd() method\r
    #\r
    #   Get FD section contents and store its data into FD dictionary of self.Profile\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a FD\r
    #   @retval False       Not able to find a FD\r
    #\r
    def __GetFd(self):\r
\r
        if not self.__GetNextToken():\r
            return False\r
\r
        S = self.__Token.upper()\r
        if S.startswith("[") and not S.startswith("[FD."):\r
            if not S.startswith("[FV.") and not S.startswith("[CAPSULE.") \\r
                and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):\r
                raise Warning("Unknown section", self.FileName, self.CurrentLineNumber)\r
            self.__UndoToken()\r
            return False\r
\r
        self.__UndoToken()\r
        if not self.__IsToken("[FD.", True):\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
            #        % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
            raise Warning("expected [FD.]", self.FileName, self.CurrentLineNumber)\r
\r
        FdName = self.__GetUiName()\r
        if FdName == "":\r
            if len (self.Profile.FdDict) == 0:\r
                FdName = GenFdsGlobalVariable.PlatformName\r
                if FdName == "" and GlobalData.gActivePlatform:\r
                    FdName = GlobalData.gActivePlatform.PlatformName\r
                self.Profile.FdNameNotSet = True\r
            else:\r
                raise Warning("expected FdName in [FD.] section", self.FileName, self.CurrentLineNumber)\r
        self.CurrentFdName = FdName.upper()\r
        \r
        if self.CurrentFdName in self.Profile.FdDict:\r
            raise Warning("Unexpected the same FD name", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken( "]"):\r
            raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
\r
        FdObj = Fd.FD()\r
        FdObj.FdUiName = self.CurrentFdName\r
        self.Profile.FdDict[self.CurrentFdName] = FdObj\r
\r
        if len (self.Profile.FdDict) > 1 and self.Profile.FdNameNotSet:\r
            raise Warning("expected all FDs have their name", self.FileName, self.CurrentLineNumber)\r
\r
        Status = self.__GetCreateFile(FdObj)\r
        if not Status:\r
            raise Warning("FD name error", self.FileName, self.CurrentLineNumber)\r
\r
        while self.__GetTokenStatements(FdObj):\r
            pass\r
        for Attr in ("BaseAddress", "Size", "ErasePolarity"):\r
            if getattr(FdObj, Attr) == None:\r
                self.__GetNextToken()\r
                raise Warning("Keyword %s missing" % Attr, self.FileName, self.CurrentLineNumber)\r
\r
        if not FdObj.BlockSizeList:\r
            FdObj.BlockSizeList.append((1, FdObj.Size, None))\r
\r
        self.__GetDefineStatements(FdObj)\r
\r
        self.__GetSetStatements(FdObj)\r
\r
        if not self.__GetRegionLayout(FdObj):\r
            raise Warning("expected region layout", self.FileName, self.CurrentLineNumber)\r
\r
        while self.__GetRegionLayout(FdObj):\r
            pass\r
        return True\r
\r
    ## __GetUiName() method\r
    #\r
    #   Return the UI name of a section\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval FdName      UI name\r
    #\r
    def __GetUiName(self):\r
        Name = ""\r
        if self.__GetNextWord():\r
            Name = self.__Token\r
\r
        return Name\r
\r
    ## __GetCreateFile() method\r
    #\r
    #   Return the output file name of object\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         object whose data will be stored in file\r
    #   @retval FdName      UI name\r
    #\r
    def __GetCreateFile(self, Obj):\r
\r
        if self.__IsKeyword( "CREATE_FILE"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected file name", self.FileName, self.CurrentLineNumber)\r
\r
            FileName = self.__Token\r
            Obj.CreateFileName = FileName\r
\r
        return True\r
\r
    ## __GetTokenStatements() method\r
    #\r
    #   Get token statements\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom token statement is got\r
    #\r
    def __GetTokenStatements(self, Obj):\r
        if self.__IsKeyword( "BaseAddress"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
    \r
            if not self.__GetNextHexNumber():\r
                raise Warning("expected Hex base address", self.FileName, self.CurrentLineNumber)\r
    \r
            Obj.BaseAddress = self.__Token\r
    \r
            if self.__IsToken( "|"):\r
                pcdPair = self.__GetNextPcdName()\r
                Obj.BaseAddressPcd = pcdPair\r
                self.Profile.PcdDict[pcdPair] = Obj.BaseAddress\r
                FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
                self.Profile.PcdFileLineDict[pcdPair] = FileLineTuple\r
            return True\r
\r
        if self.__IsKeyword( "Size"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
    \r
            if not self.__GetNextHexNumber():\r
                raise Warning("expected Hex size", self.FileName, self.CurrentLineNumber)\r
\r
            Size = self.__Token\r
            if self.__IsToken( "|"):\r
                pcdPair = self.__GetNextPcdName()\r
                Obj.SizePcd = pcdPair\r
                self.Profile.PcdDict[pcdPair] = Size\r
                FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
                self.Profile.PcdFileLineDict[pcdPair] = FileLineTuple\r
            Obj.Size = long(Size, 0)\r
            return True\r
\r
        if self.__IsKeyword( "ErasePolarity"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
    \r
            if not self.__GetNextToken():\r
                raise Warning("expected Erase Polarity", self.FileName, self.CurrentLineNumber)\r
    \r
            if self.__Token != "1" and self.__Token != "0":\r
                raise Warning("expected 1 or 0 Erase Polarity", self.FileName, self.CurrentLineNumber)\r
    \r
            Obj.ErasePolarity = self.__Token\r
            return True\r
\r
        return self.__GetBlockStatements(Obj)\r
\r
    ## __GetAddressStatements() method\r
    #\r
    #   Get address statements\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom address statement is got\r
    #   @retval True        Successfully find\r
    #   @retval False       Not able to find\r
    #\r
    def __GetAddressStatements(self, Obj):\r
\r
        if self.__IsKeyword("BsBaseAddress"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextDecimalNumber() and not self.__GetNextHexNumber():\r
                raise Warning("expected address", self.FileName, self.CurrentLineNumber)\r
\r
            BsAddress = long(self.__Token, 0)\r
            Obj.BsBaseAddress = BsAddress\r
\r
        if self.__IsKeyword("RtBaseAddress"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextDecimalNumber() and not self.__GetNextHexNumber():\r
                raise Warning("expected address", self.FileName, self.CurrentLineNumber)\r
\r
            RtAddress = long(self.__Token, 0)\r
            Obj.RtBaseAddress = RtAddress\r
\r
    ## __GetBlockStatements() method\r
    #\r
    #   Get block statements\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom block statement is got\r
    #\r
    def __GetBlockStatements(self, Obj):\r
        IsBlock = False\r
        while self.__GetBlockStatement(Obj):\r
            IsBlock = True\r
        \r
            Item = Obj.BlockSizeList[-1]\r
            if Item[0] == None or Item[1] == None:\r
                raise Warning("expected block statement", self.FileName, self.CurrentLineNumber)\r
        return IsBlock\r
\r
    ## __GetBlockStatement() method\r
    #\r
    #   Get block statement\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom block statement is got\r
    #   @retval True        Successfully find\r
    #   @retval False       Not able to find\r
    #\r
    def __GetBlockStatement(self, Obj):\r
        if not self.__IsKeyword( "BlockSize"):\r
            return False\r
\r
        if not self.__IsToken( "="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextHexNumber() and not self.__GetNextDecimalNumber():\r
            raise Warning("expected Hex or Integer block size", self.FileName, self.CurrentLineNumber)\r
\r
        BlockSize = self.__Token\r
        BlockSizePcd = None\r
        if self.__IsToken( "|"):\r
            PcdPair = self.__GetNextPcdName()\r
            BlockSizePcd = PcdPair\r
            self.Profile.PcdDict[PcdPair] = BlockSize\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            self.Profile.PcdFileLineDict[PcdPair] = FileLineTuple\r
        BlockSize = long(BlockSize, 0)\r
\r
        BlockNumber = None\r
        if self.__IsKeyword( "NumBlocks"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextDecimalNumber() and not self.__GetNextHexNumber():\r
                raise Warning("expected block numbers", self.FileName, self.CurrentLineNumber)\r
\r
            BlockNumber = long(self.__Token, 0)\r
\r
        Obj.BlockSizeList.append((BlockSize, BlockNumber, BlockSizePcd))\r
        return True\r
\r
    ## __GetDefineStatements() method\r
    #\r
    #   Get define statements\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom define statement is got\r
    #   @retval True        Successfully find\r
    #   @retval False       Not able to find\r
    #\r
    def __GetDefineStatements(self, Obj):\r
        while self.__GetDefineStatement( Obj):\r
            pass\r
\r
    ## __GetDefineStatement() method\r
    #\r
    #   Get define statement\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom define statement is got\r
    #   @retval True        Successfully find\r
    #   @retval False       Not able to find\r
    #\r
    def __GetDefineStatement(self, Obj):\r
        if self.__IsKeyword("DEFINE"):\r
            self.__GetNextToken()\r
            Macro = self.__Token\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected value", self.FileName, self.CurrentLineNumber)\r
\r
            Value = self.__Token\r
            Macro = '$(' + Macro + ')'\r
            Obj.DefineVarDict[Macro] = Value\r
            return True\r
\r
        return False\r
\r
    ## __GetSetStatements() method\r
    #\r
    #   Get set statements\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom set statement is got\r
    #   @retval True        Successfully find\r
    #   @retval False       Not able to find\r
    #\r
    def __GetSetStatements(self, Obj):\r
        while self.__GetSetStatement(Obj):\r
            pass\r
\r
    ## __GetSetStatement() method\r
    #\r
    #   Get set statement\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom set statement is got\r
    #   @retval True        Successfully find\r
    #   @retval False       Not able to find\r
    #\r
    def __GetSetStatement(self, Obj):\r
        if self.__IsKeyword("SET"):\r
            PcdPair = self.__GetNextPcdName()\r
\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            Value = self.__GetExpression()\r
            Value = self.__EvaluateConditional(Value, self.CurrentLineNumber, 'eval', True)\r
\r
            if Obj:\r
                Obj.SetVarDict[PcdPair] = Value\r
            self.Profile.PcdDict[PcdPair] = Value\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            self.Profile.PcdFileLineDict[PcdPair] = FileLineTuple\r
            return True\r
\r
        return False\r
\r
    ## __CalcRegionExpr(self)\r
    #\r
    #   Calculate expression for offset or size of a region\r
    #\r
    #   @return: None if invalid expression\r
    #            Calculated number if successfully\r
    #\r
    def __CalcRegionExpr(self):\r
        StartPos = self.GetFileBufferPos()\r
        Expr = ''\r
        PairCount = 0\r
        while not self.__EndOfFile():\r
            CurCh = self.__CurrentChar()\r
            if CurCh == '(':\r
                PairCount += 1\r
            elif CurCh == ')':\r
                PairCount -= 1\r
\r
            if CurCh in '|\r\n' and PairCount == 0:\r
                break\r
            Expr += CurCh\r
            self.__GetOneChar()\r
        try:\r
            return long(\r
                ValueExpression(Expr,\r
                                self.__CollectMacroPcd()\r
                                )(True),0)\r
        except Exception:\r
            self.SetFileBufferPos(StartPos)\r
            return None\r
\r
    ## __GetRegionLayout() method\r
    #\r
    #   Get region layout for FD\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Fd          for whom region is got\r
    #   @retval True        Successfully find\r
    #   @retval False       Not able to find\r
    #\r
    def __GetRegionLayout(self, Fd):\r
        Offset = self.__CalcRegionExpr() \r
        if Offset == None:\r
            return False\r
\r
        RegionObj = Region.Region()\r
        RegionObj.Offset = Offset\r
        Fd.RegionList.append(RegionObj)\r
\r
        if not self.__IsToken( "|"):\r
            raise Warning("expected '|'", self.FileName, self.CurrentLineNumber)\r
\r
        Size = self.__CalcRegionExpr()\r
        if Size == None:\r
            raise Warning("expected Region Size", self.FileName, self.CurrentLineNumber)\r
        RegionObj.Size = Size\r
\r
        if not self.__GetNextWord():\r
            return True\r
\r
        if not self.__Token in ("SET", "FV", "FILE", "DATA", "CAPSULE"):\r
            #\r
            # If next token is a word which is not a valid FV type, it might be part of [PcdOffset[|PcdSize]]\r
            # Or it might be next region's offset described by an expression which starts with a PCD.\r
            #    PcdOffset[|PcdSize] or OffsetPcdExpression|Size\r
            #\r
            self.__UndoToken()\r
            IsRegionPcd = (RegionSizeGuidPattern.match(self.__CurrentLine()[self.CurrentOffsetWithinLine:]) or\r
                           RegionOffsetPcdPattern.match(self.__CurrentLine()[self.CurrentOffsetWithinLine:]))\r
            if IsRegionPcd:\r
                RegionObj.PcdOffset = self.__GetNextPcdName()\r
                self.Profile.PcdDict[RegionObj.PcdOffset] = "0x%08X" % (RegionObj.Offset + long(Fd.BaseAddress, 0))\r
                self.__PcdDict['%s.%s' % (RegionObj.PcdOffset[1], RegionObj.PcdOffset[0])] = "0x%x" % RegionObj.Offset\r
                FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
                self.Profile.PcdFileLineDict[RegionObj.PcdOffset] = FileLineTuple\r
                if self.__IsToken( "|"):\r
                    RegionObj.PcdSize = self.__GetNextPcdName()\r
                    self.Profile.PcdDict[RegionObj.PcdSize] = "0x%08X" % RegionObj.Size\r
                    self.__PcdDict['%s.%s' % (RegionObj.PcdSize[1], RegionObj.PcdSize[0])] = "0x%x" % RegionObj.Size\r
                    FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
                    self.Profile.PcdFileLineDict[RegionObj.PcdSize] = FileLineTuple\r
\r
            if not self.__GetNextWord():\r
                return True\r
\r
        if self.__Token == "SET":\r
            self.__UndoToken()\r
            self.__GetSetStatements( RegionObj)\r
            if not self.__GetNextWord():\r
                return True\r
\r
        elif self.__Token == "FV":\r
            self.__UndoToken()\r
            self.__GetRegionFvType( RegionObj)\r
\r
        elif self.__Token == "CAPSULE":\r
            self.__UndoToken()\r
            self.__GetRegionCapType( RegionObj)\r
\r
        elif self.__Token == "FILE":\r
            self.__UndoToken()\r
            self.__GetRegionFileType( RegionObj)\r
\r
        elif self.__Token == "DATA":\r
            self.__UndoToken()\r
            self.__GetRegionDataType( RegionObj)\r
        else:\r
            self.__UndoToken()\r
            if self.__GetRegionLayout(Fd):\r
                return True\r
            raise Warning("A valid region type was not found. "\r
                          "Valid types are [SET, FV, CAPSULE, FILE, DATA]. This error occurred",\r
                          self.FileName, self.CurrentLineNumber)\r
\r
        return True\r
\r
    ## __GetRegionFvType() method\r
    #\r
    #   Get region fv data for region\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  RegionObj   for whom region data is got\r
    #\r
    def __GetRegionFvType(self, RegionObj):\r
\r
        if not self.__IsKeyword( "FV"):\r
            raise Warning("expected Keyword 'FV'", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken( "="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)\r
\r
        RegionObj.RegionType = "FV"\r
        RegionObj.RegionDataList.append(self.__Token)\r
\r
        while self.__IsKeyword( "FV"):\r
\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)\r
\r
            RegionObj.RegionDataList.append(self.__Token)\r
\r
    ## __GetRegionCapType() method\r
    #\r
    #   Get region capsule data for region\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  RegionObj   for whom region data is got\r
    #\r
    def __GetRegionCapType(self, RegionObj):\r
\r
        if not self.__IsKeyword("CAPSULE"):\r
            raise Warning("expected Keyword 'CAPSULE'", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected CAPSULE name", self.FileName, self.CurrentLineNumber)\r
\r
        RegionObj.RegionType = "CAPSULE"\r
        RegionObj.RegionDataList.append(self.__Token)\r
\r
        while self.__IsKeyword("CAPSULE"):\r
\r
            if not self.__IsToken("="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected CAPSULE name", self.FileName, self.CurrentLineNumber)\r
\r
            RegionObj.RegionDataList.append(self.__Token)\r
\r
    ## __GetRegionFileType() method\r
    #\r
    #   Get region file data for region\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  RegionObj   for whom region data is got\r
    #\r
    def __GetRegionFileType(self, RegionObj):\r
\r
        if not self.__IsKeyword( "FILE"):\r
            raise Warning("expected Keyword 'FILE'", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken( "="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected File name", self.FileName, self.CurrentLineNumber)\r
\r
        RegionObj.RegionType = "FILE"\r
        RegionObj.RegionDataList.append( self.__Token)\r
\r
        while self.__IsKeyword( "FILE"):\r
\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected FILE name", self.FileName, self.CurrentLineNumber)\r
\r
            RegionObj.RegionDataList.append(self.__Token)\r
\r
    ## __GetRegionDataType() method\r
    #\r
    #   Get region array data for region\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  RegionObj   for whom region data is got\r
    #\r
    def __GetRegionDataType(self, RegionObj):\r
\r
        if not self.__IsKeyword( "DATA"):\r
            raise Warning("expected Region Data type", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken( "="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken( "{"):\r
            raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextHexNumber():\r
            raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)\r
\r
        if len(self.__Token) > 18:\r
            raise Warning("Hex string can't be converted to a valid UINT64 value", self.FileName, self.CurrentLineNumber)\r
\r
        # convert hex string value to byte hex string array\r
        AllString = self.__Token\r
        AllStrLen = len (AllString)\r
        DataString = ""\r
        while AllStrLen > 4:\r
            DataString = DataString + "0x" + AllString[AllStrLen - 2: AllStrLen] + ","\r
            AllStrLen  = AllStrLen - 2\r
        DataString = DataString + AllString[:AllStrLen] + ","\r
\r
        # byte value array\r
        if len (self.__Token) <= 4:\r
            while self.__IsToken(","):\r
                if not self.__GetNextHexNumber():\r
                    raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)\r
                if len(self.__Token) > 4:\r
                    raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
                DataString += self.__Token\r
                DataString += ","\r
\r
        if not self.__IsToken( "}"):\r
            raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
\r
        DataString = DataString.rstrip(",")\r
        RegionObj.RegionType = "DATA"\r
        RegionObj.RegionDataList.append( DataString)\r
\r
        while self.__IsKeyword( "DATA"):\r
\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__IsToken( "{"):\r
                raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextHexNumber():\r
                raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)\r
\r
            if len(self.__Token) > 18:\r
                raise Warning("Hex string can't be converted to a valid UINT64 value", self.FileName, self.CurrentLineNumber)\r
\r
            # convert hex string value to byte hex string array\r
            AllString = self.__Token\r
            AllStrLen = len (AllString)\r
            DataString = ""\r
            while AllStrLen > 4:\r
                DataString = DataString + "0x" + AllString[AllStrLen - 2: AllStrLen] + ","\r
                AllStrLen  = AllStrLen - 2\r
            DataString = DataString + AllString[:AllStrLen] + ","\r
\r
            # byte value array\r
            if len (self.__Token) <= 4:\r
                while self.__IsToken(","):\r
                    if not self.__GetNextHexNumber():\r
                        raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)\r
                    if len(self.__Token) > 4:\r
                        raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
                    DataString += self.__Token\r
                    DataString += ","\r
\r
            if not self.__IsToken( "}"):\r
                raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
\r
            DataString = DataString.rstrip(",")\r
            RegionObj.RegionDataList.append( DataString)\r
\r
    ## __GetFv() method\r
    #\r
    #   Get FV section contents and store its data into FV dictionary of self.Profile\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a FV\r
    #   @retval False       Not able to find a FV\r
    #\r
    def __GetFv(self):\r
        if not self.__GetNextToken():\r
            return False\r
\r
        S = self.__Token.upper()\r
        if S.startswith("[") and not S.startswith("[FV."):\r
            if not S.startswith("[CAPSULE.") \\r
                and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):\r
                raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)\r
            self.__UndoToken()\r
            return False\r
\r
        self.__UndoToken()\r
        if not self.__IsToken("[FV.", True):\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
            #        % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
            raise Warning("Unknown Keyword '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
\r
        FvName = self.__GetUiName()\r
        self.CurrentFvName = FvName.upper()\r
\r
        if not self.__IsToken( "]"):\r
            raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
\r
        FvObj = Fv.FV()\r
        FvObj.UiFvName = self.CurrentFvName\r
        self.Profile.FvDict[self.CurrentFvName] = FvObj\r
\r
        Status = self.__GetCreateFile(FvObj)\r
        if not Status:\r
            raise Warning("FV name error", self.FileName, self.CurrentLineNumber)\r
\r
        self.__GetDefineStatements(FvObj)\r
\r
        self.__GetAddressStatements(FvObj)\r
\r
        FvObj.FvExtEntryTypeValue = []\r
        FvObj.FvExtEntryType = []\r
        FvObj.FvExtEntryData = []\r
        while True:\r
            self.__GetSetStatements(FvObj)\r
\r
            if not (self.__GetBlockStatement(FvObj) or self.__GetFvBaseAddress(FvObj) or \r
                self.__GetFvForceRebase(FvObj) or self.__GetFvAlignment(FvObj) or \r
                self.__GetFvAttributes(FvObj) or self.__GetFvNameGuid(FvObj) or \r
                self.__GetFvExtEntryStatement(FvObj)):\r
                break\r
\r
        self.__GetAprioriSection(FvObj, FvObj.DefineVarDict.copy())\r
        self.__GetAprioriSection(FvObj, FvObj.DefineVarDict.copy())\r
\r
        while True:\r
            isInf = self.__GetInfStatement(FvObj, MacroDict = FvObj.DefineVarDict.copy())\r
            isFile = self.__GetFileStatement(FvObj, MacroDict = FvObj.DefineVarDict.copy())\r
            if not isInf and not isFile:\r
                break\r
\r
        return True\r
\r
    ## __GetFvAlignment() method\r
    #\r
    #   Get alignment for FV\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom alignment is got\r
    #   @retval True        Successfully find a alignment statement\r
    #   @retval False       Not able to find a alignment statement\r
    #\r
    def __GetFvAlignment(self, Obj):\r
\r
        if not self.__IsKeyword( "FvAlignment"):\r
            return False\r
\r
        if not self.__IsToken( "="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected alignment value", self.FileName, self.CurrentLineNumber)\r
\r
        if self.__Token.upper() not in ("1", "2", "4", "8", "16", "32", "64", "128", "256", "512", \\r
                                        "1K", "2K", "4K", "8K", "16K", "32K", "64K", "128K", "256K", "512K", \\r
                                        "1M", "2M", "4M", "8M", "16M", "32M", "64M", "128M", "256M", "512M", \\r
                                        "1G", "2G"):\r
            raise Warning("Unknown alignment value '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
        Obj.FvAlignment = self.__Token\r
        return True\r
    \r
    ## __GetFvBaseAddress() method\r
    #\r
    #   Get BaseAddress for FV\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom FvBaseAddress is got\r
    #   @retval True        Successfully find a FvBaseAddress statement\r
    #   @retval False       Not able to find a FvBaseAddress statement\r
    #\r
    def __GetFvBaseAddress(self, Obj):\r
\r
        if not self.__IsKeyword("FvBaseAddress"):\r
            return False\r
\r
        if not self.__IsToken( "="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected FV base address value", self.FileName, self.CurrentLineNumber)\r
\r
        IsValidBaseAddrValue = re.compile('^0[x|X][0-9a-fA-F]+')\r
\r
        if not IsValidBaseAddrValue.match(self.__Token.upper()):\r
            raise Warning("Unknown FV base address value '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
        Obj.FvBaseAddress = self.__Token\r
        return True  \r
      \r
    ## __GetFvForceRebase() method\r
    #\r
    #   Get FvForceRebase for FV\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom FvForceRebase is got\r
    #   @retval True        Successfully find a FvForceRebase statement\r
    #   @retval False       Not able to find a FvForceRebase statement\r
    #\r
    def __GetFvForceRebase(self, Obj):\r
\r
        if not self.__IsKeyword("FvForceRebase"):\r
            return False\r
\r
        if not self.__IsToken( "="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected FvForceRebase value", self.FileName, self.CurrentLineNumber)\r
\r
        if self.__Token.upper() not in ["TRUE", "FALSE", "0", "0X0", "0X00", "1", "0X1", "0X01"]:\r
            raise Warning("Unknown FvForceRebase value '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
        \r
        if self.__Token.upper() in ["TRUE", "1", "0X1", "0X01"]:\r
            Obj.FvForceRebase = True\r
        elif self.__Token.upper() in ["FALSE", "0", "0X0", "0X00"]:\r
            Obj.FvForceRebase = False\r
        else:\r
            Obj.FvForceRebase = None\r
           \r
        return True\r
\r
\r
    ## __GetFvAttributes() method\r
    #\r
    #   Get attributes for FV\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom attribute is got\r
    #   @retval None\r
    #\r
    def __GetFvAttributes(self, FvObj):\r
        IsWordToken = False\r
        while self.__GetNextWord():\r
            IsWordToken = True\r
            name = self.__Token\r
            if name not in ("ERASE_POLARITY", "MEMORY_MAPPED", \\r
                           "STICKY_WRITE", "LOCK_CAP", "LOCK_STATUS", "WRITE_ENABLED_CAP", \\r
                           "WRITE_DISABLED_CAP", "WRITE_STATUS", "READ_ENABLED_CAP", \\r
                           "READ_DISABLED_CAP", "READ_STATUS", "READ_LOCK_CAP", \\r
                           "READ_LOCK_STATUS", "WRITE_LOCK_CAP", "WRITE_LOCK_STATUS", \\r
                           "WRITE_POLICY_RELIABLE", "WEAK_ALIGNMENT"):\r
                self.__UndoToken()\r
                return False\r
\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken() or self.__Token.upper() not in ("TRUE", "FALSE", "1", "0"):\r
                raise Warning("expected TRUE/FALSE (1/0)", self.FileName, self.CurrentLineNumber)\r
\r
            FvObj.FvAttributeDict[name] = self.__Token\r
\r
        return IsWordToken\r
    \r
    ## __GetFvNameGuid() method\r
    #\r
    #   Get FV GUID for FV\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom GUID is got\r
    #   @retval None\r
    #\r
    def __GetFvNameGuid(self, FvObj):\r
\r
        if not self.__IsKeyword( "FvNameGuid"):\r
            return False\r
\r
        if not self.__IsToken( "="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextGuid():\r
            raise Warning("expected FV GUID value", self.FileName, self.CurrentLineNumber)\r
\r
        FvObj.FvNameGuid = self.__Token\r
\r
        return True\r
\r
    def __GetFvExtEntryStatement(self, FvObj):\r
\r
        if not self.__IsKeyword( "FV_EXT_ENTRY"):\r
            return False\r
\r
        if not self.__IsKeyword ("TYPE"):\r
            raise Warning("expected 'TYPE'", self.FileName, self.CurrentLineNumber)\r
            \r
        if not self.__IsToken( "="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextHexNumber() and not self.__GetNextDecimalNumber():\r
            raise Warning("expected Hex FV extension entry type value At Line ", self.FileName, self.CurrentLineNumber)\r
\r
        FvObj.FvExtEntryTypeValue += [self.__Token]\r
\r
        if not self.__IsToken( "{"):\r
            raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsKeyword ("FILE") and not self.__IsKeyword ("DATA"):\r
            raise Warning("expected 'FILE' or 'DATA'", self.FileName, self.CurrentLineNumber)\r
\r
        FvObj.FvExtEntryType += [self.__Token]\r
\r
        if self.__Token == 'DATA':\r
\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
                \r
            if not self.__IsToken( "{"):\r
                raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextHexNumber():\r
                raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)\r
\r
            if len(self.__Token) > 4:\r
                raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
\r
            DataString = self.__Token\r
            DataString += ","\r
\r
            while self.__IsToken(","):\r
                if not self.__GetNextHexNumber():\r
                    raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)\r
                if len(self.__Token) > 4:\r
                    raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
                DataString += self.__Token\r
                DataString += ","\r
\r
            if not self.__IsToken( "}"):\r
                raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__IsToken( "}"):\r
                raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
\r
            DataString = DataString.rstrip(",")\r
            FvObj.FvExtEntryData += [DataString]\r
\r
        if self.__Token == 'FILE':\r
        \r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
                \r
            if not self.__GetNextToken():\r
                raise Warning("expected FV Extension Entry file path At Line ", self.FileName, self.CurrentLineNumber)\r
                \r
            FvObj.FvExtEntryData += [self.__Token]\r
\r
            if not self.__IsToken( "}"):\r
                raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
\r
        return True\r
\r
    ## __GetAprioriSection() method\r
    #\r
    #   Get token statements\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FvObj       for whom apriori is got\r
    #   @param  MacroDict   dictionary used to replace macro\r
    #   @retval True        Successfully find apriori statement\r
    #   @retval False       Not able to find apriori statement\r
    #\r
    def __GetAprioriSection(self, FvObj, MacroDict = {}):\r
\r
        if not self.__IsKeyword( "APRIORI"):\r
            return False\r
\r
        if not self.__IsKeyword("PEI") and not self.__IsKeyword("DXE"):\r
            raise Warning("expected Apriori file type", self.FileName, self.CurrentLineNumber)\r
        AprType = self.__Token\r
\r
        if not self.__IsToken( "{"):\r
            raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
\r
        AprSectionObj = AprioriSection.AprioriSection()\r
        AprSectionObj.AprioriType = AprType\r
\r
        self.__GetDefineStatements(AprSectionObj)\r
        MacroDict.update(AprSectionObj.DefineVarDict)\r
\r
        while True:\r
            IsInf = self.__GetInfStatement( AprSectionObj, MacroDict = MacroDict)\r
            IsFile = self.__GetFileStatement( AprSectionObj)\r
            if not IsInf and not IsFile:\r
                break\r
\r
        if not self.__IsToken( "}"):\r
            raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
\r
        FvObj.AprioriSectionList.append(AprSectionObj)\r
        return True\r
\r
    ## __GetInfStatement() method\r
    #\r
    #   Get INF statements\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom inf statement is got\r
    #   @param  MacroDict   dictionary used to replace macro\r
    #   @retval True        Successfully find inf statement\r
    #   @retval False       Not able to find inf statement\r
    #\r
    def __GetInfStatement(self, Obj, ForCapsule = False, MacroDict = {}):\r
\r
        if not self.__IsKeyword( "INF"):\r
            return False\r
\r
        ffsInf = FfsInfStatement.FfsInfStatement()\r
        self.__GetInfOptions( ffsInf)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected INF file path", self.FileName, self.CurrentLineNumber)\r
        ffsInf.InfFileName = self.__Token\r
\r
        ffsInf.CurrentLineNum = self.CurrentLineNumber\r
        ffsInf.CurrentLineContent = self.__CurrentLine()\r
\r
        if ffsInf.InfFileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
            #do case sensitive check for file path\r
            ErrorCode, ErrorInfo = PathClass(NormPath(ffsInf.InfFileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
            if ErrorCode != 0:\r
                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
\r
        if not ffsInf.InfFileName in self.Profile.InfList:\r
            self.Profile.InfList.append(ffsInf.InfFileName)\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            self.Profile.InfFileLineList.append(FileLineTuple)\r
\r
        if self.__IsToken('|'):\r
            if self.__IsKeyword('RELOCS_STRIPPED'):\r
                ffsInf.KeepReloc = False\r
            elif self.__IsKeyword('RELOCS_RETAINED'):\r
                ffsInf.KeepReloc = True\r
            else:\r
                raise Warning("Unknown reloc strip flag '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
        \r
        if ForCapsule:\r
            capsuleFfs = CapsuleData.CapsuleFfs()\r
            capsuleFfs.Ffs = ffsInf\r
            Obj.CapsuleDataList.append(capsuleFfs)\r
        else:\r
            Obj.FfsList.append(ffsInf)\r
        return True\r
\r
    ## __GetInfOptions() method\r
    #\r
    #   Get options for INF\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FfsInfObj   for whom option is got\r
    #\r
    def __GetInfOptions(self, FfsInfObj):\r
\r
        if self.__IsKeyword( "RuleOverride"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken():\r
                raise Warning("expected Rule name", self.FileName, self.CurrentLineNumber)\r
            FfsInfObj.Rule = self.__Token\r
\r
        if self.__IsKeyword( "VERSION"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken():\r
                raise Warning("expected Version", self.FileName, self.CurrentLineNumber)\r
\r
            if self.__GetStringData():\r
                FfsInfObj.Version = self.__Token\r
\r
        if self.__IsKeyword( "UI"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken():\r
                raise Warning("expected UI name", self.FileName, self.CurrentLineNumber)\r
\r
            if self.__GetStringData():\r
                FfsInfObj.Ui = self.__Token\r
\r
        if self.__IsKeyword( "USE"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken():\r
                raise Warning("expected ARCH name", self.FileName, self.CurrentLineNumber)\r
            FfsInfObj.UseArch = self.__Token\r
\r
                \r
        if self.__GetNextToken():\r
            p = re.compile(r'([a-zA-Z0-9\-]+|\$\(TARGET\)|\*)_([a-zA-Z0-9\-]+|\$\(TOOL_CHAIN_TAG\)|\*)_([a-zA-Z0-9\-]+|\$\(ARCH\)|\*)')\r
            if p.match(self.__Token):\r
                FfsInfObj.KeyStringList.append(self.__Token)\r
                if not self.__IsToken(","):\r
                    return\r
            else:\r
                self.__UndoToken()\r
                return\r
\r
            while self.__GetNextToken():\r
                if not p.match(self.__Token):\r
                    raise Warning("expected KeyString \"Target_Tag_Arch\"", self.FileName, self.CurrentLineNumber)\r
                FfsInfObj.KeyStringList.append(self.__Token)\r
\r
                if not self.__IsToken(","):\r
                    break\r
\r
    ## __GetFileStatement() method\r
    #\r
    #   Get FILE statements\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom FILE statement is got\r
    #   @param  MacroDict   dictionary used to replace macro\r
    #   @retval True        Successfully find FILE statement\r
    #   @retval False       Not able to find FILE statement\r
    #\r
    def __GetFileStatement(self, Obj, ForCapsule = False, MacroDict = {}):\r
\r
        if not self.__IsKeyword( "FILE"):\r
            return False\r
\r
        if not self.__GetNextWord():\r
            raise Warning("expected FFS type", self.FileName, self.CurrentLineNumber)\r
\r
        if ForCapsule and self.__Token == 'DATA':\r
            self.__UndoToken()\r
            self.__UndoToken()\r
            return False\r
        \r
        FfsFileObj = FfsFileStatement.FileStatement()\r
        FfsFileObj.FvFileType = self.__Token\r
\r
        if not self.__IsToken( "="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextGuid():\r
            if not self.__GetNextWord():\r
                raise Warning("expected File GUID", self.FileName, self.CurrentLineNumber)\r
            if self.__Token == 'PCD':\r
                if not self.__IsToken( "("):\r
                    raise Warning("expected '('", self.FileName, self.CurrentLineNumber)\r
                PcdPair = self.__GetNextPcdName()\r
                if not self.__IsToken( ")"):\r
                    raise Warning("expected ')'", self.FileName, self.CurrentLineNumber)\r
                self.__Token = 'PCD('+PcdPair[1]+'.'+PcdPair[0]+')'\r
                \r
        FfsFileObj.NameGuid = self.__Token\r
        \r
        self.__GetFilePart( FfsFileObj, MacroDict.copy())\r
\r
        if ForCapsule:\r
            capsuleFfs = CapsuleData.CapsuleFfs()\r
            capsuleFfs.Ffs = FfsFileObj\r
            Obj.CapsuleDataList.append(capsuleFfs)\r
        else:\r
            Obj.FfsList.append(FfsFileObj)\r
\r
        return True\r
\r
    ## __FileCouldHaveRelocFlag() method\r
    #\r
    #   Check whether reloc strip flag can be set for a file type.\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FileType    The file type to check with\r
    #   @retval True        This type could have relocation strip flag\r
    #   @retval False       No way to have it\r
    #\r
\r
    def __FileCouldHaveRelocFlag (self, FileType):\r
        if FileType in ('SEC', 'PEI_CORE', 'PEIM', 'PEI_DXE_COMBO'):\r
            return True\r
        else:\r
            return False\r
\r
    ## __SectionCouldHaveRelocFlag() method\r
    #\r
    #   Check whether reloc strip flag can be set for a section type.\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  SectionType The section type to check with\r
    #   @retval True        This type could have relocation strip flag\r
    #   @retval False       No way to have it\r
    #\r
\r
    def __SectionCouldHaveRelocFlag (self, SectionType):\r
        if SectionType in ('TE', 'PE32'):\r
            return True\r
        else:\r
            return False\r
\r
    ## __GetFilePart() method\r
    #\r
    #   Get components for FILE statement\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FfsFileObj   for whom component is got\r
    #   @param  MacroDict   dictionary used to replace macro\r
    #\r
    def __GetFilePart(self, FfsFileObj, MacroDict = {}):\r
\r
        self.__GetFileOpts( FfsFileObj)\r
\r
        if not self.__IsToken("{"):\r
            if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):\r
                if self.__FileCouldHaveRelocFlag(FfsFileObj.FvFileType):\r
                    if self.__Token == 'RELOCS_STRIPPED':\r
                        FfsFileObj.KeepReloc = False\r
                    else:\r
                        FfsFileObj.KeepReloc = True\r
                else:\r
                    raise Warning("File type %s could not have reloc strip flag%d" % (FfsFileObj.FvFileType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__IsToken("{"):\r
                raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected File name or section data", self.FileName, self.CurrentLineNumber)\r
\r
        if self.__Token == "FV":\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken():\r
                raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)\r
            FfsFileObj.FvName = self.__Token\r
\r
        elif self.__Token == "FD":\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken():\r
                raise Warning("expected FD name", self.FileName, self.CurrentLineNumber)\r
            FfsFileObj.FdName = self.__Token\r
\r
        elif self.__Token in ("DEFINE", "APRIORI", "SECTION"):\r
            self.__UndoToken()\r
            self.__GetSectionData( FfsFileObj, MacroDict)\r
        else:\r
            FfsFileObj.CurrentLineNum = self.CurrentLineNumber\r
            FfsFileObj.CurrentLineContent = self.__CurrentLine()\r
            FfsFileObj.FileName = self.__Token\r
            self.__VerifyFile(FfsFileObj.FileName)\r
\r
        if not self.__IsToken( "}"):\r
            raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
\r
    ## __GetFileOpts() method\r
    #\r
    #   Get options for FILE statement\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FfsFileObj   for whom options is got\r
    #\r
    def __GetFileOpts(self, FfsFileObj):\r
\r
        if self.__GetNextToken():\r
            Pattern = re.compile(r'([a-zA-Z0-9\-]+|\$\(TARGET\)|\*)_([a-zA-Z0-9\-]+|\$\(TOOL_CHAIN_TAG\)|\*)_([a-zA-Z0-9\-]+|\$\(ARCH\)|\*)')\r
            if Pattern.match(self.__Token):\r
                FfsFileObj.KeyStringList.append(self.__Token)\r
                if self.__IsToken(","):\r
                    while self.__GetNextToken():\r
                        if not Pattern.match(self.__Token):\r
                            raise Warning("expected KeyString \"Target_Tag_Arch\"", self.FileName, self.CurrentLineNumber)\r
                        FfsFileObj.KeyStringList.append(self.__Token)\r
\r
                        if not self.__IsToken(","):\r
                            break\r
\r
            else:\r
                self.__UndoToken()\r
\r
        if self.__IsKeyword( "FIXED", True):\r
            FfsFileObj.Fixed = True\r
\r
        if self.__IsKeyword( "CHECKSUM", True):\r
            FfsFileObj.CheckSum = True\r
\r
        if self.__GetAlignment():\r
            if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):\r
                raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
            #For FFS, Auto is default option same to ""\r
            if not self.__Token == "Auto":\r
                FfsFileObj.Alignment = self.__Token\r
\r
    ## __GetAlignment() method\r
    #\r
    #   Return the alignment value\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find alignment\r
    #   @retval False       Not able to find alignment\r
    #\r
    def __GetAlignment(self):\r
        if self.__IsKeyword( "Align", True):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected alignment value", self.FileName, self.CurrentLineNumber)\r
            return True\r
\r
        return False\r
\r
    ## __GetFilePart() method\r
    #\r
    #   Get section data for FILE statement\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FfsFileObj   for whom section is got\r
    #   @param  MacroDict   dictionary used to replace macro\r
    #\r
    def __GetSectionData(self, FfsFileObj, MacroDict = {}):\r
        Dict = {}\r
        Dict.update(MacroDict)\r
\r
        self.__GetDefineStatements(FfsFileObj)\r
\r
        Dict.update(FfsFileObj.DefineVarDict)\r
        self.__GetAprioriSection(FfsFileObj, Dict.copy())\r
        self.__GetAprioriSection(FfsFileObj, Dict.copy())\r
\r
        while True:\r
            IsLeafSection = self.__GetLeafSection(FfsFileObj, Dict)\r
            IsEncapSection = self.__GetEncapsulationSec(FfsFileObj)\r
            if not IsLeafSection and not IsEncapSection:\r
                break\r
\r
    ## __GetLeafSection() method\r
    #\r
    #   Get leaf section for Obj\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom leaf section is got\r
    #   @param  MacroDict   dictionary used to replace macro\r
    #   @retval True        Successfully find section statement\r
    #   @retval False       Not able to find section statement\r
    #\r
    def __GetLeafSection(self, Obj, MacroDict = {}):\r
\r
        OldPos = self.GetFileBufferPos()\r
\r
        if not self.__IsKeyword( "SECTION"):\r
            if len(Obj.SectionList) == 0:\r
                raise Warning("expected SECTION", self.FileName, self.CurrentLineNumber)\r
            else:\r
                return False\r
\r
        AlignValue = None\r
        if self.__GetAlignment():\r
            if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):\r
                raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
            AlignValue = self.__Token\r
\r
        BuildNum = None\r
        if self.__IsKeyword( "BUILD_NUM"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected Build number value", self.FileName, self.CurrentLineNumber)\r
\r
            BuildNum = self.__Token\r
\r
        if self.__IsKeyword( "VERSION"):\r
            if AlignValue == 'Auto':\r
                raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken():\r
                raise Warning("expected version", self.FileName, self.CurrentLineNumber)\r
            VerSectionObj = VerSection.VerSection()\r
            VerSectionObj.Alignment = AlignValue\r
            VerSectionObj.BuildNum = BuildNum\r
            if self.__GetStringData():\r
                VerSectionObj.StringData = self.__Token\r
            else:\r
                VerSectionObj.FileName = self.__Token\r
            Obj.SectionList.append(VerSectionObj)\r
            \r
        elif self.__IsKeyword( "UI"):\r
            if AlignValue == 'Auto':\r
                raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken():\r
                raise Warning("expected UI", self.FileName, self.CurrentLineNumber)\r
            UiSectionObj = UiSection.UiSection()\r
            UiSectionObj.Alignment = AlignValue\r
            if self.__GetStringData():\r
                UiSectionObj.StringData = self.__Token\r
            else:\r
                UiSectionObj.FileName = self.__Token\r
            Obj.SectionList.append(UiSectionObj)\r
\r
        elif self.__IsKeyword( "FV_IMAGE"):\r
            if AlignValue == 'Auto':\r
                raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken():\r
                raise Warning("expected FV name or FV file path", self.FileName, self.CurrentLineNumber)\r
\r
            FvName = self.__Token\r
            FvObj = None\r
\r
            if self.__IsToken( "{"):\r
                FvObj = Fv.FV()\r
                FvObj.UiFvName = FvName.upper()\r
                self.__GetDefineStatements(FvObj)\r
                MacroDict.update(FvObj.DefineVarDict)\r
                self.__GetBlockStatement(FvObj)\r
                self.__GetSetStatements(FvObj)\r
                self.__GetFvAlignment(FvObj)\r
                self.__GetFvAttributes(FvObj)\r
                self.__GetAprioriSection(FvObj, MacroDict.copy())\r
                self.__GetAprioriSection(FvObj, MacroDict.copy())\r
\r
                while True:\r
                    IsInf = self.__GetInfStatement(FvObj, MacroDict.copy())\r
                    IsFile = self.__GetFileStatement(FvObj, MacroDict.copy())\r
                    if not IsInf and not IsFile:\r
                        break\r
\r
                if not self.__IsToken( "}"):\r
                    raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
\r
            FvImageSectionObj = FvImageSection.FvImageSection()\r
            FvImageSectionObj.Alignment = AlignValue\r
            if FvObj != None:\r
                FvImageSectionObj.Fv = FvObj\r
                FvImageSectionObj.FvName = None\r
            else:\r
                FvImageSectionObj.FvName = FvName.upper()\r
                FvImageSectionObj.FvFileName = FvName\r
\r
            Obj.SectionList.append(FvImageSectionObj)\r
\r
        elif self.__IsKeyword("PEI_DEPEX_EXP") or self.__IsKeyword("DXE_DEPEX_EXP") or self.__IsKeyword("SMM_DEPEX_EXP"):\r
            if AlignValue == 'Auto':\r
                raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
            DepexSectionObj = DepexSection.DepexSection()\r
            DepexSectionObj.Alignment = AlignValue\r
            DepexSectionObj.DepexType = self.__Token\r
\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__IsToken( "{"):\r
                raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
            if not self.__SkipToToken( "}"):\r
                raise Warning("expected Depex expression ending '}'", self.FileName, self.CurrentLineNumber)\r
\r
            DepexSectionObj.Expression = self.__SkippedChars.rstrip('}')\r
            Obj.SectionList.append(DepexSectionObj)\r
\r
        else:\r
            if not self.__GetNextWord():\r
                raise Warning("expected section type", self.FileName, self.CurrentLineNumber)\r
\r
            # Encapsulation section appear, UndoToken and return\r
            if self.__Token == "COMPRESS" or self.__Token == "GUIDED":\r
                self.SetFileBufferPos(OldPos)\r
                return False\r
\r
            if self.__Token not in ("COMPAT16", "PE32", "PIC", "TE", "FV_IMAGE", "RAW", "DXE_DEPEX",\\r
                               "UI", "VERSION", "PEI_DEPEX", "SUBTYPE_GUID", "SMM_DEPEX"):\r
                raise Warning("Unknown section type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
            if AlignValue == 'Auto'and (not self.__Token == 'PE32') and (not self.__Token == 'TE'):\r
                raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
\r
            # DataSection\r
            DataSectionObj = DataSection.DataSection()\r
            DataSectionObj.Alignment = AlignValue\r
            DataSectionObj.SecType = self.__Token\r
\r
            if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):\r
                if self.__FileCouldHaveRelocFlag(Obj.FvFileType) and self.__SectionCouldHaveRelocFlag(DataSectionObj.SecType):\r
                    if self.__Token == 'RELOCS_STRIPPED':\r
                        DataSectionObj.KeepReloc = False\r
                    else:\r
                        DataSectionObj.KeepReloc = True\r
                else:\r
                    raise Warning("File type %s, section type %s, could not have reloc strip flag%d" % (Obj.FvFileType, DataSectionObj.SecType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
\r
            if self.__IsToken("="):\r
                if not self.__GetNextToken():\r
                    raise Warning("expected section file path", self.FileName, self.CurrentLineNumber)\r
                DataSectionObj.SectFileName = self.__Token\r
                self.__VerifyFile(DataSectionObj.SectFileName)\r
            else:\r
                if not self.__GetCglSection(DataSectionObj):\r
                    return False\r
\r
            Obj.SectionList.append(DataSectionObj)\r
\r
        return True\r
\r
    ## __VerifyFile\r
    #\r
    #    Check if file exists or not:\r
    #      If current phase if GenFds, the file must exist;\r
    #      If current phase is AutoGen and the file is not in $(OUTPUT_DIRECTORY), the file must exist\r
    #    @param FileName: File path to be verified.\r
    #\r
    def __VerifyFile(self, FileName):\r
        if FileName.replace('$(WORKSPACE)', '').find('$') != -1:\r
            return\r
        if not GlobalData.gAutoGenPhase or not self.__GetMacroValue("OUTPUT_DIRECTORY") in FileName:\r
            ErrorCode, ErrorInfo = PathClass(NormPath(FileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
            if ErrorCode != 0:\r
                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
\r
    ## __GetCglSection() method\r
    #\r
    #   Get compressed or GUIDed section for Obj\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom leaf section is got\r
    #   @param  AlignValue  alignment value for complex section\r
    #   @retval True        Successfully find section statement\r
    #   @retval False       Not able to find section statement\r
    #\r
    def __GetCglSection(self, Obj, AlignValue = None):\r
\r
        if self.__IsKeyword( "COMPRESS"):\r
            type = "PI_STD"\r
            if self.__IsKeyword("PI_STD") or self.__IsKeyword("PI_NONE"):\r
                type = self.__Token\r
\r
            if not self.__IsToken("{"):\r
                raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
\r
            CompressSectionObj = CompressSection.CompressSection()\r
            CompressSectionObj.Alignment = AlignValue\r
            CompressSectionObj.CompType = type\r
            # Recursive sections...\r
            while True:\r
                IsLeafSection = self.__GetLeafSection(CompressSectionObj)\r
                IsEncapSection = self.__GetEncapsulationSec(CompressSectionObj)\r
                if not IsLeafSection and not IsEncapSection:\r
                    break\r
\r
\r
            if not self.__IsToken( "}"):\r
                raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
            Obj.SectionList.append(CompressSectionObj)\r
\r
#            else:\r
#               raise Warning("Compress type not known")\r
\r
            return True\r
\r
        elif self.__IsKeyword( "GUIDED"):\r
            GuidValue = None\r
            if self.__GetNextGuid():\r
                GuidValue = self.__Token\r
\r
            AttribDict = self.__GetGuidAttrib()\r
            if not self.__IsToken("{"):\r
                raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
            GuidSectionObj = GuidSection.GuidSection()\r
            GuidSectionObj.Alignment = AlignValue\r
            GuidSectionObj.NameGuid = GuidValue\r
            GuidSectionObj.SectionType = "GUIDED"\r
            GuidSectionObj.ProcessRequired = AttribDict["PROCESSING_REQUIRED"]\r
            GuidSectionObj.AuthStatusValid = AttribDict["AUTH_STATUS_VALID"]\r
            GuidSectionObj.ExtraHeaderSize = AttribDict["EXTRA_HEADER_SIZE"]\r
            # Recursive sections...\r
            while True:\r
                IsLeafSection = self.__GetLeafSection(GuidSectionObj)\r
                IsEncapSection = self.__GetEncapsulationSec(GuidSectionObj)\r
                if not IsLeafSection and not IsEncapSection:\r
                    break\r
\r
            if not self.__IsToken( "}"):\r
                raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
            Obj.SectionList.append(GuidSectionObj)\r
\r
            return True\r
\r
        return False\r
\r
    ## __GetGuidAttri() method\r
    #\r
    #   Get attributes for GUID section\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval AttribDict  Dictionary of key-value pair of section attributes\r
    #\r
    def __GetGuidAttrib(self):\r
\r
        AttribDict = {}\r
        AttribDict["PROCESSING_REQUIRED"] = "NONE"\r
        AttribDict["AUTH_STATUS_VALID"] = "NONE"\r
        AttribDict["EXTRA_HEADER_SIZE"] = -1\r
        while self.__IsKeyword("PROCESSING_REQUIRED") or self.__IsKeyword("AUTH_STATUS_VALID") \\r
            or self.__IsKeyword("EXTRA_HEADER_SIZE"):\r
            AttribKey = self.__Token\r
\r
            if not self.__IsToken("="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected TRUE(1)/FALSE(0)/Number", self.FileName, self.CurrentLineNumber)\r
            elif AttribKey == "EXTRA_HEADER_SIZE":\r
                Base = 10\r
                if self.__Token[0:2].upper() == "0X":\r
                    Base = 16\r
                try:\r
                    AttribDict[AttribKey] = int(self.__Token, Base)\r
                    continue\r
                except ValueError:\r
                    raise Warning("expected Number", self.FileName, self.CurrentLineNumber)\r
            elif self.__Token.upper() not in ("TRUE", "FALSE", "1", "0"):\r
                raise Warning("expected TRUE/FALSE (1/0)", self.FileName, self.CurrentLineNumber)\r
            AttribDict[AttribKey] = self.__Token\r
\r
        return AttribDict\r
\r
    ## __GetEncapsulationSec() method\r
    #\r
    #   Get encapsulation section for FILE\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FfsFile     for whom section is got\r
    #   @retval True        Successfully find section statement\r
    #   @retval False       Not able to find section statement\r
    #\r
    def __GetEncapsulationSec(self, FfsFileObj):\r
\r
        OldPos = self.GetFileBufferPos()\r
        if not self.__IsKeyword( "SECTION"):\r
            if len(FfsFileObj.SectionList) == 0:\r
                raise Warning("expected SECTION", self.FileName, self.CurrentLineNumber)\r
            else:\r
                return False\r
\r
        AlignValue = None\r
        if self.__GetAlignment():\r
            if self.__Token not in ("8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):\r
                raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
            AlignValue = self.__Token\r
\r
        if not self.__GetCglSection(FfsFileObj, AlignValue):\r
            self.SetFileBufferPos(OldPos)\r
            return False\r
        else:\r
            return True\r
\r
    ## __GetCapsule() method\r
    #\r
    #   Get capsule section contents and store its data into capsule list of self.Profile\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a capsule\r
    #   @retval False       Not able to find a capsule\r
    #\r
    def __GetCapsule(self):\r
\r
        if not self.__GetNextToken():\r
            return False\r
\r
        S = self.__Token.upper()\r
        if S.startswith("[") and not S.startswith("[CAPSULE."):\r
            if not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):\r
                raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)\r
            self.__UndoToken()\r
            return False\r
\r
        self.__UndoToken()\r
        if not self.__IsToken("[CAPSULE.", True):\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
            #        % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
            raise Warning("expected [Capsule.]", self.FileName, self.CurrentLineNumber)\r
\r
        CapsuleObj = Capsule.Capsule()\r
\r
        CapsuleName = self.__GetUiName()\r
        if not CapsuleName:\r
            raise Warning("expected capsule name", self.FileName, self.CurrentLineNumber)\r
\r
        CapsuleObj.UiCapsuleName = CapsuleName.upper()\r
\r
        if not self.__IsToken( "]"):\r
            raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
\r
        if self.__IsKeyword("CREATE_FILE"):\r
            if not self.__IsToken( "="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected file name", self.FileName, self.CurrentLineNumber)\r
\r
            CapsuleObj.CreateFile = self.__Token\r
\r
        self.__GetCapsuleStatements(CapsuleObj)\r
        self.Profile.CapsuleDict[CapsuleObj.UiCapsuleName] = CapsuleObj\r
        return True\r
\r
    ## __GetCapsuleStatements() method\r
    #\r
    #   Get statements for capsule\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom statements are got\r
    #\r
    def __GetCapsuleStatements(self, Obj):\r
        self.__GetCapsuleTokens(Obj)\r
        self.__GetDefineStatements(Obj)\r
        self.__GetSetStatements(Obj)\r
        self.__GetCapsuleData(Obj)\r
\r
    ## __GetCapsuleTokens() method\r
    #\r
    #   Get token statements for capsule\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom token statements are got\r
    #\r
    def __GetCapsuleTokens(self, Obj):\r
        if not self.__GetNextToken():\r
            return False\r
        while self.__Token in ("CAPSULE_GUID", "CAPSULE_HEADER_SIZE", "CAPSULE_FLAGS", "OEM_CAPSULE_FLAGS"):\r
            Name = self.__Token.strip()\r
            if not self.__IsToken("="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
            if not self.__GetNextToken():\r
                raise Warning("expected value", self.FileName, self.CurrentLineNumber)\r
            if Name == 'CAPSULE_FLAGS':\r
                if not self.__Token in ("PersistAcrossReset", "PopulateSystemTable", "InitiateReset"):\r
                    raise Warning("expected PersistAcrossReset, PopulateSystemTable, or InitiateReset", self.FileName, self.CurrentLineNumber)\r
                Value = self.__Token.strip()\r
                while self.__IsToken(","):\r
                    Value += ','\r
                    if not self.__GetNextToken():\r
                        raise Warning("expected value", self.FileName, self.CurrentLineNumber)\r
                    if not self.__Token in ("PersistAcrossReset", "PopulateSystemTable", "InitiateReset"):\r
                        raise Warning("expected PersistAcrossReset, PopulateSystemTable, or InitiateReset", self.FileName, self.CurrentLineNumber)\r
                    Value += self.__Token.strip()\r
            elif Name == 'OEM_CAPSULE_FLAGS':\r
                Value = self.__Token.strip()\r
                if not Value.upper().startswith('0X'):\r
                    raise Warning("expected hex value between 0x0000 and 0xFFFF", self.FileName, self.CurrentLineNumber)\r
                try:\r
                    Value = int(Value, 0)\r
                except ValueError:\r
                    raise Warning("expected hex value between 0x0000 and 0xFFFF", self.FileName, self.CurrentLineNumber)\r
                if not 0x0000 <= Value <= 0xFFFF:\r
                    raise Warning("expected hex value between 0x0000 and 0xFFFF", self.FileName, self.CurrentLineNumber)\r
                Value = self.__Token.strip()\r
            else:\r
                Value = self.__Token.strip()\r
            Obj.TokensDict[Name] = Value  \r
            if not self.__GetNextToken():\r
                return False\r
        self.__UndoToken()\r
\r
    ## __GetCapsuleData() method\r
    #\r
    #   Get capsule data for capsule\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom capsule data are got\r
    #\r
    def __GetCapsuleData(self, Obj):\r
\r
        while True:\r
            IsInf = self.__GetInfStatement(Obj, True)\r
            IsFile = self.__GetFileStatement(Obj, True)\r
            IsFv = self.__GetFvStatement(Obj)\r
            IsFd = self.__GetFdStatement(Obj)\r
            IsAnyFile = self.__GetAnyFileStatement(Obj)\r
            IsAfile = self.__GetAfileStatement(Obj)\r
            if not (IsInf or IsFile or IsFv or IsFd or IsAnyFile or IsAfile):\r
                break\r
\r
    ## __GetFvStatement() method\r
    #\r
    #   Get FV for capsule\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  CapsuleObj  for whom FV is got\r
    #   @retval True        Successfully find a FV statement\r
    #   @retval False       Not able to find a FV statement\r
    #\r
    def __GetFvStatement(self, CapsuleObj):\r
\r
        if not self.__IsKeyword("FV"):\r
            return False\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)\r
\r
        if self.__Token.upper() not in self.Profile.FvDict.keys():\r
            raise Warning("FV name does not exist", self.FileName, self.CurrentLineNumber)\r
\r
        CapsuleFv = CapsuleData.CapsuleFv()\r
        CapsuleFv.FvName = self.__Token\r
        CapsuleObj.CapsuleDataList.append(CapsuleFv)\r
        return True\r
\r
    ## __GetFdStatement() method\r
    #\r
    #   Get FD for capsule\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  CapsuleObj  for whom FD is got\r
    #   @retval True        Successfully find a FD statement\r
    #   @retval False       Not able to find a FD statement\r
    #\r
    def __GetFdStatement(self, CapsuleObj):\r
\r
        if not self.__IsKeyword("FD"):\r
            return False\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected FD name", self.FileName, self.CurrentLineNumber)\r
\r
        if self.__Token.upper() not in self.Profile.FdDict.keys():\r
            raise Warning("FD name does not exist", self.FileName, self.CurrentLineNumber)\r
\r
        CapsuleFd = CapsuleData.CapsuleFd()\r
        CapsuleFd.FdName = self.__Token\r
        CapsuleObj.CapsuleDataList.append(CapsuleFd)\r
        return True\r
\r
    ## __GetAnyFileStatement() method\r
    #\r
    #   Get AnyFile for capsule\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  CapsuleObj  for whom AnyFile is got\r
    #   @retval True        Successfully find a Anyfile statement\r
    #   @retval False       Not able to find a AnyFile statement\r
    #\r
    def __GetAnyFileStatement(self, CapsuleObj):\r
\r
        if not self.__IsKeyword("FILE"):\r
            return False\r
\r
        if not self.__IsKeyword("DATA"):\r
            self.__UndoToken()\r
            return False\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected File name", self.FileName, self.CurrentLineNumber)\r
        \r
        AnyFileName = self.__Token\r
        AnyFileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(AnyFileName)\r
        if not os.path.exists(AnyFileName):\r
            raise Warning("File %s not exists"%AnyFileName, self.FileName, self.CurrentLineNumber)\r
\r
        CapsuleAnyFile = CapsuleData.CapsuleAnyFile()\r
        CapsuleAnyFile.FileName = AnyFileName\r
        CapsuleObj.CapsuleDataList.append(CapsuleAnyFile)\r
        return True\r
    \r
    ## __GetAfileStatement() method\r
    #\r
    #   Get Afile for capsule\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  CapsuleObj  for whom Afile is got\r
    #   @retval True        Successfully find a Afile statement\r
    #   @retval False       Not able to find a Afile statement\r
    #\r
    def __GetAfileStatement(self, CapsuleObj):\r
\r
        if not self.__IsKeyword("APPEND"):\r
            return False\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected Afile name", self.FileName, self.CurrentLineNumber)\r
        \r
        AfileName = self.__Token\r
        AfileBaseName = os.path.basename(AfileName)\r
        \r
        if os.path.splitext(AfileBaseName)[1]  not in [".bin",".BIN",".Bin",".dat",".DAT",".Dat",".data",".DATA",".Data"]:\r
            raise Warning('invalid binary file type, should be one of "bin","BIN","Bin","dat","DAT","Dat","data","DATA","Data"', \\r
                          self.FileName, self.CurrentLineNumber)\r
        \r
        if not os.path.isabs(AfileName):\r
            AfileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(AfileName)\r
            self.__VerifyFile(AfileName)\r
        else:\r
            if not os.path.exists(AfileName):\r
                raise Warning('%s does not exist' % AfileName, self.FileName, self.CurrentLineNumber)\r
            else:\r
                pass\r
\r
        CapsuleAfile = CapsuleData.CapsuleAfile()\r
        CapsuleAfile.FileName = AfileName\r
        CapsuleObj.CapsuleDataList.append(CapsuleAfile)\r
        return True\r
\r
    ## __GetRule() method\r
    #\r
    #   Get Rule section contents and store its data into rule list of self.Profile\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a Rule\r
    #   @retval False       Not able to find a Rule\r
    #\r
    def __GetRule(self):\r
\r
        if not self.__GetNextToken():\r
            return False\r
\r
        S = self.__Token.upper()\r
        if S.startswith("[") and not S.startswith("[RULE."):\r
            if not S.startswith("[OPTIONROM."):\r
                raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)\r
            self.__UndoToken()\r
            return False\r
        self.__UndoToken()\r
        if not self.__IsToken("[Rule.", True):\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
            #        % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
            raise Warning("expected [Rule.]", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__SkipToToken("."):\r
            raise Warning("expected '.'", self.FileName, self.CurrentLineNumber)\r
\r
        Arch = self.__SkippedChars.rstrip(".")\r
        if Arch.upper() not in ("IA32", "X64", "IPF", "EBC", "ARM", "AARCH64", "COMMON"):\r
            raise Warning("Unknown Arch '%s'" % Arch, self.FileName, self.CurrentLineNumber)\r
\r
        ModuleType = self.__GetModuleType()\r
\r
        TemplateName = ""\r
        if self.__IsToken("."):\r
            if not self.__GetNextWord():\r
                raise Warning("expected template name", self.FileName, self.CurrentLineNumber)\r
            TemplateName = self.__Token\r
\r
        if not self.__IsToken( "]"):\r
            raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
\r
        RuleObj = self.__GetRuleFileStatements()\r
        RuleObj.Arch = Arch.upper()\r
        RuleObj.ModuleType = ModuleType\r
        RuleObj.TemplateName = TemplateName\r
        if TemplateName == '' :\r
            self.Profile.RuleDict['RULE'             + \\r
                              '.'                    + \\r
                              Arch.upper()           + \\r
                              '.'                    + \\r
                              ModuleType.upper()     ] = RuleObj\r
        else :\r
            self.Profile.RuleDict['RULE'             + \\r
                              '.'                    + \\r
                              Arch.upper()           + \\r
                              '.'                    + \\r
                              ModuleType.upper()     + \\r
                              '.'                    + \\r
                              TemplateName.upper() ] = RuleObj\r
#        self.Profile.RuleList.append(rule)\r
        return True\r
\r
    ## __GetModuleType() method\r
    #\r
    #   Return the module type\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval string      module type\r
    #\r
    def __GetModuleType(self):\r
\r
        if not self.__GetNextWord():\r
            raise Warning("expected Module type", self.FileName, self.CurrentLineNumber)\r
        if self.__Token.upper() not in ("SEC", "PEI_CORE", "PEIM", "DXE_CORE", \\r
                             "DXE_DRIVER", "DXE_SAL_DRIVER", \\r
                             "DXE_SMM_DRIVER", "DXE_RUNTIME_DRIVER", \\r
                             "UEFI_DRIVER", "UEFI_APPLICATION", "USER_DEFINED", "DEFAULT", "BASE", \\r
                             "SECURITY_CORE", "COMBINED_PEIM_DRIVER", "PIC_PEIM", "RELOCATABLE_PEIM", \\r
                             "PE32_PEIM", "BS_DRIVER", "RT_DRIVER", "SAL_RT_DRIVER", "APPLICATION", "ACPITABLE", "SMM_CORE"):\r
            raise Warning("Unknown Module type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
        return self.__Token\r
\r
    ## __GetFileExtension() method\r
    #\r
    #   Return the file extension\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval string      file name extension\r
    #\r
    def __GetFileExtension(self):\r
        if not self.__IsToken("."):\r
                raise Warning("expected '.'", self.FileName, self.CurrentLineNumber)\r
\r
        Ext = ""\r
        if self.__GetNextToken():\r
            Pattern = re.compile(r'([a-zA-Z][a-zA-Z0-9]*)')\r
            if Pattern.match(self.__Token):\r
                Ext = self.__Token\r
                return '.' + Ext\r
            else:\r
                raise Warning("Unknown file extension '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
\r
        else:\r
            raise Warning("expected file extension", self.FileName, self.CurrentLineNumber)\r
\r
    ## __GetRuleFileStatement() method\r
    #\r
    #   Get rule contents\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval Rule        Rule object\r
    #\r
    def __GetRuleFileStatements(self):\r
\r
        if not self.__IsKeyword("FILE"):\r
            raise Warning("expected FILE", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextWord():\r
            raise Warning("expected FFS type", self.FileName, self.CurrentLineNumber)\r
\r
        Type = self.__Token.strip().upper()\r
        if Type not in ("RAW", "FREEFORM", "SEC", "PEI_CORE", "PEIM",\\r
                             "PEI_DXE_COMBO", "DRIVER", "DXE_CORE", "APPLICATION", "FV_IMAGE", "SMM", "SMM_CORE"):\r
            raise Warning("Unknown FV type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsKeyword("$(NAMED_GUID)"):\r
            if not self.__GetNextWord():\r
                raise Warning("expected $(NAMED_GUID)", self.FileName, self.CurrentLineNumber)\r
            if self.__Token == 'PCD':\r
                if not self.__IsToken( "("):\r
                    raise Warning("expected '('", self.FileName, self.CurrentLineNumber)\r
                PcdPair = self.__GetNextPcdName()\r
                if not self.__IsToken( ")"):\r
                    raise Warning("expected ')'", self.FileName, self.CurrentLineNumber)\r
                self.__Token = 'PCD('+PcdPair[1]+'.'+PcdPair[0]+')'\r
            \r
        NameGuid = self.__Token\r
\r
        KeepReloc = None\r
        if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):\r
            if self.__FileCouldHaveRelocFlag(Type):\r
                if self.__Token == 'RELOCS_STRIPPED':\r
                    KeepReloc = False\r
                else:\r
                    KeepReloc = True\r
            else:\r
                raise Warning("File type %s could not have reloc strip flag%d" % (Type, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
\r
        KeyStringList = []\r
        if self.__GetNextToken():\r
            Pattern = re.compile(r'([a-zA-Z0-9\-]+|\$\(TARGET\)|\*)_([a-zA-Z0-9\-]+|\$\(TOOL_CHAIN_TAG\)|\*)_([a-zA-Z0-9\-]+|\$\(ARCH\)|\*)')\r
            if Pattern.match(self.__Token):\r
                KeyStringList.append(self.__Token)\r
                if self.__IsToken(","):\r
                    while self.__GetNextToken():\r
                        if not Pattern.match(self.__Token):\r
                            raise Warning("expected KeyString \"Target_Tag_Arch\"", self.FileName, self.CurrentLineNumber)\r
                        KeyStringList.append(self.__Token)\r
\r
                        if not self.__IsToken(","):\r
                            break\r
\r
            else:\r
                self.__UndoToken()\r
\r
\r
        Fixed = False\r
        if self.__IsKeyword("Fixed", True):\r
            Fixed = True\r
\r
        CheckSum = False\r
        if self.__IsKeyword("CheckSum", True):\r
            CheckSum = True\r
\r
        AlignValue = ""\r
        if self.__GetAlignment():\r
            if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):\r
                raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
            #For FFS, Auto is default option same to ""\r
            if not self.__Token == "Auto":\r
                AlignValue = self.__Token\r
\r
        if self.__IsToken("{"):\r
            # Complex file rule expected\r
            Rule = RuleComplexFile.RuleComplexFile()\r
            Rule.FvFileType = Type\r
            Rule.NameGuid = NameGuid\r
            Rule.Alignment = AlignValue\r
            Rule.CheckSum = CheckSum\r
            Rule.Fixed = Fixed\r
            Rule.KeyStringList = KeyStringList\r
            if KeepReloc != None:\r
                Rule.KeepReloc = KeepReloc\r
\r
            while True:\r
                IsEncapsulate = self.__GetRuleEncapsulationSection(Rule)\r
                IsLeaf = self.__GetEfiSection(Rule)\r
                if not IsEncapsulate and not IsLeaf:\r
                    break\r
\r
            if not self.__IsToken("}"):\r
                raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
\r
            return Rule\r
\r
        else:\r
            # Simple file rule expected\r
            if not self.__GetNextWord():\r
                raise Warning("expected leaf section type", self.FileName, self.CurrentLineNumber)\r
\r
            SectionName = self.__Token\r
\r
            if SectionName not in ("COMPAT16", "PE32", "PIC", "TE", "FV_IMAGE", "RAW", "DXE_DEPEX",\\r
                                    "UI", "PEI_DEPEX", "VERSION", "SUBTYPE_GUID", "SMM_DEPEX"):\r
                raise Warning("Unknown leaf section name '%s'" % SectionName, self.FileName, self.CurrentLineNumber)\r
\r
\r
            if self.__IsKeyword("Fixed", True):\r
                Fixed = True\r
\r
            if self.__IsKeyword("CheckSum", True):\r
                CheckSum = True\r
\r
            SectAlignment = ""\r
            if self.__GetAlignment():\r
                if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):\r
                    raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
                if self.__Token == 'Auto' and (not SectionName == 'PE32') and (not SectionName == 'TE'):\r
                    raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
                SectAlignment = self.__Token\r
\r
            Ext = None\r
            if self.__IsToken('|'):\r
                Ext = self.__GetFileExtension()\r
            elif not self.__GetNextToken():\r
                raise Warning("expected File name", self.FileName, self.CurrentLineNumber)\r
\r
            Rule = RuleSimpleFile.RuleSimpleFile()\r
            Rule.SectionType = SectionName\r
            Rule.FvFileType = Type\r
            Rule.NameGuid = NameGuid\r
            Rule.Alignment = AlignValue\r
            Rule.SectAlignment = SectAlignment\r
            Rule.CheckSum = CheckSum\r
            Rule.Fixed = Fixed\r
            Rule.KeyStringList = KeyStringList\r
            if KeepReloc != None:\r
                Rule.KeepReloc = KeepReloc\r
            Rule.FileExtension = Ext\r
            Rule.FileName = self.__Token\r
            return Rule\r
\r
    ## __GetEfiSection() method\r
    #\r
    #   Get section list for Rule\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom section is got\r
    #   @retval True        Successfully find section statement\r
    #   @retval False       Not able to find section statement\r
    #\r
    def __GetEfiSection(self, Obj):\r
\r
        OldPos = self.GetFileBufferPos()\r
        if not self.__GetNextWord():\r
            return False\r
        SectionName = self.__Token\r
\r
        if SectionName not in ("COMPAT16", "PE32", "PIC", "TE", "FV_IMAGE", "RAW", "DXE_DEPEX",\\r
                               "UI", "VERSION", "PEI_DEPEX", "GUID", "SMM_DEPEX"):\r
            self.__UndoToken()\r
            return False\r
\r
        if SectionName == "FV_IMAGE":\r
            FvImageSectionObj = FvImageSection.FvImageSection()\r
            if self.__IsKeyword("FV_IMAGE"):\r
                pass\r
            if self.__IsToken( "{"):\r
                FvObj = Fv.FV()\r
                self.__GetDefineStatements(FvObj)\r
                self.__GetBlockStatement(FvObj)\r
                self.__GetSetStatements(FvObj)\r
                self.__GetFvAlignment(FvObj)\r
                self.__GetFvAttributes(FvObj)\r
                self.__GetAprioriSection(FvObj)\r
                self.__GetAprioriSection(FvObj)\r
\r
                while True:\r
                    IsInf = self.__GetInfStatement(FvObj)\r
                    IsFile = self.__GetFileStatement(FvObj)\r
                    if not IsInf and not IsFile:\r
                        break\r
\r
                if not self.__IsToken( "}"):\r
                    raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
                FvImageSectionObj.Fv = FvObj\r
                FvImageSectionObj.FvName = None\r
\r
            else:\r
                if not self.__IsKeyword("FV"):\r
                    raise Warning("expected 'FV'", self.FileName, self.CurrentLineNumber)\r
                FvImageSectionObj.FvFileType = self.__Token\r
\r
                if self.__GetAlignment():\r
                    if self.__Token not in ("8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):\r
                        raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
                    FvImageSectionObj.Alignment = self.__Token\r
\r
                if self.__IsToken('|'):\r
                    FvImageSectionObj.FvFileExtension = self.__GetFileExtension()\r
                elif self.__GetNextToken():\r
                    if self.__Token not in ("}", "COMPAT16", "PE32", "PIC", "TE", "FV_IMAGE", "RAW", "DXE_DEPEX",\\r
                               "UI", "VERSION", "PEI_DEPEX", "GUID", "SMM_DEPEX"):\r
                        FvImageSectionObj.FvFileName = self.__Token\r
                    else:\r
                        self.__UndoToken()\r
                else:\r
                    raise Warning("expected FV file name", self.FileName, self.CurrentLineNumber)\r
\r
            Obj.SectionList.append(FvImageSectionObj)\r
            return True\r
\r
        EfiSectionObj = EfiSection.EfiSection()\r
        EfiSectionObj.SectionType = SectionName\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected file type", self.FileName, self.CurrentLineNumber)\r
\r
        if self.__Token == "STRING":\r
            if not self.__RuleSectionCouldHaveString(EfiSectionObj.SectionType):\r
                raise Warning("%s section could NOT have string data%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__IsToken('='):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected Quoted String", self.FileName, self.CurrentLineNumber)\r
\r
            if self.__GetStringData():\r
                EfiSectionObj.StringData = self.__Token\r
\r
            if self.__IsKeyword("BUILD_NUM"):\r
                if not self.__RuleSectionCouldHaveBuildNum(EfiSectionObj.SectionType):\r
                    raise Warning("%s section could NOT have BUILD_NUM%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
\r
                if not self.__IsToken("="):\r
                    raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
                if not self.__GetNextToken():\r
                    raise Warning("expected Build number", self.FileName, self.CurrentLineNumber)\r
                EfiSectionObj.BuildNum = self.__Token\r
\r
        else:\r
            EfiSectionObj.FileType = self.__Token\r
            self.__CheckRuleSectionFileType(EfiSectionObj.SectionType, EfiSectionObj.FileType)\r
\r
        if self.__IsKeyword("Optional"):\r
            if not self.__RuleSectionCouldBeOptional(EfiSectionObj.SectionType):\r
                raise Warning("%s section could NOT be optional%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
            EfiSectionObj.Optional = True\r
\r
            if self.__IsKeyword("BUILD_NUM"):\r
                if not self.__RuleSectionCouldHaveBuildNum(EfiSectionObj.SectionType):\r
                    raise Warning("%s section could NOT have BUILD_NUM%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
\r
                if not self.__IsToken("="):\r
                    raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
                if not self.__GetNextToken():\r
                    raise Warning("expected Build number", self.FileName, self.CurrentLineNumber)\r
                EfiSectionObj.BuildNum = self.__Token\r
\r
        if self.__GetAlignment():\r
            if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):\r
                raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
            if self.__Token == 'Auto' and (not SectionName == 'PE32') and (not SectionName == 'TE'):\r
                raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
            EfiSectionObj.Alignment = self.__Token\r
\r
        if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):\r
            if self.__SectionCouldHaveRelocFlag(EfiSectionObj.SectionType):\r
                if self.__Token == 'RELOCS_STRIPPED':\r
                    EfiSectionObj.KeepReloc = False\r
                else:\r
                    EfiSectionObj.KeepReloc = True\r
                if Obj.KeepReloc != None and Obj.KeepReloc != EfiSectionObj.KeepReloc:\r
                    raise Warning("Section type %s has reloc strip flag conflict with Rule" % EfiSectionObj.SectionType, self.FileName, self.CurrentLineNumber)\r
            else:\r
                raise Warning("Section type %s could not have reloc strip flag" % EfiSectionObj.SectionType, self.FileName, self.CurrentLineNumber)\r
\r
\r
        if self.__IsToken('|'):\r
            EfiSectionObj.FileExtension = self.__GetFileExtension()\r
        elif self.__GetNextToken():\r
            if self.__Token not in ("}", "COMPAT16", "PE32", "PIC", "TE", "FV_IMAGE", "RAW", "DXE_DEPEX",\\r
                       "UI", "VERSION", "PEI_DEPEX", "GUID", "SMM_DEPEX"):\r
                \r
                if self.__Token.startswith('PCD'):\r
                    self.__UndoToken()\r
                    self.__GetNextWord()\r
                \r
                    if self.__Token == 'PCD':\r
                        if not self.__IsToken( "("):\r
                            raise Warning("expected '('", self.FileName, self.CurrentLineNumber)\r
                        PcdPair = self.__GetNextPcdName()\r
                        if not self.__IsToken( ")"):\r
                            raise Warning("expected ')'", self.FileName, self.CurrentLineNumber)\r
                        self.__Token = 'PCD('+PcdPair[1]+'.'+PcdPair[0]+')'\r
                        \r
                EfiSectionObj.FileName = self.__Token        \r
                            \r
            else:\r
                self.__UndoToken()\r
        else:\r
            raise Warning("expected section file name", self.FileName, self.CurrentLineNumber)\r
\r
        Obj.SectionList.append(EfiSectionObj)\r
        return True\r
\r
    ## __RuleSectionCouldBeOptional() method\r
    #\r
    #   Get whether a section could be optional\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  SectionType The section type to check\r
    #   @retval True        section could be optional\r
    #   @retval False       section never optional\r
    #\r
    def __RuleSectionCouldBeOptional(self, SectionType):\r
        if SectionType in ("DXE_DEPEX", "UI", "VERSION", "PEI_DEPEX", "RAW", "SMM_DEPEX"):\r
            return True\r
        else:\r
            return False\r
\r
    ## __RuleSectionCouldHaveBuildNum() method\r
    #\r
    #   Get whether a section could have build number information\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  SectionType The section type to check\r
    #   @retval True        section could have build number information\r
    #   @retval False       section never have build number information\r
    #\r
    def __RuleSectionCouldHaveBuildNum(self, SectionType):\r
        if SectionType in ("VERSION"):\r
            return True\r
        else:\r
            return False\r
\r
    ## __RuleSectionCouldHaveString() method\r
    #\r
    #   Get whether a section could have string\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  SectionType The section type to check\r
    #   @retval True        section could have string\r
    #   @retval False       section never have string\r
    #\r
    def __RuleSectionCouldHaveString(self, SectionType):\r
        if SectionType in ("UI", "VERSION"):\r
            return True\r
        else:\r
            return False\r
\r
    ## __CheckRuleSectionFileType() method\r
    #\r
    #   Get whether a section matches a file type\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  SectionType The section type to check\r
    #   @param  FileType    The file type to check\r
    #\r
    def __CheckRuleSectionFileType(self, SectionType, FileType):\r
        if SectionType == "COMPAT16":\r
            if FileType not in ("COMPAT16", "SEC_COMPAT16"):\r
                raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
        elif SectionType == "PE32":\r
            if FileType not in ("PE32", "SEC_PE32"):\r
                raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
        elif SectionType == "PIC":\r
            if FileType not in ("PIC", "PIC"):\r
                raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
        elif SectionType == "TE":\r
            if FileType not in ("TE", "SEC_TE"):\r
                raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
        elif SectionType == "RAW":\r
            if FileType not in ("BIN", "SEC_BIN", "RAW", "ASL", "ACPI"):\r
                raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
        elif SectionType == "DXE_DEPEX" or SectionType == "SMM_DEPEX":\r
            if FileType not in ("DXE_DEPEX", "SEC_DXE_DEPEX", "SMM_DEPEX"):\r
                raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
        elif SectionType == "UI":\r
            if FileType not in ("UI", "SEC_UI"):\r
                raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
        elif SectionType == "VERSION":\r
            if FileType not in ("VERSION", "SEC_VERSION"):\r
                raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
        elif SectionType == "PEI_DEPEX":\r
            if FileType not in ("PEI_DEPEX", "SEC_PEI_DEPEX"):\r
                raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
        elif SectionType == "GUID":\r
            if FileType not in ("PE32", "SEC_GUID"):\r
                raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
\r
    ## __GetRuleEncapsulationSection() method\r
    #\r
    #   Get encapsulation section for Rule\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Rule        for whom section is got\r
    #   @retval True        Successfully find section statement\r
    #   @retval False       Not able to find section statement\r
    #\r
    def __GetRuleEncapsulationSection(self, Rule):\r
\r
        if self.__IsKeyword( "COMPRESS"):\r
            Type = "PI_STD"\r
            if self.__IsKeyword("PI_STD") or self.__IsKeyword("PI_NONE"):\r
                Type = self.__Token\r
\r
            if not self.__IsToken("{"):\r
                raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
\r
            CompressSectionObj = CompressSection.CompressSection()\r
\r
            CompressSectionObj.CompType = Type\r
            # Recursive sections...\r
            while True:\r
                IsEncapsulate = self.__GetRuleEncapsulationSection(CompressSectionObj)\r
                IsLeaf = self.__GetEfiSection(CompressSectionObj)\r
                if not IsEncapsulate and not IsLeaf:\r
                    break\r
\r
            if not self.__IsToken( "}"):\r
                raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
            Rule.SectionList.append(CompressSectionObj)\r
\r
            return True\r
\r
        elif self.__IsKeyword( "GUIDED"):\r
            GuidValue = None\r
            if self.__GetNextGuid():\r
                GuidValue = self.__Token\r
\r
            if self.__IsKeyword( "$(NAMED_GUID)"):\r
                GuidValue = self.__Token\r
\r
            AttribDict = self.__GetGuidAttrib()\r
\r
            if not self.__IsToken("{"):\r
                raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
            GuidSectionObj = GuidSection.GuidSection()\r
            GuidSectionObj.NameGuid = GuidValue\r
            GuidSectionObj.SectionType = "GUIDED"\r
            GuidSectionObj.ProcessRequired = AttribDict["PROCESSING_REQUIRED"]\r
            GuidSectionObj.AuthStatusValid = AttribDict["AUTH_STATUS_VALID"]\r
            GuidSectionObj.ExtraHeaderSize = AttribDict["EXTRA_HEADER_SIZE"]\r
\r
            # Efi sections...\r
            while True:\r
                IsEncapsulate = self.__GetRuleEncapsulationSection(GuidSectionObj)\r
                IsLeaf = self.__GetEfiSection(GuidSectionObj)\r
                if not IsEncapsulate and not IsLeaf:\r
                    break\r
\r
            if not self.__IsToken( "}"):\r
                raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
            Rule.SectionList.append(GuidSectionObj)\r
\r
            return True\r
\r
        return False\r
\r
    ## __GetVtf() method\r
    #\r
    #   Get VTF section contents and store its data into VTF list of self.Profile\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a VTF\r
    #   @retval False       Not able to find a VTF\r
    #\r
    def __GetVtf(self):\r
\r
        if not self.__GetNextToken():\r
            return False\r
\r
        S = self.__Token.upper()\r
        if S.startswith("[") and not S.startswith("[VTF."):\r
            if not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):\r
                raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)\r
            self.__UndoToken()\r
            return False\r
\r
        self.__UndoToken()\r
        if not self.__IsToken("[VTF.", True):\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
            #        % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
            raise Warning("expected [VTF.]", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__SkipToToken("."):\r
            raise Warning("expected '.'", self.FileName, self.CurrentLineNumber)\r
\r
        Arch = self.__SkippedChars.rstrip(".").upper()\r
        if Arch not in ("IA32", "X64", "IPF", "ARM", "AARCH64"):\r
            raise Warning("Unknown Arch '%s'" % Arch, self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextWord():\r
            raise Warning("expected VTF name", self.FileName, self.CurrentLineNumber)\r
        Name = self.__Token.upper()\r
\r
        VtfObj = Vtf.Vtf()\r
        VtfObj.UiName = Name\r
        VtfObj.KeyArch = Arch\r
\r
        if self.__IsToken(","):\r
            if not self.__GetNextWord():\r
                raise Warning("expected Arch list", self.FileName, self.CurrentLineNumber)\r
            if self.__Token.upper() not in ("IA32", "X64", "IPF", "ARM", "AARCH64"):\r
                raise Warning("Unknown Arch '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
            VtfObj.ArchList = self.__Token.upper()\r
\r
        if not self.__IsToken( "]"):\r
            raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
\r
        if self.__IsKeyword("IA32_RST_BIN"):\r
            if not self.__IsToken("="):\r
                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
            if not self.__GetNextToken():\r
                raise Warning("expected Reset file", self.FileName, self.CurrentLineNumber)\r
\r
            VtfObj.ResetBin = self.__Token\r
            if VtfObj.ResetBin.replace('$(WORKSPACE)', '').find('$') == -1:\r
                #check for file path\r
                ErrorCode, ErrorInfo = PathClass(NormPath(VtfObj.ResetBin), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
                if ErrorCode != 0:\r
                    EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
\r
        while self.__GetComponentStatement(VtfObj):\r
            pass\r
\r
        self.Profile.VtfList.append(VtfObj)\r
        return True\r
\r
    ## __GetComponentStatement() method\r
    #\r
    #   Get components in VTF\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  VtfObj         for whom component is got\r
    #   @retval True        Successfully find a component\r
    #   @retval False       Not able to find a component\r
    #\r
    def __GetComponentStatement(self, VtfObj):\r
\r
        if not self.__IsKeyword("COMP_NAME"):\r
            return False\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextWord():\r
            raise Warning("expected Component Name", self.FileName, self.CurrentLineNumber)\r
\r
        CompStatementObj = ComponentStatement.ComponentStatement()\r
        CompStatementObj.CompName = self.__Token\r
\r
        if not self.__IsKeyword("COMP_LOC"):\r
            raise Warning("expected COMP_LOC", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        CompStatementObj.CompLoc = ""\r
        if self.__GetNextWord():\r
            CompStatementObj.CompLoc = self.__Token\r
            if self.__IsToken('|'):\r
                if not self.__GetNextWord():\r
                    raise Warning("Expected Region Name", self.FileName, self.CurrentLineNumber)\r
\r
                if self.__Token not in ("F", "N", "S"):    #, "H", "L", "PH", "PL"): not support\r
                    raise Warning("Unknown location type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
\r
                CompStatementObj.FilePos = self.__Token\r
        else:\r
            self.CurrentLineNumber += 1\r
            self.CurrentOffsetWithinLine = 0\r
\r
        if not self.__IsKeyword("COMP_TYPE"):\r
            raise Warning("expected COMP_TYPE", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected Component type", self.FileName, self.CurrentLineNumber)\r
        if self.__Token not in ("FIT", "PAL_B", "PAL_A", "OEM"):\r
            if not self.__Token.startswith("0x") or len(self.__Token) < 3 or len(self.__Token) > 4 or \\r
                not self.__HexDigit(self.__Token[2]) or not self.__HexDigit(self.__Token[-1]):\r
                raise Warning("Unknown location type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
        CompStatementObj.CompType = self.__Token\r
\r
        if not self.__IsKeyword("COMP_VER"):\r
            raise Warning("expected COMP_VER", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected Component version", self.FileName, self.CurrentLineNumber)\r
\r
        Pattern = re.compile('-$|[0-9a-fA-F]{1,2}\.[0-9a-fA-F]{1,2}$', re.DOTALL)\r
        if Pattern.match(self.__Token) == None:\r
            raise Warning("Unknown version format '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
        CompStatementObj.CompVer = self.__Token\r
\r
        if not self.__IsKeyword("COMP_CS"):\r
            raise Warning("expected COMP_CS", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected Component CS", self.FileName, self.CurrentLineNumber)\r
        if self.__Token not in ("1", "0"):\r
            raise Warning("Unknown  Component CS '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
        CompStatementObj.CompCs = self.__Token\r
\r
\r
        if not self.__IsKeyword("COMP_BIN"):\r
            raise Warning("expected COMP_BIN", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected Component file", self.FileName, self.CurrentLineNumber)\r
\r
        CompStatementObj.CompBin = self.__Token\r
        if CompStatementObj.CompBin != '-' and CompStatementObj.CompBin.replace('$(WORKSPACE)', '').find('$') == -1:\r
            #check for file path\r
            ErrorCode, ErrorInfo = PathClass(NormPath(CompStatementObj.CompBin), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
            if ErrorCode != 0:\r
                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
\r
        if not self.__IsKeyword("COMP_SYM"):\r
            raise Warning("expected COMP_SYM", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected Component symbol file", self.FileName, self.CurrentLineNumber)\r
\r
        CompStatementObj.CompSym = self.__Token\r
        if CompStatementObj.CompSym != '-' and CompStatementObj.CompSym.replace('$(WORKSPACE)', '').find('$') == -1:\r
            #check for file path\r
            ErrorCode, ErrorInfo = PathClass(NormPath(CompStatementObj.CompSym), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
            if ErrorCode != 0:\r
                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
\r
        if not self.__IsKeyword("COMP_SIZE"):\r
            raise Warning("expected COMP_SIZE", self.FileName, self.CurrentLineNumber)\r
\r
        if not self.__IsToken("="):\r
            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
\r
        if self.__IsToken("-"):\r
            CompStatementObj.CompSize = self.__Token\r
        elif self.__GetNextDecimalNumber():\r
            CompStatementObj.CompSize = self.__Token\r
        elif self.__GetNextHexNumber():\r
            CompStatementObj.CompSize = self.__Token\r
        else:\r
            raise Warning("Unknown size '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
\r
        VtfObj.ComponentStatementList.append(CompStatementObj)\r
        return True\r
\r
    ## __GetOptionRom() method\r
    #\r
    #   Get OptionROM section contents and store its data into OptionROM list of self.Profile\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        Successfully find a OptionROM\r
    #   @retval False       Not able to find a OptionROM\r
    #\r
    def __GetOptionRom(self):\r
\r
        if not self.__GetNextToken():\r
            return False\r
\r
        S = self.__Token.upper()\r
        if S.startswith("[") and not S.startswith("[OPTIONROM."):\r
            raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)\r
        \r
        self.__UndoToken()\r
        if not self.__IsToken("[OptionRom.", True):\r
            raise Warning("Unknown Keyword '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
\r
        OptRomName = self.__GetUiName()\r
\r
        if not self.__IsToken( "]"):\r
            raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
\r
        OptRomObj = OptionRom.OPTIONROM()\r
        OptRomObj.DriverName = OptRomName\r
        self.Profile.OptRomDict[OptRomName] = OptRomObj\r
\r
        while True:\r
            isInf = self.__GetOptRomInfStatement(OptRomObj)\r
            isFile = self.__GetOptRomFileStatement(OptRomObj)\r
            if not isInf and not isFile:\r
                break\r
            \r
        return True\r
\r
    ## __GetOptRomInfStatement() method\r
    #\r
    #   Get INF statements\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom inf statement is got\r
    #   @retval True        Successfully find inf statement\r
    #   @retval False       Not able to find inf statement\r
    #\r
    def __GetOptRomInfStatement(self, Obj):\r
\r
        if not self.__IsKeyword( "INF"):\r
            return False\r
\r
        ffsInf = OptRomInfStatement.OptRomInfStatement()\r
        self.__GetInfOptions( ffsInf)\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected INF file path", self.FileName, self.CurrentLineNumber)\r
        ffsInf.InfFileName = self.__Token\r
        if ffsInf.InfFileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
            #check for file path\r
            ErrorCode, ErrorInfo = PathClass(NormPath(ffsInf.InfFileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
            if ErrorCode != 0:\r
                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
\r
        if not ffsInf.InfFileName in self.Profile.InfList:\r
            self.Profile.InfList.append(ffsInf.InfFileName)\r
            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
            self.Profile.InfFileLineList.append(FileLineTuple)\r
\r
        \r
        self.__GetOptRomOverrides (ffsInf)\r
            \r
        Obj.FfsList.append(ffsInf)\r
        return True\r
\r
    ## __GetOptRomOverrides() method\r
    #\r
    #   Get overrides for OptROM INF & FILE\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FfsInfObj   for whom overrides is got\r
    #\r
    def __GetOptRomOverrides(self, Obj):\r
        if self.__IsToken('{'):\r
            Overrides = OptionRom.OverrideAttribs()\r
            while True:\r
                if self.__IsKeyword( "PCI_VENDOR_ID"):\r
                    if not self.__IsToken( "="):\r
                        raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
                    if not self.__GetNextHexNumber():\r
                        raise Warning("expected Hex vendor id", self.FileName, self.CurrentLineNumber)\r
                    Overrides.PciVendorId = self.__Token\r
                    continue\r
\r
                if self.__IsKeyword( "PCI_CLASS_CODE"):\r
                    if not self.__IsToken( "="):\r
                        raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
                    if not self.__GetNextHexNumber():\r
                        raise Warning("expected Hex class code", self.FileName, self.CurrentLineNumber)\r
                    Overrides.PciClassCode = self.__Token\r
                    continue\r
\r
                if self.__IsKeyword( "PCI_DEVICE_ID"):\r
                    if not self.__IsToken( "="):\r
                        raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
                    if not self.__GetNextHexNumber():\r
                        raise Warning("expected Hex device id", self.FileName, self.CurrentLineNumber)\r
\r
                    Overrides.PciDeviceId = self.__Token\r
                    continue\r
\r
                if self.__IsKeyword( "PCI_REVISION"):\r
                    if not self.__IsToken( "="):\r
                        raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
                    if not self.__GetNextHexNumber():\r
                        raise Warning("expected Hex revision", self.FileName, self.CurrentLineNumber)\r
                    Overrides.PciRevision = self.__Token\r
                    continue\r
\r
                if self.__IsKeyword( "PCI_COMPRESS"):\r
                    if not self.__IsToken( "="):\r
                        raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
                    if not self.__GetNextToken():\r
                        raise Warning("expected TRUE/FALSE for compress", self.FileName, self.CurrentLineNumber)\r
                    Overrides.NeedCompress = self.__Token.upper() == 'TRUE'\r
                    continue\r
\r
                if self.__IsToken( "}"):\r
                    break\r
                else:\r
                    EdkLogger.error("FdfParser", FORMAT_INVALID, File=self.FileName, Line=self.CurrentLineNumber)\r
\r
            Obj.OverrideAttribs = Overrides\r
            \r
    ## __GetOptRomFileStatement() method\r
    #\r
    #   Get FILE statements\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Obj         for whom FILE statement is got\r
    #   @retval True        Successfully find FILE statement\r
    #   @retval False       Not able to find FILE statement\r
    #\r
    def __GetOptRomFileStatement(self, Obj):\r
\r
        if not self.__IsKeyword( "FILE"):\r
            return False\r
\r
        FfsFileObj = OptRomFileStatement.OptRomFileStatement()\r
\r
        if not self.__IsKeyword("EFI") and not self.__IsKeyword("BIN"):\r
            raise Warning("expected Binary type (EFI/BIN)", self.FileName, self.CurrentLineNumber)\r
        FfsFileObj.FileType = self.__Token\r
\r
        if not self.__GetNextToken():\r
            raise Warning("expected File path", self.FileName, self.CurrentLineNumber)\r
        FfsFileObj.FileName = self.__Token\r
        if FfsFileObj.FileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
            #check for file path\r
            ErrorCode, ErrorInfo = PathClass(NormPath(FfsFileObj.FileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
            if ErrorCode != 0:\r
                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
\r
        if FfsFileObj.FileType == 'EFI':\r
            self.__GetOptRomOverrides(FfsFileObj)\r
        \r
        Obj.FfsList.append(FfsFileObj)\r
\r
        return True\r
\r
    ## __GetCapInFd() method\r
    #\r
    #   Get Cap list contained in FD\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FdName      FD name\r
    #   @retval CapList     List of Capsule in FD\r
    #\r
    def __GetCapInFd (self, FdName):\r
\r
        CapList = []\r
        if FdName.upper() in self.Profile.FdDict.keys():\r
            FdObj = self.Profile.FdDict[FdName.upper()]\r
            for elementRegion in FdObj.RegionList:\r
                if elementRegion.RegionType == 'CAPSULE':\r
                    for elementRegionData in elementRegion.RegionDataList:\r
                        if elementRegionData.endswith(".cap"):\r
                            continue\r
                        if elementRegionData != None and elementRegionData.upper() not in CapList:\r
                            CapList.append(elementRegionData.upper())\r
        return CapList\r
\r
    ## __GetReferencedFdCapTuple() method\r
    #\r
    #   Get FV and FD list referenced by a capsule image\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  CapObj      Capsule section to be searched\r
    #   @param  RefFdList   referenced FD by section\r
    #   @param  RefFvList   referenced FV by section\r
    #\r
    def __GetReferencedFdCapTuple(self, CapObj, RefFdList = [], RefFvList = []):\r
\r
        for CapsuleDataObj in CapObj.CapsuleDataList :\r
            if hasattr(CapsuleDataObj, 'FvName') and CapsuleDataObj.FvName != None and CapsuleDataObj.FvName.upper() not in RefFvList:\r
                RefFvList.append (CapsuleDataObj.FvName.upper())\r
            elif hasattr(CapsuleDataObj, 'FdName') and CapsuleDataObj.FdName != None and CapsuleDataObj.FdName.upper() not in RefFdList:\r
                RefFdList.append (CapsuleDataObj.FdName.upper())            \r
            elif CapsuleDataObj.Ffs != None:\r
                if isinstance(CapsuleDataObj.Ffs, FfsFileStatement.FileStatement):\r
                    if CapsuleDataObj.Ffs.FvName != None and CapsuleDataObj.Ffs.FvName.upper() not in RefFvList:\r
                        RefFvList.append(CapsuleDataObj.Ffs.FvName.upper())\r
                    elif CapsuleDataObj.Ffs.FdName != None and CapsuleDataObj.Ffs.FdName.upper() not in RefFdList:\r
                        RefFdList.append(CapsuleDataObj.Ffs.FdName.upper())\r
                    else:\r
                        self.__GetReferencedFdFvTupleFromSection(CapsuleDataObj.Ffs, RefFdList, RefFvList)\r
\r
    ## __GetFvInFd() method\r
    #\r
    #   Get FV list contained in FD\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FdName      FD name\r
    #   @retval FvList      list of FV in FD\r
    #\r
    def __GetFvInFd (self, FdName):\r
\r
        FvList = []\r
        if FdName.upper() in self.Profile.FdDict.keys():\r
            FdObj = self.Profile.FdDict[FdName.upper()]\r
            for elementRegion in FdObj.RegionList:\r
                if elementRegion.RegionType == 'FV':\r
                    for elementRegionData in elementRegion.RegionDataList:\r
                        if elementRegionData.endswith(".fv"):\r
                            continue\r
                        if elementRegionData != None and elementRegionData.upper() not in FvList:\r
                            FvList.append(elementRegionData.upper())\r
        return FvList\r
\r
    ## __GetReferencedFdFvTuple() method\r
    #\r
    #   Get FD and FV list referenced by a FFS file\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FfsFile     contains sections to be searched\r
    #   @param  RefFdList   referenced FD by section\r
    #   @param  RefFvList   referenced FV by section\r
    #\r
    def __GetReferencedFdFvTuple(self, FvObj, RefFdList = [], RefFvList = []):\r
\r
        for FfsObj in FvObj.FfsList:\r
            if isinstance(FfsObj, FfsFileStatement.FileStatement):\r
                if FfsObj.FvName != None and FfsObj.FvName.upper() not in RefFvList:\r
                    RefFvList.append(FfsObj.FvName.upper())\r
                elif FfsObj.FdName != None and FfsObj.FdName.upper() not in RefFdList:\r
                    RefFdList.append(FfsObj.FdName.upper())\r
                else:\r
                    self.__GetReferencedFdFvTupleFromSection(FfsObj, RefFdList, RefFvList)\r
\r
    ## __GetReferencedFdFvTupleFromSection() method\r
    #\r
    #   Get FD and FV list referenced by a FFS section\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FfsFile     contains sections to be searched\r
    #   @param  FdList      referenced FD by section\r
    #   @param  FvList      referenced FV by section\r
    #\r
    def __GetReferencedFdFvTupleFromSection(self, FfsFile, FdList = [], FvList = []):\r
\r
        SectionStack = []\r
        SectionStack.extend(FfsFile.SectionList)\r
        while SectionStack != []:\r
            SectionObj = SectionStack.pop()\r
            if isinstance(SectionObj, FvImageSection.FvImageSection):\r
                if SectionObj.FvName != None and SectionObj.FvName.upper() not in FvList:\r
                    FvList.append(SectionObj.FvName.upper())\r
                if SectionObj.Fv != None and SectionObj.Fv.UiFvName != None and SectionObj.Fv.UiFvName.upper() not in FvList:\r
                    FvList.append(SectionObj.Fv.UiFvName.upper())\r
                    self.__GetReferencedFdFvTuple(SectionObj.Fv, FdList, FvList)\r
\r
            if isinstance(SectionObj, CompressSection.CompressSection) or isinstance(SectionObj, GuidSection.GuidSection):\r
                SectionStack.extend(SectionObj.SectionList)\r
\r
    ## CycleReferenceCheck() method\r
    #\r
    #   Check whether cycle reference exists in FDF\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval True        cycle reference exists\r
    #   @retval False       Not exists cycle reference\r
    #\r
    def CycleReferenceCheck(self):\r
        #\r
        # Check the cycle between FV and FD image\r
        #\r
        MaxLength = len (self.Profile.FvDict)\r
        for FvName in self.Profile.FvDict.keys():\r
            LogStr = "\nCycle Reference Checking for FV: %s\n" % FvName\r
            RefFvStack = []\r
            RefFvStack.append(FvName)\r
            FdAnalyzedList = []\r
            \r
            Index = 0\r
            while RefFvStack != [] and Index < MaxLength:\r
                Index = Index + 1\r
                FvNameFromStack = RefFvStack.pop()\r
                if FvNameFromStack.upper() in self.Profile.FvDict.keys():\r
                    FvObj = self.Profile.FvDict[FvNameFromStack.upper()]\r
                else:\r
                    continue\r
\r
                RefFdList = []\r
                RefFvList = []\r
                self.__GetReferencedFdFvTuple(FvObj, RefFdList, RefFvList)\r
\r
                for RefFdName in RefFdList:\r
                    if RefFdName in FdAnalyzedList:\r
                        continue\r
\r
                    LogStr += "FV %s contains FD %s\n" % (FvNameFromStack, RefFdName)\r
                    FvInFdList = self.__GetFvInFd(RefFdName)\r
                    if FvInFdList != []:\r
                        for FvNameInFd in FvInFdList:\r
                            LogStr += "FD %s contains FV %s\n" % (RefFdName,FvNameInFd)\r
                            if FvNameInFd not in RefFvStack:\r
                                RefFvStack.append(FvNameInFd)\r
\r
                            if FvName in RefFvStack or FvNameFromStack in RefFvStack:\r
                                EdkLogger.info(LogStr)\r
                                return True\r
                    FdAnalyzedList.append(RefFdName)\r
\r
                for RefFvName in RefFvList:\r
                    LogStr += "FV %s contains FV %s\n" % (FvNameFromStack, RefFvName)\r
                    if RefFvName not in RefFvStack:\r
                        RefFvStack.append(RefFvName)\r
\r
                    if FvName in RefFvStack or FvNameFromStack in RefFvStack:\r
                        EdkLogger.info(LogStr)\r
                        return True\r
\r
        #\r
        # Check the cycle between Capsule and FD image\r
        #\r
        MaxLength = len (self.Profile.CapsuleDict)\r
        for CapName in self.Profile.CapsuleDict.keys():\r
            #\r
            # Capsule image to be checked.\r
            #\r
            LogStr = "\n\n\nCycle Reference Checking for Capsule: %s\n" % CapName\r
            RefCapStack = []\r
            RefCapStack.append(CapName)\r
            FdAnalyzedList = []\r
            FvAnalyzedList = []\r
            \r
            Index = 0\r
            while RefCapStack != [] and Index < MaxLength:\r
                Index = Index + 1\r
                CapNameFromStack = RefCapStack.pop()\r
                if CapNameFromStack.upper() in self.Profile.CapsuleDict.keys():\r
                    CapObj = self.Profile.CapsuleDict[CapNameFromStack.upper()]\r
                else:\r
                    continue\r
\r
                RefFvList = []\r
                RefFdList = []\r
                self.__GetReferencedFdCapTuple(CapObj, RefFdList, RefFvList)\r
\r
                FvListLength = 0\r
                FdListLength = 0\r
                while FvListLength < len (RefFvList) or FdListLength < len (RefFdList):\r
                    for RefFdName in RefFdList:\r
                        if RefFdName in FdAnalyzedList:\r
                            continue\r
\r
                        LogStr += "Capsule %s contains FD %s\n" % (CapNameFromStack, RefFdName)\r
                        CapInFdList = self.__GetCapInFd(RefFdName)\r
                        if CapInFdList != []:\r
                            for CapNameInFd in CapInFdList:\r
                                LogStr += "FD %s contains Capsule %s\n" % (RefFdName,CapNameInFd)\r
                                if CapNameInFd not in RefCapStack:\r
                                    RefCapStack.append(CapNameInFd)\r
\r
                                if CapName in RefCapStack or CapNameFromStack in RefCapStack:\r
                                    EdkLogger.info(LogStr)\r
                                    return True\r
\r
                        FvInFdList = self.__GetFvInFd(RefFdName)\r
                        if FvInFdList != []:\r
                            for FvNameInFd in FvInFdList:\r
                                LogStr += "FD %s contains FV %s\n" % (RefFdName,FvNameInFd)\r
                                if FvNameInFd not in RefFvList:\r
                                    RefFvList.append(FvNameInFd)\r
\r
                        FdAnalyzedList.append(RefFdName)\r
                    #\r
                    # the number of the parsed FV and FD image\r
                    #\r
                    FvListLength = len (RefFvList)\r
                    FdListLength = len (RefFdList)\r
                    for RefFvName in RefFvList:\r
                        if RefFvName in FvAnalyzedList:\r
                            continue\r
                        LogStr += "Capsule %s contains FV %s\n" % (CapNameFromStack, RefFvName)\r
                        if RefFvName.upper() in self.Profile.FvDict.keys():\r
                            FvObj = self.Profile.FvDict[RefFvName.upper()]\r
                        else:\r
                            continue\r
                        self.__GetReferencedFdFvTuple(FvObj, RefFdList, RefFvList)\r
                        FvAnalyzedList.append(RefFvName)\r
\r
        return False\r
\r
if __name__ == "__main__":\r
    import sys\r
    try:\r
        test_file = sys.argv[1]\r
    except IndexError, v:\r
        print "Usage: %s filename" % sys.argv[0]\r
        sys.exit(1)\r
\r
    parser = FdfParser(test_file)\r
    try:\r
        parser.ParseFile()\r
        parser.CycleReferenceCheck()\r
    except Warning, X:\r
        print str(X)\r
    else:\r
        print "Success!"\r
\r