/[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 197 by ph10, Tue Jul 31 10:50:18 2007 UTC revision 316 by ph10, Fri Jan 25 17:38:26 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    Comments about Win32 builds    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    Building under Windows with BCC5.5
16    Building PCRE on OpenVMS    Building PCRE on OpenVMS
17    
18    
19  GENERAL  GENERAL
20    
21  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
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 are untested by me.  anything other than Unix-like systems are untested by me.
24    
# Line 29  library consists entirely of code writte Line 33  library consists entirely of code writte
33  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++
34  wrapper functions are a separate issue (see below).  wrapper functions are a separate issue (see below).
35    
36  The PCRE distribution contains some experimental support for "cmake", but this  The PCRE distribution includes a "configure" file for use by the Configure/Make
37  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
38  like to try building with "cmake".  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 PCRE C LIBRARY  GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
# Line 41  The following are generic comments about Line 48  The following are generic comments about
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         in the sources.
54    
55       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
56       compiler command line to make any changes that you need.       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    
59       NOTE: There have been occasions when the way in which certain parameters       NOTE: There have been occasions when the way in which certain parameters
60       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
# Line 58  The following are generic comments about Line 68  The following are generic comments about
68         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
69    
70       OR:       OR:
71         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
72         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
73         character tables and writes them to that file. The tables are generated         "pcre_chartables.c". This generates a set of standard character tables
74         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
75         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
76         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
77         a system that uses EBCDIC code.         command. You must use this method if you are building on a system that
78           uses EBCDIC code.
79    
80       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
81       specify alternative tables at run time.       specify alternative tables at run time.
# Line 77  The following are generic comments about Line 88  The following are generic comments about
88         ucptable.h         ucptable.h
89    
90   (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
91       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.
92    
93         pcre_printint.src         pcre_printint.src
94    
95   (6) Compile the following source files:   (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
96         option if you have set up config.h with your configuration, or else use
97         other -D settings to change the configuration as required.
98    
99         pcre_chartables.c         pcre_chartables.c
100         pcre_compile.c         pcre_compile.c
# Line 104  The following are generic comments about Line 117  The following are generic comments about
117         pcre_version.c         pcre_version.c
118         pcre_xclass.c         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   (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       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       your system has static and shared libraries, you may have to do this once
128       for each type.       for each type.
129    
130   (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)
131       pcreposix library.       and link the result (on its own) as the pcreposix library.
132    
133   (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).
134       pcre and pcreposix libraries when linking. It also needs the       This needs the functions in the pcre and pcreposix libraries when linking.
135       pcre_printint.src source file, which it #includes.       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  (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       that the output matches the corresponding testoutput files. Note that the
139       supplied files are in Unix format, with just LF characters as line       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       terminators. You may need to edit them to change this if your system uses
141       a different convention.       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  (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
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).
# Line 144  additional files. The following files in Line 165  additional files. The following files in
165  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.
166    
167    
168  COMMENTS ABOUT WIN32 BUILDS  STACK SIZE IN WINDOWS ENVIRONMENTS
169    
170    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    PCRE has a compile configuration option to disable the use of stack for
179    recursion so that heap is used instead. However, pattern matching is
180    significantly slower when this is done. There is more about stack usage in the
181    "pcrestack" documentation.
182    
183    
184    COMMENTS ABOUT WIN32 BUILDS (see also "BUILDING PCRE WITH CMAKE" below)
185    
186  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"
187  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
188  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
189  some experimental, undocumented support for building using "cmake", which you  support for building using CMake, which some users find a more straightforward
190  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
191  time, the "cmake" process builds only a static library (not a dll), and the  automatically when CMake is used.
 tests are not automatically run.  
192    
193  The MinGW home page (http://www.mingw.org/) says this:  The MinGW home page (http://www.mingw.org/) says this:
194    
# Line 219  terminators in order to get some of the Line 255  terminators in order to get some of the
255  things in this area in future.  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  BUILDING UNDER WINDOWS WITH BCC5.5
342    
343  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 297  $!   Locale could not be set to fr Line 416  $!   Locale could not be set to fr
416  $!  $!
417  =========================  =========================
418    
419  Last Updated: 05 July 2007  Last Updated: 25 January 2008
420  ****  ****

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

  ViewVC Help
Powered by ViewVC 1.1.5