-/**@file\r
+/** @file\r
This file implements the protocol functions related to string package.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2012, 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
\r
#include "HiiDatabase.h"\r
\r
-typedef struct {\r
- CHAR8 *Iso639;\r
- CHAR8 *Rfc3066;\r
-} ISO639TORFC3066MAP;\r
-\r
-ISO639TORFC3066MAP Iso639ToRfc3066Map [] = {\r
- {"eng", "en-US"},\r
- {"fra", "fr-FR"},\r
-};\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
-CHAR8 *\r
-ConvertIso639ToRfc3066 (\r
- CHAR8 *Iso638Lang\r
- )\r
-{\r
- UINTN Index;\r
- CHAR8 AsciiLanguage[ISO_639_2_ENTRY_SIZE + 1];\r
- \r
- AsciiStrnCpy (AsciiLanguage, Iso638Lang, sizeof (AsciiLanguage));\r
- for (Index = 0; Index < ISO_639_2_ENTRY_SIZE + 1; Index ++) {\r
- if (AsciiLanguage [Index] == 0) {\r
- break;\r
- } else if (AsciiLanguage [Index] >= 'A' && AsciiLanguage [Index] <= 'Z') {\r
- AsciiLanguage [Index] = (CHAR8) (AsciiLanguage [Index] - 'A' + 'a');\r
- }\r
- }\r
-\r
- for (Index = 0; Index < sizeof (Iso639ToRfc3066Map) / sizeof (Iso639ToRfc3066Map[0]); Index++) {\r
- if (AsciiStrnCmp (AsciiLanguage, Iso639ToRfc3066Map[Index].Iso639, AsciiStrSize (AsciiLanguage)) == 0) {\r
- return Iso639ToRfc3066Map[Index].Rfc3066;\r
- }\r
- }\r
-\r
- return (CHAR8 *) NULL;\r
-}\r
-\r
-/**\r
- Convert language code from RFC3066 to ISO639-2.\r
-\r
- @param LanguageRfc3066 RFC3066 language code.\r
- @param LanguageIso639 ISO639-2 language code.\r
-\r
- @retval EFI_SUCCESS Language code converted.\r
- @retval EFI_NOT_FOUND Language code not found.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ConvertRfc3066LanguageToIso639Language (\r
- IN CHAR8 *LanguageRfc3066,\r
- OUT CHAR8 *LanguageIso639\r
- )\r
-{\r
- UINTN Index;\r
-\r
- if ((LanguageRfc3066[2] != '-') && (LanguageRfc3066[2] != 0)) {\r
- CopyMem (LanguageIso639, LanguageRfc3066, 3);\r
- return EFI_SUCCESS;\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
- }\r
- }\r
-\r
- return EFI_NOT_FOUND;\r
-}\r
-\r
-\r
-/**\r
- Convert language code from ISO639-2 to RFC3066 and return the converted language.\r
- Caller is responsible for freeing the allocated buffer.\r
-\r
- LanguageIso639 contain a single ISO639-2 code such as\r
- "eng" or "fra".\r
-\r
- If LanguageIso639 is NULL, then ASSERT.\r
- If LanguageRfc3066 is NULL, then ASSERT.\r
-\r
- @param LanguageIso639 ISO639-2 language code.\r
-\r
- @return the allocated buffer or NULL, if the language is not found.\r
-\r
-**/\r
-CHAR8*\r
-EFIAPI\r
-ConvertIso639LanguageToRfc3066Language (\r
- IN CONST CHAR8 *LanguageIso639\r
- )\r
-{\r
- UINTN Index;\r
- CHAR8 *Rfc3066Language;\r
- \r
- for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
- if (CompareMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3) == 0) {\r
- Rfc3066Language = AllocateZeroPool (3);\r
- if (Rfc3066Language != NULL) {\r
- Rfc3066Language = CopyMem (Rfc3066Language, &Iso639ToRfc3066ConversionTable[Index + 3], 2);\r
- }\r
- return Rfc3066Language;\r
- }\r
- }\r
-\r
- return NULL;\r
-}\r
-\r
-/**\r
- Get next language from language code list (with separator ';').\r
-\r
- If LangCode is NULL, then ASSERT.\r
- If Lang is NULL, then ASSERT.\r
-\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
-VOID\r
-EFIAPI\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
- Index = 0;\r
- StringPtr = *LangCode;\r
- while (StringPtr[Index] != 0 && StringPtr[Index] != ';') {\r
- Index++;\r
- }\r
-\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
Test if all of the characters in a string have corresponding font characters.\r
\r
Create or update the String given a new string and String ID.\r
\r
@param ThunkContext The Thunk Context.\r
- @param Rfc3066AsciiLanguage The RFC 3066 Language code in ASCII string format.\r
+ @param Rfc4646AsciiLanguage The RFC 4646 Language code in ASCII string format.\r
@param NewString The new string.\r
@param StringId The String ID. If StringId is 0, a new String Token\r
is created. Otherwise, the String Token StringId is \r
EFI_STATUS\r
UpdateString (\r
IN CONST HII_THUNK_CONTEXT *ThunkContext,\r
- IN CONST CHAR8 *Rfc3066AsciiLanguage,\r
+ IN CONST CHAR8 *Rfc4646AsciiLanguage,\r
IN CHAR16 *NewString,\r
IN OUT STRING_REF *StringId\r
)\r
{\r
EFI_STRING_ID NewStringId;\r
\r
- NewStringId = HiiSetString (ThunkContext->UefiHiiHandle, *StringId, NewString, Rfc3066AsciiLanguage);\r
+ NewStringId = HiiSetString (ThunkContext->UefiHiiHandle, *StringId, NewString, Rfc4646AsciiLanguage);\r
*StringId = NewStringId;\r
if (NewStringId == 0) {\r
//\r
identifier, indicating the language to print. A string consisting of\r
all spaces indicates that the string is applicable to all languages.\r
@param Handle The handle of the language pack to which the string is to be added.\r
- @param Token The string token assigned to the string.\r
+ @param Reference The string token assigned to the string.\r
@param NewString The string to be added.\r
\r
\r
@retval EFI_INVALID_PARAMETER The Handle was unknown. The string is not created or updated in the\r
the string package.\r
**/\r
-\r
EFI_STATUS\r
EFIAPI\r
HiiNewString (\r
EFI_STRING_ID LastStringId;\r
CHAR8 AsciiLanguage[ISO_639_2_ENTRY_SIZE + 1];\r
CHAR16 LanguageCopy[ISO_639_2_ENTRY_SIZE + 1];\r
- CHAR8 *Rfc3066AsciiLanguage;\r
+ CHAR8 *Rfc4646AsciiLanguage;\r
\r
LastStringId = (EFI_STRING_ID) 0;\r
StringId = (EFI_STRING_ID) 0;\r
- Rfc3066AsciiLanguage = NULL;\r
+ Rfc4646AsciiLanguage = NULL;\r
\r
if (Language != NULL) {\r
ZeroMem (AsciiLanguage, sizeof (AsciiLanguage));;\r
ZeroMem (LanguageCopy, sizeof (LanguageCopy));\r
CopyMem (LanguageCopy, Language, ISO_639_2_ENTRY_SIZE * sizeof (CHAR16));\r
UnicodeStrToAsciiStr (LanguageCopy, AsciiLanguage);\r
- Rfc3066AsciiLanguage = ConvertIso639ToRfc3066 (AsciiLanguage);\r
- ASSERT (Rfc3066AsciiLanguage != NULL);\r
+ Rfc4646AsciiLanguage = ConvertLanguagesIso639ToRfc4646 (AsciiLanguage);\r
+ ASSERT (Rfc4646AsciiLanguage != NULL);\r
}\r
\r
Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
if (CompareGuid (&TagGuid, &ThunkContext->TagGuid)) {\r
if (ThunkContext->SharingStringPack) {\r
StringId = *Reference;\r
- Status = UpdateString (ThunkContext, Rfc3066AsciiLanguage, NewString, &StringId);\r
+ Status = UpdateString (ThunkContext, Rfc4646AsciiLanguage, NewString, &StringId);\r
if (EFI_ERROR (Status)) {\r
break;\r
}\r
}\r
} else {\r
StringId = *Reference;\r
- Status = UpdateString (StringPackThunkContext, Rfc3066AsciiLanguage, NewString, &StringId);\r
+ Status = UpdateString (StringPackThunkContext, Rfc4646AsciiLanguage, NewString, &StringId);\r
}\r
\r
if (!EFI_ERROR (Status)) {\r
IN STRING_REF Token,\r
IN BOOLEAN Raw,\r
IN CHAR16 *LanguageString,\r
- IN OUT UINTN *BufferLengthTemp,\r
+ IN OUT UINTN *BufferLength,\r
OUT EFI_STRING StringBuffer\r
)\r
{\r
HII_THUNK_PRIVATE_DATA *Private;\r
CHAR8 *Iso639AsciiLanguage;\r
- CHAR8 *Rfc3066AsciiLanguage;\r
+ CHAR8 *Rfc4646AsciiLanguage;\r
CHAR8 *SupportedLanguages;\r
CHAR8 *PlatformLanguage;\r
CHAR8 *BestLanguage;\r
\r
Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
\r
- Iso639AsciiLanguage = NULL;\r
- Rfc3066AsciiLanguage = NULL;\r
+ Rfc4646AsciiLanguage = NULL;\r
+ SupportedLanguages = NULL;\r
+ PlatformLanguage = NULL;\r
+ Status = EFI_SUCCESS;\r
\r
if (LanguageString != NULL) {\r
Iso639AsciiLanguage = AllocateZeroPool (StrLen (LanguageString) + 1);\r
\r
//\r
// Caller of Framework HII Interface uses the Language Identification String defined \r
- // in Iso639. So map it to the Language Identifier defined in RFC3066.\r
+ // in Iso639. So map it to the Language Identifier defined in RFC4646.\r
//\r
- Rfc3066AsciiLanguage = ConvertIso639ToRfc3066 (Iso639AsciiLanguage);\r
+ Rfc4646AsciiLanguage = ConvertLanguagesIso639ToRfc4646 (Iso639AsciiLanguage);\r
+ FreePool (Iso639AsciiLanguage);\r
\r
//\r
- // If Rfc3066AsciiLanguage is NULL, more language mapping must be added to \r
- // Iso639ToRfc3066Map.\r
+ // If Rfc4646AsciiLanguage is NULL, more language mapping must be added to \r
+ // Iso639ToRfc4646Map.\r
//\r
- ASSERT (Rfc3066AsciiLanguage != NULL);\r
- \r
+ ASSERT (Rfc4646AsciiLanguage != NULL);\r
}\r
\r
UefiHiiHandle = FwHiiHandleToUefiHiiHandle (Private, Handle);\r
goto Done;\r
}\r
\r
- if (Rfc3066AsciiLanguage == NULL) {\r
- //\r
- // Get the languages that the package specified by HiiHandle supports\r
- //\r
- SupportedLanguages = HiiGetSupportedLanguages (UefiHiiHandle);\r
- if (SupportedLanguages == NULL) {\r
- goto Error2;\r
- }\r
-\r
- //\r
- // Get the current platform language setting\r
- //\r
- PlatformLanguage = GetEfiGlobalVariable (L"PlatformLang");\r
- if (PlatformLanguage == NULL) {\r
- goto Error1;\r
- }\r
-\r
- //\r
- // Get the best matching language from SupportedLanguages\r
- //\r
- BestLanguage = GetBestLanguage (\r
- SupportedLanguages, \r
- FALSE, // RFC 4646 mode\r
- PlatformLanguage, // Next highest priority\r
- SupportedLanguages, // Lowest priority \r
- NULL\r
- );\r
- if (BestLanguage == NULL) {\r
- FreePool (PlatformLanguage);\r
-Error1:\r
- FreePool (SupportedLanguages);\r
-Error2:\r
- Status = EFI_INVALID_PARAMETER;\r
- goto Done;\r
- }\r
+ //\r
+ // Get the languages that the package specified by HiiHandle supports\r
+ //\r
+ SupportedLanguages = HiiGetSupportedLanguages (UefiHiiHandle);\r
+ if (SupportedLanguages == NULL) {\r
+ goto Done;\r
+ }\r
\r
+ //\r
+ // Get the current platform language setting\r
+ //\r
+ GetEfiGlobalVariable2 (L"PlatformLang", (VOID**)&PlatformLanguage, NULL);\r
+\r
+ //\r
+ // Get the best matching language from SupportedLanguages\r
+ //\r
+ BestLanguage = GetBestLanguage (\r
+ SupportedLanguages, \r
+ FALSE, // RFC 4646 mode\r
+ (Rfc4646AsciiLanguage != NULL) ? Rfc4646AsciiLanguage : "", // Highest priority \r
+ (PlatformLanguage != NULL) ? PlatformLanguage : "", // Next highest priority\r
+ SupportedLanguages, // Lowest priority \r
+ NULL\r
+ );\r
+ if (BestLanguage != NULL) {\r
Status = mHiiStringProtocol->GetString (\r
mHiiStringProtocol,\r
BestLanguage,\r
UefiHiiHandle,\r
Token,\r
StringBuffer,\r
- BufferLengthTemp,\r
+ BufferLength,\r
NULL\r
);\r
FreePool (BestLanguage);\r
} else {\r
- Status = mHiiStringProtocol->GetString (\r
- mHiiStringProtocol,\r
- Rfc3066AsciiLanguage,\r
- UefiHiiHandle,\r
- Token,\r
- StringBuffer,\r
- BufferLengthTemp,\r
- NULL\r
- );\r
+ Status = EFI_INVALID_PARAMETER;\r
}\r
\r
Done:\r
- if (Iso639AsciiLanguage != NULL) {\r
- FreePool (Iso639AsciiLanguage);\r
+ if (Rfc4646AsciiLanguage != NULL) {\r
+ FreePool (Rfc4646AsciiLanguage);\r
+ }\r
+\r
+ if (SupportedLanguages != NULL) {\r
+ FreePool (SupportedLanguages);\r
+ }\r
+\r
+ if (PlatformLanguage != NULL) {\r
+ FreePool (PlatformLanguage);\r
}\r
- \r
return Status;\r
}\r
\r
@param This A pointer to the EFI_HII_PROTOCOL instance.\r
@param Handle The HII handle on which the string resides.\r
@param Token The string token assigned to the string.\r
- @param Raw If TRUE, the string is returned unedited in the internal storage format described\r
- above. If false, the string returned is edited by replacing <cr> with <space>\r
- and by removing special characters such as the <wide> prefix.\r
+ @param Index On input, the offset into the string where the line is to start.\r
+ On output, the index is updated to point to beyond the last character returned\r
+ in the call.\r
+ @param LineWidth The maximum width of the line in units of narrow glyphs.\r
@param LanguageString Pointer to a NULL-terminated string containing a single ISO 639-2 language\r
identifier, indicating the language to print. If the LanguageString is empty (starts\r
with a NULL), the default system language will be used to determine the language.\r
projects / mirror_edk2.git / blobdiff