/[pcre]/code/trunk/NON-UNIX-USE
ViewVC logotype

Contents of /code/trunk/NON-UNIX-USE

Parent Directory Parent Directory | Revision Log Revision Log


Revision 198 - (show annotations) (download)
Tue Jul 31 11:11:23 2007 UTC (7 years ago) by ph10
File size: 12764 byte(s)
Update version number; add words about stacks to NON-UNIX-USE.

1 Compiling PCRE on non-Unix systems
2 ----------------------------------
3
4 This document contains the following sections:
5
6 General
7 Generic instructions for the PCRE C library
8 The C++ wrapper functions
9 Building for virtual Pascal
10 Stack size in Windows environments
11 Comments about Win32 builds
12 Building under Windows with BCC5.5
13 Building PCRE on OpenVMS
14
15
16 GENERAL
17
18 I (Philip Hazel) have no knowledge of Windows or VMS sytems and how their
19 libraries work. The items in the PCRE distribution and Makefile that relate to
20 anything other than Unix-like systems are untested by me.
21
22 There are some other comments and files in the Contrib directory on the ftp
23 site that you may find useful. See
24
25 ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
26
27 If you want to compile PCRE for a non-Unix system (especially for a system that
28 does not support "configure" and "make" files), note that the basic PCRE
29 library consists entirely of code written in Standard C, and so should compile
30 successfully on any system that has a Standard C compiler and library. The C++
31 wrapper functions are a separate issue (see below).
32
33 The PCRE distribution contains some experimental support for "cmake", but this
34 is incomplete and not documented. However if you are a "cmake" user you might
35 like to try building with "cmake".
36
37
38 GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
39
40 The following are generic comments about building the PCRE C library "by hand".
41
42 (1) Copy or rename the file config.h.generic as config.h, and edit the macro
43 settings that it contains to whatever is appropriate for your environment.
44 In particular, if you want to force a specific value for newline, you can
45 define the NEWLINE macro.
46
47 An alternative approach is not to edit config.h, but to use -D on the
48 compiler command line to make any changes that you need.
49
50 NOTE: There have been occasions when the way in which certain parameters
51 in config.h are used has changed between releases. (In the configure/make
52 world, this is handled automatically.) When upgrading to a new release,
53 you are strongly advised to review config.h.generic before re-using what
54 you had previously.
55
56 (2) Copy or rename the file pcre.h.generic as pcre.h.
57
58 (3) EITHER:
59 Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
60
61 OR:
62 Compile dftables.c as a stand-alone program, and then run it with the
63 single argument "pcre_chartables.c". This generates a set of standard
64 character tables and writes them to that file. The tables are generated
65 using the default C locale for your system. If you want to use a locale
66 that is specified by LC_xxx environment variables, add the -L option to
67 the dftables command. You must use this method if you are building on
68 a system that uses EBCDIC code.
69
70 The tables in pcre_chartables.c are defaults. The caller of PCRE can
71 specify alternative tables at run time.
72
73 (4) Ensure that you have the following header files:
74
75 pcre_internal.h
76 ucp.h
77 ucpinternal.h
78 ucptable.h
79
80 (5) Also ensure that you have the following file, which is #included as source
81 when building a debugging version of PCRE and is also used by pcretest.
82
83 pcre_printint.src
84
85 (6) Compile the following source files:
86
87 pcre_chartables.c
88 pcre_compile.c
89 pcre_config.c
90 pcre_dfa_exec.c
91 pcre_exec.c
92 pcre_fullinfo.c
93 pcre_get.c
94 pcre_globals.c
95 pcre_info.c
96 pcre_maketables.c
97 pcre_newline.c
98 pcre_ord2utf8.c
99 pcre_refcount.c
100 pcre_study.c
101 pcre_tables.c
102 pcre_try_flipped.c
103 pcre_ucp_searchfuncs.c
104 pcre_valid_utf8.c
105 pcre_version.c
106 pcre_xclass.c
107
108 (7) Now link all the compiled code into an object library in whichever form
109 your system keeps such libraries. This is the basic PCRE C library. If
110 your system has static and shared libraries, you may have to do this once
111 for each type.
112
113 (8) Similarly, compile pcreposix.c and link the result (on its own) as the
114 pcreposix library.
115
116 (9) Compile the test program pcretest.c. This needs the functions in the
117 pcre and pcreposix libraries when linking. It also needs the
118 pcre_printint.src source file, which it #includes.
119
120 (10) Run pcretest on the testinput files in the testdata directory, and check
121 that the output matches the corresponding testoutput files. Note that the
122 supplied files are in Unix format, with just LF characters as line
123 terminators. You may need to edit them to change this if your system uses
124 a different convention.
125
126 (11) If you want to use the pcregrep command, compile and link pcregrep.c; it
127 uses only the basic PCRE library (it does not need the pcreposix library).
128
129
130 THE C++ WRAPPER FUNCTIONS
131
132 The PCRE distribution also contains some C++ wrapper functions and tests,
133 contributed by Google Inc. On a system that can use "configure" and "make",
134 the functions are automatically built into a library called pcrecpp. It should
135 be straightforward to compile the .cc files manually on other systems. The
136 files called xxx_unittest.cc are test programs for each of the corresponding
137 xxx.cc files.
138
139
140 BUILDING FOR VIRTUAL PASCAL
141
142 A script for building PCRE using Borland's C++ compiler for use with VPASCAL
143 was contributed by Alexander Tokarev. Stefan Weber updated the script and added
144 additional files. The following files in the distribution are for building PCRE
145 for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
146
147
148 STACK SIZE IN WINDOWS ENVIRONMENTS
149
150 The default processor stack size of 1Mb in some Windows environments is too
151 small for matching patterns that need much recursion. In particular, test 2 may
152 fail because of this. Normally, running out of stack causes a crash, but there
153 have been cases where the test program has just died silently. See your linker
154 documentation for how to increase stack size if you experience problems. The
155 Linux default of 8Mb is a reasonable choice for the stack, though even that can
156 be too small for some pattern/subject combinations. There is more about stack
157 usage in the "pcrestack" documentation.
158
159
160 COMMENTS ABOUT WIN32 BUILDS
161
162 There are two ways of building PCRE using the "configure, make, make install"
163 paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
164 the same thing; they are completely different from each other. There is also
165 some experimental, undocumented support for building using "cmake", which you
166 might like to try if you are familiar with "cmake". However, at the present
167 time, the "cmake" process builds only a static library (not a dll), and the
168 tests are not automatically run.
169
170 The MinGW home page (http://www.mingw.org/) says this:
171
172 MinGW: A collection of freely available and freely distributable Windows
173 specific header files and import libraries combined with GNU toolsets that
174 allow one to produce native Windows programs that do not rely on any
175 3rd-party C runtime DLLs.
176
177 The Cygwin home page (http://www.cygwin.com/) says this:
178
179 Cygwin is a Linux-like environment for Windows. It consists of two parts:
180
181 . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
182 substantial Linux API functionality
183
184 . A collection of tools which provide Linux look and feel.
185
186 The Cygwin DLL currently works with all recent, commercially released x86 32
187 bit and 64 bit versions of Windows, with the exception of Windows CE.
188
189 On both MinGW and Cygwin, PCRE should build correctly using:
190
191 ./configure && make && make install
192
193 This should create two libraries called libpcre and libpcreposix, and, if you
194 have enabled building the C++ wrapper, a third one called libpcrecpp. These are
195 independent libraries: when you like with libpcreposix or libpcrecpp you must
196 also link with libpcre, which contains the basic functions. (Some earlier
197 releases of PCRE included the basic libpcre functions in libpcreposix. This no
198 longer happens.)
199
200 If you want to statically link your program against a non-dll .a file, you must
201 define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
202 pcre_free() exported functions will be declared __declspec(dllimport), with
203 unwanted results.
204
205 Using Cygwin's compiler generates libraries and executables that depend on
206 cygwin1.dll. If a library that is generated this way is distributed,
207 cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
208 licence, this forces not only PCRE to be under the GPL, but also the entire
209 application. A distributor who wants to keep their own code proprietary must
210 purchase an appropriate Cygwin licence.
211
212 MinGW has no such restrictions. The MinGW compiler generates a library or
213 executable that can run standalone on Windows without any third party dll or
214 licensing issues.
215
216 But there is more complication:
217
218 If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
219 to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
220 front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
221 gcc and MinGW's gcc). So, a user can:
222
223 . Build native binaries by using MinGW or by getting Cygwin and using
224 -mno-cygwin.
225
226 . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
227 compiler flags.
228
229 The test files that are supplied with PCRE are in Unix format, with LF
230 characters as line terminators. It may be necessary to change the line
231 terminators in order to get some of the tests to work. We hope to improve
232 things in this area in future.
233
234
235 BUILDING UNDER WINDOWS WITH BCC5.5
236
237 Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
238
239 Some of the core BCC libraries have a version of PCRE from 1998 built in,
240 which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
241 version mismatch. I'm including an easy workaround below, if you'd like to
242 include it in the non-unix instructions:
243
244 When linking a project with BCC5.5, pcre.lib must be included before any of
245 the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
246 line.
247
248
249 BUILDING PCRE ON OPENVMS
250
251 Dan Mooney sent the following comments about building PCRE on OpenVMS. They
252 relate to an older version of PCRE that used fewer source files, so the exact
253 commands will need changing. See the current list of source files above.
254
255 "It was quite easy to compile and link the library. I don't have a formal
256 make file but the attached file [reproduced below] contains the OpenVMS DCL
257 commands I used to build the library. I had to add #define
258 POSIX_MALLOC_THRESHOLD 10 to pcre.h since it was not defined anywhere.
259
260 The library was built on:
261 O/S: HP OpenVMS v7.3-1
262 Compiler: Compaq C v6.5-001-48BCD
263 Linker: vA13-01
264
265 The test results did not match 100% due to the issues you mention in your
266 documentation regarding isprint(), iscntrl(), isgraph() and ispunct(). I
267 modified some of the character tables temporarily and was able to get the
268 results to match. Tests using the fr locale did not match since I don't have
269 that locale loaded. The study size was always reported to be 3 less than the
270 value in the standard test output files."
271
272 =========================
273 $! This DCL procedure builds PCRE on OpenVMS
274 $!
275 $! I followed the instructions in the non-unix-use file in the distribution.
276 $!
277 $ COMPILE == "CC/LIST/NOMEMBER_ALIGNMENT/PREFIX_LIBRARY_ENTRIES=ALL_ENTRIES
278 $ COMPILE DFTABLES.C
279 $ LINK/EXE=DFTABLES.EXE DFTABLES.OBJ
280 $ RUN DFTABLES.EXE/OUTPUT=CHARTABLES.C
281 $ COMPILE MAKETABLES.C
282 $ COMPILE GET.C
283 $ COMPILE STUDY.C
284 $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
285 $! did not seem to be defined anywhere.
286 $! I edited pcre.h and added #DEFINE SUPPORT_UTF8 to enable UTF8 support.
287 $ COMPILE PCRE.C
288 $ LIB/CREATE PCRE MAKETABLES.OBJ, GET.OBJ, STUDY.OBJ, PCRE.OBJ
289 $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
290 $! did not seem to be defined anywhere.
291 $ COMPILE PCREPOSIX.C
292 $ LIB/CREATE PCREPOSIX PCREPOSIX.OBJ
293 $ COMPILE PCRETEST.C
294 $ LINK/EXE=PCRETEST.EXE PCRETEST.OBJ, PCRE/LIB, PCREPOSIX/LIB
295 $! C programs that want access to command line arguments must be
296 $! defined as a symbol
297 $ PCRETEST :== "$ SYS$ROADSUSERS:[DMOONEY.REGEXP]PCRETEST.EXE"
298 $! Arguments must be enclosed in quotes.
299 $ PCRETEST "-C"
300 $! Test results:
301 $!
302 $! The test results did not match 100%. The functions isprint(), iscntrl(),
303 $! isgraph() and ispunct() on OpenVMS must not produce the same results
304 $! as the system that built the test output files provided with the
305 $! distribution.
306 $!
307 $! The study size did not match and was always 3 less on OpenVMS.
308 $!
309 $! Locale could not be set to fr
310 $!
311 =========================
312
313 Last Updated: 05 July 2007
314 ****

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12