[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
  @retval EFI_NOT_FOUND          The string specified by StringId is available but\r
                                 not in the specified language.\r
                                 The specified PackageList is not in the database.\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 String or Language or StringSize 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 Languages or LanguagesSize was 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 SecondaryLanguages or\r
                                 SecondaryLanguagesSize was 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
d1f95000	1	/** @file\r
	2	The file provides services to manipulate string data.\r
	3	\r
4f077902	4	Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
af2dc6a7	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
d1f95000	12	\r
d1f95000	13	**/\r
	14	\r
	15	#ifndef __HII_STRING_H__\r
	16	#define __HII_STRING_H__\r
	17	\r
7d582d6b	18	#include <Protocol/HiiFont.h>\r
7d582d6b	19	\r
1e966f63	20	#define EFI_HII_STRING_PROTOCOL_GUID \\r
1e966f63	21	{ 0xfd96974, 0x23aa, 0x4cdc, { 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a } }\r
d1f95000	22	\r
	23	typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL;\r
	24	\r
d1f95000	25	/**\r
4ca9b6c4	26	This function adds the string String to the group of strings owned by PackageList, with the\r
af2dc6a7	27	specified font information StringFontInfo, and returns a new string id.\r
d6a82eaf LG	28	The new string identifier is guaranteed to be unique within the package list. \r
d6a82eaf LG	29	That new string identifier is reserved for all languages in the package list. \r
4ca9b6c4 LG	30	\r
4ca9b6c4 LG	31	@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
af2dc6a7	32	@param PackageList The handle of the package list where this string will\r
4ca9b6c4 LG	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
af2dc6a7	41	not zero, the LanguageName being passed in will\r
4ca9b6c4 LG	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
af2dc6a7	52	@retval EFI_INVALID_PARAMETER String is NULL, or StringId is NULL, or Language is NULL.\r
4ca9b6c4 LG	53	@retval EFI_INVALID_PARAMETER The specified StringFontInfo does not exist in\r
4ca9b6c4 LG	54	current database.\r
d1f95000	55	\r
	56	**/\r
	57	typedef\r
	58	EFI_STATUS\r
8b13229b	59	(EFIAPI *EFI_HII_NEW_STRING)(\r
d1f95000	60	IN CONST EFI_HII_STRING_PROTOCOL *This,\r
7d582d6b	61	IN EFI_HII_HANDLE PackageList,\r
7d582d6b	62	OUT EFI_STRING_ID *StringId,\r
d1f95000	63	IN CONST CHAR8 *Language,\r
7d582d6b	64	IN CONST CHAR16 *LanguageName, OPTIONAL \r
d1f95000	65	IN CONST EFI_STRING String,\r
7d582d6b	66	IN CONST EFI_FONT_INFO *StringFontInfo OPTIONAL\r
d1f95000	67	);\r
	68	\r
	69	\r
	70	/**\r
4ca9b6c4 LG	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	@retval EFI_NOT_FOUND The string specified by StringId is available but\r
	92	not in the specified language.\r
	93	The specified PackageList is not in the database.\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 String or Language or StringSize was NULL.\r
	97	@retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the\r
	98	request.\r
d1f95000	99	\r
d1f95000	100	**/\r
	101	typedef\r
	102	EFI_STATUS\r
8b13229b	103	(EFIAPI *EFI_HII_GET_STRING)(\r
d1f95000	104	IN CONST EFI_HII_STRING_PROTOCOL *This,\r
d1f95000	105	IN CONST CHAR8 *Language,\r
7d582d6b	106	IN EFI_HII_HANDLE PackageList,\r
7d582d6b	107	IN EFI_STRING_ID StringId,\r
d1f95000	108	OUT EFI_STRING String,\r
7d582d6b	109	IN OUT UINTN *StringSize,\r
7d582d6b	110	OUT EFI_FONT_INFO **StringFontInfo OPTIONAL\r
d1f95000	111	);\r
	112	\r
	113	/**\r
4ca9b6c4 LG	114	This function updates the string specified by StringId in the specified PackageList to the text\r
	115	specified by String and, optionally, the font information specified by StringFontInfo.\r
	116	\r
	117	@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
	118	@param PackageList The package list containing the strings.\r
	119	@param StringId The string's id, which is unique within\r
	120	PackageList.\r
	121	@param Language Points to the language for the updated string.\r
	122	@param String Points to the new null-terminated string.\r
	123	@param StringFontInfo Points to the string's font information or NULL if\r
	124	the string font information is not changed.\r
	125	\r
	126	@retval EFI_SUCCESS The string was updated successfully.\r
	127	@retval EFI_NOT_FOUND The string specified by StringId is not in the\r
	128	database.\r
	129	@retval EFI_INVALID_PARAMETER The String or Language was NULL.\r
	130	@retval EFI_INVALID_PARAMETER The specified StringFontInfo does not exist in\r
	131	current database.\r
	132	@retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the\r
	133	task.\r
d1f95000	134	\r
	135	**/\r
	136	typedef\r
	137	EFI_STATUS\r
8b13229b	138	(EFIAPI *EFI_HII_SET_STRING)(\r
d1f95000	139	IN CONST EFI_HII_STRING_PROTOCOL *This,\r
7d582d6b	140	IN EFI_HII_HANDLE PackageList,\r
7d582d6b	141	IN EFI_STRING_ID StringId,\r
d1f95000	142	IN CONST CHAR8 *Language,\r
7d582d6b	143	IN EFI_STRING String,\r
d1f95000	144	IN CONST EFI_FONT_INFO *StringFontInfo OPTIONAL\r
	145	);\r
	146	\r
	147	\r
	148	/**\r
d1f95000	149	This function returns the list of supported languages.\r
d1f95000	150	\r
4ca9b6c4 LG	151	@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
4ca9b6c4 LG	152	@param PackageList The package list to examine.\r
4f077902 SZ	153	@param Languages Points to the buffer to hold the returned\r
4f077902 SZ	154	null-terminated ASCII string.\r
4ca9b6c4	155	@param LanguagesSize On entry, points to the size of the buffer pointed\r
4f077902	156	to by Languages, in bytes. On return, points to\r
4ca9b6c4 LG	157	the length of Languages, in bytes.\r
	158	\r
	159	@retval EFI_SUCCESS The languages were returned successfully.\r
	160	@retval EFI_INVALID_PARAMETER The Languages or LanguagesSize was NULL.\r
	161	@retval EFI_BUFFER_TOO_SMALL The LanguagesSize is too small to hold the list of\r
	162	supported languages. LanguageSize is updated to\r
	163	contain the required size.\r
	164	@retval EFI_NOT_FOUND Could not find string package in specified\r
	165	packagelist.\r
d1f95000	166	\r
	167	**/\r
	168	typedef\r
	169	EFI_STATUS\r
8b13229b	170	(EFIAPI *EFI_HII_GET_LANGUAGES)(\r
7d582d6b	171	IN CONST EFI_HII_STRING_PROTOCOL *This,\r
7d582d6b	172	IN EFI_HII_HANDLE PackageList,\r
d1f95000	173	IN OUT CHAR8 *Languages,\r
7d582d6b	174	IN OUT UINTN *LanguagesSize\r
d1f95000	175	);\r
	176	\r
	177	\r
	178	/**\r
4ca9b6c4 LG	179	Each string package has associated with it a single primary language and zero\r
	180	or more secondary languages. This routine returns the secondary languages\r
	181	associated with a package list.\r
	182	\r
	183	@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
	184	@param PackageList The package list to examine.\r
4f077902 SZ	185	@param PrimaryLanguage Points to the null-terminated ASCII string that specifies\r
	186	the primary language. Languages are specified in the\r
	187	format specified in Appendix M of the UEFI 2.0 specification.\r
	188	@param SecondaryLanguages Points to the buffer to hold the returned null-terminated\r
	189	ASCII string that describes the list of\r
4ca9b6c4	190	secondary languages for the specified\r
4f077902 SZ	191	PrimaryLanguage. If there are no secondary\r
4f077902 SZ	192	languages, the function returns successfully, but\r
4ca9b6c4 LG	193	this is set to NULL.\r
4ca9b6c4 LG	194	@param SecondaryLanguagesSize On entry, points to the size of the buffer pointed\r
4f077902	195	to by SecondaryLanguages, in bytes. On return,\r
4ca9b6c4 LG	196	points to the length of SecondaryLanguages in bytes.\r
	197	\r
	198	@retval EFI_SUCCESS Secondary languages were correctly returned.\r
4f077902	199	@retval EFI_INVALID_PARAMETER PrimaryLanguage or SecondaryLanguages or\r
4ca9b6c4 LG	200	SecondaryLanguagesSize was NULL.\r
	201	@retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondaryLanguagesSize is\r
	202	too small to hold the returned information.\r
4f077902	203	SecondaryLanguageSize is updated to hold the size of\r
4ca9b6c4	204	the buffer required.\r
4f077902	205	@retval EFI_INVALID_LANGUAGE The language specified by PrimaryLanguage is not\r
4ca9b6c4 LG	206	present in the specified package list.\r
4ca9b6c4 LG	207	@retval EFI_NOT_FOUND The specified PackageList is not in the Database. \r
d1f95000	208	\r
	209	**/\r
	210	typedef\r
	211	EFI_STATUS\r
8b13229b	212	(EFIAPI *EFI_HII_GET_2ND_LANGUAGES)(\r
7d582d6b	213	IN CONST EFI_HII_STRING_PROTOCOL *This,\r
7d582d6b	214	IN EFI_HII_HANDLE PackageList,\r
4f077902 SZ	215	IN CONST CHAR8 *PrimaryLanguage,\r
	216	IN OUT CHAR8 *SecondaryLanguages,\r
	217	IN OUT UINTN *SecondaryLanguagesSize\r
d1f95000	218	);\r
	219	\r
	220	\r
44717a39	221	///\r
	222	/// Services to manipulate the string.\r
	223	///\r
d1f95000	224	struct _EFI_HII_STRING_PROTOCOL {\r
	225	EFI_HII_NEW_STRING NewString;\r
	226	EFI_HII_GET_STRING GetString;\r
	227	EFI_HII_SET_STRING SetString;\r
	228	EFI_HII_GET_LANGUAGES GetLanguages;\r
	229	EFI_HII_GET_2ND_LANGUAGES GetSecondaryLanguages;\r
	230	};\r
	231	\r
	232	\r
	233	extern EFI_GUID gEfiHiiStringProtocolGuid;\r
	234	\r
	235	#endif\r
	236	\r