/[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 188 by ph10, Thu Jul 5 11:49:44 2007 UTC revision 392 by ph10, Tue Mar 17 21:30:30 2009 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 29  library consists entirely of code writte Line 34  library consists entirely of code writte
34  successfully on any system that has a Standard C compiler and library. The C++  successfully on any system that has a Standard C compiler and library. The C++
35  wrapper functions are a separate issue (see below).  wrapper functions are a separate issue (see below).
36    
37  The PCRE distribution contains some experimental support for "cmake", but this  The PCRE distribution includes a "configure" file for use by the Configure/Make
38  is incomplete and not documented. However if you are a "cmake" user you might  build system, as found in many Unix-like environments. There is also support
39  like to try building with "cmake".  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
# Line 41  The following are generic comments about Line 49  The following are generic comments about
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         in the sources.
55    
56       An alternative approach is not to edit config.h, but to use -D on the       An alternative approach is not to edit config.h, but to use -D on the
57       compiler command line to make any changes that you need.       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    
60       NOTE: There have been occasions when the way in which certain parameters       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       in config.h are used has changed between releases. (In the configure/make
62       world, this is handled automatically.) When upgrading to a new release,       world, this is handled automatically.) When upgrading to a new release,
63       you are strongly advised to review config.h.generic before re-using what       you are strongly advised to review config.h.generic before re-using what
64       you had previously.       you had previously.
65    
66   (2) Copy or rename the file pcre.h.generic as pcre.h.   (2) Copy or rename the file pcre.h.generic as pcre.h.
67    
68   (3) EITHER:   (3) EITHER:
69         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
70    
71       OR:       OR:
72         Compile dftables.c as a stand-alone program, and then run it with the         Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
73         single argument "pcre_chartables.c". This generates a set of standard         you have set up config.h), and then run it with the single argument
74         character tables and writes them to that file. The tables are generated         "pcre_chartables.c". This generates a set of standard character tables
75         using the default C locale for your system. If you want to use a locale         and writes them to that file. The tables are generated using the default
76         that is specified by LC_xxx environment variables, add the -L option to         C locale for your system. If you want to use a locale that is specified
77         the dftables command. You must use this method if you are building on         by LC_xxx environment variables, add the -L option to the dftables
78         a system that uses EBCDIC code.         command. You must use this method if you are building on a system that
79           uses EBCDIC code.
80    
81       The tables in pcre_chartables.c are defaults. The caller of PCRE can       The tables in pcre_chartables.c are defaults. The caller of PCRE can
82       specify alternative tables at run time.       specify alternative tables at run time.
83    
84   (4) Ensure that you have the following header files:   (4) Ensure that you have the following header files:
85    
86         pcre_internal.h         pcre_internal.h
87         ucp.h         ucp.h
88         ucpinternal.h  
        ucptable.h  
   
