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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 252 - (hide annotations) (download)
Mon Sep 17 10:38:40 2007 UTC (6 years, 10 months ago) by ph10
File size: 13879 byte(s)
Documentation tweak.

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