]> 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
Clean up HiiLib.
[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
215 If String is NULL, then ASSERT.\r
216 If StringSize is NULL, then ASSERT.\r
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
233 @retval EFI_INVALID_PARAMETER The String or StringSize was NULL.\r
234\r
235**/\r
e52c5a9f 236EFI_STATUS\r
237EFIAPI\r
238HiiLibGetString (\r
239 IN EFI_HII_HANDLE PackageList,\r
240 IN EFI_STRING_ID StringId,\r
241 OUT EFI_STRING String,\r
242 IN OUT UINTN *StringSize\r
243 )\r
244{\r
245 EFI_STATUS Status;\r
246 CHAR8 *Languages;\r
247 CHAR8 *LangStrings;\r
248 CHAR8 Lang[RFC_3066_ENTRY_SIZE];\r
249 CHAR8 CurrentLang[RFC_3066_ENTRY_SIZE];\r
250\r
251 ASSERT (String != NULL);\r
252 ASSERT (StringSize != NULL);\r
253 ASSERT (IsHiiHandleRegistered (PackageList));\r
254\r
255 HiiLibGetCurrentLanguage (CurrentLang);\r
256\r
257 Status = mHiiStringProt->GetString (\r
258 mHiiStringProt,\r
259 CurrentLang,\r
260 PackageList,\r
261 StringId,\r
262 String,\r
263 StringSize,\r
264 NULL\r
265 );\r
266\r
267 if (EFI_ERROR (Status) && (Status != EFI_BUFFER_TOO_SMALL)) {\r
268 Languages = HiiLibGetSupportedLanguages (PackageList);\r
269 ASSERT (Languages != NULL);\r
270 \r
271 LangStrings = Languages;\r
272 HiiLibGetNextLanguage (&LangStrings, Lang);\r
29870c8d 273 FreePool (Languages);\r
e52c5a9f 274\r
275 Status = mHiiStringProt->GetString (\r
276 mHiiStringProt,\r
277 Lang,\r
278 PackageList,\r
279 StringId,\r
280 String,\r
281 StringSize,\r
282 NULL\r
283 );\r
284 }\r
285\r
286 return Status;\r
287}\r
288\r
289\r
ad1b3619 290/**\r
291 Get string specified by StringId form the HiiHandle. The caller\r
292 is responsible to free the *String.\r
293\r
294 If String is NULL, then ASSERT.\r
295 If HiiHandle could not be found in the default HII database, then ASSERT.\r
296 If StringId is not found in PackageList, then ASSERT.\r
297\r
298 @param HiiHandle The HII handle of package list.\r
299 @param StringId The String ID.\r
300 @param String The output string.\r
301\r
302 @retval EFI_NOT_FOUND String is not found.\r
303 @retval EFI_SUCCESS Operation is successful.\r
304 @retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.\r
305 @retval EFI_INVALID_PARAMETER The String is NULL.\r
306\r
307**/\r
e52c5a9f 308EFI_STATUS\r
309EFIAPI\r
310HiiLibGetStringFromHandle (\r
311 IN EFI_HII_HANDLE HiiHandle,\r
312 IN EFI_STRING_ID StringId,\r
313 OUT EFI_STRING *String\r
314 )\r
315{\r
316 EFI_STATUS Status;\r
317 UINTN StringSize;\r
318\r
319 ASSERT (String != NULL);\r
320\r
321 StringSize = HII_LIB_DEFAULT_STRING_SIZE;\r
322 *String = AllocateZeroPool (StringSize);\r
323 if (*String == NULL) {\r
324 return EFI_OUT_OF_RESOURCES;\r
325 }\r
326\r
327 Status = HiiLibGetString (HiiHandle, StringId, *String, &StringSize);\r
328 if (Status == EFI_BUFFER_TOO_SMALL) {\r
29870c8d 329 FreePool (*String);\r
e52c5a9f 330 *String = AllocateZeroPool (StringSize);\r
331 if (*String == NULL) {\r
332 return EFI_OUT_OF_RESOURCES;\r
333 }\r
334 Status = HiiLibGetString (HiiHandle, StringId, *String, &StringSize);\r
335 }\r
336\r
337 return Status;\r
338}\r
339\r
340\r
341\r
342//\r
343// Lookup table of ISO639-2 3 character language codes to ISO 639-1 2 character language codes\r
344// Each entry is 5 CHAR8 values long. The first 3 CHAR8 values are the ISO 639-2 code.\r
345// The last 2 CHAR8 values are the ISO 639-1 code.\r
346//\r
29870c8d 347GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 Iso639ToRfc3066ConversionTable[] =\r
e52c5a9f 348"\\r
349aaraa\\r
350abkab\\r
351afraf\\r
352amham\\r
353araar\\r
354asmas\\r
355aymay\\r
356azeaz\\r
357bakba\\r
358belbe\\r
359benbn\\r
360bihbh\\r
361bisbi\\r
362bodbo\\r
363brebr\\r
364bulbg\\r
365catca\\r
366cescs\\r
367corkw\\r
368cosco\\r
369cymcy\\r
370danda\\r
371deude\\r
372dzodz\\r
373ellel\\r
374engen\\r
375epoeo\\r
376estet\\r
377euseu\\r
378faofo\\r
379fasfa\\r
380fijfj\\r
381finfi\\r
382frafr\\r
383fryfy\\r
384gaiga\\r
385gdhgd\\r
386glggl\\r
387grngn\\r
388gujgu\\r
389hauha\\r
390hebhe\\r
391hinhi\\r
392hrvhr\\r
393hunhu\\r
394hyehy\\r
395ikuiu\\r
396ileie\\r
397inaia\\r
398indid\\r
399ipkik\\r
400islis\\r
401itait\\r
402jawjw\\r
403jpnja\\r
404kalkl\\r
405kankn\\r
406kasks\\r
407katka\\r
408kazkk\\r
409khmkm\\r
410kinrw\\r
411kirky\\r
412korko\\r
413kurku\\r
414laolo\\r
415latla\\r
416lavlv\\r
417linln\\r
418litlt\\r
419ltzlb\\r
420malml\\r
421marmr\\r
422mkdmk\\r
423mlgmg\\r
424mltmt\\r
425molmo\\r
426monmn\\r
427mrimi\\r
428msams\\r
429myamy\\r
430nauna\\r
431nepne\\r
432nldnl\\r
433norno\\r
434ocioc\\r
435ormom\\r
436panpa\\r
437polpl\\r
438porpt\\r
439pusps\\r
440quequ\\r
441rohrm\\r
442ronro\\r
443runrn\\r
444rusru\\r
445sagsg\\r
446sansa\\r
447sinsi\\r
448slksk\\r
449slvsl\\r
450smise\\r
451smosm\\r
452snasn\\r
453sndsd\\r
454somso\\r
455sotst\\r
456spaes\\r
457sqisq\\r
458srpsr\\r
459sswss\\r
460sunsu\\r
461swasw\\r
462swesv\\r
463tamta\\r
464tattt\\r
465telte\\r
466tgktg\\r
467tgltl\\r
468thath\\r
469tsnts\\r
470tuktk\\r
471twitw\\r
472uigug\\r
473ukruk\\r
474urdur\\r
475uzbuz\\r
476vievi\\r
477volvo\\r
478wolwo\\r
479xhoxh\\r
480yidyi\\r
481zhaza\\r
482zhozh\\r
483zulzu\\r
484";\r
485\r
486\r
487/**\r
488 Convert language code from RFC3066 to ISO639-2.\r
489\r
490 @param LanguageRfc3066 RFC3066 language code.\r
491 @param LanguageIso639 ISO639-2 language code.\r
492\r
493 @retval EFI_SUCCESS Language code converted.\r
494 @retval EFI_NOT_FOUND Language code not found.\r
495\r
496**/\r
497EFI_STATUS\r
498EFIAPI\r
499ConvertRfc3066LanguageToIso639Language (\r
500 CHAR8 *LanguageRfc3066,\r
501 CHAR8 *LanguageIso639\r
502 )\r
503{\r
504 UINTN Index;\r
505\r
506 if ((LanguageRfc3066[2] != '-') && (LanguageRfc3066[2] != 0)) {\r
507 CopyMem (LanguageIso639, LanguageRfc3066, 3);\r
508 return EFI_SUCCESS;\r
509 }\r
510\r
511 for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
512 if (CompareMem (LanguageRfc3066, &Iso639ToRfc3066ConversionTable[Index + 3], 2) == 0) {\r
513 CopyMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3);\r
514 return EFI_SUCCESS;\r
515 }\r
516 }\r
517\r
518 return EFI_NOT_FOUND;\r
519}\r
520\r
521\r
2d81bfb9 522/**\r
523 Convert language code from ISO639-2 to RFC3066.\r
524\r
525 LanguageIso639 contain a single ISO639-2 code such as\r
526 "eng" or "fra".\r
527\r
528 The LanguageRfc3066 must be a buffer large enough\r
529 for RFC_3066_ENTRY_SIZE characters.\r
530\r
531 If LanguageIso639 is NULL, then ASSERT.\r
532 If LanguageRfc3066 is NULL, then ASSERT.\r
533\r
534 @param LanguageIso639 ISO639-2 language code.\r
535 @param LanguageRfc3066 RFC3066 language code.\r
536\r
537 @retval EFI_SUCCESS Language code converted.\r
538 @retval EFI_NOT_FOUND Language code not found.\r
539\r
540**/\r
541EFI_STATUS\r
542EFIAPI\r
543ConvertIso639LanguageToRfc3066Language (\r
544 IN CONST CHAR8 *LanguageIso639,\r
545 OUT CHAR8 *LanguageRfc3066\r
546 )\r
547{\r
548 UINTN Index;\r
549 \r
550 for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
551 if (CompareMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3) == 0) {\r
552 CopyMem (LanguageRfc3066, &Iso639ToRfc3066ConversionTable[Index + 3], 2);\r
553 return EFI_SUCCESS;\r
554 }\r
555 }\r
556\r
557 return EFI_NOT_FOUND;\r
558}\r
559\r
e52c5a9f 560/**\r
561 Convert language code list from RFC3066 to ISO639-2, e.g. "en-US;fr-FR" will\r
562 be converted to "engfra".\r
563\r
564 @param SupportedLanguages The RFC3066 language list.\r
565\r
566 @return The ISO639-2 language list.\r
567\r
568**/\r
569CHAR8 *\r
570EFIAPI\r
571Rfc3066ToIso639 (\r
572 CHAR8 *SupportedLanguages\r
573 )\r
574{\r
575 CHAR8 *Languages;\r
576 CHAR8 *ReturnValue;\r
577 CHAR8 *LangCodes;\r
578 CHAR8 LangRfc3066[RFC_3066_ENTRY_SIZE];\r
579 CHAR8 LangIso639[ISO_639_2_ENTRY_SIZE];\r
580 EFI_STATUS Status;\r
581\r
582 ReturnValue = AllocateZeroPool (AsciiStrSize (SupportedLanguages));\r
583 if (ReturnValue == NULL) {\r
584 return ReturnValue;\r
585 }\r
586\r
587 Languages = ReturnValue;\r
588 LangCodes = SupportedLanguages;\r
589 while (*LangCodes != 0) {\r
590 HiiLibGetNextLanguage (&LangCodes, LangRfc3066);\r
591\r
592 Status = ConvertRfc3066LanguageToIso639Language (LangRfc3066, LangIso639);\r
593 if (!EFI_ERROR (Status)) {\r
594 CopyMem (Languages, LangIso639, 3);\r
595 Languages = Languages + 3;\r
596 }\r
597 }\r
598\r
599 return ReturnValue;\r
600}\r
601\r
602\r
EFI Development Kit II mirror for PVE