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