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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 188 - (hide annotations) (download)
Thu Jul 5 11:49:44 2007 UTC (7 years, 3 months ago) by ph10
File size: 12115 byte(s)
Add information about required header files to the generic instructions, so 
that all needed files are mentioned.

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