Sync basetools' source and binary files with r1707 of the basetools project.

[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / StrGather.py

# Copyright (c) 2007, Intel Corporation\r
# All rights reserved. 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
#This file is used to parse a strings file and create or add to a string database file.\r
#\r
\r
##\r
# Import Modules\r
#\r
import re\r
import Common.EdkLogger as EdkLogger\r
from Common.BuildToolError import *\r
from UniClassObject import *\r
\r
##\r
# Static definitions\r
#\r
EFI_HII_SIBT_END = '0x00'\r
EFI_HII_SIBT_STRING_SCSU = '0x10'\r
EFI_HII_SIBT_STRING_SCSU_FONT = '0x11'\r
EFI_HII_SIBT_STRINGS_SCSU = '0x12'\r
EFI_HII_SIBT_STRINGS_SCSU_FONT = '0x13'\r
EFI_HII_SIBT_STRING_UCS2 = '0x14'\r
EFI_HII_SIBT_STRING_UCS2_FONT = '0x15'\r
EFI_HII_SIBT_STRINGS_UCS2 = '0x16'\r
EFI_HII_SIBT_STRINGS_UCS2_FONT = '0x17'\r
EFI_HII_SIBT_DUPLICATE = '0x20'\r
EFI_HII_SIBT_SKIP2 = '0x21'\r
EFI_HII_SIBT_SKIP1 = '0x22'\r
EFI_HII_SIBT_EXT1 = '0x30'\r
EFI_HII_SIBT_EXT2 = '0x31'\r
EFI_HII_SIBT_EXT4 = '0x32'\r
EFI_HII_SIBT_FONT = '0x40'\r
\r
EFI_HII_PACKAGE_STRINGS = '0x04'\r
EFI_HII_PACKAGE_FORM = '0x02'\r
\r
StringPackageType = EFI_HII_PACKAGE_STRINGS\r
StringPackageForm = EFI_HII_PACKAGE_FORM\r
StringBlockType = EFI_HII_SIBT_STRING_UCS2\r
StringSkipType = EFI_HII_SIBT_SKIP2\r
\r
HexHeader = '0x'\r
\r
COMMENT = '// '\r
DEFINE_STR = '#define'\r
COMMENT_DEFINE_STR = COMMENT + DEFINE_STR\r
NOT_REFERENCED = 'not referenced'\r
COMMENT_NOT_REFERENCED = ' ' + COMMENT + NOT_REFERENCED\r
CHAR_ARRAY_DEFIN = 'unsigned char'\r
COMMON_FILE_NAME = 'Strings'\r
OFFSET = 'offset'\r
STRING = 'string'\r
TO = 'to'\r
STRING_TOKEN = re.compile('STRING_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)\r
\r
EFI_HII_ARRAY_SIZE_LENGTH = 4\r
EFI_HII_PACKAGE_HEADER_LENGTH = 4\r
EFI_HII_HDR_SIZE_LENGTH = 4\r
EFI_HII_STRING_OFFSET_LENGTH = 4\r
EFI_STRING_ID = 1\r
EFI_STRING_ID_LENGTH = 2\r
EFI_HII_LANGUAGE_WINDOW = 0\r
EFI_HII_LANGUAGE_WINDOW_LENGTH = 2\r
EFI_HII_LANGUAGE_WINDOW_NUMBER = 16\r
EFI_HII_STRING_PACKAGE_HDR_LENGTH = EFI_HII_PACKAGE_HEADER_LENGTH + EFI_HII_HDR_SIZE_LENGTH + EFI_HII_STRING_OFFSET_LENGTH + EFI_HII_LANGUAGE_WINDOW_LENGTH * EFI_HII_LANGUAGE_WINDOW_NUMBER + EFI_STRING_ID_LENGTH\r
\r
H_C_FILE_HEADER = ['//', \\r
                   '//  DO NOT EDIT -- auto-generated file', \\r
                   '//', \\r
                   '//  This file is generated by the StrGather utility', \\r
                   '//']\r
LANGUAGE_NAME_STRING_NAME = '$LANGUAGE_NAME'\r
PRINTABLE_LANGUAGE_NAME_STRING_NAME = '$PRINTABLE_LANGUAGE_NAME'\r
\r
## Convert a dec number to a hex string\r
#\r
# Convert a dec number to a formatted hex string in length digit\r
# The digit is set to default 8\r
# The hex string starts with "0x"\r
# DecToHexStr(1000) is '0x000003E8'\r
# DecToHexStr(1000, 6) is '0x0003E8'\r
#\r
# @param Dec:    The number in dec format\r
# @param Digit:  The needed digit of hex string\r
#\r
# @retval:       The formatted hex string\r
#\r
def DecToHexStr(Dec, Digit = 8):\r
    return eval("'0x%0" + str(Digit) + "X' % int(Dec)")\r
\r
## Convert a dec number to a hex list\r
#\r
# Convert a dec number to a formatted hex list in size digit\r
# The digit is set to default 8\r
# DecToHexList(1000) is ['0xE8', '0x03', '0x00', '0x00']\r
# DecToHexList(1000, 6) is ['0xE8', '0x03', '0x00']\r
#\r
# @param Dec:    The number in dec format\r
# @param Digit:  The needed digit of hex list\r
#\r
# @retval:       A list for formatted hex string\r
#\r
def DecToHexList(Dec, Digit = 8):\r
    Hex = eval("'%0" + str(Digit) + "X' % int(Dec)" )\r
    List = []\r
    for Bit in range(Digit - 2, -1, -2):\r
        List.append(HexHeader + Hex[Bit:Bit + 2])\r
    return List\r
\r
## Convert a acsii string to a hex list\r
#\r
# Convert a acsii string to a formatted hex list\r
# AscToHexList('en-US') is ['0x65', '0x6E', '0x2D', '0x55', '0x53']\r
#\r
# @param Ascii:  The acsii string\r
#\r
# @retval:       A list for formatted hex string\r
#\r
def AscToHexList(Ascii):\r
    List = []\r
    for Item in Ascii:\r
        List.append('0x%2X' % ord(Item))\r
\r
    return List\r
\r
## Create header of .h file\r
#\r
# Create a header of .h file\r
#\r
# @param BaseName: The basename of strings\r
#\r
# @retval Str:     A string for .h file header\r
#\r
def CreateHFileHeader(BaseName):\r
    Str = ''\r
    for Item in H_C_FILE_HEADER:\r
        Str = WriteLine(Str, Item)\r
    Str = WriteLine(Str, '#ifndef _' + BaseName.upper() + '_STRINGS_DEFINE_H_')\r
    Str = WriteLine(Str, '#define _' + BaseName.upper() + '_STRINGS_DEFINE_H_')\r
    return Str\r
\r
## Create content of .h file\r
#\r
# Create content of .h file\r
#\r
# @param BaseName:       The basename of strings\r
# @param UniObjectClass: A UniObjectClass instance\r
#\r
# @retval Str:           A string of .h file content\r
#\r
def CreateHFileContent(BaseName, UniObjectClass):\r
    Str = ''\r
    ValueStartPtr = 60\r
    Line = COMMENT_DEFINE_STR + ' ' + LANGUAGE_NAME_STRING_NAME + ' ' * (ValueStartPtr - len(DEFINE_STR + LANGUAGE_NAME_STRING_NAME)) + DecToHexStr(0, 4) + COMMENT_NOT_REFERENCED\r
    Str = WriteLine(Str, Line)\r
    Line = COMMENT_DEFINE_STR + ' ' + PRINTABLE_LANGUAGE_NAME_STRING_NAME + ' ' * (ValueStartPtr - len(DEFINE_STR + PRINTABLE_LANGUAGE_NAME_STRING_NAME)) + DecToHexStr(1, 4) + COMMENT_NOT_REFERENCED\r
    Str = WriteLine(Str, Line)\r
    for Index in range(2, len(UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]])):\r
        StringItem = UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]][Index]\r
        Name = StringItem.StringName\r
        Token = StringItem.Token\r
        Referenced = StringItem.Referenced\r
        if Name != None:\r
            Line = ''\r
            if Referenced == True:\r
                if (ValueStartPtr - len(DEFINE_STR + Name)) <= 0:\r
                    Line = DEFINE_STR + ' ' + Name + ' ' + DecToHexStr(Token, 4)\r
                else:\r
                    Line = DEFINE_STR + ' ' + Name + ' ' * (ValueStartPtr - len(DEFINE_STR + Name)) + DecToHexStr(Token, 4)\r
            else:\r
                if (ValueStartPtr - len(DEFINE_STR + Name)) <= 0:\r
                    Line = COMMENT_DEFINE_STR + ' ' + Name + ' ' + DecToHexStr(Token, 4) + COMMENT_NOT_REFERENCED\r
                else:\r
                    Line = COMMENT_DEFINE_STR + ' ' + Name + ' ' * (ValueStartPtr - len(DEFINE_STR + Name)) + DecToHexStr(Token, 4) + COMMENT_NOT_REFERENCED\r
            Str = WriteLine(Str, Line)\r
