[mirror_edk2.git] / BaseTools / Source / Python / Common / Misc.py

## @file\r
# Common routines used by all tools\r
#\r
# Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# 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
from __future__ import absolute_import\r
\r
import sys\r
import string\r
import threading\r
import time\r
import re\r
import pickle\r
import array\r
import shutil\r
from random import sample\r
from struct import pack\r
import uuid\r
import subprocess\r
from collections import OrderedDict\r
\r
import Common.LongFilePathOs as os\r
from Common import EdkLogger as EdkLogger\r
from Common import GlobalData as GlobalData\r
from Common.DataType import *\r
from Common.BuildToolError import *\r
from CommonDataClass.DataClass import *\r
from Common.Parsing import GetSplitValueList\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
from Common.MultipleWorkspace import MultipleWorkspace as mws\r
from CommonDataClass.Exceptions import BadExpression\r
from Common.caching import cached_property\r
\r
## Regular expression used to find out place holders in string template\r
gPlaceholderPattern = re.compile("\$\{([^$()\s]+)\}", re.MULTILINE | re.UNICODE)\r
\r
## regular expressions for map file processing\r
startPatternGeneral = re.compile("^Start[' ']+Length[' ']+Name[' ']+Class")\r
addressPatternGeneral = re.compile("^Address[' ']+Publics by Value[' ']+Rva\+Base")\r
valuePatternGcc = re.compile('^([\w_\.]+) +([\da-fA-Fx]+) +([\da-fA-Fx]+)$')\r
pcdPatternGcc = re.compile('^([\da-fA-Fx]+) +([\da-fA-Fx]+)')\r
secReGeneral = re.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\da-fA-F]+)[Hh]? +([.\w\$]+) +(\w+)', re.UNICODE)\r
\r
StructPattern = re.compile(r'[_a-zA-Z][0-9A-Za-z_]*$')\r
\r
## Dictionary used to store dependencies of files\r
gDependencyDatabase = {}    # arch : {file path : [dependent files list]}\r
\r
#\r
# If a module is built more than once with different PCDs or library classes\r
# a temporary INF file with same content is created, the temporary file is removed\r
# when build exits.\r
#\r
_TempInfs = []\r
\r
def GetVariableOffset(mapfilepath, efifilepath, varnames):\r
    """ Parse map file to get variable offset in current EFI file\r
    @param mapfilepath    Map file absolution path\r
    @param efifilepath:   EFI binary file full path\r
    @param varnames       iteratable container whose elements are variable names to be searched\r
\r
    @return List whos elements are tuple with variable name and raw offset\r
    """\r
    lines = []\r
    try:\r
        f = open(mapfilepath, 'r')\r
        lines = f.readlines()\r
        f.close()\r
    except:\r
        return None\r
\r
    if len(lines) == 0: return None\r
    firstline = lines[0].strip()\r
    if (firstline.startswith("Archive member included ") and\r
        firstline.endswith(" file (symbol)")):\r
        return _parseForGCC(lines, efifilepath, varnames)\r
    if firstline.startswith("# Path:"):\r
        return _parseForXcode(lines, efifilepath, varnames)\r
    return _parseGeneral(lines, efifilepath, varnames)\r
\r
def _parseForXcode(lines, efifilepath, varnames):\r
    status = 0\r
    ret = []\r
    for line in lines:\r
        line = line.strip()\r
        if status == 0 and line == "# Symbols:":\r
            status = 1\r
            continue\r
        if status == 1 and len(line) != 0:\r
            for varname in varnames:\r
                if varname in line:\r
                    # cannot pregenerate this RegEx since it uses varname from varnames.\r
                    m = re.match('^([\da-fA-FxX]+)([\s\S]*)([_]*%s)$' % varname, line)\r
                    if m is not None:\r
                        ret.append((varname, m.group(1)))\r
    return ret\r
\r
def _parseForGCC(lines, efifilepath, varnames):\r
    """ Parse map file generated by GCC linker """\r
    status = 0\r
    sections = []\r
    varoffset = []\r
    for index, line in enumerate(lines):\r
        line = line.strip()\r
        # status machine transection\r
        if status == 0 and line == "Memory Configuration":\r
            status = 1\r
            continue\r
        elif status == 1 and line == 'Linker script and memory map':\r
            status = 2\r
            continue\r
        elif status ==2 and line == 'START GROUP':\r
            status = 3\r
            continue\r
\r
        # status handler\r
        if status == 3:\r
            m = valuePatternGcc.match(line)\r
            if m is not None:\r
                sections.append(m.groups(0))\r
            for varname in varnames:\r
                Str = ''\r
                m = re.match("^.data.(%s)" % varname, line)\r
                if m is not None:\r
                    m = re.match(".data.(%s)$" % varname, line)\r
                    if m is not None:\r
                        Str = lines[index + 1]\r
                    else:\r
                        Str = line[len(".data.%s" % varname):]\r
                    if Str:\r
                        m = pcdPatternGcc.match(Str.strip())\r
                        if m is not None:\r
                            varoffset.append((varname, int(m.groups(0)[0], 16), int(sections[-1][1], 16), sections[-1][0]))\r
\r
    if not varoffset:\r
        return []\r
    # get section information from efi file\r
    efisecs = PeImageClass(efifilepath).SectionHeaderList\r
    if efisecs is None or len(efisecs) == 0:\r
        return []\r
    #redirection\r
    redirection = 0\r
    for efisec in efisecs:\r
        for section in sections:\r
            if section[0].strip() == efisec[0].strip() and section[0].strip() == '.text':\r
                redirection = int(section[1], 16) - efisec[1]\r
\r
    ret = []\r
    for var in varoffset:\r
        for efisec in efisecs:\r
            if var[1] >= efisec[1] and var[1] < efisec[1]+efisec[3]:\r
                ret.append((var[0], hex(efisec[2] + var[1] - efisec[1] - redirection)))\r
    return ret\r
\r
def _parseGeneral(lines, efifilepath, varnames):\r
    status = 0    #0 - beginning of file; 1 - PE section definition; 2 - symbol table\r
    secs  = []    # key = section name\r
    varoffset = []\r
    symRe = re.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\.:\\\\\w\?@\$]+) +([\da-fA-F]+)', re.UNICODE)\r
\r
    for line in lines:\r
        line = line.strip()\r
        if startPatternGeneral.match(line):\r
            status = 1\r
            continue\r
        if addressPatternGeneral.match(line):\r
            status = 2\r
            continue\r
        if line.startswith("entry point at"):\r
            status = 3\r
            continue\r
        if status == 1 and len(line) != 0:\r
            m =  secReGeneral.match(line)\r
            assert m is not None, "Fail to parse the section in map file , line is %s" % line\r
            sec_no, sec_start, sec_length, sec_name, sec_class = m.groups(0)\r
            secs.append([int(sec_no, 16), int(sec_start, 16), int(sec_length, 16), sec_name, sec_class])\r
        if status == 2 and len(line) != 0:\r
            for varname in varnames:\r
                m = symRe.match(line)\r
                assert m is not None, "Fail to parse the symbol in map file, line is %s" % line\r
                sec_no, sym_offset, sym_name, vir_addr = m.groups(0)\r
                sec_no     = int(sec_no,     16)\r
                sym_offset = int(sym_offset, 16)\r
                vir_addr   = int(vir_addr,   16)\r
                # cannot pregenerate this RegEx since it uses varname from varnames.\r
                m2 = re.match('^[_]*(%s)' % varname, sym_name)\r
                if m2 is not None:\r
                    # fond a binary pcd entry in map file\r
                    for sec in secs:\r
                        if sec[0] == sec_no and (sym_offset >= sec[1] and sym_offset < sec[1] + sec[2]):\r
                            varoffset.append([varname, sec[3], sym_offset, vir_addr, sec_no])\r
\r
    if not varoffset: return []\r
\r
    # get section information from efi file\r
    efisecs = PeImageClass(efifilepath).SectionHeaderList\r
    if efisecs is None or len(efisecs) == 0:\r
        return []\r
\r
    ret = []\r
    for var in varoffset:\r
        index = 0\r
        for efisec in efisecs:\r
            index = index + 1\r
            if var[1].strip() == efisec[0].strip():\r
                ret.append((var[0], hex(efisec[2] + var[2])))\r
            elif var[4] == index:\r
                ret.append((var[0], hex(efisec[2] + var[2])))\r
\r
    return ret\r
\r
## Routine to process duplicated INF\r
#\r
#  This function is called by following two cases:\r
#  Case 1 in DSC:\r
#    [components.arch]\r
#    Pkg/module/module.inf\r
#    Pkg/module/module.inf {\r
#      <Defines>\r
#        FILE_GUID = 0D1B936F-68F3-4589-AFCC-FB8B7AEBC836\r
#    }\r
#  Case 2 in FDF:\r
#    INF Pkg/module/module.inf\r
#    INF FILE_GUID = 0D1B936F-68F3-4589-AFCC-FB8B7AEBC836 Pkg/module/module.inf\r
#\r
#  This function copies Pkg/module/module.inf to\r
#  Conf/.cache/0D1B936F-68F3-4589-AFCC-FB8B7AEBC836module.inf\r
#\r
#  @param Path     Original PathClass object\r
#  @param BaseName New file base name\r
#\r
#  @retval         return the new PathClass object\r
#\r
def ProcessDuplicatedInf(Path, BaseName, Workspace):\r
    Filename = os.path.split(Path.File)[1]\r
    if '.' in Filename:\r
        Filename = BaseName + Path.BaseName + Filename[Filename.rfind('.'):]\r
    else:\r
        Filename = BaseName + Path.BaseName\r
