/[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 155 by ph10, Tue Apr 24 13:36:11 2007 UTC revision 309 by ph10, Mon Jan 21 15:22:09 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 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 support for CMake. This support is relatively
37  is incomplete and not documented. However if you are a "cmake" user you might  new, but has already been used successfully to build PCRE in multiple build
38  like to try building with "cmake".  environments on Windows. There are some instructions in the section entitled
39    "Building PCRE with CMake" below.
40    
41    
42  GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY  GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
43    
44  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".
45    
46  (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
47      settings that it contains to whatever is appropriate for your environment.       settings that it contains to whatever is appropriate for your environment.
48      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
49      define the NEWLINE macro.       define the NEWLINE macro. When you compile any of the PCRE modules, you
50         must specify -DHAVE_CONFIG_H to your compiler so that config.h is included
51      An alternative approach is not to edit config.h, but to use -D on the       in the sources.
52      compiler command line to make any changes that you need.  
53         An alternative approach is not to edit config.h, but to use -D on the
54  (2) Copy or rename the file pcre.h.generic as pcre.h.       compiler command line to make any changes that you need to the
55         configuration options. In this case -DHAVE_CONFIG_H must not be set.
56  (3) EITHER:  
57        Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.       NOTE: There have been occasions when the way in which certain parameters
58         in config.h are used has changed between releases. (In the configure/make
59      OR:       world, this is handled automatically.) When upgrading to a new release,
60        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
61        single argument "pcre_chartables.c". This generates a set of standard       you had previously.
62        character tables and writes them to that file. The tables are generated  
63        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.
64        that is specified by LC_xxx environment variables, add the -L option to  
65        the dftables command. You must use this method if you are building on   (3) EITHER:
66        a system that uses EBCDIC code.         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
67    
68      The tables in pcre_chartables.c are defaults. The caller of PCRE can       OR:
69      specify alternative tables at run time.         Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
70           you have set up config.h), and then run it with the single argument
71  (4) Compile the following source files:         "pcre_chartables.c". This generates a set of standard character tables
72           and writes them to that file. The tables are generated using the default
73        pcre_chartables.c         C locale for your system. If you want to use a locale that is specified
74        pcre_compile.c         by LC_xxx environment variables, add the -L option to the dftables
75        pcre_config.c         command. You must use this method if you are building on a system that
76        pcre_dfa_exec.c         uses EBCDIC code.
77        pcre_exec.c  
78        pcre_fullinfo.c       The tables in pcre_chartables.c are defaults. The caller of PCRE can
79        pcre_get.c       specify alternative tables at run time.
80        pcre_globals.c  
81        pcre_info.c   (4) Ensure that you have the following header files:
82        pcre_maketables.c  
83        pcre_newline.c         pcre_internal.h
84        pcre_ord2utf8.c         ucp.h
85        pcre_refcount.c         ucpinternal.h
86        pcre_study.c         ucptable.h
87        pcre_tables.c  
88        pcre_try_flipped.c   (5) Also ensure that you have the following file, which is #included as source
89        pcre_ucp_searchfuncs.c       when building a debugging version of PCRE, and is also used by pcretest.
90        pcre_valid_utf8.c  
91        pcre_version.c         pcre_printint.src
92        pcre_xclass.c  
93     (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
94      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
95      system keeps such libraries. This is the basic PCRE C library. If your       other -D settings to change the configuration as required.
96      system has static and shared libraries, you may have to do this once for  
97      each type.         pcre_chartables.c
98           pcre_compile.c
99  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix         pcre_config.c
100      library.         pcre_dfa_exec.c
101           pcre_exec.c
102  (6) Compile the test program pcretest.c. This needs the functions in the         pcre_fullinfo.c
103      pcre and pcreposix libraries when linking.         pcre_get.c
104           pcre_globals.c
105  (7) Run pcretest on the testinput files in the testdata directory, and check         pcre_info.c
106      that the output matches the corresponding testoutput files. Note that the         pcre_maketables.c
107      supplied files are in Unix format, with just LF characters as line         pcre_newline.c
108      terminators. You may need to edit them to change this if your system uses a         pcre_ord2utf8.c
109      different convention.         pcre_refcount.c
110           pcre_study.c
111           pcre_tables.c
112           pcre_try_flipped.c
113           pcre_ucp_searchfuncs.c
114           pcre_valid_utf8.c
115           pcre_version.c
116           pcre_xclass.c
117    
118         Make sure that you include -I. in the compiler command (or equivalent for
119         an unusual compiler) so that all included PCRE header files are first
120         sought in the current directory. Otherwise you run the risk of picking up
121         a previously-installed file from somewhere else.
122    
123     (7) Now link all the compiled code into an object library in whichever form
124         your system keeps such libraries. This is the basic PCRE C library. If
125         your system has static and shared libraries, you may have to do this once
126         for each type.
127    
128     (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
129         and link the result (on its own) as the pcreposix library.
130    
131     (9) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
132         This needs the functions in the pcre and pcreposix libraries when linking.
133         It also needs the pcre_printint.src source file, which it #includes.
134    
135    (10) Run pcretest on the testinput files in the testdata directory, and check
136         that the output matches the corresponding testoutput files. Note that the
137         supplied files are in Unix format, with just LF characters as line
138         terminators. You may need to edit them to change this if your system uses
139         a different convention. If you are using Windows, you probably should use
140         the wintestinput3 file instead of testinput3 (and the corresponding output
141         file). This is a locale test; wintestinput3 sets the locale to "french"
142         rather than "fr_FR", and there some minor output differences.
143    
144  (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
145      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).
146    
147    
148  THE C++ WRAPPER FUNCTIONS  THE C++ WRAPPER FUNCTIONS
# Line 125  additional files. The following files in Line 163  additional files. The following files in
163  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.
164    
165    
166  COMMENTS ABOUT WIN32 BUILDS  STACK SIZE IN WINDOWS ENVIRONMENTS
167    
168  There are two ways of building PCRE using the "congifure, make, make install"  The default processor stack size of 1Mb in some Windows environments is too
169    small for matching patterns that need much recursion. In particular, test 2 may
170    fail because of this. Normally, running out of stack causes a crash, but there
171    have been cases where the test program has just died silently. See your linker
172    documentation for how to increase stack size if you experience problems. The
173    Linux default of 8Mb is a reasonable choice for the stack, though even that can
174    be too small for some pattern/subject combinations.
175    
176    PCRE has a compile configuration option to disable the use of stack for
177    recursion so that heap is used instead. However, pattern matching is
178    significantly slower when this is done. There is more about stack usage in the
179    "pcrestack" documentation.
180    
181    
182    COMMENTS ABOUT WIN32 BUILDS (see also "BUILDING PCRE WITH CMAKE" below)
183    
184    There are two ways of building PCRE using the "configure, make, make install"
185  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
186  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
187  some experimental, undocumented support for building using "cmake", which you  some experimental, undocumented support for building using "cmake", which you
# Line 159  On both MinGW and Cygwin, PCRE should bu Line 213  On both MinGW and Cygwin, PCRE should bu
213    ./configure && make && make install    ./configure && make && make install
214    
215  This should create two libraries called libpcre and libpcreposix, and, if you  This should create two libraries called libpcre and libpcreposix, and, if you
216  have enabled building the C++ wrapper, a third one called libpcrecpp.  have enabled building the C++ wrapper, a third one called libpcrecpp. These are
217    independent libraries: when you like with libpcreposix or libpcrecpp you must
218    also link with libpcre, which contains the basic functions. (Some earlier
219    releases of PCRE included the basic libpcre functions in libpcreposix. This no
220    longer happens.)
221    
222  If you want to statically link your program against a non-dll .a file, you must  If you want to statically link your program against a non-dll .a file, you must
223  define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and  define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
# Line 196  terminators in order to get some of the Line 254  terminators in order to get some of the
254  things in this area in future.  things in this area in future.
255    
256    
257    BUILDING PCRE WITH CMAKE
258    
259    CMake is an alternative build facility that can be used instead of the
260    traditional Unix "configure". CMake version 2.4.7 supports Borland makefiles,
261    MinGW makefiles, MSYS makefiles, NMake makefiles, UNIX makefiles, Visual Studio
262    6, Visual Studio 7, Visual Studio 8, and Watcom W8. The following instructions
263    were contributed by a PCRE user.
264    
265    1. Download CMake 2.4.7 or above from http://www.cmake.org/, install and ensure
266       that cmake\bin is on your path.
267    
268    2. Unzip (retaining folder structure) the PCRE source tree into a source
269       directory such as C:\pcre.
270    
271    3. Create a new, empty build directory: C:\pcre\build\
272    
273    4. Run CMakeSetup from the Shell envirornment of your build tool, e.g., Msys
274       for Msys/MinGW or Visual Studio Command Prompt for VC/VC++
275    
276    5. Enter C:\pcre\pcre-xx and C:\pcre\build for the source and build
277       directories, respectively
278    
279    6. Hit the "Configure" button.
280    
281    7. Select the particular IDE / build tool that you are using (Visual Studio,
282       MSYS makefiles, MinGW makefiles, etc.)
283    
284    8. The GUI will then list several configuration options. This is where you can
285       enable UTF-8 support, etc.
286    
287    9. Hit "Configure" again. The adjacent "OK" button should now be active.
288    
289    10. Hit "OK".
290    
291    11. The build directory should now contain a usable build system, be it a
292        solution file for Visual Studio, makefiles for MinGW, etc.
293    
294    
295    USE OF RELATIVE PATHS WITH CMAKE ON WINDOWS
296    
297    A PCRE user comments as follows:
298    
299    I thought that others may want to know the current state of
300    CMAKE_USE_RELATIVE_PATHS support on Windows.
301    
302    Here it is:
303    -- AdditionalIncludeDirectories is only partially modified (only the
304    first path - see below)
305    -- Only some of the contained file paths are modified - shown below for
306    pcre.vcproj
307    -- It properly modifies
308    
309    I am sure CMake people can fix that if they want to. Until then one will
310    need to replace existing absolute paths in project files with relative
311    paths manually (e.g. from VS) - relative to project file location. I did
312    just that before being told to try CMAKE_USE_RELATIVE_PATHS. Not a big
313    deal.
314    
315    AdditionalIncludeDirectories="E:\builds\pcre\build;E:\builds\pcre\pcre-7.5;"
316    AdditionalIncludeDirectories=".;E:\builds\pcre\pcre-7.5;"
317    
318    RelativePath="pcre.h">
319    RelativePath="pcre_chartables.c">
320    RelativePath="pcre_chartables.c.rule">
321    
322    
323    TESTING WITH RUNTEST.BAT
324    
325    1. Copy RunTest.bat into the directory where pcretest.exe has been created.
326    
327    2. Edit RunTest.bat and insert a line that indentifies the relative location of
328       the pcre source, e.g.:
329    
330       set srcdir=..\pcre-7.4-RC3
331    
332    3. Run RunTest.bat from a command shell environment. Test outputs will
333       automatically be compared to expected results, and discrepancies will
334       identified in the console output.
335    
336    4. To test pcrecpp, run pcrecpp_unittest.exe, pcre_stringpiece_unittest.exe and
337       pcre_scanner_unittest.exe.
338    
339    
340  BUILDING UNDER WINDOWS WITH BCC5.5  BUILDING UNDER WINDOWS WITH BCC5.5
341    
342  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 274  $!   Locale could not be set to fr Line 415  $!   Locale could not be set to fr
415  $!  $!
416  =========================  =========================
417    
418  Last Updated: 24 April 2007  Last Updated: 20 January 2008
419  ****  ****

Legend:
Removed from v.155  
changed lines
  Added in v.309

  ViewVC Help
Powered by ViewVC 1.1.5