From 439d43932133d32dcabd482f11842072d52b41e1 Mon Sep 17 00:00:00 2001
From: Zher Huei Lee
Date: Sun, 23 Oct 2016 01:22:48 +0100
Subject: RegEx re-implemented as a module
Re-wrote nrex as a module using godot-specific parts and new
features:
* Added string substitutions.
* Named groups are now supported.
* Removed use of mutable variables in RegEx. RegExMatch is returned
instead.
---
doc/base/classes.xml | 120 ++++++++++++++++++++++++++++++++++++++++++---------
1 file changed, 99 insertions(+), 21 deletions(-)
(limited to 'doc/base/classes.xml')
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 5eb021f6c..cafb14491 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -32514,6 +32514,7 @@
would be read as [code]"(?:\\.|[^"])*"[/code]
Currently supported features:
* Capturing [code]()[/code] and non-capturing [code](?:)[/code] groups
+ * Named capturing groups [code](?P<name>)[/code]
* Any character [code].[/code]
* Shorthand character classes [code]\w \W \s \S \d \D[/code]
* User-defined character classes such as [code][A-Za-z][/code]
@@ -32522,7 +32523,7 @@
* Lazy (non-greedy) quantifiers [code]*?[/code]
* Beginning [code]^[/code] and end [code]$[/code] anchors
* Alternation [code]|[/code]
- * Backreferences [code]\1[/code] and [code]\g{1}[/code]
+ * Backreferences [code]\1[/code], [code]\g{1}[/code], and [code]\g<name>[/code]
* POSIX character classes [code][[:alnum:]][/code]
* Lookahead [code](?=)[/code], [code](?!)[/code] and lookbehind [code](?<=)[/code], [code](?<!)[/code]
* ASCII [code]\xFF[/code] and Unicode [code]\uFFFF[/code] code points (in a style similar to Python)
@@ -32531,7 +32532,7 @@
- This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object, and forgets all captures made by the last [method find].
+ This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object.
@@ -32539,15 +32540,41 @@
-
-
- Compiles and assign the regular expression pattern to use. The limit on the number of capturing groups can be specified or made unlimited if negative.
+ Compiles and assign the regular expression pattern to use.
-
+
+
+ Returns the number of numeric capturing groups.
+
+
+
+
+
+
+ Returns an array of names of named capturing groups.
+
+
+
+
+
+
+ Returns the expression used to compile the code.
+
+
+
+
+
+
+ Returns whether this object has a valid regular expression assigned.
+
+
+
+
+
@@ -32555,45 +32582,96 @@
- This method tries to find the pattern within the string, and returns the position where it was found. It also stores any capturing group (see [method get_capture]) for further retrieval.
+ Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching reult if found, otherwise null. The starting point of the serch could be specified without moving the string start anchor.
-
+
-
+
+
+
+
+
+
+
- Returns a captured group. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]).
+ Searches the specified text for the compiled pattern and returns the text with the result replaced. Escapes and backreferences such as [code]\1[/code] and [code]\g<name>[/code] are automatically expanded and resolved. If no change was found the unmodified text is returned instead.
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Returns the number of capturing groups. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]).
+ Using results from the search, returns the specified string with escapes and backreferences such as [code]\1[/code] and [code]\g<name>[/code] expanded and resolved
-
+
-
+
+ Returns the end position of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
-
-
+
+
- Return a list of all the captures made by the regular expression.
+ Returns an array of the results of the numeric groups.
-
-
+
+
- Returns whether this object has a valid regular expression assigned.
+ Returns the number of numeric capturing groups.
+
+
+
+
+
+
+ Returns a dictionary containing the named capturing groups and their results.
+
+
+
+
+
+
+ Returns an array of names of named capturing groups.
+
+
+
+
+
+
+
+
+ Returns the starting position of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
+
+
+
+
+
+
+
+
+ Returns the result of the match in the string. An interger can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
--
cgit v1.2.3-70-g09d2