HII Library Class interface refine.

[mirror_edk2.git] / MdeModulePkg / Library / UefiHiiLib / HiiLanguage.c

/** @file\r
  Language related HII Library implementation.\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
  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
HiiLibGetNextLanguage (\r
  IN OUT CHAR8      **LangCode,\r
  OUT CHAR8         *Lang\r
  )\r
{\r
  UINTN  Index;\r
  CHAR8  *StringPtr;\r
\r
  ASSERT (LangCode != NULL);\r
  ASSERT (*LangCode != NULL);\r
  ASSERT (Lang != NULL);\r
\r
  Index = 0;\r
  StringPtr = *LangCode;\r
  while (StringPtr[Index] != 0 && StringPtr[Index] != ';') {\r
    Index++;\r
  }\r
\r
  CopyMem (Lang, StringPtr, Index);\r
  Lang[Index] = 0;\r
\r
  if (StringPtr[Index] == ';') {\r
    Index++;\r
  }\r
  *LangCode = StringPtr + Index;\r
}\r
\r
\r
/**\r
  Retrieves a pointer to the a Null-terminated ASCII string containing the list \r
  of languages that an HII handle in the HII Database supports.  The returned \r
  string is allocated using AllocatePool().  The caller is responsible for freeing\r
  the returned string using FreePool().  The format of the returned string follows\r
  the language format assumed the HII Database.\r
  \r
  If HiiHandle is NULL, then ASSERT().\r
\r
  @param[in]  HiiHandle  A handle that was previously registered in the HII Database.\r
\r
  @retval NULL   HiiHandle is not registered in the HII database\r
  @retval NULL   There are not enough resources available to retrieve the suported \r
                 languages.\r
  @retval NULL   The list of suported languages could not be retrieved.\r
  @retval Other  A pointer to the Null-terminated ASCII string of supported languages.\r
\r
**/\r
CHAR8 *\r
EFIAPI\r
HiiGetSupportedLanguages (\r
  IN EFI_HII_HANDLE           HiiHandle\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       LanguageSize;\r
  CHAR8       TempSupportedLanguages;\r
  CHAR8       *SupportedLanguages;\r
\r
  ASSERT (HiiHandle != NULL);\r
\r
  //\r
  // Retrieve the size required for the supported languages buffer.\r
  //\r
  LanguageSize = 0;\r
  Status = gHiiString->GetLanguages (gHiiString, HiiHandle, &TempSupportedLanguages, &LanguageSize);\r
\r
  //\r
  // If GetLanguages() returns EFI_SUCCESS for a zero size, \r
  // then there are no supported languages registered for HiiHandle.  If GetLanguages() \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
    //\r
    // Return NULL if the size can not be retrieved, or if HiiHandle is not in the HII Database\r
    //\r
    return NULL;\r
  }\r
\r
  //\r
  // Allocate the supported languages buffer.\r
  //\r
  SupportedLanguages = AllocateZeroPool (LanguageSize);\r
  if (SupportedLanguages == NULL) {\r
    //\r
    // Return NULL if allocation fails.\r
    //\r
    return NULL;\r
  }\r
\r
  //\r
  // Retrieve the supported languages string\r
  //\r
  Status = gHiiString->GetLanguages (gHiiString, HiiHandle, SupportedLanguages, &LanguageSize);\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Free the buffer and return NULL if the supported languages can not be retrieved.\r
    //\r
    FreePool (SupportedLanguages);\r
    return NULL;\r
  }\r
\r
  //\r
  // Return the Null-terminated ASCII string of supported languages\r
  //\r
  return SupportedLanguages;\r
}\r
\r