MdeModulePkg: Change OPTIONAL keyword usage style

[mirror_edk2.git] / MdeModulePkg / Universal / RegularExpressionDxe / RegularExpressionDxe.h

/** @file\r
  EFI_REGULAR_EXPRESSION_PROTOCOL Header File.\r
\r
  (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>\r
  Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __REGULAR_EXPRESSIONDXE_H__\r
#define __REGULAR_EXPRESSIONDXE_H__\r
\r
#include "oniguruma/src/oniguruma.h"\r
\r
#include <Uefi.h>\r
#include <Protocol/RegularExpressionProtocol.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
\r
/**\r
  Checks if the input string matches to the regular expression pattern.\r
\r
  @param This          A pointer to the EFI_REGULAR_EXPRESSION_PROTOCOL instance.\r
                       Type EFI_REGULAR_EXPRESSION_PROTOCOL is defined in Section\r
                       XYZ.\r
\r
  @param String        A pointer to a NULL terminated string to match against the\r
                       regular expression string specified by Pattern.\r
\r
  @param Pattern       A pointer to a NULL terminated string that represents the\r
                       regular expression.\r
\r
  @param SyntaxType    A pointer to the EFI_REGEX_SYNTAX_TYPE that identifies the\r
                       regular expression syntax type to use. May be NULL in which\r
                       case the function will use its default regular expression\r
                       syntax type.\r
\r
  @param Result        On return, points to TRUE if String fully matches against\r
                       the regular expression Pattern using the regular expression\r
                       SyntaxType. Otherwise, points to FALSE.\r
\r
  @param Captures      A Pointer to an array of EFI_REGEX_CAPTURE objects to receive\r
                       the captured groups in the event of a match. The full\r
                       sub-string match is put in Captures[0], and the results of N\r
                       capturing groups are put in Captures[1:N]. If Captures is\r
                       NULL, then this function doesn't allocate the memory for the\r
                       array and does not build up the elements. It only returns the\r
                       number of matching patterns in CapturesCount. If Captures is\r
                       not NULL, this function returns a pointer to an array and\r
                       builds up the elements in the array. CapturesCount is also\r
                       updated to the number of matching patterns found. It is the\r
                       caller's responsibility to free the memory pool in Captures\r
                       and in each CapturePtr in the array elements.\r
\r
  @param CapturesCount On output, CapturesCount is the number of matching patterns\r
                found in String. Zero means no matching patterns were found\r
                in the string.\r
\r
  @retval EFI_SUCCESS            The regular expression string matching\r
                                 completed successfully.\r
  @retval EFI_UNSUPPORTED        The regular expression syntax specified by\r
                                 SyntaxType is not supported by this driver.\r
  @retval EFI_DEVICE_ERROR       The regular expression string matching\r
                                 failed due to a hardware or firmware error.\r
  @retval EFI_INVALID_PARAMETER  String, Pattern, Result, or CapturesCountis\r
                                 NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RegularExpressionMatch (\r
  IN  EFI_REGULAR_EXPRESSION_PROTOCOL *This,\r
  IN  CHAR16                          *String,\r
  IN  CHAR16                          *Pattern,\r
  IN  EFI_REGEX_SYNTAX_TYPE           *SyntaxType  OPTIONAL,\r
  OUT BOOLEAN                         *Result,\r
  OUT EFI_REGEX_CAPTURE               **Captures  OPTIONAL,\r
  OUT UINTN                           *CapturesCount\r
  );\r
\r
/**\r
  Returns information about the regular expression syntax types supported\r
  by the implementation.\r
\r
  @param This                     A pointer to the EFI_REGULAR_EXPRESSION_PROTOCOL\r
                                  instance.\r
\r
  @param RegExSyntaxTypeListSize  On input, the size in bytes of RegExSyntaxTypeList.\r
                                  On output with a return code of EFI_SUCCESS, the\r
                                  size in bytes of the data returned in\r
                                  RegExSyntaxTypeList. On output with a return code\r
                                  of EFI_BUFFER_TOO_SMALL, the size of\r
                                  RegExSyntaxTypeList required to obtain the list.\r
\r
  @param RegExSyntaxTypeList      A caller-allocated memory buffer filled by the\r
                                  driver with one EFI_REGEX_SYNTAX_TYPE element\r
                                  for each supported Regular expression syntax\r
                                  type. The list must not change across multiple\r
                                  calls to the same driver. The first syntax\r
                                  type in the list is the default type for the\r
                                  driver.\r
\r
  @retval EFI_SUCCESS            The regular expression syntax types list\r
                                 was returned successfully.\r
  @retval EFI_UNSUPPORTED        The service is not supported by this driver.\r
  @retval EFI_DEVICE_ERROR       The list of syntax types could not be\r
                                 retrieved due to a hardware or firmware error.\r
  @retval EFI_BUFFER_TOO_SMALL   The buffer RegExSyntaxTypeList is too small\r
                                 to hold the result.\r
  @retval EFI_INVALID_PARAMETER  RegExSyntaxTypeListSize is NULL\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RegularExpressionGetInfo (\r
  IN     EFI_REGULAR_EXPRESSION_PROTOCOL *This,\r
  IN OUT UINTN                           *RegExSyntaxTypeListSize,\r
  OUT    EFI_REGEX_SYNTAX_TYPE           *RegExSyntaxTypeList\r
  );\r
\r
#endif\r