1. Correct coding comments.
[efi/edk2/.git] / edk2 / EdkCompatibilityPkg / Compatibility / Library / UefiLanguageLib / UefiLanguageLib.c
1 /** @file\r
2   Language Library implementation that provides functions for language conversion\r
3   between ISO 639-2 and RFC 4646 language codes.\r
4 \r
5   Copyright (c) 2009 - 2010, Intel Corporation<BR>\r
6   All rights reserved. This program and the accompanying materials\r
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
14 **/\r
15 \r
16 #include <Uefi.h>\r
17 \r
18 #include <Library/LanguageLib.h>\r
19 \r
20 #include <Library/BaseLib.h>\r
21 #include <Library/DebugLib.h>\r
22 #include <Library/MemoryAllocationLib.h>\r
23 \r
24 //\r
25 // Lookup table of ISO639-2 3 character language codes to ISO 639-1 2 character language codes\r
26 // Each entry is 5 CHAR8 values long.  The first 3 CHAR8 values are the ISO 639-2 code.\r
27 // The last 2 CHAR8 values are the ISO 639-1 code.\r
28 //\r
29 // ISO 639-2 B codes and deprecated ISO 639-1 codes are not supported.\r
30 //\r
31 // Commonly used language codes such as English and French are put in the front of the table for quick match.\r
32 //\r
33 GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 mIso639ToRfc4646ConversionTable[] =\r
34 "\\r
35 engen\\r
36 frafr\\r
37 aaraa\\r
38 abkab\\r
39 aveae\\r
40 afraf\\r
41 akaak\\r
42 amham\\r
43 argan\\r
44 araar\\r
45 asmas\\r
46 avaav\\r
47 aymay\\r
48 azeaz\\r
49 bakba\\r
50 belbe\\r
51 bulbg\\r
52 bihbh\\r
53 bisbi\\r
54 bambm\\r
55 benbn\\r
56 bodbo\\r
57 brebr\\r
58 bosbs\\r
59 catca\\r
60 chece\\r
61 chach\\r
62 cosco\\r
63 crecr\\r
64 cescs\\r
65 chucu\\r
66 chvcv\\r
67 cymcy\\r
68 danda\\r
69 deude\\r
70 divdv\\r
71 dzodz\\r
72 eweee\\r
73 ellel\\r
74 epoeo\\r
75 spaes\\r
76 estet\\r
77 euseu\\r
78 fasfa\\r
79 fulff\\r
80 finfi\\r
81 fijfj\\r
82 faofo\\r
83 fryfy\\r
84 glega\\r
85 glagd\\r
86 glggl\\r
87 grngn\\r
88 gujgu\\r
89 glvgv\\r
90 hauha\\r
91 hebhe\\r
92 hinhi\\r
93 hmoho\\r
94 hrvhr\\r
95 hatht\\r
96 hunhu\\r
97 hyehy\\r
98 herhz\\r
99 inaia\\r
100 indid\\r
101 ileie\\r
102 iboig\\r
103 iiiii\\r
104 ipkik\\r
105 idoio\\r
106 islis\\r
107 itait\\r
108 ikuiu\\r
109 jpnja\\r
110 javjv\\r
111 katka\\r
112 konkg\\r
113 kikki\\r
114 kuakj\\r
115 kazkk\\r
116 kalkl\\r
117 khmkm\\r
118 kankn\\r
119 korko\\r
120 kaukr\\r
121 kasks\\r
122 kurku\\r
123 komkv\\r
124 corkw\\r
125 kirky\\r
126 latla\\r
127 ltzlb\\r
128 luglg\\r
129 limli\\r
130 linln\\r
131 laolo\\r
132 litlt\\r
133 lublu\\r
134 lavlv\\r
135 mlgmg\\r
136 mahmh\\r
137 mrimi\\r
138 mkdmk\\r
139 malml\\r
140 monmn\\r
141 marmr\\r
142 msams\\r
143 mltmt\\r
144 myamy\\r
145 nauna\\r
146 nobnb\\r
147 ndend\\r
148 nepne\\r
149 ndong\\r
150 nldnl\\r
151 nnonn\\r
152 norno\\r
153 nblnr\\r
154 navnv\\r
155 nyany\\r
156 ocioc\\r
157 ojioj\\r
158 ormom\\r
159 orior\\r
160 ossos\\r
161 panpa\\r
162 plipi\\r
163 polpl\\r
164 pusps\\r
165 porpt\\r
166 quequ\\r
167 rohrm\\r
168 runrn\\r
169 ronro\\r
170 rusru\\r
171 kinrw\\r
172 sansa\\r
173 srdsc\\r
174 sndsd\\r
175 smese\\r
176 sagsg\\r
177 sinsi\\r
178 slksk\\r
179 slvsl\\r
180 smosm\\r
181 snasn\\r
182 somso\\r
183 sqisq\\r
184 srpsr\\r
185 sswss\\r
186 sotst\\r
187 sunsu\\r
188 swesv\\r
189 swasw\\r
190 tamta\\r
191 telte\\r
192 tgktg\\r
193 thath\\r
194 tirti\\r
195 tuktk\\r
196 tgltl\\r
197 tsntn\\r
198 tonto\\r
199 turtr\\r
200 tsots\\r
201 tattt\\r
202 twitw\\r
203 tahty\\r
204 uigug\\r
205 ukruk\\r
206 urdur\\r
207 uzbuz\\r
208 venve\\r
209 vievi\\r
210 volvo\\r
211 wlnwa\\r
212 wolwo\\r
213 xhoxh\\r
214 yidyi\\r
215 yoryo\\r
216 zhaza\\r
217 zhozh\\r
218 zulzu\\r
219 ";\r
220 \r
221 /**\r
222   Converts upper case ASCII characters in an ASCII string to lower case ASCII \r
223   characters in an ASCII string.\r
224 \r
225   If a an ASCII character in Source is in the range 'A'..'Z', then it is converted \r
226   to an ASCII character in the range 'a'..'z' in Destination.  Otherwise, no \r
227   conversion is performed.  Length ASCII characters from Source are convertered and\r
228   stored in Destination.\r
229 \r
230   @param  Destination  An ASCII string to store the results of the conversion.\r
231   @param  Source       The source ASCII string of the conversion.\r
232   @param  Length       The number of ASCII characters to convert.\r
233 \r
234 **/\r
235 VOID\r
236 EFIAPI\r
237 InternalLanguageLibToLower (\r
238   OUT CHAR8        *Destination,\r
239   IN  CONST CHAR8  *Source,\r
240   IN  UINTN        Length\r
241   )\r
242 {\r
243   for (; Length > 0; Length--, Destination++, Source++) {\r
244     *Destination = (CHAR8)((*Source >= 'A' && *Source <= 'Z') ? *Source + ('a' - 'A') : *Source);\r
245   }\r
246 }\r
247 \r
248 /**\r
249   Convert an ISO 639-2 language code to a RFC 4646 language code.\r
250   If the ISO 639-2 language code has a corresponding ISO 639-1 code, then the ISO 639-1\r
251   code is returned. Else the original ISO 639-2 code is returned. The returned RFC 4646\r
252   language code is composed of only a primary language subtag.\r
253 \r
254   If Iso639Language is NULL, then ASSERT.\r
255   If Rfc4646Language is NULL, then ASSERT.\r
256 \r
257   @param[out] Rfc4646Language  Pointers to a buffer large enough for an ASCII string\r
258                                which reprsents a RFC 4646 language code containging only\r
259                                either a ISO 639-1 or ISO 639-2 primary language subtag.\r
260                                This string is Null-terminated.\r
261   @param[in]  Iso639Language   Pointer to a 3-letter ASCII string which represents\r
262                                an ISO 639-2 language code. This string is not required\r
263                                to be Null-terminated.\r
264 \r
265   @retval TRUE                 The ISO 639-2 language code was converted to a ISO 639-1 code.\r
266   @retval FALSE                The language code does not have corresponding ISO 639-1 code.\r
267 \r
268 **/\r
269 BOOLEAN\r
270 EFIAPI\r
271 ConvertIso639ToRfc4646 (\r
272   OUT CHAR8        *Rfc4646Language,\r
273   IN  CONST CHAR8  *Iso639Language\r
274   )\r
275 {\r
276   CONST CHAR8  *Match;\r
277   \r
278   ASSERT (Iso639Language != NULL);\r
279   ASSERT (Rfc4646Language != NULL);\r
280 \r
281   //\r
282   // Convert first 3 characters of Iso639Language to lower case ASCII characters in Rfc4646Language\r
283   //\r
284   InternalLanguageLibToLower (Rfc4646Language, Iso639Language, 3);\r
285   Rfc4646Language[3] = '\0';\r
286 \r
287   Match = mIso639ToRfc4646ConversionTable;\r
288   do {\r
289     Match = AsciiStrStr (Match, Rfc4646Language);\r
290     if (Match == NULL) {\r
291       return FALSE;\r
292     }\r
293     if (((Match - mIso639ToRfc4646ConversionTable) % 5) == 0) {\r
294       break;\r
295     }\r
296     ++Match;\r
297   } while (TRUE);\r
298   Rfc4646Language[0] = Match[3];\r
299   Rfc4646Language[1] = Match[4];\r
300   Rfc4646Language[2] = '\0';\r
301   return TRUE;\r
302 }\r
303 \r
304 /**\r
305   Convert a RFC 4646 language code to an ISO 639-2 language code. The primary language\r
306   subtag of the RFC 4646 code must be either an ISO 639-1 or 639-2 code. If the primary\r
307   language subtag is an ISO 639-1 code, then it is converted to its corresponding ISO 639-2\r
308   code (T code if applies). Else the ISO 639-2 code is returned.\r
309 \r
310   If Rfc4646Language is NULL, then ASSERT.\r
311   If Iso639Language is NULL, then ASSERT.\r
312 \r
313   @param[out] Iso639Language   Pointers to a buffer large enough for a 3-letter ASCII string\r
314                                which reprsents an ISO 639-2 language code. The string is Null-terminated.\r
315   @param[in]  Rfc4646Language  Pointer to a RFC 4646 language code string. This string is terminated\r
316                                by a NULL or a ';' character.\r
317 \r
318   @retval TRUE                 Language code converted successfully.\r
319   @retval FALSE                The RFC 4646 language code is invalid or unsupported.\r
320 \r
321 **/\r
322 BOOLEAN\r
323 EFIAPI\r
324 ConvertRfc4646ToIso639 (\r
325   OUT CHAR8        *Iso639Language,\r
326   IN  CONST CHAR8  *Rfc4646Language\r
327   )\r
328 {\r
329   CONST CHAR8 *Match;\r
330   \r
331   ASSERT (Rfc4646Language != NULL);\r
332   ASSERT (Iso639Language != NULL);\r
333 \r
334   //\r
335   // RFC 4646 language code check before determining \r
336   // if the primary language subtag is ISO 639-1 or 639-2 code\r
337   //\r
338   if (Rfc4646Language[0] == '\0' || Rfc4646Language[1] == '\0') {\r
339     return FALSE;\r
340   }\r
341   \r
342   //\r
343   // Check if the primary language subtag is ISO 639-1 code\r
344   //\r
345   if (Rfc4646Language[2] == ';' || Rfc4646Language[2] == '-' || Rfc4646Language[2] == '\0') {\r
346     //\r
347     // Convert first 2 characters of Rfc4646Language to lower case ASCII characters in Iso639Language\r
348     //\r
349     InternalLanguageLibToLower (Iso639Language, Rfc4646Language, 2);\r
350     //\r
351     // Convert ISO 639-1 code to ISO 639-2 code\r
352     //\r
353     Iso639Language[2] = '\0';\r
354     Match = mIso639ToRfc4646ConversionTable;\r
355     do {\r
356       Match = AsciiStrStr (Match, Iso639Language);\r
357       if (Match == NULL) {\r
358         return FALSE;\r
359       }\r
360       if (((Match - mIso639ToRfc4646ConversionTable) % 5) == 3) {\r
361         break;\r
362       }\r
363       ++Match;\r
364     } while (TRUE);\r
365     Rfc4646Language = Match - 3;\r
366   } else if (!(Rfc4646Language[3] == ';' || Rfc4646Language[3] == '-' || Rfc4646Language[3] == '\0')) {\r
367     return FALSE;\r
368   }\r
369   Iso639Language[0] = Rfc4646Language[0];\r
370   Iso639Language[1] = Rfc4646Language[1];\r
371   Iso639Language[2] = Rfc4646Language[2];\r
372   Iso639Language[3] = '\0';\r
373   return TRUE;  \r
374 }\r
375 \r
376 /**\r
377   Convert ISO 639-2 language codes to RFC 4646 codes and return the converted codes.\r
378   Caller is responsible for freeing the allocated buffer.\r
379 \r
380   If Iso639Languages is NULL, then ASSERT.\r
381 \r
382   @param[in] Iso639Languages  Pointers to a Null-terminated ISO 639-2 language codes string containing\r
383                               one or more ISO 639-2 3-letter language codes.\r
384   \r
385   @retval NULL                Invalid ISO 639-2 language code found.\r
386   @retval NULL                Out of memory.\r
387   @return                     Pointer to the allocate buffer containing the Null-terminated converted language codes string.\r
388                               This string is composed of one or more RFC4646 language codes each of which has only\r
389                               ISO 639-1 2-letter primary language subtag.\r
390 \r
391 **/\r
392 CHAR8 *\r
393 EFIAPI\r
394 ConvertLanguagesIso639ToRfc4646 (\r
395   IN CONST CHAR8  *Iso639Languages\r
396   )\r
397 {\r
398   UINTN  Length;\r
399   UINTN  Iso639Index;\r
400   UINTN  Rfc4646Index;\r
401   CHAR8  *Rfc4646Languages;\r
402   \r
403   ASSERT (Iso639Languages != NULL);\r
404   \r
405   //\r
406   // The length of ISO 639-2 lanugage codes string must be multiple of 3\r
407   //\r
408   Length = AsciiStrLen (Iso639Languages);\r
409   if (Length % 3 != 0) {\r
410     return NULL;\r
411   }\r
412   \r
413   //\r
414   // Allocate buffer for RFC 4646 language codes string\r
415   //\r
416   Rfc4646Languages = AllocatePool (Length + (Length / 3));\r
417   if (Rfc4646Languages == NULL) {\r
418     return NULL;\r
419   }\r
420 \r
421   for (Iso639Index = 0, Rfc4646Index = 0; Iso639Languages[Iso639Index] != '\0'; Iso639Index += 3) {\r
422     if (ConvertIso639ToRfc4646 (&Rfc4646Languages[Rfc4646Index], &Iso639Languages[Iso639Index])) {\r
423       Rfc4646Index += 2;\r
424     } else {\r
425       Rfc4646Index += 3;\r
426     }\r
427     Rfc4646Languages[Rfc4646Index++] = ';';\r
428   }\r
429   Rfc4646Languages[Rfc4646Index - 1] = '\0';\r
430   return Rfc4646Languages;\r
431 }\r
432 \r
433 /**\r
434   Convert RFC 4646 language codes to ISO 639-2 codes and return the converted codes.\r
435   The primary language subtag of the RFC 4646 code must be either an ISO 639-1 or 639-2 code.\r
436   Caller is responsible for freeing the allocated buffer.\r
437 \r
438   If Rfc4646Languages is NULL, then ASSERT.\r
439 \r
440   @param[in] Rfc4646Languages  Pointers to a Null-terminated RFC 4646 language codes string containing\r
441                                one or more RFC 4646 language codes.\r
442   \r
443   @retval NULL                 Invalid or unsupported RFC 4646 language code found.\r
444   @retval NULL                 Out of memory.\r
445   @return                      Pointer to the allocate buffer containing the Null-terminated converted language codes string.\r
446                                This string is composed of one or more ISO 639-2 language codes.\r
447 \r
448 **/\r
449 CHAR8 *\r
450 EFIAPI\r
451 ConvertLanguagesRfc4646ToIso639 (\r
452   IN CONST CHAR8  *Rfc4646Languages\r
453   )\r
454 {\r
455   UINTN  NumLanguages;\r
456   UINTN  Iso639Index;\r
457   UINTN  Rfc4646Index;\r
458   CHAR8  *Iso639Languages;\r
459 \r
460   ASSERT (Rfc4646Languages != NULL);\r
461 \r
462   //\r
463   // Determine the number of languages in the RFC 4646 language codes string\r
464   //\r
465   for (Rfc4646Index = 0, NumLanguages = 1; Rfc4646Languages[Rfc4646Index] != '\0'; Rfc4646Index++) {\r
466     if (Rfc4646Languages[Rfc4646Index] == ';') {\r
467       NumLanguages++;\r
468     }\r
469   }\r
470   \r
471   //\r
472   // Allocate buffer for ISO 639-2 language codes string\r
473   //\r
474   Iso639Languages = AllocateZeroPool (NumLanguages * 3 + 1);\r
475   if (Iso639Languages == NULL) {\r
476     return NULL;\r
477   }\r
478 \r
479   //\r
480   // Do the conversion for each RFC 4646 language code\r
481   //\r
482   for (Rfc4646Index = 0, Iso639Index = 0; Rfc4646Languages[Rfc4646Index] != '\0';) {\r
483     if (ConvertRfc4646ToIso639 (&Iso639Languages[Iso639Index], &Rfc4646Languages[Rfc4646Index])) {\r
484       Iso639Index += 3;\r
485     } else {\r
486       FreePool (Iso639Languages);\r
487       return NULL;\r
488     }\r
489     //\r
490     // Locate next language code\r
491     //\r
492     while (Rfc4646Languages[Rfc4646Index] != ';' && Rfc4646Languages[Rfc4646Index] != '\0') {\r
493       Rfc4646Index++;\r
494     }\r
495     if (Rfc4646Languages[Rfc4646Index] == ';') {\r
496       Rfc4646Index++;\r
497     }\r
498   }\r
499   Iso639Languages[Iso639Index] = '\0';\r
500   return Iso639Languages;\r
501 }\r