X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=BaseTools%2FSource%2FPython%2FAutoGen%2FStrGather.py;h=b84d9f90aaec59e003d65fa3adb3252622c85714;hb=e8a47801a1dfdb148b1bfcd5bdc8ebc3bf51f92d;hp=52ab439e9b0b5129d5a827fabb93532f8017834d;hpb=756ad8f8e9d3e345f1883546e2a3125203e234aa;p=mirror_edk2.git

diff --git a/BaseTools/Source/Python/AutoGen/StrGather.py b/BaseTools/Source/Python/AutoGen/StrGather.py
index 52ab439e9b..b84d9f90aa 100644
--- a/BaseTools/Source/Python/AutoGen/StrGather.py
+++ b/BaseTools/Source/Python/AutoGen/StrGather.py
@@ -62,7 +62,7 @@ OFFSET = 'offset'
 STRING = 'string'
 TO = 'to'
 STRING_TOKEN = re.compile('STRING_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)
-COMPATIBLE_STRING_TOKEN = re.compile('STRING_TOKEN *\(([A-Za-z0-9_]+) *\)', re.MULTILINE | re.UNICODE)
+COMPATIBLE_STRING_TOKEN = re.compile('STRING_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)
 
 EFI_HII_ARRAY_SIZE_LENGTH = 4
 EFI_HII_PACKAGE_HEADER_LENGTH = 4
@@ -168,8 +168,9 @@ def CreateHFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniGenCFlag):
     Str = WriteLine(Str, Line)
     Line = COMMENT_DEFINE_STR + ' ' + PRINTABLE_LANGUAGE_NAME_STRING_NAME + ' ' * (ValueStartPtr - len(DEFINE_STR + PRINTABLE_LANGUAGE_NAME_STRING_NAME)) + DecToHexStr(1, 4) + COMMENT_NOT_REFERENCED
     Str = WriteLine(Str, Line)
+    UnusedStr = ''
 
-    #Group the referred STRING token together. 
+    #Group the referred/Unused STRING token together. 
     for Index in range(2, len(UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]])):
         StringItem = UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]][Index]
         Name = StringItem.StringName
@@ -183,21 +184,14 @@ def CreateHFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniGenCFlag):
                 else:
                     Line = DEFINE_STR + ' ' + Name + ' ' * (ValueStartPtr - len(DEFINE_STR + Name)) + DecToHexStr(Token, 4)
                 Str = WriteLine(Str, Line)
-
-    #Group the unused STRING token together.
-    for Index in range(2, len(UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]])):
-        StringItem = UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]][Index]
-        Name = StringItem.StringName
-        Token = StringItem.Token
-        Referenced = StringItem.Referenced
-        if Name != None:
-            Line = ''
-            if Referenced == False:
+            else:
                 if (ValueStartPtr - len(DEFINE_STR + Name)) <= 0:
                     Line = COMMENT_DEFINE_STR + ' ' + Name + ' ' + DecToHexStr(Token, 4) + COMMENT_NOT_REFERENCED
                 else:
                     Line = COMMENT_DEFINE_STR + ' ' + Name + ' ' * (ValueStartPtr - len(DEFINE_STR + Name)) + DecToHexStr(Token, 4) + COMMENT_NOT_REFERENCED
-                Str = WriteLine(Str, Line)
+                UnusedStr = WriteLine(UnusedStr, Line)
+
+    Str = ''.join([Str,UnusedStr])
 
     Str = WriteLine(Str, '')
     if IsCompatibleMode or UniGenCFlag:
@@ -284,6 +278,65 @@ def CreateCFileStringValue(Value):
 
     return Str
 
+## GetFilteredLanguage
+#
+# apply get best language rules to the UNI language code list
+#
+# @param UniLanguageList:  language code definition list in *.UNI file
+# @param LanguageFilterList:  language code filter list of RFC4646 format in DSC file
+#
+# @retval UniLanguageListFiltered:   the filtered language code
+#
+def GetFilteredLanguage(UniLanguageList, LanguageFilterList):
+    UniLanguageListFiltered = []
+    # if filter list is empty, then consider there is no filter
+    if LanguageFilterList == []:
+        UniLanguageListFiltered = UniLanguageList
+        return UniLanguageListFiltered
+    for Language in LanguageFilterList:
+        # first check for exact match
+        if Language in UniLanguageList:
+            if Language not in UniLanguageListFiltered:
+                UniLanguageListFiltered += [Language]
+        # find the first one with the same/equivalent primary tag
+        else:
+            if Language.find('-') != -1:
+                PrimaryTag = Language[0:Language.find('-')].lower()
+            else:
+                PrimaryTag = Language
+            
+            if len(PrimaryTag) == 3:
+                PrimaryTag = LangConvTable.get(PrimaryTag)
+            
+            for UniLanguage in UniLanguageList:
+                if UniLanguage.find('-') != -1:
+                    UniLanguagePrimaryTag = UniLanguage[0:UniLanguage.find('-')].lower()
+                else:
+                    UniLanguagePrimaryTag = UniLanguage
+                
+                if len(UniLanguagePrimaryTag) == 3:
+                    UniLanguagePrimaryTag = LangConvTable.get(UniLanguagePrimaryTag)
+
+                if PrimaryTag == UniLanguagePrimaryTag:
+                    if UniLanguage not in UniLanguageListFiltered:
+                        UniLanguageListFiltered += [UniLanguage]    
+                    break
+            else:
+                # Here is rule 3 for "get best language"
+                # If tag is not listed in the Unicode file, the default ("en") tag should be used for that language
+                # for better processing, find the one that best suit for it.
+                DefaultTag = 'en'
+                if DefaultTag not in UniLanguageListFiltered:
+                    # check whether language code with primary code equivalent with DefaultTag already in the list, if so, use that
+                    for UniLanguage in UniLanguageList:
+                        if UniLanguage.startswith('en-') or UniLanguage.startswith('eng-'):
+                            if UniLanguage not in UniLanguageListFiltered:
+                                UniLanguageListFiltered += [UniLanguage]
+                            break
+                    else:
+                        UniLanguageListFiltered += [DefaultTag]
+    return  UniLanguageListFiltered
+
 
 ## Create content of .c file
 #
