X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FUniversal%2FDisk%2FUnicodeCollation%2FEnglishDxe%2FUnicodeCollationEng.h;h=bc32e2959644a6892be4a2eec2cae6127d1e75cb;hb=HEAD;hp=3e1e1dca684ed53736e628c481884d794efb41a8;hpb=e5eed7d3641d71d7ea539e5379ea9c6a5cd97004;p=mirror_edk2.git
diff --git a/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h b/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
index 3e1e1dca68..bc32e29596 100644
--- a/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
+++ b/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
@@ -1,22 +1,14 @@
/** @file
Head file for Unicode Collation Protocol (English)
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.
-This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _UNICODE_COLLATION_ENG_H_
#define _UNICODE_COLLATION_ENG_H_
-
-
#include
#include
@@ -39,23 +31,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
//
// Macro to map character a to upper case.
//
-#define TO_UPPER(a) (CHAR16) ((a) <= 0xFF ? mEngUpperMap[a] : (a))
+#define TO_UPPER(a) (CHAR16) ((a) <= 0xFF ? mEngUpperMap[a] : (a))
//
// Macro to map character a to lower case.
//
-#define TO_LOWER(a) (CHAR16) ((a) <= 0xFF ? mEngLowerMap[a] : (a))
+#define TO_LOWER(a) (CHAR16) ((a) <= 0xFF ? mEngLowerMap[a] : (a))
//
// Prototypes
//
+
/**
- Performs a case-insensitive comparison of two Null-terminated Unicode
- strings.
+ Performs a case-insensitive comparison of two Null-terminated strings.
@param This Protocol instance pointer.
- @param Str1 A pointer to a Null-terminated Unicode string.
- @param Str2 A pointer to a Null-terminated Unicode string.
+ @param Str1 A pointer to a Null-terminated string.
+ @param Str2 A pointer to a Null-terminated string.
@retval 0 Str1 is equivalent to Str2
@retval > 0 Str1 is lexically greater than Str2
@@ -65,18 +57,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
INTN
EFIAPI
EngStriColl (
- IN EFI_UNICODE_COLLATION_PROTOCOL *This,
- IN CHAR16 *Str1,
- IN CHAR16 *Str2
+ IN EFI_UNICODE_COLLATION_PROTOCOL *This,
+ IN CHAR16 *Str1,
+ IN CHAR16 *Str2
);
/**
- Performs a case-insensitive comparison of a Null-terminated Unicode
- pattern string and a Null-terminated Unicode string.
+ Performs a case-insensitive comparison of a Null-terminated
+ pattern string and a Null-terminated string.
@param This Protocol instance pointer.
- @param String A pointer to a Null-terminated Unicode string.
- @param Pattern A pointer to a Null-terminated Unicode pattern string.
+ @param String A pointer to a Null-terminated string.
+ @param Pattern A pointer to a Null-terminated pattern string.
@retval TRUE Pattern was found in String.
@retval FALSE Pattern was not found in String.
@@ -85,69 +77,68 @@ EngStriColl (
BOOLEAN
EFIAPI
EngMetaiMatch (
- IN EFI_UNICODE_COLLATION_PROTOCOL *This,
- IN CHAR16 *String,
- IN CHAR16 *Pattern
+ IN EFI_UNICODE_COLLATION_PROTOCOL *This,
+ IN CHAR16 *String,
+ IN CHAR16 *Pattern
);
/**
- Converts all the Unicode characters in a Null-terminated Unicode string to
- lower case Unicode characters.
+ Converts all the characters in a Null-terminated string to
+ lower case characters.
@param This Protocol instance pointer.
- @param Str A pointer to a Null-terminated Unicode string.
+ @param Str A pointer to a Null-terminated string.
**/
VOID
EFIAPI
EngStrLwr (
- IN EFI_UNICODE_COLLATION_PROTOCOL *This,
- IN OUT CHAR16 *Str
+ IN EFI_UNICODE_COLLATION_PROTOCOL *This,
+ IN OUT CHAR16 *Str
);
/**
- Converts all the Unicode characters in a Null-terminated Unicode string to upper
- case Unicode characters.
+ Converts all the characters in a Null-terminated string to upper
+ case characters.
@param This Protocol instance pointer.
- @param Str A pointer to a Null-terminated Unicode string.
+ @param Str A pointer to a Null-terminated string.
**/
VOID
EFIAPI
EngStrUpr (
- IN EFI_UNICODE_COLLATION_PROTOCOL *This,
- IN OUT CHAR16 *Str
+ IN EFI_UNICODE_COLLATION_PROTOCOL *This,
+ IN OUT CHAR16 *Str
);
/**
- Converts an 8.3 FAT file name in an OEM character set to a Null-terminated
- Unicode string.
+ Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.
@param This Protocol instance pointer.
@param FatSize The size of the string Fat in bytes.
@param Fat A pointer to a Null-terminated string that contains an 8.3 file
- name using an OEM character set.
- @param String A pointer to a Null-terminated Unicode string. The string must
- be preallocated to hold FatSize Unicode characters.
+ name using an 8-bit OEM character set.
+ @param String A pointer to a Null-terminated string. The string must
+ be preallocated to hold FatSize characters.
**/
VOID
EFIAPI
EngFatToStr (
- IN EFI_UNICODE_COLLATION_PROTOCOL *This,
- IN UINTN FatSize,
- IN CHAR8 *Fat,
- OUT CHAR16 *String
+ IN EFI_UNICODE_COLLATION_PROTOCOL *This,
+ IN UINTN FatSize,
+ IN CHAR8 *Fat,
+ OUT CHAR16 *String
);
/**
- Converts a Null-terminated Unicode string to legal characters in a FAT
- filename using an OEM character set.
+ Converts a Null-terminated string to legal characters in a FAT
+ filename using an OEM character set.
@param This Protocol instance pointer.
- @param String A pointer to a Null-terminated Unicode string. The string must
- be preallocated to hold FatSize Unicode characters.
+ @param String A pointer to a Null-terminated string. The string must
+ be preallocated to hold FatSize characters.
@param FatSize The size of the string Fat in bytes.
@param Fat A pointer to a Null-terminated string that contains an 8.3 file
name using an OEM character set.
@@ -159,21 +150,21 @@ EngFatToStr (
BOOLEAN
EFIAPI
EngStrToFat (
- IN EFI_UNICODE_COLLATION_PROTOCOL *This,
- IN CHAR16 *String,
- IN UINTN FatSize,
- OUT CHAR8 *Fat
+ IN EFI_UNICODE_COLLATION_PROTOCOL *This,
+ IN CHAR16 *String,
+ IN UINTN FatSize,
+ OUT CHAR8 *Fat
);
/**
The user Entry Point for English module.
-
+
This function initializes unicode character mapping and then installs Unicode
- Collation & Unicode Collation 2 Protocols based on the feature flags.
+ Collation & Unicode Collation 2 Protocols based on the feature flags.
- @param ImageHandle The firmware allocated handle for the EFI image.
+ @param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
-
+
@retval EFI_SUCCESS The entry point is executed successfully.
@retval other Some error occurs when executing this entry point.
@@ -181,9 +172,8 @@ EngStrToFat (
EFI_STATUS
EFIAPI
InitializeUnicodeCollationEng (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
+ IN EFI_HANDLE ImageHandle,
+ IN EFI_SYSTEM_TABLE *SystemTable
);
#endif
-