/[pcre]/code/branches/pcre16/NON-UNIX-USE
ViewVC logotype

Diff of /code/branches/pcre16/NON-UNIX-USE

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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