]> git.saurik.com Git - wxWidgets.git/blame - src/regex/README
Added some documentation :)
[wxWidgets.git] / src / regex / README
CommitLineData
e970653a
RN
1wxWindows regex
2----------------
3This is a version of Henry Spencer's regex,
4which was taken from postresql, which was
5taken from the source of TCL (Toolkit Command Language).
6
7This is version of Henry Spencer's library is
8modified by the wxWindows team. The modifications
9made by the wxWindows team are as follows:
10regcustom.h (all code)
11regex.h (function wrappers, other)
12regc_locale.c (A function or two).
13All the rest (Using standard c library routines instead of
14 postresql routines, various cleanup/optimizations)
15
16The code that is wxWindows-specific is as follows:
17regcustom.h (all code, see comments on how to replace)
18regex.h (where noted with comments, compiler workarounds)
19regcomp.c (a few of the functions prefixed with wx_,
20 these may be replaced by c library routines)
21
22This newer library was chosen over the old one because
23Henry Spencer's old library did not support unicode and
24had some other bugs that were fixed by this one, and
25the license was incompatible with the wxWindows license
26and the gpl.
27
28Modifications made by the wxWindows team are not licensed.
29
30
31The original readme (from the TCL distribution) follows:
32
07dcc217
VZ
33alpha3.8 release.
34Tue Aug 10 15:51:48 EDT 1999
35henry@spsystems.net (formerly henry@zoo.toronto.edu)
36
37See WHATSNEW for change listing.
38
39installation notes:
40--------
41Read the comments at the beginning of Makefile before running.
42
43Utils.h contains some things that just might have to be modified on
44some systems, as well as a nested include (ugh) of <assert.h>.
45
46The "fake" directory contains quick-and-dirty fakes for some header
47files and routines that old systems may not have. Note also that
48-DUSEBCOPY will make utils.h substitute bcopy() for memmove().
49
50After that, "make r" will build regcomp.o, regexec.o, regfree.o,
51and regerror.o (the actual routines), bundle them together into a test
52program, and run regression tests on them. No output is good output.
53
54"make lib" builds just the .o files for the actual routines (when
55you're happy with testing and have adjusted CFLAGS for production),
56and puts them together into libregex.a. You can pick up either the
57library or *.o ("make lib" makes sure there are no other .o files left
58around to confuse things).
59
60Main.c, debug.c, split.c are used for regression testing but are not part
61of the RE routines themselves.
62
63Regex.h goes in /usr/include. All other .h files are internal only.
64--------