[mirror_edk2.git] / MdePkg / Library / HiiLib / HiiString.c

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