public class RE
- Object
- RE
RE is an efficient, lightweight regular expression evaluator/matcher class. Regular expressions are pattern descriptions which enable sophisticated matching of strings. In addition to being able to match a string against a pattern, you can also extract parts of the match. This is especially useful in text parsing! Details on the syntax of regular expression patterns are given below.
To compile a regular expression (RE), you can simply construct an RE matcher object from the string specification of the pattern, like this:
RE r = new RE("a*b");
Once you have done this, you can call either of the RE.match methods to perform matching on a String. For example:
boolean matched = r.match("aaaab");
will cause the boolean matched to be set to true because the pattern “a*b” matches the string “aaaab”.
If you were interested in the number of a’s which matched the first part of our example expression, you could change the expression to “(a*)b”. Then when you compiled the expression and matched it against something like “xaaaab”, you would get results like this:
RE r = new RE("(a*)b"); // Compile expression
boolean matched = r.match("xaaaab"); // Match against "xaaaab"
String wholeExpr = r.getParen(0); // wholeExpr will be 'aaaab'
String insideParens = r.getParen(1); // insideParens will be 'aaaa'
int startWholeExpr = r.getParenStart(0); // startWholeExpr will be index 1
int endWholeExpr = r.getParenEnd(0); // endWholeExpr will be index 6
int lenWholeExpr = r.getParenLength(0); // lenWholeExpr will be 5
int startInside = r.getParenStart(1); // startInside will be index 1
int endInside = r.getParenEnd(1); // endInside will be index 5
int lenInside = r.getParenLength(1); // lenInside will be 4
You can also refer to the contents of a parenthesized expression within a regular expression itself. This is called a ‘backreference’. The first backreference in a regular expression is denoted by \1, the second by \2 and so on. So the expression:
String pattern = "([0-9]+)=\\1";
will match any string of the form n=n (like 0=0 or 2=2).
The full regular expression syntax accepted by RE is described here:
**Characters**
*unicodeChar* Matches any identical unicode character
\ Used to quote a meta-character (like '*')
\\ Matches a single '\' character
\0nnn Matches a given octal character
\xhh Matches a given 8-bit hexadecimal character
\\uhhhh Matches a given 16-bit hexadecimal character
\t Matches an ASCII tab character
\n Matches an ASCII newline character
\r Matches an ASCII return character
\f Matches an ASCII form feed character
**Character Classes**
[abc] Simple character class
[a-zA-Z] Character class with ranges
[^abc] Negated character class
NOTE: Incomplete ranges will be interpreted as “starts from zero” or “ends with last character”.
I.e. [-a] is the same as [\u0000-a], and [a-] is the same as [a-\uFFFF], [-] means “all characters”.
**Standard POSIX Character Classes**
[:alnum:] Alphanumeric characters.
[:alpha:] Alphabetic characters.
[:blank:] Space and tab characters.
[:cntrl:] Control characters.
[:digit:] Numeric characters.
[:graph:] Characters that are printable and are also visible.
(A space is printable, but not visible, while an
`a' is both.)
[:lower:] Lower-case alphabetic characters.
[:print:] Printable characters (characters that are not
control characters.)
[:punct:] Punctuation characters (characters that are not letter,
digits, control characters, or space characters).
[:space:] Space characters (such as space, tab, and formfeed,
to name a few).
[:upper:] Upper-case alphabetic characters.
[:xdigit:] Characters that are hexadecimal digits.
**Non-standard POSIX-style Character Classes**
[:javastart:] Start of a Java identifier
[:javapart:] Part of a Java identifier
**Predefined Classes**
. Matches any character other than newline
\w Matches a "word" character (alphanumeric plus "_")
\W Matches a non-word character
\s Matches a whitespace character
\S Matches a non-whitespace character
\d Matches a digit character
\D Matches a non-digit character
**Boundary Matchers**
^ Matches only at the beginning of a line
$ Matches only at the end of a line
\b Matches only at a word boundary
\B Matches only at a non-word boundary
**Greedy Closures**
A* Matches A 0 or more times (greedy)
A+ Matches A 1 or more times (greedy)
A? Matches A 1 or 0 times (greedy)
A{n} Matches A exactly n times (greedy)
A{n,} Matches A at least n times (greedy)
A{n,m} Matches A at least n but not more than m times (greedy)
**Reluctant Closures**
A*? Matches A 0 or more times (reluctant)
A+? Matches A 1 or more times (reluctant)
A?? Matches A 0 or 1 times (reluctant)
**Logical Operators**
AB Matches A followed by B
A|B Matches either A or B
(A) Used for subexpression grouping
(?:A) Used for subexpression clustering (just like grouping but
no backrefs)
**Backreferences**
\1 Backreference to 1st parenthesized subexpression
\2 Backreference to 2nd parenthesized subexpression
\3 Backreference to 3rd parenthesized subexpression
\4 Backreference to 4th parenthesized subexpression
\5 Backreference to 5th parenthesized subexpression
\6 Backreference to 6th parenthesized subexpression
\7 Backreference to 7th parenthesized subexpression
\8 Backreference to 8th parenthesized subexpression
\9 Backreference to 9th parenthesized subexpression
All closure operators (+, *, ?, {m,n}) are greedy by default, meaning that they match as many elements of the string as possible without causing the overall match to fail. If you want a closure to be reluctant (non-greedy), you can simply follow it with a ‘?’. A reluctant closure will match as few elements of the string as possible when finding matches. {m,n} closures don’t currently support reluctancy.
Line terminators
A line terminator is a one- or two-character sequence that marks the end of a line of the input character sequence. The following are recognized as line terminators:
A newline (line feed) character (’\n’),
A carriage-return character followed immediately by a newline character ("\r\n"),
A standalone carriage-return character (’\r’),
A next-line character (’ ‘),
A line-separator character (’ ‘), or
A paragraph-separator character (’ ).
RE runs programs compiled by the RECompiler class. But the RE matcher class does not include the actual regular expression compiler for reasons of efficiency. You can construct a single RECompiler object and re-use it to compile each expression. Similarly, you can change the program run by a given matcher object at any time. However, RE and RECompiler are not threadsafe (for efficiency reasons, and because requiring thread safety in this class is deemed to be a rare requirement), so you will need to construct a separate compiler or matcher object for each thread (unless you do thread synchronization yourself). Once expression compiled into the REProgram object, REProgram can be safely shared across multiple threads and RE objects.
ISSUES:
com.weusours.util.re is not currently compatible with all standard POSIX regcomp flags
com.weusours.util.re does not support POSIX equivalence classes ([=foo=] syntax) (I18N/locale issue)
com.weusours.util.re does not support nested POSIX character classes (definitely should, but not completely trivial)
com.weusours.util.re Does not support POSIX character collation concepts ([.foo.] syntax) (I18N/locale issue)
Should there be different matching styles (simple, POSIX, Perl etc?)
Should RE support character iterators (for backwards RE matching!)?
Should RE support reluctant {m,n} closures (does anyone care)?
Not all possibilities are considered for greediness when backreferences are involved (as POSIX suggests should be the case). The POSIX RE
"(ac*)c*d[ac]*\1", when matched against"acdacaa"should yield a match of acdacaa where \1 is “a”. This is not the case in this RE package, and actually Perl doesn’t go to this extent either! Until someone actually complains about this, I’m not sure it’s worth “fixing”. If it ever is fixed, test #137 in RETest.txt should be updated.
Fields
public static final int MATCH_NORMAL = 0 | Specifies normal, case-sensitive matching behaviour. |
public static final int MATCH_CASEINDEPENDENT = 1 | Flag to indicate that matching should be case-independent (folded) |
public static final int MATCH_MULTILINE = 2 | Newlines should match as BOL/EOL (^ and $) |
public static final int MATCH_SINGLELINE = 4 | Consider all input a single body of text - newlines are matched by . |
public static final int REPLACE_ALL = 0 | Flag bit that indicates that subst should replace all occurrences of this regular expression. |
public static final int REPLACE_FIRSTONLY = 1 | Flag bit that indicates that subst should only replace the first occurrence of this regular expression. |
public static final int REPLACE_BACKREFERENCES = 2 | Flag bit that indicates that subst should replace backreferences |
Constructors
public RE(String pattern)
throws RESyntaxException | Constructs a regular expression matcher from a String by compiling it using a new instance of RECompiler. |
public RE(String pattern, int matchFlags)
throws RESyntaxException | Constructs a regular expression matcher from a String by compiling it using a new instance of RECompiler. |
public RE(REProgram program, int matchFlags) | Construct a matcher for a pre-compiled regular expression from program (bytecode) data. |
public RE(REProgram program) | Construct a matcher for a pre-compiled regular expression from program (bytecode) data. |
public RE() | Constructs a regular expression matcher with no initial program. |
Methods
public static String simplePatternToFullRegularExpression(String pattern) | Converts a ‘simplified’ regular expression to a full regular expression |
public int getMatchFlags() | Returns the current match behaviour flags. |
public void setMatchFlags(int matchFlags) | Sets match behaviour flags which alter the way RE does matching. |
public REProgram getProgram() | Returns the current regular expression program in use by this matcher object. |
public void setProgram(REProgram program) | Sets the current regular expression program used by this matcher object. |
public int getParenCount() | Returns the number of parenthesized subexpressions available after a successful match. |
public String getParen(int which) | Gets the contents of a parenthesized subexpression after a successful match. |
public final int getParenStart(int which) | Returns the start index of a given paren level. |
public final int getParenEnd(int which) | Returns the end index of a given paren level. |
public final int getParenLength(int which) | Returns the length of a given paren level. |
protected final void setParenStart(int which, int i) | Sets the start of a paren level |
protected final void setParenEnd(int which, int i) | Sets the end of a paren level |
protected void internalError(String s)
throws Error | Throws an Error representing an internal error condition probably resulting from a bug in the regular expression compiler (or possibly data corruption). |
protected int matchNodes(int firstNode, int lastNode, int idxStart) | Try to match a string against a subset of nodes in the program |
protected boolean matchAt(int i) | Match the current regular expression program against the current input string, starting at index i of the input string. |
public boolean match(String search, int i) | Matches the current regular expression program against a character array, starting at a given index. |
public boolean match(CharacterIterator search, int i) | Matches the current regular expression program against a character array, starting at a given index. |
public boolean match(String search) | Matches the current regular expression program against a String. |
public String[] split(String s) | Splits a string into an array of strings on regular expression boundaries. |
public String subst(String substituteIn, String substitution) | Substitutes a string for this regular expression in another string. |
public String subst(String substituteIn, String substitution, int flags) | Substitutes a string for this regular expression in another string. |
public String[] grep(Object[] search) | Returns an array of Strings, whose toString representation matches a regular expression. |
Inherited methods
Field details
MATCH_NORMAL
public static final int MATCH_NORMAL = 0MATCH_CASEINDEPENDENT
public static final int MATCH_CASEINDEPENDENT = 1MATCH_MULTILINE
public static final int MATCH_MULTILINE = 2MATCH_SINGLELINE
public static final int MATCH_SINGLELINE = 4REPLACE_ALL
public static final int REPLACE_ALL = 0REPLACE_FIRSTONLY
public static final int REPLACE_FIRSTONLY = 1REPLACE_BACKREFERENCES
public static final int REPLACE_BACKREFERENCES = 2Constructor details
RE
public RE(String pattern)
throws RESyntaxExceptionParameters
patternString- The regular expression pattern to compile.
Throws
RESyntaxException- Thrown if the regular expression has invalid syntax.
See also
RE
public RE(String pattern, int matchFlags)
throws RESyntaxExceptionParameters
patternString- The regular expression pattern to compile.
matchFlagsint- The matching style
Throws
RESyntaxException- Thrown if the regular expression has invalid syntax.
See also
RE
public RE(REProgram program, int matchFlags)Parameters
programREProgram- Compiled regular expression program (see RECompiler)
matchFlagsintOne or more of the RE match behaviour flags (RE.MATCH_*):
int matchFlags = RE.MATCH_NORMAL; matchFlags |= RE.MATCH_CASEINDEPENDENT; matchFlags |= RE.MATCH_MULTILINE;
See also
RE
public RE(REProgram program)Parameters
programREProgram- Compiled regular expression program
See also
RE
public RE()Method details
simplePatternToFullRegularExpression
public static String simplePatternToFullRegularExpression(String pattern)Parameters
patternString- The pattern to convert
Returns
getMatchFlags
public int getMatchFlags()Returns
Current match behaviour flags (RE.MATCH_*).
int matchFlags = RE.MATCH_NORMAL;
matchFlags |= RE.MATCH_CASEINDEPENDENT;
matchFlags |= RE.MATCH_MULTILINE;
See also
setMatchFlags
public void setMatchFlags(int matchFlags)Parameters
matchFlagsintOne or more of the RE match behaviour flags (RE.MATCH_*):
int matchFlags = RE.MATCH_NORMAL; matchFlags |= RE.MATCH_CASEINDEPENDENT; matchFlags |= RE.MATCH_MULTILINE;
getProgram
public REProgram getProgram()Returns
See also
setProgram
public void setProgram(REProgram program)Parameters
programREProgram- Regular expression program compiled by RECompiler.
See also
getParenCount
public int getParenCount()Returns
getParen
public String getParen(int which)Parameters
whichint- Nesting level of subexpression
Returns
getParenStart
public final int getParenStart(int which)Parameters
whichint- Nesting level of subexpression
Returns
getParenEnd
public final int getParenEnd(int which)Parameters
whichint- Nesting level of subexpression
Returns
getParenLength
public final int getParenLength(int which)Parameters
whichint- Nesting level of subexpression
Returns
setParenStart
protected final void setParenStart(int which, int i)Parameters
whichint- Which paren level
iint- Index in input array
setParenEnd
protected final void setParenEnd(int which, int i)Parameters
whichint- Which paren level
iint- Index in input array
internalError
protected void internalError(String s)
throws ErrorParameters
sString- Error description
Throws
matchNodes
protected int matchNodes(int firstNode, int lastNode, int idxStart)Parameters
firstNodeint- Node to start at in program
lastNodeint- Last valid node (used for matching a subexpression without matching the rest of the program as well).
idxStartint- Starting position in character array
Returns
matchAt
protected boolean matchAt(int i)Parameters
iint- The input string index to start matching at
Returns
match
public boolean match(String search, int i)Parameters
searchString- String to match against
iint- Index to start searching at
Returns
match
public boolean match(CharacterIterator search, int i)Parameters
searchCharacterIterator- String to match against
iint- Index to start searching at
Returns
match
public boolean match(String search)Parameters
searchString- String to match against
Returns
split
public String[] split(String s)Splits a string into an array of strings on regular expression boundaries.
This function works the same way as the Perl function of the same name.
Given a regular expression of "[ab]+" and a string to split of
"xyzzyababbayyzabbbab123", the result would be the array of Strings
"[xyzzy, yyz, 123]".
Please note that the first string in the resulting array may be an empty string. This happens when the very first character of input string is matched by the pattern.
Parameters
sString- String to split on this regular exression
Returns
subst
public String subst(String substituteIn, String substitution)Parameters
substituteInString- String to substitute within
substitutionString- String to substitute for all matches of this regular expression.
Returns
subst
public String subst(String substituteIn, String substitution, int flags)Substitutes a string for this regular expression in another string. This method works like the Perl function of the same name. Given a regular expression of “a*b”, a String to substituteIn of “aaaabfooaaabgarplyaaabwackyb” and the substitution String “-”, the resulting String returned by subst would be “-foo-garply-wacky-”.
It is also possible to reference the contents of a parenthesized expression with $0, $1, … $9. A regular expression of “http://[\.\w\-\?/~_@&=%]+”, a String to substituteIn of “visit us: http://www.apache.org!” and the substitution String “<a href="$0">$0</a>”, the resulting String returned by subst would be “visit us: <a href="http://www.apache.org">http://www.apache.org</a>!”.
Note: $0 represents the whole match.
Parameters
substituteInString- String to substitute within
substitutionString- String to substitute for matches of this regular expression
flagsint- One or more bitwise flags from REPLACE_*. If the REPLACE_FIRSTONLY flag bit is set, only the first occurrence of this regular expression is replaced. If the bit is not set (REPLACE_ALL), all occurrences of this pattern will be replaced. If the flag REPLACE_BACKREFERENCES is set, all backreferences will be processed.
Returns
grep
public String[] grep(Object[] search)Parameters
searchObject[]- Array of Objects to search