aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/ScintillaDoc.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ScintillaDoc.html')
-rw-r--r--doc/ScintillaDoc.html38
1 files changed, 22 insertions, 16 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index f1e6c3a75..5edf0caec 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -623,8 +623,9 @@ struct Sci_TextRange {
<p>
The base regular expression support
is limited and should only be used for simple cases and initial development.
- <span class="provisional">When using a C++11 compliant compiler and runtime, it may be possible to use the
- runtime's implementation of &lt;regex&gt; by compiling Scintilla with <code>CXX11_REGEX</code> defined.</span>
+ The C++ runtime &lt;regex&gt; library may be used by setting the <code>SCFIND_CXX11REGEX</code> search flag.
+ When using an older C++ compiler that does not support C++11, this may be turned off by
+ compiling Scintilla with <code>NO_CXX11_REGEX</code> defined.
A different regular expression
library can be <a class="jump" href="#AlternativeRegEx">integrated into Scintilla</a>
or can be called from the container using direct access to the buffer contents through
@@ -743,29 +744,32 @@ struct Sci_TextRange {
<tr>
<td><code>SCFIND_REGEXP</code></td>
- <td>The search string should be interpreted as a regular expression.</td>
+ <td>The search string should be interpreted as a regular expression.
+ Uses Scintilla's base implementation unless combined with <code>SCFIND_CXX11REGEX</code>.</td>
</tr>
<tr>
<td><code>SCFIND_POSIX</code></td>
<td>Treat regular expression in a more POSIX compatible manner
- by interpreting bare ( and ) for tagged sections rather than \( and \).</td>
+ by interpreting bare ( and ) for tagged sections rather than \( and \).
+ Has no effect when <code>SCFIND_CXX11REGEX</code> is set.</td>
</tr>
- <tr class="provisional">
+ <tr>
<td><code>SCFIND_CXX11REGEX</code></td>
- <td>When compiled with <code>CXX11_REGEX</code> this flag
- may be set to use &lt;regex&gt; instead of Scintilla's basic regular expressions.
- If the regular expression is invalid then -1 is returned and status is set to
- <code>SC_STATUS_WARN_REGEX</code>.
- The ECMAScript flag is set on the regex object and UTF-8 documents will exhibit Unicode-compliant
- behaviour. For MSVC, where wchar_t is 16-bits, the reular expression ".." will match a single
- astral-plane character. There may be other differences between compilers.</td>
+ <td>This flag may be set to use C++11 &lt;regex&gt; instead of Scintilla's basic regular expressions.
+ If the regular expression is invalid then -1 is returned and status is set to
+ <code>SC_STATUS_WARN_REGEX</code>.
+ The ECMAScript flag is set on the regex object and UTF-8 documents will exhibit Unicode-compliant
+ behaviour. For MSVC, where wchar_t is 16-bits, the reular expression ".." will match a single
+ astral-plane character. There may be other differences between compilers.
+ Must also have <code>SCFIND_REGEXP</code> set.</td>
</tr>
</tbody>
</table>
- <p>In a regular expression, special characters interpreted are:</p>
+ <p>In a regular expression, using Scintilla's base implementation,
+ special characters interpreted are:</p>
<table border="0" summary="Regular expression synopsis">
<tbody>
@@ -860,6 +864,10 @@ struct Sci_TextRange {
<p>Regular expressions will only match ranges within a single line, never matching over multiple lines.</p>
+ <p>When using <code>SCFIND_CXX11REGEX</code> more features are available,
+ generally similar to regular expression support in JavaScript.
+ See the documentation of your C++ runtime for details on what is supported.</p>
+
<code><a class="message" href="#SCI_FINDTEXT">SCI_FINDTEXT(int flags, Sci_TextToFind
*ttf)</a><br />
<a class="message" href="#SCI_SEARCHANCHOR">SCI_SEARCHANCHOR</a><br />
@@ -1020,7 +1028,7 @@ struct Sci_TextToFind {
<td>Generic failure</td>
</tr>
- <tr class="provisional">
+ <tr>
<th align="left">SC_STATUS_BADALLOC</th>
<td>2</td>
<td>Memory is exhausted</td>
@@ -7579,8 +7587,6 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next
<code class="provisional">SC_TECHNOLOGY_DIRECTWRITEDC</code> values for
<a class="message" href="#SCI_SETTECHNOLOGY">SCI_SETTECHNOLOGY</a> are provisional.</p>
- <p>Using C++11 &lt;regex&gt; is provisional.</p>
-
<p>Some developers may want to only use features that are stable and have graduated from
provisional status. To avoid using provisional messages compile with the symbol
<code>SCI_DISABLE_PROVISIONAL</code> defined.</p>