4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# This file is used to define common parsing related functions used in parsing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# This program and the accompanying materials are licensed and made available
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# under the terms and conditions of the BSD License which accompanies this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Import Modules
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncfrom Library.Misc import GuidStructureStringToGuidString
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## GetBuildOption
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Parse a string with format "[<Family>:]<ToolFlag>=Flag"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Return (Family, ToolFlag, Flag)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param String: String with BuildOption statement
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param File: The file which defines build option, used in error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync List = GetSplitValueList(String, DataType.TAB_EQUAL_SPLIT, MaxSplit=1)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ToolChain = List[0][List[0].find(':') + 1 : ].strip()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Get Library Class
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get Library of Dsc as <LibraryClassKeyWord>|<LibraryInstance>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <LibraryClassKeyWord>|<LibraryInstance>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the library class, used for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GetLibraryClass(Item, ContainerFile, WorkspaceDir, LineNo=-1):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item[0], 'LibraryClasses', ContainerFile, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync '<LibraryClassKeyWord>|<LibraryInstance>')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CheckFileExist(WorkspaceDir, List[1], ContainerFile, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Get Library Class
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get Library of Dsc as <LibraryClassKeyWord>[|<LibraryInstance>]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# [|<TokenSpaceGuidCName>.<PcdCName>]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <LibraryClassKeyWord>|<LibraryInstance>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the library class, used for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GetLibraryClassOfInf(Item, ContainerFile, WorkspaceDir, LineNo = -1):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ItemList = GetSplitValueList((Item[0] + DataType.TAB_VALUE_SPLIT * 2))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync '<LibraryClassKeyWord>[|<LibraryInstance>]\
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CheckFileType(ItemList[1], '.Inf', ContainerFile, 'LibraryClasses', \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CheckFileExist(WorkspaceDir, ItemList[1], ContainerFile, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (ItemList[0], ItemList[1], ItemList[2], SupMod)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## CheckPcdTokenInfo
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Check if PcdTokenInfo is following <TokenSpaceGuidCName>.<PcdCName>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param TokenInfoString: String to be checked
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Section: Used for error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param File: Used for error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef CheckPcdTokenInfo(TokenInfoString, Section, File, LineNo=-1):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if TokenInfoString != '' and TokenInfoString != None:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TokenInfoList = GetSplitValueList(TokenInfoString, DataType.TAB_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(TokenInfoString, Section, File, Format, LineNo)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get Pcd of Dsc as <PcdTokenSpaceGuidCName>.<TokenCName>|<Value>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# [|<Type>|<MaximumDatumSize>]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <PcdTokenSpaceGuidCName>.<TokenCName>|
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# <Value>[|<Type>|<MaximumDatumSize>]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the pcd, used for error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TokenGuid, TokenName, Value, MaximumDatumSize, Token = '', '', '', '', ''
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync List = GetSplitValueList(Item + DataType.TAB_VALUE_SPLIT * 2)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item, 'Pcds' + Type, ContainerFile, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync '<PcdTokenSpaceGuidCName>.<TokenCName>|<Value>\
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if CheckPcdTokenInfo(List[0], 'Pcds' + Type, ContainerFile, LineNo):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (TokenGuid, TokenName) = GetSplitValueList(List[0], DataType.TAB_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (TokenName, TokenGuid, Value, MaximumDatumSize, Token, Type)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Get FeatureFlagPcd
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get FeatureFlagPcd of Dsc as <PcdTokenSpaceGuidCName>.<TokenCName>|TRUE/FALSE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <PcdTokenSpaceGuidCName>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# .<TokenCName>|TRUE/FALSE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the pcd, used for error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GetFeatureFlagPcd(Item, Type, ContainerFile, LineNo=-1):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item, 'Pcds' + Type, ContainerFile, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync '<PcdTokenSpaceGuidCName>.<TokenCName>|TRUE/FALSE', \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if CheckPcdTokenInfo(List[0], 'Pcds' + Type, ContainerFile, LineNo):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (TokenGuid, TokenName) = GetSplitValueList(List[0], DataType.TAB_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Get DynamicDefaultPcd
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get DynamicDefaultPcd of Dsc as <PcdTokenSpaceGuidCName>.<TokenCName>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# |<Value>[|<DatumTyp>[|<MaxDatumSize>]]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <PcdTokenSpaceGuidCName>.<TokenCName>|
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the pcd, used for error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GetDynamicDefaultPcd(Item, Type, ContainerFile, LineNo=-1):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TokenGuid, TokenName, Value, DatumTyp, MaxDatumSize = '', '', '', '', ''
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync List = GetSplitValueList(Item + DataType.TAB_VALUE_SPLIT * 2)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item, 'Pcds' + Type, ContainerFile, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync '<PcdTokenSpaceGuidCName>.<TokenCName>|<Value>\
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if CheckPcdTokenInfo(List[0], 'Pcds' + Type, ContainerFile, LineNo):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (TokenGuid, TokenName) = GetSplitValueList(List[0], DataType.TAB_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (TokenName, TokenGuid, Value, DatumTyp, MaxDatumSize, Type)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Get DynamicHiiPcd
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get DynamicHiiPcd of Dsc as <PcdTokenSpaceGuidCName>.<TokenCName>|<String>|
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# <VariableGuidCName>|<VariableOffset>[|<DefaultValue>[|<MaximumDatumSize>]]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <PcdTokenSpaceGuidCName>.<TokenCName>|
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the pcd, used for error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GetDynamicHiiPcd(Item, Type, ContainerFile, LineNo = -1):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TokenGuid, TokenName, List1, List2, List3, List4, List5 = \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync List = GetSplitValueList(Item + DataType.TAB_VALUE_SPLIT * 2)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item, 'Pcds' + Type, ContainerFile, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync '<PcdTokenSpaceGuidCName>.<TokenCName>|<String>|\
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <VariableGuidCName>|<VariableOffset>[|<DefaultValue>\
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if CheckPcdTokenInfo(List[0], 'Pcds' + Type, ContainerFile, LineNo):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (TokenGuid, TokenName) = GetSplitValueList(List[0], DataType.TAB_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (TokenName, TokenGuid, List1, List2, List3, List4, List5, Type)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Get DynamicVpdPcd
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get DynamicVpdPcd of Dsc as <PcdTokenSpaceGuidCName>.<TokenCName>|
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# <VpdOffset>[|<MaximumDatumSize>]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <PcdTokenSpaceGuidCName>.<TokenCName>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the pcd, used for error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GetDynamicVpdPcd(Item, Type, ContainerFile, LineNo=-1):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TokenGuid, TokenName, List1, List2 = '', '', '', ''
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync List = GetSplitValueList(Item + DataType.TAB_VALUE_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item, 'Pcds' + Type, ContainerFile, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync '<PcdTokenSpaceGuidCName>.<TokenCName>|<VpdOffset>\
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if CheckPcdTokenInfo(List[0], 'Pcds' + Type, ContainerFile, LineNo):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (TokenGuid, TokenName) = GetSplitValueList(List[0], DataType.TAB_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## GetComponent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Parse block of the components defined in dsc file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Set KeyValues as [ ['component name', [lib1, lib2, lib3],
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# [bo1, bo2, bo3], [pcd1, pcd2, pcd3]], ...]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Lines: The content to be parsed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param KeyValues: To store data after parsing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindBlock, FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FindPcdsPatchableInModule, FindPcdsFixedAtBuild, FindPcdsDynamic, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FindPcdsDynamicEx) = (False, False, False, False, False, False, False, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # Ignore !include statement
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if Line.upper().find(DataType.TAB_INCLUDE.upper() + ' ') > -1 or \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # find '{' at line tail
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # Parse a block content
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # find '}' at line tail
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FindPcdsFixedAtBuild, FindPcdsDynamic, FindPcdsDynamicEx) = \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (False, False, False, False, False, False, False, False)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Pcd.append((DataType.TAB_PCDS_FEATURE_FLAG_NULL, Line))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Pcd.append((DataType.TAB_PCDS_PATCHABLE_IN_MODULE_NULL, Line))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Pcd.append((DataType.TAB_PCDS_FIXED_AT_BUILD_NULL, Line))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Pcd.append((DataType.TAB_PCDS_DYNAMIC_DEFAULT_NULL, Line))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Pcd.append((DataType.TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL, Line))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Parse a string with format "InfFilename [EXEC = ExecFilename]"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Return (InfFilename, ExecFilename)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param String: String with EXEC statement
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InfFilename = String[ : String.find('EXEC')].strip()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ExecFilename = String[String.find('EXEC') + len('EXEC') : ].strip()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## GetComponents
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Parse block of the components defined in dsc file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Set KeyValues as [ ['component name', [lib1, lib2, lib3], [bo1, bo2, bo3],
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# [pcd1, pcd2, pcd3]], ...]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Lines: The content to be parsed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Key: Reserved
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param KeyValues: To store data after parsing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param CommentCharacter: Comment char, used to ignore comment content
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @retval True Get component successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GetComponents(Lines, KeyValues, CommentCharacter):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Lines = Lines.split(DataType.TAB_SECTION_END, 1)[1]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindBlock, FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FindPcdsPatchableInModule, FindPcdsFixedAtBuild, FindPcdsDynamic, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (False, False, False, False, False, False, False, False)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # find '{' at line tail
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ListItem = CleanString(Line.rsplit('{', 1)[0], CommentCharacter)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # Parse a block content
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (FindLibraryClass, FindBuildOption, FindPcdsFeatureFlag, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # find '}' at line tail
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync KeyValues.append([ListItem, LibraryClassItem, BuildOption, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FindPcdsFixedAtBuild, FindPcdsDynamic, FindPcdsDynamicEx) = \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (False, False, False, False, False, False, False, False)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Pcd.append((DataType.TAB_PCDS_PATCHABLE_IN_MODULE, Line))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Pcd.append((DataType.TAB_PCDS_FIXED_AT_BUILD, Line))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Get Source
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get Source of Inf as <Filename>[|<Family>[|<TagName>[|<ToolCode>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# [|<PcdFeatureFlag>]]]]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <Filename>[|<Family>[|<TagName>[|<ToolCode>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# [|<PcdFeatureFlag>]]]]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the library class, used
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# for error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GetSource(Item, ContainerFile, FileRelativePath, LineNo=-1):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync '<Filename>[|<Family>[|<TagName>[|<ToolCode>\
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CheckFileExist(FileRelativePath, List[0], ContainerFile, 'Sources', \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CheckPcdTokenInfo(List[4], 'Sources', ContainerFile, LineNo)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (List[0], List[1], List[2], List[3], List[4])
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Get Binary
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get Binary of Inf as <Filename>[|<Family>[|<TagName>[|<ToolCode>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# [|<PcdFeatureFlag>]]]]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <Filename>[|<Family>[|<TagName>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# [|<ToolCode>[|<PcdFeatureFlag>]]]]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the library class,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# used for error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item, 'Binaries', ContainerFile, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "<FileType>|<Filename>[|<Target>\
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CheckPcdTokenInfo(List[3], 'Binaries', ContainerFile, LineNo)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get Guids/Protocols/Ppis of Inf as <GuidCName>[|<PcdFeatureFlag>]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <GuidCName>[|<PcdFeatureFlag>]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Type: Type of parsing string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the library class,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# used for error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get Guids/Protocols/Ppis of Dec as <GuidCName>=<GuidValue>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <GuidCName>=<GuidValue>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Type: Type of parsing string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the library class,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# used for error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GetGuidsProtocolsPpisOfDec(Item, Type, ContainerFile, LineNo=-1):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync List = GetSplitValueList(Item, DataType.TAB_EQUAL_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item, Type, ContainerFile, '<CName>=<GuidValue>', \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync #convert C-Format Guid to Register Format
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RegisterFormatGuid = GuidStructureStringToGuidString(List[1])
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## GetPackage
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get Package of Inf as <PackagePath>[|<PcdFeatureFlag>]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: String as <PackagePath>[|<PcdFeatureFlag>]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Type: Type of parsing string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ContainerFile: The file which describes the library class,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# used for error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GetPackage(Item, ContainerFile, FileRelativePath, LineNo=-1):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CheckFileType(List[0], '.Dec', ContainerFile, 'package', List[0], LineNo)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CheckFileExist(FileRelativePath, List[0], ContainerFile, 'Packages', \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CheckPcdTokenInfo(List[1], 'Packages', ContainerFile, LineNo)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Get Pcd Values of Inf
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get Pcd of Inf as <TokenSpaceGuidCName>.<PcdCName>[|<Value>]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: The string describes pcd
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Type: The type of Pcd
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param File: The file which describes the pcd, used for error report
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Format = '<TokenSpaceGuidCName>.<PcdCName>[|<Value>]'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TokenGuid, TokenName, Value, InfType = '', '', '', ''
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync elif Type == DataType.TAB_PCDS_PATCHABLE_IN_MODULE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync List = GetSplitValueList(Item, DataType.TAB_VALUE_SPLIT, 1)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TokenInfo = GetSplitValueList(List[0], DataType.TAB_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item, InfType, File, Format, LineNo)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Get Pcd Values of Dec
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get Pcd of Dec as <TokenSpcCName>.<TokenCName>|<Value>|<DatumType>|<Token>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Item: Pcd item
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Type: Pcd type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param File: Dec file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param LineNo: Line number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Format = '<TokenSpaceGuidCName>.<PcdCName>|<Value>|<DatumType>|<Token>'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TokenGuid, TokenName, Value, DatumType, Token = '', '', '', '', ''
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item, 'Pcds' + Type, File, Format, LineNo)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TokenInfo = GetSplitValueList(List[0], DataType.TAB_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RaiseParserError(Item, 'Pcds' + Type, File, Format, LineNo)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (TokenGuid, TokenName, Value, DatumType, Token, Type)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## Parse DEFINE statement
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get DEFINE macros
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param LineValue: A DEFINE line value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param StartLine: A DEFINE start line
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Table: A table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param FileID: File ID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Filename: File name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param SectionName: DEFINE section name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param SectionModel: DEFINE section model
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Arch: DEFINE arch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef ParseDefine(LineValue, StartLine, Table, FileID, SectionName, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Logger.Debug(Logger.DEBUG_2, ST.MSG_DEFINE_STATEMENT_FOUND % (LineValue, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Table.Insert(DataType.MODEL_META_DATA_DEFINE, Define[0], Define[1], '', \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync '', '', Arch, SectionModel, FileID, StartLine, -1, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## InsertSectionItems
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Insert item data of a section to a dict
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Model: A model
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param CurrentSection: Current section
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param SectionItemList: Section item list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ArchList: Arch list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param ThirdList: Third list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param RecordSet: Record set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef InsertSectionItems(Model, SectionItemList, ArchList, \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # Insert each item data of a section
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # And then parse DEFINE statement
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if LineValue.upper().find(DataType.TAB_DEFINE.upper() + ' ') > -1:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # At last parse other sections
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Records.append([LineValue, Arch, StartLine, IdNum, Third, Comment])
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## GenMetaDatSectionItem
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Key: A key
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Value: A value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param List: A list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## GetPkgInfoFromDec
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# get package name, guid, version info from dec files
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Path: File path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gPKG_INFO_DICT[Path] = (PkgName, PkgGuid, PkgVersion)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return None, None, None
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## GetWorkspacePackage
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get a list of workspace package information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # abstract package guid, version info from DecFile List
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (PkgName, PkgGuid, PkgVersion) = GetPkgInfoFromDec(DecFile)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PkgList.append((PkgName, PkgGuid, PkgVersion, DecFile))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## GetWorkspaceModule
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Get a list of workspace modules.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## MacroParser used to parse macro definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Line: The content contain linestring and line number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param FileName: The meta-file file name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param SectionType: Section for the Line belong to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param FileLocalMacros: A list contain Macro defined in [Defines] section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef MacroParser(Line, FileName, SectionType, FileLocalMacros):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # Not 'DEFINE/EDK_GLOBAL' statement, call decorated method
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return None, None
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TokenList = GetSplitValueList(LineContent[Match.end(1):], \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # Syntax check
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Logger.Error('Parser', FORMAT_INVALID, ST.ERR_MACRONAME_NOGIVEN,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Logger.Error('Parser', FORMAT_INVALID, ST.ERR_MACROVALUE_NOGIVEN,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # DEFINE defined macros
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReIsValidMacroName = re.compile(r"^[A-Z][A-Z0-9_]*$", re.DOTALL)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # Validate MACRO Value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # <MacroDefinition> ::= [<Comments>]{0,}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # "DEFINE" <MACRO> "=" [{<PATH>} {<VALUE>}] <EOL>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # <Value> ::= {<NumVal>} {<Boolean>} {<AsciiString>} {<GUID>}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # {<CString>} {<UnicodeString>} {<CArray>}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # The definition of <NumVal>, <PATH>, <Boolean>, <GUID>, <CString>,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync # <UnicodeString>, <CArray> are subset of <AsciiString>.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReIsValidMacroValue = re.compile(r"^[\x20-\x7e]*$", re.DOTALL)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## GenSection
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# generate section contents
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param SectionName: indicate the name of the section, details refer to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# INF, DEC specs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param SectionDict: section statement dict, key is SectionAttrs(arch,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# moduletype or platform may exist as needed) list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# seperated by space,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# value is statement
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncdef GenSection(SectionName, SectionDict, SplitArch=True):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if SectionAttrs and SectionName != 'Defines' and SectionAttrs.strip().upper() != DataType.TAB_ARCH_COMMON:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ArchList = GetSplitValueList(SectionAttrs, DataType.TAB_SPACE_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ArchList = GetSplitValueList(SectionAttrs, DataType.TAB_COMMENT_SPLIT)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ArchList[Index] = ConvertArchForInstall(ArchList[Index])
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Section = '[' + SectionName + '.' + (', ' + SectionName + '.').join(ArchList) + ']'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync## ConvertArchForInstall
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# if Arch.upper() is in "IA32", "X64", "IPF", and "EBC", it must be upper case. "common" must be lower case.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# Anything else, the case must be preserved
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @param Arch: the arch string that need to be converted, it should be stripped before pass in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync# @return: the arch string that get converted