Update all files to follow doxygen style file header.

[mirror_edk2.git] / MdeModulePkg / Universal / Disk / UnicodeCollation / EnglishDxe / UnicodeCollationEng.h

/** @file\r
  Head file for Unicode Collation Protocol (English)\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
#ifndef _UNICODE_COLLATION_ENG_H\r
#define _UNICODE_COLLATION_ENG_H\r
\r
\r
\r
#include <Uefi.h>\r
\r
\r
#include <Protocol/UnicodeCollation.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/PcdLib.h>\r
\r
//\r
// Defines\r
//\r
#define CHAR_FAT_VALID  0x01\r
\r
#define ToUpper(a)      (CHAR16) (a <= 0xFF ? mEngUpperMap[a] : a)\r
#define ToLower(a)      (CHAR16) (a <= 0xFF ? mEngLowerMap[a] : a)\r
\r
//\r
// Prototypes\r
//\r
INTN\r
EFIAPI\r
EngStriColl (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL           *This,\r
  IN CHAR16                                   *s1,\r
  IN CHAR16                                   *s2\r
  )\r
;\r
\r
BOOLEAN\r
EFIAPI\r
EngMetaiMatch (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL          *This,\r
  IN CHAR16                                  *String,\r
  IN CHAR16                                  *Pattern\r
  )\r
;\r
\r
VOID\r
EFIAPI\r
EngStrLwr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL          *This,\r
  IN OUT CHAR16                              *Str\r
  )\r
;\r
\r
VOID\r
EFIAPI\r
EngStrUpr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL          *This,\r
  IN OUT CHAR16                              *Str\r
  )\r
;\r
\r
VOID\r
EFIAPI\r
EngFatToStr (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL          *This,\r
  IN UINTN                                   FatSize,\r
  IN CHAR8                                   *Fat,\r
  OUT CHAR16                                 *String\r
  )\r
;\r
\r
BOOLEAN\r
EFIAPI\r
EngStrToFat (\r
  IN EFI_UNICODE_COLLATION_PROTOCOL          *This,\r
  IN CHAR16                                  *String,\r
  IN UINTN                                   FatSize,\r
  OUT CHAR8                                  *Fat\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
InitializeUnicodeCollationEng (\r
  IN EFI_HANDLE       ImageHandle,\r
  IN EFI_SYSTEM_TABLE *SystemTable\r
  )\r
;\r
\r
#endif\r