\r
    #\r
    # If -N is specified on command line, cache is disabled\r
    # The directory has to be created\r
    #\r
    DbDir = os.path.split(GlobalData.gDatabasePath)[0]\r
    if not os.path.exists(DbDir):\r
        os.makedirs(DbDir)\r
    #\r
    # A temporary INF is copied to database path which must have write permission\r
    # The temporary will be removed at the end of build\r
    # In case of name conflict, the file name is\r
    # FILE_GUIDBaseName (0D1B936F-68F3-4589-AFCC-FB8B7AEBC836module.inf)\r
    #\r
    TempFullPath = os.path.join(DbDir,\r
                                Filename)\r
    RtPath = PathClass(Path.File, Workspace)\r
    #\r
    # Modify the full path to temporary path, keep other unchanged\r
    #\r
    # To build same module more than once, the module path with FILE_GUID overridden has\r
    # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the real path\r
    # in DSC which is used as relative path by C files and other files in INF.\r
    # A trick was used: all module paths are PathClass instances, after the initialization\r
    # of PathClass, the PathClass.Path is overridden by the temporary INF path.\r
    #\r
    # The reason for creating a temporary INF is:\r
    # Platform.Modules which is the base to create ModuleAutoGen objects is a dictionary,\r
    # the key is the full path of INF, the value is an object to save overridden library instances, PCDs.\r
    # A different key for the same module is needed to create different output directory,\r
    # retrieve overridden PCDs, library instances.\r
    #\r
    # The BaseName is the FILE_GUID which is also the output directory name.\r
    #\r
    #\r
    RtPath.Path = TempFullPath\r
    RtPath.BaseName = BaseName\r
    #\r
    # If file exists, compare contents\r
    #\r
    if os.path.exists(TempFullPath):\r
        with open(str(Path), 'rb') as f1, open(TempFullPath, 'rb') as f2:\r
            if f1.read() == f2.read():\r
                return RtPath\r
    _TempInfs.append(TempFullPath)\r
    shutil.copy2(str(Path), TempFullPath)\r
    return RtPath\r
\r
## Remove temporary created INFs whose paths were saved in _TempInfs\r
#\r
def ClearDuplicatedInf():\r
    while _TempInfs:\r
        File = _TempInfs.pop()\r
        if os.path.exists(File):\r
            os.remove(File)\r
\r
## Convert GUID string in xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx style to C structure style\r
#\r
#   @param      Guid    The GUID string\r
#\r
#   @retval     string  The GUID string in C structure style\r
#\r
def GuidStringToGuidStructureString(Guid):\r
    GuidList = Guid.split('-')\r
    Result = '{'\r
    for Index in range(0, 3, 1):\r
        Result = Result + '0x' + GuidList[Index] + ', '\r
    Result = Result + '{0x' + GuidList[3][0:2] + ', 0x' + GuidList[3][2:4]\r
    for Index in range(0, 12, 2):\r
        Result = Result + ', 0x' + GuidList[4][Index:Index + 2]\r
    Result += '}}'\r
    return Result\r
\r
## Convert GUID structure in byte array to xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\r
#\r
#   @param      GuidValue   The GUID value in byte array\r
#\r
#   @retval     string      The GUID value in xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format\r
#\r
def GuidStructureByteArrayToGuidString(GuidValue):\r
    guidValueString = GuidValue.lower().replace("{", "").replace("}", "").replace(" ", "").replace(";", "")\r
    guidValueList = guidValueString.split(",")\r
    if len(guidValueList) != 16:\r
        return ''\r
        #EdkLogger.error(None, None, "Invalid GUID value string %s" % GuidValue)\r
    try:\r
        return "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x" % (\r
                int(guidValueList[3], 16),\r
                int(guidValueList[2], 16),\r
                int(guidValueList[1], 16),\r
                int(guidValueList[0], 16),\r
                int(guidValueList[5], 16),\r
                int(guidValueList[4], 16),\r
                int(guidValueList[7], 16),\r
                int(guidValueList[6], 16),\r
                int(guidValueList[8], 16),\r
                int(guidValueList[9], 16),\r
                int(guidValueList[10], 16),\r
                int(guidValueList[11], 16),\r
                int(guidValueList[12], 16),\r
                int(guidValueList[13], 16),\r
                int(guidValueList[14], 16),\r
                int(guidValueList[15], 16)\r
                )\r
    except:\r
        return ''\r
\r
## Convert GUID string in C structure style to xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\r
#\r
#   @param      GuidValue   The GUID value in C structure format\r
#\r
#   @retval     string      The GUID value in xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format\r
#\r
def GuidStructureStringToGuidString(GuidValue):\r
    if not GlobalData.gGuidCFormatPattern.match(GuidValue):\r
        return ''\r
    guidValueString = GuidValue.lower().replace("{", "").replace("}", "").replace(" ", "").replace(";", "")\r
    guidValueList = guidValueString.split(",")\r
    if len(guidValueList) != 11:\r
        return ''\r
        #EdkLogger.error(None, None, "Invalid GUID value string %s" % GuidValue)\r
    try:\r
        return "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x" % (\r
                int(guidValueList[0], 16),\r
                int(guidValueList[1], 16),\r
                int(guidValueList[2], 16),\r
                int(guidValueList[3], 16),\r
                int(guidValueList[4], 16),\r
                int(guidValueList[5], 16),\r
                int(guidValueList[6], 16),\r
                int(guidValueList[7], 16),\r
                int(guidValueList[8], 16),\r
                int(guidValueList[9], 16),\r
                int(guidValueList[10], 16)\r
                )\r
    except:\r
        return ''\r
\r
## Convert GUID string in C structure style to xxxxxxxx_xxxx_xxxx_xxxx_xxxxxxxxxxxx\r
#\r
#   @param      GuidValue   The GUID value in C structure format\r
#\r
#   @retval     string      The GUID value in xxxxxxxx_xxxx_xxxx_xxxx_xxxxxxxxxxxx format\r
#\r
def GuidStructureStringToGuidValueName(GuidValue):\r
    guidValueString = GuidValue.lower().replace("{", "").replace("}", "").replace(" ", "")\r
    guidValueList = guidValueString.split(",")\r
    if len(guidValueList) != 11:\r
        EdkLogger.error(None, FORMAT_INVALID, "Invalid GUID value string [%s]" % GuidValue)\r
    return "%08x_%04x_%04x_%02x%02x_%02x%02x%02x%02x%02x%02x" % (\r
            int(guidValueList[0], 16),\r
            int(guidValueList[1], 16),\r
            int(guidValueList[2], 16),\r
            int(guidValueList[3], 16),\r
            int(guidValueList[4], 16),\r
            int(guidValueList[5], 16),\r
            int(guidValueList[6], 16),\r
            int(guidValueList[7], 16),\r
            int(guidValueList[8], 16),\r
            int(guidValueList[9], 16),\r
            int(guidValueList[10], 16)\r
            )\r
\r
## Create directories\r
#\r
#   @param      Directory   The directory name\r
#\r
def CreateDirectory(Directory):\r
    if Directory is None or Directory.strip() == "":\r
        return True\r
    try:\r
        if not os.access(Directory, os.F_OK):\r
            os.makedirs(Directory)\r
    except:\r
        return False\r
    return True\r
\r
## Remove directories, including files and sub-directories in it\r
#\r
#   @param      Directory   The directory name\r
#\r
def RemoveDirectory(Directory, Recursively=False):\r
    if Directory is None or Directory.strip() == "" or not os.path.exists(Directory):\r
        return\r
    if Recursively:\r
        CurrentDirectory = os.getcwd()\r
        os.chdir(Directory)\r
        for File in os.listdir("."):\r
            if os.path.isdir(File):\r
                RemoveDirectory(File, Recursively)\r
            else:\r
                os.remove(File)\r
        os.chdir(CurrentDirectory)\r
    os.rmdir(Directory)\r
\r
## Store content in file\r
#\r
#  This method is used to save file only when its content is changed. This is\r
#  quite useful for "make" system to decide what will be re-built and what won't.\r
#\r
#   @param      File            The path of file\r
#   @param      Content         The new content of the file\r
#   @param      IsBinaryFile    The flag indicating if the file is binary file or not\r
#\r
#   @retval     True            If the file content is changed and the file is renewed\r
#   @retval     False           If the file content is the same\r
#\r
def SaveFileOnChange(File, Content, IsBinaryFile=True):\r
    if not IsBinaryFile:\r
        Content = Content.replace("\n", os.linesep)\r
\r
    if os.path.exists(File):\r
        try:\r
            if Content == open(File, "rb").read():\r
                return False\r
        except:\r
            EdkLogger.error(None, FILE_OPEN_FAILURE, ExtraData=File)\r
