/[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 77 by nigel, Sat Feb 24 21:40:45 2007 UTC revision 198 by ph10, Tue Jul 31 11:11:23 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 and OpenVMS usage. I (Philip Hazel)  This document contains the following sections:
5  have no knowledge of Windows or VMS sytems and how their libraries work. The  
6  items in the PCRE Makefile that relate to anything other than Unix-like systems    General
7  have been contributed by PCRE users. There are some other comments and files in    Generic instructions for the PCRE C library
8  the Contrib directory on the ftp site that you may find useful. See    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 knowledge of Windows or VMS sytems and how their
19    libraries work. The items in the PCRE distribution and Makefile that relate to
20    anything other than Unix-like systems are untested by me.
21    
22    There are some other comments and files in the Contrib directory on the ftp
23    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  PCRE consists entirely of code written in Standard C, and so should compile  library consists entirely of code written in Standard C, and so should compile
30  successfully on any system that has a Standard C compiler and library.  successfully on any system that has a Standard C compiler and library. The C++
31    wrapper functions are a separate issue (see below).
32    
33  GENERIC INSTRUCTIONS  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  The following are generic comments about building PCRE. The interspersed  like to try building with "cmake".
36  indented commands are suggestions from Mark Tetrode as to which commands you  
37  might use on a Windows system to build a static library.  
38    GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
39  (1) Copy or rename the file config.in as config.h, and change the macros that  
40  define HAVE_STRERROR and HAVE_MEMMOVE to define them as 1 rather than 0.  The following are generic comments about building the PCRE C library "by hand".
41  Unfortunately, because of the way Unix autoconf works, the default setting has  
42  to be 0. You may also want to make changes to other macros in config.h. In   (1) Copy or rename the file config.h.generic as config.h, and edit the macro
43  particular, if you want to force a specific value for newline, you can define       settings that it contains to whatever is appropriate for your environment.
44  the NEWLINE macro. The default is to use '\n', thereby using whatever value       In particular, if you want to force a specific value for newline, you can
45  your compiler gives to '\n'.       define the NEWLINE macro.
46    
47    rem Mark Tetrode's commands       An alternative approach is not to edit config.h, but to use -D on the
48    copy config.in config.h       compiler command line to make any changes that you need.
49    rem Use write, because notepad cannot handle UNIX files. Change values.  
50    write config.h       NOTE: There have been occasions when the way in which certain parameters
51         in config.h are used has changed between releases. (In the configure/make
52  (2) Copy or rename the file pcre.in as pcre.h, and change the macro definitions       world, this is handled automatically.) When upgrading to a new release,
53  for PCRE_MAJOR, PCRE_MINOR, and PCRE_DATE near its start to the values set in       you are strongly advised to review config.h.generic before re-using what
54  configure.in.       you had previously.
55    
56    rem Mark Tetrode's commands   (2) Copy or rename the file pcre.h.generic as pcre.h.
57    copy pcre.in pcre.h  
58    rem Read values from configure.in   (3) EITHER:
59    write configure.in         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
60    rem Change values  
61    write pcre.h       OR:
62           Compile dftables.c as a stand-alone program, and then run it with the
63  (3) Compile dftables.c as a stand-alone program, and then run it with         single argument "pcre_chartables.c". This generates a set of standard
64  the single argument "chartables.c". This generates a set of standard         character tables and writes them to that file. The tables are generated
65  character tables and writes them to that file.         using the default C locale for your system. If you want to use a locale
66           that is specified by LC_xxx environment variables, add the -L option to
67    rem Mark Tetrode's commands         the dftables command. You must use this method if you are building on
68    rem Compile & run         a system that uses EBCDIC code.
69    cl -DSUPPORT_UTF8 -DSUPPORT_UCP dftables.c  
70    dftables.exe chartables.c       The tables in pcre_chartables.c are defaults. The caller of PCRE can
71         specify alternative tables at run time.
72  (4) Compile maketables.c, get.c, study.c and pcre.c and link them all  
73  together into an object library in whichever form your system keeps such   (4) Ensure that you have the following header files:
74  libraries. This is the pcre library (chartables.c is included by means of an  
75  #include directive). If your system has static and shared libraries, you may         pcre_internal.h
76  have to do this once for each type.         ucp.h
77           ucpinternal.h
78    rem Mark Tetrode's commands, for a static library         ucptable.h
79    rem Compile & lib  
80    cl -DSUPPORT_UTF8 -DSUPPORT_UCP -DPOSIX_MALLOC_THRESHOLD=10 /c maketables.c get.c study.c pcre.c   (5) Also ensure that you have the following file, which is #included as source
81    lib /OUT:pcre.lib maketables.obj get.obj study.obj pcre.obj       when building a debugging version of PCRE and is also used by pcretest.
82    
83  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix         pcre_printint.src
84  library.  
85     (6) Compile the following source files:
86    rem Mark Tetrode's commands, for a static library  
87    rem Compile & lib         pcre_chartables.c
88    cl -DSUPPORT_UTF8 -DSUPPORT_UCP -DPOSIX_MALLOC_THRESHOLD=10 /c pcreposix.c         pcre_compile.c
89    lib /OUT:pcreposix.lib pcreposix.obj         pcre_config.c
90           pcre_dfa_exec.c
91  (6) Compile the test program pcretest.c. This needs the functions in the         pcre_exec.c
92  pcre and pcreposix libraries when linking.         pcre_fullinfo.c
93           pcre_get.c
94    rem Mark Tetrode's commands         pcre_globals.c
95    rem compile & link         pcre_info.c
96    cl /F0x400000 pcretest.c pcre.lib pcreposix.lib         pcre_maketables.c
97           pcre_newline.c
98  (7) Run pcretest on the testinput files in the testdata directory, and check         pcre_ord2utf8.c
99  that the output matches the corresponding testoutput files. You must use the         pcre_refcount.c
100  -i option when checking testinput2. Note that the supplied files are in Unix         pcre_study.c
101  format, with just LF characters as line terminators. You may need to edit them         pcre_tables.c
102  to change this if your system uses a different convention.         pcre_try_flipped.c
103           pcre_ucp_searchfuncs.c
104    rem Mark Tetrode's commands         pcre_valid_utf8.c
105    pcretest testdata\testinput1 testdata\myoutput1         pcre_version.c
106    windiff testdata\testoutput1 testdata\myoutput1         pcre_xclass.c
107    pcretest -i testdata\testinput2 testdata\myoutput2  
108    windiff testdata\testoutput2 testdata\myoutput2   (7) Now link all the compiled code into an object library in whichever form
109    pcretest testdata\testinput3 testdata\myoutput3       your system keeps such libraries. This is the basic PCRE C library. If
110    windiff testdata\testoutput3 testdata\myoutput3       your system has static and shared libraries, you may have to do this once
111    pcretest testdata\testinput4 testdata\myoutput4       for each type.
112    windiff testdata\testoutput4 testdata\myoutput4  
113    pcretest testdata\testinput5 testdata\myoutput5   (8) Similarly, compile pcreposix.c and link the result (on its own) as the
114    windiff testdata\testoutput5 testdata\myoutput5       pcreposix library.
115    pcretest testdata\testinput6 testdata\myoutput6  
116    windiff testdata\testoutput6 testdata\myoutput6   (9) Compile the test program pcretest.c. This needs the functions in the
117         pcre and pcreposix libraries when linking. It also needs the
118         pcre_printint.src source file, which it #includes.
119  FURTHER REMARKS  
120    (10) Run pcretest on the testinput files in the testdata directory, and check
121  If you have a system without "configure" but where you can use a Makefile, edit       that the output matches the corresponding testoutput files. Note that the
122  Makefile.in to create Makefile, substituting suitable values for the variables       supplied files are in Unix format, with just LF characters as line
123  at the head of the file.       terminators. You may need to edit them to change this if your system uses
124         a different convention.
125  Some help in building a Win32 DLL of PCRE in GnuWin32 environments was  
126  contributed by Paul Sokolovsky. These environments are Mingw32  (11) If you want to use the pcregrep command, compile and link pcregrep.c; it
127  (http://www.xraylith.wisc.edu/~khan/software/gnu-win32/) and CygWin       uses only the basic PCRE library (it does not need the pcreposix library).
128  (http://sourceware.cygnus.com/cygwin/). Paul comments:  
129    
130    For CygWin, set CFLAGS=-mno-cygwin, and do 'make dll'. You'll get  THE C++ WRAPPER FUNCTIONS
131    pcre.dll (containing pcreposix also), libpcre.dll.a, and dynamically  
132    linked pgrep and pcretest. If you have /bin/sh, run RunTest (three  The PCRE distribution also contains some C++ wrapper functions and tests,
133    main test go ok, locale not supported).  contributed by Google Inc. On a system that can use "configure" and "make",
134    the functions are automatically built into a library called pcrecpp. It should
135  Changes to do MinGW with autoconf 2.50 were supplied by Fred Cox  be straightforward to compile the .cc files manually on other systems. The
136  <sailorFred@yahoo.com>, who comments as follows:  files called xxx_unittest.cc are test programs for each of the corresponding
137    xxx.cc files.
138    If you are using the PCRE DLL, the normal Unix style configure && make &&  
139    make check && make install should just work[*]. If you want to statically  
140    link against the .a file, you must define PCRE_STATIC before including  BUILDING FOR VIRTUAL PASCAL
   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.  
141    
142  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
143  was contributed by Alexander Tokarev. It is called makevp.bat.  was contributed by Alexander Tokarev. Stefan Weber updated the script and added
144    additional files. The following files in the distribution are for building PCRE
145    for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
146    
 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.)"  
147    
148  =========================  STACK SIZE IN WINDOWS ENVIRONMENTS
 #ifdef _WIN32  
 #include <malloc.h>  
149    
150  void* malloc_stub(size_t N)  The default processor stack size of 1Mb in some Windows environments is too
151  { return malloc(N); }  small for matching patterns that need much recursion. In particular, test 2 may
152  void free_stub(void* p)  fail because of this. Normally, running out of stack causes a crash, but there
153  { free(p); }  have been cases where the test program has just died silently. See your linker
154  void *(*pcre_malloc)(size_t) = &malloc_stub;  documentation for how to increase stack size if you experience problems. The
155  void  (*pcre_free)(void *) = &free_stub;  Linux default of 8Mb is a reasonable choice for the stack, though even that can
156    be too small for some pattern/subject combinations. There is more about stack
157    usage in the "pcrestack" documentation.
158    
 #else  
159    
160  void *(*pcre_malloc)(size_t) = malloc;  COMMENTS ABOUT WIN32 BUILDS
 void  (*pcre_free)(void *) = free;  
161    
162  #endif  There are two ways of building PCRE using the "configure, make, make install"
163  =========================  paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
164    the same thing; they are completely different from each other. There is also
165    some experimental, undocumented support for building using "cmake", which you
166    might like to try if you are familiar with "cmake". However, at the present
167    time, the "cmake" process builds only a static library (not a dll), and the
168    tests are not automatically run.
169    
170    The MinGW home page (http://www.mingw.org/) says this:
171    
172      MinGW: A collection of freely available and freely distributable Windows
173      specific header files and import libraries combined with GNU toolsets that
174      allow one to produce native Windows programs that do not rely on any
175      3rd-party C runtime DLLs.
176    
177    The Cygwin home page (http://www.cygwin.com/) says this:
178    
179      Cygwin is a Linux-like environment for Windows. It consists of two parts:
180    
181      . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
182        substantial Linux API functionality
183    
184      . A collection of tools which provide Linux look and feel.
185    
186      The Cygwin DLL currently works with all recent, commercially released x86 32
187      bit and 64 bit versions of Windows, with the exception of Windows CE.
188    
189    On both MinGW and Cygwin, PCRE should build correctly using:
190    
191      ./configure && make && make install
192    
193    This should create two libraries called libpcre and libpcreposix, and, if you
194    have enabled building the C++ wrapper, a third one called libpcrecpp. These are
195    independent libraries: when you like with libpcreposix or libpcrecpp you must
196    also link with libpcre, which contains the basic functions. (Some earlier
197    releases of PCRE included the basic libpcre functions in libpcreposix. This no
198    longer happens.)
199    
200    If you want to statically link your program against a non-dll .a file, you must
201    define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
202    pcre_free() exported functions will be declared __declspec(dllimport), with
203    unwanted results.
204    
205    Using Cygwin's compiler generates libraries and executables that depend on
206    cygwin1.dll. If a library that is generated this way is distributed,
207    cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
208    licence, this forces not only PCRE to be under the GPL, but also the entire
209    application. A distributor who wants to keep their own code proprietary must
210    purchase an appropriate Cygwin licence.
211    
212    MinGW has no such restrictions. The MinGW compiler generates a library or
213    executable that can run standalone on Windows without any third party dll or
214    licensing issues.
215    
216    But there is more complication:
217    
218    If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
219    to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
220    front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
221    gcc and MinGW's gcc). So, a user can:
222    
223    . Build native binaries by using MinGW or by getting Cygwin and using
224      -mno-cygwin.
225    
226    . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
227      compiler flags.
228    
229    The test files that are supplied with PCRE are in Unix format, with LF
230    characters as line terminators. It may be necessary to change the line
231    terminators in order to get some of the tests to work. We hope to improve
232    things in this area in future.
233    
234    
235    BUILDING UNDER WINDOWS WITH BCC5.5
236    
237    Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
238    
239      Some of the core BCC libraries have a version of PCRE from 1998 built in,
240      which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
241      version mismatch. I'm including an easy workaround below, if you'd like to
242      include it in the non-unix instructions:
243    
244      When linking a project with BCC5.5, pcre.lib must be included before any of
245      the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
246      line.
247    
248    
249  BUILDING PCRE ON OPENVMS  BUILDING PCRE ON OPENVMS
250    
251  Dan Mooney sent the following comments about building PCRE on OpenVMS:  Dan Mooney sent the following comments about building PCRE on OpenVMS. They
252    relate to an older version of PCRE that used fewer source files, so the exact
253    commands will need changing. See the current list of source files above.
254    
255  "It was quite easy to compile and link the library. I don't have a formal  "It was quite easy to compile and link the library. I don't have a formal
256  make file but the attached file [reproduced below] contains the OpenVMS DCL  make file but the attached file [reproduced below] contains the OpenVMS DCL
# Line 236  $! Locale could not be set to fr Line 310  $! Locale could not be set to fr
310  $!  $!
311  =========================  =========================
312    
313    Last Updated: 05 July 2007
314  ****  ****
Legend:
Removed from v.77  
changed lines
  Added in v.198
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12