elharo commented on code in PR #41:
URL: https://github.com/apache/xerces-j/pull/41#discussion_r2465284521
##########
src/org/apache/xerces/impl/xpath/regex/ParserForXMLSchema.java:
##########
@@ -162,9 +163,11 @@ int processCIinCharacterClass(RangeToken tok, int c) {
* single-range ::= multi-c-escape | category-c-escape |
block-c-escape | <any XML char>
* cc-normal-c ::= <any character except [, ], \>
* from-to-range ::= cc-normal-c '-' cc-normal-c
+ * </pre>
*
- * @param useNrage Ignored.
- * @return This returns no NrageToken.
+ * @param useNrange ignored
+ * @return a {@link RangeToken}, returns no NRANGE token
+ * @throws ParseException if regex is not conforming to the syntax
Review Comment:
is not conforming --> does not conform
though reading it now, this is all confusing. What's regex? It's not an
argument. Where does that come from?
##########
src/org/apache/xerces/impl/xpath/regex/RegexParser.java:
##########
@@ -836,6 +847,11 @@ Token parseAtom() throws ParseException {
return tok;
}
+ /**
+ * @param c char data
+ * @return a {@link RangeToken}
+ * @throws ParseException if regex is not conforming to the syntax
Review Comment:
ditto
##########
src/org/apache/xerces/impl/xpath/regex/RegularExpression.java:
##########
@@ -261,188 +250,148 @@
* Arabic Presentation Forms-A, Combining Half Marks, CJK Compatibility
Forms,
* Small Form Variants, Arabic Presentation Forms-B, Specials,
* Halfwidth and Fullwidth Forms
- * </kbd>
- * <dt>Others:
- * <dd><kbd>ALL</kbd> (Equivalent to
<kbd>[\u005cu0000-\u005cv10FFFF]</kbd>)
- * <dd><kbd>ASSGINED</kbd> (<kbd>\p{ASSIGNED}</kbd> is equivalent to
<kbd>\P{Cn}</kbd>)
- * <dd><kbd>UNASSGINED</kbd>
- * (<kbd>\p{UNASSIGNED}</kbd> is equivalent to <kbd>\p{Cn}</kbd>)
+ * </dd>
+ * <dt>Others:</dt>
+ * <dd><code>ALL</code> (Equivalent to
<code>[\u0000-\v10FFFF]</code>)</dd>
+ * <dd><code>ASSGINED</code> (<code>\p{ASSIGNED}</code> is equivalent
to <code>\P{Cn}</code>)</dd>
Review Comment:
ASSIGNED
##########
src/org/apache/xerces/impl/xpath/regex/RegularExpression.java:
##########
@@ -27,223 +27,212 @@
* A regular expression matching engine using Non-deterministic Finite
Automaton (NFA).
* This engine does not conform to the POSIX regular expression.
*
- * <hr width="50%">
* <h3>How to use</h3>
*
* <dl>
* <dt>A. Standard way
* <dd>
* <pre>
- * RegularExpression re = new RegularExpression(<var>regex</var>);
+ * {@code
+ * RegularExpression re = new RegularExpression(regex);
* if (re.matches(text)) { ... }
+ * }
* </pre>
*
* <dt>B. Capturing groups
* <dd>
* <pre>
- * RegularExpression re = new RegularExpression(<var>regex</var>);
+ * {@code
+ * RegularExpression re = new RegularExpression(regex);
* Match match = new Match();
* if (re.matches(text, match)) {
* ... // You can refer captured texts with methods of the
<code>Match</code> class.
* }
+ * }
* </pre>
*
* </dl>
*
* <h4>Case-insensitive matching</h4>
* <pre>
+ * {@code
* RegularExpression re = new RegularExpression(<var>regex</var>, "i");
* if (re.matches(text) >= 0) { ...}
+ * }
* </pre>
*
* <h4>Options</h4>
- * <p>You can specify options to <a href="#RegularExpression(java.lang.String,
java.lang.String)"><code>RegularExpression(</code><var>regex</var><code>,
</code><var>options</var><code>)</code></a>
- * or <a href="#setPattern(java.lang.String,
java.lang.String)"><code>setPattern(</code><var>regex</var><code>,
</code><var>options</var><code>)</code></a>.
- * This <var>options</var> parameter consists of the following characters.
- * </p>
- * <dl>
- * <dt><a name="I_OPTION"><code>"i"</code></a>
- * <dd>This option indicates case-insensitive matching.
- * <dt><a name="M_OPTION"><code>"m"</code></a>
- * <dd class="REGEX"><kbd>^</kbd> and <kbd>$</kbd> consider the EOL
characters within the text.
- * <dt><a name="S_OPTION"><code>"s"</code></a>
- * <dd class="REGEX"><kbd>.</kbd> matches any one character.
- * <dt><a name="U_OPTION"><code>"u"</code></a>
- * <dd class="REGEX">Redefines <Kbd>\d \D \w \W \s \S \b \B \< \></kbd>
as becoming to Unicode.
- * <dt><a name="W_OPTION"><code>"w"</code></a>
- * <dd class="REGEX">By this option, <kbd>\b \B \< \></kbd> are processed
with the method of
- * 'Unicode Regular Expression Guidelines' Revision 4.
- * When "w" and "u" are specified at the same time,
- * <kbd>\b \B \< \></kbd> are processed for the "w" option.
- * <dt><a name="COMMA_OPTION"><code>","</code></a>
- * <dd>The parser treats a comma in a character class as a range separator.
- * <kbd class="REGEX">[a,b]</kbd> matches <kbd>a</kbd> or <kbd>,</kbd> or
<kbd>b</kbd> without this option.
- * <kbd class="REGEX">[a,b]</kbd> matches <kbd>a</kbd> or <kbd>b</kbd>
with this option.
- *
- * <dt><a name="X_OPTION"><code>"X"</code></a>
- * <dd class="REGEX">
- * By this option, the engine confoms to <a
href="http://www.w3.org/TR/2000/WD-xmlschema-2-20000407/#regexs";>XML Schema:
Regular Expression</a>.
- * The <code>match()</code> method does not do subsring matching
- * but entire string matching.
+ * <p>You can specify options to {@link #RegularExpression(String, String)} or
{@link #setPattern(String, String)}.</p>
+ * <p>This <code>options</code> parameter consists of the following
characters:</p>
+ * <ul>
+ * <li><code>i</code> : This option indicates case-insensitive matching.</li>
+ * <li><code>m</code> : <code>^</code> and <code>$</code> consider the EOL
characters within the text.</li>
+ * <li><code>s</code> : <code>.</code> matches any one character.</li>
+ * <li><code>u</code> : Redefines <code>\d \D \w \W \s \S \b \B \<
\></code> as being Unicode.</li>
+ * <li><code>w</code> : With this option, <code>\b \B \< \></code> are
processed with the method of 'Unicode Regular Expression Guidelines' Revision
4. When "w" and "u" are specified at the same time, <code>\b \B \< \></code>
are processed for the "w" option.</li>
+ * <li><code>,</code> : The parser treats a comma in a character class as a
range separator.
+ * <ul>
+ * <li><code>[a,b]</code> matches <code>a</code> or <code>,</code> or
<code>b</code> without this option.</li>
+ * <li><code>[a,b]</code> matches <code>a</code> or <code>b</code> with
this option.</li>
+ * </ul>
+ * </li>
+ * <li><code>X</code> : With this option, the engine conforms to <a
href="https://www.w3.org/TR/2000/WD-xmlschema-2-20000407/#regexs";>XML Schema:
Regular Expression</a>. The <code>match()</code> method does not do substring
matching but entire string matching.</li>
+ * </ul>
*
- * </dl>
- *
- * <hr width="50%">
* <h3>Syntax</h3>
- * <table border="1" bgcolor="#ddeeff">
- * <tr>
- * <td>
- * <h4>Differences from the Perl 5 regular expression</h4>
- * <ul>
- * <li>There is 6-digit hexadecimal character representation
(<kbd>\u005cv</kbd><var>HHHHHH</var>.)
- * <li>Supports subtraction, union, and intersection operations for
character classes.
- * <li>Not supported: <kbd>\</kbd><var>ooo</var> (Octal character
representations),
- * <Kbd>\G</kbd>, <kbd>\C</kbd>, <kbd>\l</kbd><var>c</var>,
- * <kbd>\u005c u</kbd><var>c</var>, <kbd>\L</kbd>, <kbd>\U</kbd>,
- * <kbd>\E</kbd>, <kbd>\Q</kbd>,
<kbd>\N{</kbd><var>name</var><kbd>}</kbd>,
- * <Kbd>(?{<kbd><var>code</var><kbd>})</kbd>,
<Kbd>(??{<kbd><var>code</var><kbd>})</kbd>
- * </ul>
- * </td>
- * </tr>
- * </table>
*
- * <p>Meta characters are `<KBD>. * + ? { [ ( ) | \ ^ $</KBD>'.</p>
+ * <h4>Differences from the Perl 5 regular expression</h4>
+ * <ul>
+ * <li>There is 6-digit hexadecimal character representation
(<code>\vHHHHHH</code>).
+ * <li>Supports subtraction, union, and intersection operations for character
classes.
+ * <li>Not supported:
+ * <ul>
+ * <li><code>\ooo</code> (Octal character representations)</li>
+ * <li><code>\G</code>, <code>\C</code>, <code>\lc</code></li>
+ * <li><code>\ uc</code>, <code>\L</code>, <code>\U</code></li>
+ * <li><code>\E</code>, <code>\Q</code>, <code>\N{name}</code></li>
+ * <li><code>(?{code})</code>, <code>(??{code})</code></li>
+ * </ul>
+ * </ul>
+ *
+ * <p>Meta characters are <code>. * + ? { [ ( ) | \ ^ $</code>.</p>
* <ul>
* <li>Character
* <dl>
- * <dt class="REGEX"><kbd>.</kbd> (A period)
+ * <dt><code>.</code> (A period)
* <dd>Matches any one character except the following characters.
- * <dd>LINE FEED (U+000A), CARRIAGE RETURN (U+000D),
- * PARAGRAPH SEPARATOR (U+2029), LINE SEPARATOR (U+2028)
+ * <dd>LINE FEED (U+000A), CARRIAGE RETURN (U+000D), PARAGRAPH SEPARATOR
(U+2029), LINE SEPARATOR (U+2028)
* <dd>This expression matches one code point in Unicode. It can match a
pair of surrogates.
* <dd>When <a href="#S_OPTION">the "s" option</a> is specified,
* it matches any character including the above four characters.
*
- * <dt class="REGEX"><Kbd>\e \f \n \r \t</kbd>
+ * <dt><code>\e \f \n \r \t</code>
* <dd>Matches ESCAPE (U+001B), FORM FEED (U+000C), LINE FEED (U+000A),
* CARRIAGE RETURN (U+000D), HORIZONTAL TABULATION (U+0009)
*
- * <dt class="REGEX"><kbd>\c</kbd><var>C</var>
+ * <dt><code>\cC</code>
* <dd>Matches a control character.
- * The <var>C</var> must be one of '<kbd>@</kbd>',
'<kbd>A</kbd>'-'<kbd>Z</kbd>',
- * '<kbd>[</kbd>', '<kbd>\u005c</kbd>', '<kbd>]</kbd>',
'<kbd>^</kbd>', '<kbd>_</kbd>'.
- * It matches a control character of which the character code is
less than
- * the character code of the <var>C</var> by 0x0040.
- * <dd class="REGEX">For example, a <kbd>\cJ</kbd> matches a LINE FEED
(U+000A),
- * and a <kbd>\c[</kbd> matches an ESCAPE (U+001B).
+ * The <var>C</var> must be one of '<code>@</code>',
'<code>A</code>'-'<code>Z</code>',
+ * '<code>[</code>', '<code>\</code>', '<code>]</code>',
'<code>^</code>', '<code>_</code>'.
+ * It matches a control character of which the character code is
less than the character code of
+ * the <var>C</var> by 0x0040.
+ * <dd>For example, a <code>\cJ</code> matches a LINE FEED (U+000A),
+ * and a <code>\c[</code> matches an ESCAPE (U+001B).
*
- * <dt class="REGEX">a non-meta character
+ * <dt>a non-meta character
* <dd>Matches the character.
*
- * <dt class="REGEX"><KBD>\</KBD> + a meta character
+ * <dt><code>\</code> + a meta character
* <dd>Matches the meta character.
*
- * <dt class="REGEX"><kbd>\u005cx</kbd><var>HH</var>
<kbd>\u005cx{</kbd><var>HHHH</var><kbd>}</kbd>
- * <dd>Matches a character of which code point is <var>HH</var>
(Hexadecimal) in Unicode.
- * You can write just 2 digits for <kbd>\u005cx</kbd><var>HH</var>,
and
- * variable length digits for
<kbd>\u005cx{</kbd><var>HHHH</var><kbd>}</kbd>.
+ * <dt><code>\xHH</code> <code>\x{HHHH}</code>
+ * <dd>Matches a character of which code point is <var>HH</var>
(Hexadecimal) in Unicode. You can write
+ * just 2 digits for <code>\xHH</code>, and variable length digits
for <code>\x{HHHH}</code>.
*
- * <!--
- * <dt class="REGEX"><kbd>\u005c u</kbd><var>HHHH</var>
- * <dd>Matches a character of which code point is <var>HHHH</var>
(Hexadecimal) in Unicode.
- * -->
- *
- * <dt class="REGEX"><kbd>\u005cv</kbd><var>HHHHHH</var>
+ * <dt><code>\vHHHHHH</code>
* <dd>Matches a character of which code point is <var>HHHHHH</var>
(Hexadecimal) in Unicode.
*
- * <dt class="REGEX"><kbd>\g</kbd>
+ * <dt><code>\g</code>
* <dd>Matches a grapheme.
- * <dd class="REGEX">It is equivalent to
<kbd>(?[\p{ASSIGNED}]-[\p{M}\p{C}])?(?:\p{M}|[\x{094D}\x{09CD}\x{0A4D}\x{0ACD}\x{0B3D}\x{0BCD}\x{0C4D}\x{0CCD}\x{0D4D}\x{0E3A}\x{0F84}]\p{L}|[\x{1160}-\x{11A7}]|[\x{11A8}-\x{11FF}]|[\x{FF9E}\x{FF9F}])*</kbd>
+ * <dd>It is equivalent to
<code>(?[\p{ASSIGNED}]-[\p{M}\p{C}])?(?:\p{M}|[\x{094D}\x{09CD}\x{0A4D}\x{0ACD}\x{0B3D}\x{0BCD}\x{0C4D}\x{0CCD}\x{0D4D}\x{0E3A}\x{0F84}]\p{L}|[\x{1160}-\x{11A7}]|[\x{11A8}-\x{11FF}]|[\x{FF9E}\x{FF9F}])*</code>
*
- * <dt class="REGEX"><kbd>\X</kbd>
- * <dd class="REGEX">Matches a combining character sequence.
- * It is equivalent to <kbd>(?:\PM\pM*)</kbd>
+ * <dt><code>\X</code>
+ * <dd>Matches a combining character sequence. It is equivalent to
<code>(?:\PM\pM*)</code>
* </dl>
* </li>
*
* <li>Character class
* <dl>
-+ * <dt
class="REGEX"><kbd>[</kbd><var>R<sub>1</sub></var><var>R<sub>2</sub></var><var>...</var><var>R<sub>n</sub></var><kbd>]</kbd>
(without <a href="#COMMA_OPTION">"," option</a>)
-+ * <dt
class="REGEX"><kbd>[</kbd><var>R<sub>1</sub></var><kbd>,</kbd><var>R<sub>2</sub></var><kbd>,</kbd><var>...</var><kbd>,</kbd><var>R<sub>n</sub></var><kbd>]</kbd>
(with <a href="#COMMA_OPTION">"," option</a>)
++ * <dt><code>[R1R2...Rn]</code> (without a {@link #SPECIAL_COMMA}
option)</dt>
++ * <dt><code>[R1,R2,...,Rn]</code> (with a {@link #SPECIAL_COMMA}
option)</dt>
Review Comment:
sub element should be OK
##########
src/org/apache/xerces/impl/xpath/regex/RegularExpression.java:
##########
@@ -27,223 +27,212 @@
* A regular expression matching engine using Non-deterministic Finite
Automaton (NFA).
* This engine does not conform to the POSIX regular expression.
*
- * <hr width="50%">
* <h3>How to use</h3>
*
* <dl>
* <dt>A. Standard way
* <dd>
* <pre>
- * RegularExpression re = new RegularExpression(<var>regex</var>);
+ * {@code
+ * RegularExpression re = new RegularExpression(regex);
* if (re.matches(text)) { ... }
+ * }
* </pre>
*
* <dt>B. Capturing groups
* <dd>
* <pre>
- * RegularExpression re = new RegularExpression(<var>regex</var>);
+ * {@code
+ * RegularExpression re = new RegularExpression(regex);
* Match match = new Match();
* if (re.matches(text, match)) {
* ... // You can refer captured texts with methods of the
<code>Match</code> class.
* }
+ * }
* </pre>
*
* </dl>
*
* <h4>Case-insensitive matching</h4>
* <pre>
+ * {@code
* RegularExpression re = new RegularExpression(<var>regex</var>, "i");
* if (re.matches(text) >= 0) { ...}
+ * }
* </pre>
*
* <h4>Options</h4>
- * <p>You can specify options to <a href="#RegularExpression(java.lang.String,
java.lang.String)"><code>RegularExpression(</code><var>regex</var><code>,
</code><var>options</var><code>)</code></a>
- * or <a href="#setPattern(java.lang.String,
java.lang.String)"><code>setPattern(</code><var>regex</var><code>,
</code><var>options</var><code>)</code></a>.
- * This <var>options</var> parameter consists of the following characters.
- * </p>
- * <dl>
- * <dt><a name="I_OPTION"><code>"i"</code></a>
- * <dd>This option indicates case-insensitive matching.
- * <dt><a name="M_OPTION"><code>"m"</code></a>
- * <dd class="REGEX"><kbd>^</kbd> and <kbd>$</kbd> consider the EOL
characters within the text.
- * <dt><a name="S_OPTION"><code>"s"</code></a>
- * <dd class="REGEX"><kbd>.</kbd> matches any one character.
- * <dt><a name="U_OPTION"><code>"u"</code></a>
- * <dd class="REGEX">Redefines <Kbd>\d \D \w \W \s \S \b \B \< \></kbd>
as becoming to Unicode.
- * <dt><a name="W_OPTION"><code>"w"</code></a>
- * <dd class="REGEX">By this option, <kbd>\b \B \< \></kbd> are processed
with the method of
- * 'Unicode Regular Expression Guidelines' Revision 4.
- * When "w" and "u" are specified at the same time,
- * <kbd>\b \B \< \></kbd> are processed for the "w" option.
- * <dt><a name="COMMA_OPTION"><code>","</code></a>
- * <dd>The parser treats a comma in a character class as a range separator.
- * <kbd class="REGEX">[a,b]</kbd> matches <kbd>a</kbd> or <kbd>,</kbd> or
<kbd>b</kbd> without this option.
- * <kbd class="REGEX">[a,b]</kbd> matches <kbd>a</kbd> or <kbd>b</kbd>
with this option.
- *
- * <dt><a name="X_OPTION"><code>"X"</code></a>
- * <dd class="REGEX">
- * By this option, the engine confoms to <a
href="http://www.w3.org/TR/2000/WD-xmlschema-2-20000407/#regexs";>XML Schema:
Regular Expression</a>.
- * The <code>match()</code> method does not do subsring matching
- * but entire string matching.
+ * <p>You can specify options to {@link #RegularExpression(String, String)} or
{@link #setPattern(String, String)}.</p>
+ * <p>This <code>options</code> parameter consists of the following
characters:</p>
+ * <ul>
+ * <li><code>i</code> : This option indicates case-insensitive matching.</li>
+ * <li><code>m</code> : <code>^</code> and <code>$</code> consider the EOL
characters within the text.</li>
+ * <li><code>s</code> : <code>.</code> matches any one character.</li>
+ * <li><code>u</code> : Redefines <code>\d \D \w \W \s \S \b \B \<
\></code> as being Unicode.</li>
+ * <li><code>w</code> : With this option, <code>\b \B \< \></code> are
processed with the method of 'Unicode Regular Expression Guidelines' Revision
4. When "w" and "u" are specified at the same time, <code>\b \B \< \></code>
are processed for the "w" option.</li>
+ * <li><code>,</code> : The parser treats a comma in a character class as a
range separator.
+ * <ul>
+ * <li><code>[a,b]</code> matches <code>a</code> or <code>,</code> or
<code>b</code> without this option.</li>
+ * <li><code>[a,b]</code> matches <code>a</code> or <code>b</code> with
this option.</li>
+ * </ul>
+ * </li>
+ * <li><code>X</code> : With this option, the engine conforms to <a
href="https://www.w3.org/TR/2000/WD-xmlschema-2-20000407/#regexs";>XML Schema:
Regular Expression</a>. The <code>match()</code> method does not do substring
matching but entire string matching.</li>
+ * </ul>
*
- * </dl>
- *
- * <hr width="50%">
* <h3>Syntax</h3>
- * <table border="1" bgcolor="#ddeeff">
- * <tr>
- * <td>
- * <h4>Differences from the Perl 5 regular expression</h4>
- * <ul>
- * <li>There is 6-digit hexadecimal character representation
(<kbd>\u005cv</kbd><var>HHHHHH</var>.)
- * <li>Supports subtraction, union, and intersection operations for
character classes.
- * <li>Not supported: <kbd>\</kbd><var>ooo</var> (Octal character
representations),
- * <Kbd>\G</kbd>, <kbd>\C</kbd>, <kbd>\l</kbd><var>c</var>,
- * <kbd>\u005c u</kbd><var>c</var>, <kbd>\L</kbd>, <kbd>\U</kbd>,
- * <kbd>\E</kbd>, <kbd>\Q</kbd>,
<kbd>\N{</kbd><var>name</var><kbd>}</kbd>,
- * <Kbd>(?{<kbd><var>code</var><kbd>})</kbd>,
<Kbd>(??{<kbd><var>code</var><kbd>})</kbd>
- * </ul>
- * </td>
- * </tr>
- * </table>
*
- * <p>Meta characters are `<KBD>. * + ? { [ ( ) | \ ^ $</KBD>'.</p>
+ * <h4>Differences from the Perl 5 regular expression</h4>
+ * <ul>
+ * <li>There is 6-digit hexadecimal character representation
(<code>\vHHHHHH</code>).
+ * <li>Supports subtraction, union, and intersection operations for character
classes.
+ * <li>Not supported:
+ * <ul>
+ * <li><code>\ooo</code> (Octal character representations)</li>
+ * <li><code>\G</code>, <code>\C</code>, <code>\lc</code></li>
+ * <li><code>\ uc</code>, <code>\L</code>, <code>\U</code></li>
+ * <li><code>\E</code>, <code>\Q</code>, <code>\N{name}</code></li>
+ * <li><code>(?{code})</code>, <code>(??{code})</code></li>
+ * </ul>
+ * </ul>
+ *
+ * <p>Meta characters are <code>. * + ? { [ ( ) | \ ^ $</code>.</p>
* <ul>
* <li>Character
* <dl>
- * <dt class="REGEX"><kbd>.</kbd> (A period)
+ * <dt><code>.</code> (A period)
Review Comment:
not sure why class="REGEX" is removed here. That seems OK.
##########
src/org/apache/xerces/impl/xpath/regex/REUtil.java:
##########
@@ -95,6 +95,13 @@ static final int getOptionValue(int ch) {
return ret;
}
+ /**
+ * Parses the regular expression options.
+ *
+ * @param opts a string of regular expression options consisted of "i" "m"
"s" "u" "w" "," "X" or null
Review Comment:
consisted --> consisting
or just drop these comments completely. The methods aren't public.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
