[mirror_edk2.git] / MdeModulePkg / Library / UefiHiiLib / 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
//\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
/**\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;\r
\r
  ASSERT (String != NULL);\r
  ASSERT (StringId != NULL);\r
\r
  Status = EFI_SUCCESS;\r
\r
  Languages = HiiLibGetSupportedLanguages (PackageList);\r
  ASSERT (Languages != NULL);\r
  //\r
  // Allocate working buffer to contain substring of Languages.\r
  //\r
  Lang = AllocatePool (AsciiStrSize (Languages));\r
  ASSERT (Lang != NULL);\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 (Lang);\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;\r
\r
  ASSERT (IsHiiHandleRegistered (PackageList));\r
\r
  Status = EFI_SUCCESS;\r
\r
  Languages = HiiLibGetSupportedLanguages (PackageList);\r
  ASSERT (Languages != NULL);\r
\r
  //\r
  // Allocate working buffer to contain substring of Languages.\r
  //\r
  Lang = AllocatePool (AsciiStrSize (Languages));\r
  ASSERT (Lang != 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 (Lang);\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 (HiiHandleBuffer == NULL) {\r
    return EFI_NOT_FOUND;\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
  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       *CurrentLang;\r
  CHAR8       *BestLanguage;\r
\r
  ASSERT (StringSize != NULL);\r
  ASSERT (!(*StringSize != 0 && String == NULL));\r
  ASSERT (IsHiiHandleRegistered (PackageList));\r
\r
  Languages = HiiLibGetSupportedLanguages (PackageList);\r
  ASSERT (Languages != NULL);\r
\r
  CurrentLang = GetEfiGlobalVariable (L"PlatformLang");\r
  \r
  Status = EFI_NOT_FOUND;\r
  BestLanguage = GetBestLanguage (\r
                   Languages,\r
                   FALSE,\r
                   (CurrentLang != NULL) ? CurrentLang : "",\r
                   (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLang),\r
                   Languages,\r
                   NULL\r
                   );\r
  if (BestLanguage != NULL ) {\r
     Status = mHiiStringProt->GetString (\r
                               mHiiStringProt,\r
                               BestLanguage,\r
                               PackageList,\r
                               StringId,\r
                               String,\r
                               StringSize,\r
                               NULL\r
                               );\r
     FreePool (BestLanguage);\r
  }\r
  if (CurrentLang != NULL) {\r
    FreePool (CurrentLang);\r
  }\r
  FreePool (Languages);\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
  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
  \r
  for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
    if (CompareMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3) == 0) {\r
      return AllocateCopyPool (2, &Iso639ToRfc3066ConversionTable[Index + 3]);\r
    }\r
  }\r
\r
  return NULL;\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;\r
  CHAR8       LangIso639[ISO_639_2_ENTRY_SIZE];\r
  UINTN       LanguageSize;\r
  EFI_STATUS  Status;\r
\r
  LanguageSize = AsciiStrSize (SupportedLanguages);\r
  ReturnValue = AllocateZeroPool (LanguageSize);\r
  if (ReturnValue == NULL) {\r
    return ReturnValue;\r
  }\r
\r
  //\r
  // Allocate working buffer to contain substring in SupportedLanguages;\r
  //\r
  LangRfc3066 = AllocatePool (LanguageSize);\r
  if (LangRfc3066 == NULL) {\r
    FreePool (ReturnValue);\r
    return NULL;\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
  FreePool (LangRfc3066);\r
  return ReturnValue;\r
}\r
\r
\r
Commit	Line	Data
08e4b3cf	1	/** @file\r
	2	HII Library implementation that uses DXE protocols and services.\r
	3	\r
	4	Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
	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
	17	\r
	18	\r
	19	//\r
	20	// Lookup table of ISO639-2 3 character language codes to ISO 639-1 2 character language codes\r
	21	// Each entry is 5 CHAR8 values long. The first 3 CHAR8 values are the ISO 639-2 code.\r
	22	// The last 2 CHAR8 values are the ISO 639-1 code.\r
	23	//\r
	24	GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 Iso639ToRfc3066ConversionTable[] =\r
	25	"\\r
	26	aaraa\\r
	27	abkab\\r
	28	afraf\\r
	29	amham\\r
	30	araar\\r
	31	asmas\\r
	32	aymay\\r
	33	azeaz\\r
	34	bakba\\r
	35	belbe\\r
	36	benbn\\r
	37	bihbh\\r
	38	bisbi\\r
	39	bodbo\\r
	40	brebr\\r
	41	bulbg\\r
	42	catca\\r
	43	cescs\\r
	44	corkw\\r
	45	cosco\\r
	46	cymcy\\r
	47	danda\\r
	48	deude\\r
	49	dzodz\\r
	50	ellel\\r
	51	engen\\r
	52	epoeo\\r
	53	estet\\r
	54	euseu\\r
	55	faofo\\r
	56	fasfa\\r
	57	fijfj\\r
	58	finfi\\r
	59	frafr\\r
	60	fryfy\\r
	61	gaiga\\r
	62	gdhgd\\r
	63	glggl\\r
	64	grngn\\r
65	gujgu\\r
66	hauha\\r
67	hebhe\\r
68	hinhi\\r
69	hrvhr\\r
70	hunhu\\r
71	hyehy\\r
72	ikuiu\\r
73	ileie\\r
74	inaia\\r
75	indid\\r
76	ipkik\\r
77	islis\\r
78	itait\\r
79	jawjw\\r
80	jpnja\\r
81	kalkl\\r
82	kankn\\r
83	kasks\\r
84	katka\\r
85	kazkk\\r
86	khmkm\\r
87	kinrw\\r
88	kirky\\r
89	korko\\r
90	kurku\\r
91	laolo\\r
92	latla\\r
93	lavlv\\r
94	linln\\r
95	litlt\\r
96	ltzlb\\r
97	malml\\r
98	marmr\\r
99	mkdmk\\r
100	mlgmg\\r
101	mltmt\\r
102	molmo\\r
103	monmn\\r
104	mrimi\\r
105	msams\\r
106	myamy\\r
107	nauna\\r
108	nepne\\r
109	nldnl\\r
110	norno\\r
111	ocioc\\r
112	ormom\\r
113	panpa\\r
114	polpl\\r
115	porpt\\r
116	pusps\\r
117	quequ\\r
118	rohrm\\r
119	ronro\\r
120	runrn\\r
121	rusru\\r
122	sagsg\\r
123	sansa\\r
124	sinsi\\r
125	slksk\\r
126	slvsl\\r
127	smise\\r
128	smosm\\r
129	snasn\\r
130	sndsd\\r
131	somso\\r
132	sotst\\r
133	spaes\\r
134	sqisq\\r
135	srpsr\\r
136	sswss\\r
137	sunsu\\r
138	swasw\\r
139	swesv\\r
140	tamta\\r
141	tattt\\r
142	telte\\r
143	tgktg\\r
144	tgltl\\r
145	thath\\r
146	tsnts\\r
147	tuktk\\r
148	twitw\\r
149	uigug\\r
150	ukruk\\r
151	urdur\\r
152	uzbuz\\r
153	vievi\\r
154	volvo\\r
155	wolwo\\r
156	xhoxh\\r
157	yidyi\\r
158	zhaza\\r
159	zhozh\\r
160	zulzu\\r
161	";\r
162	\r
163	\r
164	\r
165	/**\r
166	This function adds the string into String Package of each language\r
167	supported by the package list.\r
168	\r
169	If String is NULL, then ASSERT.\r
170	If StringId is NULL, the ASSERT.\r
171	If PackageList could not be found in the default HII database, then ASSERT.\r
172	\r
173	@param PackageList Handle of the package list where this string will\r
174	be added.\r
175	@param StringId On return, contains the new strings id, which is\r
176	unique within PackageList.\r
177	@param String Points to the new null-terminated string.\r
178	\r
179	@retval EFI_SUCCESS The new string was added successfully.\r
180	@retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.\r
181	\r
182	**/\r
183	EFI_STATUS\r
184	EFIAPI\r
185	HiiLibNewString (\r
186	IN EFI_HII_HANDLE PackageList,\r
187	OUT EFI_STRING_ID *StringId,\r
188	IN CONST EFI_STRING String\r
189	)\r
190	{\r
191	EFI_STATUS Status;\r
192	CHAR8 *Languages;\r
193	CHAR8 *LangStrings;\r
ea7cd3ec	194	CHAR8 *Lang;\r
08e4b3cf	195	\r
	196	ASSERT (String != NULL);\r
	197	ASSERT (StringId != NULL);\r
	198	\r
	199	Status = EFI_SUCCESS;\r
	200	\r
	201	Languages = HiiLibGetSupportedLanguages (PackageList);\r
6cd8bf64	202	ASSERT (Languages != NULL);\r
ea7cd3ec	203	//\r
	204	// Allocate working buffer to contain substring of Languages.\r
	205	//\r
	206	Lang = AllocatePool (AsciiStrSize (Languages));\r
	207	ASSERT (Lang != NULL);\r
08e4b3cf	208	\r
	209	LangStrings = Languages;\r
	210	while (*LangStrings != 0) {\r
	211	HiiLibGetNextLanguage (&LangStrings, Lang);\r
	212	\r
	213	//\r
	214	// For each language supported by the package,\r
	215	// a string token is created.\r
	216	//\r
	217	Status = mHiiStringProt->NewString (\r
	218	mHiiStringProt,\r
	219	PackageList,\r
	220	StringId,\r
	221	Lang,\r
	222	NULL,\r
	223	String,\r
	224	NULL\r
	225	);\r
	226	if (EFI_ERROR (Status)) {\r
	227	break;\r
	228	}\r
	229	}\r
	230	\r
ea7cd3ec	231	FreePool (Lang);\r
08e4b3cf	232	FreePool (Languages);\r
	233	\r
	234	return Status;\r
	235	\r
	236	}\r
	237	\r
	238	\r
	239	/**\r
	240	This function update the specified string in String Package of each language\r
	241	supported by the package list.\r
	242	\r
	243	If String is NULL, then ASSERT.\r
	244	If PackageList could not be found in the default HII database, then ASSERT.\r
	245	If StringId is not found in PackageList, then ASSERT.\r
	246	\r
	247	@param PackageList Handle of the package list where this string will\r
	248	be added.\r
	249	@param StringId Ths String Id to be updated.\r
	250	@param String Points to the new null-terminated string.\r
	251	\r
	252	@retval EFI_SUCCESS The new string was added successfully.\r
	253	@retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.\r
	254	\r
	255	**/\r
	256	EFI_STATUS\r
	257	EFIAPI\r
	258	HiiLibSetString (\r
	259	IN EFI_HII_HANDLE PackageList,\r
	260	IN EFI_STRING_ID StringId,\r
	261	IN CONST EFI_STRING String\r
	262	)\r
	263	{\r
	264	EFI_STATUS Status;\r
	265	CHAR8 *Languages;\r
	266	CHAR8 *LangStrings;\r
ea7cd3ec	267	CHAR8 *Lang;\r
08e4b3cf	268	\r
	269	ASSERT (IsHiiHandleRegistered (PackageList));\r
	270	\r
	271	Status = EFI_SUCCESS;\r
	272	\r
	273	Languages = HiiLibGetSupportedLanguages (PackageList);\r
	274	ASSERT (Languages != NULL);\r
	275	\r
ea7cd3ec	276	//\r
	277	// Allocate working buffer to contain substring of Languages.\r
	278	//\r
	279	Lang = AllocatePool (AsciiStrSize (Languages));\r
	280	ASSERT (Lang != NULL);\r
	281	\r
08e4b3cf	282	LangStrings = Languages;\r
	283	while (*LangStrings != 0) {\r
	284	HiiLibGetNextLanguage (&LangStrings, Lang);\r
	285	\r
	286	//\r
	287	// For each language supported by the package,\r
	288	// the string is updated.\r
	289	//\r
	290	Status = mHiiStringProt->SetString (\r
	291	mHiiStringProt,\r
	292	PackageList,\r
	293	StringId,\r
	294	Lang,\r
	295	String,\r
	296	NULL\r
	297	);\r
	298	if (EFI_ERROR (Status)) {\r
	299	break;\r
	300	}\r
	301	}\r
	302	\r
ea7cd3ec	303	FreePool (Lang);\r
08e4b3cf	304	FreePool (Languages);\r
	305	\r
	306	return Status;\r
	307	}\r
	308	\r
	309	\r
	310	/**\r
	311	Get the string given the StringId and String package Producer's Guid. The caller\r
	312	is responsible to free the *String.\r
	313	\r
	314	If PackageList with the matching ProducerGuid is not found, then ASSERT.\r
	315	If PackageList with the matching ProducerGuid is found but no String is\r
	316	specified by StringId is found, then ASSERT.\r
	317	\r
	318	@param ProducerGuid The Guid of String package list.\r
	319	@param StringId The String ID.\r
	320	@param String The output string.\r
	321	\r
	322	@retval EFI_SUCCESS Operation is successful.\r
	323	@retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.\r
	324	\r
	325	**/\r
	326	EFI_STATUS\r
	327	EFIAPI\r
	328	HiiLibGetStringFromToken (\r
	329	IN EFI_GUID *ProducerGuid,\r
	330	IN EFI_STRING_ID StringId,\r
	331	OUT EFI_STRING *String\r
	332	)\r
	333	{\r
	334	EFI_STATUS Status;\r
	335	UINTN Index;\r
	336	UINTN HandleBufferLen;\r
	337	EFI_HII_HANDLE *HiiHandleBuffer;\r
	338	EFI_GUID Guid;\r
	339	\r
	340	Status = HiiLibGetHiiHandles (&HandleBufferLen, &HiiHandleBuffer);\r
4a1102c9	341	if (HiiHandleBuffer == NULL) {\r
4a1102c9	342	return EFI_NOT_FOUND;\r
08e4b3cf	343	}\r
	344	for (Index = 0; Index < (HandleBufferLen / sizeof (EFI_HII_HANDLE)); Index++) {\r
	345	Status = HiiLibExtractGuidFromHiiHandle (HiiHandleBuffer[Index], &Guid);\r
	346	if (EFI_ERROR(Status)) {\r
	347	return Status;\r
	348	}\r
	349	if (CompareGuid (&Guid, ProducerGuid)) {\r
	350	break;\r
	351	}\r
	352	}\r
	353	\r
	354	if (Index >= (HandleBufferLen / sizeof (EFI_HII_HANDLE))) {\r
	355	//\r
	356	// If PackageList with the matching ProducerGuid is not found, then ASSERT.\r
	357	//\r
	358	ASSERT (FALSE);\r
	359	Status = EFI_NOT_FOUND;\r
	360	goto Out;\r
	361	}\r
	362	\r
	363	Status = HiiLibGetStringFromHandle (HiiHandleBuffer[Index], StringId, String);\r
	364	\r
	365	Out:\r
4a1102c9	366	FreePool (HiiHandleBuffer);\r
4a1102c9	367	\r
08e4b3cf	368	return Status;\r
	369	}\r
	370	\r
	371	/**\r
	372	This function try to retrieve string from String package of current language.\r
	373	If fails, it try to retrieve string from String package of first language it support.\r
	374	\r
	375	If StringSize is NULL, then ASSERT.\r
	376	If String is NULL and *StringSize is not 0, then ASSERT.\r
	377	If PackageList could not be found in the default HII database, then ASSERT.\r
	378	If StringId is not found in PackageList, then ASSERT.\r
	379	\r
	380	@param PackageList The package list in the HII database to search for\r
	381	the specified string.\r
	382	@param StringId The string's id, which is unique within\r
	383	PackageList.\r
	384	@param String Points to the new null-terminated string.\r
	385	@param StringSize On entry, points to the size of the buffer pointed\r
	386	to by String, in bytes. On return, points to the\r
	387	length of the string, in bytes.\r
	388	\r
	389	@retval EFI_SUCCESS The string was returned successfully.\r
	390	@retval EFI_NOT_FOUND The string specified by StringId is not available.\r
	391	@retval EFI_BUFFER_TOO_SMALL The buffer specified by StringLength is too small\r
	392	to hold the string.\r
	393	\r
	394	**/\r
	395	EFI_STATUS\r
	396	EFIAPI\r
	397	HiiLibGetString (\r
	398	IN EFI_HII_HANDLE PackageList,\r
	399	IN EFI_STRING_ID StringId,\r
	400	OUT EFI_STRING String,\r
	401	IN OUT UINTN *StringSize\r
	402	)\r
	403	{\r
	404	EFI_STATUS Status;\r
	405	CHAR8 *Languages;\r
ea7cd3ec	406	CHAR8 *CurrentLang;\r
ea7cd3ec	407	CHAR8 *BestLanguage;\r
08e4b3cf	408	\r
	409	ASSERT (StringSize != NULL);\r
	410	ASSERT (!(*StringSize != 0 && String == NULL));\r
	411	ASSERT (IsHiiHandleRegistered (PackageList));\r
	412	\r
ea7cd3ec	413	Languages = HiiLibGetSupportedLanguages (PackageList);\r
ea7cd3ec	414	ASSERT (Languages != NULL);\r
08e4b3cf	415	\r
ea7cd3ec	416	CurrentLang = GetEfiGlobalVariable (L"PlatformLang");\r
	417	\r
	418	Status = EFI_NOT_FOUND;\r
	419	BestLanguage = GetBestLanguage (\r
	420	Languages,\r
	421	FALSE,\r
	422	(CurrentLang != NULL) ? CurrentLang : "",\r
	423	(CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLang),\r
	424	Languages,\r
	425	NULL\r
	426	);\r
	427	if (BestLanguage != NULL ) {\r
	428	Status = mHiiStringProt->GetString (\r
08e4b3cf	429	mHiiStringProt,\r
ea7cd3ec	430	BestLanguage,\r
08e4b3cf	431	PackageList,\r
	432	StringId,\r
	433	String,\r
	434	StringSize,\r
	435	NULL\r
	436	);\r
ea7cd3ec	437	FreePool (BestLanguage);\r
	438	}\r
	439	if (CurrentLang != NULL) {\r
	440	FreePool (CurrentLang);\r
08e4b3cf	441	}\r
ea7cd3ec	442	FreePool (Languages);\r
08e4b3cf	443	\r
	444	return Status;\r
	445	}\r
	446	\r
	447	\r
	448	/**\r
	449	Get string specified by StringId form the HiiHandle. The caller\r
	450	is responsible to free the *String.\r
	451	\r
	452	If String is NULL, then ASSERT.\r
	453	If HiiHandle could not be found in the default HII database, then ASSERT.\r
	454	If StringId is not found in PackageList, then ASSERT.\r
	455	\r
	456	@param HiiHandle The HII handle of package list.\r
	457	@param StringId The String ID.\r
	458	@param String The output string.\r
	459	\r
	460	@retval EFI_NOT_FOUND String is not found.\r
	461	@retval EFI_SUCCESS Operation is successful.\r
	462	@retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.\r
	463	\r
	464	**/\r
	465	EFI_STATUS\r
	466	EFIAPI\r
	467	HiiLibGetStringFromHandle (\r
	468	IN EFI_HII_HANDLE HiiHandle,\r
	469	IN EFI_STRING_ID StringId,\r
	470	OUT EFI_STRING *String\r
	471	)\r
	472	{\r
	473	EFI_STATUS Status;\r
	474	UINTN StringSize;\r
	475	\r
	476	ASSERT (String != NULL);\r
	477	\r
	478	StringSize = HII_LIB_DEFAULT_STRING_SIZE;\r
	479	*String = AllocateZeroPool (StringSize);\r
	480	if (*String == NULL) {\r
	481	return EFI_OUT_OF_RESOURCES;\r
	482	}\r
	483	\r
	484	Status = HiiLibGetString (HiiHandle, StringId, *String, &StringSize);\r
	485	if (Status == EFI_BUFFER_TOO_SMALL) {\r
	486	FreePool (*String);\r
	487	*String = AllocateZeroPool (StringSize);\r
	488	if (*String == NULL) {\r
	489	return EFI_OUT_OF_RESOURCES;\r
	490	}\r
	491	Status = HiiLibGetString (HiiHandle, StringId, *String, &StringSize);\r
	492	}\r
	493	\r
	494	return Status;\r
	495	}\r
	496	\r
	497	\r
	498	\r
	499	/**\r
	500	Convert language code from RFC3066 to ISO639-2.\r
	501	\r
	502	@param LanguageRfc3066 RFC3066 language code.\r
	503	@param LanguageIso639 ISO639-2 language code.\r
	504	\r
	505	@retval EFI_SUCCESS Language code converted.\r
	506	@retval EFI_NOT_FOUND Language code not found.\r
507	\r
508	**/\r
509	EFI_STATUS\r
510	EFIAPI\r
511	ConvertRfc3066LanguageToIso639Language (\r
512	IN CHAR8 *LanguageRfc3066,\r
513	OUT CHAR8 *LanguageIso639\r
514	)\r
515	{\r
516	UINTN Index;\r
517	\r
518	if ((LanguageRfc3066[2] != '-') && (LanguageRfc3066[2] != 0)) {\r
519	CopyMem (LanguageIso639, LanguageRfc3066, 3);\r
520	return EFI_SUCCESS;\r
521	}\r
522	\r
523	for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
524	if (CompareMem (LanguageRfc3066, &Iso639ToRfc3066ConversionTable[Index + 3], 2) == 0) {\r
525	CopyMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3);\r
526	return EFI_SUCCESS;\r
527	}\r
528	}\r
529	\r
530	return EFI_NOT_FOUND;\r
531	}\r
532	\r
533	\r
534	/**\r
ea7cd3ec	535	Convert language code from ISO639-2 to RFC3066 and return the converted language.\r
ea7cd3ec	536	Caller is responsible for freeing the allocated buffer.\r
08e4b3cf	537	\r
	538	LanguageIso639 contain a single ISO639-2 code such as\r
	539	"eng" or "fra".\r
	540	\r
08e4b3cf	541	If LanguageIso639 is NULL, then ASSERT.\r
	542	If LanguageRfc3066 is NULL, then ASSERT.\r
	543	\r
	544	@param LanguageIso639 ISO639-2 language code.\r
08e4b3cf	545	\r
ea7cd3ec	546	@return the allocated buffer or NULL, if the language is not found.\r
08e4b3cf	547	\r
08e4b3cf	548	**/\r
ea7cd3ec	549	CHAR8*\r
08e4b3cf	550	EFIAPI\r
08e4b3cf	551	ConvertIso639LanguageToRfc3066Language (\r
ea7cd3ec	552	IN CONST CHAR8 *LanguageIso639\r
08e4b3cf	553	)\r
	554	{\r
	555	UINTN Index;\r
	556	\r
	557	for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
	558	if (CompareMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3) == 0) {\r
ea7cd3ec	559	return AllocateCopyPool (2, &Iso639ToRfc3066ConversionTable[Index + 3]);\r
08e4b3cf	560	}\r
	561	}\r
	562	\r
