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

Legend:
Removed from v.77  
changed lines
  Added in v.254

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12