/[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 260 by ph10, Thu Sep 20 10:19:16 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 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
21    anything other than Unix-like systems are untested by me.
22    
23    There are some other comments and files in the Contrib directory on the ftp
24    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  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
31  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++
32    wrapper functions are a separate issue (see below).
33    
34  GENERIC INSTRUCTIONS  The PCRE distribution includes support for CMake. This support is relatively
35    new, but has already been used successfully to build PCRE in multiple build
36  The following are generic comments about building PCRE. The interspersed  environments on Windows. There are some instructions in the section entitled
37  indented commands are suggestions from Mark Tetrode as to which commands you  "Building PCRE with CMake" below.
38  might use on a Windows system to build a static library.  
39    
40  (1) Copy or rename the file config.in as config.h, and change the macros that  GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
41  define HAVE_STRERROR and HAVE_MEMMOVE to define them as 1 rather than 0.  
42  Unfortunately, because of the way Unix autoconf works, the default setting has  The following are generic comments about building the PCRE C library "by hand".
43  to be 0. You may also want to make changes to other macros in config.h. In  
44  particular, if you want to force a specific value for newline, you can define   (1) Copy or rename the file config.h.generic as config.h, and edit the macro
45  the NEWLINE macro. The default is to use '\n', thereby using whatever value       settings that it contains to whatever is appropriate for your environment.
46  your compiler gives to '\n'.       In particular, if you want to force a specific value for newline, you can
47         define the NEWLINE macro. When you compile any of the PCRE modules, you
48    rem Mark Tetrode's commands       must specify -DHAVE_CONFIG_H to your compiler so that config.h is included
49    copy config.in config.h       in the sources.
50    rem Use write, because notepad cannot handle UNIX files. Change values.  
51    write config.h       An alternative approach is not to edit config.h, but to use -D on the
52         compiler command line to make any changes that you need to the
53  (2) Copy or rename the file pcre.in as pcre.h, and change the macro definitions       configuration options. In this case -DHAVE_CONFIG_H must not be set.
54  for PCRE_MAJOR, PCRE_MINOR, and PCRE_DATE near its start to the values set in  
55  configure.in.       NOTE: There have been occasions when the way in which certain parameters
56         in config.h are used has changed between releases. (In the configure/make
57    rem Mark Tetrode's commands       world, this is handled automatically.) When upgrading to a new release,
58    copy pcre.in pcre.h       you are strongly advised to review config.h.generic before re-using what
59    rem Read values from configure.in       you had previously.
60    write configure.in  
61    rem Change values   (2) Copy or rename the file pcre.h.generic as pcre.h.
62    write pcre.h  
63     (3) EITHER:
64  (3) Compile dftables.c as a stand-alone program, and then run it with         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
65  the single argument "chartables.c". This generates a set of standard  
66  character tables and writes them to that file.       OR:
67           Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
68    rem Mark Tetrode's commands         you have set up config.h), and then run it with the single argument
69    rem Compile & run         "pcre_chartables.c". This generates a set of standard character tables
70    cl -DSUPPORT_UTF8 -DSUPPORT_UCP dftables.c         and writes them to that file. The tables are generated using the default
71    dftables.exe chartables.c         C locale for your system. If you want to use a locale that is specified
72           by LC_xxx environment variables, add the -L option to the dftables
73  (4) Compile maketables.c, get.c, study.c and pcre.c and link them all         command. You must use this method if you are building on a system that
74  together into an object library in whichever form your system keeps such         uses EBCDIC code.
75  libraries. This is the pcre library (chartables.c is included by means of an  
76  #include directive). If your system has static and shared libraries, you may       The tables in pcre_chartables.c are defaults. The caller of PCRE can
77  have to do this once for each type.       specify alternative tables at run time.
78    
79    rem Mark Tetrode's commands, for a static library   (4) Ensure that you have the following header files:
80    rem Compile & lib  
81    cl -DSUPPORT_UTF8 -DSUPPORT_UCP -DPOSIX_MALLOC_THRESHOLD=10 /c maketables.c get.c study.c pcre.c         pcre_internal.h
82    lib /OUT:pcre.lib maketables.obj get.obj study.obj pcre.obj         ucp.h
83           ucpinternal.h
84  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix         ucptable.h
85  library.  
86     (5) Also ensure that you have the following file, which is #included as source
87    rem Mark Tetrode's commands, for a static library       when building a debugging version of PCRE and is also used by pcretest.
88    rem Compile & lib  
89    cl -DSUPPORT_UTF8 -DSUPPORT_UCP -DPOSIX_MALLOC_THRESHOLD=10 /c pcreposix.c         pcre_printint.src
90    lib /OUT:pcreposix.lib pcreposix.obj  
91     (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
92  (6) Compile the test program pcretest.c. This needs the functions in the       option if you have set up config.h with your configuration, or else use
93  pcre and pcreposix libraries when linking.       other -D settings to change the configuration as required.
94    
95    rem Mark Tetrode's commands         pcre_chartables.c
96    rem compile & link         pcre_compile.c
97    cl /F0x400000 pcretest.c pcre.lib pcreposix.lib         pcre_config.c
98           pcre_dfa_exec.c
99  (7) Run pcretest on the testinput files in the testdata directory, and check         pcre_exec.c
100  that the output matches the corresponding testoutput files. You must use the         pcre_fullinfo.c
101  -i option when checking testinput2. Note that the supplied files are in Unix         pcre_get.c
102  format, with just LF characters as line terminators. You may need to edit them         pcre_globals.c
103  to change this if your system uses a different convention.         pcre_info.c
104           pcre_maketables.c
105    rem Mark Tetrode's commands         pcre_newline.c
106    pcretest testdata\testinput1 testdata\myoutput1         pcre_ord2utf8.c
107    windiff testdata\testoutput1 testdata\myoutput1         pcre_refcount.c
108    pcretest -i testdata\testinput2 testdata\myoutput2         pcre_study.c
109    windiff testdata\testoutput2 testdata\myoutput2         pcre_tables.c
110    pcretest testdata\testinput3 testdata\myoutput3         pcre_try_flipped.c
111    windiff testdata\testoutput3 testdata\myoutput3         pcre_ucp_searchfuncs.c
112    pcretest testdata\testinput4 testdata\myoutput4         pcre_valid_utf8.c
113    windiff testdata\testoutput4 testdata\myoutput4         pcre_version.c
114    pcretest testdata\testinput5 testdata\myoutput5         pcre_xclass.c
115    windiff testdata\testoutput5 testdata\myoutput5  
116    pcretest testdata\testinput6 testdata\myoutput6       Make sure that you include -I. in the compiler command (or equivalent for
117    windiff testdata\testoutput6 testdata\myoutput6       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  FURTHER REMARKS  
121     (7) Now link all the compiled code into an object library in whichever form
122  If you have a system without "configure" but where you can use a Makefile, edit       your system keeps such libraries. This is the basic PCRE C library. If
123  Makefile.in to create Makefile, substituting suitable values for the variables       your system has static and shared libraries, you may have to do this once
124  at the head of the file.       for each type.
125    
126  Some help in building a Win32 DLL of PCRE in GnuWin32 environments was   (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
127  contributed by Paul Sokolovsky. These environments are Mingw32       and link the result (on its own) as the pcreposix library.
128  (http://www.xraylith.wisc.edu/~khan/software/gnu-win32/) and CygWin  
129  (http://sourceware.cygnus.com/cygwin/). Paul comments:   (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    For CygWin, set CFLAGS=-mno-cygwin, and do 'make dll'. You'll get       It also needs the pcre_printint.src source file, which it #includes.
132    pcre.dll (containing pcreposix also), libpcre.dll.a, and dynamically  
133    linked pgrep and pcretest. If you have /bin/sh, run RunTest (three  (10) Run pcretest on the testinput files in the testdata directory, and check
134    main test go ok, locale not supported).       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  Changes to do MinGW with autoconf 2.50 were supplied by Fred Cox       terminators. You may need to edit them to change this if your system uses
137  <sailorFred@yahoo.com>, who comments as follows:       a different convention. If you are using Windows, you probably should use
138         the wintestinput3 file instead of testinput3 (and the corresponding output
139    If you are using the PCRE DLL, the normal Unix style configure && make &&       file). This is a locale test; wintestinput3 sets the locale to "french"
140    make check && make install should just work[*]. If you want to statically       rather than "fr_FR", and there some minor output differences.
141    link against the .a file, you must define PCRE_STATIC before including  
142    pcre.h, otherwise the pcre_malloc and pcre_free exported functions will be  (11) If you want to use the pcregrep command, compile and link pcregrep.c; it
143    declared __declspec(dllimport), with hilarious results.  See the configure.in       uses only the basic PCRE library (it does not need the pcreposix library).
144    and pcretest.c for how it is done for the static test.  
145    
146    Also, there will only be a libpcre.la, not a libpcreposix.la, as you  THE C++ WRAPPER FUNCTIONS
147    would expect from the Unix version. The single DLL includes the pcreposix  
148    interface.  The PCRE distribution also contains some C++ wrapper functions and tests,
149    contributed by Google Inc. On a system that can use "configure" and "make",
150  [*] But note that the supplied test files are in Unix format, with just LF  the functions are automatically built into a library called pcrecpp. It should
151  characters as line terminators. You will have to edit them to change to CR LF  be straightforward to compile the .cc files manually on other systems. The
152  terminators.  files called xxx_unittest.cc are test programs for each of the corresponding
153    xxx.cc files.
154    
155    
156    BUILDING FOR VIRTUAL PASCAL
157    
158  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
159  was contributed by Alexander Tokarev. It is called makevp.bat.  was contributed by Alexander Tokarev. Stefan Weber updated the script and added
160    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    
 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.)"  
163    
164  =========================  STACK SIZE IN WINDOWS ENVIRONMENTS
 #ifdef _WIN32  
 #include <malloc.h>  
165    
166  void* malloc_stub(size_t N)  The default processor stack size of 1Mb in some Windows environments is too
167  { return malloc(N); }  small for matching patterns that need much recursion. In particular, test 2 may
168  void free_stub(void* p)  fail because of this. Normally, running out of stack causes a crash, but there
169  { free(p); }  have been cases where the test program has just died silently. See your linker
170  void *(*pcre_malloc)(size_t) = &malloc_stub;  documentation for how to increase stack size if you experience problems. The
171  void  (*pcre_free)(void *) = &free_stub;  Linux default of 8Mb is a reasonable choice for the stack, though even that can
172    be too small for some pattern/subject combinations.
173    
174  #else  PCRE has a compile configuration option to disable the use of stack for
175    recursion so that heap is used instead. However, pattern matching is
176    significantly slower when this is done. There is more about stack usage in the
177    "pcrestack" documentation.
178    
 void *(*pcre_malloc)(size_t) = malloc;  
 void  (*pcre_free)(void *) = free;  
179    
180  #endif  COMMENTS ABOUT WIN32 BUILDS (see also "BUILDING PCRE WITH CMAKE" below)
181  =========================  
182    There are two ways of building PCRE using the "configure, make, make install"
183    paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
184    the same thing; they are completely different from each other. There is also
185    some experimental, undocumented support for building using "cmake", which you
186    might like to try if you are familiar with "cmake". However, at the present
187    time, the "cmake" process builds only a static library (not a dll), and the
188    tests are not automatically run.
189    
190    The MinGW home page (http://www.mingw.org/) says this:
191    
192      MinGW: A collection of freely available and freely distributable Windows
193      specific header files and import libraries combined with GNU toolsets that
194      allow one to produce native Windows programs that do not rely on any
195      3rd-party C runtime DLLs.
196    
197    The Cygwin home page (http://www.cygwin.com/) says this:
198    
199      Cygwin is a Linux-like environment for Windows. It consists of two parts:
200    
201      . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
202        substantial Linux API functionality
203    
204      . A collection of tools which provide Linux look and feel.
205    
206      The Cygwin DLL currently works with all recent, commercially released x86 32
207      bit and 64 bit versions of Windows, with the exception of Windows CE.
208    
209    On both MinGW and Cygwin, PCRE should build correctly using:
210    
211      ./configure && make && make install
212    
213    This should create two libraries called libpcre and libpcreposix, and, if you
214    have enabled building the C++ wrapper, a third one called libpcrecpp. These are
215    independent libraries: when you like with libpcreposix or libpcrecpp you must
216    also link with libpcre, which contains the basic functions. (Some earlier
217    releases of PCRE included the basic libpcre functions in libpcreposix. This no
218    longer happens.)
219    
220    If you want to statically link your program against a non-dll .a file, you must
221    define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
222    pcre_free() exported functions will be declared __declspec(dllimport), with
223    unwanted results.
224    
225    Using Cygwin's compiler generates libraries and executables that depend on
226    cygwin1.dll. If a library that is generated this way is distributed,
227    cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
228    licence, this forces not only PCRE to be under the GPL, but also the entire
229    application. A distributor who wants to keep their own code proprietary must
230    purchase an appropriate Cygwin licence.
231    
232    MinGW has no such restrictions. The MinGW compiler generates a library or
233    executable that can run standalone on Windows without any third party dll or
234    licensing issues.
235    
236    But there is more complication:
237    
238    If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
239    to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
240    front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
241    gcc and MinGW's gcc). So, a user can:
242    
243    . Build native binaries by using MinGW or by getting Cygwin and using
244      -mno-cygwin.
245    
246    . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
247      compiler flags.
248    
249    The test files that are supplied with PCRE are in Unix format, with LF
250    characters as line terminators. It may be necessary to change the line
251    terminators in order to get some of the tests to work. We hope to improve
252    things in this area in future.
253    
254    
255    BUILDING PCRE WITH CMAKE
256    
257    CMake is an alternative build facility that can be used instead of the
258    traditional Unix "configure". CMake version 2.4.7 supports Borland makefiles,
259    MinGW makefiles, MSYS makefiles, NMake makefiles, UNIX makefiles, Visual Studio
260    6, Visual Studio 7, Visual Studio 8, and Watcom W8. The following instructions
261    were contributed by a PCRE user.
262    
263    1. Download CMake 2.4.7 or above from http://www.cmake.org/, install and ensure
264       that cmake\bin is on your path.
265    
266    2. Unzip (retaining folder structure) the PCRE source tree into a source
267       directory such as C:\pcre.
268    
269    3. Create a new, empty build directory: C:\pcre\build\
270    
271    4. Run CMakeSetup from the Shell envirornment of your build tool, e.g., Msys
272       for Msys/MinGW or Visual Studio Command Prompt for VC/VC++
273    
274    5. Enter C:\pcre\pcre-xx and C:\pcre\build for the source and build
275       directories, respectively
276    
277    6. Hit the "Configure" button.
278    
279    7. Select the particular IDE / build tool that you are using (Visual Studio,
280       MSYS makefiles, MinGW makefiles, etc.)
281    
282    8. The GUI will then list several configuration options. This is where you can
283       enable UTF-8 support, etc.
284    
285    9. Hit "Configure" again. The adjacent "OK" button should now be active.
286    
287    10. Hit "OK".
288    
289    11. The build directory should now contain a usable build system, be it a
290        solution file for Visual Studio, makefiles for MinGW, etc.
291    
292    Testing with RunTest.bat
293    
294    1. Copy RunTest.bat into the directory where pcretest.exe has been created.
295    
296    2. Edit RunTest.bat and insert a line that indentifies the relative location of
297       the pcre source, e.g.:
298    
299       set srcdir=..\pcre-7.4-RC3
300    
301    3. Run RunTest.bat from a command shell environment. Test outputs will
302       automatically be compared to expected results, and discrepancies will
303       identified in the console output.
304    
305    4. To test pcrecpp, run pcrecpp_unittest.exe, pcre_stringpiece_unittest.exe and
306       pcre_scanner_unittest.exe.
307    
308    
309    BUILDING UNDER WINDOWS WITH BCC5.5
310    
311    Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
312    
313      Some of the core BCC libraries have a version of PCRE from 1998 built in,
314      which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
315      version mismatch. I'm including an easy workaround below, if you'd like to
316      include it in the non-unix instructions:
317    
318      When linking a project with BCC5.5, pcre.lib must be included before any of
319      the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
320      line.
321    
322    
323  BUILDING PCRE ON OPENVMS  BUILDING PCRE ON OPENVMS
324    
325  Dan Mooney sent the following comments about building PCRE on OpenVMS:  Dan Mooney sent the following comments about building PCRE on OpenVMS. They
326    relate to an older version of PCRE that used fewer source files, so the exact
327    commands will need changing. See the current list of source files above.
328    
329  "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
330  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 384  $!   Locale could not be set to fr
384  $!  $!
385  =========================  =========================
386    
387    Last Updated: 21 September 2007
388  ****  ****

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

  ViewVC Help
Powered by ViewVC 1.1.5