Maintainers.txt: Remove Yonghong from BaseTools Reviewer

[mirror_edk2.git] / FatPkg / EnhancedFatDxe / UnicodeCollation.c

/** @file\r
  Unicode Collation Support component that hides the trivial difference of Unicode Collation\r
  and Unicode collation 2 Protocol.\r
\r
  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "Fat.h"\r
\r
EFI_UNICODE_COLLATION_PROTOCOL  *mUnicodeCollationInterface = NULL;\r
\r
/**\r
  Worker function to initialize Unicode Collation support.\r
\r
  It tries to locate Unicode Collation (2) protocol and matches it with current\r
  platform language code.\r
\r
  @param  AgentHandle          The handle used to open Unicode Collation (2) protocol.\r
  @param  ProtocolGuid         The pointer to Unicode Collation (2) protocol GUID.\r
  @param  VariableName         The name of the RFC 4646 or ISO 639-2 language variable.\r
  @param  DefaultLanguage      The default language in case the RFC 4646 or ISO 639-2 language is absent.\r
\r
  @retval EFI_SUCCESS          The Unicode Collation (2) protocol has been successfully located.\r
  @retval Others               The Unicode Collation (2) protocol has not been located.\r
\r
**/\r
EFI_STATUS\r
InitializeUnicodeCollationSupportWorker (\r
  IN EFI_HANDLE         AgentHandle,\r
  IN EFI_GUID           *ProtocolGuid,\r
  IN CONST CHAR16       *VariableName,\r
  IN CONST CHAR8        *DefaultLanguage\r
  )\r
{\r
  EFI_STATUS                      ReturnStatus;\r
  EFI_STATUS                      Status;\r
  UINTN                           NumHandles;\r
  UINTN                           Index;\r
  EFI_HANDLE                      *Handles;\r
  EFI_UNICODE_COLLATION_PROTOCOL  *Uci;\r
  BOOLEAN                         Iso639Language;\r
  CHAR8                           *Language;\r
  CHAR8                           *BestLanguage;\r
\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  ProtocolGuid,\r
                  NULL,\r
                  &NumHandles,\r
                  &Handles\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Iso639Language = (BOOLEAN) (ProtocolGuid == &gEfiUnicodeCollationProtocolGuid);\r
  GetEfiGlobalVariable2 (VariableName, (VOID**) &Language, NULL);\r
\r
  ReturnStatus = EFI_UNSUPPORTED;\r
  for (Index = 0; Index < NumHandles; Index++) {\r
    //\r
    // Open Unicode Collation Protocol\r
    //\r
    Status = gBS->OpenProtocol (\r
                    Handles[Index],\r
                    ProtocolGuid,\r
                    (VOID **) &Uci,\r
                    AgentHandle,\r
                    NULL,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    //\r
    // Find the best matching matching language from the supported languages\r
    // of Unicode Collation (2) protocol.\r
    //\r
    BestLanguage = GetBestLanguage (\r
                     Uci->SupportedLanguages,\r
                     Iso639Language,\r
                     (Language == NULL) ? "" : Language,\r
                     DefaultLanguage,\r
                     NULL\r
                     );\r
    if (BestLanguage != NULL) {\r
      FreePool (BestLanguage);\r
      mUnicodeCollationInterface = Uci;\r
      ReturnStatus = EFI_SUCCESS;\r
      break;\r
    }\r
  }\r
\r
  if (Language != NULL) {\r
    FreePool (Language);\r
  }\r
\r
  FreePool (Handles);\r
\r
  return ReturnStatus;\r
}\r
\r
/**\r
  Initialize Unicode Collation support.\r
\r
  It tries to locate Unicode Collation 2 protocol and matches it with current\r
  platform language code. If for any reason the first attempt fails, it then tries to\r
  use Unicode Collation Protocol.\r
\r
  @param  AgentHandle          The handle used to open Unicode Collation (2) protocol.\r
\r
  @retval EFI_SUCCESS          The Unicode Collation (2) protocol has been successfully located.\r
  @retval Others               The Unicode Collation (2) protocol has not been located.\r
\r
**/\r
EFI_STATUS\r
InitializeUnicodeCollationSupport (\r
  IN EFI_HANDLE    AgentHandle\r
  )\r
{\r
\r
  EFI_STATUS       Status;\r
\r
  Status = EFI_UNSUPPORTED;\r
\r
  //\r
  // First try to use RFC 4646 Unicode Collation 2 Protocol.\r
  //\r
  Status = InitializeUnicodeCollationSupportWorker (\r
             AgentHandle,\r
             &gEfiUnicodeCollation2ProtocolGuid,\r
             L"PlatformLang",\r
             (CONST CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLang)\r
             );\r
  //\r
  // If the attempt to use Unicode Collation 2 Protocol fails, then we fall back\r
  // on the ISO 639-2 Unicode Collation Protocol.\r
  //\r
  if (EFI_ERROR (Status)) {\r
    Status = InitializeUnicodeCollationSupportWorker (\r
               AgentHandle,\r
               &gEfiUnicodeCollationProtocolGuid,\r
               L"Lang",\r
               (CONST CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultLang)\r
               );\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Performs a case-insensitive comparison of two Null-terminated Unicode strings.\r
\r
  @param  S1                   A pointer to a Null-terminated Unicode string.\r
  @param  S2                   A pointer to a Null-terminated Unicode string.\r
\r
  @retval 0                    S1 is equivalent to S2.\r
  @retval >0                   S1 is lexically greater than S2.\r
  @retval <0                   S1 is lexically less than S2.\r
**/\r
INTN\r
FatStriCmp (\r
  IN CHAR16       *S1,\r
  IN CHAR16       *S2\r
  )\r
{\r
  ASSERT (StrSize (S1) != 0);\r
  ASSERT (StrSize (S2) != 0);\r
  ASSERT (mUnicodeCollationInterface != NULL);\r
\r
  return mUnicodeCollationInterface->StriColl (\r
                                       mUnicodeCollationInterface,\r
                                       S1,\r
                                       S2\r
                                       );\r
}\r
\r
\r
/**\r
  Uppercase a string.\r
\r
  @param  String                   The string which will be upper-cased.\r
\r
\r
**/\r
VOID\r
FatStrUpr (\r
  IN OUT CHAR16   *String\r
  )\r
{\r
  ASSERT (StrSize (String) != 0);\r
  ASSERT (mUnicodeCollationInterface != NULL);\r
\r
  mUnicodeCollationInterface->StrUpr (mUnicodeCollationInterface, String);\r
}\r
\r
\r
/**\r
  Lowercase a string\r
\r
  @param  String                   The string which will be lower-cased.\r
\r
\r
**/\r
VOID\r
FatStrLwr (\r
  IN OUT CHAR16   *String\r
  )\r
{\r
  ASSERT (StrSize (String) != 0);\r
  ASSERT (mUnicodeCollationInterface != NULL);\r
\r
  mUnicodeCollationInterface->StrLwr (mUnicodeCollationInterface, String);\r
}\r
\r
\r
/**\r
  Convert FAT string to unicode string.\r
\r
  @param  FatSize               The size of FAT string.\r
  @param  Fat                   The FAT string.\r
  @param  String                The unicode string.\r
\r
  @return None.\r
\r
**/\r
VOID\r
FatFatToStr (\r
  IN  UINTN                            FatSize,\r
  IN  CHAR8                            *Fat,\r
  OUT CHAR16                           *String\r
  )\r
{\r
  ASSERT (Fat != NULL);\r
  ASSERT (String != NULL);\r
  ASSERT (((UINTN) String & 0x01) == 0);\r
  ASSERT (mUnicodeCollationInterface != NULL);\r
\r
  mUnicodeCollationInterface->FatToStr (mUnicodeCollationInterface, FatSize, Fat, String);\r
}\r
\r
\r
/**\r
  Convert unicode string to Fat string.\r
\r
  @param  String                The unicode string.\r
  @param  FatSize               The size of the FAT string.\r
  @param  Fat                   The FAT string.\r
\r
  @retval TRUE                  Convert successfully.\r
  @retval FALSE                 Convert error.\r
\r
**/\r
BOOLEAN\r
FatStrToFat (\r
  IN  CHAR16                          *String,\r
  IN  UINTN                           FatSize,\r
  OUT CHAR8                           *Fat\r
  )\r
{\r
  ASSERT (Fat != NULL);\r
  ASSERT (StrSize (String) != 0);\r
  ASSERT (mUnicodeCollationInterface != NULL);\r
\r
  return mUnicodeCollationInterface->StrToFat (\r
                                       mUnicodeCollationInterface,\r
                                       String,\r
                                       FatSize,\r
                                       Fat\r
                                       );\r
}\r