projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 756ad8f8 | 1 | # Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r |
| 40d841f6 | 2 | # This program and the accompanying materials\r |
| 30fdf114 LG |
3 | # are licensed and made available under the terms and conditions of the BSD License\r |
| 4 | # which accompanies this distribution. The full text of the license may be found at\r | |
| 5 | # http://opensource.org/licenses/bsd-license.php\r | |
| 6 | #\r | |
| 7 | # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 8 | # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 9 | \r | |
| 10 | #\r | |
| 11 | #This file is used to parse a strings file and create or add to a string database file.\r | |
| 12 | #\r | |
| 13 | \r | |
| 14 | ##\r | |
| 15 | # Import Modules\r | |
| 16 | #\r | |
| 17 | import re\r | |
| 18 | import Common.EdkLogger as EdkLogger\r | |
| 19 | from Common.BuildToolError import *\r | |
| 20 | from UniClassObject import *\r | |
| b303ea72 LG |
21 | from StringIO import StringIO\r |
| 22 | from struct import pack\r | |
| 30fdf114 LG |
23 | \r |
| 24 | ##\r | |
| 25 | # Static definitions\r | |
| 26 | #\r | |
| 27 | EFI_HII_SIBT_END = '0x00'\r | |
| 28 | EFI_HII_SIBT_STRING_SCSU = '0x10'\r | |
| 29 | EFI_HII_SIBT_STRING_SCSU_FONT = '0x11'\r | |
| 30 | EFI_HII_SIBT_STRINGS_SCSU = '0x12'\r | |
| 31 | EFI_HII_SIBT_STRINGS_SCSU_FONT = '0x13'\r | |
| 32 | EFI_HII_SIBT_STRING_UCS2 = '0x14'\r | |
| 33 | EFI_HII_SIBT_STRING_UCS2_FONT = '0x15'\r | |
| 34 | EFI_HII_SIBT_STRINGS_UCS2 = '0x16'\r | |
| 35 | EFI_HII_SIBT_STRINGS_UCS2_FONT = '0x17'\r | |
| 36 | EFI_HII_SIBT_DUPLICATE = '0x20'\r | |
| 37 | EFI_HII_SIBT_SKIP2 = '0x21'\r | |
| 38 | EFI_HII_SIBT_SKIP1 = '0x22'\r | |
| 39 | EFI_HII_SIBT_EXT1 = '0x30'\r | |
| 40 | EFI_HII_SIBT_EXT2 = '0x31'\r | |
| 41 | EFI_HII_SIBT_EXT4 = '0x32'\r | |
| 42 | EFI_HII_SIBT_FONT = '0x40'\r | |
| 43 | \r | |
| 44 | EFI_HII_PACKAGE_STRINGS = '0x04'\r | |
| 45 | EFI_HII_PACKAGE_FORM = '0x02'\r | |
| 46 | \r | |
| 47 | StringPackageType = EFI_HII_PACKAGE_STRINGS\r | |
| 48 | StringPackageForm = EFI_HII_PACKAGE_FORM\r | |
| 49 | StringBlockType = EFI_HII_SIBT_STRING_UCS2\r | |
| 50 | StringSkipType = EFI_HII_SIBT_SKIP2\r | |
| 51 | \r | |
| 52 | HexHeader = '0x'\r | |
| 53 | \r | |
| 54 | COMMENT = '// '\r | |
| 55 | DEFINE_STR = '#define'\r | |
| 56 | COMMENT_DEFINE_STR = COMMENT + DEFINE_STR\r | |
| 57 | NOT_REFERENCED = 'not referenced'\r | |
| 58 | COMMENT_NOT_REFERENCED = ' ' + COMMENT + NOT_REFERENCED\r | |
| 59 | CHAR_ARRAY_DEFIN = 'unsigned char'\r | |
| 60 | COMMON_FILE_NAME = 'Strings'\r | |
| 61 | OFFSET = 'offset'\r | |
| 62 | STRING = 'string'\r | |
| 63 | TO = 'to'\r | |
| 64 | STRING_TOKEN = re.compile('STRING_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)\r | |
| b303ea72 | 65 | COMPATIBLE_STRING_TOKEN = re.compile('STRING_TOKEN *\(([A-Za-z0-9_]+) *\)', re.MULTILINE | re.UNICODE)\r |
| 30fdf114 LG |
66 | \r |
| 67 | EFI_HII_ARRAY_SIZE_LENGTH = 4\r | |
| 68 | EFI_HII_PACKAGE_HEADER_LENGTH = 4\r | |
| 69 | EFI_HII_HDR_SIZE_LENGTH = 4\r | |
| 70 | EFI_HII_STRING_OFFSET_LENGTH = 4\r | |
| 71 | EFI_STRING_ID = 1\r | |
| 72 | EFI_STRING_ID_LENGTH = 2\r | |
| 73 | EFI_HII_LANGUAGE_WINDOW = 0\r | |
| 74 | EFI_HII_LANGUAGE_WINDOW_LENGTH = 2\r | |
| 75 | EFI_HII_LANGUAGE_WINDOW_NUMBER = 16\r | |
| 76 | 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 | |
| 77 | \r | |
| 78 | H_C_FILE_HEADER = ['//', \\r | |
| 79 | '// DO NOT EDIT -- auto-generated file', \\r | |
| 80 | '//', \\r | |
| 81 | '// This file is generated by the StrGather utility', \\r | |
| 82 | '//']\r | |
| 83 | LANGUAGE_NAME_STRING_NAME = '$LANGUAGE_NAME'\r | |
| 84 | PRINTABLE_LANGUAGE_NAME_STRING_NAME = '$PRINTABLE_LANGUAGE_NAME'\r | |
| 85 | \r | |
| 86 | ## Convert a dec number to a hex string\r | |
| 87 | #\r | |
| 88 | # Convert a dec number to a formatted hex string in length digit\r | |
| 89 | # The digit is set to default 8\r | |
| 90 | # The hex string starts with "0x"\r | |
| 91 | # DecToHexStr(1000) is '0x000003E8'\r | |
| 92 | # DecToHexStr(1000, 6) is '0x0003E8'\r | |
| 93 | #\r | |
| 94 | # @param Dec: The number in dec format\r | |
| 95 | # @param Digit: The needed digit of hex string\r | |
| 96 | #\r | |
| 97 | # @retval: The formatted hex string\r | |
| 98 | #\r | |
| 99 | def DecToHexStr(Dec, Digit = 8):\r | |
| 100 | return eval("'0x%0" + str(Digit) + "X' % int(Dec)")\r | |
| 101 | \r | |
| 102 | ## Convert a dec number to a hex list\r | |
| 103 | #\r | |
| 104 | # Convert a dec number to a formatted hex list in size digit\r | |
| 105 | # The digit is set to default 8\r | |
| 106 | # DecToHexList(1000) is ['0xE8', '0x03', '0x00', '0x00']\r | |
| 107 | # DecToHexList(1000, 6) is ['0xE8', '0x03', '0x00']\r | |
| 108 | #\r | |
| 109 | # @param Dec: The number in dec format\r | |
| 110 | # @param Digit: The needed digit of hex list\r | |
| 111 | #\r | |
| 112 | # @retval: A list for formatted hex string\r | |
| 113 | #\r | |
| 114 | def DecToHexList(Dec, Digit = 8):\r | |
| 115 | Hex = eval("'%0" + str(Digit) + "X' % int(Dec)" )\r | |
| 116 | List = []\r | |
| 117 | for Bit in range(Digit - 2, -1, -2):\r | |
| 118 | List.append(HexHeader + Hex[Bit:Bit + 2])\r | |
| 119 | return List\r | |
| 120 | \r | |
| 121 | ## Convert a acsii string to a hex list\r | |
| 122 | #\r | |
| 123 | # Convert a acsii string to a formatted hex list\r | |
| 124 | # AscToHexList('en-US') is ['0x65', '0x6E', '0x2D', '0x55', '0x53']\r | |
| 125 | #\r | |
| 126 | # @param Ascii: The acsii string\r | |
| 127 | #\r | |
| 128 | # @retval: A list for formatted hex string\r | |
| 129 | #\r | |
| 130 | def AscToHexList(Ascii):\r | |
| 131 | List = []\r | |
| 132 | for Item in Ascii:\r | |
| 133 | List.append('0x%2X' % ord(Item))\r | |
| 134 | \r | |
| 135 | return List\r | |
| 136 | \r | |
| 137 | ## Create header of .h file\r | |
| 138 | #\r | |
| 139 | # Create a header of .h file\r | |
| 140 | #\r | |
| 141 | # @param BaseName: The basename of strings\r | |
| 142 | #\r | |
| 143 | # @retval Str: A string for .h file header\r | |
| 144 | #\r | |
| 145 | def CreateHFileHeader(BaseName):\r | |
| 146 | Str = ''\r | |
| 147 | for Item in H_C_FILE_HEADER:\r | |
| 148 | Str = WriteLine(Str, Item)\r | |
| 149 | Str = WriteLine(Str, '#ifndef _' + BaseName.upper() + '_STRINGS_DEFINE_H_')\r | |
| 150 | Str = WriteLine(Str, '#define _' + BaseName.upper() + '_STRINGS_DEFINE_H_')\r | |
| 151 | return Str\r | |
| 152 | \r | |
| 153 | ## Create content of .h file\r | |
| 154 | #\r | |
| 155 | # Create content of .h file\r | |
| 156 | #\r | |
| b303ea72 LG |
157 | # @param BaseName: The basename of strings\r |
| 158 | # @param UniObjectClass A UniObjectClass instance\r | |
| 159 | # @param IsCompatibleMode Compatible mode\r | |
| 160 | # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r | |
| 30fdf114 LG |
161 | #\r |
| 162 | # @retval Str: A string of .h file content\r | |
| 163 | #\r | |
| b303ea72 | 164 | def CreateHFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniGenCFlag):\r |
| 30fdf114 LG |
165 | Str = ''\r |
| 166 | ValueStartPtr = 60\r | |
| 167 | Line = COMMENT_DEFINE_STR + ' ' + LANGUAGE_NAME_STRING_NAME + ' ' * (ValueStartPtr - len(DEFINE_STR + LANGUAGE_NAME_STRING_NAME)) + DecToHexStr(0, 4) + COMMENT_NOT_REFERENCED\r | |
| 168 | Str = WriteLine(Str, Line)\r | |
| 169 | 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 | |
| 170 | Str = WriteLine(Str, Line)\r | |
| 756ad8f8 LG |
171 | \r |
| 172 | #Group the referred STRING token together. \r | |
| 30fdf114 LG |
173 | for Index in range(2, len(UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]])):\r |
| 174 | StringItem = UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]][Index]\r | |
| 175 | Name = StringItem.StringName\r | |
| 176 | Token = StringItem.Token\r | |
| 177 | Referenced = StringItem.Referenced\r | |
| 178 | if Name != None:\r | |
| 179 | Line = ''\r | |
| 180 | if Referenced == True:\r | |
| fd171542 | 181 | if (ValueStartPtr - len(DEFINE_STR + Name)) <= 0:\r |
| 182 | Line = DEFINE_STR + ' ' + Name + ' ' + DecToHexStr(Token, 4)\r | |
| 183 | else:\r | |
| 184 | Line = DEFINE_STR + ' ' + Name + ' ' * (ValueStartPtr - len(DEFINE_STR + Name)) + DecToHexStr(Token, 4)\r | |
| 756ad8f8 LG |
185 | Str = WriteLine(Str, Line)\r |
| 186 | \r | |
| 187 | #Group the unused STRING token together.\r | |
| 188 | for Index in range(2, len(UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]])):\r | |
| 189 | StringItem = UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]][Index]\r | |
| 190 | Name = StringItem.StringName\r | |
| 191 | Token = StringItem.Token\r | |
| 192 | Referenced = StringItem.Referenced\r | |
| 193 | if Name != None:\r | |
| 194 | Line = ''\r | |
| 195 | if Referenced == False:\r | |
| fd171542 | 196 | if (ValueStartPtr - len(DEFINE_STR + Name)) <= 0:\r |
| 197 | Line = COMMENT_DEFINE_STR + ' ' + Name + ' ' + DecToHexStr(Token, 4) + COMMENT_NOT_REFERENCED\r | |
| 198 | else:\r | |
| 199 | Line = COMMENT_DEFINE_STR + ' ' + Name + ' ' * (ValueStartPtr - len(DEFINE_STR + Name)) + DecToHexStr(Token, 4) + COMMENT_NOT_REFERENCED\r | |
| 756ad8f8 | 200 | Str = WriteLine(Str, Line)\r |
| 30fdf114 | 201 | \r |
| b303ea72 LG |
202 | Str = WriteLine(Str, '')\r |
| 203 | if IsCompatibleMode or UniGenCFlag:\r | |
| 204 | Str = WriteLine(Str, 'extern unsigned char ' + BaseName + 'Strings[];')\r | |
| 30fdf114 LG |
205 | return Str\r |
| 206 | \r | |
| 207 | ## Create a complete .h file\r | |
| 208 | #\r | |
| 209 | # Create a complet .h file with file header and file content\r | |
| 210 | #\r | |
| b303ea72 LG |
211 | # @param BaseName: The basename of strings\r |
| 212 | # @param UniObjectClass A UniObjectClass instance\r | |
| 213 | # @param IsCompatibleMode Compatible mode\r | |
| 214 | # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r | |
| 30fdf114 LG |
215 | #\r |
| 216 | # @retval Str: A string of complete .h file\r | |
| 217 | #\r | |
| b303ea72 LG |
218 | def CreateHFile(BaseName, UniObjectClass, IsCompatibleMode, UniGenCFlag):\r |
| 219 | HFile = WriteLine('', CreateHFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniGenCFlag))\r | |
| 30fdf114 LG |
220 | \r |
| 221 | return HFile\r | |
| 222 | \r | |
| 223 | ## Create header of .c file\r | |
| 224 | #\r | |
| 225 | # Create a header of .c file\r | |
| 226 | #\r | |
| 227 | # @retval Str: A string for .c file header\r | |
| 228 | #\r | |
| 229 | def CreateCFileHeader():\r | |
| 230 | Str = ''\r | |
| 231 | for Item in H_C_FILE_HEADER:\r | |
| 232 | Str = WriteLine(Str, Item)\r | |
| 233 | \r | |
| 234 | return Str\r | |
| 235 | \r | |
| b303ea72 LG |
236 | ## Create a buffer to store all items in an array\r |
| 237 | #\r | |
| 238 | # @param BinBuffer Buffer to contain Binary data.\r | |
| 239 | # @param Array: The array need to be formatted\r | |
| 240 | #\r | |
| 241 | def CreateBinBuffer(BinBuffer, Array):\r | |
| 242 | for Item in Array:\r | |
| 243 | BinBuffer.write(pack("B", int(Item,16)))\r | |
| 244 | \r | |
| 30fdf114 LG |
245 | ## Create a formatted string all items in an array\r |
| 246 | #\r | |
| 247 | # Use ',' to join each item in an array, and break an new line when reaching the width (default is 16)\r | |
| 248 | #\r | |
| 249 | # @param Array: The array need to be formatted\r | |
| 250 | # @param Width: The line length, the default value is set to 16\r | |
| 251 | #\r | |
| 252 | # @retval ArrayItem: A string for all formatted array items\r | |
| 253 | #\r | |
| 254 | def CreateArrayItem(Array, Width = 16):\r | |
| 255 | MaxLength = Width\r | |
| 256 | Index = 0\r | |
| 257 | Line = ' '\r | |
| 258 | ArrayItem = ''\r | |
| 259 | \r | |
| 260 | for Item in Array:\r | |
| 261 | if Index < MaxLength:\r | |
| 262 | Line = Line + Item + ', '\r | |
| 263 | Index = Index + 1\r | |
| 264 | else:\r | |
| 265 | ArrayItem = WriteLine(ArrayItem, Line)\r | |
| 266 | Line = ' ' + Item + ', '\r | |
| 267 | Index = 1\r | |
| 268 | ArrayItem = Write(ArrayItem, Line.rstrip())\r | |
| 269 | \r | |
| 270 | return ArrayItem\r | |
| 271 | \r | |
| 272 | ## CreateCFileStringValue\r | |
| 273 | #\r | |
| 274 | # Create a line with string value\r | |
| 275 | #\r | |
| 276 | # @param Value: Value of the string\r | |
| 277 | #\r | |
| 278 | # @retval Str: A formatted string with string value\r | |
| 279 | #\r | |
| 280 | \r | |
| 281 | def CreateCFileStringValue(Value):\r | |
| 282 | Value = [StringBlockType] + Value\r | |
| 283 | Str = WriteLine('', CreateArrayItem(Value))\r | |
| 284 | \r | |
| 285 | return Str\r | |
| 286 | \r | |
| 6780eef1 LG |
287 | ## GetFilteredLanguage\r |
| 288 | #\r | |
| 289 | # apply get best language rules to the UNI language code list\r | |
| 290 | #\r | |
| 291 | # @param UniLanguageList: language code definition list in *.UNI file\r | |
| 292 | # @param LanguageFilterList: language code filter list of RFC4646 format in DSC file\r | |
| 293 | #\r | |
| 294 | # @retval UniLanguageListFiltered: the filtered language code\r | |
| 295 | #\r | |
| 296 | def GetFilteredLanguage(UniLanguageList, LanguageFilterList):\r | |
| 297 | UniLanguageListFiltered = []\r | |
| 298 | # if filter list is empty, then consider there is no filter\r | |
| 299 | if LanguageFilterList == []:\r | |
| 300 | UniLanguageListFiltered = UniLanguageList\r | |
| 301 | return UniLanguageListFiltered\r | |
| 302 | for Language in LanguageFilterList:\r | |
| 303 | # first check for exact match\r | |
| 304 | if Language in UniLanguageList:\r | |
| 305 | if Language not in UniLanguageListFiltered:\r | |
| 306 | UniLanguageListFiltered += [Language]\r | |
| 307 | # find the first one with the same/equivalent primary tag\r | |
| 308 | else:\r | |
| 309 | if Language.find('-') != -1:\r | |
| 310 | PrimaryTag = Language[0:Language.find('-')].lower()\r | |
| 311 | else:\r | |
| 312 | PrimaryTag = Language\r | |
| 313 | \r | |
| 314 | if len(PrimaryTag) == 3:\r | |
| 315 | PrimaryTag = LangConvTable.get(PrimaryTag)\r | |
| 316 | \r | |
| 317 | for UniLanguage in UniLanguageList:\r | |
| 318 | if UniLanguage.find('-') != -1:\r | |
| 319 | UniLanguagePrimaryTag = UniLanguage[0:UniLanguage.find('-')].lower()\r | |
| 320 | else:\r | |
| 321 | UniLanguagePrimaryTag = UniLanguage\r | |
| 322 | \r | |
| 323 | if len(UniLanguagePrimaryTag) == 3:\r | |
| 324 | UniLanguagePrimaryTag = LangConvTable.get(UniLanguagePrimaryTag)\r | |
| 325 | \r | |
| 326 | if PrimaryTag == UniLanguagePrimaryTag:\r | |
| 327 | if UniLanguage not in UniLanguageListFiltered:\r | |
| 328 | UniLanguageListFiltered += [UniLanguage] \r | |
| 329 | break\r | |
| 330 | else:\r | |
| 331 | # Here is rule 3 for "get best language"\r | |
| 332 | # If tag is not listed in the Unicode file, the default ("en") tag should be used for that language\r | |
| 333 | # for better processing, find the one that best suit for it.\r | |
| 334 | DefaultTag = 'en'\r | |
| 335 | if DefaultTag not in UniLanguageListFiltered:\r | |
| 336 | # check whether language code with primary code equivalent with DefaultTag already in the list, if so, use that\r | |
| 337 | for UniLanguage in UniLanguageList:\r | |
| 338 | if UniLanguage.startswith('en-') or UniLanguage.startswith('eng-'):\r | |
| 339 | if UniLanguage not in UniLanguageListFiltered:\r | |
| 340 | UniLanguageListFiltered += [UniLanguage]\r | |
| 341 | break\r | |
| 342 | else:\r | |
| 343 | UniLanguageListFiltered += [DefaultTag]\r | |
| 344 | return UniLanguageListFiltered\r | |
| 345 | \r | |
| 30fdf114 LG |
346 | \r |
| 347 | ## Create content of .c file\r | |
| 348 | #\r | |
| 349 | # Create content of .c file\r | |
| 350 | #\r | |
| b303ea72 LG |
351 | # @param BaseName: The basename of strings\r |
| 352 | # @param UniObjectClass A UniObjectClass instance\r | |
| 353 | # @param IsCompatibleMode Compatible mode\r | |
| 354 | # @param UniBinBuffer UniBinBuffer to contain UniBinary data.\r | |
| 6780eef1 | 355 | # @param FilterInfo Platform language filter information \r |
| 30fdf114 LG |
356 | #\r |
| 357 | # @retval Str: A string of .c file content\r | |
| 358 | #\r | |
| 6780eef1 | 359 | def CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniBinBuffer, FilterInfo):\r |
| 30fdf114 LG |
360 | #\r |
| 361 | # Init array length\r | |
| 362 | #\r | |
| 363 | TotalLength = EFI_HII_ARRAY_SIZE_LENGTH\r | |
| 364 | Str = ''\r | |
| 365 | Offset = 0\r | |
| 366 | \r | |
| 6780eef1 LG |
367 | EDK2Module = FilterInfo[0]\r |
| 368 | if EDK2Module:\r | |
| 369 | LanguageFilterList = FilterInfo[1]\r | |
| 370 | else:\r | |
| 371 | # EDK module is using ISO639-2 format filter, convert to the RFC4646 format\r | |
| 372 | LanguageFilterList = [LangConvTable.get(F.lower()) for F in FilterInfo[1]]\r | |
| 373 | \r | |
| 374 | UniLanguageList = []\r | |
| 375 | for IndexI in range(len(UniObjectClass.LanguageDef)):\r | |
| 376 | UniLanguageList += [UniObjectClass.LanguageDef[IndexI][0]] \r | |
| 377 | \r | |
| 378 | UniLanguageListFiltered = GetFilteredLanguage(UniLanguageList, LanguageFilterList)\r | |
| 379 | \r | |
| 380 | \r | |
| 30fdf114 LG |
381 | #\r |
| 382 | # Create lines for each language's strings\r | |
| 383 | #\r | |
| 384 | for IndexI in range(len(UniObjectClass.LanguageDef)):\r | |
| 385 | Language = UniObjectClass.LanguageDef[IndexI][0]\r | |
| 386 | LangPrintName = UniObjectClass.LanguageDef[IndexI][1]\r | |
| 6780eef1 LG |
387 | if Language not in UniLanguageListFiltered:\r |
| 388 | continue\r | |
| 389 | \r | |
| b303ea72 | 390 | StringBuffer = StringIO()\r |
| 30fdf114 LG |
391 | StrStringValue = ''\r |
| 392 | ArrayLength = 0\r | |
| b303ea72 | 393 | NumberOfUseOtherLangDef = 0\r |
| 30fdf114 LG |
394 | Index = 0\r |
| 395 | for IndexJ in range(1, len(UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[IndexI][0]])):\r | |
| 396 | Item = UniObjectClass.FindByToken(IndexJ, Language)\r | |
| 397 | Name = Item.StringName\r | |
| 398 | Value = Item.StringValueByteList\r | |
| 399 | Referenced = Item.Referenced\r | |
| 400 | Token = Item.Token\r | |
| 401 | Length = Item.Length\r | |
| 402 | UseOtherLangDef = Item.UseOtherLangDef\r | |
| 403 | \r | |
| 404 | if UseOtherLangDef != '' and Referenced:\r | |
| b303ea72 | 405 | NumberOfUseOtherLangDef = NumberOfUseOtherLangDef + 1\r |
| 30fdf114 LG |
406 | Index = Index + 1\r |
| 407 | else:\r | |
| b303ea72 LG |
408 | if NumberOfUseOtherLangDef > 0:\r |
| 409 | StrStringValue = WriteLine(StrStringValue, CreateArrayItem([StringSkipType] + DecToHexList(NumberOfUseOtherLangDef, 4)))\r | |
| 410 | CreateBinBuffer (StringBuffer, ([StringSkipType] + DecToHexList(NumberOfUseOtherLangDef, 4)))\r | |
| 411 | NumberOfUseOtherLangDef = 0\r | |
| 30fdf114 LG |
412 | ArrayLength = ArrayLength + 3\r |
| 413 | if Referenced and Item.Token > 0:\r | |
| 414 | Index = Index + 1\r | |
| 415 | StrStringValue = WriteLine(StrStringValue, "// %s: %s:%s" % (DecToHexStr(Index, 4), Name, DecToHexStr(Token, 4)))\r | |
| 416 | StrStringValue = Write(StrStringValue, CreateCFileStringValue(Value))\r | |
| b303ea72 | 417 | CreateBinBuffer (StringBuffer, [StringBlockType] + Value)\r |
| 30fdf114 LG |
418 | ArrayLength = ArrayLength + Item.Length + 1 # 1 is for the length of string type\r |
| 419 | \r | |
| 420 | #\r | |
| 421 | # EFI_HII_PACKAGE_HEADER\r | |
| 422 | #\r | |
| 423 | Offset = EFI_HII_STRING_PACKAGE_HDR_LENGTH + len(Language) + 1\r | |
| 424 | ArrayLength = Offset + ArrayLength + 1\r | |
| 425 | \r | |
| 426 | #\r | |
| 427 | # Create PACKAGE HEADER\r | |
| 428 | #\r | |
| 429 | Str = WriteLine(Str, '// PACKAGE HEADER\n')\r | |
| 430 | TotalLength = TotalLength + ArrayLength\r | |
| 431 | \r | |
| 432 | List = DecToHexList(ArrayLength, 6) + \\r | |
| 433 | [StringPackageType] + \\r | |
| 434 | DecToHexList(Offset) + \\r | |
| 435 | DecToHexList(Offset) + \\r | |
| 436 | DecToHexList(EFI_HII_LANGUAGE_WINDOW, EFI_HII_LANGUAGE_WINDOW_LENGTH * 2) * EFI_HII_LANGUAGE_WINDOW_NUMBER + \\r | |
| 437 | DecToHexList(EFI_STRING_ID, 4) + \\r | |
| 438 | AscToHexList(Language) + \\r | |
| 439 | DecToHexList(0, 2)\r | |
| 440 | Str = WriteLine(Str, CreateArrayItem(List, 16) + '\n')\r | |
| 441 | \r | |
| 442 | #\r | |
| 443 | # Create PACKAGE DATA\r | |
| 444 | #\r | |
| 445 | Str = WriteLine(Str, '// PACKAGE DATA\n')\r | |
| 446 | Str = Write(Str, StrStringValue)\r | |
| 447 | \r | |
| 448 | #\r | |
| 449 | # Add an EFI_HII_SIBT_END at last\r | |
| 450 | #\r | |
| 451 | Str = WriteLine(Str, ' ' + EFI_HII_SIBT_END + ",")\r | |
| b303ea72 LG |
452 | \r |
| 453 | #\r | |
| 454 | # Create binary UNI string\r | |
| 455 | #\r | |
| 456 | if UniBinBuffer:\r | |
| 457 | CreateBinBuffer (UniBinBuffer, List)\r | |
| 458 | UniBinBuffer.write (StringBuffer.getvalue())\r | |
| 459 | UniBinBuffer.write (pack("B", int(EFI_HII_SIBT_END,16)))\r | |
| 460 | StringBuffer.close()\r | |
| 30fdf114 LG |
461 | \r |
| 462 | #\r | |
| 463 | # Create line for string variable name\r | |
| 464 | # "unsigned char $(BaseName)Strings[] = {"\r | |
| 465 | #\r | |
| 466 | AllStr = WriteLine('', CHAR_ARRAY_DEFIN + ' ' + BaseName + COMMON_FILE_NAME + '[] = {\n' )\r | |
| 467 | \r | |
| 30fdf114 | 468 | if IsCompatibleMode:\r |
| b303ea72 LG |
469 | #\r |
| 470 | # Create FRAMEWORK_EFI_HII_PACK_HEADER in compatible mode\r | |
| 471 | #\r | |
| 30fdf114 LG |
472 | AllStr = WriteLine(AllStr, '// FRAMEWORK PACKAGE HEADER Length')\r |
| 473 | AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength + 2)) + '\n')\r | |
| 474 | AllStr = WriteLine(AllStr, '// FRAMEWORK PACKAGE HEADER Type')\r | |
| 475 | AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(2, 4)) + '\n')\r | |
| b303ea72 LG |
476 | else:\r |
| 477 | #\r | |
| 478 | # Create whole array length in UEFI mode\r | |
| 479 | #\r | |
| 30fdf114 LG |
480 | AllStr = WriteLine(AllStr, '// STRGATHER_OUTPUT_HEADER')\r |
| 481 | AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength)) + '\n')\r | |
| 482 | \r | |
| 483 | #\r | |
| 484 | # Join package data\r | |
| 485 | #\r | |
| 486 | AllStr = Write(AllStr, Str)\r | |
| 487 | \r | |
| 488 | return AllStr\r | |
| 489 | \r | |
| 490 | ## Create end of .c file\r | |
| 491 | #\r | |
| 492 | # Create end of .c file\r | |
| 493 | #\r | |
| 494 | # @retval Str: A string of .h file end\r | |
| 495 | #\r | |
| 496 | def CreateCFileEnd():\r | |
| 497 | Str = Write('', '};')\r | |
| 498 | return Str\r | |
| 499 | \r | |
| 500 | ## Create a .c file\r | |
| 501 | #\r | |
| 502 | # Create a complete .c file\r | |
| 503 | #\r | |
| b303ea72 LG |
504 | # @param BaseName: The basename of strings\r |
| 505 | # @param UniObjectClass A UniObjectClass instance\r | |
| 506 | # @param IsCompatibleMode Compatible Mode\r | |
| 6780eef1 | 507 | # @param FilterInfo Platform language filter information \r |
| 30fdf114 | 508 | #\r |
| 6780eef1 | 509 | # @retval CFile: A string of complete .c file\r |
| 30fdf114 | 510 | #\r |
| 6780eef1 | 511 | def CreateCFile(BaseName, UniObjectClass, IsCompatibleMode, FilterInfo):\r |
| 30fdf114 LG |
512 | CFile = ''\r |
| 513 | #CFile = WriteLine(CFile, CreateCFileHeader())\r | |
| 6780eef1 | 514 | CFile = WriteLine(CFile, CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, None, FilterInfo))\r |
| 30fdf114 LG |
515 | CFile = WriteLine(CFile, CreateCFileEnd())\r |
| 516 | return CFile\r | |
| 517 | \r | |
| 518 | ## GetFileList\r | |
| 519 | #\r | |
| 520 | # Get a list for all files\r | |
| 521 | #\r | |
| 522 | # @param IncludeList: A list of all path to be searched\r | |
| 523 | # @param SkipList: A list of all types of file could be skipped\r | |
| 524 | #\r | |
| 525 | # @retval FileList: A list of all files found\r | |
| 526 | #\r | |
| 527 | def GetFileList(SourceFileList, IncludeList, SkipList):\r | |
| 528 | if IncludeList == None:\r | |
| 529 | EdkLogger.error("UnicodeStringGather", AUTOGEN_ERROR, "Include path for unicode file is not defined")\r | |
| 530 | \r | |
| 531 | FileList = []\r | |
| 532 | if SkipList == None:\r | |
| 533 | SkipList = []\r | |
| 534 | \r | |
| 535 | for File in SourceFileList:\r | |
| 536 | for Dir in IncludeList:\r | |
| 537 | if not os.path.exists(Dir):\r | |
| 538 | continue\r | |
| 539 | File = os.path.join(Dir, File.Path)\r | |
| 540 | #\r | |
| 541 | # Ignore Dir\r | |
| 542 | #\r | |
| 543 | if os.path.isfile(File) != True:\r | |
| 544 | continue\r | |
| 545 | #\r | |
| 546 | # Ignore file listed in skip list\r | |
| 547 | #\r | |
| 548 | IsSkip = False\r | |
| 549 | for Skip in SkipList:\r | |
| 550 | if os.path.splitext(File)[1].upper() == Skip.upper():\r | |
| 551 | EdkLogger.verbose("Skipped %s for string token uses search" % File)\r | |
| 552 | IsSkip = True\r | |
| 553 | break\r | |
| 554 | \r | |
| 555 | if not IsSkip:\r | |
| 556 | FileList.append(File)\r | |
| 557 | \r | |
| 558 | break\r | |
| 559 | \r | |
| 560 | return FileList\r | |
| 561 | \r | |
| 562 | ## SearchString\r | |
| 563 | #\r | |
| 564 | # Search whether all string defined in UniObjectClass are referenced\r | |
| 565 | # All string used should be set to Referenced\r | |
| 566 | #\r | |
| 567 | # @param UniObjectClass: Input UniObjectClass\r | |
| 568 | # @param FileList: Search path list\r | |
| b303ea72 | 569 | # @param IsCompatibleMode Compatible Mode\r |
| 30fdf114 LG |
570 | #\r |
| 571 | # @retval UniObjectClass: UniObjectClass after searched\r | |
| 572 | #\r | |
| b303ea72 | 573 | def SearchString(UniObjectClass, FileList, IsCompatibleMode):\r |
| 30fdf114 LG |
574 | if FileList == []:\r |
| 575 | return UniObjectClass\r | |
| 576 | \r | |
| 577 | for File in FileList:\r | |
| 578 | if os.path.isfile(File):\r | |
| 579 | Lines = open(File, 'r')\r | |
| 580 | for Line in Lines:\r | |
| b303ea72 LG |
581 | if not IsCompatibleMode:\r |
| 582 | StringTokenList = STRING_TOKEN.findall(Line)\r | |
| 583 | else:\r | |
| 584 | StringTokenList = COMPATIBLE_STRING_TOKEN.findall(Line)\r | |
| 30fdf114 LG |
585 | for StrName in StringTokenList:\r |
| 586 | EdkLogger.debug(EdkLogger.DEBUG_5, "Found string identifier: " + StrName)\r | |
| 587 | UniObjectClass.SetStringReferenced(StrName)\r | |
| 588 | \r | |
| 589 | UniObjectClass.ReToken()\r | |
| 590 | \r | |
| 591 | return UniObjectClass\r | |
| 592 | \r | |
| 593 | ## GetStringFiles\r | |
| 594 | #\r | |
| 595 | # This function is used for UEFI2.1 spec\r | |
| 596 | #\r | |
| 597 | #\r | |
| 6780eef1 | 598 | def GetStringFiles(UniFilList, SourceFileList, IncludeList, IncludePathList, SkipList, BaseName, IsCompatibleMode = False, ShellMode = False, UniGenCFlag = True, UniGenBinBuffer = None, FilterInfo = [True, []]):\r |
| 30fdf114 LG |
599 | Status = True\r |
| 600 | ErrorMessage = ''\r | |
| 601 | \r | |
| 602 | if len(UniFilList) > 0:\r | |
| 603 | if ShellMode:\r | |
| 604 | #\r | |
| 605 | # support ISO 639-2 codes in .UNI files of EDK Shell\r | |
| 606 | #\r | |
| 756ad8f8 | 607 | Uni = UniFileClassObject(sorted (UniFilList), True, IncludePathList)\r |
| 30fdf114 | 608 | else:\r |
| 756ad8f8 | 609 | Uni = UniFileClassObject(sorted (UniFilList), IsCompatibleMode, IncludePathList)\r |
| 30fdf114 LG |
610 | else:\r |
| 611 | EdkLogger.error("UnicodeStringGather", AUTOGEN_ERROR, 'No unicode files given')\r | |
| 612 | \r | |
| 613 | FileList = GetFileList(SourceFileList, IncludeList, SkipList)\r | |
| 614 | \r | |
| 756ad8f8 | 615 | Uni = SearchString(Uni, sorted (FileList), IsCompatibleMode)\r |
| 30fdf114 | 616 | \r |
| b303ea72 LG |
617 | HFile = CreateHFile(BaseName, Uni, IsCompatibleMode, UniGenCFlag)\r |
| 618 | CFile = None\r | |
| 619 | if IsCompatibleMode or UniGenCFlag:\r | |
| 6780eef1 | 620 | CFile = CreateCFile(BaseName, Uni, IsCompatibleMode, FilterInfo)\r |
| b303ea72 | 621 | if UniGenBinBuffer:\r |
| 6780eef1 | 622 | CreateCFileContent(BaseName, Uni, IsCompatibleMode, UniGenBinBuffer, FilterInfo)\r |
| 30fdf114 LG |
623 | \r |
| 624 | return HFile, CFile\r | |
| 625 | \r | |
| 626 | #\r | |
| 627 | # Write an item\r | |
| 628 | #\r | |
| 629 | def Write(Target, Item):\r | |
| 630 | return Target + Item\r | |
| 631 | \r | |
| 632 | #\r | |
| 633 | # Write an item with a break line\r | |
| 634 | #\r | |
| 635 | def WriteLine(Target, Item):\r | |
| 636 | return Target + Item + '\n'\r | |
| 637 | \r | |
| 638 | # This acts like the main() function for the script, unless it is 'import'ed into another\r | |
| 639 | # script.\r | |
| 640 | if __name__ == '__main__':\r | |
| 641 | EdkLogger.info('start')\r | |
| 642 | \r | |
| 643 | UniFileList = [\r | |
| 644 | r'C:\\Edk\\Strings2.uni',\r | |
| 645 | r'C:\\Edk\\Strings.uni'\r | |
| 646 | ]\r | |
| 647 | \r | |
| 648 | SrcFileList = []\r | |
| 649 | for Root, Dirs, Files in os.walk('C:\\Edk'):\r | |
| 650 | for File in Files:\r | |
| 651 | SrcFileList.append(File)\r | |
| 652 | \r | |
| 653 | IncludeList = [\r | |
| 654 | r'C:\\Edk'\r | |
| 655 | ]\r | |
| 656 | \r | |
| 657 | SkipList = ['.inf', '.uni']\r | |
| 658 | BaseName = 'DriverSample'\r | |
| 659 | (h, c) = GetStringFiles(UniFileList, SrcFileList, IncludeList, SkipList, BaseName, True)\r | |
| 660 | hfile = open('unistring.h', 'w')\r | |
| 661 | cfile = open('unistring.c', 'w')\r | |
| 662 | hfile.write(h)\r | |
| 663 | cfile.write(c)\r | |
| 664 | \r | |
| 665 | EdkLogger.info('end')\r |