\r
    Str =  WriteLine(Str, '')\r
    Str = WriteLine(Str, 'extern unsigned char ' + BaseName + 'Strings[];')\r
    return Str\r
\r
## Create a complete .h file\r
#\r
# Create a complet .h file with file header and file content\r
#\r
# @param BaseName:       The basename of strings\r
# @param UniObjectClass: A UniObjectClass instance\r
#\r
# @retval Str:           A string of complete .h file\r
#\r
def CreateHFile(BaseName, UniObjectClass):\r
    HFile = WriteLine('', CreateHFileContent(BaseName, UniObjectClass))\r
\r
    return HFile\r
\r
## Create header of .c file\r
#\r
# Create a header of .c file\r
#\r
# @retval Str:     A string for .c file header\r
#\r
def CreateCFileHeader():\r
    Str = ''\r
    for Item in H_C_FILE_HEADER:\r
        Str = WriteLine(Str, Item)\r
\r
    return Str\r
\r
## Create a formatted string all items in an array\r
#\r
# Use ',' to join each item in an array, and break an new line when reaching the width (default is 16)\r
#\r
# @param Array:      The array need to be formatted\r
# @param Width:      The line length, the default value is set to 16\r
#\r
# @retval ArrayItem: A string for all formatted array items\r
#\r
def CreateArrayItem(Array, Width = 16):\r
    MaxLength = Width\r
    Index = 0\r
    Line = '  '\r
    ArrayItem = ''\r