89   (5) Also ensure that you have the following file, which is #included as source   (5) Also ensure that you have the following file, which is #included as source
90       when building a debugging version of PCRE and is also used by pcretest.       when building a debugging version of PCRE, and is also used by pcretest.
91    
92         pcre_printint.src         pcre_printint.src
93    
94   (6) Compile the following source files:   (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
95         option if you have set up config.h with your configuration, or else use
96         other -D settings to change the configuration as required.
97    
98         pcre_chartables.c         pcre_chartables.c
99         pcre_compile.c         pcre_compile.c
100         pcre_config.c         pcre_config.c
# Line 99  The following are generic comments about Line 111  The following are generic comments about
111         pcre_study.c         pcre_study.c
112         pcre_tables.c         pcre_tables.c
113         pcre_try_flipped.c         pcre_try_flipped.c
114         pcre_ucp_searchfuncs.c         pcre_ucd.c
115         pcre_valid_utf8.c         pcre_valid_utf8.c
116         pcre_version.c         pcre_version.c
117         pcre_xclass.c         pcre_xclass.c
118    
119         Make sure that you include -I. in the compiler command (or equivalent for
120         an unusual compiler) so that all included PCRE header files are first
121         sought in the current directory. Otherwise you run the risk of picking up
122         a previously-installed file from somewhere else.
123    
124   (7) Now link all the compiled code into an object library in whichever form   (7) Now link all the compiled code into an object library in whichever form
125       your system keeps such libraries. This is the basic PCRE C library. If       your system keeps such libraries. This is the basic PCRE C library. If
126       your system has static and shared libraries, you may have to do this once       your system has static and shared libraries, you may have to do this once
127       for each type.       for each type.
128    
129   (8) Similarly, compile pcreposix.c and link the result (on its own) as the   (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
130       pcreposix library.       and link the result (on its own) as the pcreposix library.
131    
132   (9) Compile the test program pcretest.c. This needs the functions in the   (9) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
133       pcre and pcreposix libraries when linking. It also needs the       This needs the functions in the pcre and pcreposix libraries when linking.
134       pcre_printint.src source file, which it #includes.       It also needs the pcre_printint.src source file, which it #includes.
135    
136  (10) Run pcretest on the testinput files in the testdata directory, and check  (10) Run pcretest on the testinput files in the testdata directory, and check
137       that the output matches the corresponding testoutput files. Note that the       that the output matches the corresponding testoutput files. Note that the
138       supplied files are in Unix format, with just LF characters as line       supplied files are in Unix format, with just LF characters as line
139       terminators. You may need to edit them to change this if your system uses       terminators. You may need to edit them to change this if your system uses
140       a different convention.       a different convention. If you are using Windows, you probably should use
141         the wintestinput3 file instead of testinput3 (and the corresponding output
142         file). This is a locale test; wintestinput3 sets the locale to "french"
143         rather than "fr_FR", and there some minor output differences.
144    
145  (11) 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
146       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).
# Line 144  additional files. The following files in Line 164  additional files. The following files in
164  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.
165    
166    
167  COMMENTS ABOUT WIN32 BUILDS  STACK SIZE IN WINDOWS ENVIRONMENTS
168    
169    The default processor stack size of 1Mb in some Windows environments is too
170    small for matching patterns that need much recursion. In particular, test 2 may
171    fail because of this. Normally, running out of stack causes a crash, but there
172    have been cases where the test program has just died silently. See your linker
173    documentation for how to increase stack size if you experience problems. The
174    Linux default of 8Mb is a reasonable choice for the stack, though even that can
175    be too small for some pattern/subject combinations.
176    
177    PCRE has a compile configuration option to disable the use of stack for
178    recursion so that heap is used instead. However, pattern matching is
179    significantly slower when this is done. There is more about stack usage in the
180    "pcrestack" documentation.
181    
182    
183    LINKING PROGRAMS IN WINDOWS ENVIRONMENTS
184    
185    If you want to statically link a program against a PCRE library in the form of
186    a non-dll .a file, you must define PCRE_STATIC before including pcre.h,
187    otherwise the pcre_malloc() and pcre_free() exported functions will be declared
188    __declspec(dllimport), with unwanted results.
189    
190    
191    CALLING CONVENTIONS IN WINDOWS ENVIRONMENTS
192    
193    It is possible to compile programs to use different calling conventions using
194    MSVC. Search the web for "calling conventions" for more information. To make it
195    easier to change the calling convention for the exported functions in the
196    PCRE library, the macro PCRE_CALL_CONVENTION is present in all the external
197    definitions. It can be set externally when compiling (e.g. in CFLAGS). If it is
198    not set, it defaults to empty; the default calling convention is then used
199    (which is what is wanted most of the time).
200    
201    
202    COMMENTS ABOUT WIN32 BUILDS (see also "BUILDING PCRE WITH CMAKE" below)
203    
204  There are two ways of building PCRE using the "configure, make, make install"  There are two ways of building PCRE using the "configure, make, make install"
205  paradigm on Windows systems: using MinGW or using Cygwin. These are not at all  paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
206  the same thing; they are completely different from each other. There is also  the same thing; they are completely different from each other. There is also
207  some experimental, undocumented support for building using "cmake", which you  support for building using CMake, which some users find a more straightforward
208  might like to try if you are familiar with "cmake". However, at the present  way of building PCRE under Windows. However, the tests are not run
209  time, the "cmake" process builds only a static library (not a dll), and the  automatically when CMake is used.
 tests are not automatically run.  
210    
211  The MinGW home page (http://www.mingw.org/) says this:  The MinGW home page (http://www.mingw.org/) says this:
212    
# Line 184  also link with libpcre, which contains t Line 238  also link with libpcre, which contains t
238  releases of PCRE included the basic libpcre functions in libpcreposix. This no  releases of PCRE included the basic libpcre functions in libpcreposix. This no
239  longer happens.)  longer happens.)
240    
241  If you want to statically link your program against a non-dll .a file, you must  A user submitted a special-purpose patch that makes it easy to create
242  define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and  "pcre.dll" under mingw32 using the "msys" environment. It provides "pcre.dll"
243  pcre_free() exported functions will be declared __declspec(dllimport), with  as a special target. If you use this target, no other files are built, and in
244  unwanted results.  particular, the pcretest and pcregrep programs are not built. An example of how
245    this might be used is:
246    
247      ./configure --enable-utf --disable-cpp CFLAGS="-03 -s"; make pcre.dll
248    
249  Using Cygwin's compiler generates libraries and executables that depend on  Using Cygwin's compiler generates libraries and executables that depend on
250  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 219  terminators in order to get some of the Line 276  terminators in order to get some of the
276  things in this area in future.  things in this area in future.
277    
278    
279    BUILDING PCRE ON WINDOWS WITH CMAKE
280    
281    CMake is an alternative build facility that can be used instead of the
282    traditional Unix "configure". CMake version 2.4.7 supports Borland makefiles,
283    MinGW makefiles, MSYS makefiles, NMake makefiles, UNIX makefiles, Visual Studio
284    6, Visual Studio 7, Visual Studio 8, and Watcom W8. The following instructions
285    were contributed by a PCRE user.
286    
287    1.  Download CMake 2.4.7 or above from http://www.cmake.org/, install and ensure
288        that cmake\bin is on your path.
289    
290    2.  Unzip (retaining folder structure) the PCRE source tree into a source
291        directory such as C:\pcre.
292    
293    3.  Create a new, empty build directory: C:\pcre\build\
294    
295    4.  Run CMakeSetup from the Shell envirornment of your build tool, e.g., Msys
296        for Msys/MinGW or Visual Studio Command Prompt for VC/VC++
297    
298    5.  Enter C:\pcre\pcre-xx and C:\pcre\build for the source and build
299        directories, respectively
300    
301    6.  Hit the "Configure" button.
302    
303    7.  Select the particular IDE / build tool that you are using (Visual Studio,
304        MSYS makefiles, MinGW makefiles, etc.)
305    
306    8.  The GUI will then list several configuration options. This is where you can
307        enable UTF-8 support, etc.
308    
309    9.  Hit "Configure" again. The adjacent "OK" button should now be active.
310    
311    10. Hit "OK".
312    
313    11. The build directory should now contain a usable build system, be it a
314        solution file for Visual Studio, makefiles for MinGW, etc.
315    
316    
317    USE OF RELATIVE PATHS WITH CMAKE ON WINDOWS
318    
319    A PCRE user comments as follows:
320    
321    I thought that others may want to know the current state of
322    CMAKE_USE_RELATIVE_PATHS support on Windows.
323    
324    Here it is:
325    -- AdditionalIncludeDirectories is only partially modified (only the
326    first path - see below)
327    -- Only some of the contained file paths are modified - shown below for
328    pcre.vcproj
329    -- It properly modifies
330    
331    I am sure CMake people can fix that if they want to. Until then one will
332    need to replace existing absolute paths in project files with relative
333    paths manually (e.g. from VS) - relative to project file location. I did
334    just that before being told to try CMAKE_USE_RELATIVE_PATHS. Not a big
335    deal.
336    
337    AdditionalIncludeDirectories="E:\builds\pcre\build;E:\builds\pcre\pcre-7.5;"
338    AdditionalIncludeDirectories=".;E:\builds\pcre\pcre-7.5;"
339    
340    RelativePath="pcre.h">
341    RelativePath="pcre_chartables.c">
342    RelativePath="pcre_chartables.c.rule">
343    
344    
345    TESTING WITH RUNTEST.BAT
346    
347    1. Copy RunTest.bat into the directory where pcretest.exe has been created.
348    
349    2. Edit RunTest.bat and insert a line that indentifies the relative location of
350       the pcre source, e.g.:
351    
352       set srcdir=..\pcre-7.4-RC3
353    
354    3. Run RunTest.bat from a command shell environment. Test outputs will
355       automatically be compared to expected results, and discrepancies will
356       identified in the console output.
357    
358    4. To test pcrecpp, run pcrecpp_unittest.exe, pcre_stringpiece_unittest.exe and
359       pcre_scanner_unittest.exe.
360    
361    
362  BUILDING UNDER WINDOWS WITH BCC5.5  BUILDING UNDER WINDOWS WITH BCC5.5
363    
364  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 233  Michael Roy sent these comments about bu Line 373  Michael Roy sent these comments about bu
373    line.    line.
374    
375    
376    BUILDING UNDER WINDOWS CE WITH VISUAL STUDIO 200x
377    
378    Vincent Richomme sent a zip archive of files to help with this process. They
379    can be found in the file "pcre-vsbuild.zip" in the Contrib directory of the FTP
380    site.
381    
382    
383  BUILDING PCRE ON OPENVMS  BUILDING PCRE ON OPENVMS
384    
385  Dan Mooney sent the following comments about building PCRE on OpenVMS. They  Dan Mooney sent the following comments about building PCRE on OpenVMS. They
# Line 297  $! Locale could not be set to fr Line 444  $! Locale could not be set to fr
444  $!  $!
445  =========================  =========================
446    
447  Last Updated: 05 July 2007  Last Updated: 08 March 2009
448  ****  ****

Legend:
Removed from v.188  
changed lines
  Added in v.392

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12