[wxWidgets.git] / src / regex / README

wxWindows regex
---------------
This is a version of Henry Spencer's regex, which was taken from the
source of TCL (Toolkit Command Language).  It implements POSIX regular
expressions and also supports Unicode and some Perl5 extensions.

The modifications made by the wxWindows team are as follows:

regcustom.h
-----------
Types and constants appropriate for our use of the library are defined
here.

regex.h
-------
This is unmodified. Note though, that a portion of it (clearly marked)
is copied from regcustom.h as part of the build process.

regc_locale.c
-------------
This module provides character classifications.

The current version from Tcl supports only a Unicode build. The
original code from Henry Spencer, on the other hand, was ASCII only.
Therefore, in order to support both, code from the ASCII version has been
incorporated into the Unicode version, conditionally compiled depending
on wxUSE_UNICODE.

The only non-trivial dependencies were: Tcl_UniCharToUpper,
Tcl_UniCharToLower and Tcl_UniCharToTitle. The implementations of these
have also been incorporated (from Tcl). These in turn depend only the data
tables in tclUniData.c (which is unmodified). At some point wxWindows
may have it's own Unicode character classification code, at which point
these should be used instead.

Other dependencies (on Tcl_DString) have been eliminated using wxWindows
wxChar functions.

The ASCII version has also been extended to support character
classifications based on the current locale rather than ASCII only.
Commit	Line	Data
e970653a	1	wxWindows regex
1701c4d4 VS	2	---------------
	3	This is a version of Henry Spencer's regex, which was taken from the
	4	source of TCL (Toolkit Command Language). It implements POSIX regular
	5	expressions and also supports Unicode and some Perl5 extensions.
	6
	7	The modifications made by the wxWindows team are as follows:
	8
	9	regcustom.h
	10	-----------
	11	Types and constants appropriate for our use of the library are defined
	12	here.
	13
	14	regex.h
	15	-------
	16	This is unmodified. Note though, that a portion of it (clearly marked)
	17	is copied from regcustom.h as part of the build process.
	18
	19	regc_locale.c
	20	-------------
	21	This module provides character classifications.
	22
	23	The current version from Tcl supports only a Unicode build. The
	24	original code from Henry Spencer, on the other hand, was ASCII only.
	25	Therefore, in order to support both, code from the ASCII version has been
	26	incorporated into the Unicode version, conditionally compiled depending
	27	on wxUSE_UNICODE.
	28
	29	The only non-trivial dependencies were: Tcl_UniCharToUpper,
	30	Tcl_UniCharToLower and Tcl_UniCharToTitle. The implementations of these
	31	have also been incorporated (from Tcl). These in turn depend only the data
	32	tables in tclUniData.c (which is unmodified). At some point wxWindows
	33	may have it's own Unicode character classification code, at which point
	34	these should be used instead.
	35
	36	Other dependencies (on Tcl_DString) have been eliminated using wxWindows
	37	wxChar functions.
	38
	39	The ASCII version has also been extended to support character
	40	classifications based on the current locale rather than ASCII only.
e970653a	41