\r
    DirName = os.path.dirname(File)\r
    if not CreateDirectory(DirName):\r
        EdkLogger.error(None, FILE_CREATE_FAILURE, "Could not create directory %s" % DirName)\r
    else:\r
        if DirName == '':\r
            DirName = os.getcwd()\r
        if not os.access(DirName, os.W_OK):\r
            EdkLogger.error(None, PERMISSION_FAILURE, "Do not have write permission on directory %s" % DirName)\r
\r
    try:\r
        Fd = open(File, "wb")\r
        Fd.write(Content)\r
        Fd.close()\r
    except IOError as X:\r
        EdkLogger.error(None, FILE_CREATE_FAILURE, ExtraData='IOError %s' % X)\r
\r
    return True\r
\r
## Retrieve and cache the real path name in file system\r
#\r
#   @param      Root    The root directory of path relative to\r
#\r
#   @retval     str     The path string if the path exists\r
#   @retval     None    If path doesn't exist\r
#\r
class DirCache:\r
    _CACHE_ = set()\r
    _UPPER_CACHE_ = {}\r
\r
    def __init__(self, Root):\r
        self._Root = Root\r
        for F in os.listdir(Root):\r
            self._CACHE_.add(F)\r
            self._UPPER_CACHE_[F.upper()] = F\r
\r
    # =[] operator\r
    def __getitem__(self, Path):\r
        Path = Path[len(os.path.commonprefix([Path, self._Root])):]\r
        if not Path:\r
            return self._Root\r
        if Path and Path[0] == os.path.sep:\r
            Path = Path[1:]\r
        if Path in self._CACHE_:\r
            return os.path.join(self._Root, Path)\r
        UpperPath = Path.upper()\r
        if UpperPath in self._UPPER_CACHE_:\r
            return os.path.join(self._Root, self._UPPER_CACHE_[UpperPath])\r
\r
        IndexList = []\r
        LastSepIndex = -1\r
        SepIndex = Path.find(os.path.sep)\r
        while SepIndex > -1:\r
            Parent = UpperPath[:SepIndex]\r
            if Parent not in self._UPPER_CACHE_:\r
                break\r
            LastSepIndex = SepIndex\r
            SepIndex = Path.find(os.path.sep, LastSepIndex + 1)\r
\r
        if LastSepIndex == -1:\r
            return None\r
\r
        Cwd = os.getcwd()\r
        os.chdir(self._Root)\r
        SepIndex = LastSepIndex\r
        while SepIndex > -1:\r
            Parent = Path[:SepIndex]\r
            ParentKey = UpperPath[:SepIndex]\r
            if ParentKey not in self._UPPER_CACHE_:\r
                os.chdir(Cwd)\r
                return None\r
\r
            if Parent in self._CACHE_:\r
                ParentDir = Parent\r
            else:\r
                ParentDir = self._UPPER_CACHE_[ParentKey]\r
            for F in os.listdir(ParentDir):\r
                Dir = os.path.join(ParentDir, F)\r
                self._CACHE_.add(Dir)\r
                self._UPPER_CACHE_[Dir.upper()] = Dir\r
\r
            SepIndex = Path.find(os.path.sep, SepIndex + 1)\r
\r
        os.chdir(Cwd)\r
        if Path in self._CACHE_:\r
            return os.path.join(self._Root, Path)\r
        elif UpperPath in self._UPPER_CACHE_:\r
            return os.path.join(self._Root, self._UPPER_CACHE_[UpperPath])\r
        return None\r
\r
def RealPath(File, Dir='', OverrideDir=''):\r
    NewFile = os.path.normpath(os.path.join(Dir, File))\r
    NewFile = GlobalData.gAllFiles[NewFile]\r
    if not NewFile and OverrideDir:\r
        NewFile = os.path.normpath(os.path.join(OverrideDir, File))\r
        NewFile = GlobalData.gAllFiles[NewFile]\r
    return NewFile\r
\r
## Get GUID value from given packages\r
#\r
#   @param      CName           The CName of the GUID\r
#   @param      PackageList     List of packages looking-up in\r
#   @param      Inffile         The driver file\r
#\r
#   @retval     GuidValue   if the CName is found in any given package\r
#   @retval     None        if the CName is not found in all given packages\r
#\r
def GuidValue(CName, PackageList, Inffile = None):\r
    for P in PackageList:\r
        GuidKeys = P.Guids.keys()\r
        if Inffile and P._PrivateGuids:\r
            if not Inffile.startswith(P.MetaFile.Dir):\r
                GuidKeys = [x for x in P.Guids if x not in P._PrivateGuids]\r
        if CName in GuidKeys:\r
            return P.Guids[CName]\r
    return None\r
\r
## A string template class\r
#\r
#  This class implements a template for string replacement. A string template\r
#  looks like following\r
#\r
#       ${BEGIN} other_string ${placeholder_name} other_string ${END}\r
#\r
#  The string between ${BEGIN} and ${END} will be repeated as many times as the\r
#  length of "placeholder_name", which is a list passed through a dict. The\r
#  "placeholder_name" is the key name of the dict. The ${BEGIN} and ${END} can\r
#  be not used and, in this case, the "placeholder_name" must not a list and it\r
#  will just be replaced once.\r
#\r
class TemplateString(object):\r
    _REPEAT_START_FLAG = "BEGIN"\r
    _REPEAT_END_FLAG = "END"\r
\r
    class Section(object):\r
        _LIST_TYPES = [type([]), type(set()), type((0,))]\r
\r
        def __init__(self, TemplateSection, PlaceHolderList):\r
            self._Template = TemplateSection\r
            self._PlaceHolderList = []\r
\r
            # Split the section into sub-sections according to the position of placeholders\r
            if PlaceHolderList:\r
                self._SubSectionList = []\r
                SubSectionStart = 0\r
                #\r
                # The placeholders passed in must be in the format of\r
                #\r
                #   PlaceHolderName, PlaceHolderStartPoint, PlaceHolderEndPoint\r
                #\r
                for PlaceHolder, Start, End in PlaceHolderList:\r
                    self._SubSectionList.append(TemplateSection[SubSectionStart:Start])\r
                    self._SubSectionList.append(TemplateSection[Start:End])\r
                    self._PlaceHolderList.append(PlaceHolder)\r
                    SubSectionStart = End\r
                if SubSectionStart < len(TemplateSection):\r
                    self._SubSectionList.append(TemplateSection[SubSectionStart:])\r
            else:\r
                self._SubSectionList = [TemplateSection]\r
\r
        def __str__(self):\r
            return self._Template + " : " + str(self._PlaceHolderList)\r
\r
        def Instantiate(self, PlaceHolderValues):\r
            RepeatTime = -1\r
            RepeatPlaceHolders = {}\r
            NonRepeatPlaceHolders = {}\r
\r
            for PlaceHolder in self._PlaceHolderList:\r
                if PlaceHolder not in PlaceHolderValues:\r
                    continue\r
                Value = PlaceHolderValues[PlaceHolder]\r
                if type(Value) in self._LIST_TYPES:\r
                    if RepeatTime < 0:\r
                        RepeatTime = len(Value)\r
                    elif RepeatTime != len(Value):\r
                        EdkLogger.error(\r
                                    "TemplateString",\r
                                    PARAMETER_INVALID,\r
                                    "${%s} has different repeat time from others!" % PlaceHolder,\r
                                    ExtraData=str(self._Template)\r
                                    )\r
                    RepeatPlaceHolders["${%s}" % PlaceHolder] = Value\r
                else:\r
                    NonRepeatPlaceHolders["${%s}" % PlaceHolder] = Value\r
\r
            if NonRepeatPlaceHolders:\r
                StringList = []\r
                for S in self._SubSectionList:\r
                    if S not in NonRepeatPlaceHolders:\r
                        StringList.append(S)\r
                    else:\r
                        StringList.append(str(NonRepeatPlaceHolders[S]))\r
            else:\r
                StringList = self._SubSectionList\r
\r
            if RepeatPlaceHolders:\r
                TempStringList = []\r
                for Index in range(RepeatTime):\r
                    for S in StringList:\r
                        if S not in RepeatPlaceHolders:\r
                            TempStringList.append(S)\r
                        else:\r
                            TempStringList.append(str(RepeatPlaceHolders[S][Index]))\r
                StringList = TempStringList\r
\r
            return "".join(StringList)\r
\r
    ## Constructor\r
    def __init__(self, Template=None):\r
        self.String = []\r
        self.IsBinary = False\r
        self._Template = Template\r
        self._TemplateSectionList = self._Parse(Template)\r
\r
    ## str() operator\r
    #\r
    #   @retval     string  The string replaced\r
    #\r
    def __str__(self):\r
        return "".join(self.String)\r
\r
    ## Split the template string into fragments per the ${BEGIN} and ${END} flags\r
    #\r
    #   @retval     list    A list of TemplateString.Section objects\r
    #\r
    def _Parse(self, Template):\r
        SectionStart = 0\r
        SearchFrom = 0\r
        MatchEnd = 0\r
        PlaceHolderList = []\r
        TemplateSectionList = []\r
        while Template:\r
            MatchObj = gPlaceholderPattern.search(Template, SearchFrom)\r
            if not MatchObj:\r
                if MatchEnd <= len(Template):\r
                    TemplateSection = TemplateString.Section(Template[SectionStart:], PlaceHolderList)\r
                    TemplateSectionList.append(TemplateSection)\r
                break\r
