/[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 258 by ph10, Wed Sep 19 09:27:50 2007 UTC revision 434 by ph10, Sat Sep 5 10:20:28 2009 UTC
# Line 8  This document contains the following sec Line 8  This document contains the following sec
8    The C++ wrapper functions    The C++ wrapper functions
9    Building for virtual Pascal    Building for virtual Pascal
10    Stack size in Windows environments    Stack size in Windows environments
11      Linking programs in Windows environments
12    Comments about Win32 builds    Comments about Win32 builds
13    Building PCRE with Cmake    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    
# Line 20  I (Philip Hazel) have no experience of W Line 23  I (Philip Hazel) have no experience of W
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 31  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 fully documented. However if you are a "cmake" user you  build system, as found in many Unix-like environments. There is also support
39  might like to try building with "cmake". There are some instructions in the  support for CMake, which some users prefer, in particular in Windows
40  section entitled "Building PCRE with Cmake" below.  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 80  The following are generic comments about Line 85  The following are generic comments about
85    
86         pcre_internal.h         pcre_internal.h
87         ucp.h         ucp.h
        ucpinternal.h  
        ucptable.h  
88    
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    
# Line 108  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
# Line 169  fail because of this. Normally, running Line 172  fail because of this. Normally, running
172  have been cases where the test program has just died silently. See your linker  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  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  Linux default of 8Mb is a reasonable choice for the stack, though even that can
175  be too small for some pattern/subject combinations. There is more about stack  be too small for some pattern/subject combinations.
 usage in the "pcrestack" documentation.  
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  COMMENTS ABOUT WIN32 BUILDS  
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 213  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 248  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 WITH CMAKE  BUILDING PCRE ON WINDOWS WITH CMAKE
280    
281  These instructions were contributed by a PCRE user.  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. Download CMake 2.4.7 or above from http://www.cmake.org/, install and ensure  1.  Install the latest CMake version available from http://www.cmake.org/, and
288     that cmake\bin is on your path.      ensure that cmake\bin is on your path.
289    
290  2. Unzip (retaining folder structure) the PCRE source tree into a source  2.  Unzip (retaining folder structure) the PCRE source tree into a source
291     directory such as C:\pcre.      directory such as C:\pcre.
292    
293  3. Create a new, empty build directory: C:\pcre\build\  3.  Create a new, empty build directory, for example C:\pcre\build\
294    
295  4. Run CMakeSetup from the Shell envirornment of your build tool, e.g., Msys  4.  Run cmake-gui from the Shell envirornment of your build tool, for example,
296     for Msys/MinGW or Visual Studio Command Prompt for VC/VC++      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  5.  Enter C:\pcre\pcre-xx and C:\pcre\build for the source and build
299     directories, respectively      directories, respectively.
300    
301  6. Hit the "Configure" button.  6.  Hit the "Configure" button.
302    
303  7. Select the particular IDE / build tool that you are using (Visual Studio,  7.  Select the particular IDE / build tool that you are using (Visual
304     MSYS makefiles, MinGW makefiles, etc.)      Studio, MSYS makefiles, MinGW makefiles, etc.)
305    
306  8. The GUI will then list several configuration options. This is where you can  8.  The GUI will then list several configuration options. This is where
307     enable UTF-8 support, etc.      you can enable UTF-8 support or other PCRE optional features.
308    
309  9. Hit "Configure" again. The adjacent "OK" button should now be active.  9.  Hit "Configure" again. The adjacent "Generate" button should now be
310        active.
311    
312  10. Hit "OK".  10. Hit "Generate".
313    
314  11. The build directory should now contain a usable build system, be it a  11. The build directory should now contain a usable build system, be it a
315      solution file for Visual Studio, makefiles for MinGW, etc.      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  Testing with RunTest.bat  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.  1. Copy RunTest.bat into the directory where pcretest.exe has been created.
350    
# Line 310  Michael Roy sent these comments about bu Line 373  Michael Roy sent these comments about bu
373    When linking a project with BCC5.5, pcre.lib must be included before any of    When linking a project with BCC5.5, pcre.lib must be included before any of
374    the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command    the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
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    
# Line 376  $! Locale could not be set to fr Line 446  $! Locale could not be set to fr
446  $!  $!
447  =========================  =========================
448    
449  Last Updated: 17 September 2007  Last Updated: 17 March 2009
450  ****  ****

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

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12