[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 create a new string in String Package or updates an existing \r
  string in a String Package.  If StringId is 0, then a new string is added to\r
  a String Package.  If StringId is not zero, then a string in String Package is\r
  updated.  If SupportedLanguages is NULL, then the string is added or updated\r
  for all the languages that the String Package supports.  If SupportedLanguages\r
  is not NULL, then the string is added or updated for the set of languages \r
  specified by SupportedLanguages.\r
    \r
  If HiiHandle is NULL, then ASSERT().\r
  If String is NULL, then ASSERT().\r
\r
  @param[in]  HiiHandle           A handle that was previously registered in the \r
                                  HII Database.\r
  @param[in]  StringId            If zero, then a new string is created in the \r
                                  String Package associated with HiiHandle.  If \r
                                  non-zero, then the string specified by StringId \r
                                  is updated in the String Package  associated \r
                                  with HiiHandle. \r
  @param[in]  String              A pointer to the Null-terminated Unicode string \r
                                  to add or update in the String Package associated \r
                                  with HiiHandle.\r
  @param[in]  SupportedLanguages  A pointer to a Null-terminated ASCII string of \r
                                  language codes.  If this parameter is NULL, then \r
                                  String is added or updated in the String Package \r
                                  associated with HiiHandle for all the languages \r
                                  that the String Package supports.  If this \r
                                  parameter is not NULL, then then String is added \r
                                  or updated in the String Package associated with \r
                                  HiiHandle for the set oflanguages specified by \r
                                  SupportedLanguages.  The format of \r
                                  SupportedLanguages must follow the language \r
                                  format assumed the HII Database.\r
\r
  @retval 0      The string could not be added or updated in the String Package.\r
  @retval Other  The EFI_STRING_ID of the newly added or updated string.\r
\r
**/\r
EFI_STRING_ID\r
EFIAPI\r
HiiSetString (\r
  IN EFI_HII_HANDLE    HiiHandle,\r
  IN EFI_STRING_ID     StringId,            OPTIONAL\r
  IN CONST EFI_STRING  String,\r
  IN CONST CHAR8       *SupportedLanguages  OPTIONAL\r
  )\r
{\r
  EFI_STATUS     Status;\r
  CHAR8          *AllocatedLanguages;\r
  CHAR8          *Supported;\r
  CHAR8          *Language;\r
  EFI_STRING_ID  NewStringId;\r
\r
  ASSERT (HiiHandle != NULL);\r
  ASSERT (String != NULL);\r
\r
  if (SupportedLanguages == NULL) {\r
    //\r
    // Retrieve the languages that the package specified by HiiHandle supports\r
    //\r
    AllocatedLanguages = HiiGetSupportedLanguages (HiiHandle);\r
  } else {\r
    //\r
    // Allocate a copy of the SupportLanguages string that passed in\r
    //\r
    AllocatedLanguages = AllocateCopyPool (AsciiStrLen (SupportedLanguages), SupportedLanguages);\r
  }\r
\r
  //\r
  // If there are not enough resources for the supported languages string, then return a StringId of 0\r
  //\r
  if (AllocatedLanguages == NULL) {\r
    return (EFI_STRING_ID)(0);\r
  }\r
\r
  NewStringId = 0;\r
  Status = EFI_INVALID_PARAMETER;\r
  //\r
  // Loop through each language that the string supports\r
  //\r
  for (Supported = AllocatedLanguages; *Supported != '\0'; ) {\r
    //\r
    // Cache a pointer to the beginning of the current language in the list of languages\r
    //\r
    Language = Supported;\r
\r
    //\r
    // Search for the next language seperator and replace it with a Null-terminator\r
    //\r
    for (; *Supported != 0 && *Supported != ';'; Supported++);\r
    if (*Supported != 0) {\r
      *(Supported++) = '\0';\r
    }\r
\r
    //\r
    // If StringId is 0, then call NewString().  Otherwise, call SetString()\r
    //\r
    if (StringId == (EFI_STRING_ID)(0)) {\r
      Status = gHiiString->NewString (gHiiString, HiiHandle, &NewStringId, Language, NULL, String, NULL);\r
    } else {\r
      Status = gHiiString->SetString (gHiiString, HiiHandle, StringId, Language, String, NULL);\r
    }\r
\r
    //\r
    // If there was an error, then break out of the loop and return a StringId of 0\r
    //\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
  }\r
\r
  //\r
  // Free the buffer of supported languages\r
  //\r
  FreePool (AllocatedLanguages);\r
\r
  if (EFI_ERROR (Status)) {\r
    return (EFI_STRING_ID)(0);\r
  } else if (StringId == (EFI_STRING_ID)(0)) {\r
    return NewStringId;\r
  } else {\r
    return StringId;\r
  }\r
}\r
\r
\r
/**\r
  Retrieves a string from a string package names by GUID in a specific language.  \r
  If the language is not specified, then a string from a string package in the \r
  current platform  language is retrieved.  If the string can not be retrieved \r
  using the specified language or the current platform language, then the string \r
  is retrieved from the string package in the first language the string package \r
  supports.  The returned string is allocated using AllocatePool().  The caller \r
  is responsible for freeing the allocated buffer using FreePool().\r
  \r
  If PackageListGuid is NULL, then ASSERT().\r
  If StringId is 0, then ASSERT.\r
\r
  @param[in]  PackageListGuid  The GUID of a package list that was previously \r
                               registered in the HII Database.\r
  @param[in]  StringId         The identifier of the string to retrieved from the \r
                               string package associated with PackageListGuid.\r
  @param[in]  Language         The language of the string to retrieve.  If this \r
                               parameter is NULL, then the current platform \r
                               language is used.  The format of Language must \r
                               follow the language format assumed the HII Database.\r
\r
  @retval NULL   The package list specified by PackageListGuid is not present in the\r
                 HII Database.\r
  @retval NULL   The string specified by StringId is not present in the string package.\r
  @retval Other  The string was returned.\r
\r
**/\r
EFI_STRING\r
EFIAPI\r
HiiGetPackageString (\r
  IN CONST EFI_GUID  *PackageListGuid,\r
  IN EFI_STRING_ID   StringId,\r
  IN CONST CHAR8     *Language  OPTIONAL\r
  )\r
{\r
  EFI_HANDLE  *HiiHandleBuffer;\r
  EFI_HANDLE  HiiHandle;\r
\r
  ASSERT (PackageListGuid != NULL);\r
\r
  HiiHandleBuffer = HiiGetHiiHandles (PackageListGuid);\r
  if (HiiHandleBuffer == NULL) {\r
    return NULL;\r
  }\r
\r
  HiiHandle = HiiHandleBuffer[0];\r
  FreePool (HiiHandleBuffer);\r
\r
  return HiiGetString (HiiHandle, StringId, Language);\r
}\r
\r
/**\r
  Retrieves a string from a string package in a specific language.  If the language\r
  is not specified, then a string from a string package in the current platform \r
  language is retrieved.  If the string can not be retrieved using the specified \r
  language or the current platform language, then the string is retrieved from \r
  the string package in the first language the string package supports.  The \r
  returned string is allocated using AllocatePool().  The caller is responsible \r
  for freeing the allocated buffer using FreePool().\r
  \r
  If HiiHandle is NULL, then ASSERT().\r
  If StringId is 0, then ASSET.\r
\r
  @param[in]  HiiHandle  A handle that was previously registered in the HII Database.\r
  @param[in]  StringId   The identifier of the string to retrieved from the string \r
                         package associated with HiiHandle.\r
  @param[in]  Language   The language of the string to retrieve.  If this parameter \r
                         is NULL, then the current platform language is used.  The \r
                         format of Language must follow the language format assumed \r
                         the HII Database.\r
\r
  @retval NULL   The string specified by StringId is not present in the string package.\r
  @retval Other  The string was returned.\r
\r
**/\r
EFI_STRING\r
EFIAPI\r
HiiGetString (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN EFI_STRING_ID   StringId,\r
  IN CONST CHAR8     *Language  OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       StringSize;\r
  CHAR16      TempString;\r
  EFI_STRING  String;\r
  CHAR8       *SupportedLanguages;\r
  CHAR8       *PlatformLanguage;\r
  CHAR8       *BestLanguage;\r
\r
  ASSERT (HiiHandle != NULL);\r
  ASSERT (StringId != 0);\r
\r
  //\r
  // Initialize all allocated buffers to NULL\r
  // \r
  SupportedLanguages = NULL;\r
  PlatformLanguage   = NULL;\r
  BestLanguage       = NULL;\r
  String             = NULL;\r
\r
  //\r
  // Get the languages that the package specified by HiiHandle supports\r
  //\r
  SupportedLanguages = HiiGetSupportedLanguages (HiiHandle);\r
  if (SupportedLanguages == NULL) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Get the current platform language setting\r
  //\r
  PlatformLanguage = GetEfiGlobalVariable (L"PlatformLang");\r
\r
  //\r
  // If Languag is NULL, then set it to an empty string, so it will be \r
  // skipped by GetBestLanguage()\r
  //\r
  if (Language == NULL) {\r
    Language = "";\r
  }\r
\r
  //\r
  // Get the best matching language from SupportedLanguages\r
  //\r
  BestLanguage = GetBestLanguage (\r
                   SupportedLanguages, \r
                   FALSE,                                             // RFC 4646 mode\r
                   Language,                                          // Highest priority \r
                   PlatformLanguage != NULL ? PlatformLanguage : "",  // Next highest priority\r
                   SupportedLanguages,                                // Lowest priority \r
                   NULL\r
                   );\r
  if (BestLanguage == NULL) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Retrieve the size of the string in the string package for the BestLanguage\r
  //\r
  StringSize = 0;\r
  Status = gHiiString->GetString (\r
                         gHiiString,\r
                         BestLanguage,\r
                         HiiHandle,\r
                         StringId,\r
                         &TempString,\r
                         &StringSize,\r
                         NULL\r
                         );\r
  //\r
  // If GetString() returns EFI_SUCCESS for a zero size, \r
  // then there are no supported languages registered for HiiHandle.  If GetString() \r
  // returns an error other than EFI_BUFFER_TOO_SMALL, then HiiHandle is not present\r
  // in the HII Database\r
  //\r
  if (Status != EFI_BUFFER_TOO_SMALL) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Allocate a buffer for the return string\r
  //\r
  String = AllocateZeroPool (StringSize);\r
  if (String == NULL) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Retrieve the string from the string package\r
  //\r
  Status = gHiiString->GetString (\r
                         gHiiString,\r
                         BestLanguage,\r
                         HiiHandle,\r
                         StringId,\r
                         String,\r
                         &StringSize,\r
                         NULL\r
                         );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Free the buffer and return NULL if the supported languages can not be retrieved.\r
    //\r
    FreePool (String);\r
    String = NULL;\r
  }\r
\r
Error:\r
  //\r
  // Free allocated buffers\r
  //\r
  if (SupportedLanguages != NULL) {\r
    FreePool (SupportedLanguages);\r
  }\r
  if (PlatformLanguage != NULL) {\r
    FreePool (PlatformLanguage);\r
  }\r
  if (BestLanguage != NULL) {\r
    FreePool (BestLanguage);\r
  }\r
\r
  //\r
  // Return the Null-terminated Unicode string\r
  //\r
  return String;\r
}\r
\r
/**\r
  Convert language code from RFC3066 to ISO639-2.\r
\r
  @param  LanguageRfc3066        RFC3066 language code.\r
  @param  LanguageIso639         ISO639-2 language code.\r
\r
  @retval EFI_SUCCESS            Language code converted.\r
  @retval EFI_NOT_FOUND          Language code not found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConvertRfc3066LanguageToIso639Language (\r
  IN  CHAR8   *LanguageRfc3066,\r
  OUT CHAR8   *LanguageIso639\r
  )\r
{\r
  UINTN  Index;\r
\r
  if ((LanguageRfc3066[2] != '-') && (LanguageRfc3066[2] != 0)) {\r
    CopyMem (LanguageIso639, LanguageRfc3066, 3);\r
    return EFI_SUCCESS;\r
  }\r
\r
  for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
    if (CompareMem (LanguageRfc3066, &Iso639ToRfc3066ConversionTable[Index + 3], 2) == 0) {\r
      CopyMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3);\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
\r
/**\r
  Convert language code from ISO639-2 to RFC3066 and return the converted language.\r
  Caller is responsible for freeing the allocated buffer.\r
\r
  LanguageIso639 contain a single ISO639-2 code such as\r
  "eng" or "fra".\r
\r
  If LanguageIso639 is NULL, then ASSERT.\r
  If LanguageRfc3066 is NULL, then ASSERT.\r
\r
  @param  LanguageIso639         ISO639-2 language code.\r
\r
  @return the allocated buffer or NULL, if the language is not found.\r
\r
**/\r
CHAR8*\r
EFIAPI\r
ConvertIso639LanguageToRfc3066Language (\r
  IN  CONST CHAR8   *LanguageIso639\r
  )\r
{\r
  UINTN Index;\r
  CHAR8 *Rfc3066Language;\r
  \r
  for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
    if (CompareMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3) == 0) {\r
      Rfc3066Language = AllocateZeroPool (3);\r
      if (Rfc3066Language != NULL) {\r
        Rfc3066Language = CopyMem (Rfc3066Language, &Iso639ToRfc3066ConversionTable[Index + 3], 2);\r
      }\r
      return Rfc3066Language;\r
    }\r
  }\r
