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