]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/re_syntax.tex
fix LaTeX error (escape underscores); don't abuse bold face
[wxWidgets.git] / docs / latex / wx / re_syntax.tex
index e79f69e0b990458dd726074e60c6084ee3639d84..7e5ca974c7c2f550e2391dad4b7e72330d6d6b2b 100644 (file)
@@ -1,5 +1,5 @@
 % manual page source format generated by PolyglotMan v3.0.9,
-% available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z
+% available from http://polyglotman.sourceforge.net/
 
 \section{Syntax of the builtin regular expression library}\label{wxresyn}
 
@@ -10,7 +10,7 @@ pattern that matches certain strings and doesn't match others.
 
 \helpref{wxRegEx}{wxregex}
 
-\subsection{Different Flavors of REs}
+\subsection{Different Flavors of REs}\label{differentflavors}
 
 \helpref{Syntax of the builtin regular expression library}{wxresyn}
 
@@ -25,7 +25,7 @@ AREs. BREs mostly exist for backward compatibility in some old programs;
 they will be discussed at the \helpref{end}{wxresynbre}. POSIX EREs are almost an exact subset
 of AREs. Features of AREs that are not present in EREs will be indicated.
 
-\subsection{Regular Expression Syntax}
+\subsection{Regular Expression Syntax}\label{resyntax}
 
 \helpref{Syntax of the builtin regular expression library}{wxresyn}
 
@@ -90,7 +90,7 @@ not be followed by a quantifier. The simple constraints are as follows;
 some more constraints are described later, under \helpref{Escapes}{wxresynescapes}.
 
 \begin{twocollist}\twocolwidtha{4cm}
-\twocolitem{{\bf $^$}}{matches at the beginning of a line}
+\twocolitem{{\bf \caret}}{matches at the beginning of a line}
 \twocolitem{{\bf \$}}{matches at the end of a line}
 \twocolitem{{\bf (?=re)}}{{\it positive lookahead}
 (AREs only), matches at any point where a substring matching {\it re} begins}
@@ -109,7 +109,7 @@ An RE may not end with `{\bf $\backslash$}'.
 
 A {\it bracket expression} is a list
 of characters enclosed in `{\bf $[]$}'. It normally matches any single character from
-the list (but see below). If the list begins with `{\bf $^$}', it matches any single
+the list (but see below). If the list begins with `{\bf \caret}', it matches any single
 character (but see below) {\it not} from the rest of the list. 
 
 If two characters
@@ -122,7 +122,7 @@ programs should avoid relying on them.
 To include a literal {\bf $]$} or {\bf -} in the
 list, the simplest method is to enclose it in {\bf $[.$} and {\bf $.]$} to make it a collating
 element (see below). Alternatively, make it the first character (following
-a possible `{\bf $^$}'), or (AREs only) precede it with `{\bf $\backslash$}'.
+a possible `{\bf \caret}'), or (AREs only) precede it with `{\bf $\backslash$}'.
 Alternatively, for `{\bf -}', make
 it the last character, or the second endpoint of a range. To use a literal
  {\bf -} as the first endpoint of a range, make it a collating element or (AREs
@@ -136,7 +136,7 @@ that collates as if it were a single character, or a collating-sequence
 name for either) enclosed in {\bf $[.$} and {\bf $.]$} stands for the
 sequence of characters of that collating element.
 
-{\it wxWindows}: Currently no multi-character collating elements are defined.
+{\it wxWidgets}: Currently no multi-character collating elements are defined.
 So in {\bf $[.X.]$}, {\it X} can either be a single character literal or
 the name of a character. For example, the following are both identical
  {\bf $[[.0.]-[.9.]]$} and {\bf $[[.zero.]-[.nine.]]$} and mean the same as
@@ -146,7 +146,7 @@ the name of a character. For example, the following are both identical
 %The sequence is a single element of the bracket
 %expression's list. A bracket expression in a locale that has multi-character
 %collating elements can thus match more than one character. So (insidiously),
-%a bracket expression that starts with {\bf $^$} can match multi-character collating
+%a bracket expression that starts with {\bf \caret} can match multi-character collating
 %elements even if none of them appear in the bracket expression! ({\it Note:}
 %Tcl currently has no multi-character collating elements. This information
 %is only for illustration.) 
@@ -162,8 +162,8 @@ collating elements equivalent to that one, including itself.
 %(If there are
 %no other equivalent collating elements, the treatment is as if the enclosing
 %delimiters were `{\bf $[.$}' and `{\bf $.]$}'.) For example, if {\bf o}
-%and {\bf $^$} are the members of an
-%equivalence class, then `{\bf $[[$=o=$]]$}', `{\bf $[[$=$^$=$]]$}',
+%and {\bf \caret} are the members of an
+%equivalence class, then `{\bf $[[$=o=$]]$}', `{\bf $[[$=\caret=$]]$}',
 %and `{\bf $[o^]$}' are all synonymous.
 An equivalence class may not be an endpoint of a range.
 
@@ -171,7 +171,7 @@ An equivalence class may not be an endpoint of a range.
 %implements only the Unicode locale. It doesn't define any equivalence classes.
 %The examples above are just illustrations.) 
 
-{\it wxWindows}: Currently no equivalence classes are defined, so 
+{\it wxWidgets}: Currently no equivalence classes are defined, so 
 {\bf $[=X=]$} stands for just the single character {\it X}. 
  {\it X} can either be a single character literal or the name of a character,
 see \helpref{Character Names}{wxresynchars}.
@@ -200,7 +200,7 @@ Standard character classes are:
 %implementation  has  only one locale: the Unicode locale.)
 A character class may not be used as an endpoint of a range. 
 
-{\it wxWindows:} In a non-Unicode build, these character classifications depend on the
+{\it wxWidgets}: In a non-Unicode build, these character classifications depend on the
 current locale, and correspond to the values return by the ANSI C 'is'
 functions: isalpha, isupper, etc. In Unicode mode they are based on
 Unicode classifications, and are not affected by the current locale.
@@ -302,7 +302,7 @@ escape:
 \begin{twocollist}\twocolwidtha{4cm}
 \twocolitem{{\bf $\backslash$A}}{matches only at the beginning of the string
 (see \helpref{Matching}{wxresynmatching}, below,
-for how this differs from `{\bf $^$}')}
+for how this differs from `{\bf \caret}')}
 \twocolitem{{\bf $\backslash$m}}{matches only at the beginning of a word}
 \twocolitem{{\bf $\backslash$M}}{matches only at the end of a word}
 \twocolitem{{\bf $\backslash$y}}{matches only at the beginning or end of a word}
@@ -339,7 +339,7 @@ is taken as a back  reference if it comes after a suitable subexpression
 (i.e. the number is in the legal range for a back reference), and otherwise
 is taken as octal. 
 
-\subsection{Metasyntax}
+\subsection{Metasyntax}\label{remetasyntax}
 
 \helpref{Syntax of the builtin regular expression library}{wxresyn}
 
@@ -459,22 +459,22 @@ inside a bracket expression, all case counterparts of it are added to the
 bracket expression, so that {\bf $[x]$} becomes {\bf $[xX]$} and {\bf $[^x]$} becomes `{\bf $[^xX]$}'. 
 
 If newline-sensitive
-matching is specified, {\bf .} and bracket expressions using {\bf $^$} will never match
+matching is specified, {\bf .} and bracket expressions using {\bf \caret} will never match
 the newline character (so that matches will never cross newlines unless
-the RE explicitly arranges it) and {\bf $^$} and {\bf \$} will match the empty string after
+the RE explicitly arranges it) and {\bf \caret} and {\bf \$} will match the empty string after
 and before a newline respectively, in addition to matching at beginning
 and end of string respectively. ARE {\bf $\backslash$A} and {\bf $\backslash$Z} continue to match beginning
 or end of string {\it only}. 
 
 If partial newline-sensitive matching is specified,
 this affects {\bf .} and bracket expressions as with newline-sensitive matching,
