MdeModulePkg/DxeCapsuleLibFmp: Use new Variable Lock interface

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

/** @file\r
  HII Library implementation that uses DXE protocols and services.\r
\r
  Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>\r
 (C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include "InternalHiiLib.h"\r
\r
/**\r
  This function create a new string in String Package or updates an existing\r
  string in a String Package.  If StringId is 0, then a new string is added to\r
  a String Package.  If StringId is not zero, then a string in String Package is\r
  updated.  If SupportedLanguages is NULL, then the string is added or updated\r
  for all the languages that the String Package supports.  If SupportedLanguages\r
  is not NULL, then the string is added or updated for the set of languages\r
  specified by SupportedLanguages.\r
\r
  If HiiHandle is NULL, then ASSERT().\r
  If String is NULL, then ASSERT().\r
\r
  @param[in]  HiiHandle           A handle that was previously registered in the\r
                                  HII Database.\r
  @param[in]  StringId            If zero, then a new string is created in the\r
                                  String Package associated with HiiHandle.  If\r
                                  non-zero, then the string specified by StringId\r
                                  is updated in the String Package  associated\r
                                  with HiiHandle.\r
  @param[in]  String              A pointer to the Null-terminated Unicode string\r
                                  to add or update in the String Package associated\r
                                  with HiiHandle.\r
  @param[in]  SupportedLanguages  A pointer to a Null-terminated ASCII string of\r
                                  language codes.  If this parameter is NULL, then\r
                                  String is added or updated in the String Package\r
                                  associated with HiiHandle for all the languages\r
                                  that the String Package supports.  If this\r
                                  parameter is not NULL, then then String is added\r
                                  or updated in the String Package associated with\r
                                  HiiHandle for the set oflanguages specified by\r
                                  SupportedLanguages.  The format of\r
                                  SupportedLanguages must follow the language\r
                                  format assumed the HII Database.\r
\r
  @retval 0      The string could not be added or updated in the String Package.\r
  @retval Other  The EFI_STRING_ID of the newly added or updated string.\r
\r
**/\r
EFI_STRING_ID\r
EFIAPI\r
HiiSetString (\r
  IN EFI_HII_HANDLE    HiiHandle,\r
  IN EFI_STRING_ID     StringId,            OPTIONAL\r
  IN CONST EFI_STRING  String,\r
  IN CONST CHAR8       *SupportedLanguages  OPTIONAL\r
  )\r
{\r
  EFI_STATUS     Status;\r
  CHAR8          *AllocatedLanguages;\r
  CHAR8          *Supported;\r
  CHAR8          *Language;\r
\r
  ASSERT (HiiHandle != NULL);\r
  ASSERT (String != NULL);\r
\r
  if (SupportedLanguages == NULL) {\r
    //\r
    // Retrieve the languages that the package specified by HiiHandle supports\r
    //\r
    AllocatedLanguages = HiiGetSupportedLanguages (HiiHandle);\r
  } else {\r
    //\r
    // Allocate a copy of the SupportLanguages string that passed in\r
    //\r
    AllocatedLanguages = AllocateCopyPool (AsciiStrSize (SupportedLanguages), SupportedLanguages);\r
  }\r
\r
  //\r
  // If there are not enough resources for the supported languages string, then return a StringId of 0\r
  //\r
  if (AllocatedLanguages == NULL) {\r
    return (EFI_STRING_ID)(0);\r
  }\r
\r
  Status = EFI_INVALID_PARAMETER;\r
  //\r
  // Loop through each language that the string supports\r
  //\r
  for (Supported = AllocatedLanguages; *Supported != '\0'; ) {\r
    //\r
    // Cache a pointer to the beginning of the current language in the list of languages\r
    //\r
    Language = Supported;\r
\r
    //\r
    // Search for the next language separator and replace it with a Null-terminator\r
    //\r
    for (; *Supported != 0 && *Supported != ';'; Supported++);\r
    if (*Supported != 0) {\r
      *(Supported++) = '\0';\r
    }\r
\r
    if ((SupportedLanguages == NULL) && AsciiStrnCmp (Language, UEFI_CONFIG_LANG, AsciiStrLen (UEFI_CONFIG_LANG)) == 0) {\r
      //\r
      // Skip string package used for keyword protocol.\r
      //\r
      continue;\r
    }\r
\r
    //\r
    // If StringId is 0, then call NewString().  Otherwise, call SetString()\r
    //\r
    if (StringId == (EFI_STRING_ID)(0)) {\r
      Status = gHiiString->NewString (gHiiString, HiiHandle, &StringId, Language, NULL, String, NULL);\r
    } else {\r
      Status = gHiiString->SetString (gHiiString, HiiHandle, StringId, Language, String, NULL);\r
    }\r
\r
    //\r
    // If there was an error, then break out of the loop and return a StringId of 0\r
    //\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
  }\r
\r
  //\r
  // Free the buffer of supported languages\r
  //\r
  FreePool (AllocatedLanguages);\r
\r
  if (EFI_ERROR (Status)) {\r
    return (EFI_STRING_ID)(0);\r
  } else {\r
    return StringId;\r
  }\r
}\r
\r
\r
/**\r
  Retrieves a string from a string package names by GUID in a specific language.\r
  If the language is not specified, then a string from a string package in the\r
  current platform  language is retrieved.  If the string can not be retrieved\r
  using the specified language or the current platform language, then the string\r
  is retrieved from the string package in the first language the string package\r
  supports.  The returned string is allocated using AllocatePool().  The caller\r
  is responsible for freeing the allocated buffer using FreePool().\r
\r
  If PackageListGuid is NULL, then ASSERT().\r
  If StringId is 0, then ASSERT.\r
\r
  @param[in]  PackageListGuid  The GUID of a package list that was previously\r
                               registered in the HII Database.\r
  @param[in]  StringId         The identifier of the string to retrieved from the\r
                               string package associated with PackageListGuid.\r
  @param[in]  Language         The language of the string to retrieve.  If this\r
                               parameter is NULL, then the current platform\r
                               language is used.  The format of Language must\r
                               follow the language format assumed the HII Database.\r
\r
  @retval NULL   The package list specified by PackageListGuid is not present in the\r
                 HII Database.\r
  @retval NULL   The string specified by StringId is not present in the string package.\r
  @retval Other  The string was returned.\r
\r
**/\r
EFI_STRING\r
EFIAPI\r
HiiGetPackageString (\r
  IN CONST EFI_GUID  *PackageListGuid,\r
  IN EFI_STRING_ID   StringId,\r
  IN CONST CHAR8     *Language  OPTIONAL\r
  )\r
{\r
  EFI_HII_HANDLE  *HiiHandleBuffer;\r
  EFI_HII_HANDLE  HiiHandle;\r
\r
  ASSERT (PackageListGuid != NULL);\r
\r
  HiiHandleBuffer = HiiGetHiiHandles (PackageListGuid);\r
  if (HiiHandleBuffer == NULL) {\r
    return NULL;\r
  }\r
\r
  HiiHandle = HiiHandleBuffer[0];\r
  FreePool (HiiHandleBuffer);\r
\r
  return HiiGetString (HiiHandle, StringId, Language);\r
}\r
\r
/**\r
  Retrieves a string from a string package in a specific language specified in Language\r
  or in the best lanaguage. See HiiGetStringEx () for the details.\r
\r
  @param[in]  HiiHandle  A handle that was previously registered in the HII Database.\r
  @param[in]  StringId   The identifier of the string to retrieved from the string\r
                         package associated with HiiHandle.\r
  @param[in]  Language   The language of the string to retrieve.  If this parameter\r
                         is NULL, then the current platform language is used.  The\r
                         format of Language must follow the language format assumed\r
                         the HII Database.\r
\r
  @retval NULL   The string specified by StringId is not present in the string package.\r
  @retval Other  The string was returned.\r
\r
**/\r
EFI_STRING\r
EFIAPI\r
HiiGetString (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN EFI_STRING_ID   StringId,\r
  IN CONST CHAR8     *Language  OPTIONAL\r
  )\r
{\r
  return HiiGetStringEx (HiiHandle, StringId, Language, TRUE);\r
}\r
\r
/**\r
  Retrieves a string from a string package in a specific language or in the best\r
  language at discretion of this function according to the priority of languages.\r
  TryBestLanguage is used to get the string in the best language or in the language\r
  specified in Language parameter. The behavior is,\r
  If TryBestLanguage is TRUE, this function looks for the best language for the string.\r
   - If the string can not be retrieved using the specified language or the current\r
     platform language, then the string is retrieved from the string package in the\r
     first language the string package supports.\r
  If TryBestLanguage is FALSE, Language must be specified for retrieving the string.\r
\r
  The returned string is allocated using AllocatePool().  The caller is responsible\r
  for freeing the allocated buffer using FreePool().\r
\r
  If HiiHandle is NULL, then ASSERT().\r
  If StringId is 0, then ASSET.\r
  If TryBestLanguage is FALE and Language is NULL, then ASSERT().\r
\r
  @param[in]  HiiHandle         A handle that was previously registered in the HII Database.\r
  @param[in]  StringId          The identifier of the string to retrieved from the string\r
                                package associated with HiiHandle.\r
  @param[in]  Language          The language of the string to retrieve.  If this parameter\r
                                is NULL, then the current platform language is used.  The\r
                                format of Language must follow the language format assumed\r
                                the HII Database.\r
  @param[in]  TryBestLanguage   If TRUE, try to get the best matching language from all\r
                                supported languages.If FALSE, the Language must be assigned\r
                                for the StringID.\r
\r
  @retval NULL   The string specified by StringId is not present in the string package.\r
  @retval Other  The string was returned.\r
\r
**/\r
EFI_STRING\r
EFIAPI\r
HiiGetStringEx (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN EFI_STRING_ID   StringId,\r
  IN CONST CHAR8     *Language  OPTIONAL,\r
  IN BOOLEAN         TryBestLanguage\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       StringSize;\r
  CHAR16      TempString;\r
  EFI_STRING  String;\r
  CHAR8       *SupportedLanguages;\r
  CHAR8       *PlatformLanguage;\r
  CHAR8       *BestLanguage;\r
\r
  ASSERT (HiiHandle != NULL);\r
  ASSERT (StringId != 0);\r
  //\r
  // Language must be specified if TryBestLanguage = FALSE.\r
  //\r
  ASSERT (!(!TryBestLanguage && Language == NULL));\r
  //\r
  // Initialize all allocated buffers to NULL\r
  //\r
  SupportedLanguages = NULL;\r
  PlatformLanguage   = NULL;\r
  BestLanguage       = NULL;\r
  String             = NULL;\r
\r
  //\r
  // Get the languages that the package specified by HiiHandle supports\r
  //\r
  SupportedLanguages = HiiGetSupportedLanguages (HiiHandle);\r
  if (SupportedLanguages == NULL) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Get the current platform language setting\r
  //\r
  GetEfiGlobalVariable2 (L"PlatformLang", (VOID**)&PlatformLanguage, NULL);\r
\r
  //\r
  // If Languag is NULL, then set it to an empty string, so it will be\r
  // skipped by GetBestLanguage()\r
  //\r
  if (Language == NULL) {\r
    Language = "";\r
  }\r
\r
  if (TryBestLanguage) {\r
    //\r
    // Get the best matching language from SupportedLanguages\r
    //\r
    BestLanguage = GetBestLanguage (\r
                     SupportedLanguages,\r
                     FALSE,                                             // RFC 4646 mode\r
                     Language,                                          // Highest priority\r
                     PlatformLanguage != NULL ? PlatformLanguage : "",  // Next highest priority\r
                     SupportedLanguages,                                // Lowest priority\r
                     NULL\r
                     );\r
    if (BestLanguage == NULL) {\r
      goto Error;\r
    }\r
  } else {\r
    BestLanguage = (CHAR8 *) Language;\r
  }\r
\r
\r
  //\r
  // Retrieve the size of the string in the string package for the BestLanguage\r
  //\r
  StringSize = 0;\r
  Status = gHiiString->GetString (\r
                         gHiiString,\r
                         BestLanguage,\r
                         HiiHandle,\r
                         StringId,\r
                         &TempString,\r
                         &StringSize,\r
                         NULL\r
                         );\r
  //\r
  // If GetString() returns EFI_SUCCESS for a zero size,\r
  // then there are no supported languages registered for HiiHandle.  If GetString()\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
    goto Error;\r
  }\r
\r
  //\r
  // Allocate a buffer for the return string\r
  //\r
  String = AllocateZeroPool (StringSize);\r
  if (String == NULL) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Retrieve the string from the string package\r
  //\r
  Status = gHiiString->GetString (\r
                         gHiiString,\r
                         BestLanguage,\r
                         HiiHandle,\r
                         StringId,\r
                         String,\r
                         &StringSize,\r
                         NULL\r
                         );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Free the buffer and return NULL if the supported languages can not be retrieved.\r
    //\r
    FreePool (String);\r
    String = NULL;\r
  }\r
\r
Error:\r
  //\r
  // Free allocated buffers\r
  //\r
  if (SupportedLanguages != NULL) {\r
    FreePool (SupportedLanguages);\r
  }\r
  if (PlatformLanguage != NULL) {\r
    FreePool (PlatformLanguage);\r
  }\r
  if (TryBestLanguage && BestLanguage != NULL) {\r
    FreePool (BestLanguage);\r
  }\r
\r
  //\r
  // Return the Null-terminated Unicode string\r
  //\r
  return String;\r
}\r
\r