@@ -293,10 +346,11 @@ def CreateCFileStringValue(Value):
 # @param UniObjectClass   A UniObjectClass instance
 # @param IsCompatibleMode Compatible mode
 # @param UniBinBuffer     UniBinBuffer to contain UniBinary data.
+# @param FilterInfo       Platform language filter information 
 #
 # @retval Str:           A string of .c file content
 #
-def CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniBinBuffer=None):
+def CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniBinBuffer, FilterInfo):
     #
     # Init array length
     #
@@ -304,25 +358,40 @@ def CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniBinBuffer=
     Str = ''
     Offset = 0
 
+    EDK2Module = FilterInfo[0]
+    if EDK2Module:
+        LanguageFilterList = FilterInfo[1]
+    else:
+        # EDK module is using ISO639-2 format filter, convert to the RFC4646 format
+        LanguageFilterList = [LangConvTable.get(F.lower()) for F in FilterInfo[1]]
+    
+    UniLanguageList = []
+    for IndexI in range(len(UniObjectClass.LanguageDef)):
+        UniLanguageList += [UniObjectClass.LanguageDef[IndexI][0]]           
+
+    UniLanguageListFiltered = GetFilteredLanguage(UniLanguageList, LanguageFilterList)
+ 
+        
     #
     # Create lines for each language's strings
     #
     for IndexI in range(len(UniObjectClass.LanguageDef)):
         Language = UniObjectClass.LanguageDef[IndexI][0]
-        LangPrintName = UniObjectClass.LanguageDef[IndexI][1]
-
+        if Language not in UniLanguageListFiltered:
+            continue
+        
         StringBuffer = StringIO()
         StrStringValue = ''
         ArrayLength = 0
         NumberOfUseOtherLangDef = 0
         Index = 0
         for IndexJ in range(1, len(UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[IndexI][0]])):
-            Item = UniObjectClass.FindByToken(IndexJ, Language)
+            Item = UniObjectClass.OrderedStringListByToken[Language][IndexJ]
+
             Name = Item.StringName
             Value = Item.StringValueByteList
             Referenced = Item.Referenced
             Token = Item.Token
-            Length = Item.Length
             UseOtherLangDef = Item.UseOtherLangDef
 
             if UseOtherLangDef != '' and Referenced:
@@ -428,13 +497,14 @@ def CreateCFileEnd():
 # @param BaseName:        The basename of strings
 # @param UniObjectClass   A UniObjectClass instance
 # @param IsCompatibleMode Compatible Mode
+# @param FilterInfo       Platform language filter information 
 #
-# @retval CFile:         A string of complete .c file
+# @retval CFile:          A string of complete .c file
 #
-def CreateCFile(BaseName, UniObjectClass, IsCompatibleMode):
+def CreateCFile(BaseName, UniObjectClass, IsCompatibleMode, FilterInfo):
     CFile = ''
     #CFile = WriteLine(CFile, CreateCFileHeader())
-    CFile = WriteLine(CFile, CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode))
+    CFile = WriteLine(CFile, CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, None, FilterInfo))
     CFile = WriteLine(CFile, CreateCFileEnd())
     return CFile
 
@@ -518,10 +588,7 @@ def SearchString(UniObjectClass, FileList, IsCompatibleMode):
 # This function is used for UEFI2.1 spec
 #
 #
-def GetStringFiles(UniFilList, SourceFileList, IncludeList, IncludePathList, SkipList, BaseName, IsCompatibleMode = False, ShellMode = False, UniGenCFlag = True, UniGenBinBuffer = None):
-    Status = True
-    ErrorMessage = ''
-
+def GetStringFiles(UniFilList, SourceFileList, IncludeList, IncludePathList, SkipList, BaseName, IsCompatibleMode = False, ShellMode = False, UniGenCFlag = True, UniGenBinBuffer = None, FilterInfo = [True, []]):  
     if len(UniFilList) > 0:
         if ShellMode:
             #
@@ -540,9 +607,9 @@ def GetStringFiles(UniFilList, SourceFileList, IncludeList, IncludePathList, Ski
     HFile = CreateHFile(BaseName, Uni, IsCompatibleMode, UniGenCFlag)
     CFile = None
     if IsCompatibleMode or UniGenCFlag:
-        CFile = CreateCFile(BaseName, Uni, IsCompatibleMode)
+        CFile = CreateCFile(BaseName, Uni, IsCompatibleMode, FilterInfo)
     if UniGenBinBuffer:
-        CreateCFileContent(BaseName, Uni, IsCompatibleMode, UniGenBinBuffer)
+        CreateCFileContent(BaseName, Uni, IsCompatibleMode, UniGenBinBuffer, FilterInfo)
 
     return HFile, CFile
 
@@ -550,13 +617,13 @@ def GetStringFiles(UniFilList, SourceFileList, IncludeList, IncludePathList, Ski
 # Write an item
 #
 def Write(Target, Item):
-    return Target + Item
+    return ''.join([Target,Item])
 
 #
 # Write an item with a break line
 #
 def WriteLine(Target, Item):
-    return Target + Item + '\n'
+    return ''.join([Target,Item,'\n'])
 
 # This acts like the main() function for the script, unless it is 'import'ed into another
 # script.