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

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

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12