\r
  return NULL;\r
}\r
\r
/**\r
  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
cb7d01c0	166	This function create a new string in String Package or updates an existing \r
	167	string in a String Package. If StringId is 0, then a new string is added to\r
	168	a String Package. If StringId is not zero, then a string in String Package is\r
	169	updated. If SupportedLanguages is NULL, then the string is added or updated\r
	170	for all the languages that the String Package supports. If SupportedLanguages\r
	171	is not NULL, then the string is added or updated for the set of languages \r
	172	specified by SupportedLanguages.\r
	173	\r
	174	If HiiHandle is NULL, then ASSERT().\r
	175	If String is NULL, then ASSERT().\r
	176	\r
	177	@param[in] HiiHandle A handle that was previously registered in the \r
	178	HII Database.\r
	179	@param[in] StringId If zero, then a new string is created in the \r
	180	String Package associated with HiiHandle. If \r
	181	non-zero, then the string specified by StringId \r
	182	is updated in the String Package associated \r
	183	with HiiHandle. \r
	184	@param[in] String A pointer to the Null-terminated Unicode string \r
	185	to add or update in the String Package associated \r
	186	with HiiHandle.\r
	187	@param[in] SupportedLanguages A pointer to a Null-terminated ASCII string of \r
	188	language codes. If this parameter is NULL, then \r
	189	String is added or updated in the String Package \r
	190	associated with HiiHandle for all the languages \r
	191	that the String Package supports. If this \r
	192	parameter is not NULL, then then String is added \r
	193	or updated in the String Package associated with \r
	194	HiiHandle for the set oflanguages specified by \r
	195	SupportedLanguages. The format of \r
	196	SupportedLanguages must follow the language \r
	197	format assumed the HII Database.\r
	198	\r
	199	@retval 0 The string could not be added or updated in the String Package.\r
	200	@retval Other The EFI_STRING_ID of the newly added or updated string.\r
08e4b3cf	201	\r
08e4b3cf	202	**/\r
cb7d01c0	203	EFI_STRING_ID\r
08e4b3cf	204	EFIAPI\r
cb7d01c0	205	HiiSetString (\r
	206	IN EFI_HII_HANDLE HiiHandle,\r
	207	IN EFI_STRING_ID StringId, OPTIONAL\r
	208	IN CONST EFI_STRING String,\r
	209	IN CONST CHAR8 *SupportedLanguages OPTIONAL\r
08e4b3cf	210	)\r
08e4b3cf	211	{\r
cb7d01c0	212	EFI_STATUS Status;\r
	213	CHAR8 *AllocatedLanguages;\r
	214	CHAR8 *Supported;\r
	215	CHAR8 *Language;\r
	216	EFI_STRING_ID NewStringId;\r
08e4b3cf	217	\r
cb7d01c0	218	ASSERT (HiiHandle != NULL);\r
08e4b3cf	219	ASSERT (String != NULL);\r
08e4b3cf	220	\r
cb7d01c0	221	if (SupportedLanguages == NULL) {\r
	222	//\r
	223	// Retrieve the languages that the package specified by HiiHandle supports\r
	224	//\r
	225	AllocatedLanguages = HiiGetSupportedLanguages (HiiHandle);\r
	226	} else {\r
	227	//\r
	228	// Allocate a copy of the SupportLanguages string that passed in\r
	229	//\r
	230	AllocatedLanguages = AllocateCopyPool (AsciiStrLen (SupportedLanguages), SupportedLanguages);\r
	231	}\r
08e4b3cf	232	\r
ea7cd3ec	233	//\r
cb7d01c0	234	// If there are not enough resources for the supported languages string, then return a StringId of 0\r
ea7cd3ec	235	//\r
cb7d01c0	236	if (AllocatedLanguages == NULL) {\r
	237	return (EFI_STRING_ID)(0);\r
	238	}\r
08e4b3cf	239	\r
cb7d01c0	240	NewStringId = 0;\r
	241	Status = EFI_INVALID_PARAMETER;\r
	242	//\r
	243	// Loop through each language that the string supports\r
	244	//\r
	245	for (Supported = AllocatedLanguages; *Supported != '\0'; ) {\r
	246	//\r
	247	// Cache a pointer to the beginning of the current language in the list of languages\r
	248	//\r
	249	Language = Supported;\r
08e4b3cf	250	\r
08e4b3cf	251	//\r
cb7d01c0	252	// Search for the next language seperator and replace it with a Null-terminator\r
08e4b3cf	253	//\r
cb7d01c0	254	for (; Supported != 0 && Supported != ';'; Supported++);\r
	255	if (*Supported != 0) {\r
	256	*(Supported++) = '\0';\r
08e4b3cf	257	}\r
08e4b3cf	258	\r
cb7d01c0	259	//\r
	260	// If StringId is 0, then call NewString(). Otherwise, call SetString()\r
	261	//\r
	262	if (StringId == (EFI_STRING_ID)(0)) {\r
	263	Status = gHiiString->NewString (gHiiString, HiiHandle, &NewStringId, Language, NULL, String, NULL);\r
	264	} else {\r
	265	Status = gHiiString->SetString (gHiiString, HiiHandle, StringId, Language, String, NULL);\r
	266	}\r
08e4b3cf	267	\r
08e4b3cf	268	//\r
cb7d01c0	269	// If there was an error, then break out of the loop and return a StringId of 0\r
08e4b3cf	270	//\r
08e4b3cf	271	if (EFI_ERROR (Status)) {\r
	272	break;\r
	273	}\r
	274	}\r
	275	\r
cb7d01c0	276	//\r
	277	// Free the buffer of supported languages\r
	278	//\r
	279	FreePool (AllocatedLanguages);\r
	280	\r
	281	if (EFI_ERROR (Status)) {\r
	282	return (EFI_STRING_ID)(0);\r
	283	} else if (StringId == (EFI_STRING_ID)(0)) {\r
	284	return NewStringId;\r
	285	} else {\r
	286	return StringId;\r
	287	}\r
08e4b3cf	288	}\r
	289	\r
	290	\r
	291	/**\r
cb7d01c0	292	Retrieves a string from a string package names by GUID in a specific language. \r
	293	If the language is not specified, then a string from a string package in the \r
	294	current platform language is retrieved. If the string can not be retrieved \r
	295	using the specified language or the current platform language, then the string \r
	296	is retrieved from the string package in the first language the string package \r
	297	supports. The returned string is allocated using AllocatePool(). The caller \r
	298	is responsible for freeing the allocated buffer using FreePool().\r
	299	\r
	300	If PackageListGuid is NULL, then ASSERT().\r
	301	If StringId is 0, then ASSERT.\r
	302	\r
	303	@param[in] PackageListGuid The GUID of a package list that was previously \r
	304	registered in the HII Database.\r
	305	@param[in] StringId The identifier of the string to retrieved from the \r
	306	string package associated with PackageListGuid.\r
	307	@param[in] Language The language of the string to retrieve. If this \r
	308	parameter is NULL, then the current platform \r
	309	language is used. The format of Language must \r
	310	follow the language format assumed the HII Database.\r
	311	\r
	312	@retval NULL The package list specified by PackageListGuid is not present in the\r
	313	HII Database.\r
	314	@retval NULL The string specified by StringId is not present in the string package.\r
	315	@retval Other The string was returned.\r
08e4b3cf	316	\r
08e4b3cf	317	**/\r
cb7d01c0	318	EFI_STRING\r
08e4b3cf	319	EFIAPI\r
cb7d01c0	320	HiiGetPackageString (\r
	321	IN CONST EFI_GUID *PackageListGuid,\r
	322	IN EFI_STRING_ID StringId,\r
	323	IN CONST CHAR8 *Language OPTIONAL\r
08e4b3cf	324	)\r
08e4b3cf	325	{\r
cb7d01c0	326	EFI_HANDLE *HiiHandleBuffer;\r
cb7d01c0	327	EFI_HANDLE HiiHandle;\r
08e4b3cf	328	\r
cb7d01c0	329	ASSERT (PackageListGuid != NULL);\r
08e4b3cf	330	\r
cb7d01c0	331	HiiHandleBuffer = HiiGetHiiHandles (PackageListGuid);\r
	332	if (HiiHandleBuffer == NULL) {\r
	333	return NULL;\r
08e4b3cf	334	}\r
08e4b3cf	335	\r
cb7d01c0	336	HiiHandle = HiiHandleBuffer[0];\r
4a1102c9	337	FreePool (HiiHandleBuffer);\r
4a1102c9	338	\r
cb7d01c0	339	return HiiGetString (HiiHandle, StringId, Language);\r
08e4b3cf	340	}\r
	341	\r
	342	/**\r
cb7d01c0	343	Retrieves a string from a string package in a specific language. If the language\r
	344	is not specified, then a string from a string package in the current platform \r
	345	language is retrieved. If the string can not be retrieved using the specified \r
	346	language or the current platform language, then the string is retrieved from \r
	347	the string package in the first language the string package supports. The \r
	348	returned string is allocated using AllocatePool(). The caller is responsible \r
	349	for freeing the allocated buffer using FreePool().\r
	350	\r
	351	If HiiHandle is NULL, then ASSERT().\r
	352	If StringId is 0, then ASSET.\r
	353	\r
	354	@param[in] HiiHandle A handle that was previously registered in the HII Database.\r
	355	@param[in] StringId The identifier of the string to retrieved from the string \r
	356	package associated with HiiHandle.\r
	357	@param[in] Language The language of the string to retrieve. If this parameter \r
	358	is NULL, then the current platform language is used. The \r
	359	format of Language must follow the language format assumed \r
	360	the HII Database.\r
	361	\r
	362	@retval NULL The string specified by StringId is not present in the string package.\r
	363	@retval Other The string was returned.\r
08e4b3cf	364	\r
08e4b3cf	365	**/\r
cb7d01c0	366	EFI_STRING\r
08e4b3cf	367	EFIAPI\r
cb7d01c0	368	HiiGetString (\r
	369	IN EFI_HII_HANDLE HiiHandle,\r
	370	IN EFI_STRING_ID StringId,\r
	371	IN CONST CHAR8 *Language OPTIONAL\r
08e4b3cf	372	)\r
	373	{\r
	374	EFI_STATUS Status;\r
cb7d01c0	375	UINTN StringSize;\r
	376	CHAR16 TempString;\r
	377	EFI_STRING String;\r
	378	CHAR8 *SupportedLanguages;\r
	379	CHAR8 *PlatformLanguage;\r
ea7cd3ec	380	CHAR8 *BestLanguage;\r
08e4b3cf	381	\r
cb7d01c0	382	ASSERT (HiiHandle != NULL);\r
cb7d01c0	383	ASSERT (StringId != 0);\r
08e4b3cf	384	\r
cb7d01c0	385	//\r
	386	// Initialize all allocated buffers to NULL\r
	387	// \r
	388	SupportedLanguages = NULL;\r
	389	PlatformLanguage = NULL;\r
	390	BestLanguage = NULL;\r
	391	String = NULL;\r
08e4b3cf	392	\r
cb7d01c0	393	//\r
	394	// Get the languages that the package specified by HiiHandle supports\r
	395	//\r
	396	SupportedLanguages = HiiGetSupportedLanguages (HiiHandle);\r
	397	if (SupportedLanguages == NULL) {\r
	398	goto Error;\r
08e4b3cf	399	}\r
08e4b3cf	400	\r
cb7d01c0	401	//\r
	402	// Get the current platform language setting\r
	403	//\r
	404	PlatformLanguage = GetEfiGlobalVariable (L"PlatformLang");\r
08e4b3cf	405	\r
cb7d01c0	406	//\r
	407	// If Languag is NULL, then set it to an empty string, so it will be \r
	408	// skipped by GetBestLanguage()\r
	409	//\r
	410	if (Language == NULL) {\r
	411	Language = "";\r
	412	}\r
08e4b3cf	413	\r
cb7d01c0	414	//\r
	415	// Get the best matching language from SupportedLanguages\r
	416	//\r
	417	BestLanguage = GetBestLanguage (\r
	418	SupportedLanguages, \r
	419	FALSE, // RFC 4646 mode\r
	420	Language, // Highest priority \r
	421	PlatformLanguage != NULL ? PlatformLanguage : "", // Next highest priority\r
	422	SupportedLanguages, // Lowest priority \r
	423	NULL\r
	424	);\r
	425	if (BestLanguage == NULL) {\r
	426	goto Error;\r
	427	}\r
08e4b3cf	428	\r
cb7d01c0	429	//\r
	430	// Retrieve the size of the string in the string package for the BestLanguage\r
	431	//\r
	432	StringSize = 0;\r
	433	Status = gHiiString->GetString (\r
	434	gHiiString,\r
	435	BestLanguage,\r
	436	HiiHandle,\r
	437	StringId,\r
	438	&TempString,\r
	439	&StringSize,\r
	440	NULL\r
	441	);\r
	442	//\r
	443	// If GetString() returns EFI_SUCCESS for a zero size, \r
	444	// then there are no supported languages registered for HiiHandle. If GetString() \r
	445	// returns an error other than EFI_BUFFER_TOO_SMALL, then HiiHandle is not present\r
	446	// in the HII Database\r
	447	//\r
	448	if (Status != EFI_BUFFER_TOO_SMALL) {\r
	449	goto Error;\r
	450	}\r
08e4b3cf	451	\r
cb7d01c0	452	//\r
	453	// Allocate a buffer for the return string\r
	454	//\r
	455	String = AllocateZeroPool (StringSize);\r
	456	if (String == NULL) {\r
	457	goto Error;\r
	458	}\r
08e4b3cf	459	\r
cb7d01c0	460	//\r
	461	// Retrieve the string from the string package\r
	462	//\r
	463	Status = gHiiString->GetString (\r
	464	gHiiString,\r
	465	BestLanguage,\r
	466	HiiHandle,\r
	467	StringId,\r
	468	String,\r
	469	&StringSize,\r
	470	NULL\r
	471	);\r
	472	if (EFI_ERROR (Status)) {\r
	473	//\r
	474	// Free the buffer and return NULL if the supported languages can not be retrieved.\r
	475	//\r
	476	FreePool (String);\r
	477	String = NULL;\r
08e4b3cf	478	}\r
08e4b3cf	479	\r
cb7d01c0	480	Error:\r
	481	//\r
	482	// Free allocated buffers\r
	483	//\r
	484	if (SupportedLanguages != NULL) {\r
	485	FreePool (SupportedLanguages);\r
	486	}\r
	487	if (PlatformLanguage != NULL) {\r
	488	FreePool (PlatformLanguage);\r
	489	}\r
	490	if (BestLanguage != NULL) {\r
	491	FreePool (BestLanguage);\r
08e4b3cf	492	}\r
08e4b3cf	493	\r
cb7d01c0	494	//\r
	495	// Return the Null-terminated Unicode string\r
	496	//\r
	497	return String;\r
08e4b3cf	498	}\r
08e4b3cf	499	\r
08e4b3cf	500	/**\r
	501	Convert language code from RFC3066 to ISO639-2.\r
	502	\r
	503	@param LanguageRfc3066 RFC3066 language code.\r
	504	@param LanguageIso639 ISO639-2 language code.\r
	505	\r
	506	@retval EFI_SUCCESS Language code converted.\r
	507	@retval EFI_NOT_FOUND Language code not found.\r
	508	\r
	509	**/\r
	510	EFI_STATUS\r
	511	EFIAPI\r
	512	ConvertRfc3066LanguageToIso639Language (\r
	513	IN CHAR8 *LanguageRfc3066,\r
	514	OUT CHAR8 *LanguageIso639\r
	515	)\r
	516	{\r
	517	UINTN Index;\r
	518	\r
	519	if ((LanguageRfc3066[2] != '-') && (LanguageRfc3066[2] != 0)) {\r
	520	CopyMem (LanguageIso639, LanguageRfc3066, 3);\r
	521	return EFI_SUCCESS;\r
	522	}\r
	523	\r
	524	for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
	525	if (CompareMem (LanguageRfc3066, &Iso639ToRfc3066ConversionTable[Index + 3], 2) == 0) {\r
	526	CopyMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3);\r
	527	return EFI_SUCCESS;\r
	528	}\r
	529	}\r
	530	\r
	531	return EFI_NOT_FOUND;\r
	532	}\r
	533	\r
	534	\r
	535	/**\r
ea7cd3ec	536	Convert language code from ISO639-2 to RFC3066 and return the converted language.\r
ea7cd3ec	537	Caller is responsible for freeing the allocated buffer.\r
08e4b3cf	538	\r
	539	LanguageIso639 contain a single ISO639-2 code such as\r
	540	"eng" or "fra".\r
	541	\r
08e4b3cf	542	If LanguageIso639 is NULL, then ASSERT.\r
	543	If LanguageRfc3066 is NULL, then ASSERT.\r
	544	\r
	545	@param LanguageIso639 ISO639-2 language code.\r
08e4b3cf	546	\r
ea7cd3ec	547	@return the allocated buffer or NULL, if the language is not found.\r
08e4b3cf	548	\r
08e4b3cf	549	**/\r
ea7cd3ec	550	CHAR8*\r
08e4b3cf	551	EFIAPI\r
08e4b3cf	552	ConvertIso639LanguageToRfc3066Language (\r
ea7cd3ec	553	IN CONST CHAR8 *LanguageIso639\r
08e4b3cf	554	)\r
	555	{\r
	556	UINTN Index;\r
b1a4c981	557	CHAR8 *Rfc3066Language;\r
08e4b3cf	558	\r
	559	for (Index = 0; Iso639ToRfc3066ConversionTable[Index] != 0; Index += 5) {\r
	560	if (CompareMem (LanguageIso639, &Iso639ToRfc3066ConversionTable[Index], 3) == 0) {\r
b1a4c981	561	Rfc3066Language = AllocateZeroPool (3);\r
	562	if (Rfc3066Language != NULL) {\r
	563	Rfc3066Language = CopyMem (Rfc3066Language, &Iso639ToRfc3066ConversionTable[Index + 3], 2);\r
	564	}\r
	565	return Rfc3066Language;\r
08e4b3cf	566	}\r
	567	}\r
	568	\r
ea7cd3ec	569	return NULL;\r
08e4b3cf	570	}\r
	571	\r
	572	/**\r
	573	Convert language code list from RFC3066 to ISO639-2, e.g. "en-US;fr-FR" will\r
	574	be converted to "engfra".\r
	575	\r
	576	@param SupportedLanguages The RFC3066 language list.\r
	577	\r
	578	@return The ISO639-2 language list.\r
	579	\r
	580	**/\r
	581	CHAR8 *\r
	582	EFIAPI\r
	583	Rfc3066ToIso639 (\r
	584	CHAR8 *SupportedLanguages\r
	585	)\r
	586	{\r
	587	CHAR8 *Languages;\r
	588	CHAR8 *ReturnValue;\r
	589	CHAR8 *LangCodes;\r
ea7cd3ec	590	CHAR8 *LangRfc3066;\r
08e4b3cf	591	CHAR8 LangIso639[ISO_639_2_ENTRY_SIZE];\r
ea7cd3ec	592	UINTN LanguageSize;\r
08e4b3cf	593	EFI_STATUS Status;\r
08e4b3cf	594	\r
ea7cd3ec	595	LanguageSize = AsciiStrSize (SupportedLanguages);\r
ea7cd3ec	596	ReturnValue = AllocateZeroPool (LanguageSize);\r
08e4b3cf	597	if (ReturnValue == NULL) {\r
	598	return ReturnValue;\r
	599	}\r
	600	\r
ea7cd3ec	601	//\r
	602	// Allocate working buffer to contain substring in SupportedLanguages;\r
	603	//\r
	604	LangRfc3066 = AllocatePool (LanguageSize);\r
	605	if (LangRfc3066 == NULL) {\r
	606	FreePool (ReturnValue);\r
	607	return NULL;\r
	608	}\r
08e4b3cf	609	Languages = ReturnValue;\r
	610	LangCodes = SupportedLanguages;\r
	611	while (*LangCodes != 0) {\r
	612	HiiLibGetNextLanguage (&LangCodes, LangRfc3066);\r
	613	\r
	614	Status = ConvertRfc3066LanguageToIso639Language (LangRfc3066, LangIso639);\r
	615	if (!EFI_ERROR (Status)) {\r
	616	CopyMem (Languages, LangIso639, 3);\r
	617	Languages = Languages + 3;\r
	618	}\r
	619	}\r
	620	\r
ea7cd3ec	621	FreePool (LangRfc3066);\r
08e4b3cf	622	return ReturnValue;\r
	623	}\r
	624	\r
	625	\r