\r
            MatchString = MatchObj.group(1)\r
            MatchStart = MatchObj.start()\r
            MatchEnd = MatchObj.end()\r
\r
            if MatchString == self._REPEAT_START_FLAG:\r
                if MatchStart > SectionStart:\r
                    TemplateSection = TemplateString.Section(Template[SectionStart:MatchStart], PlaceHolderList)\r
                    TemplateSectionList.append(TemplateSection)\r
                SectionStart = MatchEnd\r
                PlaceHolderList = []\r
            elif MatchString == self._REPEAT_END_FLAG:\r
                TemplateSection = TemplateString.Section(Template[SectionStart:MatchStart], PlaceHolderList)\r
                TemplateSectionList.append(TemplateSection)\r
                SectionStart = MatchEnd\r
                PlaceHolderList = []\r
            else:\r
                PlaceHolderList.append((MatchString, MatchStart - SectionStart, MatchEnd - SectionStart))\r
            SearchFrom = MatchEnd\r
        return TemplateSectionList\r
\r
    ## Replace the string template with dictionary of placeholders and append it to previous one\r
    #\r
    #   @param      AppendString    The string template to append\r
    #   @param      Dictionary      The placeholder dictionaries\r
    #\r
    def Append(self, AppendString, Dictionary=None):\r
        if Dictionary:\r
            SectionList = self._Parse(AppendString)\r
            self.String.append( "".join(S.Instantiate(Dictionary) for S in SectionList))\r
        else:\r
            if isinstance(AppendString,list):\r
                self.String.extend(AppendString)\r
            else:\r
                self.String.append(AppendString)\r
\r
    ## Replace the string template with dictionary of placeholders\r
    #\r
    #   @param      Dictionary      The placeholder dictionaries\r
    #\r
    #   @retval     str             The string replaced with placeholder values\r
    #\r
    def Replace(self, Dictionary=None):\r
        return "".join(S.Instantiate(Dictionary) for S in self._TemplateSectionList)\r
\r
## Progress indicator class\r
#\r
#  This class makes use of thread to print progress on console.\r
#\r
class Progressor:\r
    # for avoiding deadloop\r
    _StopFlag = None\r
    _ProgressThread = None\r
    _CheckInterval = 0.25\r
\r
    ## Constructor\r
    #\r
    #   @param      OpenMessage     The string printed before progress charaters\r
    #   @param      CloseMessage    The string printed after progress charaters\r
    #   @param      ProgressChar    The charater used to indicate the progress\r
    #   @param      Interval        The interval in seconds between two progress charaters\r
    #\r
    def __init__(self, OpenMessage="", CloseMessage="", ProgressChar='.', Interval=1.0):\r
        self.PromptMessage = OpenMessage\r
        self.CodaMessage = CloseMessage\r
        self.ProgressChar = ProgressChar\r
        self.Interval = Interval\r
        if Progressor._StopFlag is None:\r
            Progressor._StopFlag = threading.Event()\r
\r
    ## Start to print progress charater\r
    #\r
    #   @param      OpenMessage     The string printed before progress charaters\r
    #\r
    def Start(self, OpenMessage=None):\r
        if OpenMessage is not None:\r
            self.PromptMessage = OpenMessage\r
        Progressor._StopFlag.clear()\r
        if Progressor._ProgressThread is None:\r
            Progressor._ProgressThread = threading.Thread(target=self._ProgressThreadEntry)\r
            Progressor._ProgressThread.setDaemon(False)\r
            Progressor._ProgressThread.start()\r
\r
    ## Stop printing progress charater\r
    #\r
    #   @param      CloseMessage    The string printed after progress charaters\r
    #\r
    def Stop(self, CloseMessage=None):\r
        OriginalCodaMessage = self.CodaMessage\r
        if CloseMessage is not None:\r
            self.CodaMessage = CloseMessage\r
        self.Abort()\r
        self.CodaMessage = OriginalCodaMessage\r
\r
    ## Thread entry method\r
    def _ProgressThreadEntry(self):\r
        sys.stdout.write(self.PromptMessage + " ")\r
        sys.stdout.flush()\r
        TimeUp = 0.0\r
        while not Progressor._StopFlag.isSet():\r
            if TimeUp <= 0.0:\r
                sys.stdout.write(self.ProgressChar)\r
                sys.stdout.flush()\r
                TimeUp = self.Interval\r
            time.sleep(self._CheckInterval)\r
            TimeUp -= self._CheckInterval\r
        sys.stdout.write(" " + self.CodaMessage + "\n")\r
        sys.stdout.flush()\r
\r
    ## Abort the progress display\r
    @staticmethod\r
    def Abort():\r
        if Progressor._StopFlag is not None:\r
            Progressor._StopFlag.set()\r
        if Progressor._ProgressThread is not None:\r
            Progressor._ProgressThread.join()\r
            Progressor._ProgressThread = None\r
\r
\r
## Dictionary using prioritized list as key\r
#\r
class tdict:\r
    _ListType = type([])\r
    _TupleType = type(())\r
    _Wildcard = 'COMMON'\r
    _ValidWildcardList = ['COMMON', 'DEFAULT', 'ALL', TAB_STAR, 'PLATFORM']\r
\r
    def __init__(self, _Single_=False, _Level_=2):\r
        self._Level_ = _Level_\r
        self.data = {}\r
        self._Single_ = _Single_\r
\r
    # =[] operator\r
    def __getitem__(self, key):\r
        KeyType = type(key)\r
        RestKeys = None\r
        if KeyType == self._ListType or KeyType == self._TupleType:\r
            FirstKey = key[0]\r
            if len(key) > 1:\r
                RestKeys = key[1:]\r
            elif self._Level_ > 1:\r
                RestKeys = [self._Wildcard for i in range(0, self._Level_ - 1)]\r
        else:\r
            FirstKey = key\r
            if self._Level_ > 1:\r
                RestKeys = [self._Wildcard for i in range(0, self._Level_ - 1)]\r
\r
        if FirstKey is None or str(FirstKey).upper() in self._ValidWildcardList:\r
            FirstKey = self._Wildcard\r
\r
        if self._Single_:\r
            return self._GetSingleValue(FirstKey, RestKeys)\r
        else:\r
            return self._GetAllValues(FirstKey, RestKeys)\r
\r
    def _GetSingleValue(self, FirstKey, RestKeys):\r
        Value = None\r
        #print "%s-%s" % (FirstKey, self._Level_) ,\r
        if self._Level_ > 1:\r
            if FirstKey == self._Wildcard:\r
                if FirstKey in self.data:\r
                    Value = self.data[FirstKey][RestKeys]\r
                if Value is None:\r
                    for Key in self.data:\r
                        Value = self.data[Key][RestKeys]\r
                        if Value is not None: break\r
            else:\r
                if FirstKey in self.data:\r
                    Value = self.data[FirstKey][RestKeys]\r
                if Value is None and self._Wildcard in self.data:\r
                    #print "Value=None"\r
                    Value = self.data[self._Wildcard][RestKeys]\r
        else:\r
            if FirstKey == self._Wildcard:\r
                if FirstKey in self.data:\r
                    Value = self.data[FirstKey]\r
                if Value is None:\r
                    for Key in self.data:\r
                        Value = self.data[Key]\r
                        if Value is not None: break\r
            else:\r
                if FirstKey in self.data:\r
                    Value = self.data[FirstKey]\r
                elif self._Wildcard in self.data:\r
                    Value = self.data[self._Wildcard]\r
        return Value\r
\r
    def _GetAllValues(self, FirstKey, RestKeys):\r
        Value = []\r
        if self._Level_ > 1:\r
            if FirstKey == self._Wildcard:\r
                for Key in self.data:\r
                    Value += self.data[Key][RestKeys]\r
            else:\r
                if FirstKey in self.data:\r
                    Value += self.data[FirstKey][RestKeys]\r
                if self._Wildcard in self.data:\r
                    Value += self.data[self._Wildcard][RestKeys]\r
        else:\r
            if FirstKey == self._Wildcard:\r
                for Key in self.data:\r
                    Value.append(self.data[Key])\r
            else:\r
                if FirstKey in self.data:\r
                    Value.append(self.data[FirstKey])\r
                if self._Wildcard in self.data:\r
                    Value.append(self.data[self._Wildcard])\r
        return Value\r
\r
    ## []= operator\r
    def __setitem__(self, key, value):\r
        KeyType = type(key)\r
        RestKeys = None\r
        if KeyType == self._ListType or KeyType == self._TupleType:\r
            FirstKey = key[0]\r
            if len(key) > 1:\r
                RestKeys = key[1:]\r
            else:\r
                RestKeys = [self._Wildcard for i in range(0, self._Level_ - 1)]\r
        else:\r
            FirstKey = key\r
            if self._Level_ > 1:\r
                RestKeys = [self._Wildcard for i in range(0, self._Level_ - 1)]\r
\r
        if FirstKey in self._ValidWildcardList:\r
            FirstKey = self._Wildcard\r
\r
        if FirstKey not in self.data and self._Level_ > 0:\r
            self.data[FirstKey] = tdict(self._Single_, self._Level_ - 1)\r
\r
        if self._Level_ > 1:\r
            self.data[FirstKey][RestKeys] = value\r
        else:\r
            self.data[FirstKey] = value\r
