]> 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: StrGather has redundant declaration
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / StrGather.py
CommitLineData
97fa0ee9
YL		 1## @file\r
2# This file is used to parse a strings file and create or add to a string database \r
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
20from UniClassObject import *\r
b303ea72 21from StringIO import StringIO\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
62OFFSET = 'offset'\r
63STRING = 'string'\r
64TO = 'to'\r
65STRING_TOKEN = re.compile('STRING_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)\r
66\r
67EFI_HII_ARRAY_SIZE_LENGTH = 4\r
68EFI_HII_PACKAGE_HEADER_LENGTH = 4\r
69EFI_HII_HDR_SIZE_LENGTH = 4\r
70EFI_HII_STRING_OFFSET_LENGTH = 4\r
71EFI_STRING_ID = 1\r
72EFI_STRING_ID_LENGTH = 2\r
73EFI_HII_LANGUAGE_WINDOW = 0\r
74EFI_HII_LANGUAGE_WINDOW_LENGTH = 2\r
75EFI_HII_LANGUAGE_WINDOW_NUMBER = 16\r
76EFI_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
78H_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
83LANGUAGE_NAME_STRING_NAME = '$LANGUAGE_NAME'\r
84PRINTABLE_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
99def 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
114def DecToHexList(Dec, Digit = 8):\r
47fea6af 115 Hex = eval("'%0" + str(Digit) + "X' % int(Dec)")\r
30fdf114
LG		 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
130def AscToHexList(Ascii):\r
131 List = []\r
132 for Item in Ascii:\r
333ba578 133 List.append('0x%02X' % ord(Item))\r
30fdf114
LG		 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
145def 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 164def 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
79b74a03 171 UnusedStr = ''\r
756ad8f8 172\r
79b74a03 173 #Group the referred/Unused STRING token together. \r
30fdf114
LG		 174 for Index in range(2, len(UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]])):\r
175 StringItem = UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[0][0]][Index]\r
176 Name = StringItem.StringName\r
177 Token = StringItem.Token\r
178 Referenced = StringItem.Referenced\r
179 if Name != None:\r
180 Line = ''\r
181 if Referenced == True:\r
fd171542 182 if (ValueStartPtr - len(DEFINE_STR + Name)) <= 0:\r
183 Line = DEFINE_STR + ' ' + Name + ' ' + DecToHexStr(Token, 4)\r
184 else:\r
185 Line = DEFINE_STR + ' ' + Name + ' ' * (ValueStartPtr - len(DEFINE_STR + Name)) + DecToHexStr(Token, 4)\r
756ad8f8 186 Str = WriteLine(Str, Line)\r
79b74a03 187 else:\r
fd171542 188 if (ValueStartPtr - len(DEFINE_STR + Name)) <= 0:\r
189 Line = COMMENT_DEFINE_STR + ' ' + Name + ' ' + DecToHexStr(Token, 4) + COMMENT_NOT_REFERENCED\r
190 else:\r
191 Line = COMMENT_DEFINE_STR + ' ' + Name + ' ' * (ValueStartPtr - len(DEFINE_STR + Name)) + DecToHexStr(Token, 4) + COMMENT_NOT_REFERENCED\r
79b74a03
LG		 192 UnusedStr = WriteLine(UnusedStr, Line)\r
193\r
47fea6af 194 Str = ''.join([Str, UnusedStr])\r
30fdf114 195\r
b303ea72
LG		 196 Str = WriteLine(Str, '')\r
197 if IsCompatibleMode or UniGenCFlag:\r
198 Str = WriteLine(Str, 'extern unsigned char ' + BaseName + 'Strings[];')\r
30fdf114
LG		 199 return Str\r
200\r
201## Create a complete .h file\r
202#\r
203# Create a complet .h file with file header and file content\r
204#\r
b303ea72
LG		 205# @param BaseName: The basename of strings\r
206# @param UniObjectClass A UniObjectClass instance\r
207# @param IsCompatibleMode Compatible mode\r
208# @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r
30fdf114
LG		 209#\r
210# @retval Str: A string of complete .h file\r
211#\r
b303ea72
LG		 212def CreateHFile(BaseName, UniObjectClass, IsCompatibleMode, UniGenCFlag):\r
213 HFile = WriteLine('', CreateHFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniGenCFlag))\r
30fdf114
LG		 214\r
215 return HFile\r
216\r
217## Create header of .c file\r
218#\r
219# Create a header of .c file\r
220#\r
221# @retval Str: A string for .c file header\r
222#\r
223def CreateCFileHeader():\r
224 Str = ''\r
225 for Item in H_C_FILE_HEADER:\r
226 Str = WriteLine(Str, Item)\r
227\r
228 return Str\r
229\r
b303ea72
LG		 230## Create a buffer to store all items in an array\r
231#\r
232# @param BinBuffer Buffer to contain Binary data.\r
233# @param Array: The array need to be formatted\r
234#\r
235def CreateBinBuffer(BinBuffer, Array):\r
236 for Item in Array:\r
47fea6af 237 BinBuffer.write(pack("B", int(Item, 16)))\r
b303ea72 238\r
30fdf114
LG		 239## Create a formatted string all items in an array\r
240#\r
241# Use ',' to join each item in an array, and break an new line when reaching the width (default is 16)\r
242#\r
243# @param Array: The array need to be formatted\r
244# @param Width: The line length, the default value is set to 16\r
245#\r
246# @retval ArrayItem: A string for all formatted array items\r
247#\r
248def CreateArrayItem(Array, Width = 16):\r
249 MaxLength = Width\r
250 Index = 0\r
251 Line = ' '\r
252 ArrayItem = ''\r
253\r
254 for Item in Array:\r
255 if Index < MaxLength:\r
256 Line = Line + Item + ', '\r
257 Index = Index + 1\r
258 else:\r
259 ArrayItem = WriteLine(ArrayItem, Line)\r
47fea6af 260 Line = ' ' + Item + ', '\r
30fdf114
LG		 261 Index = 1\r
262 ArrayItem = Write(ArrayItem, Line.rstrip())\r
263\r
264 return ArrayItem\r
265\r
266## CreateCFileStringValue\r
267#\r
268# Create a line with string value\r
269#\r
270# @param Value: Value of the string\r
271#\r
272# @retval Str: A formatted string with string value\r
273#\r
274\r
275def CreateCFileStringValue(Value):\r
276 Value = [StringBlockType] + Value\r
277 Str = WriteLine('', CreateArrayItem(Value))\r
278\r
279 return Str\r
280\r
6780eef1
LG		 281## GetFilteredLanguage\r
282#\r
283# apply get best language rules to the UNI language code list\r
284#\r
285# @param UniLanguageList: language code definition list in *.UNI file\r
286# @param LanguageFilterList: language code filter list of RFC4646 format in DSC file\r
287#\r
288# @retval UniLanguageListFiltered: the filtered language code\r
289#\r
290def GetFilteredLanguage(UniLanguageList, LanguageFilterList):\r
291 UniLanguageListFiltered = []\r
292 # if filter list is empty, then consider there is no filter\r
293 if LanguageFilterList == []:\r
294 UniLanguageListFiltered = UniLanguageList\r
295 return UniLanguageListFiltered\r
296 for Language in LanguageFilterList:\r
297 # first check for exact match\r
298 if Language in UniLanguageList:\r
299 if Language not in UniLanguageListFiltered:\r
300 UniLanguageListFiltered += [Language]\r
301 # find the first one with the same/equivalent primary tag\r
302 else:\r
303 if Language.find('-') != -1:\r
304 PrimaryTag = Language[0:Language.find('-')].lower()\r
305 else:\r
306 PrimaryTag = Language\r
307 \r
308 if len(PrimaryTag) == 3:\r
309 PrimaryTag = LangConvTable.get(PrimaryTag)\r
310 \r
311 for UniLanguage in UniLanguageList:\r
312 if UniLanguage.find('-') != -1:\r
313 UniLanguagePrimaryTag = UniLanguage[0:UniLanguage.find('-')].lower()\r
314 else:\r
315 UniLanguagePrimaryTag = UniLanguage\r
316 \r
317 if len(UniLanguagePrimaryTag) == 3:\r
318 UniLanguagePrimaryTag = LangConvTable.get(UniLanguagePrimaryTag)\r
319\r
320 if PrimaryTag == UniLanguagePrimaryTag:\r
321 if UniLanguage not in UniLanguageListFiltered:\r
47fea6af 322 UniLanguageListFiltered += [UniLanguage]\r
6780eef1
LG		 323 break\r
324 else:\r
325 # Here is rule 3 for "get best language"\r
326 # If tag is not listed in the Unicode file, the default ("en") tag should be used for that language\r
327 # for better processing, find the one that best suit for it.\r
328 DefaultTag = 'en'\r
329 if DefaultTag not in UniLanguageListFiltered:\r
330 # check whether language code with primary code equivalent with DefaultTag already in the list, if so, use that\r
331 for UniLanguage in UniLanguageList:\r
332 if UniLanguage.startswith('en-') or UniLanguage.startswith('eng-'):\r
333 if UniLanguage not in UniLanguageListFiltered:\r
334 UniLanguageListFiltered += [UniLanguage]\r
335 break\r
336 else:\r
337 UniLanguageListFiltered += [DefaultTag]\r
338 return UniLanguageListFiltered\r
339\r
30fdf114
LG		 340\r
341## Create content of .c file\r
342#\r
343# Create content of .c file\r
344#\r
b303ea72
LG		 345# @param BaseName: The basename of strings\r
346# @param UniObjectClass A UniObjectClass instance\r
347# @param IsCompatibleMode Compatible mode\r
348# @param UniBinBuffer UniBinBuffer to contain UniBinary data.\r
6780eef1 349# @param FilterInfo Platform language filter information \r
30fdf114
LG		 350#\r
351# @retval Str: A string of .c file content\r
352#\r
6780eef1 353def CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniBinBuffer, FilterInfo):\r
30fdf114
LG		 354 #\r
355 # Init array length\r
356 #\r
357 TotalLength = EFI_HII_ARRAY_SIZE_LENGTH\r
358 Str = ''\r
359 Offset = 0\r
360\r
6780eef1
LG		 361 EDK2Module = FilterInfo[0]\r
362 if EDK2Module:\r
363 LanguageFilterList = FilterInfo[1]\r
364 else:\r
365 # EDK module is using ISO639-2 format filter, convert to the RFC4646 format\r
366 LanguageFilterList = [LangConvTable.get(F.lower()) for F in FilterInfo[1]]\r
367 \r
368 UniLanguageList = []\r
369 for IndexI in range(len(UniObjectClass.LanguageDef)):\r
47fea6af 370 UniLanguageList += [UniObjectClass.LanguageDef[IndexI][0]]\r
6780eef1
LG		 371\r
372 UniLanguageListFiltered = GetFilteredLanguage(UniLanguageList, LanguageFilterList)\r
373 \r
374 \r
30fdf114
LG		 375 #\r
376 # Create lines for each language's strings\r
377 #\r
378 for IndexI in range(len(UniObjectClass.LanguageDef)):\r
379 Language = UniObjectClass.LanguageDef[IndexI][0]\r
6780eef1
LG		 380 if Language not in UniLanguageListFiltered:\r
381 continue\r
382 \r
b303ea72 383 StringBuffer = StringIO()\r
30fdf114
LG		 384 StrStringValue = ''\r
385 ArrayLength = 0\r
b303ea72 386 NumberOfUseOtherLangDef = 0\r
30fdf114
LG		 387 Index = 0\r
388 for IndexJ in range(1, len(UniObjectClass.OrderedStringList[UniObjectClass.LanguageDef[IndexI][0]])):\r
79b74a03
LG		 389 Item = UniObjectClass.OrderedStringListByToken[Language][IndexJ]\r
390\r
30fdf114
LG		 391 Name = Item.StringName\r
392 Value = Item.StringValueByteList\r
393 Referenced = Item.Referenced\r
394 Token = Item.Token\r
30fdf114
LG		 395 UseOtherLangDef = Item.UseOtherLangDef\r
396\r
397 if UseOtherLangDef != '' and Referenced:\r
b303ea72 398 NumberOfUseOtherLangDef = NumberOfUseOtherLangDef + 1\r
30fdf114
LG		 399 Index = Index + 1\r
400 else:\r
b303ea72
LG		 401 if NumberOfUseOtherLangDef > 0:\r
402 StrStringValue = WriteLine(StrStringValue, CreateArrayItem([StringSkipType] + DecToHexList(NumberOfUseOtherLangDef, 4)))\r
403 CreateBinBuffer (StringBuffer, ([StringSkipType] + DecToHexList(NumberOfUseOtherLangDef, 4)))\r
404 NumberOfUseOtherLangDef = 0\r
30fdf114
LG		 405 ArrayLength = ArrayLength + 3\r
406 if Referenced and Item.Token > 0:\r
407 Index = Index + 1\r
408 StrStringValue = WriteLine(StrStringValue, "// %s: %s:%s" % (DecToHexStr(Index, 4), Name, DecToHexStr(Token, 4)))\r
409 StrStringValue = Write(StrStringValue, CreateCFileStringValue(Value))\r
b303ea72 410 CreateBinBuffer (StringBuffer, [StringBlockType] + Value)\r
30fdf114
LG		 411 ArrayLength = ArrayLength + Item.Length + 1 # 1 is for the length of string type\r
412\r
413 #\r
414 # EFI_HII_PACKAGE_HEADER\r
415 #\r
416 Offset = EFI_HII_STRING_PACKAGE_HDR_LENGTH + len(Language) + 1\r
417 ArrayLength = Offset + ArrayLength + 1\r
418\r
419 #\r
420 # Create PACKAGE HEADER\r
421 #\r
422 Str = WriteLine(Str, '// PACKAGE HEADER\n')\r
423 TotalLength = TotalLength + ArrayLength\r
424\r
425 List = DecToHexList(ArrayLength, 6) + \\r
426 [StringPackageType] + \\r
427 DecToHexList(Offset) + \\r
428 DecToHexList(Offset) + \\r
429 DecToHexList(EFI_HII_LANGUAGE_WINDOW, EFI_HII_LANGUAGE_WINDOW_LENGTH * 2) * EFI_HII_LANGUAGE_WINDOW_NUMBER + \\r
430 DecToHexList(EFI_STRING_ID, 4) + \\r
431 AscToHexList(Language) + \\r
432 DecToHexList(0, 2)\r
433 Str = WriteLine(Str, CreateArrayItem(List, 16) + '\n')\r
434\r
435 #\r
436 # Create PACKAGE DATA\r
437 #\r
438 Str = WriteLine(Str, '// PACKAGE DATA\n')\r
439 Str = Write(Str, StrStringValue)\r
440\r
441 #\r
442 # Add an EFI_HII_SIBT_END at last\r
443 #\r
444 Str = WriteLine(Str, ' ' + EFI_HII_SIBT_END + ",")\r
b303ea72
LG		 445 \r
446 #\r
447 # Create binary UNI string\r
448 #\r
449 if UniBinBuffer:\r
450 CreateBinBuffer (UniBinBuffer, List)\r
451 UniBinBuffer.write (StringBuffer.getvalue())\r
47fea6af 452 UniBinBuffer.write (pack("B", int(EFI_HII_SIBT_END, 16)))\r
b303ea72 453 StringBuffer.close()\r
30fdf114
LG		 454\r
455 #\r
456 # Create line for string variable name\r
457 # "unsigned char $(BaseName)Strings[] = {"\r
458 #\r
47fea6af 459 AllStr = WriteLine('', CHAR_ARRAY_DEFIN + ' ' + BaseName + COMMON_FILE_NAME + '[] = {\n')\r
30fdf114 460\r
30fdf114 461 if IsCompatibleMode:\r
b303ea72
LG		 462 #\r
463 # Create FRAMEWORK_EFI_HII_PACK_HEADER in compatible mode\r
464 #\r
30fdf114
LG		 465 AllStr = WriteLine(AllStr, '// FRAMEWORK PACKAGE HEADER Length')\r
466 AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength + 2)) + '\n')\r
467 AllStr = WriteLine(AllStr, '// FRAMEWORK PACKAGE HEADER Type')\r
468 AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(2, 4)) + '\n')\r
b303ea72
LG		 469 else:\r
470 #\r
471 # Create whole array length in UEFI mode\r
472 #\r
30fdf114
LG		 473 AllStr = WriteLine(AllStr, '// STRGATHER_OUTPUT_HEADER')\r
474 AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength)) + '\n')\r
475\r
476 #\r
477 # Join package data\r
478 #\r
479 AllStr = Write(AllStr, Str)\r
480\r
481 return AllStr\r
482\r
483## Create end of .c file\r
484#\r
485# Create end of .c file\r
486#\r
487# @retval Str: A string of .h file end\r
488#\r
489def CreateCFileEnd():\r
490 Str = Write('', '};')\r
491 return Str\r
492\r
493## Create a .c file\r
494#\r
495# Create a complete .c file\r
496#\r
b303ea72
LG		 497# @param BaseName: The basename of strings\r
498# @param UniObjectClass A UniObjectClass instance\r
499# @param IsCompatibleMode Compatible Mode\r
6780eef1 500# @param FilterInfo Platform language filter information \r
30fdf114 501#\r
6780eef1 502# @retval CFile: A string of complete .c file\r
30fdf114 503#\r
6780eef1 504def CreateCFile(BaseName, UniObjectClass, IsCompatibleMode, FilterInfo):\r
30fdf114
LG		 505 CFile = ''\r
506 #CFile = WriteLine(CFile, CreateCFileHeader())\r
6780eef1 507 CFile = WriteLine(CFile, CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, None, FilterInfo))\r
30fdf114
LG		 508 CFile = WriteLine(CFile, CreateCFileEnd())\r
509 return CFile\r
510\r
511## GetFileList\r
512#\r
513# Get a list for all files\r
514#\r
515# @param IncludeList: A list of all path to be searched\r
516# @param SkipList: A list of all types of file could be skipped\r
517#\r
518# @retval FileList: A list of all files found\r
519#\r
520def GetFileList(SourceFileList, IncludeList, SkipList):\r
521 if IncludeList == None:\r
522 EdkLogger.error("UnicodeStringGather", AUTOGEN_ERROR, "Include path for unicode file is not defined")\r
523\r
524 FileList = []\r
525 if SkipList == None:\r
526 SkipList = []\r
527\r
528 for File in SourceFileList:\r
529 for Dir in IncludeList:\r
530 if not os.path.exists(Dir):\r
531 continue\r
532 File = os.path.join(Dir, File.Path)\r
533 #\r
534 # Ignore Dir\r
535 #\r
536 if os.path.isfile(File) != True:\r
537 continue\r
538 #\r
539 # Ignore file listed in skip list\r
540 #\r
541 IsSkip = False\r
542 for Skip in SkipList:\r
543 if os.path.splitext(File)[1].upper() == Skip.upper():\r
544 EdkLogger.verbose("Skipped %s for string token uses search" % File)\r
545 IsSkip = True\r
546 break\r
547\r
548 if not IsSkip:\r
549 FileList.append(File)\r
550\r
551 break\r
552\r
553 return FileList\r
554\r
555## SearchString\r
556#\r
557# Search whether all string defined in UniObjectClass are referenced\r
558# All string used should be set to Referenced\r
559#\r
560# @param UniObjectClass: Input UniObjectClass\r
561# @param FileList: Search path list\r
b303ea72 562# @param IsCompatibleMode Compatible Mode\r
30fdf114
LG		 563#\r
564# @retval UniObjectClass: UniObjectClass after searched\r
565#\r
b303ea72 566def SearchString(UniObjectClass, FileList, IsCompatibleMode):\r
30fdf114
LG		 567 if FileList == []:\r
568 return UniObjectClass\r
569\r
570 for File in FileList:\r
571 if os.path.isfile(File):\r
572 Lines = open(File, 'r')\r
573 for Line in Lines:\r
afb04ba1 574 for StrName in STRING_TOKEN.findall(Line):\r
30fdf114
LG		 575 EdkLogger.debug(EdkLogger.DEBUG_5, "Found string identifier: " + StrName)\r
576 UniObjectClass.SetStringReferenced(StrName)\r
577\r
578 UniObjectClass.ReToken()\r
579\r
580 return UniObjectClass\r
581\r
582## GetStringFiles\r
583#\r
584# This function is used for UEFI2.1 spec\r
585#\r
586#\r
79b74a03 587def GetStringFiles(UniFilList, SourceFileList, IncludeList, IncludePathList, SkipList, BaseName, IsCompatibleMode = False, ShellMode = False, UniGenCFlag = True, UniGenBinBuffer = None, FilterInfo = [True, []]): \r
30fdf114
LG		 588 if len(UniFilList) > 0:\r
589 if ShellMode:\r
590 #\r
591 # support ISO 639-2 codes in .UNI files of EDK Shell\r
592 #\r
756ad8f8 593 Uni = UniFileClassObject(sorted (UniFilList), True, IncludePathList)\r
30fdf114 594 else:\r
756ad8f8 595 Uni = UniFileClassObject(sorted (UniFilList), IsCompatibleMode, IncludePathList)\r
30fdf114
LG		 596 else:\r
597 EdkLogger.error("UnicodeStringGather", AUTOGEN_ERROR, 'No unicode files given')\r
598\r
599 FileList = GetFileList(SourceFileList, IncludeList, SkipList)\r
600\r
756ad8f8 601 Uni = SearchString(Uni, sorted (FileList), IsCompatibleMode)\r
30fdf114 602\r
b303ea72
LG		 603 HFile = CreateHFile(BaseName, Uni, IsCompatibleMode, UniGenCFlag)\r
604 CFile = None\r
605 if IsCompatibleMode or UniGenCFlag:\r
6780eef1 606 CFile = CreateCFile(BaseName, Uni, IsCompatibleMode, FilterInfo)\r
b303ea72 607 if UniGenBinBuffer:\r
6780eef1 608 CreateCFileContent(BaseName, Uni, IsCompatibleMode, UniGenBinBuffer, FilterInfo)\r
30fdf114
LG		 609\r
610 return HFile, CFile\r
611\r
612#\r
613# Write an item\r
614#\r
615def Write(Target, Item):\r
47fea6af 616 return ''.join([Target, Item])\r
30fdf114
LG		 617\r
618#\r
619# Write an item with a break line\r
620#\r
621def WriteLine(Target, Item):\r
47fea6af 622 return ''.join([Target, Item, '\n'])\r
30fdf114
LG		 623\r
624# This acts like the main() function for the script, unless it is 'import'ed into another\r
625# script.\r
626if __name__ == '__main__':\r
627 EdkLogger.info('start')\r
628\r
629 UniFileList = [\r
630 r'C:\\Edk\\Strings2.uni',\r
631 r'C:\\Edk\\Strings.uni'\r
632 ]\r
633\r
634 SrcFileList = []\r
635 for Root, Dirs, Files in os.walk('C:\\Edk'):\r
636 for File in Files:\r
637 SrcFileList.append(File)\r
638\r
639 IncludeList = [\r
640 r'C:\\Edk'\r
641 ]\r
642\r
643 SkipList = ['.inf', '.uni']\r
644 BaseName = 'DriverSample'\r
645 (h, c) = GetStringFiles(UniFileList, SrcFileList, IncludeList, SkipList, BaseName, True)\r
646 hfile = open('unistring.h', 'w')\r
647 cfile = open('unistring.c', 'w')\r
648 hfile.write(h)\r
649 cfile.write(c)\r
650\r
651 EdkLogger.info('end')\r
EFI Development Kit II mirror for PVE