-but not {\bf $^$} and `{\bf \$}'. 
+but not {\bf \caret} and `{\bf \$}'. 
 
 If inverse partial newline-sensitive matching is specified,
-this affects {\bf $^$} and {\bf \$} as with newline-sensitive matching, but not {\bf .} and bracket
+this affects {\bf \caret} and {\bf \$} as with newline-sensitive matching, but not {\bf .} and bracket
 expressions. This isn't very useful but is provided for symmetry. 
 
-\subsection{Limits And Compatibility}
+\subsection{Limits And Compatibility}\label{relimits}
 
 \helpref{Syntax of the builtin regular expression library}{wxresyn}
 
@@ -544,12 +544,12 @@ for their functionality. The delimiters for bounds
 are {\bf $\backslash$\{} and `{\bf $\backslash$\}}', with {\bf \{} and
  {\bf \}} by themselves ordinary characters. The parentheses for nested subexpressions
 are {\bf $\backslash$(} and `{\bf $\backslash$)}', with {\bf (} and {\bf )} by themselves
-ordinary characters. {\bf $^$} is an ordinary
+ordinary characters. {\bf \caret} is an ordinary
 character except at the beginning of the RE or the beginning of a parenthesized
 subexpression, {\bf \$} is an ordinary character except at the end of the RE or
 the end of a parenthesized subexpression, and {\bf *} is an ordinary character
 if it appears at the beginning of the RE or the beginning of a parenthesized
-subexpression (after a possible leading `{\bf $^$}'). Finally, single-digit back references
+subexpression (after a possible leading `{\bf \caret}'). Finally, single-digit back references
 are available, and {\bf $\backslash<$} and {\bf $\backslash>$} are synonyms
 for {\bf $[[:<:]]$} and {\bf $[[:>:]]$} respectively;
 no other escapes are available.  
@@ -644,8 +644,8 @@ Note that the character names are case sensitive.
 \twocolitem{backslash}{'$\backslash$'}
 \twocolitem{reverse-solidus}{'$\backslash$'}
 \twocolitem{right-square-bracket}{'$]$'}
-\twocolitem{circumflex}{'$^$'}
-\twocolitem{circumflex-accent}{'$^$'}
+\twocolitem{circumflex}{'\caret'}
+\twocolitem{circumflex-accent}{'\caret'}
 \twocolitem{underscore}{'\_'}
 \twocolitem{low-line}{'\_'}
 \twocolitem{grave-accent}{'`'}
@@ -654,7 +654,7 @@ Note that the character names are case sensitive.
 \twocolitem{vertical-line}{'$|$'}
 \twocolitem{right-brace}{'\}'}
 \twocolitem{right-curly-bracket}{'\}'}
-\twocolitem{tilde}{'$~$'}
+\twocolitem{tilde}{'\destruct{}'}
 \twocolitem{DEL}{'$\backslash$177'}
 \end{twocollist}