/[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 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    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      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  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  libraries work. The items in the PCRE distribution and Makefile that relate to
19  anything other than Unix-like systems are untested by me.  anything other than Unix-like systems are untested by me.
# Line 10  site that you may find useful. See Line 23  site that you may find useful. See
23    
24    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    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 (especially for a system that
27  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
28  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
29  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++
30  library. The C++ wrapper functions are a separate issue (see below).  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 C LIBRARY  GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
38    
39  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".
40    
41  (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
42      settings that it contains to whatever is appropriate for your environment.       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       In particular, if you want to force a specific value for newline, you can
44      define the NEWLINE macro.       define the NEWLINE macro.
45    
46      An alternative approach is not to edit config.h, but to use -D on the       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.       compiler command line to make any changes that you need.
48    
49  (2) Copy or rename the file pcre.h.generic as pcre.h.       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  (3) EITHER:       world, this is handled automatically.) When upgrading to a new release,
52        Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.       you are strongly advised to review config.h.generic before re-using what
53         you had previously.
54      OR:  
55        Compile dftables.c as a stand-alone program, and then run it with the   (2) Copy or rename the file pcre.h.generic as pcre.h.
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   (3) EITHER:
58        using the default C locale for your system. If you want to use a locale         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
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       OR:
61        a system that uses EBCDIC code.         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      The tables in pcre_chartables.c are defaults. The caller of PCRE can         character tables and writes them to that file. The tables are generated
64      specify alternative tables at run time.         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  (4) Compile the following source files:         the dftables command. You must use this method if you are building on
67           a system that uses EBCDIC code.
68        pcre_chartables.c  
69        pcre_compile.c       The tables in pcre_chartables.c are defaults. The caller of PCRE can
70        pcre_config.c       specify alternative tables at run time.
71        pcre_dfa_exec.c  
72        pcre_exec.c   (4) Ensure that you have the following header files:
73        pcre_fullinfo.c  
74        pcre_get.c         pcre_internal.h
75        pcre_globals.c         ucp.h
76        pcre_info.c         ucpinternal.h
77        pcre_maketables.c         ucptable.h
78        pcre_newline.c  
79        pcre_ord2utf8.c   (5) Also ensure that you have the following file, which is #included as source
80        pcre_refcount.c       when building a debugging version of PCRE and is also used by pcretest.
81        pcre_study.c  
82        pcre_tables.c         pcre_printint.src
83        pcre_try_flipped.c  
84        pcre_ucp_searchfuncs.c   (6) Compile the following source files:
85        pcre_valid_utf8.c  
86        pcre_version.c         pcre_chartables.c
87        pcre_xclass.c         pcre_compile.c
88           pcre_config.c
89      Now link them all together into an object library in whichever form your         pcre_dfa_exec.c
90      system keeps such libraries. This is the basic PCRE C library. If your         pcre_exec.c
91      system has static and shared libraries, you may have to do this once for         pcre_fullinfo.c
92      each type.         pcre_get.c
93           pcre_globals.c
94  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix         pcre_info.c
95      library.         pcre_maketables.c
96           pcre_newline.c
97  (6) Compile the test program pcretest.c. This needs the functions in the         pcre_ord2utf8.c
98      pcre and pcreposix libraries when linking.         pcre_refcount.c
99           pcre_study.c
100  (7) Run pcretest on the testinput files in the testdata directory, and check         pcre_tables.c
101      that the output matches the corresponding testoutput files. Note that the         pcre_try_flipped.c
102      supplied files are in Unix format, with just LF characters as line         pcre_ucp_searchfuncs.c
103      terminators. You may need to edit them to change this if your system uses a         pcre_valid_utf8.c
104      different convention.         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  (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
126      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).
127    
128    
129  THE C++ WRAPPER FUNCTIONS  THE C++ WRAPPER FUNCTIONS
# Line 105  BUILDING FOR VIRTUAL PASCAL Line 141  BUILDING FOR VIRTUAL PASCAL
141  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
142  was contributed by Alexander Tokarev. Stefan Weber updated the script and added  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  additional files. The following files in the distribution are for building PCRE
144  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.  
145    
146    
147  BUILDING UNDER WINDOWS WITH BCC5.5  COMMENTS ABOUT WIN32 BUILDS
148    
149  Michael Roy sent these comments about building PCRE under Windows with BCC5.5:  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    Some of the core BCC libraries have a version of PCRE from 1998 built in,  The MinGW home page (http://www.mingw.org/) says this:
   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:  
158    
159    When linking a project with BCC5.5, pcre.lib must be included before any of    MinGW: A collection of freely available and freely distributable Windows
160    the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command    specific header files and import libraries combined with GNU toolsets that
161    line.    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  OUT-OF-DATE COMMENTS ABOUT WIN32 BUILDS    Cygwin is a Linux-like environment for Windows. It consists of two parts:
167    
168  [These comments need looking at by someone who knows about Windows.]    . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
169        substantial Linux API functionality
170    
171  Some help in building a Win32 DLL of PCRE in GnuWin32 environments was    . A collection of tools which provide Linux look and feel.
 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.)"  
172    
173  =========================    The Cygwin DLL currently works with all recent, commercially released x86 32
174  #ifdef _WIN32    bit and 64 bit versions of Windows, with the exception of Windows CE.
 #include <malloc.h>  
175    
176  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;  
177    
178  #else    ./configure && make && make install
179    
180  void *(*pcre_malloc)(size_t) = malloc;  This should create two libraries called libpcre and libpcreposix, and, if you
181  void  (*pcre_free)(void *) = free;  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  #endif  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  BUILDING PCRE ON OPENVMS
# Line 255  $!   Locale could not be set to fr Line 297  $!   Locale could not be set to fr
297  $!  $!
298  =========================  =========================
299    
300  Last Updated: 20 March 2007  Last Updated: 05 July 2007
301  ****  ****

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

  ViewVC Help
Powered by ViewVC 1.1.5