\r
    def SetGreedyMode(self):\r
        self._Single_ = False\r
        if self._Level_ > 1:\r
            for Key in self.data:\r
                self.data[Key].SetGreedyMode()\r
\r
    def SetSingleMode(self):\r
        self._Single_ = True\r
        if self._Level_ > 1:\r
            for Key in self.data:\r
                self.data[Key].SetSingleMode()\r
\r
    def GetKeys(self, KeyIndex=0):\r
        assert KeyIndex >= 0\r
        if KeyIndex == 0:\r
            return set(self.data.keys())\r
        else:\r
            keys = set()\r
            for Key in self.data:\r
                keys |= self.data[Key].GetKeys(KeyIndex - 1)\r
            return keys\r
\r
def AnalyzePcdExpression(Setting):\r
    RanStr = ''.join(sample(string.ascii_letters + string.digits, 8))\r
    Setting = Setting.replace('\\\\', RanStr).strip()\r
    # There might be escaped quote in a string: \", \\\" , \', \\\'\r
    Data = Setting\r
    # There might be '|' in string and in ( ... | ... ), replace it with '-'\r
    NewStr = ''\r
    InSingleQuoteStr = False\r
    InDoubleQuoteStr = False\r
    Pair = 0\r
    for Index, ch in enumerate(Data):\r
        if ch == '"' and not InSingleQuoteStr:\r
            if Data[Index - 1] != '\\':\r
                InDoubleQuoteStr = not InDoubleQuoteStr\r
        elif ch == "'" and not InDoubleQuoteStr:\r
            if Data[Index - 1] != '\\':\r
                InSingleQuoteStr = not InSingleQuoteStr\r
        elif ch == '(' and not (InSingleQuoteStr or InDoubleQuoteStr):\r
            Pair += 1\r
        elif ch == ')' and not (InSingleQuoteStr or InDoubleQuoteStr):\r
            Pair -= 1\r
\r
        if (Pair > 0 or InSingleQuoteStr or InDoubleQuoteStr) and ch == TAB_VALUE_SPLIT:\r
            NewStr += '-'\r
        else:\r
            NewStr += ch\r
    FieldList = []\r
    StartPos = 0\r
    while True:\r
        Pos = NewStr.find(TAB_VALUE_SPLIT, StartPos)\r
        if Pos < 0:\r
            FieldList.append(Setting[StartPos:].strip())\r
            break\r
        FieldList.append(Setting[StartPos:Pos].strip())\r
        StartPos = Pos + 1\r
    for i, ch in enumerate(FieldList):\r
        if RanStr in ch:\r
            FieldList[i] = ch.replace(RanStr,'\\\\')\r
    return FieldList\r
\r
def ParseFieldValue (Value):\r
    def ParseDevPathValue (Value):\r
        if '\\' in Value:\r
            Value.replace('\\', '/').replace(' ', '')\r
\r
        Cmd = 'DevicePath ' + '"' + Value + '"'\r
        try:\r
            p = subprocess.Popen(Cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\r
            out, err = p.communicate()\r
        except Exception as X:\r
            raise BadExpression("DevicePath: %s" % (str(X)) )\r
        finally:\r
            subprocess._cleanup()\r
            p.stdout.close()\r
            p.stderr.close()\r
        if err:\r
            raise BadExpression("DevicePath: %s" % str(err))\r
        Size = len(out.split())\r
        out = ','.join(out.split())\r
        return '{' + out + '}', Size\r
\r
    if "{CODE(" in Value:\r
        return Value, len(Value.split(","))\r
    if isinstance(Value, type(0)):\r
        return Value, (Value.bit_length() + 7) / 8\r
    if not isinstance(Value, type('')):\r
        raise BadExpression('Type %s is %s' %(Value, type(Value)))\r
    Value = Value.strip()\r
    if Value.startswith(TAB_UINT8) and Value.endswith(')'):\r
        Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
        if Size > 1:\r
            raise BadExpression('Value (%s) Size larger than %d' %(Value, Size))\r
        return Value, 1\r
    if Value.startswith(TAB_UINT16) and Value.endswith(')'):\r
        Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
        if Size > 2:\r
            raise BadExpression('Value (%s) Size larger than %d' %(Value, Size))\r
        return Value, 2\r
    if Value.startswith(TAB_UINT32) and Value.endswith(')'):\r
        Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
        if Size > 4:\r
            raise BadExpression('Value (%s) Size larger than %d' %(Value, Size))\r
        return Value, 4\r
    if Value.startswith(TAB_UINT64) and Value.endswith(')'):\r
        Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])\r
        if Size > 8:\r
            raise BadExpression('Value (%s) Size larger than %d' % (Value, Size))\r
        return Value, 8\r
    if Value.startswith(TAB_GUID) and Value.endswith(')'):\r
        Value = Value.split('(', 1)[1][:-1].strip()\r
        if Value[0] == '{' and Value[-1] == '}':\r
            TmpValue = GuidStructureStringToGuidString(Value)\r
            if not TmpValue:\r
                raise BadExpression("Invalid GUID value string %s" % Value)\r
            Value = TmpValue\r
        if Value[0] == '"' and Value[-1] == '"':\r
            Value = Value[1:-1]\r
        try:\r
            Value = "'" + uuid.UUID(Value).bytes_le + "'"\r
        except ValueError as Message:\r
            raise BadExpression(Message)\r
        Value, Size = ParseFieldValue(Value)\r
        return Value, 16\r
    if Value.startswith('L"') and Value.endswith('"'):\r
        # Unicode String\r
        # translate escape character\r
        Value = Value[1:]\r
        try:\r
            Value = eval(Value)\r
        except:\r
            Value = Value[1:-1]\r
        List = list(Value)\r
        List.reverse()\r
        Value = 0\r
        for Char in List:\r
            Value = (Value << 16) | ord(Char)\r
        return Value, (len(List) + 1) * 2\r
    if Value.startswith('"') and Value.endswith('"'):\r
        # ASCII String\r
        # translate escape character\r
        try:\r
            Value = eval(Value)\r
        except:\r
            Value = Value[1:-1]\r
        List = list(Value)\r
        List.reverse()\r
        Value = 0\r
        for Char in List:\r
            Value = (Value << 8) | ord(Char)\r
        return Value, len(List) + 1\r
    if Value.startswith("L'") and Value.endswith("'"):\r
        # Unicode Character Constant\r
        # translate escape character\r
        Value = Value[1:]\r
        try:\r
            Value = eval(Value)\r
        except:\r
            Value = Value[1:-1]\r
        List = list(Value)\r
        if len(List) == 0:\r
            raise BadExpression('Length %s is %s' % (Value, len(List)))\r
        List.reverse()\r
        Value = 0\r
        for Char in List:\r
            Value = (Value << 16) | ord(Char)\r
        return Value, len(List) * 2\r
    if Value.startswith("'") and Value.endswith("'"):\r
        # Character constant\r
        # translate escape character\r
        try:\r
            Value = eval(Value)\r
        except:\r
            Value = Value[1:-1]\r
        List = list(Value)\r
        if len(List) == 0:\r
            raise BadExpression('Length %s is %s' % (Value, len(List)))\r
        List.reverse()\r
        Value = 0\r
        for Char in List:\r
            Value = (Value << 8) | ord(Char)\r
        return Value, len(List)\r
    if Value.startswith('{') and Value.endswith('}'):\r
        # Byte array\r
        Value = Value[1:-1]\r
        List = [Item.strip() for Item in Value.split(',')]\r
        List.reverse()\r
        Value = 0\r
        RetSize = 0\r
        for Item in List:\r
            ItemValue, Size = ParseFieldValue(Item)\r
            RetSize += Size\r
            for I in range(Size):\r
                Value = (Value << 8) | ((ItemValue >> 8 * I) & 0xff)\r
        return Value, RetSize\r
    if Value.startswith('DEVICE_PATH(') and Value.endswith(')'):\r
        Value = Value.replace("DEVICE_PATH(", '').rstrip(')')\r
        Value = Value.strip().strip('"')\r
        return ParseDevPathValue(Value)\r
    if Value.lower().startswith('0x'):\r
        try:\r
            Value = int(Value, 16)\r
        except:\r
            raise BadExpression("invalid hex value: %s" % Value)\r
        if Value == 0:\r
            return 0, 1\r
        return Value, (Value.bit_length() + 7) / 8\r
    if Value[0].isdigit():\r
        Value = int(Value, 10)\r
        if Value == 0:\r
            return 0, 1\r
        return Value, (Value.bit_length() + 7) / 8\r
    if Value.lower() == 'true':\r
        return 1, 1\r
    if Value.lower() == 'false':\r
        return 0, 1\r
    return Value, 1\r
