/[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 128 by ph10, Tue Mar 20 11:46:50 2007 UTC revision 243 by ph10, Thu Sep 13 09:28:14 2007 UTC
# Line 1  Line 1 
1  Compiling PCRE on non-Unix systems  Compiling PCRE on non-Unix systems
2  ----------------------------------  ----------------------------------
3    
4  I (Philip Hazel) have no knowledge of Windows or VMS sytems and how their  This document contains the following sections:
5    
6      General
7      Generic instructions for the PCRE C library
8      The C++ wrapper functions
9      Building for virtual Pascal
10      Stack size in Windows environments
11      Comments about Win32 builds
12      Building under Windows with BCC5.5
13      Building PCRE on OpenVMS
14    
15    
16    GENERAL
17    
18    I (Philip Hazel) have no experience of Windows or VMS sytems and how their
19  libraries work. The items in the PCRE distribution and Makefile that relate to  libraries work. The items in the PCRE distribution and Makefile that relate to
20  anything other than Unix-like systems are untested by me.  anything other than Unix-like systems are untested by me.
21    
# Line 10  site that you may find useful. See Line 24  site that you may find useful. See
24    
25    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
26    
27  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 (especially for a system that
28  for a system that does not support "configure" and "make" files), note that  does not support "configure" and "make" files), note that the basic PCRE
29  the basic PCRE library consists entirely of code written in Standard C, and so  library consists entirely of code written in Standard C, and so should compile
30  should compile successfully on any system that has a Standard C compiler and  successfully on any system that has a Standard C compiler and library. The C++
31  library. The C++ wrapper functions are a separate issue (see below).  wrapper functions are a separate issue (see below).
32    
33    The PCRE distribution contains some experimental support for "cmake", but this
34    is incomplete and not documented. However if you are a "cmake" user you might
35    like to try building with "cmake".
36    
37    
38  GENERIC INSTRUCTIONS FOR THE C LIBRARY  GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
39    
40  The following are generic comments about building the PCRE C library "by hand".  The following are generic comments about building the PCRE C library "by hand".
41    
42  (1) Copy or rename the file config.h.generic as config.h, and edit the macro   (1) Copy or rename the file config.h.generic as config.h, and edit the macro
43      settings that it contains to whatever is appropriate for your environment.       settings that it contains to whatever is appropriate for your environment.
44      In particular, if you want to force a specific value for newline, you can       In particular, if you want to force a specific value for newline, you can
45      define the NEWLINE macro.       define the NEWLINE macro. When you compile any of the PCRE modules, you
46         must specify -DHAVE_CONFIG_H to your compiler so that config.h is included
47      An alternative approach is not to edit config.h, but to use -D on the       in the sources.
48      compiler command line to make any changes that you need.  
49         An alternative approach is not to edit config.h, but to use -D on the
50  (2) Copy or rename the file pcre.h.generic as pcre.h.       compiler command line to make any changes that you need to the
51         configuration options. In this case -DHAVE_CONFIG_H must not be set.
52  (3) EITHER:  
53        Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.       NOTE: There have been occasions when the way in which certain parameters
54         in config.h are used has changed between releases. (In the configure/make
55      OR:       world, this is handled automatically.) When upgrading to a new release,
56        Compile dftables.c as a stand-alone program, and then run it with the       you are strongly advised to review config.h.generic before re-using what
57        single argument "pcre_chartables.c". This generates a set of standard       you had previously.
58        character tables and writes them to that file. The tables are generated  
59        using the default C locale for your system. If you want to use a locale   (2) Copy or rename the file pcre.h.generic as pcre.h.
60        that is specified by LC_xxx environment variables, add the -L option to  
61        the dftables command. You must use this method if you are building on   (3) EITHER:
62        a system that uses EBCDIC code.         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
63    
64      The tables in pcre_chartables.c are defaults. The caller of PCRE can       OR:
65      specify alternative tables at run time.         Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
66           you have set up config.h), and then run it with the single argument
67  (4) Compile the following source files:         "pcre_chartables.c". This generates a set of standard character tables
68           and writes them to that file. The tables are generated using the default
69        pcre_chartables.c         C locale for your system. If you want to use a locale that is specified
70        pcre_compile.c         by LC_xxx environment variables, add the -L option to the dftables
71        pcre_config.c         command. You must use this method if you are building on a system that
72        pcre_dfa_exec.c         uses EBCDIC code.
73        pcre_exec.c  
74        pcre_fullinfo.c       The tables in pcre_chartables.c are defaults. The caller of PCRE can
75        pcre_get.c       specify alternative tables at run time.
76        pcre_globals.c  
77        pcre_info.c   (4) Ensure that you have the following header files:
78        pcre_maketables.c  
79        pcre_newline.c         pcre_internal.h
80        pcre_ord2utf8.c         ucp.h
81        pcre_refcount.c         ucpinternal.h
82        pcre_study.c         ucptable.h
83        pcre_tables.c  
84        pcre_try_flipped.c   (5) Also ensure that you have the following file, which is #included as source
85        pcre_ucp_searchfuncs.c       when building a debugging version of PCRE and is also used by pcretest.
86        pcre_valid_utf8.c  
87        pcre_version.c         pcre_printint.src
88        pcre_xclass.c  
89     (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
90      Now link them all together into an object library in whichever form your       option if you have set up config.h with your configuration, or else use
91      system keeps such libraries. This is the basic PCRE C library. If your       other -D settings to change the configuration as required.
92      system has static and shared libraries, you may have to do this once for  
93      each type.         pcre_chartables.c
94           pcre_compile.c
95  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix         pcre_config.c
96      library.         pcre_dfa_exec.c
97           pcre_exec.c
98  (6) Compile the test program pcretest.c. This needs the functions in the         pcre_fullinfo.c
99      pcre and pcreposix libraries when linking.         pcre_get.c
100           pcre_globals.c
101  (7) Run pcretest on the testinput files in the testdata directory, and check         pcre_info.c
102      that the output matches the corresponding testoutput files. Note that the         pcre_maketables.c
103      supplied files are in Unix format, with just LF characters as line         pcre_newline.c
104      terminators. You may need to edit them to change this if your system uses a         pcre_ord2utf8.c
105      different convention.         pcre_refcount.c
106           pcre_study.c
107           pcre_tables.c
108           pcre_try_flipped.c
109           pcre_ucp_searchfuncs.c
110           pcre_valid_utf8.c
111           pcre_version.c
112           pcre_xclass.c
113    
114         Make sure that you include -I. in the compiler command (or equivalent for
115         an unusual compiler) so that all included PCRE header files are first
116         sought in the current directory. Otherwise you run the risk of picking up
117         a previously-installed file from somewhere else.
118    
119     (7) Now link all the compiled code into an object library in whichever form
120         your system keeps such libraries. This is the basic PCRE C library. If
121         your system has static and shared libraries, you may have to do this once
122         for each type.
123    
124     (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
125         and link the result (on its own) as the pcreposix library.
126    
127     (9) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
128         This needs the functions in the pcre and pcreposix libraries when linking.
129         It also needs the pcre_printint.src source file, which it #includes.
130    
131    (10) Run pcretest on the testinput files in the testdata directory, and check
132         that the output matches the corresponding testoutput files. Note that the
133         supplied files are in Unix format, with just LF characters as line
134         terminators. You may need to edit them to change this if your system uses
135         a different convention.
136    
137  (8) If you want to use the pcregrep command, compile and link pcregrep.c; it  (11) If you want to use the pcregrep command, compile and link pcregrep.c; it
138      uses only the basic PCRE library (it does not need the pcreposix library).       uses only the basic PCRE library (it does not need the pcreposix library).
139    
140    
141  THE C++ WRAPPER FUNCTIONS  THE C++ WRAPPER FUNCTIONS
# Line 105  BUILDING FOR VIRTUAL PASCAL Line 153  BUILDING FOR VIRTUAL PASCAL
153  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
154  was contributed by Alexander Tokarev. Stefan Weber updated the script and added  was contributed by Alexander Tokarev. Stefan Weber updated the script and added
155  additional files. The following files in the distribution are for building PCRE  additional files. The following files in the distribution are for building PCRE
156  for use with VP/Borland: makevp-compile.txt, makevp-linklib.txt, makevp.bat,  for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
 pcregexp.pas.  
157    
158    
159  BUILDING UNDER WINDOWS WITH BCC5.5  STACK SIZE IN WINDOWS ENVIRONMENTS
160    
161  Michael Roy sent these comments about building PCRE under Windows with BCC5.5:  The default processor stack size of 1Mb in some Windows environments is too
162    small for matching patterns that need much recursion. In particular, test 2 may
163    fail because of this. Normally, running out of stack causes a crash, but there
164    have been cases where the test program has just died silently. See your linker
165    documentation for how to increase stack size if you experience problems. The
166    Linux default of 8Mb is a reasonable choice for the stack, though even that can
167    be too small for some pattern/subject combinations. There is more about stack
168    usage in the "pcrestack" documentation.
169    
   Some of the core BCC libraries have a version of PCRE from 1998 built in,  
   which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a  
   version mismatch. I'm including an easy workaround below, if you'd like to  
   include it in the non-unix instructions:  
170    
171    When linking a project with BCC5.5, pcre.lib must be included before any of  COMMENTS ABOUT WIN32 BUILDS
   the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command  
   line.  
172    
173    There are two ways of building PCRE using the "configure, make, make install"
174    paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
175    the same thing; they are completely different from each other. There is also
176    some experimental, undocumented support for building using "cmake", which you
177    might like to try if you are familiar with "cmake". However, at the present
178    time, the "cmake" process builds only a static library (not a dll), and the
179    tests are not automatically run.
180    
181  OUT-OF-DATE COMMENTS ABOUT WIN32 BUILDS  The MinGW home page (http://www.mingw.org/) says this:
182    
183  [These comments need looking at by someone who knows about Windows.]    MinGW: A collection of freely available and freely distributable Windows
184      specific header files and import libraries combined with GNU toolsets that
185      allow one to produce native Windows programs that do not rely on any
186      3rd-party C runtime DLLs.
187    
188  Some help in building a Win32 DLL of PCRE in GnuWin32 environments was  The Cygwin home page (http://www.cygwin.com/) says this:
 contributed by Paul Sokolovsky. 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).  
   
 Changes to do MinGW with autoconf 2.50 were supplied by Fred Cox  
 <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.  
   
 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.)"  
189    
190  =========================    Cygwin is a Linux-like environment for Windows. It consists of two parts:
 #ifdef _WIN32  
 #include <malloc.h>  
191    
192  void* malloc_stub(size_t N)    . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
193  { return malloc(N); }      substantial Linux API functionality
 void free_stub(void* p)  
 { free(p); }  
 void *(*pcre_malloc)(size_t) = &malloc_stub;  
 void  (*pcre_free)(void *) = &free_stub;  
194    
195  #else    . A collection of tools which provide Linux look and feel.
196    
197  void *(*pcre_malloc)(size_t) = malloc;    The Cygwin DLL currently works with all recent, commercially released x86 32
198  void  (*pcre_free)(void *) = free;    bit and 64 bit versions of Windows, with the exception of Windows CE.
199    
200  #endif  On both MinGW and Cygwin, PCRE should build correctly using:
201  =========================  
202      ./configure && make && make install
203    
204    This should create two libraries called libpcre and libpcreposix, and, if you
205    have enabled building the C++ wrapper, a third one called libpcrecpp. These are
206    independent libraries: when you like with libpcreposix or libpcrecpp you must
207    also link with libpcre, which contains the basic functions. (Some earlier
208    releases of PCRE included the basic libpcre functions in libpcreposix. This no
209    longer happens.)
210    
211    If you want to statically link your program against a non-dll .a file, you must
212    define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
213    pcre_free() exported functions will be declared __declspec(dllimport), with
214    unwanted results.
215    
216    Using Cygwin's compiler generates libraries and executables that depend on
217    cygwin1.dll. If a library that is generated this way is distributed,
218    cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
219    licence, this forces not only PCRE to be under the GPL, but also the entire
220    application. A distributor who wants to keep their own code proprietary must
221    purchase an appropriate Cygwin licence.
222    
223    MinGW has no such restrictions. The MinGW compiler generates a library or
224    executable that can run standalone on Windows without any third party dll or
225    licensing issues.
226    
227    But there is more complication:
228    
229    If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
230    to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
231    front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
232    gcc and MinGW's gcc). So, a user can:
233    
234    . Build native binaries by using MinGW or by getting Cygwin and using
235      -mno-cygwin.
236    
237    . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
238      compiler flags.
239    
240    The test files that are supplied with PCRE are in Unix format, with LF
241    characters as line terminators. It may be necessary to change the line
242    terminators in order to get some of the tests to work. We hope to improve
243    things in this area in future.
244    
245    
246    BUILDING UNDER WINDOWS WITH BCC5.5
247    
248    Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
249    
250      Some of the core BCC libraries have a version of PCRE from 1998 built in,
251      which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
252      version mismatch. I'm including an easy workaround below, if you'd like to
253      include it in the non-unix instructions:
254    
255      When linking a project with BCC5.5, pcre.lib must be included before any of
256      the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
257      line.
258    
259    
260  BUILDING PCRE ON OPENVMS  BUILDING PCRE ON OPENVMS
# Line 255  $! Locale could not be set to fr Line 321  $! Locale could not be set to fr
321  $!  $!
322  =========================  =========================
323    
324  Last Updated: 20 March 2007  Last Updated: 11 September 2007
325  ****  ****

Legend:
Removed from v.128  
changed lines
  Added in v.243

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12