[mirror_edk2.git] / MdePkg / Include / Protocol / HiiString.h

/** @file\r
  The file provides services to manipulate string data.\r
  \r
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution.  \r
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
#ifndef __HII_STRING_H__\r
#define __HII_STRING_H__\r
\r
#include <Protocol/HiiFont.h>\r
\r
#define EFI_HII_STRING_PROTOCOL_GUID \\r
  { 0xfd96974, 0x23aa, 0x4cdc, { 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a } }\r
\r
typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL;\r
\r
/**\r
  This function adds the string String to the group of strings owned by PackageList, with the\r
  specified font information StringFontInfo, and returns a new string id.\r
  The new string identifier is guaranteed to be unique within the package list. \r
  That new string identifier is reserved for all languages in the package list. \r
\r
  @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
  @param  PackageList            The 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  Language               Points to the language for the new string.\r
  @param  LanguageName           Points to the printable language name to associate\r
                                 with the passed in  Language field.If LanguageName\r
                                 is not NULL and the string package header's\r
                                 LanguageName  associated with a given Language is\r
                                 not zero, the LanguageName being passed in will\r
                                 be ignored.\r
  @param  String                 Points to the new null-terminated string.\r
  @param  StringFontInfo         Points to the new string's font information or\r
                                 NULL if the string should have the default system\r
                                 font, size and style.\r
\r
  @retval EFI_SUCCESS            The new string was added successfully.\r
  @retval EFI_NOT_FOUND          The specified PackageList could not be found in\r
                                 database.\r
  @retval EFI_OUT_OF_RESOURCES   Could not add the string due to lack of resources.\r
  @retval EFI_INVALID_PARAMETER  String is NULL, or StringId is NULL, or Language is NULL.\r
  @retval EFI_INVALID_PARAMETER  The specified StringFontInfo does not exist in\r
                                 current database.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_NEW_STRING)(\r
  IN CONST  EFI_HII_STRING_PROTOCOL   *This,\r
  IN        EFI_HII_HANDLE            PackageList,\r
  OUT       EFI_STRING_ID             *StringId,\r
  IN CONST  CHAR8                     *Language,\r
  IN  CONST CHAR16                    *LanguageName, OPTIONAL  \r
  IN CONST  EFI_STRING                String,\r
  IN CONST  EFI_FONT_INFO             *StringFontInfo OPTIONAL\r
);\r
\r
\r
/**\r
  This function retrieves the string specified by StringId which is associated\r
  with the specified PackageList in the language Language and copies it into\r
  the buffer specified by String.\r
\r
  @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
  @param  Language               Points to the language for the retrieved string.\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
  @param  StringFontInfo         If not NULL, points to the string's font\r
                                 information.  It's caller's responsibility to free\r
                                 this buffer.\r
\r
  @retval EFI_SUCCESS            The string was returned successfully.\r
  @retval EFI_NOT_FOUND          The string specified by StringId is not available.\r
                                 The specified PackageList is not in the database.\r
  @retval EFI_INVALID_LANGUAGE    The string specified by StringId is available but \r
                                  not in the specified language.\r
  @retval EFI_BUFFER_TOO_SMALL   The buffer specified by StringSize is too small to\r
                                 hold the string.\r
  @retval EFI_INVALID_PARAMETER   The Language or StringSize was NULL.\r
  @retval EFI_INVALID_PARAMETER   The value referenced by StringSize was not zero and\r
                                  String was NULL.\r
  @retval EFI_OUT_OF_RESOURCES    There were insufficient resources to complete the\r
                                  request.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_GET_STRING)(\r
  IN CONST  EFI_HII_STRING_PROTOCOL *This,\r
  IN CONST  CHAR8                   *Language,\r
  IN        EFI_HII_HANDLE          PackageList,\r
  IN        EFI_STRING_ID           StringId,\r
  OUT       EFI_STRING              String,\r
  IN OUT    UINTN                   *StringSize,\r
  OUT       EFI_FONT_INFO           **StringFontInfo OPTIONAL\r
);\r
\r
/**\r
  This function updates the string specified by StringId in the specified PackageList to the text\r
  specified by String and, optionally, the font information specified by StringFontInfo.\r
\r
  @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
  @param  PackageList            The package list containing the strings.\r
  @param  StringId               The string's id, which is unique within\r
                                 PackageList.\r
  @param  Language               Points to the language for the updated string.\r
  @param  String                 Points to the new null-terminated string.\r
  @param  StringFontInfo         Points to the string's font information or NULL if\r
                                 the  string font information is not changed.\r
\r
  @retval EFI_SUCCESS            The string was updated successfully.\r
  @retval EFI_NOT_FOUND          The string specified by StringId is not in the\r
                                 database.\r
  @retval EFI_INVALID_PARAMETER  The String or Language was NULL.\r
  @retval EFI_INVALID_PARAMETER  The specified StringFontInfo does not exist in\r
                                 current database.\r
  @retval EFI_OUT_OF_RESOURCES   The system is out of resources to accomplish the\r
                                 task.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_SET_STRING)(\r
  IN CONST  EFI_HII_STRING_PROTOCOL *This,\r
  IN        EFI_HII_HANDLE          PackageList,\r
  IN        EFI_STRING_ID           StringId,\r
  IN CONST  CHAR8                   *Language,\r
  IN        EFI_STRING              String,\r
  IN CONST  EFI_FONT_INFO           *StringFontInfo OPTIONAL\r
);\r
\r
\r
/**\r
  This function returns the list of supported languages.\r
\r
  @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
  @param  PackageList            The package list to examine.\r
  @param  Languages              Points to the buffer to hold the returned\r
                                 null-terminated ASCII string.\r
  @param  LanguagesSize          On entry, points to the size of the buffer pointed\r
                                 to by Languages, in bytes. On return, points to\r
                                 the length of Languages, in bytes.\r
\r
  @retval EFI_SUCCESS            The languages were returned successfully.\r
  @retval EFI_INVALID_PARAMETER  The LanguagesSize was NULL.\r
  @retval EFI_INVALID_PARAMETER  The value referenced by LanguagesSize is not zero\r
                                 and Languages is NULL.\r
  @retval EFI_BUFFER_TOO_SMALL   The LanguagesSize is too small to hold the list of\r
                                 supported languages. LanguageSize is updated to\r
                                 contain the required size.\r
  @retval EFI_NOT_FOUND          Could not find string package in specified\r
                                 packagelist.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_GET_LANGUAGES)(\r
  IN CONST  EFI_HII_STRING_PROTOCOL   *This,\r
  IN        EFI_HII_HANDLE            PackageList,\r
  IN OUT    CHAR8                     *Languages,\r
  IN OUT    UINTN                     *LanguagesSize\r
);\r
\r
\r
/**\r
  Each string package has associated with it a single primary language and zero\r
  or more secondary languages. This routine returns the secondary languages\r
  associated with a package list.\r
\r
  @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
  @param  PackageList            The package list to examine.\r
  @param  PrimaryLanguage        Points to the null-terminated ASCII string that specifies\r
                                 the primary language. Languages are specified in the\r
                                 format specified in Appendix M of the UEFI 2.0 specification.\r
  @param  SecondaryLanguages     Points to the buffer to hold the returned null-terminated\r
                                 ASCII string that describes the list of\r
                                 secondary languages for the specified\r
                                 PrimaryLanguage. If there are no secondary\r
                                 languages, the function returns successfully, but\r
                                 this is set to NULL.\r
  @param  SecondaryLanguagesSize On entry, points to the size of the buffer pointed\r
                                 to by SecondaryLanguages, in bytes. On return,\r
                                 points to the length of SecondaryLanguages in bytes.\r
\r
  @retval EFI_SUCCESS            Secondary languages were correctly returned.\r
  @retval EFI_INVALID_PARAMETER  PrimaryLanguage or SecondaryLanguagesSize was NULL.\r
  @retval EFI_INVALID_PARAMETER  The value referenced by SecondaryLanguagesSize is not\r
                                 zero and SecondaryLanguages is NULL.\r
  @retval EFI_BUFFER_TOO_SMALL   The buffer specified by SecondaryLanguagesSize is\r
                                 too small to hold the returned information.\r
                                 SecondaryLanguageSize is updated to hold the size of\r
                                 the buffer required.\r
  @retval EFI_INVALID_LANGUAGE   The language specified by PrimaryLanguage is not\r
                                 present in the specified package list.\r
  @retval EFI_NOT_FOUND          The specified PackageList is not in the Database.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_GET_2ND_LANGUAGES)(\r
  IN CONST  EFI_HII_STRING_PROTOCOL   *This,\r
  IN        EFI_HII_HANDLE            PackageList,\r
  IN CONST  CHAR8                     *PrimaryLanguage,\r
  IN OUT    CHAR8                     *SecondaryLanguages,\r
  IN OUT    UINTN                     *SecondaryLanguagesSize\r
);\r
\r
\r
///\r
/// Services to manipulate the string.\r
///\r
struct _EFI_HII_STRING_PROTOCOL {\r
  EFI_HII_NEW_STRING        NewString;\r
  EFI_HII_GET_STRING        GetString;\r
  EFI_HII_SET_STRING        SetString;\r
  EFI_HII_GET_LANGUAGES     GetLanguages;\r
  EFI_HII_GET_2ND_LANGUAGES GetSecondaryLanguages;\r
};\r
\r
\r
extern EFI_GUID gEfiHiiStringProtocolGuid;\r
\r
#endif\r
\r
Commit	Line	Data
	1	/** @file\r
	2	The file provides services to manipulate string data.\r
	3	\r
	4	Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
	5	This program and the accompanying materials are licensed and made available under \r
	6	the terms and conditions of the BSD License that accompanies this distribution. \r
	7	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	#ifndef __HII_STRING_H__\r
	16	#define __HII_STRING_H__\r
	17	\r
	18	#include <Protocol/HiiFont.h>\r
	19	\r
	20	#define EFI_HII_STRING_PROTOCOL_GUID \\r
	21	{ 0xfd96974, 0x23aa, 0x4cdc, { 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a } }\r
	22	\r
	23	typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL;\r
	24	\r
	25	/**\r
	26	This function adds the string String to the group of strings owned by PackageList, with the\r
	27	specified font information StringFontInfo, and returns a new string id.\r
	28	The new string identifier is guaranteed to be unique within the package list. \r
	29	That new string identifier is reserved for all languages in the package list. \r
	30	\r
	31	@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
	32	@param PackageList The handle of the package list where this string will\r
	33	be added.\r
	34	@param StringId On return, contains the new strings id, which is\r
	35	unique within PackageList.\r
	36	@param Language Points to the language for the new string.\r
	37	@param LanguageName Points to the printable language name to associate\r
	38	with the passed in Language field.If LanguageName\r
	39	is not NULL and the string package header's\r
	40	LanguageName associated with a given Language is\r
	41	not zero, the LanguageName being passed in will\r
	42	be ignored.\r
	43	@param String Points to the new null-terminated string.\r
	44	@param StringFontInfo Points to the new string's font information or\r
	45	NULL if the string should have the default system\r
	46	font, size and style.\r
	47	\r
	48	@retval EFI_SUCCESS The new string was added successfully.\r
	49	@retval EFI_NOT_FOUND The specified PackageList could not be found in\r
	50	database.\r
	51	@retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.\r
	52	@retval EFI_INVALID_PARAMETER String is NULL, or StringId is NULL, or Language is NULL.\r
	53	@retval EFI_INVALID_PARAMETER The specified StringFontInfo does not exist in\r
	54	current database.\r
	55	\r
	56	**/\r
	57	typedef\r
	58	EFI_STATUS\r
	59	(EFIAPI *EFI_HII_NEW_STRING)(\r
	60	IN CONST EFI_HII_STRING_PROTOCOL *This,\r
	61	IN EFI_HII_HANDLE PackageList,\r
	62	OUT EFI_STRING_ID *StringId,\r
	63	IN CONST CHAR8 *Language,\r
	64	IN CONST CHAR16 *LanguageName, OPTIONAL \r
	65	IN CONST EFI_STRING String,\r
	66	IN CONST EFI_FONT_INFO *StringFontInfo OPTIONAL\r
	67	);\r
	68	\r
	69	\r
	70	/**\r
	71	This function retrieves the string specified by StringId which is associated\r
	72	with the specified PackageList in the language Language and copies it into\r
	73	the buffer specified by String.\r
	74	\r
	75	@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
	76	@param Language Points to the language for the retrieved string.\r
	77	@param PackageList The package list in the HII database to search for\r
	78	the specified string.\r
	79	@param StringId The string's id, which is unique within\r
	80	PackageList.\r
	81	@param String Points to the new null-terminated string.\r
	82	@param StringSize On entry, points to the size of the buffer pointed\r
	83	to by String, in bytes. On return, points to the\r
	84	length of the string, in bytes.\r
	85	@param StringFontInfo If not NULL, points to the string's font\r
	86	information. It's caller's responsibility to free\r
	87	this buffer.\r
	88	\r
	89	@retval EFI_SUCCESS The string was returned successfully.\r
	90	@retval EFI_NOT_FOUND The string specified by StringId is not available.\r
	91	The specified PackageList is not in the database.\r
	92	@retval EFI_INVALID_LANGUAGE The string specified by StringId is available but \r
	93	not in the specified language.\r
	94	@retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small to\r
	95	hold the string.\r
	96	@retval EFI_INVALID_PARAMETER The Language or StringSize was NULL.\r
	97	@retval EFI_INVALID_PARAMETER The value referenced by StringSize was not zero and\r
	98	String was NULL.\r
	99	@retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the\r
	100	request.\r
	101	\r
	102	**/\r
	103	typedef\r
	104	EFI_STATUS\r
	105	(EFIAPI *EFI_HII_GET_STRING)(\r
	106	IN CONST EFI_HII_STRING_PROTOCOL *This,\r
	107	IN CONST CHAR8 *Language,\r
	108	IN EFI_HII_HANDLE PackageList,\r
	109	IN EFI_STRING_ID StringId,\r
	110	OUT EFI_STRING String,\r
	111	IN OUT UINTN *StringSize,\r
	112	OUT EFI_FONT_INFO **StringFontInfo OPTIONAL\r
	113	);\r
	114	\r
	115	/**\r
	116	This function updates the string specified by StringId in the specified PackageList to the text\r
	117	specified by String and, optionally, the font information specified by StringFontInfo.\r
	118	\r
	119	@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
	120	@param PackageList The package list containing the strings.\r
	121	@param StringId The string's id, which is unique within\r
	122	PackageList.\r
	123	@param Language Points to the language for the updated string.\r
	124	@param String Points to the new null-terminated string.\r
	125	@param StringFontInfo Points to the string's font information or NULL if\r
	126	the string font information is not changed.\r
	127	\r
	128	@retval EFI_SUCCESS The string was updated successfully.\r
	129	@retval EFI_NOT_FOUND The string specified by StringId is not in the\r
	130	database.\r
	131	@retval EFI_INVALID_PARAMETER The String or Language was NULL.\r
	132	@retval EFI_INVALID_PARAMETER The specified StringFontInfo does not exist in\r
	133	current database.\r
	134	@retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the\r
	135	task.\r
	136	\r
	137	**/\r
	138	typedef\r
	139	EFI_STATUS\r
	140	(EFIAPI *EFI_HII_SET_STRING)(\r
	141	IN CONST EFI_HII_STRING_PROTOCOL *This,\r
	142	IN EFI_HII_HANDLE PackageList,\r
	143	IN EFI_STRING_ID StringId,\r
	144	IN CONST CHAR8 *Language,\r
	145	IN EFI_STRING String,\r
	146	IN CONST EFI_FONT_INFO *StringFontInfo OPTIONAL\r
	147	);\r
	148	\r
	149	\r
	150	/**\r
	151	This function returns the list of supported languages.\r
	152	\r
	153	@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
	154	@param PackageList The package list to examine.\r
	155	@param Languages Points to the buffer to hold the returned\r
	156	null-terminated ASCII string.\r
	157	@param LanguagesSize On entry, points to the size of the buffer pointed\r
	158	to by Languages, in bytes. On return, points to\r
	159	the length of Languages, in bytes.\r
	160	\r
	161	@retval EFI_SUCCESS The languages were returned successfully.\r
	162	@retval EFI_INVALID_PARAMETER The LanguagesSize was NULL.\r
	163	@retval EFI_INVALID_PARAMETER The value referenced by LanguagesSize is not zero\r
	164	and Languages is NULL.\r
	165	@retval EFI_BUFFER_TOO_SMALL The LanguagesSize is too small to hold the list of\r
	166	supported languages. LanguageSize is updated to\r
	167	contain the required size.\r
	168	@retval EFI_NOT_FOUND Could not find string package in specified\r
	169	packagelist.\r
	170	\r
	171	**/\r
	172	typedef\r
	173	EFI_STATUS\r
	174	(EFIAPI *EFI_HII_GET_LANGUAGES)(\r
	175	IN CONST EFI_HII_STRING_PROTOCOL *This,\r
	176	IN EFI_HII_HANDLE PackageList,\r
	177	IN OUT CHAR8 *Languages,\r
	178	IN OUT UINTN *LanguagesSize\r
	179	);\r
	180	\r
	181	\r
	182	/**\r
	183	Each string package has associated with it a single primary language and zero\r
	184	or more secondary languages. This routine returns the secondary languages\r
	185	associated with a package list.\r
	186	\r
	187	@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
	188	@param PackageList The package list to examine.\r
	189	@param PrimaryLanguage Points to the null-terminated ASCII string that specifies\r
	190	the primary language. Languages are specified in the\r
	191	format specified in Appendix M of the UEFI 2.0 specification.\r
	192	@param SecondaryLanguages Points to the buffer to hold the returned null-terminated\r
	193	ASCII string that describes the list of\r
	194	secondary languages for the specified\r
	195	PrimaryLanguage. If there are no secondary\r
	196	languages, the function returns successfully, but\r
	197	this is set to NULL.\r
	198	@param SecondaryLanguagesSize On entry, points to the size of the buffer pointed\r
	199	to by SecondaryLanguages, in bytes. On return,\r
	200	points to the length of SecondaryLanguages in bytes.\r
	201	\r
	202	@retval EFI_SUCCESS Secondary languages were correctly returned.\r
	203	@retval EFI_INVALID_PARAMETER PrimaryLanguage or SecondaryLanguagesSize was NULL.\r
	204	@retval EFI_INVALID_PARAMETER The value referenced by SecondaryLanguagesSize is not\r
	205	zero and SecondaryLanguages is NULL.\r
	206	@retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondaryLanguagesSize is\r
	207	too small to hold the returned information.\r
	208	SecondaryLanguageSize is updated to hold the size of\r
	209	the buffer required.\r
	210	@retval EFI_INVALID_LANGUAGE The language specified by PrimaryLanguage is not\r
	211	present in the specified package list.\r
	212	@retval EFI_NOT_FOUND The specified PackageList is not in the Database.\r
	213	\r
	214	**/\r
	215	typedef\r
	216	EFI_STATUS\r
	217	(EFIAPI *EFI_HII_GET_2ND_LANGUAGES)(\r
	218	IN CONST EFI_HII_STRING_PROTOCOL *This,\r
	219	IN EFI_HII_HANDLE PackageList,\r
	220	IN CONST CHAR8 *PrimaryLanguage,\r
	221	IN OUT CHAR8 *SecondaryLanguages,\r
	222	IN OUT UINTN *SecondaryLanguagesSize\r
	223	);\r
	224	\r
	225	\r
	226	///\r
	227	/// Services to manipulate the string.\r
	228	///\r
	229	struct _EFI_HII_STRING_PROTOCOL {\r
	230	EFI_HII_NEW_STRING NewString;\r
	231	EFI_HII_GET_STRING GetString;\r
	232	EFI_HII_SET_STRING SetString;\r
	233	EFI_HII_GET_LANGUAGES GetLanguages;\r
	234	EFI_HII_GET_2ND_LANGUAGES GetSecondaryLanguages;\r
	235	};\r
	236	\r
	237	\r
	238	extern EFI_GUID gEfiHiiStringProtocolGuid;\r
	239	\r
	240	#endif\r
	241	\r