\r
## AnalyzeDscPcd\r
#\r
#  Analyze DSC PCD value, since there is no data type info in DSC\r
#  This function is used to match functions (AnalyzePcdData) used for retrieving PCD value from database\r
#  1. Feature flag: TokenSpace.PcdCName|PcdValue\r
#  2. Fix and Patch:TokenSpace.PcdCName|PcdValue[|VOID*[|MaxSize]]\r
#  3. Dynamic default:\r
#     TokenSpace.PcdCName|PcdValue[|VOID*[|MaxSize]]\r
#     TokenSpace.PcdCName|PcdValue\r
#  4. Dynamic VPD:\r
#     TokenSpace.PcdCName|VpdOffset[|VpdValue]\r
#     TokenSpace.PcdCName|VpdOffset[|MaxSize[|VpdValue]]\r
#  5. Dynamic HII:\r
#     TokenSpace.PcdCName|HiiString|VariableGuid|VariableOffset[|HiiValue]\r
#  PCD value needs to be located in such kind of string, and the PCD value might be an expression in which\r
#    there might have "|" operator, also in string value.\r
#\r
#  @param Setting: String contain information described above with "TokenSpace.PcdCName|" stripped\r
#  @param PcdType: PCD type: feature, fixed, dynamic default VPD HII\r
#  @param DataType: The datum type of PCD: VOID*, UNIT, BOOL\r
#  @retval:\r
#    ValueList: A List contain fields described above\r
#    IsValid:   True if conforming EBNF, otherwise False\r
#    Index:     The index where PcdValue is in ValueList\r
#\r
def AnalyzeDscPcd(Setting, PcdType, DataType=''):\r
    FieldList = AnalyzePcdExpression(Setting)\r
\r
    IsValid = True\r
    if PcdType in (MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_PATCHABLE_IN_MODULE, MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_EX_DEFAULT):\r
        Value = FieldList[0]\r
        Size = ''\r
        if len(FieldList) > 1 and FieldList[1]:\r
            DataType = FieldList[1]\r
            if FieldList[1] != TAB_VOID and StructPattern.match(FieldList[1]) is None:\r
                IsValid = False\r
        if len(FieldList) > 2:\r
            Size = FieldList[2]\r
        if IsValid:\r
            if DataType == "":\r
                IsValid = (len(FieldList) <= 1)\r
            else:\r
                IsValid = (len(FieldList) <= 3)\r
\r
        if Size:\r
            try:\r
                int(Size, 16) if Size.upper().startswith("0X") else int(Size)\r
            except:\r
                IsValid = False\r
                Size = -1\r
        return [str(Value), DataType, str(Size)], IsValid, 0\r
    elif PcdType == MODEL_PCD_FEATURE_FLAG:\r
        Value = FieldList[0]\r
        Size = ''\r
        IsValid = (len(FieldList) <= 1)\r
        return [Value, DataType, str(Size)], IsValid, 0\r
    elif PcdType in (MODEL_PCD_DYNAMIC_VPD, MODEL_PCD_DYNAMIC_EX_VPD):\r
        VpdOffset = FieldList[0]\r
        Value = Size = ''\r
        if not DataType == TAB_VOID:\r
            if len(FieldList) > 1:\r
                Value = FieldList[1]\r
        else:\r
            if len(FieldList) > 1:\r
                Size = FieldList[1]\r
            if len(FieldList) > 2:\r
                Value = FieldList[2]\r
        if DataType == "":\r
            IsValid = (len(FieldList) <= 1)\r
        else:\r
            IsValid = (len(FieldList) <= 3)\r
        if Size:\r
            try:\r
                int(Size, 16) if Size.upper().startswith("0X") else int(Size)\r
            except:\r
                IsValid = False\r
                Size = -1\r
        return [VpdOffset, str(Size), Value], IsValid, 2\r
    elif PcdType in (MODEL_PCD_DYNAMIC_HII, MODEL_PCD_DYNAMIC_EX_HII):\r
        IsValid = (3 <= len(FieldList) <= 5)\r
        HiiString = FieldList[0]\r
        Guid = Offset = Value = Attribute = ''\r
        if len(FieldList) > 1:\r
            Guid = FieldList[1]\r
        if len(FieldList) > 2:\r
            Offset = FieldList[2]\r
        if len(FieldList) > 3:\r
            Value = FieldList[3]\r
        if len(FieldList) > 4:\r
            Attribute = FieldList[4]\r
        return [HiiString, Guid, Offset, Value, Attribute], IsValid, 3\r
    return [], False, 0\r
\r
## AnalyzePcdData\r
#\r
#  Analyze the pcd Value, Datum type and TokenNumber.\r
#  Used to avoid split issue while the value string contain "|" character\r
#\r
#  @param[in] Setting:  A String contain value/datum type/token number information;\r
#\r
#  @retval   ValueList: A List contain value, datum type and toke number.\r
#\r
def AnalyzePcdData(Setting):\r
    ValueList = ['', '', '']\r
\r
    ValueRe = re.compile(r'^\s*L?\".*\|.*\"')\r
    PtrValue = ValueRe.findall(Setting)\r
\r
    ValueUpdateFlag = False\r
\r
    if len(PtrValue) >= 1:\r
        Setting = re.sub(ValueRe, '', Setting)\r
        ValueUpdateFlag = True\r
\r
    TokenList = Setting.split(TAB_VALUE_SPLIT)\r
    ValueList[0:len(TokenList)] = TokenList\r
\r
    if ValueUpdateFlag:\r
        ValueList[0] = PtrValue[0]\r
\r
    return ValueList\r
\r
## check format of PCD value against its the datum type\r
#\r
# For PCD value setting\r
#\r
def CheckPcdDatum(Type, Value):\r
    if Type == TAB_VOID:\r
        ValueRe = re.compile(r'\s*L?\".*\"\s*$')\r
        if not (((Value.startswith('L"') or Value.startswith('"')) and Value.endswith('"'))\r
                or (Value.startswith('{') and Value.endswith('}')) or (Value.startswith("L'") or Value.startswith("'") and Value.endswith("'"))\r
               ):\r
            return False, "Invalid value [%s] of type [%s]; must be in the form of {...} for array"\\r
                          ", \"...\" or \'...\' for string, L\"...\" or L\'...\' for unicode string" % (Value, Type)\r
        elif ValueRe.match(Value):\r
            # Check the chars in UnicodeString or CString is printable\r
            if Value.startswith("L"):\r
                Value = Value[2:-1]\r
            else:\r
                Value = Value[1:-1]\r
            Printset = set(string.printable)\r
            Printset.remove(TAB_PRINTCHAR_VT)\r
            Printset.add(TAB_PRINTCHAR_BS)\r
            Printset.add(TAB_PRINTCHAR_NUL)\r
            if not set(Value).issubset(Printset):\r
                PrintList = sorted(Printset)\r
                return False, "Invalid PCD string value of type [%s]; must be printable chars %s." % (Type, PrintList)\r
    elif Type == 'BOOLEAN':\r
        if Value not in ['TRUE', 'True', 'true', '0x1', '0x01', '1', 'FALSE', 'False', 'false', '0x0', '0x00', '0']:\r
            return False, "Invalid value [%s] of type [%s]; must be one of TRUE, True, true, 0x1, 0x01, 1"\\r
                          ", FALSE, False, false, 0x0, 0x00, 0" % (Value, Type)\r
    elif Type in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64]:\r
        if Value and int(Value, 0) < 0:\r
            return False, "PCD can't be set to negative value[%s] for datum type [%s]" % (Value, Type)\r
        try:\r
            Value = int(Value, 0)\r
            if Value > MAX_VAL_TYPE[Type]:\r
                return False, "Too large PCD value[%s] for datum type [%s]" % (Value, Type)\r
        except:\r
            return False, "Invalid value [%s] of type [%s];"\\r
                          " must be a hexadecimal, decimal or octal in C language format." % (Value, Type)\r
    else:\r
        return True, "StructurePcd"\r
\r
    return True, ""\r
\r
def CommonPath(PathList):\r
    P1 = min(PathList).split(os.path.sep)\r
    P2 = max(PathList).split(os.path.sep)\r
    for Index in range(min(len(P1), len(P2))):\r
        if P1[Index] != P2[Index]:\r
            return os.path.sep.join(P1[:Index])\r
    return os.path.sep.join(P1)\r
\r
class PathClass(object):\r
    def __init__(self, File='', Root='', AlterRoot='', Type='', IsBinary=False,\r
                 Arch='COMMON', ToolChainFamily='', Target='', TagName='', ToolCode=''):\r
        self.Arch = Arch\r
        self.File = str(File)\r
        if os.path.isabs(self.File):\r
            self.Root = ''\r
            self.AlterRoot = ''\r
        else:\r
            self.Root = str(Root)\r
            self.AlterRoot = str(AlterRoot)\r
\r
        # Remove any '.' and '..' in path\r
        if self.Root:\r
            self.Root = mws.getWs(self.Root, self.File)\r
            self.Path = os.path.normpath(os.path.join(self.Root, self.File))\r
            self.Root = os.path.normpath(CommonPath([self.Root, self.Path]))\r
            # eliminate the side-effect of 'C:'\r
            if self.Root[-1] == ':':\r
                self.Root += os.path.sep\r
            # file path should not start with path separator\r
            if self.Root[-1] == os.path.sep:\r
                self.File = self.Path[len(self.Root):]\r
            else:\r
                self.File = self.Path[len(self.Root) + 1:]\r
        else:\r
            self.Path = os.path.normpath(self.File)\r
\r
        self.SubDir, self.Name = os.path.split(self.File)\r
        self.BaseName, self.Ext = os.path.splitext(self.Name)\r
\r
        if self.Root:\r
            if self.SubDir:\r
                self.Dir = os.path.join(self.Root, self.SubDir)\r
            else:\r
                self.Dir = self.Root\r
        else:\r
            self.Dir = self.SubDir\r
