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

Legend:
Removed from v.73  
changed lines
  Added in v.134

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12