3 EFI_REGULAR_EXPRESSION_PROTOCOL Implementation
5 (C) Copyright 2015 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 CHAR8 ErrorMessage
[ONIG_MAX_ERROR_MESSAGE_LEN
];
96 // Detemine the internal syntax type
98 OnigSyntax
= ONIG_SYNTAX_DEFAULT
;
99 if (CompareGuid (SyntaxType
, &gEfiRegexSyntaxTypePosixExtendedGuid
)) {
100 OnigSyntax
= ONIG_SYNTAX_POSIX_EXTENDED
;
101 } else if (CompareGuid (SyntaxType
, &gEfiRegexSyntaxTypePerlGuid
)) {
102 OnigSyntax
= ONIG_SYNTAX_PERL
;
104 DEBUG ((DEBUG_ERROR
, "Unsupported regex syntax - using default\n"));
111 Start
= (OnigUChar
*)Pattern
;
112 OnigResult
= onig_new (
115 Start
+ onigenc_str_bytelen_null (CHAR16_ENCODING
, Start
),
122 if (OnigResult
!= ONIG_NORMAL
) {
123 onig_error_code_to_str (ErrorMessage
, OnigResult
, &ErrorInfo
);
124 DEBUG ((DEBUG_ERROR
, "Regex compilation failed: %a\n", ErrorMessage
));
125 return EFI_DEVICE_ERROR
;
131 Start
= (OnigUChar
*)String
;
132 Region
= onig_region_new ();
133 if (Region
== NULL
) {
134 onig_free (OnigRegex
);
135 return EFI_OUT_OF_RESOURCES
;
137 OnigResult
= onig_search (
140 Start
+ onigenc_str_bytelen_null (CHAR16_ENCODING
, Start
),
142 Start
+ onigenc_str_bytelen_null (CHAR16_ENCODING
, Start
),
146 if (OnigResult
>= 0) {
150 if (OnigResult
!= ONIG_MISMATCH
) {
151 onig_error_code_to_str (ErrorMessage
, OnigResult
);
152 DEBUG ((DEBUG_ERROR
, "Regex match failed: %a\n", ErrorMessage
));
157 // If successful, copy out the region (capture) information
159 if (*Result
&& Captures
!= NULL
) {
160 *CapturesCount
= Region
->num_regs
;
161 *Captures
= AllocatePool (*CapturesCount
* sizeof(**Captures
));
162 if (*Captures
!= NULL
) {
163 for (Index
= 0; Index
< *CapturesCount
; ++Index
) {
165 // Region beg/end values represent bytes, not characters
167 (*Captures
)[Index
].CapturePtr
= (CHAR16
*)((UINTN
)String
+ Region
->beg
[Index
]);
168 (*Captures
)[Index
].Length
= (Region
->end
[Index
] - Region
->beg
[Index
]) / sizeof(CHAR16
);
173 onig_region_free (Region
, 1);
174 onig_free (OnigRegex
);
180 Returns information about the regular expression syntax types supported
181 by the implementation.
183 @param This A pointer to the EFI_REGULAR_EXPRESSION_PROTOCOL
186 @param RegExSyntaxTypeListSize On input, the size in bytes of RegExSyntaxTypeList.
187 On output with a return code of EFI_SUCCESS, the
188 size in bytes of the data returned in
189 RegExSyntaxTypeList. On output with a return code
190 of EFI_BUFFER_TOO_SMALL, the size of
191 RegExSyntaxTypeList required to obtain the list.
193 @param RegExSyntaxTypeList A caller-allocated memory buffer filled by the
194 driver with one EFI_REGEX_SYNTAX_TYPE element
195 for each supported Regular expression syntax
196 type. The list must not change across multiple
197 calls to the same driver. The first syntax
198 type in the list is the default type for the
201 @retval EFI_SUCCESS The regular expression syntax types list
202 was returned successfully.
203 @retval EFI_UNSUPPORTED The service is not supported by this driver.
204 @retval EFI_DEVICE_ERROR The list of syntax types could not be
205 retrieved due to a hardware or firmware error.
206 @retval EFI_BUFFER_TOO_SMALL The buffer RegExSyntaxTypeList is too small
208 @retval EFI_INVALID_PARAMETER RegExSyntaxTypeListSize is NULL
213 RegularExpressionGetInfo (
214 IN EFI_REGULAR_EXPRESSION_PROTOCOL
*This
,
215 IN OUT UINTN
*RegExSyntaxTypeListSize
,
216 OUT EFI_REGEX_SYNTAX_TYPE
*RegExSyntaxTypeList
222 if (This
== NULL
|| RegExSyntaxTypeListSize
== NULL
) {
223 return EFI_INVALID_PARAMETER
;
226 if (*RegExSyntaxTypeListSize
!= 0 && RegExSyntaxTypeList
== NULL
) {
227 return EFI_INVALID_PARAMETER
;
230 SyntaxSize
= ARRAY_SIZE (mSupportedSyntaxes
) * sizeof(**mSupportedSyntaxes
);
232 if (*RegExSyntaxTypeListSize
< SyntaxSize
) {
233 *RegExSyntaxTypeListSize
= SyntaxSize
;
234 return EFI_BUFFER_TOO_SMALL
;
237 for (Index
= 0; Index
< ARRAY_SIZE (mSupportedSyntaxes
); ++Index
) {
238 CopyMem (&RegExSyntaxTypeList
[Index
], mSupportedSyntaxes
[Index
], sizeof(**mSupportedSyntaxes
));
240 *RegExSyntaxTypeListSize
= SyntaxSize
;
246 Checks if the input string matches to the regular expression pattern.
248 @param This A pointer to the EFI_REGULAR_EXPRESSION_PROTOCOL instance.
249 Type EFI_REGULAR_EXPRESSION_PROTOCOL is defined in Section
252 @param String A pointer to a NULL terminated string to match against the
253 regular expression string specified by Pattern.
255 @param Pattern A pointer to a NULL terminated string that represents the
258 @param SyntaxType A pointer to the EFI_REGEX_SYNTAX_TYPE that identifies the
259 regular expression syntax type to use. May be NULL in which
260 case the function will use its default regular expression
263 @param Result On return, points to TRUE if String fully matches against
264 the regular expression Pattern using the regular expression
265 SyntaxType. Otherwise, points to FALSE.
267 @param Captures A Pointer to an array of EFI_REGEX_CAPTURE objects to receive
268 the captured groups in the event of a match. The full
269 sub-string match is put in Captures[0], and the results of N
270 capturing groups are put in Captures[1:N]. If Captures is
271 NULL, then this function doesn't allocate the memory for the
272 array and does not build up the elements. It only returns the
273 number of matching patterns in CapturesCount. If Captures is
274 not NULL, this function returns a pointer to an array and
275 builds up the elements in the array. CapturesCount is also
276 updated to the number of matching patterns found. It is the
277 caller's responsibility to free the memory pool in Captures
278 and in each CapturePtr in the array elements.
280 @param CapturesCount On output, CapturesCount is the number of matching patterns
281 found in String. Zero means no matching patterns were found
284 @retval EFI_SUCCESS The regular expression string matching
285 completed successfully.
286 @retval EFI_UNSUPPORTED The regular expression syntax specified by
287 SyntaxType is not supported by this driver.
288 @retval EFI_DEVICE_ERROR The regular expression string matching
289 failed due to a hardware or firmware error.
290 @retval EFI_INVALID_PARAMETER String, Pattern, Result, or CapturesCountis
296 RegularExpressionMatch (
297 IN EFI_REGULAR_EXPRESSION_PROTOCOL
*This
,
300 IN EFI_REGEX_SYNTAX_TYPE
*SyntaxType
, OPTIONAL
302 OUT EFI_REGEX_CAPTURE
**Captures
, OPTIONAL
303 OUT UINTN
*CapturesCount
310 if (This
== NULL
|| String
== NULL
|| Pattern
== NULL
|| Result
== NULL
|| CapturesCount
== NULL
) {
311 return EFI_INVALID_PARAMETER
;
315 // Figure out which syntax to use
317 if (SyntaxType
== NULL
) {
318 SyntaxType
= mSupportedSyntaxes
[0];
321 for (Index
= 0; Index
< ARRAY_SIZE (mSupportedSyntaxes
); ++Index
) {
322 if (CompareGuid (SyntaxType
, mSupportedSyntaxes
[Index
])) {
328 return EFI_UNSUPPORTED
;
332 Status
= OnigurumaMatch (String
, Pattern
, SyntaxType
, Result
, Captures
, CapturesCount
);
338 Entry point for RegularExpressionDxe.
340 @param ImageHandle Image handle this driver.
341 @param SystemTable Pointer to SystemTable.
343 @retval Status Whether this function complete successfully.
348 RegularExpressionDxeEntry (
349 IN EFI_HANDLE ImageHandle
,
350 IN EFI_SYSTEM_TABLE
*SystemTable
355 Status
= gBS
->InstallMultipleProtocolInterfaces (
357 &gEfiRegularExpressionProtocolGuid
,