Add details comments for the code flow to initialize Unicode Collation (2) support.

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

/** @file\r
  Unicode Collation Library that hides the trival difference of Unicode Collation\r
  and Unicode collation 2 Protocol.\r
\r
  Copyright (c) 2007, 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
#include "Fat.h"\r
\r
STATIC EFI_UNICODE_COLLATION_PROTOCOL  *mUnicodeCollationInterface = NULL;\r
\r
typedef\r
BOOLEAN\r
(* SEARCH_LANG_CODE) (\r
  IN CONST CHAR8    *Languages,\r
  IN CONST CHAR8    *MatchLangCode\r
  );\r
\r
struct _UNICODE_INTERFACE {\r
  CHAR16            *VariableName;\r
  CHAR8             *DefaultLangCode;\r
  SEARCH_LANG_CODE  SearchLangCode;\r
  EFI_GUID          *UnicodeProtocolGuid;\r
};\r
\r
typedef struct _UNICODE_INTERFACE UNICODE_INTERFACE;\r
\r
STATIC\r
BOOLEAN\r
SearchIso639LangCode (\r
  IN CONST CHAR8    *Languages,\r
  IN CONST CHAR8    *MatchLangCode\r
  )\r
{\r
  CONST CHAR8       *LangCode;\r
\r
  for (LangCode = Languages; *LangCode != '\0'; LangCode += 3) {\r
    if (CompareMem (LangCode, MatchLangCode, 3) == 0) {\r
      return TRUE;\r
    }\r
  }\r
\r
  return FALSE;\r
}\r
\r
STATIC\r
BOOLEAN\r
SearchRfc3066LangCode (\r
  IN CONST CHAR8    *Languages,\r
  IN CONST CHAR8    *MatchLangCode\r
  )\r
{\r
  CHAR8       *SubStr;\r
  CHAR8       Terminal;\r
\r
  SubStr = AsciiStrStr (Languages, MatchLangCode);\r
  if (SubStr == NULL) {\r
    return FALSE;\r
  }\r
\r
  if (SubStr != Languages && *(SubStr - 1) != ';') {\r
    return FALSE;\r
  }\r
\r
  Terminal = *(SubStr + AsciiStrLen (MatchLangCode));\r
  if (Terminal != '\0' && Terminal != ';') {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED UNICODE_INTERFACE mIso639Lang = {\r
  L"Lang",\r
  (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultLang),\r
  SearchIso639LangCode,\r
  &gEfiUnicodeCollationProtocolGuid,\r
};\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED UNICODE_INTERFACE mRfc3066Lang = {\r
  L"PlatformLang",\r
  (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLang),\r
  SearchRfc3066LangCode,\r
  &gEfiUnicodeCollation2ProtocolGuid,\r
};\r
\r
STATIC\r
EFI_STATUS\r
InitializeUnicodeCollationSupportWithConfig (\r
  IN EFI_HANDLE         AgentHandle,\r
  IN UNICODE_INTERFACE  *UnicodeInterface\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  CHAR8                           Buffer[100];\r
  UINTN                           BufferSize;\r
  UINTN                           Index;\r
  CHAR8                           *LangCode;\r
  UINTN                           NoHandles;\r
  EFI_HANDLE                      *Handles;\r
  EFI_UNICODE_COLLATION_PROTOCOL  *Uci;\r
\r
  LangCode   = Buffer;\r
  BufferSize = sizeof (Buffer);\r
  Status = gRT->GetVariable (\r
                  UnicodeInterface->VariableName,\r
                  &gEfiGlobalVariableGuid,\r
                  NULL,\r
                  &BufferSize,\r
                  Buffer\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    LangCode = UnicodeInterface->DefaultLangCode;\r
  }\r
\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  UnicodeInterface->UnicodeProtocolGuid,\r
                  NULL,\r
                  &NoHandles,\r
                  &Handles\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  for (Index = 0; Index < NoHandles; Index++) {\r
    //\r
    // Open Unicode Collation Protocol\r
    //\r
    Status = gBS->OpenProtocol (\r
                    Handles[Index],\r
                    UnicodeInterface->UnicodeProtocolGuid,\r
                    (VOID **) &Uci,\r
                    AgentHandle,\r
                    NULL,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    if (UnicodeInterface->SearchLangCode (Uci->SupportedLanguages, LangCode)) {\r
      mUnicodeCollationInterface = Uci;\r
      break;\r
    }\r
  }\r
\r
  FreePool (Handles);\r
\r
  return (mUnicodeCollationInterface != NULL)? EFI_SUCCESS : EFI_NOT_FOUND;\r
}\r
\r
/**\r
  Initialize Unicode Collation support.\r
\r
  This function searches Initialized Unicode Collation support based on PCDs:\r
  PcdUnicodeCollation2Support and PcdUnicodeCollationSupport.\r
  It first 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 3066 Unicode Collation 2 Protocol.\r
  //\r
  if (FeaturePcdGet (PcdUnicodeCollation2Support)) {\r
    Status = InitializeUnicodeCollationSupportWithConfig (AgentHandle, &mRfc3066Lang);\r
  }\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 (FeaturePcdGet (PcdUnicodeCollationSupport) && EFI_ERROR (Status)) {\r
    Status = InitializeUnicodeCollationSupportWithConfig (AgentHandle, &mIso639Lang);\r
  }\r
\r
  return Status;\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  Str                   The string which will be upper-cased.\r
\r
  @return None.\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  Str                   The string which will be lower-cased.\r
\r
  @return None\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