-# Copyright (c) 2007, Intel Corporation\r
-# All rights reserved. This program and the accompanying materials\r
+## @file\r
+# This file is used to collect all defined strings in multiple uni files\r
+#\r
+# Copyright (c) 2007 - 2014, 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
# 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 collect all defined strings in multiple uni files\r
-#\r
-\r
##\r
# Import Modules\r
#\r
-import os, codecs, re\r
+import Common.LongFilePathOs as os, codecs, re\r
+import distutils.util\r
import Common.EdkLogger as EdkLogger\r
from Common.BuildToolError import *\r
from Common.String import GetLineNo\r
from Common.Misc import PathClass\r
-\r
+from Common.LongFilePathSupport import LongFilePath\r
##\r
# Static definitions\r
#\r
NULL = u'\u0000'\r
TAB = u'\t'\r
BACK_SPLASH = u'\\'\r
+DOBULE_QUOTED_SPLASH = u'\\"'\r
+SIGLE_QUOTED_SPLASH = u"\\'"\r
+TAB_BACK_SLASH = u"\\/"\r
\r
gIncludePattern = re.compile("^#include +[\"<]+([^\"< >]+)[>\"]+$", re.MULTILINE | re.UNICODE)\r
\r
if length == 3 and LangName.isalpha():\r
TempLangName = LangConvTable.get(LangName.lower())\r
if TempLangName != None:\r
- return TempLangName\r
+ return TempLangName\r
return LangName\r
else:\r
EdkLogger.error("Unicode File Parser", FORMAT_INVALID, "Invalid ISO 639-2 language code : %s" % LangName, File)\r
\r
+ if (LangName[0] == 'X' or LangName[0] == 'x') and LangName[1] == '-':\r
+ return LangName\r
if length == 2:\r
if LangName.isalpha():\r
return LangName\r
repr(self.StringValue) + ' ' + \\r
repr(self.UseOtherLangDef)\r
\r
+ def UpdateValue(self, Value = None):\r
+ if Value != None:\r
+ self.StringValue = Value + u'\x00' # Add a NULL at string tail\r
+ self.StringValueByteList = UniToHexList(self.StringValue)\r
+ self.Length = len(self.StringValueByteList)\r
+\r
## UniFileClassObject\r
#\r
# A structure for .uni file definition\r
#\r
class UniFileClassObject(object):\r
- def __init__(self, FileList = [], IsCompatibleMode = False):\r
+ def __init__(self, FileList = [], IsCompatibleMode = False, IncludePathList = []):\r
self.FileList = FileList\r
self.Token = 2\r
self.LanguageDef = [] #[ [u'LanguageIdentifier', u'PrintableName'], ... ]\r
self.OrderedStringList = {} #{ u'LanguageIdentifier' : [StringDefClassObject] }\r
+ self.OrderedStringDict = {} #{ u'LanguageIdentifier' : {StringName:(IndexInList)} }\r
+ self.OrderedStringListByToken = {} #{ u'LanguageIdentifier' : {Token: StringDefClassObject} }\r
self.IsCompatibleMode = IsCompatibleMode\r
-\r
+ self.IncludePathList = IncludePathList\r
if len(self.FileList) > 0:\r
self.LoadUniFiles(FileList)\r
\r
# Get Language definition\r
#\r
def GetLangDef(self, File, Line):\r
- Lang = Line.split()\r
+ Lang = distutils.util.split_quoted((Line.split(u"//")[0]))\r
if len(Lang) != 3:\r
try:\r
- FileIn = codecs.open(File, mode='rb', encoding='utf-16').read()\r
+ FileIn = codecs.open(LongFilePath(File.Path), mode='rb', encoding='utf-16').read()\r
except UnicodeError, X:\r
EdkLogger.error("build", FILE_READ_FAILURE, "File read failure: %s" % str(X), ExtraData=File);\r
except:\r
EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=File);\r
LineNo = GetLineNo(FileIn, Line, False)\r
EdkLogger.error("Unicode File Parser", PARSER_ERROR, "Wrong language definition",\r
- ExtraData="""%s\n\t*Correct format is like '#langdef eng "English"'""" % Line, File = File, Line = LineNo)\r
+ ExtraData="""%s\n\t*Correct format is like '#langdef en-US "English"'""" % Line, File = File, Line = LineNo)\r
else:\r
LangName = GetLanguageCode(Lang[1], self.IsCompatibleMode, self.File)\r
- LangPrintName = Lang[2][1:-1]\r
+ LangPrintName = Lang[2]\r
\r
IsLangInDef = False\r
for Item in self.LanguageDef:\r
self.AddStringToList(u'$LANGUAGE_NAME', LangName, LangName, 0, True, Index=0)\r
self.AddStringToList(u'$PRINTABLE_LANGUAGE_NAME', LangName, LangPrintName, 1, True, Index=1)\r
\r
+ if not IsLangInDef:\r
+ #\r
+ # The found STRING tokens will be added into new language string list\r
+ # so that the unique STRING identifier is reserved for all languages in the package list. \r
+ #\r
+ FirstLangName = self.LanguageDef[0][0]\r
+ if LangName != FirstLangName:\r
+ for Index in range (2, len (self.OrderedStringList[FirstLangName])):\r
+ Item = self.OrderedStringList[FirstLangName][Index]\r
+ if Item.UseOtherLangDef != '':\r
+ OtherLang = Item.UseOtherLangDef\r
+ else:\r
+ OtherLang = FirstLangName\r
+ self.OrderedStringList[LangName].append (StringDefClassObject(Item.StringName, '', Item.Referenced, Item.Token, OtherLang))\r
+ self.OrderedStringDict[LangName][Item.StringName] = len(self.OrderedStringList[LangName]) - 1\r
return True\r
\r
#\r
# Get String name and value\r
#\r
def GetStringObject(self, Item):\r
- Name = ''\r
Language = ''\r
Value = ''\r
\r
Name = Item.split()[1]\r
# Check the string name is the upper character\r
- if not self.IsCompatibleMode and Name != '':\r
+ if Name != '':\r
MatchString = re.match('[A-Z0-9_]+', Name, re.UNICODE)\r
if MatchString == None or MatchString.end(0) != len(Name):\r
EdkLogger.error('Unicode File Parser', FORMAT_INVALID, 'The string token name %s defined in UNI file %s contains the invalid lower case character.' %(Name, self.File))\r
if not os.path.exists(File.Path) or not os.path.isfile(File.Path):\r
EdkLogger.error("Unicode File Parser", FILE_NOT_FOUND, ExtraData=File.Path)\r
\r
- Dir = File.Dir\r
try:\r
- FileIn = codecs.open(File.Path, mode='rb', encoding='utf-16').readlines()\r
+ FileIn = codecs.open(LongFilePath(File.Path), mode='rb', encoding='utf-16').readlines()\r
except UnicodeError, X:\r
EdkLogger.error("build", FILE_READ_FAILURE, "File read failure: %s" % str(X), ExtraData=File.Path);\r
except:\r
#\r
# Use unique identifier\r
#\r
+ FindFlag = -1\r
+ LineCount = 0\r
for Line in FileIn:\r
+ Line = FileIn[LineCount]\r
+ LineCount += 1\r
Line = Line.strip()\r
#\r
# Ignore comment line and empty line\r
#\r
if Line == u'' or Line.startswith(u'//'):\r
continue\r
+ \r
+ #\r
+ # Process comment embeded in string define lines\r
+ #\r
+ FindFlag = Line.find(u'//')\r
+ if FindFlag != -1:\r
+ Line = Line.replace(Line[FindFlag:], u' ')\r
+ if FileIn[LineCount].strip().startswith('#language'):\r
+ Line = Line + FileIn[LineCount]\r
+ FileIn[LineCount-1] = Line\r
+ FileIn[LineCount] = os.linesep\r
+ LineCount -= 1\r
+ for Index in xrange (LineCount + 1, len (FileIn) - 1):\r
+ if (Index == len(FileIn) -1):\r
+ FileIn[Index] = os.linesep\r
+ else:\r
+ FileIn[Index] = FileIn[Index + 1]\r
+ continue\r
+ \r
Line = Line.replace(u'/langdef', u'#langdef')\r
Line = Line.replace(u'/string', u'#string')\r
Line = Line.replace(u'/language', u'#language')\r
Line = Line.replace(u'/include', u'#include')\r
\r
+ Line = Line.replace(u'\\\\', u'\u0006')\r
Line = Line.replace(UNICODE_WIDE_CHAR, WIDE_CHAR)\r
Line = Line.replace(UNICODE_NARROW_CHAR, NARROW_CHAR)\r
Line = Line.replace(UNICODE_NON_BREAKING_CHAR, NON_BREAKING_CHAR)\r
\r
- Line = Line.replace(u'\\\\', u'\u0006')\r
Line = Line.replace(u'\\r\\n', CR + LF)\r
Line = Line.replace(u'\\n', CR + LF)\r
Line = Line.replace(u'\\r', CR)\r
Line = Line.replace(u'''\"''', u'''"''')\r
Line = Line.replace(u'\t', u' ')\r
Line = Line.replace(u'\u0006', u'\\')\r
- \r
+ Line = Line.replace(DOBULE_QUOTED_SPLASH, u'"')\r
+ Line = Line.replace(SIGLE_QUOTED_SPLASH, u"'")\r
+ Line = Line.replace(TAB_BACK_SLASH, u"/")\r
+\r
# if Line.find(u'\\x'):\r
# hex = Line[Line.find(u'\\x') + 2 : Line.find(u'\\x') + 6]\r
# hex = "u'\\u" + hex + "'"\r
\r
IncList = gIncludePattern.findall(Line)\r
if len(IncList) == 1:\r
- Lines.extend(self.PreProcess(PathClass(str(IncList[0]), Dir)))\r
+ for Dir in [File.Dir] + self.IncludePathList:\r
+ IncFile = PathClass(str(IncList[0]), Dir)\r
+ if os.path.isfile(IncFile.Path):\r
+ Lines.extend(self.PreProcess(IncFile))\r
+ break\r
+ else:\r
+ EdkLogger.error("Unicode File Parser", FILE_NOT_FOUND, Message="Cannot find include file", ExtraData=str(IncList[0]))\r
continue\r
\r
Lines.append(Line)\r
# Add a string to list\r
#\r
def AddStringToList(self, Name, Language, Value, Token = None, Referenced = False, UseOtherLangDef = '', Index = -1):\r
+ for LangNameItem in self.LanguageDef:\r
+ if Language == LangNameItem[0]:\r
+ break\r
+ else:\r
+ EdkLogger.error('Unicode File Parser', FORMAT_NOT_SUPPORTED, "The language '%s' for %s is not defined in Unicode file %s." \\r
+ % (Language, Name, self.File))\r
+ \r
if Language not in self.OrderedStringList:\r
self.OrderedStringList[Language] = []\r
-\r
- IsAdded = False\r
- for Item in self.OrderedStringList[Language]:\r
- if Name == Item.StringName:\r
- IsAdded = True\r
- break\r
- if not IsAdded:\r
+ self.OrderedStringDict[Language] = {}\r
+\r
+ IsAdded = True\r
+ if Name in self.OrderedStringDict[Language]:\r
+ IsAdded = False\r
+ if Value != None:\r
+ ItemIndexInList = self.OrderedStringDict[Language][Name]\r
+ Item = self.OrderedStringList[Language][ItemIndexInList]\r
+ Item.UpdateValue(Value)\r
+ Item.UseOtherLangDef = '' \r
+\r
+ if IsAdded:\r
Token = len(self.OrderedStringList[Language])\r
if Index == -1:\r
self.OrderedStringList[Language].append(StringDefClassObject(Name, Value, Referenced, Token, UseOtherLangDef))\r
+ self.OrderedStringDict[Language][Name] = Token\r
+ for LangName in self.LanguageDef:\r
+ #\r
+ # New STRING token will be added into all language string lists.\r
+ # so that the unique STRING identifier is reserved for all languages in the package list. \r
+ #\r
+ if LangName[0] != Language:\r
+ if UseOtherLangDef != '':\r
+ OtherLangDef = UseOtherLangDef\r
+ else:\r
+ OtherLangDef = Language\r
+ self.OrderedStringList[LangName[0]].append(StringDefClassObject(Name, '', Referenced, Token, OtherLangDef))\r
+ self.OrderedStringDict[LangName[0]][Name] = len(self.OrderedStringList[LangName[0]]) - 1\r
else:\r
self.OrderedStringList[Language].insert(Index, StringDefClassObject(Name, Value, Referenced, Token, UseOtherLangDef))\r
+ self.OrderedStringDict[Language][Name] = Index\r
\r
#\r
# Set the string as referenced\r
#\r
def SetStringReferenced(self, Name):\r
- for Lang in self.OrderedStringList:\r
- for Item in self.OrderedStringList[Lang]:\r
- if Name == Item.StringName:\r
- Item.Referenced = True\r
- break\r
+ #\r
+ # String stoken are added in the same order in all language string lists.\r
+ # So, only update the status of string stoken in first language string list.\r
+ #\r
+ Lang = self.LanguageDef[0][0]\r
+ if Name in self.OrderedStringDict[Lang]:\r
+ ItemIndexInList = self.OrderedStringDict[Lang][Name]\r
+ Item = self.OrderedStringList[Lang][ItemIndexInList]\r
+ Item.Referenced = True\r
+\r
#\r
# Search the string in language definition by Name\r
#\r
def FindStringValue(self, Name, Lang):\r
- for Item in self.OrderedStringList[Lang]:\r
- if Item.StringName == Name:\r
- return Item\r
+ if Name in self.OrderedStringDict[Lang]:\r
+ ItemIndexInList = self.OrderedStringDict[Lang][Name]\r
+ return self.OrderedStringList[Lang][ItemIndexInList]\r
\r
return None\r
\r
#\r
def ReToken(self):\r
#\r
- # Search each string to find if it is defined for each language\r
- # Use secondary language value to replace if missing in any one language\r
- #\r
- for IndexI in range(0, len(self.LanguageDef)):\r
- LangKey = self.LanguageDef[IndexI][0]\r
- for Item in self.OrderedStringList[LangKey]:\r
- Name = Item.StringName\r
- Value = Item.StringValue[0:-1]\r
- Referenced = Item.Referenced\r
- Index = self.OrderedStringList[LangKey].index(Item)\r
- for IndexJ in range(0, len(self.LanguageDef)):\r
- LangFind = self.LanguageDef[IndexJ][0]\r
- if self.FindStringValue(Name, LangFind) == None:\r
- EdkLogger.debug(EdkLogger.DEBUG_5, Name)\r
- Token = len(self.OrderedStringList[LangFind])\r
- self.AddStringToList(Name, LangFind, Value, Token, Referenced, LangKey, Index)\r
+ # Retoken all language strings according to the status of string stoken in the first language string.\r
#\r
- # Retoken\r
- #\r
- # First re-token the first language\r
- LangName = self.LanguageDef[0][0]\r
- ReferencedStringList = []\r
- NotReferencedStringList = []\r
- Token = 0\r
+ FirstLangName = self.LanguageDef[0][0]\r
+\r
+ # Convert the OrderedStringList to be OrderedStringListByToken in order to faciliate future search by token\r
+ for LangNameItem in self.LanguageDef:\r
+ self.OrderedStringListByToken[LangNameItem[0]] = {}\r
\r
#\r
- # Order UNI token by their String Name\r
+ # Use small token for all referred string stoken.\r
#\r
- StringNameList = []\r
- for Item in self.OrderedStringList[LangName]:\r
- StringNameList.append (Item.StringName)\r
- StringNameList.sort()\r
-\r
- for Name in StringNameList:\r
- Item = self.FindStringValue (Name, LangName)\r
- if Item.Referenced == True:\r
- Item.Token = Token\r
- ReferencedStringList.append(Item)\r
- Token = Token + 1\r
- else:\r
- NotReferencedStringList.append(Item)\r
- self.OrderedStringList[LangName] = ReferencedStringList\r
- for Index in range(len(NotReferencedStringList)):\r
- NotReferencedStringList[Index].Token = Token + Index\r
- self.OrderedStringList[LangName].append(NotReferencedStringList[Index])\r
+ RefToken = 0\r
+ for Index in range (0, len (self.OrderedStringList[FirstLangName])):\r
+ FirstLangItem = self.OrderedStringList[FirstLangName][Index]\r
+ if FirstLangItem.Referenced == True:\r
+ for LangNameItem in self.LanguageDef:\r
+ LangName = LangNameItem[0]\r
+ OtherLangItem = self.OrderedStringList[LangName][Index]\r
+ OtherLangItem.Referenced = True\r
+ OtherLangItem.Token = RefToken\r
+ self.OrderedStringListByToken[LangName][OtherLangItem.Token] = OtherLangItem\r
+ RefToken = RefToken + 1\r
\r
#\r
- # Adjust the orders of other languages\r
+ # Use big token for all unreferred string stoken.\r
#\r
- for IndexOfLanguage in range(1, len(self.LanguageDef)):\r
- for OrderedString in self.OrderedStringList[LangName]:\r
- for UnOrderedString in self.OrderedStringList[self.LanguageDef[IndexOfLanguage][0]]:\r
- if OrderedString.StringName == UnOrderedString.StringName:\r
- UnOrderedString.Token = OrderedString.Token\r
- break\r
+ UnRefToken = 0\r
+ for Index in range (0, len (self.OrderedStringList[FirstLangName])):\r
+ FirstLangItem = self.OrderedStringList[FirstLangName][Index]\r
+ if FirstLangItem.Referenced == False:\r
+ for LangNameItem in self.LanguageDef:\r
+ LangName = LangNameItem[0]\r
+ OtherLangItem = self.OrderedStringList[LangName][Index]\r
+ OtherLangItem.Token = RefToken + UnRefToken\r
+ self.OrderedStringListByToken[LangName][OtherLangItem.Token] = OtherLangItem\r
+ UnRefToken = UnRefToken + 1\r
\r
#\r
# Show the instance itself\r
if __name__ == '__main__':\r
EdkLogger.Initialize()\r
EdkLogger.SetLevel(EdkLogger.DEBUG_0)\r
- a = UniFileClassObject(['C:\\Edk\\Strings.uni', 'C:\\Edk\\Strings2.uni'])\r
+ a = UniFileClassObject([PathClass("C:\\Edk\\Strings.uni"), PathClass("C:\\Edk\\Strings2.uni")])\r
a.ReToken()\r
a.ShowMe()\r
projects / mirror_edk2.git / blobdiff