ea7cd3ec	563	return NULL;\r
08e4b3cf	564	}\r
	565	\r
	566	/**\r
	567	Convert language code list from RFC3066 to ISO639-2, e.g. "en-US;fr-FR" will\r
	568	be converted to "engfra".\r
	569	\r
	570	@param SupportedLanguages The RFC3066 language list.\r
	571	\r
	572	@return The ISO639-2 language list.\r
	573	\r
	574	**/\r
	575	CHAR8 *\r
	576	EFIAPI\r
	577	Rfc3066ToIso639 (\r
	578	CHAR8 *SupportedLanguages\r
	579	)\r
	580	{\r
	581	CHAR8 *Languages;\r
	582	CHAR8 *ReturnValue;\r
	583	CHAR8 *LangCodes;\r
ea7cd3ec	584	CHAR8 *LangRfc3066;\r
08e4b3cf	585	CHAR8 LangIso639[ISO_639_2_ENTRY_SIZE];\r
ea7cd3ec	586	UINTN LanguageSize;\r
08e4b3cf	587	EFI_STATUS Status;\r
08e4b3cf	588	\r
ea7cd3ec	589	LanguageSize = AsciiStrSize (SupportedLanguages);\r
ea7cd3ec	590	ReturnValue = AllocateZeroPool (LanguageSize);\r
08e4b3cf	591	if (ReturnValue == NULL) {\r
	592	return ReturnValue;\r
	593	}\r
	594	\r
ea7cd3ec	595	//\r
	596	// Allocate working buffer to contain substring in SupportedLanguages;\r
	597	//\r
	598	LangRfc3066 = AllocatePool (LanguageSize);\r
	599	if (LangRfc3066 == NULL) {\r
	600	FreePool (ReturnValue);\r
	601	return NULL;\r
	602	}\r
08e4b3cf	603	Languages = ReturnValue;\r
	604	LangCodes = SupportedLanguages;\r
	605	while (*LangCodes != 0) {\r
	606	HiiLibGetNextLanguage (&LangCodes, LangRfc3066);\r
	607	\r
	608	Status = ConvertRfc3066LanguageToIso639Language (LangRfc3066, LangIso639);\r
	609	if (!EFI_ERROR (Status)) {\r
	610	CopyMem (Languages, LangIso639, 3);\r
	611	Languages = Languages + 3;\r
	612	}\r
	613	}\r
	614	\r
ea7cd3ec	615	FreePool (LangRfc3066);\r
08e4b3cf	616	return ReturnValue;\r
	617	}\r
	618	\r
	619	\r