/[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 63 by nigel, Sat Feb 24 21:40:03 2007 UTC revision 155 by ph10, Tue Apr 24 13:36:11 2007 UTC
# Line 1  Line 1 
1  Compiling PCRE on non-Unix systems  Compiling PCRE on non-Unix systems
2  ----------------------------------  ----------------------------------
3    
4  See below for comments on Cygwin or MinGW usage.  This document contains the following sections:
5    
6  If you want to compile PCRE for a non-Unix system, note that it consists    General
7  entirely of code written in Standard C, and so should compile successfully    Generic instructions for the PCRE C library
8  on any machine with a Standard C compiler and library, using normal compiling    The C++ wrapper functions
9  commands to do the following:    Building for virtual Pascal
10      Comments about Win32 builds
11  (1) Copy or rename the file config.in as config.h, and change the macros that    Building under Windows with BCC5.5
12  define HAVE_STRERROR and HAVE_MEMMOVE to define them as 1 rather than 0.    Building PCRE on OpenVMS
13  Unfortunately, because of the way Unix autoconf works, the default setting has  
14  to be 0. You may also want to make changes to other macros in config.h. In  
15  particular, if you want to force a specific value for newline, you can define  GENERAL
16  the NEWLINE macro. The default is to use '\n', thereby using whatever value  
17  your compiler gives to '\n'.  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  (2) Copy or rename the file pcre.in as pcre.h, and change the macro definitions  anything other than Unix-like systems are untested by me.
20  for PCRE_MAJOR, PCRE_MINOR, and PCRE_DATE near its start to the values set in  
21  configure.in.  There are some other comments and files in the Contrib directory on the ftp
22    site that you may find useful. See
23  (3) Compile dftables.c as a stand-alone program, and then run it with  
24  the standard output sent to chartables.c. This generates a set of standard    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
25  character tables.  
26    If you want to compile PCRE for a non-Unix system (especially for a system that
27  (4) Compile maketables.c, get.c, study.c and pcre.c and link them all  does not support "configure" and "make" files), note that the basic PCRE
28  together into an object library in whichever form your system keeps such  library consists entirely of code written in Standard C, and so should compile
29  libraries. This is the pcre library (chartables.c is included by means of an  successfully on any system that has a Standard C compiler and library. The C++
30  #include directive).  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    (2) Copy or rename the file pcre.h.generic as pcre.h.
50    
51    (3) EITHER:
52          Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
53    
54        OR:
55          Compile dftables.c as a stand-alone program, and then run it with the
56          single argument "pcre_chartables.c". This generates a set of standard
57          character tables and writes them to that file. The tables are generated
58          using the default C locale for your system. If you want to use a locale
59          that is specified by LC_xxx environment variables, add the -L option to
60          the dftables command. You must use this method if you are building on
61          a system that uses EBCDIC code.
62    
63        The tables in pcre_chartables.c are defaults. The caller of PCRE can
64        specify alternative tables at run time.
65    
66    (4) Compile the following source files:
67    
68          pcre_chartables.c
69          pcre_compile.c
70          pcre_config.c
71          pcre_dfa_exec.c
72          pcre_exec.c
73          pcre_fullinfo.c
74          pcre_get.c
75          pcre_globals.c
76          pcre_info.c
77          pcre_maketables.c
78          pcre_newline.c
79          pcre_ord2utf8.c
80          pcre_refcount.c
81          pcre_study.c
82          pcre_tables.c
83          pcre_try_flipped.c
84          pcre_ucp_searchfuncs.c
85          pcre_valid_utf8.c
86          pcre_version.c
87          pcre_xclass.c
88    
89        Now link them all together into an object library in whichever form your
90        system keeps such libraries. This is the basic PCRE C library. If your
91        system has static and shared libraries, you may have to do this once for
92        each type.
93    
94  (5) Similarly, compile pcreposix.c and link it as the pcreposix library.  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix
95        library.
96    
97  (6) Compile the test program pcretest.c. This needs the functions in the  (6) Compile the test program pcretest.c. This needs the functions in the
98  pcre and pcreposix libraries when linking.      pcre and pcreposix libraries when linking.
99    
100  (7) Run pcretest on the testinput files in the testdata directory, and check  (7) Run pcretest on the testinput files in the testdata directory, and check
101  that the output matches the corresponding testoutput files. You must use the      that the output matches the corresponding testoutput files. Note that the
102  -i option when checking testinput2. Note that the supplied files are in Unix      supplied files are in Unix format, with just LF characters as line
103  format, with just LF characters as line terminators. You may need to edit them      terminators. You may need to edit them to change this if your system uses a
104  to change this if your system uses a different convention.      different convention.
105    
106  If you have a system without "configure" but where you can use a Makefile, edit  (8) If you want to use the pcregrep command, compile and link pcregrep.c; it
107  Makefile.in to create Makefile, substituting suitable values for the variables      uses only the basic PCRE library (it does not need the pcreposix library).
108  at the head of the file.  
109    
110  Some help in building a Win32 DLL of PCRE in GnuWin32 environments was  THE C++ WRAPPER FUNCTIONS
111  contributed by Paul Sokolovsky. These environments are Mingw32  
112  (http://www.xraylith.wisc.edu/~khan/software/gnu-win32/) and CygWin  The PCRE distribution also contains some C++ wrapper functions and tests,
113  (http://sourceware.cygnus.com/cygwin/). Paul comments:  contributed by Google Inc. On a system that can use "configure" and "make",
114    the functions are automatically built into a library called pcrecpp. It should
115    For CygWin, set CFLAGS=-mno-cygwin, and do 'make dll'. You'll get  be straightforward to compile the .cc files manually on other systems. The
116    pcre.dll (containing pcreposix also), libpcre.dll.a, and dynamically  files called xxx_unittest.cc are test programs for each of the corresponding
117    linked pgrep and pcretest. If you have /bin/sh, run RunTest (three  xxx.cc files.
118    main test go ok, locale not supported).  
119    
120  Changes to do MinGW with autoconf 2.50 were supplied by Fred Cox  BUILDING FOR VIRTUAL PASCAL
 <sailorFred@yahoo.com>, who comments as follows:  
   
   If you are using the PCRE DLL, the normal Unix style configure && make &&  
   make check && make install should just work[*]. If you want to statically  
   link against the .a file, you must define PCRE_STATIC before including  
   pcre.h, otherwise the pcre_malloc and pcre_free exported functions will be  
   declared __declspec(dllimport), with hilarious results.  See the configure.in  
   and pcretest.c for how it is done for the static test.  
   
   Also, there will only be a libpcre.la, not a libpcreposix.la, as you  
   would expect from the Unix version. The single DLL includes the pcreposix  
   interface.  
   
 [*] But note that the supplied test files are in Unix format, with just LF  
 characters as line terminators. You will have to edit them to change to CR LF  
 terminators.  
121    
122  A script for building PCRE using Borland's C++ compiler for use with VPASCAL  A script for building PCRE using Borland's C++ compiler for use with VPASCAL
123  was contributed by Alexander Tokarev. It is called makevp.bat.  was contributed by Alexander Tokarev. Stefan Weber updated the script and added
124    additional files. The following files in the distribution are for building PCRE
125    for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
126    
 These are some further comments about Win32 builds from Mark Evans. They  
 were contributed before Fred Cox's changes were made, so it is possible that  
 they may no longer be relevant.  
   
 The documentation for Win32 builds is a bit shy.  Under MSVC6 I  
 followed their instructions to the letter, but there were still  
 some things missing.  
   
 (1) Must #define STATIC for entire project if linking statically.  
     (I see no reason to use DLLs for code this compact.)  This of  
     course is a project setting in MSVC under Preprocessor.  
   
 (2) Missing some #ifdefs relating to the function pointers  
     pcre_malloc and pcre_free.  See my solution below.  (The stubs  
     may not be mandatory but they made me feel better.)  
127    
128  =========================  COMMENTS ABOUT WIN32 BUILDS
129  #ifdef _WIN32  
130  #include <malloc.h>  There are two ways of building PCRE using the "congifure, make, make install"
131    paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
132    the same thing; they are completely different from each other. There is also
133    some experimental, undocumented support for building using "cmake", which you
134    might like to try if you are familiar with "cmake". However, at the present
135    time, the "cmake" process builds only a static library (not a dll), and the
136    tests are not automatically run.
137    
138    The MinGW home page (http://www.mingw.org/) says this:
139    
140      MinGW: A collection of freely available and freely distributable Windows
141      specific header files and import libraries combined with GNU toolsets that
142      allow one to produce native Windows programs that do not rely on any
143      3rd-party C runtime DLLs.
144    
145    The Cygwin home page (http://www.cygwin.com/) says this:
146    
147      Cygwin is a Linux-like environment for Windows. It consists of two parts:
148    
149      . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
150        substantial Linux API functionality
151    
152      . A collection of tools which provide Linux look and feel.
153    
154      The Cygwin DLL currently works with all recent, commercially released x86 32
155      bit and 64 bit versions of Windows, with the exception of Windows CE.
156    
157    On both MinGW and Cygwin, PCRE should build correctly using:
158    
159      ./configure && make && make install
160    
161    This should create two libraries called libpcre and libpcreposix, and, if you
162    have enabled building the C++ wrapper, a third one called libpcrecpp.
163    
164  void* malloc_stub(size_t N)  If you want to statically link your program against a non-dll .a file, you must
165  { return malloc(N); }  define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
166  void free_stub(void* p)  pcre_free() exported functions will be declared __declspec(dllimport), with
167  { free(p); }  unwanted results.
 void *(*pcre_malloc)(size_t) = &malloc_stub;  
 void  (*pcre_free)(void *) = &free_stub;  
168    
169  #else  Using Cygwin's compiler generates libraries and executables that depend on
170    cygwin1.dll. If a library that is generated this way is distributed,
171    cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
172    licence, this forces not only PCRE to be under the GPL, but also the entire
173    application. A distributor who wants to keep their own code proprietary must
174    purchase an appropriate Cygwin licence.
175    
176  void *(*pcre_malloc)(size_t) = malloc;  MinGW has no such restrictions. The MinGW compiler generates a library or
177  void  (*pcre_free)(void *) = free;  executable that can run standalone on Windows without any third party dll or
178    licensing issues.
179    
180  #endif  But there is more complication:
181    
182    If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
183    to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
184    front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
185    gcc and MinGW's gcc). So, a user can:
186    
187    . Build native binaries by using MinGW or by getting Cygwin and using
188      -mno-cygwin.
189    
190    . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
191      compiler flags.
192    
193    The test files that are supplied with PCRE are in Unix format, with LF
194    characters as line terminators. It may be necessary to change the line
195    terminators in order to get some of the tests to work. We hope to improve
196    things in this area in future.
197    
198    
199    BUILDING UNDER WINDOWS WITH BCC5.5
200    
201    Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
202    
203      Some of the core BCC libraries have a version of PCRE from 1998 built in,
204      which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
205      version mismatch. I'm including an easy workaround below, if you'd like to
206      include it in the non-unix instructions:
207    
208      When linking a project with BCC5.5, pcre.lib must be included before any of
209      the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
210      line.
211    
212    
213    BUILDING PCRE ON OPENVMS
214    
215    Dan Mooney sent the following comments about building PCRE on OpenVMS. They
216    relate to an older version of PCRE that used fewer source files, so the exact
217    commands will need changing. See the current list of source files above.
218    
219    "It was quite easy to compile and link the library. I don't have a formal
220    make file but the attached file [reproduced below] contains the OpenVMS DCL
221    commands I used to build the library. I had to add #define
222    POSIX_MALLOC_THRESHOLD 10 to pcre.h since it was not defined anywhere.
223    
224    The library was built on:
225    O/S: HP OpenVMS v7.3-1
226    Compiler: Compaq C v6.5-001-48BCD
227    Linker: vA13-01
228    
229    The test results did not match 100% due to the issues you mention in your
230    documentation regarding isprint(), iscntrl(), isgraph() and ispunct(). I
231    modified some of the character tables temporarily and was able to get the
232    results to match. Tests using the fr locale did not match since I don't have
233    that locale loaded. The study size was always reported to be 3 less than the
234    value in the standard test output files."
235    
236    =========================
237    $! This DCL procedure builds PCRE on OpenVMS
238    $!
239    $! I followed the instructions in the non-unix-use file in the distribution.
240    $!
241    $ COMPILE == "CC/LIST/NOMEMBER_ALIGNMENT/PREFIX_LIBRARY_ENTRIES=ALL_ENTRIES
242    $ COMPILE DFTABLES.C
243    $ LINK/EXE=DFTABLES.EXE DFTABLES.OBJ
244    $ RUN DFTABLES.EXE/OUTPUT=CHARTABLES.C
245    $ COMPILE MAKETABLES.C
246    $ COMPILE GET.C
247    $ COMPILE STUDY.C
248    $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
249    $! did not seem to be defined anywhere.
250    $! I edited pcre.h and added #DEFINE SUPPORT_UTF8 to enable UTF8 support.
251    $ COMPILE PCRE.C
252    $ LIB/CREATE PCRE MAKETABLES.OBJ, GET.OBJ, STUDY.OBJ, PCRE.OBJ
253    $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
254    $! did not seem to be defined anywhere.
255    $ COMPILE PCREPOSIX.C
256    $ LIB/CREATE PCREPOSIX PCREPOSIX.OBJ
257    $ COMPILE PCRETEST.C
258    $ LINK/EXE=PCRETEST.EXE PCRETEST.OBJ, PCRE/LIB, PCREPOSIX/LIB
259    $! C programs that want access to command line arguments must be
260    $! defined as a symbol
261    $ PCRETEST :== "$ SYS$ROADSUSERS:[DMOONEY.REGEXP]PCRETEST.EXE"
262    $! Arguments must be enclosed in quotes.
263    $ PCRETEST "-C"
264    $! Test results:
265    $!
266    $!   The test results did not match 100%. The functions isprint(), iscntrl(),
267    $!   isgraph() and ispunct() on OpenVMS must not produce the same results
268    $!   as the system that built the test output files provided with the
269    $!   distribution.
270    $!
271    $!   The study size did not match and was always 3 less on OpenVMS.
272    $!
273    $!   Locale could not be set to fr
274    $!
275  =========================  =========================
276    
277    Last Updated: 24 April 2007
278  ****  ****

Legend:
Removed from v.63  
changed lines
  Added in v.155

  ViewVC Help
Powered by ViewVC 1.1.5