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