\r
        if IsBinary:\r
            self.Type = Type\r
        else:\r
            self.Type = self.Ext.lower()\r
\r
        self.IsBinary = IsBinary\r
        self.Target = Target\r
        self.TagName = TagName\r
        self.ToolCode = ToolCode\r
        self.ToolChainFamily = ToolChainFamily\r
\r
    ## Convert the object of this class to a string\r
    #\r
    #  Convert member Path of the class to a string\r
    #\r
    #  @retval string Formatted String\r
    #\r
    def __str__(self):\r
        return self.Path\r
\r
    ## Override __eq__ function\r
    #\r
    # Check whether PathClass are the same\r
    #\r
    # @retval False The two PathClass are different\r
    # @retval True  The two PathClass are the same\r
    #\r
    def __eq__(self, Other):\r
        return self.Path == str(Other)\r
\r
    ## Override __cmp__ function\r
    #\r
    # Customize the comparsion operation of two PathClass\r
    #\r
    # @retval 0     The two PathClass are different\r
    # @retval -1    The first PathClass is less than the second PathClass\r
    # @retval 1     The first PathClass is Bigger than the second PathClass\r
    def __cmp__(self, Other):\r
        OtherKey = str(Other)\r
\r
        SelfKey = self.Path\r
        if SelfKey == OtherKey:\r
            return 0\r
        elif SelfKey > OtherKey:\r
            return 1\r
        else:\r
            return -1\r
\r
    ## Override __hash__ function\r
    #\r
    # Use Path as key in hash table\r
    #\r
    # @retval string Key for hash table\r
    #\r
    def __hash__(self):\r
        return hash(self.Path)\r
\r
    @cached_property\r
    def Key(self):\r
        return self.Path.upper()\r
\r
    @property\r
    def TimeStamp(self):\r
        return os.stat(self.Path)[8]\r
\r
    def Validate(self, Type='', CaseSensitive=True):\r
        def RealPath2(File, Dir='', OverrideDir=''):\r
            NewFile = None\r
            if OverrideDir:\r
                NewFile = GlobalData.gAllFiles[os.path.normpath(os.path.join(OverrideDir, File))]\r
                if NewFile:\r
                    if OverrideDir[-1] == os.path.sep:\r
                        return NewFile[len(OverrideDir):], NewFile[0:len(OverrideDir)]\r
                    else:\r
                        return NewFile[len(OverrideDir) + 1:], NewFile[0:len(OverrideDir)]\r
            if GlobalData.gAllFiles:\r
                NewFile = GlobalData.gAllFiles[os.path.normpath(os.path.join(Dir, File))]\r
            if not NewFile:\r
                NewFile = os.path.normpath(os.path.join(Dir, File))\r
                if not os.path.exists(NewFile):\r
                    return None, None\r
            if NewFile:\r
                if Dir:\r
                    if Dir[-1] == os.path.sep:\r
                        return NewFile[len(Dir):], NewFile[0:len(Dir)]\r
                    else:\r
                        return NewFile[len(Dir) + 1:], NewFile[0:len(Dir)]\r
                else:\r
                    return NewFile, ''\r
\r
            return None, None\r
\r
        if GlobalData.gCaseInsensitive:\r
            CaseSensitive = False\r
        if Type and Type.lower() != self.Type:\r
            return FILE_TYPE_MISMATCH, '%s (expect %s but got %s)' % (self.File, Type, self.Type)\r
\r
        RealFile, RealRoot = RealPath2(self.File, self.Root, self.AlterRoot)\r
        if not RealRoot and not RealFile:\r
            RealFile = self.File\r
            if self.AlterRoot:\r
                RealFile = os.path.join(self.AlterRoot, self.File)\r
            elif self.Root:\r
                RealFile = os.path.join(self.Root, self.File)\r
            if len (mws.getPkgPath()) == 0:\r
                return FILE_NOT_FOUND, os.path.join(self.AlterRoot, RealFile)\r
            else:\r
                return FILE_NOT_FOUND, "%s is not found in packages path:\n\t%s" % (self.File, '\n\t'.join(mws.getPkgPath()))\r
\r
        ErrorCode = 0\r
        ErrorInfo = ''\r
        if RealRoot != self.Root or RealFile != self.File:\r
            if CaseSensitive and (RealFile != self.File or (RealRoot != self.Root and RealRoot != self.AlterRoot)):\r
                ErrorCode = FILE_CASE_MISMATCH\r
                ErrorInfo = self.File + '\n\t' + RealFile + " [in file system]"\r
\r
            self.SubDir, self.Name = os.path.split(RealFile)\r
            self.BaseName, self.Ext = os.path.splitext(self.Name)\r
            if self.SubDir:\r
                self.Dir = os.path.join(RealRoot, self.SubDir)\r
            else:\r
                self.Dir = RealRoot\r
            self.File = RealFile\r
            self.Root = RealRoot\r
            self.Path = os.path.join(RealRoot, RealFile)\r
        return ErrorCode, ErrorInfo\r
\r
## Parse PE image to get the required PE informaion.\r
#\r
class PeImageClass():\r
    ## Constructor\r
    #\r
    #   @param  File FilePath of PeImage\r
    #\r
    def __init__(self, PeFile):\r
        self.FileName   = PeFile\r
        self.IsValid    = False\r
        self.Size       = 0\r
        self.EntryPoint = 0\r
        self.SectionAlignment  = 0\r
        self.SectionHeaderList = []\r
        self.ErrorInfo = ''\r
        try:\r
            PeObject = open(PeFile, 'rb')\r
        except:\r
            self.ErrorInfo = self.FileName + ' can not be found\n'\r
            return\r
        # Read DOS header\r
        ByteArray = array.array('B')\r
        ByteArray.fromfile(PeObject, 0x3E)\r
        ByteList = ByteArray.tolist()\r
        # DOS signature should be 'MZ'\r
        if self._ByteListToStr (ByteList[0x0:0x2]) != 'MZ':\r
            self.ErrorInfo = self.FileName + ' has no valid DOS signature MZ'\r
            return\r
\r
        # Read 4 byte PE Signature\r
        PeOffset = self._ByteListToInt(ByteList[0x3C:0x3E])\r
        PeObject.seek(PeOffset)\r
        ByteArray = array.array('B')\r
        ByteArray.fromfile(PeObject, 4)\r
        # PE signature should be 'PE\0\0'\r
        if ByteArray.tostring() != 'PE\0\0':\r
            self.ErrorInfo = self.FileName + ' has no valid PE signature PE00'\r
            return\r
\r
        # Read PE file header\r
        ByteArray = array.array('B')\r
        ByteArray.fromfile(PeObject, 0x14)\r
        ByteList = ByteArray.tolist()\r
        SecNumber = self._ByteListToInt(ByteList[0x2:0x4])\r
        if SecNumber == 0:\r
            self.ErrorInfo = self.FileName + ' has no section header'\r
            return\r
\r
        # Read PE optional header\r
        OptionalHeaderSize = self._ByteListToInt(ByteArray[0x10:0x12])\r
        ByteArray = array.array('B')\r
        ByteArray.fromfile(PeObject, OptionalHeaderSize)\r
        ByteList = ByteArray.tolist()\r
        self.EntryPoint       = self._ByteListToInt(ByteList[0x10:0x14])\r
        self.SectionAlignment = self._ByteListToInt(ByteList[0x20:0x24])\r
        self.Size             = self._ByteListToInt(ByteList[0x38:0x3C])\r
\r
        # Read each Section Header\r
        for Index in range(SecNumber):\r
            ByteArray = array.array('B')\r
            ByteArray.fromfile(PeObject, 0x28)\r
            ByteList = ByteArray.tolist()\r
            SecName  = self._ByteListToStr(ByteList[0:8])\r
            SecVirtualSize = self._ByteListToInt(ByteList[8:12])\r
            SecRawAddress  = self._ByteListToInt(ByteList[20:24])\r
            SecVirtualAddress = self._ByteListToInt(ByteList[12:16])\r
            self.SectionHeaderList.append((SecName, SecVirtualAddress, SecRawAddress, SecVirtualSize))\r
        self.IsValid = True\r
        PeObject.close()\r
\r
    def _ByteListToStr(self, ByteList):\r
        String = ''\r
        for index in range(len(ByteList)):\r
            if ByteList[index] == 0:\r
                break\r
            String += chr(ByteList[index])\r
        return String\r
\r
    def _ByteListToInt(self, ByteList):\r
        Value = 0\r
        for index in range(len(ByteList) - 1, -1, -1):\r
            Value = (Value << 8) | int(ByteList[index])\r
        return Value\r
\r
class DefaultStore():\r
    def __init__(self, DefaultStores ):\r
\r
        self.DefaultStores = DefaultStores\r
    def DefaultStoreID(self, DefaultStoreName):\r
        for key, value in self.DefaultStores.items():\r
            if value == DefaultStoreName:\r
                return key\r
        return None\r
    def GetDefaultDefault(self):\r
        if not self.DefaultStores or "0" in self.DefaultStores:\r
            return "0", TAB_DEFAULT_STORES_DEFAULT\r
        else:\r
            minvalue = min(int(value_str) for value_str in self.DefaultStores)\r
            return (str(minvalue), self.DefaultStores[str(minvalue)])\r
    def GetMin(self, DefaultSIdList):\r
        if not DefaultSIdList:\r
            return TAB_DEFAULT_STORES_DEFAULT\r
        storeidset = {storeid for storeid, storename in self.DefaultStores.values() if storename in DefaultSIdList}\r
        if not storeidset:\r
            return ""\r
        minid = min(storeidset )\r
        for sid, name in self.DefaultStores.values():\r
            if sid == minid:\r
                return name\r