\r
    for Item in Array:\r
        if Index < MaxLength:\r
            Line = Line + Item + ',  '\r
            Index = Index + 1\r
        else:\r
            ArrayItem = WriteLine(ArrayItem, Line)\r
            Line = '  ' + Item +  ',  '\r
            Index = 1\r
    ArrayItem = Write(ArrayItem, Line.rstrip())\r
\r
    return ArrayItem\r
\r
## CreateCFileStringValue\r
#\r
# Create a line with string value\r
#\r
# @param Value:  Value of the string\r
#\r
# @retval Str:   A formatted string with string value\r
#\r
\r
def CreateCFileStringValue(Value):\r
    Value = [StringBlockType] + Value\r
    Str = WriteLine('', CreateArrayItem(Value))\r
\r
    return Str\r
\r
\r
## Create content of .c file\r
#\r
# Create content of .c file\r
#\r
# @param BaseName:       The basename of strings\r
# @param UniObjectClass: A UniObjectClass instance\r
#\r
# @retval Str:           A string of .c file content\r
#\r
def CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode):\r
    #\r
    # Init array length\r
    #\r
    TotalLength = EFI_HII_ARRAY_SIZE_LENGTH\r
    Str = ''\r
    Offset = 0\r
\r
    #\r
    # Create lines for each language's strings\r
    #\r
    for IndexI in range(len(UniObjectClass.LanguageDef)):\r
        Language = UniObjectClass.LanguageDef[IndexI][0]\r
        LangPrintName = UniObjectClass.LanguageDef[IndexI][1]\r
\r
        StrStringValue = ''\r
        ArrayLength = 0\r
        NumberOfUseOhterLangDef = 0\r
        Index = 0\r
        for IndexJ in range(1, len(UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[IndexI][0]])):\r
            Item = UniObjectClass.FindByToken(IndexJ, Language)\r
            Name = Item.StringName\r
            Value = Item.StringValueByteList\r
            Referenced = Item.Referenced\r
            Token = Item.Token\r
            Length = Item.Length\r
            UseOtherLangDef = Item.UseOtherLangDef\r
