/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package java.util.regex;

import java.text.Normalizer;

import java.util.Locale;

import java.util.Map;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Arrays;

/**

 * A compiled representation of a regular expression.

 *

 * <p> A regular expression, specified as a string, must first be compiled into

 * an instance of this class.  The resulting pattern can then be used to create

 * a {@link Matcher} object that can match arbitrary {@link

 * java.lang.CharSequence </code>character sequences<code>} against the regular

 * expression.  All of the state involved in performing a match resides in the

 * matcher, so many matchers can share the same pattern.

 *

 * <p> A typical invocation sequence is thus

 *

 * <blockquote><pre>

 * Pattern p = Pattern.{@link #compile compile}("a*b");

 * Matcher m = p.{@link #matcher matcher}("aaaaab");

 * boolean b = m.{@link Matcher#matches matches}();</pre></blockquote>

 *

 * <p> A {@link #matches matches} method is defined by this class as a

 * convenience for when a regular expression is used just once.  This method

 * compiles an expression and matches an input sequence against it in a single

 * invocation.  The statement

 *

 * <blockquote><pre>

 * boolean b = Pattern.matches("a*b", "aaaaab");</pre></blockquote>

 *

 * is equivalent to the three statements above, though for repeated matches it

 * is less efficient since it does not allow the compiled pattern to be reused.

 *

 * <p> Instances of this class are immutable and are safe for use by multiple

 * concurrent threads.  Instances of the {@link Matcher} class are not safe for

 * such use.

 *

 *

 * <a name="sum">

 * <h4> Summary of regular-expression constructs </h4>

 *

 * <table border="0" cellpadding="1" cellspacing="0"

 *  summary="Regular expression constructs, and what they match">

 *

 * <tr align="left">

 * <th bgcolor="#CCCCFF" align="left" id="construct">Construct</th>

 * <th bgcolor="#CCCCFF" align="left" id="matches">Matches</th>

 * </tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="characters">Characters</th></tr>

 *

 * <tr><td valign="top" headers="construct characters"><i>x</i></td>

 *     <td headers="matches">The character <i>x</i></td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\\</tt></td>

 *     <td headers="matches">The backslash character</td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\0</tt><i>n</i></td>

 *     <td headers="matches">The character with octal value <tt>0</tt><i>n</i>

 *         (0&nbsp;<tt>&lt;=</tt>&nbsp;<i>n</i>&nbsp;<tt>&lt;=</tt>&nbsp;7)</td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\0</tt><i>nn</i></td>

 *     <td headers="matches">The character with octal value <tt>0</tt><i>nn</i>

 *         (0&nbsp;<tt>&lt;=</tt>&nbsp;<i>n</i>&nbsp;<tt>&lt;=</tt>&nbsp;7)</td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\0</tt><i>mnn</i></td>

 *     <td headers="matches">The character with octal value <tt>0</tt><i>mnn</i>

 *         (0&nbsp;<tt>&lt;=</tt>&nbsp;<i>m</i>&nbsp;<tt>&lt;=</tt>&nbsp;3,

 *         0&nbsp;<tt>&lt;=</tt>&nbsp;<i>n</i>&nbsp;<tt>&lt;=</tt>&nbsp;7)</td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\x</tt><i>hh</i></td>

 *     <td headers="matches">The character with hexadecimal&nbsp;value&nbsp;<tt>0x</tt><i>hh</i></td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>&#92;u</tt><i>hhhh</i></td>

 *     <td headers="matches">The character with hexadecimal&nbsp;value&nbsp;<tt>0x</tt><i>hhhh</i></td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>&#92;x</tt><i>{h...h}</i></td>

 *     <td headers="matches">The character with hexadecimal&nbsp;value&nbsp;<tt>0x</tt><i>h...h</i>

 *         ({@link java.lang.Character#MIN_CODE_POINT Character.MIN_CODE_POINT}

 *         &nbsp;&lt;=&nbsp;<tt>0x</tt><i>h...h</i>&nbsp;&lt;=&nbsp

 *          {@link java.lang.Character#MAX_CODE_POINT Character.MAX_CODE_POINT})</td></tr>

 * <tr><td valign="top" headers="matches"><tt>\t</tt></td>

 *     <td headers="matches">The tab character (<tt>'&#92;u0009'</tt>)</td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\n</tt></td>

 *     <td headers="matches">The newline (line feed) character (<tt>'&#92;u000A'</tt>)</td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\r</tt></td>

 *     <td headers="matches">The carriage-return character (<tt>'&#92;u000D'</tt>)</td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\f</tt></td>

 *     <td headers="matches">The form-feed character (<tt>'&#92;u000C'</tt>)</td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\a</tt></td>

 *     <td headers="matches">The alert (bell) character (<tt>'&#92;u0007'</tt>)</td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\e</tt></td>

 *     <td headers="matches">The escape character (<tt>'&#92;u001B'</tt>)</td></tr>

 * <tr><td valign="top" headers="construct characters"><tt>\c</tt><i>x</i></td>

 *     <td headers="matches">The control character corresponding to <i>x</i></td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="classes">Character classes</th></tr>

 *

 * <tr><td valign="top" headers="construct classes"><tt>[abc]</tt></td>

 *     <td headers="matches"><tt>a</tt>, <tt>b</tt>, or <tt>c</tt> (simple class)</td></tr>

 * <tr><td valign="top" headers="construct classes"><tt>[^abc]</tt></td>

 *     <td headers="matches">Any character except <tt>a</tt>, <tt>b</tt>, or <tt>c</tt> (negation)</td></tr>

 * <tr><td valign="top" headers="construct classes"><tt>[a-zA-Z]</tt></td>

 *     <td headers="matches"><tt>a</tt> through <tt>z</tt>

 *         or <tt>A</tt> through <tt>Z</tt>, inclusive (range)</td></tr>

 * <tr><td valign="top" headers="construct classes"><tt>[a-d[m-p]]</tt></td>

 *     <td headers="matches"><tt>a</tt> through <tt>d</tt>,

 *      or <tt>m</tt> through <tt>p</tt>: <tt>[a-dm-p]</tt> (union)</td></tr>

 * <tr><td valign="top" headers="construct classes"><tt>[a-z&&[def]]</tt></td>

 *     <td headers="matches"><tt>d</tt>, <tt>e</tt>, or <tt>f</tt> (intersection)</tr>

 * <tr><td valign="top" headers="construct classes"><tt>[a-z&&[^bc]]</tt></td>

 *     <td headers="matches"><tt>a</tt> through <tt>z</tt>,

 *         except for <tt>b</tt> and <tt>c</tt>: <tt>[ad-z]</tt> (subtraction)</td></tr>

 * <tr><td valign="top" headers="construct classes"><tt>[a-z&&[^m-p]]</tt></td>

 *     <td headers="matches"><tt>a</tt> through <tt>z</tt>,

 *          and not <tt>m</tt> through <tt>p</tt>: <tt>[a-lq-z]</tt>(subtraction)</td></tr>

 * <tr><th>&nbsp;</th></tr>

 *

 * <tr align="left"><th colspan="2" id="predef">Predefined character classes</th></tr>

 *

 * <tr><td valign="top" headers="construct predef"><tt>.</tt></td>

 *     <td headers="matches">Any character (may or may not match <a href="#lt">line terminators</a>)</td></tr>

 * <tr><td valign="top" headers="construct predef"><tt>\d</tt></td>

 *     <td headers="matches">A digit: <tt>[0-9]</tt></td></tr>

 * <tr><td valign="top" headers="construct predef"><tt>\D</tt></td>

 *     <td headers="matches">A non-digit: <tt>[^0-9]</tt></td></tr>

 * <tr><td valign="top" headers="construct predef"><tt>\h</tt></td>

 *     <td headers="matches">A horizontal whitespace character:

 *     <tt>[ \t\xA0&#92;u1680&#92;u180e&#92;u2000-&#92;u200a&#92;u202f&#92;u205f&#92;u3000]</tt></td></tr>

 * <tr><td valign="top" headers="construct predef"><tt>\H</tt></td>

 *     <td headers="matches">A non-horizontal whitespace character: <tt>[^\h]</tt></td></tr>

 * <tr><td valign="top" headers="construct predef"><tt>\s</tt></td>

 *     <td headers="matches">A whitespace character: <tt>[ \t\n\x0B\f\r]</tt></td></tr>

 * <tr><td valign="top" headers="construct predef"><tt>\S</tt></td>

 *     <td headers="matches">A non-whitespace character: <tt>[^\s]</tt></td></tr>

 * <tr><td valign="top" headers="construct predef"><tt>\v</tt></td>

 *     <td headers="matches">A vertical whitespace character: <tt>[\n\x0B\f\r\x85&#92;u2028&#92;u2029]</tt>

 *     </td></tr>

 * <tr><td valign="top" headers="construct predef"><tt>\V</tt></td>

 *     <td headers="matches">A non-vertical whitespace character: <tt>[^\v]</tt></td></tr>

 * <tr><td valign="top" headers="construct predef"><tt>\w</tt></td>

 *     <td headers="matches">A word character: <tt>[a-zA-Z_0-9]</tt></td></tr>

 * <tr><td valign="top" headers="construct predef"><tt>\W</tt></td>

 *     <td headers="matches">A non-word character: <tt>[^\w]</tt></td></tr>

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="posix">POSIX character classes</b> (US-ASCII only)<b></th></tr>

 *

 * <tr><td valign="top" headers="construct posix"><tt>\p{Lower}</tt></td>

 *     <td headers="matches">A lower-case alphabetic character: <tt>[a-z]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{Upper}</tt></td>

 *     <td headers="matches">An upper-case alphabetic character:<tt>[A-Z]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{ASCII}</tt></td>

 *     <td headers="matches">All ASCII:<tt>[\x00-\x7F]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{Alpha}</tt></td>

 *     <td headers="matches">An alphabetic character:<tt>[\p{Lower}\p{Upper}]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{Digit}</tt></td>

 *     <td headers="matches">A decimal digit: <tt>[0-9]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{Alnum}</tt></td>

 *     <td headers="matches">An alphanumeric character:<tt>[\p{Alpha}\p{Digit}]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{Punct}</tt></td>

 *     <td headers="matches">Punctuation: One of <tt>!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~</tt></td></tr>

 *     <!-- <tt>[\!"#\$%&'\(\)\*\+,\-\./:;\<=\>\?@\[\\\]\^_`\{\|\}~]</tt>

 *          <tt>[\X21-\X2F\X31-\X40\X5B-\X60\X7B-\X7E]</tt> -->

 * <tr><td valign="top" headers="construct posix"><tt>\p{Graph}</tt></td>

 *     <td headers="matches">A visible character: <tt>[\p{Alnum}\p{Punct}]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{Print}</tt></td>

 *     <td headers="matches">A printable character: <tt>[\p{Graph}\x20]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{Blank}</tt></td>

 *     <td headers="matches">A space or a tab: <tt>[ \t]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{Cntrl}</tt></td>

 *     <td headers="matches">A control character: <tt>[\x00-\x1F\x7F]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{XDigit}</tt></td>

 *     <td headers="matches">A hexadecimal digit: <tt>[0-9a-fA-F]</tt></td></tr>

 * <tr><td valign="top" headers="construct posix"><tt>\p{Space}</tt></td>

 *     <td headers="matches">A whitespace character: <tt>[ \t\n\x0B\f\r]</tt></td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2">java.lang.Character classes (simple <a href="#jcc">java character type</a>)</th></tr>

 *

 * <tr><td valign="top"><tt>\p{javaLowerCase}</tt></td>

 *     <td>Equivalent to java.lang.Character.isLowerCase()</td></tr>

 * <tr><td valign="top"><tt>\p{javaUpperCase}</tt></td>

 *     <td>Equivalent to java.lang.Character.isUpperCase()</td></tr>

 * <tr><td valign="top"><tt>\p{javaWhitespace}</tt></td>

 *     <td>Equivalent to java.lang.Character.isWhitespace()</td></tr>

 * <tr><td valign="top"><tt>\p{javaMirrored}</tt></td>

 *     <td>Equivalent to java.lang.Character.isMirrored()</td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="unicode">Classes for Unicode scripts, blocks, categories and binary properties</th></tr>

 * * <tr><td valign="top" headers="construct unicode"><tt>\p{IsLatin}</tt></td>

 *     <td headers="matches">A Latin&nbsp;script character (<a href="#usc">script</a>)</td></tr>

 * <tr><td valign="top" headers="construct unicode"><tt>\p{InGreek}</tt></td>

 *     <td headers="matches">A character in the Greek&nbsp;block (<a href="#ubc">block</a>)</td></tr>

 * <tr><td valign="top" headers="construct unicode"><tt>\p{Lu}</tt></td>

 *     <td headers="matches">An uppercase letter (<a href="#ucc">category</a>)</td></tr>

 * <tr><td valign="top" headers="construct unicode"><tt>\p{IsAlphabetic}</tt></td>

 *     <td headers="matches">An alphabetic character (<a href="#ubpc">binary property</a>)</td></tr>

 * <tr><td valign="top" headers="construct unicode"><tt>\p{Sc}</tt></td>

 *     <td headers="matches">A currency symbol</td></tr>

 * <tr><td valign="top" headers="construct unicode"><tt>\P{InGreek}</tt></td>

 *     <td headers="matches">Any character except one in the Greek block (negation)</td></tr>

 * <tr><td valign="top" headers="construct unicode"><tt>[\p{L}&&[^\p{Lu}]]&nbsp;</tt></td>

 *     <td headers="matches">Any letter except an uppercase letter (subtraction)</td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="bounds">Boundary matchers</th></tr>

 *

 * <tr><td valign="top" headers="construct bounds"><tt>^</tt></td>

 *     <td headers="matches">The beginning of a line</td></tr>

 * <tr><td valign="top" headers="construct bounds"><tt>$</tt></td>

 *     <td headers="matches">The end of a line</td></tr>

 * <tr><td valign="top" headers="construct bounds"><tt>\b</tt></td>

 *     <td headers="matches">A word boundary</td></tr>

 * <tr><td valign="top" headers="construct bounds"><tt>\B</tt></td>

 *     <td headers="matches">A non-word boundary</td></tr>

 * <tr><td valign="top" headers="construct bounds"><tt>\A</tt></td>

 *     <td headers="matches">The beginning of the input</td></tr>

 * <tr><td valign="top" headers="construct bounds"><tt>\G</tt></td>

 *     <td headers="matches">The end of the previous match</td></tr>

 * <tr><td valign="top" headers="construct bounds"><tt>\Z</tt></td>

 *     <td headers="matches">The end of the input but for the final

 *         <a href="#lt">terminator</a>, if&nbsp;any</td></tr>

 * <tr><td valign="top" headers="construct bounds"><tt>\z</tt></td>

 *     <td headers="matches">The end of the input</td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="lineending">Linebreak matcher</th></tr>

 * <tr><td valign="top" headers="construct lineending"><tt>\R</tt></td>

 *     <td headers="matches">Any Unicode linebreak sequence, is equivalent to

 *     <tt>&#92;u000D&#92;u000A|[&#92;u000A&#92;u000B&#92;u000C&#92;u000D&#92;u0085&#92;u2028&#92;u2029]

 *     </tt></td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="greedy">Greedy quantifiers</th></tr>

 *

 * <tr><td valign="top" headers="construct greedy"><i>X</i><tt>?</tt></td>

 *     <td headers="matches"><i>X</i>, once or not at all</td></tr>

 * <tr><td valign="top" headers="construct greedy"><i>X</i><tt>*</tt></td>

 *     <td headers="matches"><i>X</i>, zero or more times</td></tr>

 * <tr><td valign="top" headers="construct greedy"><i>X</i><tt>+</tt></td>

 *     <td headers="matches"><i>X</i>, one or more times</td></tr>

 * <tr><td valign="top" headers="construct greedy"><i>X</i><tt>{</tt><i>n</i><tt>}</tt></td>

 *     <td headers="matches"><i>X</i>, exactly <i>n</i> times</td></tr>

 * <tr><td valign="top" headers="construct greedy"><i>X</i><tt>{</tt><i>n</i><tt>,}</tt></td>

 *     <td headers="matches"><i>X</i>, at least <i>n</i> times</td></tr>

 * <tr><td valign="top" headers="construct greedy"><i>X</i><tt>{</tt><i>n</i><tt>,</tt><i>m</i><tt>}</tt></td>

 *     <td headers="matches"><i>X</i>, at least <i>n</i> but not more than <i>m</i> times</td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="reluc">Reluctant quantifiers</th></tr>

 *

 * <tr><td valign="top" headers="construct reluc"><i>X</i><tt>??</tt></td>

 *     <td headers="matches"><i>X</i>, once or not at all</td></tr>

 * <tr><td valign="top" headers="construct reluc"><i>X</i><tt>*?</tt></td>

 *     <td headers="matches"><i>X</i>, zero or more times</td></tr>

 * <tr><td valign="top" headers="construct reluc"><i>X</i><tt>+?</tt></td>

 *     <td headers="matches"><i>X</i>, one or more times</td></tr>

 * <tr><td valign="top" headers="construct reluc"><i>X</i><tt>{</tt><i>n</i><tt>}?</tt></td>

 *     <td headers="matches"><i>X</i>, exactly <i>n</i> times</td></tr>

 * <tr><td valign="top" headers="construct reluc"><i>X</i><tt>{</tt><i>n</i><tt>,}?</tt></td>

 *     <td headers="matches"><i>X</i>, at least <i>n</i> times</td></tr>

 * <tr><td valign="top" headers="construct reluc"><i>X</i><tt>{</tt><i>n</i><tt>,</tt><i>m</i><tt>}?</tt></td>

 *     <td headers="matches"><i>X</i>, at least <i>n</i> but not more than <i>m</i> times</td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="poss">Possessive quantifiers</th></tr>

 *

 * <tr><td valign="top" headers="construct poss"><i>X</i><tt>?+</tt></td>

 *     <td headers="matches"><i>X</i>, once or not at all</td></tr>

 * <tr><td valign="top" headers="construct poss"><i>X</i><tt>*+</tt></td>

 *     <td headers="matches"><i>X</i>, zero or more times</td></tr>

 * <tr><td valign="top" headers="construct poss"><i>X</i><tt>++</tt></td>

 *     <td headers="matches"><i>X</i>, one or more times</td></tr>

 * <tr><td valign="top" headers="construct poss"><i>X</i><tt>{</tt><i>n</i><tt>}+</tt></td>

 *     <td headers="matches"><i>X</i>, exactly <i>n</i> times</td></tr>

 * <tr><td valign="top" headers="construct poss"><i>X</i><tt>{</tt><i>n</i><tt>,}+</tt></td>

 *     <td headers="matches"><i>X</i>, at least <i>n</i> times</td></tr>

 * <tr><td valign="top" headers="construct poss"><i>X</i><tt>{</tt><i>n</i><tt>,</tt><i>m</i><tt>}+</tt></td>

 *     <td headers="matches"><i>X</i>, at least <i>n</i> but not more than <i>m</i> times</td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="logical">Logical operators</th></tr>

 *

 * <tr><td valign="top" headers="construct logical"><i>XY</i></td>

 *     <td headers="matches"><i>X</i> followed by <i>Y</i></td></tr>

 * <tr><td valign="top" headers="construct logical"><i>X</i><tt>|</tt><i>Y</i></td>

 *     <td headers="matches">Either <i>X</i> or <i>Y</i></td></tr>

 * <tr><td valign="top" headers="construct logical"><tt>(</tt><i>X</i><tt>)</tt></td>

 *     <td headers="matches">X, as a <a href="#cg">capturing group</a></td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="backref">Back references</th></tr>

 *

 * <tr><td valign="bottom" headers="construct backref"><tt>\</tt><i>n</i></td>

 *     <td valign="bottom" headers="matches">Whatever the <i>n</i><sup>th</sup>

 *     <a href="#cg">capturing group</a> matched</td></tr>

 *

 * <tr><td valign="bottom" headers="construct backref"><tt>\</tt><i>k</i>&lt;<i>name</i>&gt;</td>

 *     <td valign="bottom" headers="matches">Whatever the

 *     <a href="#groupname">named-capturing group</a> "name" matched</td></tr>

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="quot">Quotation</th></tr>

 *

 * <tr><td valign="top" headers="construct quot"><tt>\</tt></td>

 *     <td headers="matches">Nothing, but quotes the following character</td></tr>

 * <tr><td valign="top" headers="construct quot"><tt>\Q</tt></td>

 *     <td headers="matches">Nothing, but quotes all characters until <tt>\E</tt></td></tr>

 * <tr><td valign="top" headers="construct quot"><tt>\E</tt></td>

 *     <td headers="matches">Nothing, but ends quoting started by <tt>\Q</tt></td></tr>

 *     <!-- Metachars: !$()*+.<>?[\]^{|} -->

 *

 * <tr><th>&nbsp;</th></tr>

 * <tr align="left"><th colspan="2" id="special">Special constructs (named-capturing and non-capturing)</th></tr>

 *

 * <tr><td valign="top" headers="construct special"><tt>(?&lt;<a href="#groupname">name</a>&gt;</tt><i>X</i><tt>)</tt></td>

 *     <td headers="matches"><i>X</i>, as a named-capturing group</td></tr>

 * <tr><td valign="top" headers="construct special"><tt>(?:</tt><i>X</i><tt>)</tt></td>

 *     <td headers="matches"><i>X</i>, as a non-capturing group</td></tr>

 * <tr><td valign="top" headers="construct special"><tt>(?idmsuxU-idmsuxU)&nbsp;</tt></td>

 *     <td headers="matches">Nothing, but turns match flags <a href="#CASE_INSENSITIVE">i</a>

 * <a href="#UNIX_LINES">d</a> <a href="#MULTILINE">m</a> <a href="#DOTALL">s</a>

 * <a href="#UNICODE_CASE">u</a> <a href="#COMMENTS">x</a> <a href="#UNICODE_CHARACTER_CLASS">U</a>

 * on - off</td></tr>

 * <tr><td valign="top" headers="construct special"><tt>(?idmsux-idmsux:</tt><i>X</i><tt>)</tt>&nbsp;&nbsp;</td>

 *     <td headers="matches"><i>X</i>, as a <a href="#cg">non-capturing group</a> with the

 *         given flags <a href="#CASE_INSENSITIVE">i</a> <a href="#UNIX_LINES">d</a>

 * <a href="#MULTILINE">m</a> <a href="#DOTALL">s</a> <a href="#UNICODE_CASE">u</a >

 * <a href="#COMMENTS">x</a> on - off</td></tr>

 * <tr><td valign="top" headers="construct special"><tt>(?=</tt><i>X</i><tt>)</tt></td>

 *     <td headers="matches"><i>X</i>, via zero-width positive lookahead</td></tr>

 * <tr><td valign="top" headers="construct special"><tt>(?!</tt><i>X</i><tt>)</tt></td>

 *     <td headers="matches"><i>X</i>, via zero-width negative lookahead</td></tr>

 * <tr><td valign="top" headers="construct special"><tt>(?&lt;=</tt><i>X</i><tt>)</tt></td>

 *     <td headers="matches"><i>X</i>, via zero-width positive lookbehind</td></tr>

 * <tr><td valign="top" headers="construct special"><tt>(?&lt;!</tt><i>X</i><tt>)</tt></td>

 *     <td headers="matches"><i>X</i>, via zero-width negative lookbehind</td></tr>

 * <tr><td valign="top" headers="construct special"><tt>(?&gt;</tt><i>X</i><tt>)</tt></td>

 *     <td headers="matches"><i>X</i>, as an independent, non-capturing group</td></tr>

 *

 * </table>

 *

 * <hr>

 *

 *

 * <a name="bs">

 * <h4> Backslashes, escapes, and quoting </h4>

 *

 * <p> The backslash character (<tt>'\'</tt>) serves to introduce escaped

 * constructs, as defined in the table above, as well as to quote characters

 * that otherwise would be interpreted as unescaped constructs.  Thus the

 * expression <tt>\\</tt> matches a single backslash and <tt>\{</tt> matches a

 * left brace.

 *

 * <p> It is an error to use a backslash prior to any alphabetic character that

 * does not denote an escaped construct; these are reserved for future

 * extensions to the regular-expression language.  A backslash may be used

 * prior to a non-alphabetic character regardless of whether that character is

 * part of an unescaped construct.

 *

 * <p> Backslashes within string literals in Java source code are interpreted

 * as required by

 * <cite>The Java&trade; Language Specification</cite>

 * as either Unicode escapes (section 3.3) or other character escapes (section 3.10.6)

 * It is therefore necessary to double backslashes in string

 * literals that represent regular expressions to protect them from

 * interpretation by the Java bytecode compiler.  The string literal

 * <tt>"&#92;b"</tt>, for example, matches a single backspace character when

 * interpreted as a regular expression, while <tt>"&#92;&#92;b"</tt> matches a

 * word boundary.  The string literal <tt>"&#92;(hello&#92;)"</tt> is illegal

 * and leads to a compile-time error; in order to match the string

 * <tt>(hello)</tt> the string literal <tt>"&#92;&#92;(hello&#92;&#92;)"</tt>

 * must be used.

 *

 * <a name="cc">

 * <h4> Character Classes </h4>

 *

 *    <p> Character classes may appear within other character classes, and

 *    may be composed by the union operator (implicit) and the intersection

 *    operator (<tt>&amp;&amp;</tt>).

 *    The union operator denotes a class that contains every character that is

 *    in at least one of its operand classes.  The intersection operator

 *    denotes a class that contains every character that is in both of its

 *    operand classes.

 *

 *    <p> The precedence of character-class operators is as follows, from

 *    highest to lowest:

 *

 *    <blockquote><table border="0" cellpadding="1" cellspacing="0"

 *                 summary="Precedence of character class operators.">

 *      <tr><th>1&nbsp;&nbsp;&nbsp;&nbsp;</th>

 *        <td>Literal escape&nbsp;&nbsp;&nbsp;&nbsp;</td>

 *        <td><tt>\x</tt></td></tr>

 *     <tr><th>2&nbsp;&nbsp;&nbsp;&nbsp;</th>

 *        <td>Grouping</td>

 *        <td><tt>[...]</tt></td></tr>

 *     <tr><th>3&nbsp;&nbsp;&nbsp;&nbsp;</th>

 *        <td>Range</td>

 *        <td><tt>a-z</tt></td></tr>

 *      <tr><th>4&nbsp;&nbsp;&nbsp;&nbsp;</th>

 *        <td>Union</td>

 *        <td><tt>[a-e][i-u]</tt></td></tr>

 *      <tr><th>5&nbsp;&nbsp;&nbsp;&nbsp;</th>

 *        <td>Intersection</td>

 *        <td><tt>[a-z&&[aeiou]]</tt></td></tr>

 *    </table></blockquote>

 *

 *    <p> Note that a different set of metacharacters are in effect inside

 *    a character class than outside a character class. For instance, the

 *    regular expression <tt>.</tt> loses its special meaning inside a

 *    character class, while the expression <tt>-</tt> becomes a range

 *    forming metacharacter.

 *

 * <a name="lt">

 * <h4> Line terminators </h4>

 *

 * <p> A <i>line terminator</i> 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:

 *

 * <ul>

 *

 *   <li> A newline (line feed) character&nbsp;(<tt>'\n'</tt>),

 *

 *   <li> A carriage-return character followed immediately by a newline

 *   character&nbsp;(<tt>"\r\n"</tt>),

 *

 *   <li> A standalone carriage-return character&nbsp;(<tt>'\r'</tt>),

 *

 *   <li> A next-line character&nbsp;(<tt>'&#92;u0085'</tt>),

 *

 *   <li> A line-separator character&nbsp;(<tt>'&#92;u2028'</tt>), or

 *

 *   <li> A paragraph-separator character&nbsp;(<tt>'&#92;u2029</tt>).

 *

 * </ul>

 * <p>If {@link #UNIX_LINES} mode is activated, then the only line terminators

 * recognized are newline characters.

 *

 * <p> The regular expression <tt>.</tt> matches any character except a line

 * terminator unless the {@link #DOTALL} flag is specified.

 *

 * <p> By default, the regular expressions <tt>^</tt> and <tt>$</tt> ignore

 * line terminators and only match at the beginning and the end, respectively,

 * of the entire input sequence. If {@link #MULTILINE} mode is activated then

 * <tt>^</tt> matches at the beginning of input and after any line terminator

 * except at the end of input. When in {@link #MULTILINE} mode <tt>$</tt>

 * matches just before a line terminator or the end of the input sequence.

 *

 * <a name="cg">

 * <h4> Groups and capturing </h4>

 *

 * <a name="gnumber">

 * <h5> Group number </h5>

 * <p> Capturing groups are numbered by counting their opening parentheses from

 * left to right.  In the expression <tt>((A)(B(C)))</tt>, for example, there

 * are four such groups: </p>

 *

 * <blockquote><table cellpadding=1 cellspacing=0 summary="Capturing group numberings">

 * <tr><th>1&nbsp;&nbsp;&nbsp;&nbsp;</th>

 *     <td><tt>((A)(B(C)))</tt></td></tr>

 * <tr><th>2&nbsp;&nbsp;&nbsp;&nbsp;</th>

 *     <td><tt>(A)</tt></td></tr>

 * <tr><th>3&nbsp;&nbsp;&nbsp;&nbsp;</th>

 *     <td><tt>(B(C))</tt></td></tr>

 * <tr><th>4&nbsp;&nbsp;&nbsp;&nbsp;</th>

 *     <td><tt>(C)</tt></td></tr>

 * </table></blockquote>

 *

 * <p> Group zero always stands for the entire expression.

 *

 * <p> Capturing groups are so named because, during a match, each subsequence

 * of the input sequence that matches such a group is saved.  The captured

 * subsequence may be used later in the expression, via a back reference, and

 * may also be retrieved from the matcher once the match operation is complete.

 *

 * <a name="groupname">

 * <h5> Group name </h5>

 * <p>A capturing group can also be assigned a "name", a <tt>named-capturing group</tt>,

 * and then be back-referenced later by the "name". Group names are composed of

 * the following characters. The first character must be a <tt>letter</tt>.

 *

 * <ul>

 *   <li> The uppercase letters <tt>'A'</tt> through <tt>'Z'</tt>

 *        (<tt>'&#92;u0041'</tt>&nbsp;through&nbsp;<tt>'&#92;u005a'</tt>),

 *   <li> The lowercase letters <tt>'a'</tt> through <tt>'z'</tt>

 *        (<tt>'&#92;u0061'</tt>&nbsp;through&nbsp;<tt>'&#92;u007a'</tt>),