/[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 93 by nigel, Sat Feb 24 21:41:42 2007 UTC revision 135 by ph10, Thu Mar 29 09:09:33 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      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    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
25    
# Line 16  should compile successfully on any syste Line 30  should compile successfully on any syste
30  library. The C++ wrapper functions are a separate issue (see below).  library. The C++ wrapper functions are a separate issue (see below).
31    
32    
33  GENERIC INSTRUCTIONS FOR THE C LIBRARY  GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
34    
35  The following are generic comments about building PCRE. The interspersed  The following are generic comments about building the PCRE C library "by hand".
 indented commands are suggestions from Mark Tetrode as to which commands you  
 might use on a Windows system to build a static library.  
   
 (1) Copy or rename the file config.h.in as config.h, and change the macros that  
 define HAVE_STRERROR and HAVE_MEMMOVE to define them as 1 rather than 0.  
 Unfortunately, because of the way Unix autoconf works, the default setting has  
 to be 0. You may also want to make changes to other macros in config.h. In  
 particular, if you want to force a specific value for newline, you can define  
 the NEWLINE macro. The default is to use '\n', thereby using whatever value  
 your compiler gives to '\n'.  
   
   rem Mark Tetrode's commands  
   copy config.h.in config.h  
   rem Use write, because notepad cannot handle UNIX files. Change values.  
   write config.h  
   
 (2) Compile dftables.c as a stand-alone program, and then run it with  
 the single argument "pcre_chartables.c". This generates a set of standard  
 character tables and writes them to that file.  
   
   rem Mark Tetrode's commands  
   rem Compile & run  
   cl -DSUPPORT_UTF8 -DSUPPORT_UCP dftables.c  
   dftables.exe pcre_chartables.c  
   
 (3) Compile the following source files:  
   
   pcre_chartables.c  
   pcre_compile.c  
   pcre_config.c  
   pcre_dfa_exec.c  
   pcre_exec.c  
   pcre_fullinfo.c  
   pcre_get.c  
   pcre_globals.c  
   pcre_info.c  
   pcre_maketables.c  
   pcre_newline.c  
   pcre_ord2utf8.c  
   pcre_refcount.c  
   pcre_study.c  
   pcre_tables.c  
   pcre_try_flipped.c  
   pcre_ucp_searchfuncs.c  
   pcre_valid_utf8.c  
   pcre_version.c  
   pcre_xclass.c  
   
 and link them all together into an object library in whichever form your system  
 keeps such libraries. This is the pcre C library. If your system has static and  
 shared libraries, you may have to do this once for each type.  
   
   rem These comments are out-of-date, referring to a previous release which  
   rem had fewer source files. Replace with the file names from above.  
   rem Mark Tetrode's commands, for a static library  
   rem Compile & lib  
   cl -DSUPPORT_UTF8 -DSUPPORT_UCP -DPOSIX_MALLOC_THRESHOLD=10 /c maketables.c get.c study.c pcre.c  
   lib /OUT:pcre.lib maketables.obj get.obj study.obj pcre.obj  
   
 (4) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix  
 library.  
   
   rem Mark Tetrode's commands, for a static library  
   rem Compile & lib  
   cl -DSUPPORT_UTF8 -DSUPPORT_UCP -DPOSIX_MALLOC_THRESHOLD=10 /c pcreposix.c  
   lib /OUT:pcreposix.lib pcreposix.obj  
   
 (5) Compile the test program pcretest.c. This needs the functions in the  
 pcre and pcreposix libraries when linking.  
   
   rem Mark Tetrode's commands  
   rem compile & link  
   cl /F0x400000 pcretest.c pcre.lib pcreposix.lib  
   
 (6) Run pcretest on the testinput files in the testdata directory, and check  
 that the output matches the corresponding testoutput files. Note that the  
 supplied files are in Unix format, with just LF characters as line terminators.  
 You may need to edit them to change this if your system uses a different  
 convention.  
   
   rem Mark Tetrode's commands  
   pcretest testdata\testinput1 testdata\myoutput1  
   windiff testdata\testoutput1 testdata\myoutput1  
   pcretest -i testdata\testinput2 testdata\myoutput2  
   windiff testdata\testoutput2 testdata\myoutput2  
   pcretest testdata\testinput3 testdata\myoutput3  
   windiff testdata\testoutput3 testdata\myoutput3  
   pcretest testdata\testinput4 testdata\myoutput4  
   windiff testdata\testoutput4 testdata\myoutput4  
   pcretest testdata\testinput5 testdata\myoutput5  
   windiff testdata\testoutput5 testdata\myoutput5  
   pcretest testdata\testinput6 testdata\myoutput6  
   windiff testdata\testoutput6 testdata\myoutput6  
36    
37  Note that there are now three more tests (7, 8, 9) that did not exist when Mark  (1) Copy or rename the file config.h.generic as config.h, and edit the macro
38  wrote those comments. The test the new pcre_dfa_exec() function.      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        define the NEWLINE macro.
41    
42        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    
45    (2) Copy or rename the file pcre.h.generic as pcre.h.
46    
47    (3) EITHER:
48          Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
49    
50        OR:
51          Compile dftables.c as a stand-alone program, and then run it with the
52          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
91        library.
92    
93    (6) Compile the test program pcretest.c. This needs the functions in the
94        pcre and pcreposix libraries when linking.
95    
96    (7) Run pcretest on the testinput files in the testdata directory, and check
97        that the output matches the corresponding testoutput files. Note that the
98        supplied files are in Unix format, with just LF characters as line
99        terminators. You may need to edit them to change this if your system uses a
100        different convention.
101    
102  (7) If you want to use the pcregrep command, compile and link pcregrep.c; it  (8) If you want to use the pcregrep command, compile and link pcregrep.c; it
103  uses only the basic PCRE library.      uses only the basic PCRE library (it does not need the pcreposix library).
104    
105    
106  THE C++ WRAPPER FUNCTIONS  THE C++ WRAPPER FUNCTIONS
107    
108  The PCRE distribution now contains some C++ wrapper functions and tests,  The PCRE distribution also contains some C++ wrapper functions and tests,
109  contributed by Google Inc. On a system that can use "configure" and "make",  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  the functions are automatically built into a library called pcrecpp. It should
111  be straightforward to compile the .cc files manually on other systems. The  be straightforward to compile the .cc files manually on other systems. The
# Line 130  files called xxx_unittest.cc are test pr Line 113  files called xxx_unittest.cc are test pr
113  xxx.cc files.  xxx.cc files.
114    
115    
116  FURTHER REMARKS  BUILDING FOR VIRTUAL PASCAL
117    
118  If you have a system without "configure" but where you can use a Makefile, edit  A script for building PCRE using Borland's C++ compiler for use with VPASCAL
119  Makefile.in to create Makefile, substituting suitable values for the variables  was contributed by Alexander Tokarev. Stefan Weber updated the script and added
120  at the head of the file.  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    
 Michael Roy sent these comments about building PCRE under Windows with BCC5.5:  
123    
124    Some of the core BCC libraries have a version of PCRE from 1998 built in,  COMMENTS ABOUT WIN32 BUILDS
   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:  
125    
126    When linking a project with BCC5.5, pcre.lib must be included before any of  There are two ways of building PCRE on Windows systems: using MinGW or using
127    the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command  Cygwin. These are not at all the same thing, and are completely different from
128    line.  each other.
129    
130  Some help in building a Win32 DLL of PCRE in GnuWin32 environments was  The MinGW home page (http://www.mingw.org/) 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.  
131    
132  A script for building PCRE using Borland's C++ compiler for use with VPASCAL    MinGW: A collection of freely available and freely distributable Windows
133  was contributed by Alexander Tokarev. It is called makevp.bat.    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  These are some further comments about Win32 builds from Mark Evans. They  The Cygwin home page (http://www.cygwin.com/) says this:
 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.)"  
138    
139  =========================    Cygwin is a Linux-like environment for Windows. It consists of two parts:
 #ifdef _WIN32  
 #include <malloc.h>  
140    
141  void* malloc_stub(size_t N)    . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
142  { 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;  
143    
144  #else    . A collection of tools which provide Linux look and feel.
145    
146  void *(*pcre_malloc)(size_t) = malloc;    The Cygwin DLL currently works with all recent, commercially released x86 32
147  void  (*pcre_free)(void *) = free;    bit and 64 bit versions of Windows, with the exception of Windows CE.
148    
149  #endif  On both MinGW and Cygwin, PCRE should build correctly using:
150  =========================  
151      ./configure && make && make install
152    
153    However, if you want to statically link your program against the .a file, you
154    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    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  BUILDING PCRE ON OPENVMS
# Line 278  $!   Locale could not be set to fr Line 263  $!   Locale could not be set to fr
263  $!  $!
264  =========================  =========================
265    
266    Last Updated: 26 March 2007
267  ****  ****

Legend:
Removed from v.93  
changed lines
  Added in v.135

  ViewVC Help
Powered by ViewVC 1.1.5