]>
Commit | Line | Data |
---|---|---|
f4cd24da RN |
1 | /** @file\r |
2 | Language settings\r | |
3 | \r | |
4 | Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>\r | |
5 | 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 | #include "Bds.h"\r | |
16 | #define ISO_639_2_ENTRY_SIZE 3\r | |
17 | \r | |
18 | /**\r | |
19 | Check if lang is in supported language codes according to language string.\r | |
20 | \r | |
21 | This code is used to check if lang is in in supported language codes. It can handle\r | |
22 | RFC4646 and ISO639 language tags.\r | |
23 | In ISO639 language tags, take 3-characters as a delimitation to find matched string.\r | |
24 | In RFC4646 language tags, take semicolon as a delimitation to find matched string.\r | |
25 | \r | |
26 | For example:\r | |
27 | SupportedLang = "engfraengfra"\r | |
28 | Iso639Language = TRUE\r | |
29 | Lang = "eng", the return value is "TRUE", or\r | |
30 | Lang = "chs", the return value is "FALSE".\r | |
31 | Another example:\r | |
32 | SupportedLang = "en;fr;en-US;fr-FR"\r | |
33 | Iso639Language = FALSE\r | |
34 | Lang = "en", the return value is "TRUE", or\r | |
35 | Lang = "zh", the return value is "FALSE".\r | |
36 | \r | |
37 | @param SupportedLang Platform supported language codes.\r | |
38 | @param Lang Configured language.\r | |
39 | @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646.\r | |
40 | \r | |
41 | @retval TRUE lang is in supported language codes.\r | |
42 | @retval FALSE lang is not in supported language codes.\r | |
43 | \r | |
44 | **/\r | |
45 | BOOLEAN\r | |
46 | IsLangInSupportedLangCodes(\r | |
47 | IN CHAR8 *SupportedLang,\r | |
48 | IN CHAR8 *Lang,\r | |
49 | IN BOOLEAN Iso639Language\r | |
50 | ) \r | |
51 | {\r | |
52 | UINTN Index;\r | |
53 | UINTN CompareLength;\r | |
54 | UINTN LanguageLength;\r | |
55 | \r | |
56 | if (Iso639Language) {\r | |
57 | CompareLength = ISO_639_2_ENTRY_SIZE;\r | |
58 | for (Index = 0; Index < AsciiStrLen (SupportedLang); Index += CompareLength) {\r | |
59 | if (AsciiStrnCmp (Lang, SupportedLang + Index, CompareLength) == 0) {\r | |
60 | //\r | |
61 | // Successfully find the Lang string in SupportedLang string.\r | |
62 | //\r | |
63 | return TRUE;\r | |
64 | }\r | |
65 | }\r | |
66 | return FALSE;\r | |
67 | } else {\r | |
68 | //\r | |
69 | // Compare RFC4646 language code\r | |
70 | //\r | |
71 | for (LanguageLength = 0; Lang[LanguageLength] != '\0'; LanguageLength++);\r | |
72 | \r | |
73 | for (; *SupportedLang != '\0'; SupportedLang += CompareLength) {\r | |
74 | //\r | |
75 | // Skip ';' characters in SupportedLang\r | |
76 | //\r | |
77 | for (; *SupportedLang != '\0' && *SupportedLang == ';'; SupportedLang++);\r | |
78 | //\r | |
79 | // Determine the length of the next language code in SupportedLang\r | |
80 | //\r | |
81 | for (CompareLength = 0; SupportedLang[CompareLength] != '\0' && SupportedLang[CompareLength] != ';'; CompareLength++);\r | |
82 | \r | |
83 | if ((CompareLength == LanguageLength) && \r | |
84 | (AsciiStrnCmp (Lang, SupportedLang, CompareLength) == 0)) {\r | |
85 | //\r | |
86 | // Successfully find the Lang string in SupportedLang string.\r | |
87 | //\r | |
88 | return TRUE;\r | |
89 | }\r | |
90 | }\r | |
91 | return FALSE;\r | |
92 | }\r | |
93 | }\r | |
94 | \r | |
95 | /**\r | |
96 | Initialize Lang or PlatformLang variable, if Lang or PlatformLang variable is not found,\r | |
97 | or it has been set to an unsupported value(not one of platform supported language codes),\r | |
98 | set the default language code to it.\r | |
99 | \r | |
100 | @param LangName Language name, L"Lang" or L"PlatformLang".\r | |
101 | @param SupportedLang Platform supported language codes.\r | |
102 | @param DefaultLang Default language code.\r | |
103 | @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646,\r | |
104 | TRUE for L"Lang" LangName or FALSE for L"PlatformLang" LangName.\r | |
105 | \r | |
106 | **/\r | |
107 | VOID\r | |
108 | InitializeLangVariable (\r | |
109 | IN CHAR16 *LangName,\r | |
110 | IN CHAR8 *SupportedLang,\r | |
111 | IN CHAR8 *DefaultLang, \r | |
112 | IN BOOLEAN Iso639Language\r | |
113 | )\r | |
114 | {\r | |
115 | CHAR8 *Lang;\r | |
116 | \r | |
117 | //\r | |
118 | // Find current Lang or PlatformLang from EFI Variable.\r | |
119 | //\r | |
120 | GetEfiGlobalVariable2 (LangName, (VOID **) &Lang, NULL);\r | |
121 | \r | |
122 | //\r | |
123 | // If Lang or PlatformLang variable is not found,\r | |
124 | // or it has been set to an unsupported value(not one of the supported language codes),\r | |
125 | // set the default language code to it.\r | |
126 | //\r | |
127 | if ((Lang == NULL) || !IsLangInSupportedLangCodes (SupportedLang, Lang, Iso639Language)) {\r | |
128 | //\r | |
129 | // The default language code should be one of the supported language codes.\r | |
130 | //\r | |
131 | ASSERT (IsLangInSupportedLangCodes (SupportedLang, DefaultLang, Iso639Language));\r | |
132 | BdsDxeSetVariableAndReportStatusCodeOnError (\r | |
133 | LangName,\r | |
134 | &gEfiGlobalVariableGuid,\r | |
135 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
136 | AsciiStrSize (DefaultLang),\r | |
137 | DefaultLang\r | |
138 | );\r | |
139 | }\r | |
140 | \r | |
141 | if (Lang != NULL) {\r | |
142 | FreePool (Lang);\r | |
143 | }\r | |
144 | }\r | |
145 | \r | |
146 | /**\r | |
147 | Determine the current language that will be used\r | |
148 | based on language related EFI Variables.\r | |
149 | \r | |
150 | @param LangCodesSettingRequired - If required to set LangCodes variable\r | |
151 | \r | |
152 | **/\r | |
153 | VOID\r | |
154 | InitializeLanguage (\r | |
155 | BOOLEAN LangCodesSettingRequired\r | |
156 | )\r | |
157 | {\r | |
158 | EFI_STATUS Status;\r | |
159 | CHAR8 *LangCodes;\r | |
160 | CHAR8 *PlatformLangCodes;\r | |
161 | \r | |
162 | LangCodes = (CHAR8 *)PcdGetPtr (PcdUefiVariableDefaultLangCodes);\r | |
163 | PlatformLangCodes = (CHAR8 *)PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes);\r | |
164 | if (LangCodesSettingRequired) {\r | |
165 | if (!FeaturePcdGet (PcdUefiVariableDefaultLangDeprecate)) {\r | |
166 | //\r | |
167 | // UEFI 2.1 depricated this variable so we support turning it off\r | |
168 | //\r | |
169 | Status = gRT->SetVariable (\r | |
170 | L"LangCodes",\r | |
171 | &gEfiGlobalVariableGuid,\r | |
172 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
173 | AsciiStrSize (LangCodes),\r | |
174 | LangCodes\r | |
175 | );\r | |
176 | //\r | |
177 | // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.\r | |
178 | //\r | |
179 | ASSERT_EFI_ERROR(Status);\r | |
180 | }\r | |
181 | \r | |
182 | Status = gRT->SetVariable (\r | |
183 | L"PlatformLangCodes",\r | |
184 | &gEfiGlobalVariableGuid,\r | |
185 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
186 | AsciiStrSize (PlatformLangCodes),\r | |
187 | PlatformLangCodes\r | |
188 | );\r | |
189 | //\r | |
190 | // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.\r | |
191 | //\r | |
192 | ASSERT_EFI_ERROR(Status);\r | |
193 | }\r | |
194 | \r | |
195 | if (!FeaturePcdGet (PcdUefiVariableDefaultLangDeprecate)) {\r | |
196 | //\r | |
197 | // UEFI 2.1 depricated this variable so we support turning it off\r | |
198 | //\r | |
199 | InitializeLangVariable (L"Lang", LangCodes, (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultLang), TRUE);\r | |
200 | }\r | |
201 | InitializeLangVariable (L"PlatformLang", PlatformLangCodes, (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLang), FALSE);\r | |
202 | }\r |