[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / Strings.c

/**@file\r
  This file implements the protocol functions related to string package.\r
  \r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
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 "HiiDatabase.h"\r
\r
typedef struct {\r
  CHAR8 *Iso639;\r
  CHAR8 *Rfc3066;\r
} ISO639TORFC3066MAP;\r
\r
ISO639TORFC3066MAP Iso639ToRfc3066Map [] = {\r
    {"eng", "en-US"},\r
    {"fra", "fr-FR"},\r
};\r
\r
CHAR8 *\r
ConvertIso639ToRfc3066 (\r
  CHAR8 *Iso638Lang\r
  )\r
{\r
  UINTN Index;\r
\r
  for (Index = 0; Index < sizeof (Iso639ToRfc3066Map) / sizeof (Iso639ToRfc3066Map[0]); Index++) {\r
    if (AsciiStrnCmp (Iso638Lang, Iso639ToRfc3066Map[Index].Iso639, AsciiStrSize (Iso638Lang)) == 0) {\r
      return Iso639ToRfc3066Map[Index].Rfc3066;\r
    }\r
  }\r
\r
  return (CHAR8 *) NULL;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
HiiTestString (\r
  IN     EFI_HII_PROTOCOL   *This,\r
  IN     CHAR16             *StringToTest,\r
  IN OUT UINT32             *FirstMissing,\r
  OUT    UINT32             *GlyphBufferSize\r
  )\r
/*++\r
\r
Routine Description:\r
  Test if all of the characters in a string have corresponding font characters.\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
{\r
  ASSERT (FALSE);\r
  return EFI_SUCCESS;\r
}\r
\r
\r
\r
EFI_STATUS\r
GetTagGuidByFwHiiHandle (\r
  IN  CONST HII_THUNK_PRIVATE_DATA      *Private,\r
  IN        FRAMEWORK_EFI_HII_HANDLE    FwHiiHandle,\r
  OUT       EFI_GUID                    *TagGuid\r
  )\r
{\r
  LIST_ENTRY                                *Link;\r
  HII_THUNK_CONTEXT                          *ThunkContext;\r
\r
  ASSERT (TagGuid != NULL);\r
\r
  Link = GetFirstNode (&Private->ThunkContextListHead);\r
  while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
\r
    ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
\r
    if (FwHiiHandle == ThunkContext->FwHiiHandle) {\r
      CopyGuid (TagGuid, &ThunkContext->TagGuid);\r
      return EFI_SUCCESS;\r
    }\r
\r
    Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
\r
\r
EFI_STATUS\r
EFIAPI\r
HiiNewString (\r
  IN     EFI_HII_PROTOCOL           *This,\r
  IN     CHAR16                     *Language,\r
  IN     FRAMEWORK_EFI_HII_HANDLE   Handle,\r
  IN OUT STRING_REF                 *Reference,\r
  IN     CHAR16                     *NewString\r
  )\r
/*++\r
\r
Routine Description:\r
  This function allows a new String to be added to an already existing String Package.\r
  We will make a buffer the size of the package + StrSize of the new string.  We will\r
  copy the string package that first gets changed and the following language packages until\r
  we encounter the NULL string package.  All this time we will ensure that the offsets have\r
  been adjusted.\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
{\r
  EFI_STATUS                                Status;\r
  HII_THUNK_PRIVATE_DATA                    *Private;\r
  EFI_GUID                                  TagGuid;\r
  LIST_ENTRY                                *Link;\r
  HII_THUNK_CONTEXT                          *ThunkContext;\r
  EFI_STRING_ID                             StringId;\r
  EFI_STRING_ID                             LastStringId;\r
  CHAR8                                     AsciiLanguage[ISO_639_2_ENTRY_SIZE + 1];\r
  BOOLEAN                                   Found;\r
  CHAR8                                     *Rfc3066AsciiLanguage;\r
\r
  LastStringId      = (EFI_STRING_ID) 0;\r
  StringId          = (EFI_STRING_ID) 0;\r
  Found             = FALSE;\r
  Rfc3066AsciiLanguage = NULL;\r
\r
  Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
\r
  Status = GetTagGuidByFwHiiHandle (Private, Handle, &TagGuid);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  if (Language != NULL) {\r
    ZeroMem (AsciiLanguage, sizeof (AsciiLanguage));;\r
    \r
    UnicodeStrToAsciiStr (Language, AsciiLanguage);\r
    Rfc3066AsciiLanguage = ConvertIso639ToRfc3066 (AsciiLanguage);\r
    ASSERT (Rfc3066AsciiLanguage != NULL);\r
  }\r
\r
  Link = GetFirstNode (&Private->ThunkContextListHead);\r
  while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
    ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
\r
    if (CompareGuid (&TagGuid, &ThunkContext->TagGuid)) {\r
      Found = TRUE;\r
      if (*Reference == 0) {\r
        //\r
        // Create a new string token.\r
        //\r
        if (Rfc3066AsciiLanguage == NULL) {\r
          //\r
          // For all languages in the package list.\r
          //\r
          Status = HiiLibNewString (ThunkContext->UefiHiiHandle, &StringId, NewString);\r
        } else {\r
          //\r
          // For specified language.\r
          //\r
          Status = mHiiStringProtocol->NewString (\r
                                         mHiiStringProtocol,\r
                                         ThunkContext->UefiHiiHandle,\r
                                         &StringId,\r
                                         Rfc3066AsciiLanguage,\r
                                         NULL,\r
                                         NewString,\r
                                         NULL\r
                                         );\r
        }\r
      } else {\r
        //\r
        // Update the existing string token.\r
        //\r
        if (Rfc3066AsciiLanguage == NULL) {\r
          //\r
          // For all languages in the package list.\r
          //\r
          Status = HiiLibSetString (ThunkContext->UefiHiiHandle, *Reference, NewString);\r
        } else {\r
          //\r
          // For specified language.\r
          //\r
          Status = mHiiStringProtocol->SetString (\r
                                       mHiiStringProtocol,\r
                                       ThunkContext->UefiHiiHandle,\r
                                       *Reference,\r
                                       Rfc3066AsciiLanguage,\r
                                       NewString,\r
                                       NULL\r
                                       );\r
        }\r
      }\r
      if (EFI_ERROR (Status)) {\r
        //\r
        // Only EFI_INVALID_PARAMETER is defined in HII 0.92 specification.\r
        //\r
        return EFI_INVALID_PARAMETER;\r
      }\r
\r
      if (*Reference == 0) {\r
        //\r
        // When creating new string token, make sure all created token is the same\r
        // for all string packages registered using FW HII interface.\r
        //\r
        if (LastStringId == (EFI_STRING_ID) 0) {\r
          LastStringId = StringId;\r
        } else {\r
          if (LastStringId != StringId) {\r
            ASSERT(FALSE);\r
            return EFI_INVALID_PARAMETER;\r
          }\r
        }\r
      }\r
    }\r
\r
    Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
  }\r
\r
  if (Found) {\r
    if (*Reference == 0) {\r
      *Reference = StringId;\r
    }\r
    Status = EFI_SUCCESS;\r
  } else {\r
    DEBUG((EFI_D_ERROR, "Thunk HiiNewString fails to find the String Packages to update\n"));\r
    //\r
    // BUGBUG: Remove ths ASSERT when development is done.\r
    //\r
    ASSERT (FALSE);\r
    Status = EFI_NOT_FOUND;\r
  }\r
  \r
  //\r
  // For UNI file, some String may not be defined for a language. This has been true for a lot of platform code.\r
  // For this case, EFI_NOT_FOUND will be returned. To allow the old code to be run without porting, we don't assert \r
  // on EFI_NOT_FOUND. The missing Strings will be shown if user select a differnt languages other than the default\r
  // English language for the platform.\r
  //\r
  ASSERT_EFI_ERROR (EFI_ERROR (Status) && Status != EFI_NOT_FOUND);  \r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
HiiResetStrings (\r
  IN     EFI_HII_PROTOCOL   *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE      Handle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
    This function removes any new strings that were added after the initial string export for this handle.\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetString (\r
  IN     EFI_HII_PROTOCOL           *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE   Handle,\r
  IN     STRING_REF                 Token,\r
  IN     BOOLEAN                    Raw,\r
  IN     CHAR16                     *LanguageString,\r
  IN OUT UINTN                      *BufferLengthTemp,\r
  OUT    EFI_STRING                 StringBuffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function extracts a string from a package already registered with the EFI HII database.\r
\r
Arguments:\r
  This            - A pointer to the EFI_HII_PROTOCOL instance.\r
  Handle          - The HII handle on which the string resides.\r
  Token           - The string token assigned to the string.\r
  Raw             - If TRUE, the string is returned unedited in the internal storage format described\r
                    above. If false, the string returned is edited by replacing <cr> with <space>\r
                    and by removing special characters such as the <wide> prefix.\r
  LanguageString  - Pointer to a NULL-terminated string containing a single ISO 639-2 language\r
                    identifier, indicating the language to print. If the LanguageString is empty (starts\r
                    with a NULL), the default system language will be used to determine the language.\r
  BufferLength    - Length of the StringBuffer. If the status reports that the buffer width is too\r
                    small, this parameter is filled with the length of the buffer needed.\r
  StringBuffer    - The buffer designed to receive the characters in the string. Type EFI_STRING is\r
                    defined in String.\r
\r
Returns:\r
  EFI_INVALID_PARAMETER - If input parameter is invalid.\r
  EFI_BUFFER_TOO_SMALL  - If the *BufferLength is too small.\r
  EFI_SUCCESS           - Operation is successful.\r
\r
--*/\r
{\r
  CHAR8                                 *Iso639AsciiLanguage;\r
  HII_THUNK_PRIVATE_DATA                *Private;\r
  CHAR8                                 *Rfc3066AsciiLanguage;\r
  EFI_HII_HANDLE                        UefiHiiHandle;\r
  EFI_STATUS                            Status;\r
\r
  Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
\r
  Iso639AsciiLanguage = NULL;\r
  Rfc3066AsciiLanguage = NULL;\r
\r
  if (LanguageString != NULL) {\r
    Iso639AsciiLanguage = AllocateZeroPool (StrLen (LanguageString) + 1);\r
    if (Iso639AsciiLanguage == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    UnicodeStrToAsciiStr  (LanguageString, Iso639AsciiLanguage);\r
\r
    //\r
    // Caller of Framework HII Interface uses the Language Identification String defined \r
    // in Iso639. So map it to the Language Identifier defined in RFC3066.\r
    //\r
    Rfc3066AsciiLanguage = ConvertIso639ToRfc3066 (Iso639AsciiLanguage);\r
\r
    //\r
    // If Rfc3066AsciiLanguage is NULL, more language mapping must be added to \r
    // Iso639ToRfc3066Map.\r
    //\r
    ASSERT (Rfc3066AsciiLanguage != NULL);\r
    \r
  }\r
\r
  UefiHiiHandle = FwHiiHandleToUefiHiiHandle (Private, Handle);\r
  if (UefiHiiHandle == NULL) {\r
    Status = EFI_NOT_FOUND;\r
    goto Done;\r
  }\r
\r
  if (Rfc3066AsciiLanguage == NULL) {\r
    Status =  HiiLibGetString (UefiHiiHandle, Token, StringBuffer, BufferLengthTemp);\r
  } else {\r
    Status = mHiiStringProtocol->GetString (\r
                                 mHiiStringProtocol,\r
                                 Rfc3066AsciiLanguage,\r
                                 UefiHiiHandle,\r
                                 Token,\r
                                 StringBuffer,\r
                                 BufferLengthTemp,\r
                                 NULL\r
                                 );\r
  }\r
\r
Done:\r
  SafeFreePool (Iso639AsciiLanguage);\r
  \r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetLine (\r
  IN     EFI_HII_PROTOCOL   *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE      Handle,\r
  IN     STRING_REF         Token,\r
  IN OUT UINT16             *Index,\r
  IN     UINT16             LineWidth,\r
  IN     CHAR16             *LanguageString,\r
  IN OUT UINT16             *BufferLength,\r
  OUT    EFI_STRING         StringBuffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function allows a program to extract a part of a string of not more than a given width.\r
  With repeated calls, this allows a calling program to extract "lines" of text that fit inside\r
  columns.  The effort of measuring the fit of strings inside columns is localized to this call.\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
{\r
  ASSERT (FALSE);\r
  return EFI_UNSUPPORTED;\r
}\r
\r
\r
Commit	Line	Data
4259256b	1	/**@file\r
0368663f	2	This file implements the protocol functions related to string package.\r
0368663f	3	\r
4259256b	4	Copyright (c) 2006 - 2008, Intel Corporation\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 "HiiDatabase.h"\r
	17	\r
133a9dfb	18	typedef struct {\r
	19	CHAR8 *Iso639;\r
	20	CHAR8 *Rfc3066;\r
	21	} ISO639TORFC3066MAP;\r
	22	\r
	23	ISO639TORFC3066MAP Iso639ToRfc3066Map [] = {\r
	24	{"eng", "en-US"},\r
	25	{"fra", "fr-FR"},\r
	26	};\r
	27	\r
	28	CHAR8 *\r
	29	ConvertIso639ToRfc3066 (\r
	30	CHAR8 *Iso638Lang\r
	31	)\r
	32	{\r
	33	UINTN Index;\r
	34	\r
	35	for (Index = 0; Index < sizeof (Iso639ToRfc3066Map) / sizeof (Iso639ToRfc3066Map[0]); Index++) {\r
	36	if (AsciiStrnCmp (Iso638Lang, Iso639ToRfc3066Map[Index].Iso639, AsciiStrSize (Iso638Lang)) == 0) {\r
	37	return Iso639ToRfc3066Map[Index].Rfc3066;\r
	38	}\r
	39	}\r
	40	\r
	41	return (CHAR8 *) NULL;\r
	42	}\r
	43	\r
	44	\r
4259256b	45	EFI_STATUS\r
	46	EFIAPI\r
	47	HiiTestString (\r
	48	IN EFI_HII_PROTOCOL *This,\r
	49	IN CHAR16 *StringToTest,\r
	50	IN OUT UINT32 *FirstMissing,\r
	51	OUT UINT32 *GlyphBufferSize\r
	52	)\r
	53	/*++\r
	54	\r
	55	Routine Description:\r
	56	Test if all of the characters in a string have corresponding font characters.\r
	57	\r
	58	Arguments:\r
	59	\r
	60	Returns:\r
	61	\r
	62	--*/\r
	63	{\r
	64	ASSERT (FALSE);\r
	65	return EFI_SUCCESS;\r
	66	}\r
	67	\r
133a9dfb	68	\r
133a9dfb	69	\r
4259256b	70	EFI_STATUS\r
0368663f	71	GetTagGuidByFwHiiHandle (\r
	72	IN CONST HII_THUNK_PRIVATE_DATA *Private,\r
	73	IN FRAMEWORK_EFI_HII_HANDLE FwHiiHandle,\r
4259256b	74	OUT EFI_GUID *TagGuid\r
	75	)\r
	76	{\r
0368663f	77	LIST_ENTRY *Link;\r
0368663f	78	HII_THUNK_CONTEXT *ThunkContext;\r
4259256b	79	\r
	80	ASSERT (TagGuid != NULL);\r
	81	\r
0368663f	82	Link = GetFirstNode (&Private->ThunkContextListHead);\r
0368663f	83	while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
4259256b	84	\r
0368663f	85	ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
4259256b	86	\r
0368663f	87	if (FwHiiHandle == ThunkContext->FwHiiHandle) {\r
0368663f	88	CopyGuid (TagGuid, &ThunkContext->TagGuid);\r
4259256b	89	return EFI_SUCCESS;\r
4259256b	90	}\r
0368663f	91	\r
0368663f	92	Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
4259256b	93	}\r
0368663f	94	\r
4259256b	95	return EFI_NOT_FOUND;\r
	96	}\r
	97	\r
0368663f	98	\r
0368663f	99	\r
4259256b	100	EFI_STATUS\r
0368663f	101	EFIAPI\r
	102	HiiNewString (\r
	103	IN EFI_HII_PROTOCOL *This,\r
	104	IN CHAR16 *Language,\r
	105	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
	106	IN OUT STRING_REF *Reference,\r
	107	IN CHAR16 *NewString\r
4259256b	108	)\r
0368663f	109	/*++\r
	110	\r
	111	Routine Description:\r
	112	This function allows a new String to be added to an already existing String Package.\r
	113	We will make a buffer the size of the package + StrSize of the new string. We will\r
	114	copy the string package that first gets changed and the following language packages until\r
	115	we encounter the NULL string package. All this time we will ensure that the offsets have\r
	116	been adjusted.\r
	117	\r
	118	Arguments:\r
	119	\r
	120	Returns:\r
	121	\r
	122	--*/\r
4259256b	123	{\r
4259256b	124	EFI_STATUS Status;\r
0368663f	125	HII_THUNK_PRIVATE_DATA *Private;\r
	126	EFI_GUID TagGuid;\r
	127	LIST_ENTRY *Link;\r
	128	HII_THUNK_CONTEXT *ThunkContext;\r
	129	EFI_STRING_ID StringId;\r
	130	EFI_STRING_ID LastStringId;\r
133a9dfb	131	CHAR8 AsciiLanguage[ISO_639_2_ENTRY_SIZE + 1];\r
4259256b	132	BOOLEAN Found;\r
133a9dfb	133	CHAR8 *Rfc3066AsciiLanguage;\r
4259256b	134	\r
0368663f	135	LastStringId = (EFI_STRING_ID) 0;\r
	136	StringId = (EFI_STRING_ID) 0;\r
	137	Found = FALSE;\r
133a9dfb	138	Rfc3066AsciiLanguage = NULL;\r
4259256b	139	\r
0368663f	140	Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
	141	\r
	142	Status = GetTagGuidByFwHiiHandle (Private, Handle, &TagGuid);\r
	143	ASSERT_EFI_ERROR (Status);\r
	144	\r
	145	if (Language != NULL) {\r
133a9dfb	146	ZeroMem (AsciiLanguage, sizeof (AsciiLanguage));;\r
133a9dfb	147	\r
ea58467b	148	UnicodeStrToAsciiStr (Language, AsciiLanguage);\r
133a9dfb	149	Rfc3066AsciiLanguage = ConvertIso639ToRfc3066 (AsciiLanguage);\r
133a9dfb	150	ASSERT (Rfc3066AsciiLanguage != NULL);\r
ea58467b	151	}\r
4259256b	152	\r
0368663f	153	Link = GetFirstNode (&Private->ThunkContextListHead);\r
	154	while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
	155	ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
4259256b	156	\r
0368663f	157	if (CompareGuid (&TagGuid, &ThunkContext->TagGuid)) {\r
4259256b	158	Found = TRUE;\r
4259256b	159	if (*Reference == 0) {\r
0368663f	160	//\r
	161	// Create a new string token.\r
	162	//\r
133a9dfb	163	if (Rfc3066AsciiLanguage == NULL) {\r
0368663f	164	//\r
	165	// For all languages in the package list.\r
	166	//\r
	167	Status = HiiLibNewString (ThunkContext->UefiHiiHandle, &StringId, NewString);\r
ea58467b	168	} else {\r
0368663f	169	//\r
	170	// For specified language.\r
	171	//\r
ea58467b	172	Status = mHiiStringProtocol->NewString (\r
ea58467b	173	mHiiStringProtocol,\r
0368663f	174	ThunkContext->UefiHiiHandle,\r
0368663f	175	&StringId,\r
133a9dfb	176	Rfc3066AsciiLanguage,\r
ea58467b	177	NULL,\r
	178	NewString,\r
	179	NULL\r
	180	);\r
	181	}\r
4259256b	182	} else {\r
0368663f	183	//\r
	184	// Update the existing string token.\r
	185	//\r
133a9dfb	186	if (Rfc3066AsciiLanguage == NULL) {\r
0368663f	187	//\r
	188	// For all languages in the package list.\r
	189	//\r
	190	Status = HiiLibSetString (ThunkContext->UefiHiiHandle, *Reference, NewString);\r
ea58467b	191	} else {\r
0368663f	192	//\r
	193	// For specified language.\r
	194	//\r
ea58467b	195	Status = mHiiStringProtocol->SetString (\r
ea58467b	196	mHiiStringProtocol,\r
0368663f	197	ThunkContext->UefiHiiHandle,\r
ea58467b	198	*Reference,\r
133a9dfb	199	Rfc3066AsciiLanguage,\r
ea58467b	200	NewString,\r
	201	NULL\r
	202	);\r
	203	}\r
4259256b	204	}\r
4259256b	205	if (EFI_ERROR (Status)) {\r
0368663f	206	//\r
	207	// Only EFI_INVALID_PARAMETER is defined in HII 0.92 specification.\r
	208	//\r
	209	return EFI_INVALID_PARAMETER;\r
4259256b	210	}\r
0368663f	211	\r
4259256b	212	if (*Reference == 0) {\r
0368663f	213	//\r
	214	// When creating new string token, make sure all created token is the same\r
	215	// for all string packages registered using FW HII interface.\r
	216	//\r
	217	if (LastStringId == (EFI_STRING_ID) 0) {\r
	218	LastStringId = StringId;\r
4259256b	219	} else {\r
0368663f	220	if (LastStringId != StringId) {\r
4259256b	221	ASSERT(FALSE);\r
	222	return EFI_INVALID_PARAMETER;\r
	223	}\r
	224	}\r
	225	}\r
	226	}\r
0368663f	227	\r
0368663f	228	Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
4259256b	229	}\r
	230	\r
	231	if (Found) {\r
0368663f	232	if (*Reference == 0) {\r
	233	*Reference = StringId;\r
	234	}\r
4259256b	235	Status = EFI_SUCCESS;\r
4259256b	236	} else {\r
0368663f	237	DEBUG((EFI_D_ERROR, "Thunk HiiNewString fails to find the String Packages to update\n"));\r
	238	//\r
	239	// BUGBUG: Remove ths ASSERT when development is done.\r
	240	//\r
46b5ebc8	241	ASSERT (FALSE);\r
4259256b	242	Status = EFI_NOT_FOUND;\r
	243	}\r
	244	\r
46b5ebc8	245	//\r
	246	// For UNI file, some String may not be defined for a language. This has been true for a lot of platform code.\r
	247	// For this case, EFI_NOT_FOUND will be returned. To allow the old code to be run without porting, we don't assert \r
ea58467b	248	// on EFI_NOT_FOUND. The missing Strings will be shown if user select a differnt languages other than the default\r
ea58467b	249	// English language for the platform.\r
46b5ebc8	250	//\r
46b5ebc8	251	ASSERT_EFI_ERROR (EFI_ERROR (Status) && Status != EFI_NOT_FOUND); \r
4259256b	252	\r
46b5ebc8	253	return Status;\r
4259256b	254	}\r
	255	\r
	256	EFI_STATUS\r
	257	EFIAPI\r
	258	HiiResetStrings (\r
	259	IN EFI_HII_PROTOCOL *This,\r
	260	IN FRAMEWORK_EFI_HII_HANDLE Handle\r
	261	)\r
	262	/*++\r
	263	\r
	264	Routine Description:\r
	265	\r
	266	This function removes any new strings that were added after the initial string export for this handle.\r
	267	\r
	268	Arguments:\r
	269	\r
	270	Returns:\r
	271	\r
	272	--*/\r
	273	{\r
0368663f	274	return EFI_SUCCESS;\r
4259256b	275	}\r
	276	\r
	277	EFI_STATUS\r
	278	EFIAPI\r
	279	HiiGetString (\r
133a9dfb	280	IN EFI_HII_PROTOCOL *This,\r
	281	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
	282	IN STRING_REF Token,\r
	283	IN BOOLEAN Raw,\r
	284	IN CHAR16 *LanguageString,\r
	285	IN OUT UINTN *BufferLengthTemp,\r
	286	OUT EFI_STRING StringBuffer\r
4259256b	287	)\r
	288	/*++\r
	289	\r
	290	Routine Description:\r
	291	\r
	292	This function extracts a string from a package already registered with the EFI HII database.\r
	293	\r
	294	Arguments:\r
	295	This - A pointer to the EFI_HII_PROTOCOL instance.\r
	296	Handle - The HII handle on which the string resides.\r
	297	Token - The string token assigned to the string.\r
	298	Raw - If TRUE, the string is returned unedited in the internal storage format described\r
	299	above. If false, the string returned is edited by replacing <cr> with <space>\r
	300	and by removing special characters such as the <wide> prefix.\r
	301	LanguageString - Pointer to a NULL-terminated string containing a single ISO 639-2 language\r
	302	identifier, indicating the language to print. If the LanguageString is empty (starts\r
	303	with a NULL), the default system language will be used to determine the language.\r
	304	BufferLength - Length of the StringBuffer. If the status reports that the buffer width is too\r
	305	small, this parameter is filled with the length of the buffer needed.\r
	306	StringBuffer - The buffer designed to receive the characters in the string. Type EFI_STRING is\r
	307	defined in String.\r
	308	\r
	309	Returns:\r
	310	EFI_INVALID_PARAMETER - If input parameter is invalid.\r
	311	EFI_BUFFER_TOO_SMALL - If the *BufferLength is too small.\r
	312	EFI_SUCCESS - Operation is successful.\r
	313	\r
	314	--*/\r
	315	{\r
133a9dfb	316	CHAR8 *Iso639AsciiLanguage;\r
0368663f	317	HII_THUNK_PRIVATE_DATA *Private;\r
133a9dfb	318	CHAR8 *Rfc3066AsciiLanguage;\r
	319	EFI_HII_HANDLE UefiHiiHandle;\r
	320	EFI_STATUS Status;\r
4259256b	321	\r
0368663f	322	Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r
4259256b	323	\r
133a9dfb	324	Iso639AsciiLanguage = NULL;\r
	325	Rfc3066AsciiLanguage = NULL;\r
	326	\r
	327	if (LanguageString != NULL) {\r
	328	Iso639AsciiLanguage = AllocateZeroPool (StrLen (LanguageString) + 1);\r
	329	if (Iso639AsciiLanguage == NULL) {\r
4259256b	330	return EFI_OUT_OF_RESOURCES;\r
4259256b	331	}\r
133a9dfb	332	UnicodeStrToAsciiStr (LanguageString, Iso639AsciiLanguage);\r
ea58467b	333	\r
133a9dfb	334	//\r
	335	// Caller of Framework HII Interface uses the Language Identification String defined \r
	336	// in Iso639. So map it to the Language Identifier defined in RFC3066.\r
	337	//\r
	338	Rfc3066AsciiLanguage = ConvertIso639ToRfc3066 (Iso639AsciiLanguage);\r
1668bd49	339	\r
	340	//\r
	341	// If Rfc3066AsciiLanguage is NULL, more language mapping must be added to \r
	342	// Iso639ToRfc3066Map.\r
	343	//\r
	344	ASSERT (Rfc3066AsciiLanguage != NULL);\r
ea58467b	345	\r
4259256b	346	}\r
4259256b	347	\r
133a9dfb	348	UefiHiiHandle = FwHiiHandleToUefiHiiHandle (Private, Handle);\r
	349	if (UefiHiiHandle == NULL) {\r
	350	Status = EFI_NOT_FOUND;\r
	351	goto Done;\r
	352	}\r
4259256b	353	\r
133a9dfb	354	if (Rfc3066AsciiLanguage == NULL) {\r
	355	Status = HiiLibGetString (UefiHiiHandle, Token, StringBuffer, BufferLengthTemp);\r
	356	} else {\r
	357	Status = mHiiStringProtocol->GetString (\r
	358	mHiiStringProtocol,\r
	359	Rfc3066AsciiLanguage,\r
	360	UefiHiiHandle,\r
	361	Token,\r
	362	StringBuffer,\r
	363	BufferLengthTemp,\r
	364	NULL\r
	365	);\r
4259256b	366	}\r
4259256b	367	\r
133a9dfb	368	Done:\r
	369	SafeFreePool (Iso639AsciiLanguage);\r
	370	\r
	371	return Status;\r
4259256b	372	}\r
	373	\r
	374	EFI_STATUS\r
	375	EFIAPI\r
	376	HiiGetLine (\r
	377	IN EFI_HII_PROTOCOL *This,\r
	378	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
	379	IN STRING_REF Token,\r
	380	IN OUT UINT16 *Index,\r
	381	IN UINT16 LineWidth,\r
	382	IN CHAR16 *LanguageString,\r
	383	IN OUT UINT16 *BufferLength,\r
	384	OUT EFI_STRING StringBuffer\r
	385	)\r
	386	/*++\r
	387	\r
	388	Routine Description:\r
	389	\r
	390	This function allows a program to extract a part of a string of not more than a given width.\r
	391	With repeated calls, this allows a calling program to extract "lines" of text that fit inside\r
	392	columns. The effort of measuring the fit of strings inside columns is localized to this call.\r
	393	\r
	394	Arguments:\r
	395	\r
	396	Returns:\r
	397	\r
	398	--*/\r
	399	{\r
	400	ASSERT (FALSE);\r
	401	return EFI_UNSUPPORTED;\r
	402	}\r
	403	\r
1668bd49	404	\r