/[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 134 by ph10, Mon Mar 26 16:00:17 2007 UTC revision 317 by ph10, Fri Jan 25 17:57:39 2008 UTC
# Line 7  This document contains the following sec Line 7  This document contains the following sec
7    Generic instructions for the PCRE C library    Generic instructions for the PCRE C library
8    The C++ wrapper functions    The C++ wrapper functions
9    Building for virtual Pascal    Building for virtual Pascal
10      Stack size in Windows environments
11      Linking programs in Windows environments
12    Comments about Win32 builds    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    Building under Windows with BCC5.5
17    Building PCRE on OpenVMS    Building PCRE on OpenVMS
18    
19    
20  GENERAL  GENERAL
21    
22  I (Philip Hazel) have no knowledge of Windows or VMS sytems and how their  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  libraries work. The items in the PCRE distribution and Makefile that relate to
24  anything other than Unix-like systems are untested by me.  anything other than Unix-like systems are untested by me.
25    
# Line 23  site that you may find useful. See Line 28  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  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
34  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++
35  library. The C++ wrapper functions are a separate issue (see below).  wrapper functions are a separate issue (see below).
36    
37    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    support for CMake, which some users prefer, in particular in Windows
40    environments. There are some instructions for CMake under Windows in the
41    section entitled "Building PCRE with CMake" below. CMake can also be used to
42    build PCRE in Unix-like systems.
43    
44    
45  GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY  GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
46    
47  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".
48    
49  (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
50      settings that it contains to whatever is appropriate for your environment.       settings that it contains to whatever is appropriate for your environment.
51      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
52      define the NEWLINE macro.       define the NEWLINE macro. When you compile any of the PCRE modules, you
53         must specify -DHAVE_CONFIG_H to your compiler so that config.h is included
54      An alternative approach is not to edit config.h, but to use -D on the       in the sources.
55      compiler command line to make any changes that you need.  
56         An alternative approach is not to edit config.h, but to use -D on the
57  (2) Copy or rename the file pcre.h.generic as pcre.h.       compiler command line to make any changes that you need to the
58         configuration options. In this case -DHAVE_CONFIG_H must not be set.
59  (3) EITHER:  
60        Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.       NOTE: There have been occasions when the way in which certain parameters
61         in config.h are used has changed between releases. (In the configure/make
62      OR:       world, this is handled automatically.) When upgrading to a new release,
63        Compile dftables.c as a stand-alone program, and then run it with the       you are strongly advised to review config.h.generic before re-using what
64        single argument "pcre_chartables.c". This generates a set of standard       you had previously.
65        character tables and writes them to that file. The tables are generated  
66        using the default C locale for your system. If you want to use a locale   (2) Copy or rename the file pcre.h.generic as pcre.h.
67        that is specified by LC_xxx environment variables, add the -L option to  
68        the dftables command. You must use this method if you are building on   (3) EITHER:
69        a system that uses EBCDIC code.         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
70    
71      The tables in pcre_chartables.c are defaults. The caller of PCRE can       OR:
72      specify alternative tables at run time.         Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
73           you have set up config.h), and then run it with the single argument
74  (4) Compile the following source files:         "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        pcre_chartables.c         C locale for your system. If you want to use a locale that is specified
77        pcre_compile.c         by LC_xxx environment variables, add the -L option to the dftables
78        pcre_config.c         command. You must use this method if you are building on a system that
79        pcre_dfa_exec.c         uses EBCDIC code.
80        pcre_exec.c  
81        pcre_fullinfo.c       The tables in pcre_chartables.c are defaults. The caller of PCRE can
82        pcre_get.c       specify alternative tables at run time.
83        pcre_globals.c  
84        pcre_info.c   (4) Ensure that you have the following header files:
85        pcre_maketables.c  
86        pcre_newline.c         pcre_internal.h
87        pcre_ord2utf8.c         ucp.h
88        pcre_refcount.c         ucpinternal.h
89        pcre_study.c         ucptable.h
90        pcre_tables.c  
91        pcre_try_flipped.c   (5) Also ensure that you have the following file, which is #included as source
92        pcre_ucp_searchfuncs.c       when building a debugging version of PCRE, and is also used by pcretest.
93        pcre_valid_utf8.c  
94        pcre_version.c         pcre_printint.src
95        pcre_xclass.c  
96     (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
97      Now link them all together into an object library in whichever form your       option if you have set up config.h with your configuration, or else use
98      system keeps such libraries. This is the basic PCRE C library. If your       other -D settings to change the configuration as required.
99      system has static and shared libraries, you may have to do this once for  
100      each type.         pcre_chartables.c
101           pcre_compile.c
102  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix         pcre_config.c
103      library.         pcre_dfa_exec.c
104           pcre_exec.c
105  (6) Compile the test program pcretest.c. This needs the functions in the         pcre_fullinfo.c
106      pcre and pcreposix libraries when linking.         pcre_get.c
107           pcre_globals.c
108  (7) Run pcretest on the testinput files in the testdata directory, and check         pcre_info.c
109      that the output matches the corresponding testoutput files. Note that the         pcre_maketables.c
110      supplied files are in Unix format, with just LF characters as line         pcre_newline.c
111      terminators. You may need to edit them to change this if your system uses a         pcre_ord2utf8.c
112      different convention.         pcre_refcount.c
113           pcre_study.c
114           pcre_tables.c
115           pcre_try_flipped.c
116           pcre_ucp_searchfuncs.c
117           pcre_valid_utf8.c
118           pcre_version.c
119           pcre_xclass.c
120    
121         Make sure that you include -I. in the compiler command (or equivalent for
122         an unusual compiler) so that all included PCRE header files are first
123         sought in the current directory. Otherwise you run the risk of picking up
124         a previously-installed file from somewhere else.
125    
126     (7) Now link all the compiled code into an object library in whichever form
127         your system keeps such libraries. This is the basic PCRE C library. If
128         your system has static and shared libraries, you may have to do this once
129         for each type.
130    
131     (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
132         and link the result (on its own) as the pcreposix library.
133    
134     (9) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
135         This needs the functions in the pcre and pcreposix libraries when linking.
136         It also needs the pcre_printint.src source file, which it #includes.
137    
138    (10) Run pcretest on the testinput files in the testdata directory, and check
139         that the output matches the corresponding testoutput files. Note that the
140         supplied files are in Unix format, with just LF characters as line
141         terminators. You may need to edit them to change this if your system uses
142         a different convention. If you are using Windows, you probably should use
143         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  (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
148      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).
149    
150    
151  THE C++ WRAPPER FUNCTIONS  THE C++ WRAPPER FUNCTIONS
# Line 118  BUILDING FOR VIRTUAL PASCAL Line 163  BUILDING FOR VIRTUAL PASCAL
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. Stefan Weber updated the script and added  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  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.  for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
167    
168    
169  COMMENTS ABOUT WIN32 BUILDS  STACK SIZE IN WINDOWS ENVIRONMENTS
170    
171  There are two ways of building PCRE on Windows systems: using MinGW or using  The default processor stack size of 1Mb in some Windows environments is too
172  Cygwin. These are not at all the same thing, and are completely different from  small for matching patterns that need much recursion. In particular, test 2 may
173  each other.  fail because of this. Normally, running out of stack causes a crash, but there
174    have been cases where the test program has just died silently. See your linker
175    documentation for how to increase stack size if you experience problems. The
176    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    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    
184    
185    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    COMMENTS ABOUT WIN32 BUILDS (see also "BUILDING PCRE WITH CMAKE" below)
194    
195    There are two ways of building PCRE using the "configure, make, make install"
196    paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
197    the same thing; they are completely different from each other. There is also
198    support for building using CMake, which some users find a more straightforward
199    way of building PCRE under Windows. However, the tests are not run
200    automatically when CMake is used.
201    
202  The MinGW home page (http://www.mingw.org/) says this:  The MinGW home page (http://www.mingw.org/) says this:
203    
# Line 150  On both MinGW and Cygwin, PCRE should bu Line 222  On both MinGW and Cygwin, PCRE should bu
222    
223    ./configure && make && make install    ./configure && make && make install
224    
225  However, if you want to statically link your program against the .a file, you  This should create two libraries called libpcre and libpcreposix, and, if you
226  must define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc()  have enabled building the C++ wrapper, a third one called libpcrecpp. These are
227  and pcre_free() exported functions will be declared __declspec(dllimport), with  independent libraries: when you like with libpcreposix or libpcrecpp you must
228  unwanted results.  also link with libpcre, which contains the basic functions. (Some earlier
229    releases of PCRE included the basic libpcre functions in libpcreposix. This no
230    longer happens.)
231    
232    A user submitted a special-purpose patch that makes it easy to create
233    "pcre.dll" under mingw32 using the "msys" environment. It provides "pcre.dll"
234    as a special target. If you use this target, no other files are built, and in
235    particular, the pcretest and pcregrep programs are not built. An example of how
236    this might be used is:
237    
238      ./configure --enable-utf --disable-cpp CFLAGS="-03 -s"; make pcre.dll
239    
240  Using Cygwin's compiler generates libraries and executables that depend on  Using Cygwin's compiler generates libraries and executables that depend on
241  cygwin1.dll. If a library that is generated this way is distributed,  cygwin1.dll. If a library that is generated this way is distributed,
# Line 181  gcc and MinGW's gcc). So, a user can: Line 263  gcc and MinGW's gcc). So, a user can:
263    
264  The test files that are supplied with PCRE are in Unix format, with LF  The test files that are supplied with PCRE are in Unix format, with LF
265  characters as line terminators. It may be necessary to change the line  characters as line terminators. It may be necessary to change the line
266  terminators in order to get some of the tests to work. We hope to improves  terminators in order to get some of the tests to work. We hope to improve
267  things in this area in future.  things in this area in future.
268    
269    
270    BUILDING PCRE ON WINDOWS WITH CMAKE
271    
272    CMake is an alternative build facility that can be used instead of the
273    traditional Unix "configure". CMake version 2.4.7 supports Borland makefiles,
274    MinGW makefiles, MSYS makefiles, NMake makefiles, UNIX makefiles, Visual Studio
275    6, Visual Studio 7, Visual Studio 8, and Watcom W8. The following instructions
276    were contributed by a PCRE user.
277    
278    1.  Download CMake 2.4.7 or above from http://www.cmake.org/, install and ensure
279        that cmake\bin is on your path.
280    
281    2.  Unzip (retaining folder structure) the PCRE source tree into a source
282        directory such as C:\pcre.
283    
284    3.  Create a new, empty build directory: C:\pcre\build\
285    
286    4.  Run CMakeSetup from the Shell envirornment of your build tool, e.g., Msys
287        for Msys/MinGW or Visual Studio Command Prompt for VC/VC++
288    
289    5.  Enter C:\pcre\pcre-xx and C:\pcre\build for the source and build
290        directories, respectively
291    
292    6.  Hit the "Configure" button.
293    
294    7.  Select the particular IDE / build tool that you are using (Visual Studio,
295        MSYS makefiles, MinGW makefiles, etc.)
296    
297    8.  The GUI will then list several configuration options. This is where you can
298        enable UTF-8 support, etc.
299    
300    9.  Hit "Configure" again. The adjacent "OK" button should now be active.
301    
302    10. Hit "OK".
303    
304    11. The build directory should now contain a usable build system, be it a
305        solution file for Visual Studio, makefiles for MinGW, etc.
306    
307    
308    USE OF RELATIVE PATHS WITH CMAKE ON WINDOWS
309    
310    A PCRE user comments as follows:
311    
312    I thought that others may want to know the current state of
313    CMAKE_USE_RELATIVE_PATHS support on Windows.
314    
315    Here it is:
316    -- AdditionalIncludeDirectories is only partially modified (only the
317    first path - see below)
318    -- Only some of the contained file paths are modified - shown below for
319    pcre.vcproj
320    -- It properly modifies
321    
322    I am sure CMake people can fix that if they want to. Until then one will
323    need to replace existing absolute paths in project files with relative
324    paths manually (e.g. from VS) - relative to project file location. I did
325    just that before being told to try CMAKE_USE_RELATIVE_PATHS. Not a big
326    deal.
327    
328    AdditionalIncludeDirectories="E:\builds\pcre\build;E:\builds\pcre\pcre-7.5;"
329    AdditionalIncludeDirectories=".;E:\builds\pcre\pcre-7.5;"
330    
331    RelativePath="pcre.h">
332    RelativePath="pcre_chartables.c">
333    RelativePath="pcre_chartables.c.rule">
334    
335    
336    TESTING WITH RUNTEST.BAT
337    
338    1. Copy RunTest.bat into the directory where pcretest.exe has been created.
339    
340    2. Edit RunTest.bat and insert a line that indentifies the relative location of
341       the pcre source, e.g.:
342    
343       set srcdir=..\pcre-7.4-RC3
344    
345    3. Run RunTest.bat from a command shell environment. Test outputs will
346       automatically be compared to expected results, and discrepancies will
347       identified in the console output.
348    
349    4. To test pcrecpp, run pcrecpp_unittest.exe, pcre_stringpiece_unittest.exe and
350       pcre_scanner_unittest.exe.
351    
352    
353  BUILDING UNDER WINDOWS WITH BCC5.5  BUILDING UNDER WINDOWS WITH BCC5.5
354    
355  Michael Roy sent these comments about building PCRE under Windows with BCC5.5:  Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
# Line 263  $! Locale could not be set to fr Line 428  $! Locale could not be set to fr
428  $!  $!
429  =========================  =========================
430    
431  Last Updated: 26 March 2007  Last Updated: 25 January 2008
432  ****  ****

Legend:
Removed from v.134  
changed lines
  Added in v.317

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12