/** @file\r
Language settings\r
\r
-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
#include "Language.h"\r
#include "FrontPage.h"\r
\r
-//\r
-// Lookup table of ISO639-2 3 character language codes to ISO 639-1 2 character language codes\r
-// Each entry is 5 CHAR8 values long. The first 3 CHAR8 values are the ISO 639-2 code.\r
-// The last 2 CHAR8 values are the ISO 639-1 code.\r
-//\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 Iso639ToRfc3066ConversionTable[] =\r
-"\\r
-aaraa\\r
-abkab\\r
-afraf\\r
-amham\\r
-araar\\r
-asmas\\r
-aymay\\r
-azeaz\\r
-bakba\\r
-belbe\\r
-benbn\\r
-bihbh\\r
-bisbi\\r
-bodbo\\r
-brebr\\r
-bulbg\\r
-catca\\r
-cescs\\r
-corkw\\r
-cosco\\r
-cymcy\\r
-danda\\r
-deude\\r
-dzodz\\r
-ellel\\r
-engen\\r
-epoeo\\r
-estet\\r
-euseu\\r
-faofo\\r
-fasfa\\r
-fijfj\\r
-finfi\\r
-frafr\\r
-fryfy\\r
-gaiga\\r
-gdhgd\\r
-glggl\\r
-grngn\\r
-gujgu\\r
-hauha\\r
-hebhe\\r
-hinhi\\r
-hrvhr\\r
-hunhu\\r
-hyehy\\r
-ikuiu\\r
-ileie\\r
-inaia\\r
-indid\\r
-ipkik\\r
-islis\\r
-itait\\r
-jawjw\\r
-jpnja\\r
-kalkl\\r
-kankn\\r
-kasks\\r
-katka\\r
-kazkk\\r
-khmkm\\r
-kinrw\\r
-kirky\\r
-korko\\r
-kurku\\r
-laolo\\r
-latla\\r
-lavlv\\r
-linln\\r
-litlt\\r
-ltzlb\\r
-malml\\r
-marmr\\r
-mkdmk\\r
-mlgmg\\r
-mltmt\\r
-molmo\\r
-monmn\\r
-mrimi\\r
-msams\\r
-myamy\\r
-nauna\\r
-nepne\\r
-nldnl\\r
-norno\\r
-ocioc\\r
-ormom\\r
-panpa\\r
-polpl\\r
-porpt\\r
-pusps\\r
-quequ\\r
-rohrm\\r
-ronro\\r
-runrn\\r
-rusru\\r
-sagsg\\r
-sansa\\r
-sinsi\\r
-slksk\\r
-slvsl\\r
-smise\\r
-smosm\\r
-snasn\\r
-sndsd\\r
-somso\\r
-sotst\\r
-spaes\\r
-sqisq\\r
-srpsr\\r
-sswss\\r
-sunsu\\r
-swasw\\r
-swesv\\r
-tamta\\r
-tattt\\r
-telte\\r
-tgktg\\r
-tgltl\\r
-thath\\r
-tsnts\\r
-tuktk\\r
-twitw\\r
-uigug\\r
-ukruk\\r
-urdur\\r
-uzbuz\\r
-vievi\\r
-volvo\\r
-wolwo\\r
-xhoxh\\r
-yidyi\\r
-zhaza\\r
-zhozh\\r
-zulzu\\r
-";\r
-\r
-#define NARROW_GLYPH_NUMBER 8\r
-#define WIDE_GLYPH_NUMBER 75\r
-\r
EFI_GUID mFontPackageGuid = {\r
0x78941450, 0x90ab, 0x4fb1, {0xb7, 0x5f, 0x58, 0x92, 0x14, 0xe2, 0x4a, 0xc}\r
};\r
\r
+#define NARROW_GLYPH_NUMBER 8\r
+#define WIDE_GLYPH_NUMBER 75\r
+\r
typedef struct {\r
///\r
/// This 4-bytes total array length is required by HiiAddPackages()\r
\r
HiiHandle = HiiAddPackages (\r
&mFontPackageGuid,\r
- mBdsImageHandle,\r
+ gImageHandle,\r
&mFontBin,\r
NULL\r
);\r
}\r
\r
/**\r
- Convert language code from RFC3066 to ISO639-2.\r
+ Get next language from language code list (with separator ';').\r
\r
- @param LanguageRfc3066 RFC3066 language code.\r
- @param LanguageIso639 ISO639-2 language code.\r
+ If LangCode is NULL, then ASSERT.\r
+ If Lang is NULL, then ASSERT.\r
\r
- @retval EFI_SUCCESS Language code converted.\r
- @retval EFI_NOT_FOUND Language code not found.\r
+ @param LangCode On input: point to first language in the list. On\r
+ output: point to next language in the list, or\r
+ NULL if no more language in the list.\r
+ @param Lang The first language in the list.\r
\r
**/\r
-EFI_STATUS\r
+VOID\r
EFIAPI\r
-ConvertRfc3066LanguageToIso639Language (\r
- IN CHAR8 *LanguageRfc3066,\r
- OUT CHAR8 *LanguageIso639\r
+GetNextLanguage (\r
+ IN OUT CHAR8 **LangCode,\r
+ OUT CHAR8 *Lang\r
)\r
{\r
UINTN Index;\r
+ CHAR8 *StringPtr;\r
+\r
+ ASSERT (LangCode != NULL);\r
+ ASSERT (*LangCode != NULL);\r
+ ASSERT (Lang != NULL);\r
\r
- if ((LanguageRfc3066[2] != '-') && (LanguageRfc3066[2] != 0)) {\r
- CopyMem (LanguageIso639, LanguageRfc3066, 3);\r
- return EFI_SUCCESS;\r
+ Index = 0;\r
+ StringPtr = *LangCode;\r
+ while (StringPtr[Index] != 0 && StringPtr[Index] != ';') {\r
+ Index++;\r
}\r
\r
- for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
- if (CompareMem (LanguageRfc3066, &Iso639ToRfc3066ConversionTable[Index + 3], 2) == 0) {\r
- CopyMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3);\r
- return EFI_SUCCESS;\r
+ CopyMem (Lang, StringPtr, Index);\r
+ Lang[Index] = 0;\r
+\r
+ if (StringPtr[Index] == ';') {\r
+ Index++;\r
+ }\r
+ *LangCode = StringPtr + Index;\r
+}\r
+\r
+/**\r
+ Check if lang is in supported language codes according to language string.\r
+\r
+ This code is used to check if lang is in in supported language codes. It can handle\r
+ RFC4646 and ISO639 language tags.\r
+ In ISO639 language tags, take 3-characters as a delimitation to find matched string.\r
+ In RFC4646 language tags, take semicolon as a delimitation to find matched string.\r
+\r
+ For example:\r
+ SupportedLang = "engfraengfra"\r
+ Iso639Language = TRUE\r
+ Lang = "eng", the return value is "TRUE", or\r
+ Lang = "chs", the return value is "FALSE".\r
+ Another example:\r
+ SupportedLang = "en;fr;en-US;fr-FR"\r
+ Iso639Language = FALSE\r
+ Lang = "en", the return value is "TRUE", or\r
+ Lang = "zh", the return value is "FALSE".\r
+\r
+ @param SupportedLang Platform supported language codes.\r
+ @param Lang Configured language.\r
+ @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646.\r
+\r
+ @retval TRUE lang is in supported language codes.\r
+ @retval FALSE lang is not in supported language codes.\r
+\r
+**/\r
+BOOLEAN\r
+IsLangInSupportedLangCodes(\r
+ IN CHAR8 *SupportedLang,\r
+ IN CHAR8 *Lang,\r
+ IN BOOLEAN Iso639Language\r
+ )\r
+{\r
+ UINTN Index;\r
+ UINTN CompareLength;\r
+ UINTN LanguageLength;\r
+\r
+ if (Iso639Language) {\r
+ CompareLength = ISO_639_2_ENTRY_SIZE;\r
+ for (Index = 0; Index < AsciiStrLen (SupportedLang); Index += CompareLength) {\r
+ if (AsciiStrnCmp (Lang, SupportedLang + Index, CompareLength) == 0) {\r
+ //\r
+ // Successfully find the Lang string in SupportedLang string.\r
+ //\r
+ return TRUE;\r
+ }\r
}\r
+ return FALSE;\r
+ } else {\r
+ //\r
+ // Compare RFC4646 language code\r
+ //\r
+ for (LanguageLength = 0; Lang[LanguageLength] != '\0'; LanguageLength++);\r
+\r
+ for (; *SupportedLang != '\0'; SupportedLang += CompareLength) {\r
+ //\r
+ // Skip ';' characters in SupportedLang\r
+ //\r
+ for (; *SupportedLang != '\0' && *SupportedLang == ';'; SupportedLang++);\r
+ //\r
+ // Determine the length of the next language code in SupportedLang\r
+ //\r
+ for (CompareLength = 0; SupportedLang[CompareLength] != '\0' && SupportedLang[CompareLength] != ';'; CompareLength++);\r
+\r
+ if ((CompareLength == LanguageLength) &&\r
+ (AsciiStrnCmp (Lang, SupportedLang, CompareLength) == 0)) {\r
+ //\r
+ // Successfully find the Lang string in SupportedLang string.\r
+ //\r
+ return TRUE;\r
+ }\r
+ }\r
+ return FALSE;\r
}\r
+}\r
+\r
+/**\r
+ Initialize Lang or PlatformLang variable, if Lang or PlatformLang variable is not found,\r
+ or it has been set to an unsupported value(not one of platform supported language codes),\r
+ set the default language code to it.\r
+\r
+ @param LangName Language name, L"Lang" or L"PlatformLang".\r
+ @param SupportedLang Platform supported language codes.\r
+ @param DefaultLang Default language code.\r
+ @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646,\r
+ TRUE for L"Lang" LangName or FALSE for L"PlatformLang" LangName.\r
+\r
+**/\r
+VOID\r
+InitializeLangVariable (\r
+ IN CHAR16 *LangName,\r
+ IN CHAR8 *SupportedLang,\r
+ IN CHAR8 *DefaultLang,\r
+ IN BOOLEAN Iso639Language\r
+ )\r
+{\r
+ CHAR8 *Lang;\r
\r
- return EFI_NOT_FOUND;\r
+ //\r
+ // Find current Lang or PlatformLang from EFI Variable.\r
+ //\r
+ GetEfiGlobalVariable2 (LangName, (VOID **) &Lang, NULL);\r
+ //\r
+ // If Lang or PlatformLang variable is not found,\r
+ // or it has been set to an unsupported value(not one of the supported language codes),\r
+ // set the default language code to it.\r
+ //\r
+ if ((Lang == NULL) || !IsLangInSupportedLangCodes (SupportedLang, Lang, Iso639Language)) {\r
+ //\r
+ // The default language code should be one of the supported language codes.\r
+ //\r
+ ASSERT (IsLangInSupportedLangCodes (SupportedLang, DefaultLang, Iso639Language));\r
+ BdsDxeSetVariableAndReportStatusCodeOnError (\r
+ LangName,\r
+ &gEfiGlobalVariableGuid,\r
+ EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
+ AsciiStrSize (DefaultLang),\r
+ DefaultLang\r
+ );\r
+ }\r
+\r
+ if (Lang != NULL) {\r
+ FreePool (Lang);\r
+ }\r
}\r
\r
/**\r
Determine the current language that will be used\r
based on language related EFI Variables.\r
\r
- @param LangCodesSettingRequired - If required to set LangCode variable\r
+ @param LangCodesSettingRequired - If required to set LangCodes variable\r
\r
**/\r
VOID\r
)\r
{\r
EFI_STATUS Status;\r
- UINTN Size;\r
- CHAR8 *Lang;\r
- CHAR8 LangCode[ISO_639_2_ENTRY_SIZE];\r
CHAR8 *LangCodes;\r
- CHAR8 *PlatformLang;\r
CHAR8 *PlatformLangCodes;\r
- UINTN Index;\r
- BOOLEAN Invalid;\r
\r
ExportFonts ();\r
\r
LangCodes = (CHAR8 *)PcdGetPtr (PcdUefiVariableDefaultLangCodes);\r
+ PlatformLangCodes = (CHAR8 *)PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes);\r
if (LangCodesSettingRequired) {\r
if (!FeaturePcdGet (PcdUefiVariableDefaultLangDeprecate)) {\r
//\r
- // UEFI 2.1 depricated this variable so we support turning it off\r
+ // UEFI 2.0 depricated this variable so we support turning it off\r
//\r
Status = gRT->SetVariable (\r
L"LangCodes",\r
&gEfiGlobalVariableGuid,\r
EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
- AsciiStrLen (LangCodes),\r
+ AsciiStrSize (LangCodes),\r
LangCodes\r
);\r
+ //\r
+ // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.\r
+ //\r
+ ASSERT_EFI_ERROR (Status);\r
}\r
\r
-\r
- PlatformLangCodes = (CHAR8 *)PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes);\r
Status = gRT->SetVariable (\r
L"PlatformLangCodes",\r
&gEfiGlobalVariableGuid,\r
AsciiStrSize (PlatformLangCodes),\r
PlatformLangCodes\r
);\r
- }\r
-\r
- if (!FeaturePcdGet (PcdUefiVariableDefaultLangDeprecate)) {\r
- //\r
- // UEFI 2.1 depricated this variable so we support turning it off\r
- //\r
-\r
- //\r
- // Find current LangCode from Lang NV Variable\r
- //\r
- Size = ISO_639_2_ENTRY_SIZE;\r
- Status = gRT->GetVariable (\r
- L"Lang",\r
- &gEfiGlobalVariableGuid,\r
- NULL,\r
- &Size,\r
- &LangCode\r
- );\r
- if (!EFI_ERROR (Status)) {\r
- Status = EFI_NOT_FOUND;\r
- for (Index = 0; LangCodes[Index] != 0; Index += ISO_639_2_ENTRY_SIZE) {\r
- if (CompareMem (&LangCodes[Index], LangCode, ISO_639_2_ENTRY_SIZE) == 0) {\r
- Status = EFI_SUCCESS;\r
- break;\r
- }\r
- }\r
- }\r
-\r
//\r
- // If we cannot get language code from Lang variable,\r
- // or LangCode cannot be found from language table,\r
- // set the mDefaultLangCode to Lang variable.\r
+ // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.\r
//\r
- if (EFI_ERROR (Status)) {\r
- Lang = (CHAR8 *)PcdGetPtr (PcdUefiVariableDefaultLang);\r
- Status = gRT->SetVariable (\r
- L"Lang",\r
- &gEfiGlobalVariableGuid,\r
- EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
- ISO_639_2_ENTRY_SIZE,\r
- Lang\r
- );\r
- }\r
+ ASSERT_EFI_ERROR (Status);\r
}\r
\r
- Invalid = FALSE;\r
- PlatformLang = BdsLibGetVariableAndSize (L"PlatformLang", &gEfiGlobalVariableGuid, &Size);\r
- if (PlatformLang != NULL) {\r
+ if (!FeaturePcdGet (PcdUefiVariableDefaultLangDeprecate)) {\r
//\r
- // Check Current PlatformLang value against PlatformLangCode. Need a library that is TBD\r
- // Set Invalid based on state of PlatformLang.\r
+ // UEFI 2.0 depricated this variable so we support turning it off\r
//\r
-\r
- FreePool (PlatformLang);\r
- } else {\r
- // No valid variable is set\r
- Invalid = TRUE;\r
- }\r
-\r
- if (Invalid) {\r
- PlatformLang = (CHAR8 *)PcdGetPtr (PcdUefiVariableDefaultPlatformLang);\r
- Status = gRT->SetVariable (\r
- L"PlatformLang",\r
- &gEfiGlobalVariableGuid,\r
- EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
- AsciiStrSize (PlatformLang),\r
- PlatformLang\r
- );\r
+ InitializeLangVariable (L"Lang", LangCodes, (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultLang), TRUE);\r
}\r
+ InitializeLangVariable (L"PlatformLang", PlatformLangCodes, (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLang), FALSE);\r
}\r
projects / mirror_edk2.git / blobdiff