/[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 75 by nigel, Sat Feb 24 21:40:37 2007 UTC revision 188 by ph10, Thu Jul 5 11:49:44 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    
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  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
29  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++
30    wrapper functions are a separate issue (see below).
31    
32  GENERIC INSTRUCTIONS  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  The following are generic comments about building PCRE. The interspersed  like to try building with "cmake".
35  indented commands are suggestions from Mark Tetrode as to which commands you  
36  might use on a Windows system to build a static library.  
37    GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
38  (1) Copy or rename the file config.in as config.h, and change the macros that  
39  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".
40  Unfortunately, because of the way Unix autoconf works, the default setting has  
41  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
42  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.
43  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
44  your compiler gives to '\n'.       define the NEWLINE macro.
45    
46    rem Mark Tetrode's commands       An alternative approach is not to edit config.h, but to use -D on the
47    copy config.in config.h       compiler command line to make any changes that you need.
48    rem Use write, because notepad cannot handle UNIX files. Change values.  
49    write config.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  (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,
52  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
53  configure.in.       you had previously.
54    
55    rem Mark Tetrode's commands   (2) Copy or rename the file pcre.h.generic as pcre.h.
56    copy pcre.in pcre.h  
57    rem Read values from configure.in   (3) EITHER:
58    write configure.in         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
59    rem Change values  
60    write pcre.h       OR:
61           Compile dftables.c as a stand-alone program, and then run it with the
62  (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
63  the single argument "chartables.c". This generates a set of standard         character tables and writes them to that file. The tables are generated
64  character tables and writes them to that file.         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    rem Mark Tetrode's commands         the dftables command. You must use this method if you are building on
67    rem Compile & run         a system that uses EBCDIC code.
68    cl -DSUPPORT_UTF8 dftables.c  
69    dftables.exe > chartables.c       The tables in pcre_chartables.c are defaults. The caller of PCRE can
70         specify alternative tables at run time.
71  (4) Compile maketables.c, get.c, study.c and pcre.c and link them all  
72  together into an object library in whichever form your system keeps such   (4) Ensure that you have the following header files:
73  libraries. This is the pcre library (chartables.c is included by means of an  
74  #include directive). If your system has static and shared libraries, you may         pcre_internal.h
75  have to do this once for each type.         ucp.h
76           ucpinternal.h
77    rem Mark Tetrode's commands, for a static library         ucptable.h
78    rem Compile & lib  
79    cl -DSUPPORT_UTF8 -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
80    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.
81    
82  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix         pcre_printint.src
83  library.  
84     (6) Compile the following source files:
85    rem Mark Tetrode's commands, for a static library  
86    rem Compile & lib         pcre_chartables.c
87    cl -DSUPPORT_UTF8 -DPOSIX_MALLOC_THRESHOLD=10 /c pcreposix.c         pcre_compile.c
88    lib /OUT:pcreposix.lib pcreposix.obj         pcre_config.c
89           pcre_dfa_exec.c
90  (6) Compile the test program pcretest.c. This needs the functions in the         pcre_exec.c
91  pcre and pcreposix libraries when linking.         pcre_fullinfo.c
92           pcre_get.c
93    rem Mark Tetrode's commands         pcre_globals.c
94    rem compile & link         pcre_info.c
95    cl pcretest.c pcre.lib pcreposix.lib         pcre_maketables.c
96           pcre_newline.c
97  (7) Run pcretest on the testinput files in the testdata directory, and check         pcre_ord2utf8.c
98  that the output matches the corresponding testoutput files. You must use the         pcre_refcount.c
99  -i option when checking testinput2. Note that the supplied files are in Unix         pcre_study.c
100  format, with just LF characters as line terminators. You may need to edit them         pcre_tables.c
101  to change this if your system uses a different convention.         pcre_try_flipped.c
102           pcre_ucp_searchfuncs.c
103    rem Mark Tetrode's commands         pcre_valid_utf8.c
104    rem Make a change, i.e. space, backspace, and save again - do this for all         pcre_version.c
105    rem to change UNIX to Win, \n to \n\r         pcre_xclass.c
106    write testoutput1  
107    write testoutput2   (7) Now link all the compiled code into an object library in whichever form
108    write testoutput3       your system keeps such libraries. This is the basic PCRE C library. If
109    write testoutput4       your system has static and shared libraries, you may have to do this once
110    write testoutput5       for each type.
111    pcretest testdata\testinput1 testdata\myoutput1  
112    windiff testdata\testoutput1 testdata\myoutput1   (8) Similarly, compile pcreposix.c and link the result (on its own) as the
113    pcretest -i testdata\testinput2 testdata\myoutput2       pcreposix library.
114    windiff testdata\testoutput2 testdata\myoutput2  
115    pcretest testdata\testinput3 testdata\myoutput3   (9) Compile the test program pcretest.c. This needs the functions in the
116    windiff testdata\testoutput3 testdata\myoutput3       pcre and pcreposix libraries when linking. It also needs the
117    pcretest testdata\testinput4 testdata\myoutput4       pcre_printint.src source file, which it #includes.
118    windiff testdata\testoutput4 testdata\myoutput4  
119    pcretest testdata\testinput5 testdata\myoutput5  (10) Run pcretest on the testinput files in the testdata directory, and check
120    windiff testdata\testoutput5 testdata\myoutput5       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  FURTHER REMARKS       a different convention.
124    
125  If you have a system without "configure" but where you can use a Makefile, edit  (11) If you want to use the pcregrep command, compile and link pcregrep.c; it
126  Makefile.in to create Makefile, substituting suitable values for the variables       uses only the basic PCRE library (it does not need the pcreposix library).
127  at the head of the file.  
128    
129  Some help in building a Win32 DLL of PCRE in GnuWin32 environments was  THE C++ WRAPPER FUNCTIONS
130  contributed by Paul Sokolovsky. These environments are Mingw32  
131  (http://www.xraylith.wisc.edu/~khan/software/gnu-win32/) and CygWin  The PCRE distribution also contains some C++ wrapper functions and tests,
132  (http://sourceware.cygnus.com/cygwin/). Paul comments:  contributed by Google Inc. On a system that can use "configure" and "make",
133    the functions are automatically built into a library called pcrecpp. It should
134    For CygWin, set CFLAGS=-mno-cygwin, and do 'make dll'. You'll get  be straightforward to compile the .cc files manually on other systems. The
135    pcre.dll (containing pcreposix also), libpcre.dll.a, and dynamically  files called xxx_unittest.cc are test programs for each of the corresponding
136    linked pgrep and pcretest. If you have /bin/sh, run RunTest (three  xxx.cc files.
137    main test go ok, locale not supported).  
138    
139  Changes to do MinGW with autoconf 2.50 were supplied by Fred Cox  BUILDING FOR VIRTUAL PASCAL
 <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.  
140    
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. It is called makevp.bat.  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
144    for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
145    
 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.)"  
146    
147  =========================  COMMENTS ABOUT WIN32 BUILDS
 #ifdef _WIN32  
 #include <malloc.h>  
148    
149  void* malloc_stub(size_t N)  There are two ways of building PCRE using the "configure, make, make install"
150  { return malloc(N); }  paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
151  void free_stub(void* p)  the same thing; they are completely different from each other. There is also
152  { free(p); }  some experimental, undocumented support for building using "cmake", which you
153  void *(*pcre_malloc)(size_t) = &malloc_stub;  might like to try if you are familiar with "cmake". However, at the present
154  void  (*pcre_free)(void *) = &free_stub;  time, the "cmake" process builds only a static library (not a dll), and the
155    tests are not automatically run.
156    
157  #else  The MinGW home page (http://www.mingw.org/) says this:
158    
159  void *(*pcre_malloc)(size_t) = malloc;    MinGW: A collection of freely available and freely distributable Windows
160  void  (*pcre_free)(void *) = free;    specific header files and import libraries combined with GNU toolsets that
161      allow one to produce native Windows programs that do not rely on any
162      3rd-party C runtime DLLs.
163    
164  #endif  The Cygwin home page (http://www.cygwin.com/) says this:
165  =========================  
166      Cygwin is a Linux-like environment for Windows. It consists of two parts:
167    
168      . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
169        substantial Linux API functionality
170    
171      . A collection of tools which provide Linux look and feel.
172    
173      The Cygwin DLL currently works with all recent, commercially released x86 32
174      bit and 64 bit versions of Windows, with the exception of Windows CE.
175    
176    On both MinGW and Cygwin, PCRE should build correctly using:
177    
178      ./configure && make && make install
179    
180    This should create two libraries called libpcre and libpcreposix, and, if you
181    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    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
237    
238  Dan Mooney sent the following comments about building PCRE on OpenVMS:  Dan Mooney sent the following comments about building PCRE on OpenVMS. They
239    relate to an older version of PCRE that used fewer source files, so the exact
240    commands will need changing. See the current list of source files above.
241    
242  "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
243  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 241  $!   Locale could not be set to fr Line 297  $!   Locale could not be set to fr
297  $!  $!
298  =========================  =========================
299    
300    Last Updated: 05 July 2007
301  ****  ****

Legend:
Removed from v.75  
changed lines
  Added in v.188

  ViewVC Help
Powered by ViewVC 1.1.5