\r
            if UseOtherLangDef != '' and Referenced:\r
                NumberOfUseOhterLangDef = NumberOfUseOhterLangDef + 1\r
                Index = Index + 1\r
            else:\r
                if NumberOfUseOhterLangDef > 0:\r
                    StrStringValue = WriteLine(StrStringValue, CreateArrayItem([StringSkipType] + DecToHexList(NumberOfUseOhterLangDef, 4)))\r
                    NumberOfUseOhterLangDef = 0\r
                    ArrayLength = ArrayLength + 3\r
                if Referenced and Item.Token > 0:\r
                    Index = Index + 1\r
                    StrStringValue = WriteLine(StrStringValue, "// %s: %s:%s" % (DecToHexStr(Index, 4), Name, DecToHexStr(Token, 4)))\r
                    StrStringValue = Write(StrStringValue, CreateCFileStringValue(Value))\r
                    Offset = Offset + Length\r
                    ArrayLength = ArrayLength + Item.Length + 1 # 1 is for the length of string type\r
\r
        #\r
        # EFI_HII_PACKAGE_HEADER\r
        #\r
        Offset = EFI_HII_STRING_PACKAGE_HDR_LENGTH + len(Language) + 1\r
        ArrayLength = Offset + ArrayLength + 1\r
\r
        #\r
        # Create PACKAGE HEADER\r
        #\r
        Str = WriteLine(Str, '// PACKAGE HEADER\n')\r
        TotalLength = TotalLength + ArrayLength\r
\r
        List = DecToHexList(ArrayLength, 6) + \\r
               [StringPackageType] + \\r
               DecToHexList(Offset) + \\r
               DecToHexList(Offset) + \\r
               DecToHexList(EFI_HII_LANGUAGE_WINDOW, EFI_HII_LANGUAGE_WINDOW_LENGTH * 2) * EFI_HII_LANGUAGE_WINDOW_NUMBER + \\r
               DecToHexList(EFI_STRING_ID, 4) + \\r
               AscToHexList(Language) + \\r
               DecToHexList(0, 2)\r
        Str = WriteLine(Str, CreateArrayItem(List, 16) + '\n')\r
\r
        #\r
        # Create PACKAGE DATA\r
        #\r
        Str = WriteLine(Str, '// PACKAGE DATA\n')\r
        Str = Write(Str, StrStringValue)\r
\r
        #\r
        # Add an EFI_HII_SIBT_END at last\r
        #\r
        Str = WriteLine(Str, '  ' + EFI_HII_SIBT_END + ",")\r
\r
    #\r
    # Create line for string variable name\r
    # "unsigned char $(BaseName)Strings[] = {"\r
    #\r
    AllStr = WriteLine('', CHAR_ARRAY_DEFIN + ' ' + BaseName + COMMON_FILE_NAME + '[] = {\n' )\r
\r
    #\r
    # Create FRAMEWORK_EFI_HII_PACK_HEADER in compatible mode\r
    #\r
    if IsCompatibleMode:\r
        AllStr = WriteLine(AllStr, '// FRAMEWORK PACKAGE HEADER Length')\r
        AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength + 2)) + '\n')\r
        AllStr = WriteLine(AllStr, '// FRAMEWORK PACKAGE HEADER Type')\r
        AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(2, 4)) + '\n')\r
\r
    #\r
    # Create whole array length in UEFI mode\r
    #\r
    if not IsCompatibleMode:\r
        AllStr = WriteLine(AllStr, '// STRGATHER_OUTPUT_HEADER')\r
        AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength)) + '\n')\r
\r
    #\r
    # Join package data\r
    #\r
    AllStr = Write(AllStr, Str)\r
\r
    return AllStr\r
\r
## Create end of .c file\r
#\r
# Create end of .c file\r
#\r
# @retval Str:           A string of .h file end\r
#\r
def CreateCFileEnd():\r
    Str = Write('', '};')\r
    return Str\r
\r
## Create a .c file\r
#\r
# Create a complete .c file\r
#\r
# @param BaseName:       The basename of strings\r
# @param UniObjectClass: A UniObjectClass instance\r
#\r
# @retval CFile:         A string of complete .c file\r
#\r
def CreateCFile(BaseName, UniObjectClass, IsCompatibleMode):\r
    CFile = ''\r
    #CFile = WriteLine(CFile, CreateCFileHeader())\r
    CFile = WriteLine(CFile, CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode))\r
    CFile = WriteLine(CFile, CreateCFileEnd())\r
    return CFile\r
