UserUnicodeCollation.h File Reference

#include <Uefi.h>
#include <Protocol/UnicodeCollation.h>

Go to the source code of this file.

Functions
VOID	OcUnicodeCollationInitializeMappingTables (VOID)
INTN	EngStriColl (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *Str1, IN CHAR16 *Str2)
VOID EFIAPI	EngStrLwr (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN OUT CHAR16 *Str)
VOID EFIAPI	EngStrUpr (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN OUT CHAR16 *Str)
BOOLEAN EFIAPI	EngMetaiMatch (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *String, IN CHAR16 *Pattern)
VOID EFIAPI	EngFatToStr (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN UINTN FatSize, IN CHAR8 *Fat, OUT CHAR16 *String)
BOOLEAN EFIAPI	EngStrToFat (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *String, IN UINTN FatSize, OUT CHAR8 *Fat)
VOID	UserUnicodeCollationInstallProtocol (OUT EFI_UNICODE_COLLATION_PROTOCOL **Interface)

Variables
EFI_UNICODE_COLLATION_PROTOCOL	gInternalUnicode2Eng

Detailed Description

Copyright (c) 2023, Savva Mitrofanov. All rights reserved. SPDX-License-Identifier: BSD-3-Clause

Definition in file UserUnicodeCollation.h.

Function Documentation

EngFatToStr()

VOID EFIAPI EngFatToStr	(	IN EFI_UNICODE_COLLATION_PROTOCOL *	This,
		IN UINTN	FatSize,
		IN CHAR8 *	Fat,
		OUT CHAR16 *	String )

Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.

Parameters

This	Protocol instance pointer.
FatSize	The size of the string Fat in bytes.
Fat	A pointer to a Null-terminated string that contains an 8.3 file name using an 8-bit OEM character set.
String	A pointer to a Null-terminated string. The string must be preallocated to hold FatSize characters.

Definition at line 408 of file OcUnicodeCollationEngCommon.c.

EngMetaiMatch()

BOOLEAN EFIAPI EngMetaiMatch	(	IN EFI_UNICODE_COLLATION_PROTOCOL *	This,
		IN CHAR16 *	String,
		IN CHAR16 *	Pattern )

Performs a case-insensitive comparison of a Null-terminated pattern string and a Null-terminated string.

Parameters

This	Protocol instance pointer.
String	A pointer to a Null-terminated string.
Pattern	A pointer to a Null-terminated pattern string.

Return values

TRUE	Pattern was found in String.
FALSE	Pattern was not found in String.

Definition at line 272 of file OcUnicodeCollationEngCommon.c.

EngStriColl()

INTN EngStriColl	(	IN EFI_UNICODE_COLLATION_PROTOCOL *	This,
		IN CHAR16 *	Str1,
		IN CHAR16 *	Str2 )

Performs a case-insensitive comparison of two Null-terminated strings.

Parameters

This	Protocol instance pointer.
Str1	A pointer to a Null-terminated string.
Str2	A pointer to a Null-terminated string.

Return values

0	Str1 is equivalent to Str2
>	0 Str1 is lexically greater than Str2
<	0 Str1 is lexically less than Str2

Definition at line 198 of file OcUnicodeCollationEngCommon.c.

EngStrLwr()

VOID EFIAPI EngStrLwr	(	IN EFI_UNICODE_COLLATION_PROTOCOL *	This,
		IN OUT CHAR16 *	Str )

Converts all the characters in a Null-terminated string to lower case characters.

Parameters

This	Protocol instance pointer.
Str	A pointer to a Null-terminated string.

Definition at line 226 of file OcUnicodeCollationEngCommon.c.

EngStrToFat()

BOOLEAN EFIAPI EngStrToFat	(	IN EFI_UNICODE_COLLATION_PROTOCOL *	This,
		IN CHAR16 *	String,
		IN UINTN	FatSize,
		OUT CHAR8 *	Fat )

Converts a Null-terminated string to legal characters in a FAT filename using an OEM character set.

Parameters

This	Protocol instance pointer.
String	A pointer to a Null-terminated string. The string must be preallocated to hold FatSize characters.
FatSize	The size of the string Fat in bytes.
Fat	A pointer to a Null-terminated string that contains an 8.3 file name using an OEM character set.

Return values

TRUE	Fat is a Long File Name
FALSE	Fat is an 8.3 file name

Definition at line 445 of file OcUnicodeCollationEngCommon.c.

EngStrUpr()

VOID EFIAPI EngStrUpr	(	IN EFI_UNICODE_COLLATION_PROTOCOL *	This,
		IN OUT CHAR16 *	Str )

Converts all the characters in a Null-terminated string to upper case characters.

Parameters

This	Protocol instance pointer.
Str	A pointer to a Null-terminated string.

Definition at line 247 of file OcUnicodeCollationEngCommon.c.

OcUnicodeCollationInitializeMappingTables()

VOID OcUnicodeCollationInitializeMappingTables

(

VOID

)

Initializes mapping tables for the protocol.

Definition at line 153 of file OcUnicodeCollationEngCommon.c.

UserUnicodeCollationInstallProtocol()

VOID UserUnicodeCollationInstallProtocol

(

OUT EFI_UNICODE_COLLATION_PROTOCOL **

Interface

)

Userspace English unicode collation protocol implementation.

This function initializes unicode character mapping and then install Unicode Collation protocol on given interface.

Parameters

[in]

Interface

Interface into which protocol should be installed

Definition at line 13 of file UserUnicodeCollation.c.

Variable Documentation

gInternalUnicode2Eng

EFI_UNICODE_COLLATION_PROTOCOL gInternalUnicode2Eng

extern

Unicode collation instance.

Definition at line 55 of file OcUnicodeCollationEngCommon.c.