/[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 111 by ph10, Thu Mar 8 16:53:09 2007 UTC revision 259 by ph10, Wed Sep 19 09:52:44 2007 UTC
# Line 1  Line 1 
1  Compiling PCRE on non-Unix systems  Compiling PCRE on non-Unix systems
2  ----------------------------------  ----------------------------------
3    
4  I (Philip Hazel) have no knowledge of Windows or VMS sytems and how their  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      Stack size in Windows environments
11      Comments about Win32 builds
12      Building PCRE with Cmake
13      Building under Windows with BCC5.5
14      Building PCRE on OpenVMS
15    
16    
17    GENERAL
18    
19    I (Philip Hazel) have no experience of Windows or VMS sytems and how their
20  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
21  anything other than Unix-like systems have been contributed by PCRE users and  anything other than Unix-like systems are untested by me.
 are untested by me.  
22    
23  There are some other comments and files in the Contrib directory on the ftp  There are some other comments and files in the Contrib directory on the ftp
24  site that you may find useful, although a lot of them are now out-of-date. See  site that you may find useful. See
25    
26    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
27    
28  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
29  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
30  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
31  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++
32  library. The C++ wrapper functions are a separate issue (see below).  wrapper functions are a separate issue (see below).
33    
34    The PCRE distribution contains some experimental support for "cmake", but this
35    is incomplete and not fully documented. However if you are a "cmake" user you
36    might like to try building with "cmake". There are some instructions in the
37    section entitled "Building PCRE with Cmake" below.
38    
39    
40  GENERIC INSTRUCTIONS FOR THE C LIBRARY  GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
41    
42  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".
43    
44  (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
45      settings that it contains to whatever is appropriate for your environment.       settings that it contains to whatever is appropriate for your environment.
46      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
47      define the NEWLINE macro.       define the NEWLINE macro. When you compile any of the PCRE modules, you
48         must specify -DHAVE_CONFIG_H to your compiler so that config.h is included
49      An alternative approach is not to edit config.h, but to use -D on the       in the sources.
50      compiler command line to make any changes that you need.  
51         An alternative approach is not to edit config.h, but to use -D on the
52  (2) Copy or rename the file pcre.h.generic to pcre.h.       compiler command line to make any changes that you need to the
53         configuration options. In this case -DHAVE_CONFIG_H must not be set.
54  (3) Compile dftables.c as a stand-alone program, and then run it with  
55      the single argument "pcre_chartables.c". This generates a set of standard       NOTE: There have been occasions when the way in which certain parameters
56      character tables and writes them to that file.       in config.h are used has changed between releases. (In the configure/make
57         world, this is handled automatically.) When upgrading to a new release,
58  (4) Compile the following source files:       you are strongly advised to review config.h.generic before re-using what
59         you had previously.
60        pcre_chartables.c  
61        pcre_compile.c   (2) Copy or rename the file pcre.h.generic as pcre.h.
62        pcre_config.c  
63        pcre_dfa_exec.c   (3) EITHER:
64        pcre_exec.c         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
65        pcre_fullinfo.c  
66        pcre_get.c       OR:
67        pcre_globals.c         Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
68        pcre_info.c         you have set up config.h), and then run it with the single argument
69        pcre_maketables.c         "pcre_chartables.c". This generates a set of standard character tables
70        pcre_newline.c         and writes them to that file. The tables are generated using the default
71        pcre_ord2utf8.c         C locale for your system. If you want to use a locale that is specified
72        pcre_refcount.c         by LC_xxx environment variables, add the -L option to the dftables
73        pcre_study.c         command. You must use this method if you are building on a system that
74        pcre_tables.c         uses EBCDIC code.
75        pcre_try_flipped.c  
76        pcre_ucp_searchfuncs.c       The tables in pcre_chartables.c are defaults. The caller of PCRE can
77        pcre_valid_utf8.c       specify alternative tables at run time.
78        pcre_version.c  
79        pcre_xclass.c   (4) Ensure that you have the following header files:
80    
81      Now link them all together into an object library in whichever form your         pcre_internal.h
82      system keeps such libraries. This is the basic PCRE C library. If your         ucp.h
83      system has static and shared libraries, you may have to do this once for         ucpinternal.h
84      each type.         ucptable.h
85    
86  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix   (5) Also ensure that you have the following file, which is #included as source
87      library.       when building a debugging version of PCRE and is also used by pcretest.
88    
89  (6) Compile the test program pcretest.c. This needs the functions in the         pcre_printint.src
90      pcre and pcreposix libraries when linking.  
91     (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
92  (7) Run pcretest on the testinput files in the testdata directory, and check       option if you have set up config.h with your configuration, or else use
93      that the output matches the corresponding testoutput files. Note that the       other -D settings to change the configuration as required.
94      supplied files are in Unix format, with just LF characters as line  
95      terminators. You may need to edit them to change this if your system uses a         pcre_chartables.c
96      different convention.         pcre_compile.c
97           pcre_config.c
98           pcre_dfa_exec.c
99           pcre_exec.c
100           pcre_fullinfo.c
101           pcre_get.c
102           pcre_globals.c
103           pcre_info.c
104           pcre_maketables.c
105           pcre_newline.c
106           pcre_ord2utf8.c
107           pcre_refcount.c
108           pcre_study.c
109           pcre_tables.c
110           pcre_try_flipped.c
111           pcre_ucp_searchfuncs.c
112           pcre_valid_utf8.c
113           pcre_version.c
114           pcre_xclass.c
115    
116         Make sure that you include -I. in the compiler command (or equivalent for
117         an unusual compiler) so that all included PCRE header files are first
118         sought in the current directory. Otherwise you run the risk of picking up
119         a previously-installed file from somewhere else.
120    
121     (7) Now link all the compiled code into an object library in whichever form
122         your system keeps such libraries. This is the basic PCRE C library. If
123         your system has static and shared libraries, you may have to do this once
124         for each type.
125    
126     (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
127         and link the result (on its own) as the pcreposix library.
128    
129     (9) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
130         This needs the functions in the pcre and pcreposix libraries when linking.
131         It also needs the pcre_printint.src source file, which it #includes.
132    
133    (10) Run pcretest on the testinput files in the testdata directory, and check
134         that the output matches the corresponding testoutput files. Note that the
135         supplied files are in Unix format, with just LF characters as line
136         terminators. You may need to edit them to change this if your system uses
137         a different convention. If you are using Windows, you probably should use
138         the wintestinput3 file instead of testinput3 (and the corresponding output
139         file). This is a locale test; wintestinput3 sets the locale to "french"
140         rather than "fr_FR", and there some minor output differences.
141    
142  (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
143      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).
144    
145    
146  THE C++ WRAPPER FUNCTIONS  THE C++ WRAPPER FUNCTIONS
# Line 92  xxx.cc files. Line 155  xxx.cc files.
155    
156  BUILDING FOR VIRTUAL PASCAL  BUILDING FOR VIRTUAL PASCAL
157    
158  Stefan Weber contributed the following files in the distribution for building  A script for building PCRE using Borland's C++ compiler for use with VPASCAL
159  PCRE for use with VP/Borland: !compile.txt, !linklib.txt, makevp.bat,  was contributed by Alexander Tokarev. Stefan Weber updated the script and added
160  pcregexp.pas.  additional files. The following files in the distribution are for building PCRE
161    for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
162    
163    
164  BUILDING UNDER WINDOWS WITH BCC5.5  STACK SIZE IN WINDOWS ENVIRONMENTS
165    
166  Michael Roy sent these comments about building PCRE under Windows with BCC5.5:  The default processor stack size of 1Mb in some Windows environments is too
167    small for matching patterns that need much recursion. In particular, test 2 may
168    fail because of this. Normally, running out of stack causes a crash, but there
169    have been cases where the test program has just died silently. See your linker
170    documentation for how to increase stack size if you experience problems. The
171    Linux default of 8Mb is a reasonable choice for the stack, though even that can
172    be too small for some pattern/subject combinations. There is more about stack
173    usage in the "pcrestack" documentation.
174    
   Some of the core BCC libraries have a version of PCRE from 1998 built in,  
   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:  
175    
176    When linking a project with BCC5.5, pcre.lib must be included before any of  COMMENTS ABOUT WIN32 BUILDS
   the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command  
   line.  
177    
178    There are two ways of building PCRE using the "configure, make, make install"
179    paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
180    the same thing; they are completely different from each other. There is also
181    some experimental, undocumented support for building using "cmake", which you
182    might like to try if you are familiar with "cmake". However, at the present
183    time, the "cmake" process builds only a static library (not a dll), and the
184    tests are not automatically run.
185    
186  OUT-OF-DATE COMMENTS ABOUT WIN32 BUILDS  The MinGW home page (http://www.mingw.org/) says this:
187    
188  [These comments need looking at by someone who knows about Windows.]    MinGW: A collection of freely available and freely distributable Windows
189      specific header files and import libraries combined with GNU toolsets that
190      allow one to produce native Windows programs that do not rely on any
191      3rd-party C runtime DLLs.
192    
193  Some help in building a Win32 DLL of PCRE in GnuWin32 environments was  The Cygwin home page (http://www.cygwin.com/) 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.  
194    
195  A script for building PCRE using Borland's C++ compiler for use with VPASCAL    Cygwin is a Linux-like environment for Windows. It consists of two parts:
 was contributed by Alexander Tokarev. It is called makevp.bat.  
196    
197  These are some further comments about Win32 builds from Mark Evans. They    . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
198  were contributed before Fred Cox's changes were made, so it is possible that      substantial Linux API functionality
 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.)"  
199    
200  =========================    . A collection of tools which provide Linux look and feel.
 #ifdef _WIN32  
 #include <malloc.h>  
201    
202  void* malloc_stub(size_t N)    The Cygwin DLL currently works with all recent, commercially released x86 32
203  { return malloc(N); }    bit and 64 bit versions of Windows, with the exception of Windows CE.
 void free_stub(void* p)  
 { free(p); }  
 void *(*pcre_malloc)(size_t) = &malloc_stub;  
 void  (*pcre_free)(void *) = &free_stub;  
204    
205  #else  On both MinGW and Cygwin, PCRE should build correctly using:
206    
207  void *(*pcre_malloc)(size_t) = malloc;    ./configure && make && make install
 void  (*pcre_free)(void *) = free;  
208    
209  #endif  This should create two libraries called libpcre and libpcreposix, and, if you
210  =========================  have enabled building the C++ wrapper, a third one called libpcrecpp. These are
211    independent libraries: when you like with libpcreposix or libpcrecpp you must
212    also link with libpcre, which contains the basic functions. (Some earlier
213    releases of PCRE included the basic libpcre functions in libpcreposix. This no
214    longer happens.)
215    
216    If you want to statically link your program against a non-dll .a file, you must
217    define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
218    pcre_free() exported functions will be declared __declspec(dllimport), with
219    unwanted results.
220    
221    Using Cygwin's compiler generates libraries and executables that depend on
222    cygwin1.dll. If a library that is generated this way is distributed,
223    cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
224    licence, this forces not only PCRE to be under the GPL, but also the entire
225    application. A distributor who wants to keep their own code proprietary must
226    purchase an appropriate Cygwin licence.
227    
228    MinGW has no such restrictions. The MinGW compiler generates a library or
229    executable that can run standalone on Windows without any third party dll or
230    licensing issues.
231    
232    But there is more complication:
233    
234    If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
235    to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
236    front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
237    gcc and MinGW's gcc). So, a user can:
238    
239    . Build native binaries by using MinGW or by getting Cygwin and using
240      -mno-cygwin.
241    
242    . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
243      compiler flags.
244    
245    The test files that are supplied with PCRE are in Unix format, with LF
246    characters as line terminators. It may be necessary to change the line
247    terminators in order to get some of the tests to work. We hope to improve
248    things in this area in future.
249    
250    
251    BUILDING PCRE WITH CMAKE
252    
253    These instructions were contributed by a PCRE user.
254    
255    1. Download CMake 2.4.7 or above from http://www.cmake.org/, install and ensure
256       that cmake\bin is on your path.
257    
258    2. Unzip (retaining folder structure) the PCRE source tree into a source
259       directory such as C:\pcre.
260    
261    3. Create a new, empty build directory: C:\pcre\build\
262    
263    4. Run CMakeSetup from the Shell envirornment of your build tool, e.g., Msys
264       for Msys/MinGW or Visual Studio Command Prompt for VC/VC++
265    
266    5. Enter C:\pcre\pcre-xx and C:\pcre\build for the source and build
267       directories, respectively
268    
269    6. Hit the "Configure" button.
270    
271    7. Select the particular IDE / build tool that you are using (Visual Studio,
272       MSYS makefiles, MinGW makefiles, etc.)
273    
274    8. The GUI will then list several configuration options. This is where you can
275       enable UTF-8 support, etc.
276    
277    9. Hit "Configure" again. The adjacent "OK" button should now be active.
278    
279    10. Hit "OK".
280    
281    11. The build directory should now contain a usable build system, be it a
282        solution file for Visual Studio, makefiles for MinGW, etc.
283    
284    Testing with RunTest.bat
285    
286    1. Copy RunTest.bat into the directory where pcretest.exe has been created.
287    
288    2. Edit RunTest.bat and insert a line that indentifies the relative location of
289       the pcre source, e.g.:
290    
291       set srcdir=..\pcre-7.4-RC3
292    
293    3. Run RunTest.bat from a command shell environment. Test outputs will
294       automatically be compared to expected results, and discrepancies will
295       identified in the console output.
296    
297    4. To test pcrecpp, run pcrecpp_unittest.exe, pcre_stringpiece_unittest.exe and
298       pcre_scanner_unittest.exe.
299    
300    
301    BUILDING UNDER WINDOWS WITH BCC5.5
302    
303    Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
304    
305      Some of the core BCC libraries have a version of PCRE from 1998 built in,
306      which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
307      version mismatch. I'm including an easy workaround below, if you'd like to
308      include it in the non-unix instructions:
309    
310      When linking a project with BCC5.5, pcre.lib must be included before any of
311      the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
312      line.
313    
314    
315  BUILDING PCRE ON OPENVMS  BUILDING PCRE ON OPENVMS
# Line 246  $! Locale could not be set to fr Line 376  $! Locale could not be set to fr
376  $!  $!
377  =========================  =========================
378    
379    Last Updated: 17 September 2007
380  ****  ****

Legend:
Removed from v.111  
changed lines
  Added in v.259

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12