[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / Language.h

/** @file\r
  Language setting\r
\r
Copyright (c) 2004 - 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
#ifndef _LANGUAGE_H_\r
#define _LANGUAGE_H_\r
\r
#include "String.h"\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
/**\r
  Get next language from language code list (with separator ';').\r
\r
  If LangCode is NULL, then ASSERT.\r
  If Lang is NULL, then ASSERT.\r
\r
  @param  LangCode    On input: point to first language in the list. On\r
                                 output: point to next language in the list, or\r
                                 NULL if no more language in the list.\r
  @param  Lang           The first language in the list.\r
\r
**/\r
VOID\r
EFIAPI\r
GetNextLanguage (\r
  IN OUT CHAR8      **LangCode,\r
  OUT CHAR8         *Lang\r
  );\r
\r
/**\r
  Determine the current language that will be used\r
  based on language related EFI Variables.\r
\r
  @param LangCodesSettingRequired If required to set LangCode variable\r
\r
**/\r
VOID\r
InitializeLanguage (\r
  BOOLEAN LangCodesSettingRequired\r
  );\r
\r
#endif // _LANGUAGE_H_\r
Commit	Line	Data
5c08e117	1	/** @file\r
	2	Language setting\r
	3	\r
	4	Copyright (c) 2004 - 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	#ifndef _LANGUAGE_H_\r
	16	#define _LANGUAGE_H_\r
	17	\r
	18	#include "String.h"\r
	19	\r
ad5a96ab	20	/**\r
	21	Convert language code from RFC3066 to ISO639-2.\r
	22	\r
	23	@param LanguageRfc3066 RFC3066 language code.\r
	24	@param LanguageIso639 ISO639-2 language code.\r
	25	\r
	26	@retval EFI_SUCCESS Language code converted.\r
	27	@retval EFI_NOT_FOUND Language code not found.\r
	28	\r
	29	**/\r
	30	EFI_STATUS\r
	31	EFIAPI\r
	32	ConvertRfc3066LanguageToIso639Language (\r
	33	IN CHAR8 *LanguageRfc3066,\r
	34	OUT CHAR8 *LanguageIso639\r
	35	);\r
	36	\r
0f268521	37	/**\r
	38	Get next language from language code list (with separator ';').\r
	39	\r
	40	If LangCode is NULL, then ASSERT.\r
	41	If Lang is NULL, then ASSERT.\r
	42	\r
	43	@param LangCode On input: point to first language in the list. On\r
	44	output: point to next language in the list, or\r
	45	NULL if no more language in the list.\r
	46	@param Lang The first language in the list.\r
	47	\r
	48	**/\r
	49	VOID\r
	50	EFIAPI\r
	51	GetNextLanguage (\r
	52	IN OUT CHAR8 **LangCode,\r
	53	OUT CHAR8 *Lang\r
	54	);\r
	55	\r
5c08e117	56	/**\r
	57	Determine the current language that will be used\r
	58	based on language related EFI Variables.\r
	59	\r
	60	@param LangCodesSettingRequired If required to set LangCode variable\r
	61	\r
	62	**/\r
	63	VOID\r
	64	InitializeLanguage (\r
	65	BOOLEAN LangCodesSettingRequired\r
	66	);\r
	67	\r
	68	#endif // _LANGUAGE_H_\r