]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Library/HiiLib/HiiString.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Fix a bug in the assert condition.
[mirror_edk2.git] / MdePkg / Library / HiiLib / HiiString.c
CommitLineData
e52c5a9f 1/** @file\r
2 HII Library implementation that uses DXE protocols and services.\r
3\r
27d55a2d 4 Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
e52c5a9f 5 All rights reserved. This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15\r
16#include "InternalHiiLib.h"\r
ad1b3619 17\r
18/**\r
19 This function adds the string into String Package of each language\r
20 supported by the package list.\r
21\r
22 If String is NULL, then ASSERT.\r
23 If StringId is NULL, the ASSERT.\r
24 If PackageList could not be found in the default HII database, then ASSERT.\r
25\r
26 @param PackageList Handle of the package list where this string will\r
27 be added.\r
28 @param StringId On return, contains the new strings id, which is\r
29 unique within PackageList.\r
30 @param String Points to the new null-terminated string.\r
31\r
32 @retval EFI_SUCCESS The new string was added successfully.\r
33 @retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.\r
34\r
35**/\r
e52c5a9f 36EFI_STATUS\r
37EFIAPI\r
38HiiLibNewString (\r
39 IN EFI_HII_HANDLE PackageList,\r
40 OUT EFI_STRING_ID *StringId,\r
41 IN CONST EFI_STRING String\r
42 )\r
43{\r
44 EFI_STATUS Status;\r
45 CHAR8 *Languages;\r
46 CHAR8 *LangStrings;\r
47 CHAR8 Lang[RFC_3066_ENTRY_SIZE];\r
48\r
49 ASSERT (String != NULL);\r
50 ASSERT (StringId != NULL);\r
51\r
52 Status = EFI_SUCCESS;\r
53\r
54 Languages = HiiLibGetSupportedLanguages (PackageList);\r
55\r
56 LangStrings = Languages;\r
57 while (*LangStrings != 0) {\r
58 HiiLibGetNextLanguage (&LangStrings, Lang);\r
59\r
29870c8d 60 //\r
61 // For each language supported by the package,\r
62 // a string token is created.\r
63 //\r
e52c5a9f 64 Status = mHiiStringProt->NewString (\r
65 mHiiStringProt,\r
66 PackageList,\r
67 StringId,\r
68 Lang,\r
69 NULL,\r
70 String,\r
71 NULL\r
72 );\r
73 if (EFI_ERROR (Status)) {\r
74 break;\r
75 }\r
76 }\r
77\r
78 FreePool (Languages);\r
79\r
80 return Status;\r
81 \r
82}\r
83\r
ad1b3619 84\r
85/**\r
86 This function update the specified string in String Package of each language\r
87 supported by the package list.\r
88\r
89 If String is NULL, then ASSERT.\r
90 If PackageList could not be found in the default HII database, then ASSERT.\r
91 If StringId is not found in PackageList, then ASSERT.\r
92\r
93 @param PackageList Handle of the package list where this string will\r
94 be added.\r
95 @param StringId Ths String Id to be updated.\r
96 @param String Points to the new null-terminated string.\r
97\r
98 @retval EFI_SUCCESS The new string was added successfully.\r
99 @retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.\r
100\r
101**/\r
e52c5a9f 102EFI_STATUS\r
103EFIAPI\r
104HiiLibSetString (\r
105 IN EFI_HII_HANDLE PackageList,\r
106 IN EFI_STRING_ID StringId,\r
107 IN CONST EFI_STRING String\r
108 )\r
109{\r
110 EFI_STATUS Status;\r
111 CHAR8 *Languages;\r
112 CHAR8 *LangStrings;\r
113 CHAR8 Lang[RFC_3066_ENTRY_SIZE];\r
114\r
115 ASSERT (IsHiiHandleRegistered (PackageList));\r
116\r
117 Status = EFI_SUCCESS;\r
118\r
119 Languages = HiiLibGetSupportedLanguages (PackageList);\r
120 ASSERT (Languages != NULL);\r
121\r
122 LangStrings = Languages;\r
123 while (*LangStrings != 0) {\r
124 HiiLibGetNextLanguage (&LangStrings, Lang);\r
125\r
29870c8d 126 //\r
127 // For each language supported by the package,\r
128 // the string is updated.\r
129 //\r
e52c5a9f 130 Status = mHiiStringProt->SetString (\r
131 mHiiStringProt,\r
132 PackageList,\r
133 StringId,\r
134 Lang,\r
135 String,\r
136 NULL\r
137 );\r
138 if (EFI_ERROR (Status)) {\r
139 break;\r
140 }\r
141 }\r
142\r
143 FreePool (Languages);\r
144\r
145 return Status;\r
146}\r
147\r
148\r
ad1b3619 149/**\r
150 Get the string given the StringId and String package Producer's Guid. The caller\r
151 is responsible to free the *String.\r
152\r
153 If PackageList with the matching ProducerGuid is not found, then ASSERT.\r
154 If PackageList with the matching ProducerGuid is found but no String is\r
155 specified by StringId is found, then ASSERT.\r
156\r
157 @param ProducerGuid The Guid of String package list.\r
158 @param StringId The String ID.\r
159 @param String The output string.\r
160\r
161 @retval EFI_SUCCESS Operation is successful.\r
162 @retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.\r
163\r
164**/\r
e52c5a9f 165EFI_STATUS\r
166EFIAPI\r
167HiiLibGetStringFromToken (\r
168 IN EFI_GUID *ProducerGuid,\r
169 IN EFI_STRING_ID StringId,\r
170 OUT EFI_STRING *String\r
171 )\r
172{\r
173 EFI_STATUS Status;\r
174 UINTN Index;\r
175 UINTN HandleBufferLen;\r
176 EFI_HII_HANDLE *HiiHandleBuffer;\r
177 EFI_GUID Guid;\r
178\r
179 Status = HiiLibGetHiiHandles (&HandleBufferLen, &HiiHandleBuffer);\r
180 if (EFI_ERROR(Status)) {\r
181 return Status;\r
182 }\r
183 for (Index = 0; Index < (HandleBufferLen / sizeof (EFI_HII_HANDLE)); Index++) {\r
184 Status = HiiLibExtractGuidFromHiiHandle (HiiHandleBuffer[Index], &Guid);\r
185 if (EFI_ERROR(Status)) {\r
186 return Status;\r
187 }\r
27d55a2d 188 if (CompareGuid (&Guid, ProducerGuid)) {\r
e52c5a9f 189 break;\r
190 }\r
191 }\r
192\r
193 if (Index >= (HandleBufferLen / sizeof (EFI_HII_HANDLE))) {\r
194 //\r
195 // If PackageList with the matching ProducerGuid is not found, then ASSERT.\r
196 //\r
197 ASSERT (FALSE);\r
198 Status = EFI_NOT_FOUND;\r
199 goto Out;\r
200 }\r
201\r
202 Status = HiiLibGetStringFromHandle (HiiHandleBuffer[Index], StringId, String);\r
203\r
204Out:\r
205 if (HiiHandleBuffer != NULL) {\r
29870c8d 206 FreePool (HiiHandleBuffer);\r
e52c5a9f 207 }\r
208 return Status;\r
209}\r
210\r
ad1b3619 211/**\r
212 This function try to retrieve string from String package of current language.\r
213 If fails, it try to retrieve string from String package of first language it support.\r
214\r
ad1b3619 215 If StringSize is NULL, then ASSERT.\r
4386f143 216 If String is NULL and *StringSize is not 0, then ASSERT.\r
ad1b3619 217 If PackageList could not be found in the default HII database, then ASSERT.\r
218 If StringId is not found in PackageList, then ASSERT.\r
219\r
220 @param PackageList The package list in the HII database to search for\r
221 the specified string.\r
222 @param StringId The string's id, which is unique within\r
223 PackageList.\r
224 @param String Points to the new null-terminated string.\r
225 @param StringSize On entry, points to the size of the buffer pointed\r
226 to by String, in bytes. On return, points to the\r
227 length of the string, in bytes.\r
228\r
229 @retval EFI_SUCCESS The string was returned successfully.\r
230 @retval EFI_NOT_FOUND The string specified by StringId is not available.\r
231 @retval EFI_BUFFER_TOO_SMALL The buffer specified by StringLength is too small\r
232 to hold the string.\r
ad1b3619 233\r
234**/\r
e52c5a9f 235EFI_STATUS\r
236EFIAPI\r
237HiiLibGetString (\r
238 IN EFI_HII_HANDLE PackageList,\r
239 IN EFI_STRING_ID StringId,\r
240 OUT EFI_STRING String,\r
241 IN OUT UINTN *StringSize\r
242 )\r
243{\r
244 EFI_STATUS Status;\r
245 CHAR8 *Languages;\r
246 CHAR8 *LangStrings;\r
247 CHAR8 Lang[RFC_3066_ENTRY_SIZE];\r
248 CHAR8 CurrentLang[RFC_3066_ENTRY_SIZE];\r
249\r
e52c5a9f 250 ASSERT (StringSize != NULL);\r
4386f143 251 ASSERT (!(*StringSize != 0 && String == NULL));\r
e52c5a9f 252 ASSERT (IsHiiHandleRegistered (PackageList));\r
253\r
254 HiiLibGetCurrentLanguage (CurrentLang);\r
255\r
256 Status = mHiiStringProt->GetString (\r
257 mHiiStringProt,\r
258 CurrentLang,\r
259 PackageList,\r
260 StringId,\r
261 String,\r
262 StringSize,\r
263 NULL\r
264 );\r
265\r
266 if (EFI_ERROR (Status) && (Status != EFI_BUFFER_TOO_SMALL)) {\r
267 Languages = HiiLibGetSupportedLanguages (PackageList);\r
268 ASSERT (Languages != NULL);\r
269 \r
270 LangStrings = Languages;\r
271 HiiLibGetNextLanguage (&LangStrings, Lang);\r
29870c8d 272 FreePool (Languages);\r
e52c5a9f 273\r
274 Status = mHiiStringProt->GetString (\r
275 mHiiStringProt,\r
276 Lang,\r
277 PackageList,\r
278 StringId,\r
279 String,\r
280 StringSize,\r
281 NULL\r
282 );\r
283 }\r
284\r
285 return Status;\r
286}\r
287\r
288\r
ad1b3619 289/**\r
290 Get string specified by StringId form the HiiHandle. The caller\r
291 is responsible to free the *String.\r
292\r
293 If String is NULL, then ASSERT.\r
294 If HiiHandle could not be found in the default HII database, then ASSERT.\r
295 If StringId is not found in PackageList, then ASSERT.\r
296\r
297 @param HiiHandle The HII handle of package list.\r
298 @param StringId The String ID.\r
299 @param String The output string.\r
300\r
301 @retval EFI_NOT_FOUND String is not found.\r
302 @retval EFI_SUCCESS Operation is successful.\r
303 @retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.\r
304 @retval EFI_INVALID_PARAMETER The String is NULL.\r
305\r
306**/\r
e52c5a9f 307EFI_STATUS\r
308EFIAPI\r
309HiiLibGetStringFromHandle (\r
310 IN EFI_HII_HANDLE HiiHandle,\r
311 IN EFI_STRING_ID StringId,\r
312 OUT EFI_STRING *String\r
313 )\r
314{\r
315 EFI_STATUS Status;\r
316 UINTN StringSize;\r
317\r
318 ASSERT (String != NULL);\r
319\r
320 StringSize = HII_LIB_DEFAULT_STRING_SIZE;\r
321 *String = AllocateZeroPool (StringSize);\r
322 if (*String == NULL) {\r
323 return EFI_OUT_OF_RESOURCES;\r
324 }\r
325\r
326 Status = HiiLibGetString (HiiHandle, StringId, *String, &StringSize);\r
327 if (Status == EFI_BUFFER_TOO_SMALL) {\r
29870c8d 328 FreePool (*String);\r
e52c5a9f 329 *String = AllocateZeroPool (StringSize);\r
330 if (*String == NULL) {\r
331 return EFI_OUT_OF_RESOURCES;\r
332 }\r
333 Status = HiiLibGetString (HiiHandle, StringId, *String, &StringSize);\r
334 }\r
335\r
336 return Status;\r
337}\r
338\r
339\r
340\r
341//\r
342// Lookup table of ISO639-2 3 character language codes to ISO 639-1 2 character language codes\r
343// Each entry is 5 CHAR8 values long. The first 3 CHAR8 values are the ISO 639-2 code.\r
344// The last 2 CHAR8 values are the ISO 639-1 code.\r
345//\r
29870c8d 346GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 Iso639ToRfc3066ConversionTable[] =\r
e52c5a9f 347"\\r
348aaraa\\r
349abkab\\r
350afraf\\r
351amham\\r
352araar\\r
353asmas\\r
354aymay\\r
355azeaz\\r
356bakba\\r
357belbe\\r
358benbn\\r
359bihbh\\r
360bisbi\\r
361bodbo\\r
362brebr\\r
363bulbg\\r
364catca\\r
365cescs\\r
366corkw\\r
367cosco\\r
368cymcy\\r
369danda\\r
370deude\\r
371dzodz\\r
372ellel\\r
373engen\\r
374epoeo\\r
375estet\\r
376euseu\\r
377faofo\\r
378fasfa\\r
379fijfj\\r
380finfi\\r
381frafr\\r
382fryfy\\r
383gaiga\\r
384gdhgd\\r
385glggl\\r
386grngn\\r
387gujgu\\r
388hauha\\r
389hebhe\\r
390hinhi\\r
391hrvhr\\r
392hunhu\\r
393hyehy\\r
394ikuiu\\r
395ileie\\r
396inaia\\r
397indid\\r
398ipkik\\r
399islis\\r
400itait\\r
401jawjw\\r
402jpnja\\r
403kalkl\\r
404kankn\\r
405kasks\\r
406katka\\r
407kazkk\\r
408khmkm\\r
409kinrw\\r
410kirky\\r
411korko\\r
412kurku\\r
413laolo\\r
414latla\\r
415lavlv\\r
416linln\\r
417litlt\\r
418ltzlb\\r
419malml\\r
420marmr\\r
421mkdmk\\r
422mlgmg\\r
423mltmt\\r
424molmo\\r
425monmn\\r
426mrimi\\r
427msams\\r
428myamy\\r
429nauna\\r
430nepne\\r
431nldnl\\r
432norno\\r
433ocioc\\r
434ormom\\r
435panpa\\r
436polpl\\r
437porpt\\r
438pusps\\r
439quequ\\r
440rohrm\\r
441ronro\\r
442runrn\\r
443rusru\\r
444sagsg\\r
445sansa\\r
446sinsi\\r
447slksk\\r
448slvsl\\r
449smise\\r
450smosm\\r
451snasn\\r
452sndsd\\r
453somso\\r
454sotst\\r
455spaes\\r
456sqisq\\r
457srpsr\\r
458sswss\\r
459sunsu\\r
460swasw\\r
461swesv\\r
462tamta\\r
463tattt\\r
464telte\\r
465tgktg\\r
466tgltl\\r
467thath\\r
468tsnts\\r
469tuktk\\r
470twitw\\r
471uigug\\r
472ukruk\\r
473urdur\\r
474uzbuz\\r
475vievi\\r
476volvo\\r
477wolwo\\r
478xhoxh\\r
479yidyi\\r
480zhaza\\r
481zhozh\\r
482zulzu\\r
483";\r
484\r
485\r
486/**\r
487 Convert language code from RFC3066 to ISO639-2.\r
488\r
489 @param LanguageRfc3066 RFC3066 language code.\r
490 @param LanguageIso639 ISO639-2 language code.\r
491\r
492 @retval EFI_SUCCESS Language code converted.\r
493 @retval EFI_NOT_FOUND Language code not found.\r
494\r
495**/\r
496EFI_STATUS\r
497EFIAPI\r
498ConvertRfc3066LanguageToIso639Language (\r
499 CHAR8 *LanguageRfc3066,\r
500 CHAR8 *LanguageIso639\r
501 )\r
502{\r
503 UINTN Index;\r
504\r
505 if ((LanguageRfc3066[2] != '-') && (LanguageRfc3066[2] != 0)) {\r
506 CopyMem (LanguageIso639, LanguageRfc3066, 3);\r
507 return EFI_SUCCESS;\r
508 }\r
509\r
510 for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
511 if (CompareMem (LanguageRfc3066, &Iso639ToRfc3066ConversionTable[Index + 3], 2) == 0) {\r
512 CopyMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3);\r
513 return EFI_SUCCESS;\r
514 }\r
515 }\r
516\r
517 return EFI_NOT_FOUND;\r
518}\r
519\r
520\r
2d81bfb9 521/**\r
522 Convert language code from ISO639-2 to RFC3066.\r
523\r
524 LanguageIso639 contain a single ISO639-2 code such as\r
525 "eng" or "fra".\r
526\r
527 The LanguageRfc3066 must be a buffer large enough\r
528 for RFC_3066_ENTRY_SIZE characters.\r
529\r
530 If LanguageIso639 is NULL, then ASSERT.\r
531 If LanguageRfc3066 is NULL, then ASSERT.\r
532\r
533 @param LanguageIso639 ISO639-2 language code.\r
534 @param LanguageRfc3066 RFC3066 language code.\r
535\r
536 @retval EFI_SUCCESS Language code converted.\r
537 @retval EFI_NOT_FOUND Language code not found.\r
538\r
539**/\r
540EFI_STATUS\r
541EFIAPI\r
542ConvertIso639LanguageToRfc3066Language (\r
543 IN CONST CHAR8 *LanguageIso639,\r
544 OUT CHAR8 *LanguageRfc3066\r
545 )\r
546{\r
547 UINTN Index;\r
548 \r
549 for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
550 if (CompareMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3) == 0) {\r
551 CopyMem (LanguageRfc3066, &Iso639ToRfc3066ConversionTable[Index + 3], 2);\r
552 return EFI_SUCCESS;\r
553 }\r
554 }\r
555\r
556 return EFI_NOT_FOUND;\r
557}\r
558\r
e52c5a9f 559/**\r
560 Convert language code list from RFC3066 to ISO639-2, e.g. "en-US;fr-FR" will\r
561 be converted to "engfra".\r
562\r
563 @param SupportedLanguages The RFC3066 language list.\r
564\r
565 @return The ISO639-2 language list.\r
566\r
567**/\r
568CHAR8 *\r
569EFIAPI\r
570Rfc3066ToIso639 (\r
571 CHAR8 *SupportedLanguages\r
572 )\r
573{\r
574 CHAR8 *Languages;\r
575 CHAR8 *ReturnValue;\r
576 CHAR8 *LangCodes;\r
577 CHAR8 LangRfc3066[RFC_3066_ENTRY_SIZE];\r
578 CHAR8 LangIso639[ISO_639_2_ENTRY_SIZE];\r
579 EFI_STATUS Status;\r
580\r
581 ReturnValue = AllocateZeroPool (AsciiStrSize (SupportedLanguages));\r
582 if (ReturnValue == NULL) {\r
583 return ReturnValue;\r
584 }\r
585\r
586 Languages = ReturnValue;\r
587 LangCodes = SupportedLanguages;\r
588 while (*LangCodes != 0) {\r
589 HiiLibGetNextLanguage (&LangCodes, LangRfc3066);\r
590\r
591 Status = ConvertRfc3066LanguageToIso639Language (LangRfc3066, LangIso639);\r
592 if (!EFI_ERROR (Status)) {\r
593 CopyMem (Languages, LangIso639, 3);\r
594 Languages = Languages + 3;\r
595 }\r
596 }\r
597\r
598 return ReturnValue;\r
599}\r
600\r
601\r
EFI Development Kit II mirror for PVE