/[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 434 by ph10, Sat Sep 5 10:20:28 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    
26  There are some other comments and files in the Contrib directory on the ftp  There are some other comments and files (including some documentation in CHM
27  site that you may find useful. See  format) in the Contrib directory on the FTP site:
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    
# 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
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  
89        pcre_study.c   (5) Also ensure that you have the following file, which is #included as source
90        pcre_tables.c       when building a debugging version of PCRE, and is also used by pcretest.
91        pcre_try_flipped.c  
92        pcre_ucp_searchfuncs.c         pcre_printint.src
93        pcre_valid_utf8.c  
94        pcre_version.c   (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
95        pcre_xclass.c       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      Now link them all together into an object library in whichever form your  
98      system keeps such libraries. This is the basic PCRE C library. If your         pcre_chartables.c
99      system has static and shared libraries, you may have to do this once for         pcre_compile.c
100      each type.         pcre_config.c
101           pcre_dfa_exec.c
102  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix         pcre_exec.c
103      library.         pcre_fullinfo.c
104           pcre_get.c
105  (6) Compile the test program pcretest.c. This needs the functions in the         pcre_globals.c
106      pcre and pcreposix libraries when linking.         pcre_info.c
107           pcre_maketables.c
108  (7) Run pcretest on the testinput files in the testdata directory, and check         pcre_newline.c
109      that the output matches the corresponding testoutput files. Note that the         pcre_ord2utf8.c
110      supplied files are in Unix format, with just LF characters as line         pcre_refcount.c
111      terminators. You may need to edit them to change this if your system uses a         pcre_study.c
112      different convention.         pcre_tables.c
113           pcre_try_flipped.c
114           pcre_ucd.c
115           pcre_valid_utf8.c
116           pcre_version.c
117           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
125         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
127         for each type.
128    
129     (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
130         and link the result (on its own) as the pcreposix library.
131    
132     (9) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
133         This needs the functions in the pcre and pcreposix libraries when linking.
134         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
137         that the output matches the corresponding testoutput files. Note that the
138         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
140         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  (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
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).
147    
148    
149  THE C++ WRAPPER FUNCTIONS  THE C++ WRAPPER FUNCTIONS
# Line 125  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  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
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"
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 159  On both MinGW and Cygwin, PCRE should bu Line 232  On both MinGW and Cygwin, PCRE should bu
232    ./configure && make && make install    ./configure && make && make install
233    
234  This should create two libraries called libpcre and libpcreposix, and, if you  This should create two libraries called libpcre and libpcreposix, and, if you
235  have enabled building the C++ wrapper, a third one called libpcrecpp.  have enabled building the C++ wrapper, a third one called libpcrecpp. These are
236    independent libraries: when you like with libpcreposix or libpcrecpp you must
237    also link with libpcre, which contains the basic functions. (Some earlier
238    releases of PCRE included the basic libpcre functions in libpcreposix. This no
239    longer happens.)
240    
241    A user submitted a special-purpose patch that makes it easy to create
242    "pcre.dll" under mingw32 using the "msys" environment. It provides "pcre.dll"
243    as a special target. If you use this target, no other files are built, and in
244    particular, the pcretest and pcregrep programs are not built. An example of how
245    this might be used is:
246    
247  If you want to statically link your program against a non-dll .a file, you must    ./configure --enable-utf --disable-cpp CFLAGS="-03 -s"; make pcre.dll
 define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and  
 pcre_free() exported functions will be declared __declspec(dllimport), with  
 unwanted results.  
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 196  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 configuration facility that can be used instead of the
282    traditional Unix "configure". CMake creates project files (make files, solution
283    files, etc.) tailored to numerous development environments, including Visual
284    Studio, Borland, Msys, MinGW, NMake, and Unix. The following instructions
285    were contributed by a PCRE user.
286    
287    1.  Install the latest CMake version available from http://www.cmake.org/, and
288        ensure 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, for example C:\pcre\build\
294    
295    4.  Run cmake-gui from the Shell envirornment of your build tool, for example,
296        Msys 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
304        Studio, MSYS makefiles, MinGW makefiles, etc.)
305    
306    8.  The GUI will then list several configuration options. This is where
307        you can enable UTF-8 support or other PCRE optional features.
308    
309    9.  Hit "Configure" again. The adjacent "Generate" button should now be
310        active.
311    
312    10. Hit "Generate".
313    
314    11. The build directory should now contain a usable build system, be it a
315        solution file for Visual Studio, makefiles for MinGW, etc. Exit from
316        cmake-gui and use the generated build system with your compiler or IDE.
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  BUILDING UNDER WINDOWS WITH BCC5.5
365    
366  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 210  Michael Roy sent these comments about bu Line 375  Michael Roy sent these comments about bu
375    line.    line.
376    
377    
378    BUILDING UNDER WINDOWS CE WITH VISUAL STUDIO 200x
379    
380    Vincent Richomme sent a zip archive of files to help with this process. They
381    can be found in the file "pcre-vsbuild.zip" in the Contrib directory of the FTP
382    site.
383    
384    
385  BUILDING PCRE ON OPENVMS  BUILDING PCRE ON OPENVMS
386    
387  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 274  $!   Locale could not be set to fr Line 446  $!   Locale could not be set to fr
446  $!  $!
447  =========================  =========================
448    
449  Last Updated: 24 April 2007  Last Updated: 17 March 2009
450  ****  ****

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

  ViewVC Help
Powered by ViewVC 1.1.5