\r
## GetFileList\r
#\r
# Get a list for all files\r
#\r
# @param IncludeList:  A list of all path to be searched\r
# @param SkipList:     A list of all types of file could be skipped\r
#\r
# @retval FileList:    A list of all files found\r
#\r
def GetFileList(SourceFileList, IncludeList, SkipList):\r
    if IncludeList == None:\r
        EdkLogger.error("UnicodeStringGather", AUTOGEN_ERROR, "Include path for unicode file is not defined")\r
\r
    FileList = []\r
    if SkipList == None:\r
        SkipList = []\r
\r
    for File in SourceFileList:\r
        for Dir in IncludeList:\r
            if not os.path.exists(Dir):\r
                continue\r
            File = os.path.join(Dir, File.Path)\r
            #\r
            # Ignore Dir\r
            #\r
            if os.path.isfile(File) != True:\r
                continue\r
            #\r
            # Ignore file listed in skip list\r
            #\r
            IsSkip = False\r
            for Skip in SkipList:\r
                if os.path.splitext(File)[1].upper() == Skip.upper():\r
                    EdkLogger.verbose("Skipped %s for string token uses search" % File)\r
                    IsSkip = True\r
                    break\r
\r
            if not IsSkip:\r
                FileList.append(File)\r
\r
            break\r
\r
    return FileList\r
\r
## SearchString\r
#\r
# Search whether all string defined in UniObjectClass are referenced\r
# All string used should be set to Referenced\r
#\r
# @param UniObjectClass:  Input UniObjectClass\r
# @param FileList:        Search path list\r
#\r
# @retval UniObjectClass: UniObjectClass after searched\r
#\r
def SearchString(UniObjectClass, FileList):\r
    if FileList == []:\r
        return UniObjectClass\r
\r
    for File in FileList:\r
        if os.path.isfile(File):\r
            Lines = open(File, 'r')\r
            for Line in Lines:\r
                StringTokenList = STRING_TOKEN.findall(Line)\r
                for StrName in StringTokenList:\r
                    EdkLogger.debug(EdkLogger.DEBUG_5, "Found string identifier: " + StrName)\r
                    UniObjectClass.SetStringReferenced(StrName)\r
\r
    UniObjectClass.ReToken()\r
\r
    return UniObjectClass\r
\r
## GetStringFiles\r
#\r
# This function is used for UEFI2.1 spec\r
#\r
#\r
def GetStringFiles(UniFilList, SourceFileList, IncludeList, SkipList, BaseName, IsCompatibleMode = False, ShellMode = False):\r
    Status = True\r
    ErrorMessage = ''\r
\r
    if len(UniFilList) > 0:\r
        if ShellMode:\r
            #\r
            # support ISO 639-2 codes in .UNI files of EDK Shell\r
            #\r
            Uni = UniFileClassObject(UniFilList, True)\r
        else:\r
            Uni = UniFileClassObject(UniFilList, IsCompatibleMode)\r
    else:\r
        EdkLogger.error("UnicodeStringGather", AUTOGEN_ERROR, 'No unicode files given')\r
\r
    FileList = GetFileList(SourceFileList, IncludeList, SkipList)\r
\r
    Uni = SearchString(Uni, FileList)\r
\r
    HFile = CreateHFile(BaseName, Uni)\r
    CFile = CreateCFile(BaseName, Uni, IsCompatibleMode)\r
\r
    return HFile, CFile\r
\r
#\r
# Write an item\r
#\r
def Write(Target, Item):\r
    return Target + Item\r
\r
#\r
# Write an item with a break line\r
#\r
def WriteLine(Target, Item):\r
    return Target + Item + '\n'\r
\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# script.\r
if __name__ == '__main__':\r
    EdkLogger.info('start')\r
\r
    UniFileList = [\r
                   r'C:\\Edk\\Strings2.uni',\r
                   r'C:\\Edk\\Strings.uni'\r
    ]\r
\r
    SrcFileList = []\r
    for Root, Dirs, Files in os.walk('C:\\Edk'):\r
        for File in Files:\r
            SrcFileList.append(File)\r
\r
    IncludeList = [\r
                   r'C:\\Edk'\r
    ]\r
\r
    SkipList = ['.inf', '.uni']\r
    BaseName = 'DriverSample'\r
    (h, c) = GetStringFiles(UniFileList, SrcFileList, IncludeList, SkipList, BaseName, True)\r
    hfile = open('unistring.h', 'w')\r
    cfile = open('unistring.c', 'w')\r
    hfile.write(h)\r
    cfile.write(c)\r
\r
    EdkLogger.info('end')\r