\r
class SkuClass():\r
    DEFAULT = 0\r
    SINGLE = 1\r
    MULTIPLE =2\r
\r
    def __init__(self,SkuIdentifier='', SkuIds=None):\r
        if SkuIds is None:\r
            SkuIds = {}\r
\r
        for SkuName in SkuIds:\r
            SkuId = SkuIds[SkuName][0]\r
            skuid_num = int(SkuId, 16) if SkuId.upper().startswith("0X") else int(SkuId)\r
            if skuid_num > 0xFFFFFFFFFFFFFFFF:\r
                EdkLogger.error("build", PARAMETER_INVALID,\r
                            ExtraData = "SKU-ID [%s] value %s exceeds the max value of UINT64"\r
                                      % (SkuName, SkuId))\r
\r
        self.AvailableSkuIds = OrderedDict()\r
        self.SkuIdSet = []\r
        self.SkuIdNumberSet = []\r
        self.SkuData = SkuIds\r
        self._SkuInherit = {}\r
        self._SkuIdentifier = SkuIdentifier\r
        if SkuIdentifier == '' or SkuIdentifier is None:\r
            self.SkuIdSet = ['DEFAULT']\r
            self.SkuIdNumberSet = ['0U']\r
        elif SkuIdentifier == 'ALL':\r
            self.SkuIdSet = SkuIds.keys()\r
            self.SkuIdNumberSet = [num[0].strip() + 'U' for num in SkuIds.values()]\r
        else:\r
            r = SkuIdentifier.split('|')\r
            self.SkuIdSet=[(r[k].strip()).upper() for k in range(len(r))]\r
            k = None\r
            try:\r
                self.SkuIdNumberSet = [SkuIds[k][0].strip() + 'U' for k in self.SkuIdSet]\r
            except Exception:\r
                EdkLogger.error("build", PARAMETER_INVALID,\r
                            ExtraData = "SKU-ID [%s] is not supported by the platform. [Valid SKU-ID: %s]"\r
                                      % (k, " | ".join(SkuIds.keys())))\r
        for each in self.SkuIdSet:\r
            if each in SkuIds:\r
                self.AvailableSkuIds[each] = SkuIds[each][0]\r
            else:\r
                EdkLogger.error("build", PARAMETER_INVALID,\r
                            ExtraData="SKU-ID [%s] is not supported by the platform. [Valid SKU-ID: %s]"\r
                                      % (each, " | ".join(SkuIds.keys())))\r
        if self.SkuUsageType != SkuClass.SINGLE:\r
            self.AvailableSkuIds.update({'DEFAULT':0, 'COMMON':0})\r
        if self.SkuIdSet:\r
            GlobalData.gSkuids = (self.SkuIdSet)\r
            if 'COMMON' in GlobalData.gSkuids:\r
                GlobalData.gSkuids.remove('COMMON')\r
            if self.SkuUsageType == self.SINGLE:\r
                if len(GlobalData.gSkuids) != 1:\r
                    if 'DEFAULT' in GlobalData.gSkuids:\r
                        GlobalData.gSkuids.remove('DEFAULT')\r
            if GlobalData.gSkuids:\r
                GlobalData.gSkuids.sort()\r
\r
    def GetNextSkuId(self, skuname):\r
        if not self._SkuInherit:\r
            self._SkuInherit = {}\r
            for item in self.SkuData.values():\r
                self._SkuInherit[item[1]]=item[2] if item[2] else "DEFAULT"\r
        return self._SkuInherit.get(skuname, "DEFAULT")\r
\r
    def GetSkuChain(self, sku):\r
        if sku == "DEFAULT":\r
            return ["DEFAULT"]\r
        skulist = [sku]\r
        nextsku = sku\r
        while True:\r
            nextsku = self.GetNextSkuId(nextsku)\r
            skulist.append(nextsku)\r
            if nextsku == "DEFAULT":\r
                break\r
        skulist.reverse()\r
        return skulist\r
    def SkuOverrideOrder(self):\r
        skuorderset = []\r
        for skuname in self.SkuIdSet:\r
            skuorderset.append(self.GetSkuChain(skuname))\r
\r
        skuorder = []\r
        for index in range(max(len(item) for item in skuorderset)):\r
            for subset in skuorderset:\r
                if index > len(subset)-1:\r
                    continue\r
                if subset[index] in skuorder:\r
                    continue\r
                skuorder.append(subset[index])\r
\r
        return skuorder\r
\r
    @property\r
    def SkuUsageType(self):\r
        if self._SkuIdentifier.upper() == "ALL":\r
            return SkuClass.MULTIPLE\r
\r
        if len(self.SkuIdSet) == 1:\r
            if self.SkuIdSet[0] == 'DEFAULT':\r
                return SkuClass.DEFAULT\r
            return SkuClass.SINGLE\r
        if len(self.SkuIdSet) == 2 and 'DEFAULT' in self.SkuIdSet:\r
            return SkuClass.SINGLE\r
        return SkuClass.MULTIPLE\r
\r
    def DumpSkuIdArrary(self):\r
        if self.SkuUsageType == SkuClass.SINGLE:\r
            return "{0x0}"\r
        ArrayStrList = []\r
        for skuname in self.AvailableSkuIds:\r
            if skuname == "COMMON":\r
                continue\r
            while skuname != "DEFAULT":\r
                ArrayStrList.append(hex(int(self.AvailableSkuIds[skuname])))\r
                skuname = self.GetNextSkuId(skuname)\r
            ArrayStrList.append("0x0")\r
        return "{{{myList}}}".format(myList=",".join(ArrayStrList))\r
\r
    @property\r
    def AvailableSkuIdSet(self):\r
        return self.AvailableSkuIds\r
\r
    @property\r
    def SystemSkuId(self):\r
        if self.SkuUsageType == SkuClass.SINGLE:\r
            if len(self.SkuIdSet) == 1:\r
                return self.SkuIdSet[0]\r
            else:\r
                return self.SkuIdSet[0] if self.SkuIdSet[0] != 'DEFAULT' else self.SkuIdSet[1]\r
        else:\r
            return 'DEFAULT'\r
\r
##  Get the integer value from string like "14U" or integer like 2\r
#\r
#   @param      Input   The object that may be either a integer value or a string\r
#\r
#   @retval     Value    The integer value that the input represents\r
#\r
def GetIntegerValue(Input):\r
    if type(Input) in (int, long):\r
        return Input\r
    String = Input\r
    if String.endswith("U"):\r
        String = String[:-1]\r
    if String.endswith("ULL"):\r
        String = String[:-3]\r
    if String.endswith("LL"):\r
        String = String[:-2]\r
\r
    if String.startswith("0x") or String.startswith("0X"):\r
        return int(String, 16)\r
    elif String == '':\r
        return 0\r
    else:\r
        return int(String)\r
\r
#\r
# Pack a GUID (registry format) list into a buffer and return it\r
#\r
def PackGUID(Guid):\r
    return pack(PACK_PATTERN_GUID,\r
                int(Guid[0], 16),\r
                int(Guid[1], 16),\r
                int(Guid[2], 16),\r
                int(Guid[3][-4:-2], 16),\r
                int(Guid[3][-2:], 16),\r
                int(Guid[4][-12:-10], 16),\r
                int(Guid[4][-10:-8], 16),\r
                int(Guid[4][-8:-6], 16),\r
                int(Guid[4][-6:-4], 16),\r
                int(Guid[4][-4:-2], 16),\r
                int(Guid[4][-2:], 16)\r
                )\r
\r
#\r
# Pack a GUID (byte) list into a buffer and return it\r
#\r
def PackByteFormatGUID(Guid):\r
    return pack(PACK_PATTERN_GUID,\r
                Guid[0],\r
                Guid[1],\r
                Guid[2],\r
                Guid[3],\r
                Guid[4],\r
                Guid[5],\r
                Guid[6],\r
                Guid[7],\r
                Guid[8],\r
                Guid[9],\r
                Guid[10],\r
                )\r
\r
## DeepCopy dict/OrderedDict recusively\r
#\r
#   @param      ori_dict    a nested dict or ordereddict\r
#\r
#   @retval     new dict or orderdict\r
#\r
def CopyDict(ori_dict):\r
    dict_type = ori_dict.__class__\r
    if dict_type not in (dict,OrderedDict):\r
        return ori_dict\r
    new_dict = dict_type()\r
    for key in ori_dict:\r
        if isinstance(ori_dict[key],(dict,OrderedDict)):\r
            new_dict[key] = CopyDict(ori_dict[key])\r
        else:\r
            new_dict[key] = ori_dict[key]\r
    return new_dict\r
\r
#\r
# Remove the c/c++ comments: // and /* */\r
#\r
def RemoveCComments(ctext):\r
    return re.sub('//.*?\n|/\*.*?\*/', '\n', ctext, flags=re.S)\r