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

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

Parent Directory Parent Directory | Revision Log Revision Log


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