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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 200 - (hide annotations) (download)
Wed Aug 1 09:10:40 2007 UTC (7 years, 4 months ago) by ph10
File size: 13052 byte(s)
Correct errors in previous patch; tidy for test release.

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

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