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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 41 by nigel, Sat Feb 24 21:39:17 2007 UTC revision 197 by ph10, Tue Jul 31 10:50:18 2007 UTC
# Line 1  Line 1 
1  Compiling PCRE on non-Unix systems  Compiling PCRE on non-Unix systems
2  ----------------------------------  ----------------------------------
3    
4  If you want to compile PCRE for a non-Unix system, note that it consists  This document contains the following sections:
 entirely of code written in Standard C, and so should compile successfully  
 on any machine with a Standard C compiler and library, using normal compiling  
 commands to do the following:  
   
 (1) Copy or rename the file config.in as config.h. You should not have to  
 change any settings inside it for a Standard C environment.  
   
 (2) Compile dftables.c as a stand-alone program, and then run it with  
 the standard output sent to chartables.c. This generates a set of standard  
 character tables.  
   
 (3) Compile maketables.c, get.c, study.c and pcre.c and link them all  
 together into an object library in whichever form your system keeps such  
 libraries. This is the pcre library (chartables.c gets included by means of an  
 #include directive).  
   
 (4) Similarly, compile pcreposix.c and link it as the pcreposix library.  
   
 (5) Compile the test program pcretest.c. This needs the functions in the  
 pcre and pcreposix libraries when linking.  
   
 (6) Run pcretest on the testinput files in the testdata directory, and check  
 that the output matches the corresponding testoutput files. You must use the  
 -i option when checking testinput2.  
   
 If you have a system without "configure" but where you can use a Makefile, edit  
 Makefile.in to create Makefile, substituting suitable values for the variables  
 at the head of the file.  
   
 Some help in building a Win32 DLL of PCRE in GnuWin32 environments was  
 contributed by Paul.Sokolovsky@technologist.com. These environments are  
 Mingw32 (http://www.xraylith.wisc.edu/~khan/software/gnu-win32/) and  
 CygWin  (http://sourceware.cygnus.com/cygwin/). Paul comments:  
   
   For CygWin, set CFLAGS=-mno-cygwin, and do 'make dll'. You'll get  
   pcre.dll (containing pcreposix also), libpcre.dll.a, and dynamically  
   linked pgrep and pcretest. If you have /bin/sh, run RunTest (three  
   main test go ok, locale not supported).  
5    
6      General
7      Generic instructions for the PCRE C library
8      The C++ wrapper functions
9      Building for virtual Pascal
10      Comments about Win32 builds
11      Building under Windows with BCC5.5
12      Building PCRE on OpenVMS
13    
14    
15    GENERAL
16    
17    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    anything other than Unix-like systems are untested by me.
20    
21    There are some other comments and files in the Contrib directory on the ftp
22    site that you may find useful. See
23    
24      ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
25    
26    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    
32    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    like to try building with "cmake".
35    
36    
37    GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
38    
39    The following are generic comments about building the PCRE C library "by hand".
40    
41     (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    
115     (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    
119    (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    
125    (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    
128    
129    THE C++ WRAPPER FUNCTIONS
130    
131    The PCRE distribution also contains some C++ wrapper functions and tests,
132    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    BUILDING FOR VIRTUAL PASCAL
140    
141    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    for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
145    
146    
147    COMMENTS ABOUT WIN32 BUILDS
148    
149    There are two ways of building PCRE using the "configure, make, make install"
150    paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
151    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    time, the "cmake" process builds only a static library (not a dll), and the
155    tests are not automatically run.
156    
157    The MinGW home page (http://www.mingw.org/) says this:
158    
159      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    
164    The Cygwin home page (http://www.cygwin.com/) says this:
165    
166      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        substantial Linux API functionality
170    
171      . A collection of tools which provide Linux look and feel.
172    
173      The Cygwin DLL currently works with all recent, commercially released x86 32
174      bit and 64 bit versions of Windows, with the exception of Windows CE.
175    
176    On both MinGW and Cygwin, PCRE should build correctly using:
177    
178      ./configure && make && make install
179    
180    This should create two libraries called libpcre and libpcreposix, and, if you
181    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    longer happens.)
186    
187    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    unwanted results.
191    
192    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    
199    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    
203    But there is more complication:
204    
205    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    
210    . Build native binaries by using MinGW or by getting Cygwin and using
211      -mno-cygwin.
212    
213    . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
214      compiler flags.
215    
216    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    terminators in order to get some of the tests to work. We hope to improve
219    things in this area in future.
220    
221    
222    BUILDING UNDER WINDOWS WITH BCC5.5
223    
224    Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
225    
226      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    
231      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    
235    
236    BUILDING PCRE ON OPENVMS
237    
238    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    
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    Last Updated: 05 July 2007
301  ****  ****

Legend:
Removed from v.41  
changed lines
  Added in v.197

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12