3 EFI_REGULAR_EXPRESSION_PROTOCOL Implementation
5 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
7 This program and the accompanying materials are licensed and made available
8 under the terms and conditions of the BSD License that accompanies this
9 distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
13 WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "RegularExpressionDxe.h"
20 EFI_REGEX_SYNTAX_TYPE
* CONST mSupportedSyntaxes
[] = {
21 &gEfiRegexSyntaxTypePosixExtendedGuid
,
22 &gEfiRegexSyntaxTypePerlGuid
26 EFI_REGULAR_EXPRESSION_PROTOCOL mProtocolInstance
= {
27 RegularExpressionMatch
,
28 RegularExpressionGetInfo
33 #define CHAR16_ENCODING ONIG_ENCODING_UTF16_LE
36 Call the Oniguruma regex match API.
38 Same parameters as RegularExpressionMatch, except SyntaxType is required.
40 @param String A pointer to a NULL terminated string to match against the
41 regular expression string specified by Pattern.
43 @param Pattern A pointer to a NULL terminated string that represents the
45 @param SyntaxType A pointer to the EFI_REGEX_SYNTAX_TYPE that identifies the
46 regular expression syntax type to use. May be NULL in which
47 case the function will use its default regular expression
50 @param Result On return, points to TRUE if String fully matches against
51 the regular expression Pattern using the regular expression
52 SyntaxType. Otherwise, points to FALSE.
54 @param Captures A Pointer to an array of EFI_REGEX_CAPTURE objects to receive
55 the captured groups in the event of a match. The full
56 sub-string match is put in Captures[0], and the results of N
57 capturing groups are put in Captures[1:N]. If Captures is
58 NULL, then this function doesn't allocate the memory for the
59 array and does not build up the elements. It only returns the
60 number of matching patterns in CapturesCount. If Captures is
61 not NULL, this function returns a pointer to an array and
62 builds up the elements in the array. CapturesCount is also
63 updated to the number of matching patterns found. It is the
64 caller's responsibility to free the memory pool in Captures
65 and in each CapturePtr in the array elements.
67 @param CapturesCount On output, CapturesCount is the number of matching patterns
68 found in String. Zero means no matching patterns were found
71 @retval EFI_SUCCESS Regex compilation and match completed successfully.
72 @retval EFI_DEVICE_ERROR Regex compilation failed.
80 IN EFI_REGEX_SYNTAX_TYPE
*SyntaxType
,
82 OUT EFI_REGEX_CAPTURE
**Captures
, OPTIONAL
83 OUT UINTN
*CapturesCount
87 OnigSyntaxType
*OnigSyntax
;
90 OnigErrorInfo ErrorInfo
;
91 OnigUChar ErrorMessage
[ONIG_MAX_ERROR_MESSAGE_LEN
];
100 // Detemine the internal syntax type
102 OnigSyntax
= ONIG_SYNTAX_DEFAULT
;
103 if (CompareGuid (SyntaxType
, &gEfiRegexSyntaxTypePosixExtendedGuid
)) {
104 OnigSyntax
= ONIG_SYNTAX_POSIX_EXTENDED
;
105 } else if (CompareGuid (SyntaxType
, &gEfiRegexSyntaxTypePerlGuid
)) {
106 OnigSyntax
= ONIG_SYNTAX_PERL
;
108 DEBUG ((DEBUG_ERROR
, "Unsupported regex syntax - using default\n"));
109 return EFI_UNSUPPORTED
;
115 Start
= (OnigUChar
*)Pattern
;
116 OnigResult
= onig_new (
119 Start
+ onigenc_str_bytelen_null (CHAR16_ENCODING
, Start
),
126 if (OnigResult
!= ONIG_NORMAL
) {
127 onig_error_code_to_str (ErrorMessage
, OnigResult
, &ErrorInfo
);
128 DEBUG ((DEBUG_ERROR
, "Regex compilation failed: %a\n", ErrorMessage
));
129 return EFI_DEVICE_ERROR
;
135 Start
= (OnigUChar
*)String
;
136 Region
= onig_region_new ();
137 if (Region
== NULL
) {
138 onig_free (OnigRegex
);
139 return EFI_OUT_OF_RESOURCES
;
141 OnigResult
= onig_search (
144 Start
+ onigenc_str_bytelen_null (CHAR16_ENCODING
, Start
),
146 Start
+ onigenc_str_bytelen_null (CHAR16_ENCODING
, Start
),
151 if (OnigResult
>= 0) {
155 if (OnigResult
!= ONIG_MISMATCH
) {
156 onig_error_code_to_str (ErrorMessage
, OnigResult
);
157 DEBUG ((DEBUG_ERROR
, "Regex match failed: %a\n", ErrorMessage
));
158 onig_region_free (Region
, 1);
159 onig_free (OnigRegex
);
160 return EFI_DEVICE_ERROR
;
165 // If successful, copy out the region (capture) information
167 if (*Result
&& Captures
!= NULL
) {
168 *CapturesCount
= Region
->num_regs
;
169 *Captures
= AllocateZeroPool (*CapturesCount
* sizeof(**Captures
));
170 if (*Captures
!= NULL
) {
171 for (Index
= 0; Index
< *CapturesCount
; ++Index
) {
173 // Region beg/end values represent bytes, not characters
175 (*Captures
)[Index
].Length
= (Region
->end
[Index
] - Region
->beg
[Index
]) / sizeof(CHAR16
);
176 (*Captures
)[Index
].CapturePtr
= AllocateCopyPool (
177 ((*Captures
)[Index
].Length
) * sizeof (CHAR16
),
178 (CHAR16
*)((UINTN
)String
+ Region
->beg
[Index
])
180 if ((*Captures
)[Index
].CapturePtr
== NULL
) {
181 Status
= EFI_OUT_OF_RESOURCES
;
186 if (EFI_ERROR (Status
)) {
187 for (Index
= 0; Index
< *CapturesCount
; ++Index
) {
188 if ((*Captures
)[Index
].CapturePtr
!= NULL
) {
189 FreePool ((CHAR16
*)(*Captures
)[Index
].CapturePtr
);
192 FreePool (*Captures
);
197 onig_region_free (Region
, 1);
198 onig_free (OnigRegex
);
204 Returns information about the regular expression syntax types supported
205 by the implementation.
207 @param This A pointer to the EFI_REGULAR_EXPRESSION_PROTOCOL
210 @param RegExSyntaxTypeListSize On input, the size in bytes of RegExSyntaxTypeList.
211 On output with a return code of EFI_SUCCESS, the
212 size in bytes of the data returned in
213 RegExSyntaxTypeList. On output with a return code
214 of EFI_BUFFER_TOO_SMALL, the size of
215 RegExSyntaxTypeList required to obtain the list.
217 @param RegExSyntaxTypeList A caller-allocated memory buffer filled by the
218 driver with one EFI_REGEX_SYNTAX_TYPE element
219 for each supported Regular expression syntax
220 type. The list must not change across multiple
221 calls to the same driver. The first syntax
222 type in the list is the default type for the
225 @retval EFI_SUCCESS The regular expression syntax types list
226 was returned successfully.
227 @retval EFI_UNSUPPORTED The service is not supported by this driver.
228 @retval EFI_DEVICE_ERROR The list of syntax types could not be
229 retrieved due to a hardware or firmware error.
230 @retval EFI_BUFFER_TOO_SMALL The buffer RegExSyntaxTypeList is too small
232 @retval EFI_INVALID_PARAMETER RegExSyntaxTypeListSize is NULL
237 RegularExpressionGetInfo (
238 IN EFI_REGULAR_EXPRESSION_PROTOCOL
*This
,
239 IN OUT UINTN
*RegExSyntaxTypeListSize
,
240 OUT EFI_REGEX_SYNTAX_TYPE
*RegExSyntaxTypeList
246 if (This
== NULL
|| RegExSyntaxTypeListSize
== NULL
) {
247 return EFI_INVALID_PARAMETER
;
250 if (*RegExSyntaxTypeListSize
!= 0 && RegExSyntaxTypeList
== NULL
) {
251 return EFI_INVALID_PARAMETER
;
254 SyntaxSize
= ARRAY_SIZE (mSupportedSyntaxes
) * sizeof(**mSupportedSyntaxes
);
256 if (*RegExSyntaxTypeListSize
< SyntaxSize
) {
257 *RegExSyntaxTypeListSize
= SyntaxSize
;
258 return EFI_BUFFER_TOO_SMALL
;
261 for (Index
= 0; Index
< ARRAY_SIZE (mSupportedSyntaxes
); ++Index
) {
262 CopyMem (&RegExSyntaxTypeList
[Index
], mSupportedSyntaxes
[Index
], sizeof(**mSupportedSyntaxes
));
264 *RegExSyntaxTypeListSize
= SyntaxSize
;
270 Checks if the input string matches to the regular expression pattern.
272 @param This A pointer to the EFI_REGULAR_EXPRESSION_PROTOCOL instance.
273 Type EFI_REGULAR_EXPRESSION_PROTOCOL is defined in Section
276 @param String A pointer to a NULL terminated string to match against the
277 regular expression string specified by Pattern.
279 @param Pattern A pointer to a NULL terminated string that represents the
282 @param SyntaxType A pointer to the EFI_REGEX_SYNTAX_TYPE that identifies the
283 regular expression syntax type to use. May be NULL in which
284 case the function will use its default regular expression
287 @param Result On return, points to TRUE if String fully matches against
288 the regular expression Pattern using the regular expression
289 SyntaxType. Otherwise, points to FALSE.
291 @param Captures A Pointer to an array of EFI_REGEX_CAPTURE objects to receive
292 the captured groups in the event of a match. The full
293 sub-string match is put in Captures[0], and the results of N
294 capturing groups are put in Captures[1:N]. If Captures is
295 NULL, then this function doesn't allocate the memory for the
296 array and does not build up the elements. It only returns the
297 number of matching patterns in CapturesCount. If Captures is
298 not NULL, this function returns a pointer to an array and
299 builds up the elements in the array. CapturesCount is also
300 updated to the number of matching patterns found. It is the
301 caller's responsibility to free the memory pool in Captures
302 and in each CapturePtr in the array elements.
304 @param CapturesCount On output, CapturesCount is the number of matching patterns
305 found in String. Zero means no matching patterns were found
308 @retval EFI_SUCCESS The regular expression string matching
309 completed successfully.
310 @retval EFI_UNSUPPORTED The regular expression syntax specified by
311 SyntaxType is not supported by this driver.
312 @retval EFI_DEVICE_ERROR The regular expression string matching
313 failed due to a hardware or firmware error.
314 @retval EFI_INVALID_PARAMETER String, Pattern, Result, or CapturesCountis
320 RegularExpressionMatch (
321 IN EFI_REGULAR_EXPRESSION_PROTOCOL
*This
,
324 IN EFI_REGEX_SYNTAX_TYPE
*SyntaxType
, OPTIONAL
326 OUT EFI_REGEX_CAPTURE
**Captures
, OPTIONAL
327 OUT UINTN
*CapturesCount
334 if (This
== NULL
|| String
== NULL
|| Pattern
== NULL
|| Result
== NULL
|| CapturesCount
== NULL
) {
335 return EFI_INVALID_PARAMETER
;
339 // Figure out which syntax to use
341 if (SyntaxType
== NULL
) {
342 SyntaxType
= mSupportedSyntaxes
[0];
345 for (Index
= 0; Index
< ARRAY_SIZE (mSupportedSyntaxes
); ++Index
) {
346 if (CompareGuid (SyntaxType
, mSupportedSyntaxes
[Index
])) {
352 return EFI_UNSUPPORTED
;
356 Status
= OnigurumaMatch (String
, Pattern
, SyntaxType
, Result
, Captures
, CapturesCount
);
362 Entry point for RegularExpressionDxe.
364 @param ImageHandle Image handle this driver.
365 @param SystemTable Pointer to SystemTable.
367 @retval Status Whether this function complete successfully.
372 RegularExpressionDxeEntry (
373 IN EFI_HANDLE ImageHandle
,
374 IN EFI_SYSTEM_TABLE
*SystemTable
379 Status
= gBS
->InstallMultipleProtocolInterfaces (
381 &gEfiRegularExpressionProtocolGuid
,