[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[RFC_3066_ENTRY_SIZE];\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
  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 (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       *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
  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
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
194	CHAR8 Lang[RFC_3066_ENTRY_SIZE];\r
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
08e4b3cf	203	\r
	204	LangStrings = Languages;\r
	205	while (*LangStrings != 0) {\r
	206	HiiLibGetNextLanguage (&LangStrings, Lang);\r
	207	\r
	208	//\r
	209	// For each language supported by the package,\r
	210	// a string token is created.\r
	211	//\r
	212	Status = mHiiStringProt->NewString (\r
	213	mHiiStringProt,\r
	214	PackageList,\r
	215	StringId,\r
	216	Lang,\r
	217	NULL,\r
	218	String,\r
	219	NULL\r
	220	);\r
	221	if (EFI_ERROR (Status)) {\r
	222	break;\r
	223	}\r
	224	}\r
	225	\r
	226	FreePool (Languages);\r
	227	\r
	228	return Status;\r
	229	\r
	230	}\r
	231	\r
	232	\r
	233	/**\r
	234	This function update the specified string in String Package of each language\r
	235	supported by the package list.\r
	236	\r
	237	If String is NULL, then ASSERT.\r
	238	If PackageList could not be found in the default HII database, then ASSERT.\r
	239	If StringId is not found in PackageList, then ASSERT.\r
	240	\r
	241	@param PackageList Handle of the package list where this string will\r
	242	be added.\r
	243	@param StringId Ths String Id to be updated.\r
	244	@param String Points to the new null-terminated string.\r
	245	\r
	246	@retval EFI_SUCCESS The new string was added successfully.\r
	247	@retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.\r
	248	\r
	249	**/\r
	250	EFI_STATUS\r
	251	EFIAPI\r
	252	HiiLibSetString (\r
	253	IN EFI_HII_HANDLE PackageList,\r
	254	IN EFI_STRING_ID StringId,\r
	255	IN CONST EFI_STRING String\r
	256	)\r
	257	{\r
	258	EFI_STATUS Status;\r
	259	CHAR8 *Languages;\r
	260	CHAR8 *LangStrings;\r
	261	CHAR8 Lang[RFC_3066_ENTRY_SIZE];\r
	262	\r
	263	ASSERT (IsHiiHandleRegistered (PackageList));\r
	264	\r
	265	Status = EFI_SUCCESS;\r
	266	\r
267	Languages = HiiLibGetSupportedLanguages (PackageList);\r
268	ASSERT (Languages != NULL);\r
269	\r
270	LangStrings = Languages;\r
271	while (*LangStrings != 0) {\r
272	HiiLibGetNextLanguage (&LangStrings, Lang);\r
273	\r
274	//\r
275	// For each language supported by the package,\r
276	// the string is updated.\r
277	//\r
278	Status = mHiiStringProt->SetString (\r
279	mHiiStringProt,\r
280	PackageList,\r
281	StringId,\r
282	Lang,\r
283	String,\r
284	NULL\r
285	);\r
286	if (EFI_ERROR (Status)) {\r
287	break;\r
288	}\r
289	}\r
290	\r
291	FreePool (Languages);\r
292	\r
293	return Status;\r
294	}\r
295	\r
296	\r
297	/**\r
298	Get the string given the StringId and String package Producer's Guid. The caller\r
299	is responsible to free the *String.\r
300	\r
301	If PackageList with the matching ProducerGuid is not found, then ASSERT.\r
302	If PackageList with the matching ProducerGuid is found but no String is\r
303	specified by StringId is found, then ASSERT.\r
304	\r
305	@param ProducerGuid The Guid of String package list.\r
306	@param StringId The String ID.\r
307	@param String The output string.\r
308	\r
309	@retval EFI_SUCCESS Operation is successful.\r
310	@retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.\r
311	\r
312	**/\r
313	EFI_STATUS\r
314	EFIAPI\r
315	HiiLibGetStringFromToken (\r
316	IN EFI_GUID *ProducerGuid,\r
317	IN EFI_STRING_ID StringId,\r
318	OUT EFI_STRING *String\r
319	)\r
320	{\r
321	EFI_STATUS Status;\r
322	UINTN Index;\r
323	UINTN HandleBufferLen;\r
324	EFI_HII_HANDLE *HiiHandleBuffer;\r
325	EFI_GUID Guid;\r
326	\r
327	Status = HiiLibGetHiiHandles (&HandleBufferLen, &HiiHandleBuffer);\r
4a1102c9	328	if (HiiHandleBuffer == NULL) {\r
4a1102c9	329	return EFI_NOT_FOUND;\r
08e4b3cf	330	}\r
	331	for (Index = 0; Index < (HandleBufferLen / sizeof (EFI_HII_HANDLE)); Index++) {\r
	332	Status = HiiLibExtractGuidFromHiiHandle (HiiHandleBuffer[Index], &Guid);\r
	333	if (EFI_ERROR(Status)) {\r
	334	return Status;\r
	335	}\r
	336	if (CompareGuid (&Guid, ProducerGuid)) {\r
	337	break;\r
	338	}\r
	339	}\r
	340	\r
	341	if (Index >= (HandleBufferLen / sizeof (EFI_HII_HANDLE))) {\r
	342	//\r
	343	// If PackageList with the matching ProducerGuid is not found, then ASSERT.\r
	344	//\r
	345	ASSERT (FALSE);\r
	346	Status = EFI_NOT_FOUND;\r
	347	goto Out;\r
	348	}\r
	349	\r
	350	Status = HiiLibGetStringFromHandle (HiiHandleBuffer[Index], StringId, String);\r
	351	\r
	352	Out:\r
4a1102c9	353	FreePool (HiiHandleBuffer);\r
4a1102c9	354	\r
08e4b3cf	355	return Status;\r
	356	}\r
	357	\r
	358	/**\r
	359	This function try to retrieve string from String package of current language.\r
	360	If fails, it try to retrieve string from String package of first language it support.\r
	361	\r
	362	If StringSize is NULL, then ASSERT.\r
	363	If String is NULL and *StringSize is not 0, then ASSERT.\r
	364	If PackageList could not be found in the default HII database, then ASSERT.\r
	365	If StringId is not found in PackageList, then ASSERT.\r
	366	\r
	367	@param PackageList The package list in the HII database to search for\r
	368	the specified string.\r
	369	@param StringId The string's id, which is unique within\r
	370	PackageList.\r
	371	@param String Points to the new null-terminated string.\r
	372	@param StringSize On entry, points to the size of the buffer pointed\r
	373	to by String, in bytes. On return, points to the\r
	374	length of the string, in bytes.\r
	375	\r
	376	@retval EFI_SUCCESS The string was returned successfully.\r
	377	@retval EFI_NOT_FOUND The string specified by StringId is not available.\r
	378	@retval EFI_BUFFER_TOO_SMALL The buffer specified by StringLength is too small\r
	379	to hold the string.\r
	380	\r
	381	**/\r
	382	EFI_STATUS\r
	383	EFIAPI\r
	384	HiiLibGetString (\r
	385	IN EFI_HII_HANDLE PackageList,\r
	386	IN EFI_STRING_ID StringId,\r
	387	OUT EFI_STRING String,\r
	388	IN OUT UINTN *StringSize\r
	389	)\r
	390	{\r
	391	EFI_STATUS Status;\r
	392	CHAR8 *Languages;\r
	393	CHAR8 *LangStrings;\r
	394	CHAR8 Lang[RFC_3066_ENTRY_SIZE];\r
	395	CHAR8 CurrentLang[RFC_3066_ENTRY_SIZE];\r
	396	\r
	397	ASSERT (StringSize != NULL);\r
	398	ASSERT (!(*StringSize != 0 && String == NULL));\r
	399	ASSERT (IsHiiHandleRegistered (PackageList));\r
	400	\r
	401	GetCurrentLanguage (CurrentLang);\r
	402	\r
	403	Status = mHiiStringProt->GetString (\r
	404	mHiiStringProt,\r
	405	CurrentLang,\r
	406	PackageList,\r
	407	StringId,\r
	408	String,\r
	409	StringSize,\r
	410	NULL\r
	411	);\r
	412	\r
	413	if (EFI_ERROR (Status) && (Status != EFI_BUFFER_TOO_SMALL)) {\r
	414	Languages = HiiLibGetSupportedLanguages (PackageList);\r
	415	ASSERT (Languages != NULL);\r
	416	\r
	417	LangStrings = Languages;\r
	418	HiiLibGetNextLanguage (&LangStrings, Lang);\r
419	FreePool (Languages);\r
420	\r
421	Status = mHiiStringProt->GetString (\r
422	mHiiStringProt,\r
423	Lang,\r
424	PackageList,\r
425	StringId,\r
426	String,\r
427	StringSize,\r
428	NULL\r
429	);\r
430	}\r
431	\r
432	return Status;\r
433	}\r
434	\r
435	\r
436	/**\r
437	Get string specified by StringId form the HiiHandle. The caller\r
438	is responsible to free the *String.\r
439	\r
440	If String is NULL, then ASSERT.\r
441	If HiiHandle could not be found in the default HII database, then ASSERT.\r
442	If StringId is not found in PackageList, then ASSERT.\r
443	\r
444	@param HiiHandle The HII handle of package list.\r
445	@param StringId The String ID.\r
446	@param String The output string.\r
447	\r
448	@retval EFI_NOT_FOUND String is not found.\r
449	@retval EFI_SUCCESS Operation is successful.\r
450	@retval EFI_OUT_OF_RESOURCES There is not enought memory in the system.\r
451	\r
452	**/\r
453	EFI_STATUS\r
454	EFIAPI\r
455	HiiLibGetStringFromHandle (\r
456	IN EFI_HII_HANDLE HiiHandle,\r
457	IN EFI_STRING_ID StringId,\r
458	OUT EFI_STRING *String\r
459	)\r
460	{\r
461	EFI_STATUS Status;\r
462	UINTN StringSize;\r
463	\r
464	ASSERT (String != NULL);\r
465	\r
466	StringSize = HII_LIB_DEFAULT_STRING_SIZE;\r
467	*String = AllocateZeroPool (StringSize);\r
468	if (*String == NULL) {\r
469	return EFI_OUT_OF_RESOURCES;\r
470	}\r
471	\r
472	Status = HiiLibGetString (HiiHandle, StringId, *String, &StringSize);\r
473	if (Status == EFI_BUFFER_TOO_SMALL) {\r
474	FreePool (*String);\r
475	*String = AllocateZeroPool (StringSize);\r
476	if (*String == NULL) {\r
477	return EFI_OUT_OF_RESOURCES;\r
478	}\r
479	Status = HiiLibGetString (HiiHandle, StringId, *String, &StringSize);\r
480	}\r
481	\r
482	return Status;\r
483	}\r
484	\r
485	\r
486	\r
487	/**\r
488	Convert language code from RFC3066 to ISO639-2.\r
489	\r
490	@param LanguageRfc3066 RFC3066 language code.\r
491	@param LanguageIso639 ISO639-2 language code.\r
492	\r
493	@retval EFI_SUCCESS Language code converted.\r
494	@retval EFI_NOT_FOUND Language code not found.\r
495	\r
496	**/\r
497	EFI_STATUS\r
498	EFIAPI\r
499	ConvertRfc3066LanguageToIso639Language (\r
500	IN CHAR8 *LanguageRfc3066,\r
501	OUT CHAR8 *LanguageIso639\r
502	)\r
503	{\r
504	UINTN Index;\r
505	\r
506	if ((LanguageRfc3066[2] != '-') && (LanguageRfc3066[2] != 0)) {\r
507	CopyMem (LanguageIso639, LanguageRfc3066, 3);\r
508	return EFI_SUCCESS;\r
509	}\r
510	\r
511	for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
512	if (CompareMem (LanguageRfc3066, &Iso639ToRfc3066ConversionTable[Index + 3], 2) == 0) {\r
513	CopyMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3);\r
514	return EFI_SUCCESS;\r
515	}\r
516	}\r
517	\r
518	return EFI_NOT_FOUND;\r
519	}\r
520	\r
521	\r
522	/**\r
523	Convert language code from ISO639-2 to RFC3066.\r
524	\r
525	LanguageIso639 contain a single ISO639-2 code such as\r
526	"eng" or "fra".\r
527	\r
528	The LanguageRfc3066 must be a buffer large enough\r
529	for RFC_3066_ENTRY_SIZE characters.\r
530	\r
531	If LanguageIso639 is NULL, then ASSERT.\r
532	If LanguageRfc3066 is NULL, then ASSERT.\r
533	\r
534	@param LanguageIso639 ISO639-2 language code.\r
535	@param LanguageRfc3066 RFC3066 language code.\r
536	\r
537	@retval EFI_SUCCESS Language code converted.\r
538	@retval EFI_NOT_FOUND Language code not found.\r
539	\r
540	**/\r
541	EFI_STATUS\r
542	EFIAPI\r
543	ConvertIso639LanguageToRfc3066Language (\r
544	IN CONST CHAR8 *LanguageIso639,\r
545	OUT CHAR8 *LanguageRfc3066\r
546	)\r
547	{\r
548	UINTN Index;\r
549	\r
550	for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
551	if (CompareMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3) == 0) {\r
552	CopyMem (LanguageRfc3066, &Iso639ToRfc3066ConversionTable[Index + 3], 2);\r
553	return EFI_SUCCESS;\r
554	}\r
555	}\r
556	\r
557	return EFI_NOT_FOUND;\r
558	}\r
559	\r
560	/**\r
561	Convert language code list from RFC3066 to ISO639-2, e.g. "en-US;fr-FR" will\r
562	be converted to "engfra".\r
563	\r
564	@param SupportedLanguages The RFC3066 language list.\r
565	\r
566	@return The ISO639-2 language list.\r
567	\r
568	**/\r
569	CHAR8 *\r
570	EFIAPI\r
571	Rfc3066ToIso639 (\r
572	CHAR8 *SupportedLanguages\r
573	)\r
574	{\r
575	CHAR8 *Languages;\r
576	CHAR8 *ReturnValue;\r
577	CHAR8 *LangCodes;\r
578	CHAR8 LangRfc3066[RFC_3066_ENTRY_SIZE];\r
579	CHAR8 LangIso639[ISO_639_2_ENTRY_SIZE];\r
580	EFI_STATUS Status;\r
581	\r
582	ReturnValue = AllocateZeroPool (AsciiStrSize (SupportedLanguages));\r
583	if (ReturnValue == NULL) {\r
584	return ReturnValue;\r
585	}\r
586	\r
587	Languages = ReturnValue;\r
588	LangCodes = SupportedLanguages;\r
589	while (*LangCodes != 0) {\r
590	HiiLibGetNextLanguage (&LangCodes, LangRfc3066);\r
591	\r
592	Status = ConvertRfc3066LanguageToIso639Language (LangRfc3066, LangIso639);\r
593	if (!EFI_ERROR (Status)) {\r
594	CopyMem (Languages, LangIso639, 3);\r
595	Languages = Languages + 3;\r
596	}\r
597	}\r
598	\r
599	return ReturnValue;\r
600	}\r
601	\r
602	\r