]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/UnicodeCollation.h
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Include / Protocol / UnicodeCollation.h
index e9eef61210f054d3ae1780ab34c98e02f31289c8..c4025eb4ff8ac26f3cd3d7861acdb3c18fd596a9 100644 (file)
@@ -1,16 +1,10 @@
 /** @file\r
   Unicode Collation protocol that follows the UEFI 2.0 specification.\r
-  This protocol is used to allow code running in the boot services environment \r
+  This protocol is used to allow code running in the boot services environment\r
   to perform lexical comparison functions on Unicode strings for given languages.\r
 \r
-Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution.  \r
-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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -27,27 +21,27 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
     0xa4c751fc, 0x23ae, 0x4c3e, {0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49 } \\r
   }\r
 \r
-typedef struct _EFI_UNICODE_COLLATION_PROTOCOL  EFI_UNICODE_COLLATION_PROTOCOL;\r
-\r
+typedef struct _EFI_UNICODE_COLLATION_PROTOCOL EFI_UNICODE_COLLATION_PROTOCOL;\r
 \r
 ///\r
 /// Protocol GUID name defined in EFI1.1.\r
-/// \r
-#define UNICODE_COLLATION_PROTOCOL              EFI_UNICODE_COLLATION_PROTOCOL_GUID\r
+///\r
+#define UNICODE_COLLATION_PROTOCOL  EFI_UNICODE_COLLATION_PROTOCOL_GUID\r
 \r
 ///\r
 /// Protocol defined in EFI1.1.\r
-/// \r
-typedef EFI_UNICODE_COLLATION_PROTOCOL          UNICODE_COLLATION_INTERFACE;\r
+///\r
+typedef EFI_UNICODE_COLLATION_PROTOCOL UNICODE_COLLATION_INTERFACE;\r
 \r
 ///\r
 /// Protocol data structures and defines\r
 ///\r
-#define EFI_UNICODE_BYTE_ORDER_MARK (CHAR16) (0xfeff)\r
+#define EFI_UNICODE_BYTE_ORDER_MARK  (CHAR16) (0xfeff)\r
 \r
 //\r
 // Protocol member functions\r
 //\r
+\r
 /**\r
   Performs a case-insensitive comparison of two Null-terminated strings.\r
 \r
@@ -69,7 +63,7 @@ INTN
   );\r
 \r
 /**\r
-  Performs a case-insensitive comparison of a Null-terminated \r
+  Performs a case-insensitive comparison of a Null-terminated\r
   pattern string and a Null-terminated string.\r
 \r
   @param  This    A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\r
@@ -89,7 +83,7 @@ BOOLEAN
   );\r
 \r
 /**\r
-  Converts all the characters in a Null-terminated string to \r
+  Converts all the characters in a Null-terminated string to\r
   lower case characters.\r
 \r
   @param  This   A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\r
@@ -119,7 +113,7 @@ VOID
   );\r
 \r
 /**\r
-  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
+  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated\r
   string.\r
 \r
   @param  This    A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\r
@@ -140,13 +134,13 @@ VOID
   );\r
 \r
 /**\r
-  Converts a Null-terminated string to legal characters in a FAT \r
-  filename using an OEM character set. \r
+  Converts a Null-terminated string to legal characters in a FAT\r
+  filename using an OEM character set.\r
 \r
   @param  This    A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\r
   @param  String  A pointer to a Null-terminated string.\r
   @param  FatSize The size of the string Fat in bytes.\r
-  @param  Fat     A pointer to a string that contains the converted version of \r
+  @param  Fat     A pointer to a string that contains the converted version of\r
                   String using legal FAT characters from an OEM character set.\r
 \r
   @retval TRUE    One or more conversions failed and were substituted with '_'\r
@@ -163,30 +157,30 @@ BOOLEAN
   );\r
 \r
 ///\r
-/// The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive \r
-/// comparisons of strings. \r
+/// The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive\r
+/// comparisons of strings.\r
 ///\r
 struct _EFI_UNICODE_COLLATION_PROTOCOL {\r
-  EFI_UNICODE_COLLATION_STRICOLL    StriColl;\r
-  EFI_UNICODE_COLLATION_METAIMATCH  MetaiMatch;\r
-  EFI_UNICODE_COLLATION_STRLWR      StrLwr;\r
-  EFI_UNICODE_COLLATION_STRUPR      StrUpr;\r
+  EFI_UNICODE_COLLATION_STRICOLL      StriColl;\r
+  EFI_UNICODE_COLLATION_METAIMATCH    MetaiMatch;\r
+  EFI_UNICODE_COLLATION_STRLWR        StrLwr;\r
+  EFI_UNICODE_COLLATION_STRUPR        StrUpr;\r
 \r
   //\r
   // for supporting fat volumes\r
   //\r
-  EFI_UNICODE_COLLATION_FATTOSTR    FatToStr;\r
-  EFI_UNICODE_COLLATION_STRTOFAT    StrToFat;\r
-  \r
+  EFI_UNICODE_COLLATION_FATTOSTR      FatToStr;\r
+  EFI_UNICODE_COLLATION_STRTOFAT      StrToFat;\r
+\r
   ///\r
   /// A Null-terminated ASCII string array that contains one or more language codes.\r
   /// When this field is used for UnicodeCollation2, it is specified in RFC 4646 format.\r
   /// When it is used for UnicodeCollation, it is specified in ISO 639-2 format.\r
   ///\r
-  CHAR8                             *SupportedLanguages;\r
+  CHAR8                               *SupportedLanguages;\r
 };\r
 \r
-extern EFI_GUID gEfiUnicodeCollationProtocolGuid;\r
-extern EFI_GUID gEfiUnicodeCollation2ProtocolGuid;\r
+extern EFI_GUID  gEfiUnicodeCollationProtocolGuid;\r
+extern EFI_GUID  gEfiUnicodeCollation2ProtocolGuid;\r
 \r
 #endif\r