RegularExpressionDxe.h File Reference

#include "oniguruma/src/oniguruma.h"
#include <Uefi.h>
#include <Protocol/RegularExpressionProtocol.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseLib.h>

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	RegularExpressionMatch (IN EFI_REGULAR_EXPRESSION_PROTOCOL *This, IN CHAR16 *String, IN CHAR16 *Pattern, IN EFI_REGEX_SYNTAX_TYPE *SyntaxType OPTIONAL, OUT BOOLEAN *Result, OUT EFI_REGEX_CAPTURE **Captures OPTIONAL, OUT UINTN *CapturesCount)
EFI_STATUS EFIAPI	RegularExpressionGetInfo (IN EFI_REGULAR_EXPRESSION_PROTOCOL *This, IN OUT UINTN *RegExSyntaxTypeListSize, OUT EFI_REGEX_SYNTAX_TYPE *RegExSyntaxTypeList)

Detailed Description

EFI_REGULAR_EXPRESSION_PROTOCOL Header File.

(C) Copyright 2015 Hewlett Packard Enterprise Development LP
Copyright (c) 2020, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file RegularExpressionDxe.h.

Function Documentation

RegularExpressionGetInfo()

EFI_STATUS EFIAPI RegularExpressionGetInfo	(	IN EFI_REGULAR_EXPRESSION_PROTOCOL *	This,
		IN OUT UINTN *	RegExSyntaxTypeListSize,
		OUT EFI_REGEX_SYNTAX_TYPE *	RegExSyntaxTypeList
	)

Returns information about the regular expression syntax types supported by the implementation.

Parameters

This	A pointer to the EFI_REGULAR_EXPRESSION_PROTOCOL instance.
RegExSyntaxTypeListSize	On input, the size in bytes of RegExSyntaxTypeList. On output with a return code of EFI_SUCCESS, the size in bytes of the data returned in RegExSyntaxTypeList. On output with a return code of EFI_BUFFER_TOO_SMALL, the size of RegExSyntaxTypeList required to obtain the list.
RegExSyntaxTypeList	A caller-allocated memory buffer filled by the driver with one EFI_REGEX_SYNTAX_TYPE element for each supported Regular expression syntax type. The list must not change across multiple calls to the same driver. The first syntax type in the list is the default type for the driver.

Return values

EFI_SUCCESS	The regular expression syntax types list was returned successfully.
EFI_UNSUPPORTED	The service is not supported by this driver.
EFI_DEVICE_ERROR	The list of syntax types could not be retrieved due to a hardware or firmware error.
EFI_BUFFER_TOO_SMALL	The buffer RegExSyntaxTypeList is too small to hold the result.
EFI_INVALID_PARAMETER	RegExSyntaxTypeListSize is NULL

Definition at line 230 of file RegularExpressionDxe.c.

RegularExpressionMatch()

EFI_STATUS EFIAPI RegularExpressionMatch	(	IN EFI_REGULAR_EXPRESSION_PROTOCOL *	This,
		IN CHAR16 *	String,
		IN CHAR16 *	Pattern,
		IN EFI_REGEX_SYNTAX_TYPE *SyntaxType	OPTIONAL,
		OUT BOOLEAN *	Result,
		OUT EFI_REGEX_CAPTURE **Captures	OPTIONAL,
		OUT UINTN *	CapturesCount
	)

Checks if the input string matches to the regular expression pattern.

Parameters

This	A pointer to the EFI_REGULAR_EXPRESSION_PROTOCOL instance. Type EFI_REGULAR_EXPRESSION_PROTOCOL is defined in Section XYZ.
String	A pointer to a NULL terminated string to match against the regular expression string specified by Pattern.
Pattern	A pointer to a NULL terminated string that represents the regular expression.
SyntaxType	A pointer to the EFI_REGEX_SYNTAX_TYPE that identifies the regular expression syntax type to use. May be NULL in which case the function will use its default regular expression syntax type.
Result	On return, points to TRUE if String fully matches against the regular expression Pattern using the regular expression SyntaxType. Otherwise, points to FALSE.
Captures	A Pointer to an array of EFI_REGEX_CAPTURE objects to receive the captured groups in the event of a match. The full sub-string match is put in Captures[0], and the results of N capturing groups are put in Captures[1:N]. If Captures is NULL, then this function doesn't allocate the memory for the array and does not build up the elements. It only returns the number of matching patterns in CapturesCount. If Captures is not NULL, this function returns a pointer to an array and builds up the elements in the array. CapturesCount is also updated to the number of matching patterns found. It is the caller's responsibility to free the memory pool in Captures and in each CapturePtr in the array elements.
CapturesCount	On output, CapturesCount is the number of matching patterns found in String. Zero means no matching patterns were found in the string.

Return values

EFI_SUCCESS	The regular expression string matching completed successfully.
EFI_UNSUPPORTED	The regular expression syntax specified by SyntaxType is not supported by this driver.
EFI_DEVICE_ERROR	The regular expression string matching failed due to a hardware or firmware error.
EFI_INVALID_PARAMETER	String, Pattern, Result, or CapturesCountis NULL.

Definition at line 314 of file RegularExpressionDxe.c.