/[pcre]/code/trunk/NON-UNIX-USE

Diff of /code/trunk/NON-UNIX-USE

Parent Directory | Revision Log | View Patch Patch

-revision 111 by ph10,
Thu Mar  8 16:53:09 2007 UTC
+revision 317 by ph10,
Fri Jan 25 17:57:39 2008 UTC
 Line 1
  Compiling PCRE on non-Unix systems
  ----------------------------------
- I (Philip Hazel) have no knowledge of Windows or VMS sytems and how their
+ This document contains the following sections:
+   General
+   Generic instructions for the PCRE C library
+   The C++ wrapper functions
+   Building for virtual Pascal
+   Stack size in Windows environments
+   Linking programs in Windows environments
+   Comments about Win32 builds
+   Building PCRE on Windows with CMake
+   Use of relative paths with CMake on Windows
+   Testing with runtest.bat
+   Building under Windows with BCC5.5
+   Building PCRE on OpenVMS
+ GENERAL
+ I (Philip Hazel) have no experience of Windows or VMS sytems and how their
  libraries work. The items in the PCRE distribution and Makefile that relate to
- anything other than Unix-like systems have been contributed by PCRE users and
+ anything other than Unix-like systems are untested by me.
- are untested by me.
  There are some other comments and files in the Contrib directory on the ftp
- site that you may find useful, although a lot of them are now out-of-date. See
+ site that you may find useful. See
    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
- If you want to compile PCRE for a non-Unix system (or perhaps, more strictly,
+ If you want to compile PCRE for a non-Unix system (especially for a system that
- for a system that does not support "configure" and "make" files), note that
+ does not support "configure" and "make" files), note that the basic PCRE
- the basic PCRE library consists entirely of code written in Standard C, and so
+ library consists entirely of code written in Standard C, and so should compile
- should compile successfully on any system that has a Standard C compiler and
+ successfully on any system that has a Standard C compiler and library. The C++
- library. The C++ wrapper functions are a separate issue (see below).
+ wrapper functions are a separate issue (see below).
+ The PCRE distribution includes a "configure" file for use by the Configure/Make
+ build system, as found in many Unix-like environments. There is also support
+ support for CMake, which some users prefer, in particular in Windows
+ environments. There are some instructions for CMake under Windows in the
+ section entitled "Building PCRE with CMake" below. CMake can also be used to
+ build PCRE in Unix-like systems.
- GENERIC INSTRUCTIONS FOR THE C LIBRARY
+ GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
  The following are generic comments about building the PCRE C library "by hand".
- (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
-     settings that it contains to whatever is appropriate for your environment.
+      settings that it contains to whatever is appropriate for your environment.
-     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
-     define the NEWLINE macro.
+      define the NEWLINE macro. When you compile any of the PCRE modules, you
+      must specify -DHAVE_CONFIG_H to your compiler so that config.h is included
-     An alternative approach is not to edit config.h, but to use -D on the
+      in the sources.
-     compiler command line to make any changes that you need.
+      An alternative approach is not to edit config.h, but to use -D on the
- (2) Copy or rename the file pcre.h.generic to pcre.h.
+      compiler command line to make any changes that you need to the
+      configuration options. In this case -DHAVE_CONFIG_H must not be set.
- (3) Compile dftables.c as a stand-alone program, and then run it with
-     the single argument "pcre_chartables.c". This generates a set of standard
+      NOTE: There have been occasions when the way in which certain parameters
-     character tables and writes them to that file.
+      in config.h are used has changed between releases. (In the configure/make
+      world, this is handled automatically.) When upgrading to a new release,
- (4) Compile the following source files:
+      you are strongly advised to review config.h.generic before re-using what
+      you had previously.
-       pcre_chartables.c
-       pcre_compile.c
+  (2) Copy or rename the file pcre.h.generic as pcre.h.
-       pcre_config.c
-       pcre_dfa_exec.c
+  (3) EITHER:
-       pcre_exec.c
+        Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
-       pcre_fullinfo.c
-       pcre_get.c
+      OR:
-       pcre_globals.c
+        Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
-       pcre_info.c
+        you have set up config.h), and then run it with the single argument
-       pcre_maketables.c
+        "pcre_chartables.c". This generates a set of standard character tables
-       pcre_newline.c
+        and writes them to that file. The tables are generated using the default
-       pcre_ord2utf8.c
+        C locale for your system. If you want to use a locale that is specified
-       pcre_refcount.c
+        by LC_xxx environment variables, add the -L option to the dftables
-       pcre_study.c
+        command. You must use this method if you are building on a system that
-       pcre_tables.c
+        uses EBCDIC code.
-       pcre_try_flipped.c
-       pcre_ucp_searchfuncs.c
+      The tables in pcre_chartables.c are defaults. The caller of PCRE can
-       pcre_valid_utf8.c
+      specify alternative tables at run time.
-       pcre_version.c
-       pcre_xclass.c
+  (4) Ensure that you have the following header files:
-     Now link them all together into an object library in whichever form your
+        pcre_internal.h
-     system keeps such libraries. This is the basic PCRE C library. If your
+        ucp.h
-     system has static and shared libraries, you may have to do this once for
+        ucpinternal.h
-     each type.
+        ucptable.h
- (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix
+  (5) Also ensure that you have the following file, which is #included as source
-     library.
+      when building a debugging version of PCRE, and is also used by pcretest.
- (6) Compile the test program pcretest.c. This needs the functions in the
+        pcre_printint.src
-     pcre and pcreposix libraries when linking.
+  (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
- (7) Run pcretest on the testinput files in the testdata directory, and check
+      option if you have set up config.h with your configuration, or else use
-     that the output matches the corresponding testoutput files. Note that the
+      other -D settings to change the configuration as required.
-     supplied files are in Unix format, with just LF characters as line
-     terminators. You may need to edit them to change this if your system uses a
+        pcre_chartables.c
-     different convention.
+        pcre_compile.c
+        pcre_config.c
+        pcre_dfa_exec.c
+        pcre_exec.c
+        pcre_fullinfo.c
+        pcre_get.c
+        pcre_globals.c
+        pcre_info.c
+        pcre_maketables.c
+        pcre_newline.c
+        pcre_ord2utf8.c
+        pcre_refcount.c
+        pcre_study.c
+        pcre_tables.c
+        pcre_try_flipped.c
+        pcre_ucp_searchfuncs.c
+        pcre_valid_utf8.c
+        pcre_version.c
+        pcre_xclass.c
+      Make sure that you include -I. in the compiler command (or equivalent for
+      an unusual compiler) so that all included PCRE header files are first
+      sought in the current directory. Otherwise you run the risk of picking up
+      a previously-installed file from somewhere else.
+  (7) Now link all the compiled code into an object library in whichever form
+      your system keeps such libraries. This is the basic PCRE C library. If
+      your system has static and shared libraries, you may have to do this once
+      for each type.
+  (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
+      and link the result (on its own) as the pcreposix library.
+  (9) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
+      This needs the functions in the pcre and pcreposix libraries when linking.
+      It also needs the pcre_printint.src source file, which it #includes.
+ (10) Run pcretest on the testinput files in the testdata directory, and check
+      that the output matches the corresponding testoutput files. Note that the
+      supplied files are in Unix format, with just LF characters as line
+      terminators. You may need to edit them to change this if your system uses
+      a different convention. If you are using Windows, you probably should use
+      the wintestinput3 file instead of testinput3 (and the corresponding output
+      file). This is a locale test; wintestinput3 sets the locale to "french"
+      rather than "fr_FR", and there some minor output differences.
- (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
-     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).
  THE C++ WRAPPER FUNCTIONS
-Line 92 
 xxx.cc files.
+Line 160 
 xxx.cc files.
  BUILDING FOR VIRTUAL PASCAL
- Stefan Weber contributed the following files in the distribution for building
+ A script for building PCRE using Borland's C++ compiler for use with VPASCAL
- PCRE for use with VP/Borland: !compile.txt, !linklib.txt, makevp.bat,
+ was contributed by Alexander Tokarev. Stefan Weber updated the script and added
- pcregexp.pas.
+ additional files. The following files in the distribution are for building PCRE
+ for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
- BUILDING UNDER WINDOWS WITH BCC5.5
+ STACK SIZE IN WINDOWS ENVIRONMENTS
- Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
+ The default processor stack size of 1Mb in some Windows environments is too
+ small for matching patterns that need much recursion. In particular, test 2 may
+ fail because of this. Normally, running out of stack causes a crash, but there
+ have been cases where the test program has just died silently. See your linker
+ documentation for how to increase stack size if you experience problems. The
+ Linux default of 8Mb is a reasonable choice for the stack, though even that can
+ be too small for some pattern/subject combinations.
-   Some of the core BCC libraries have a version of PCRE from 1998 built in,
+ PCRE has a compile configuration option to disable the use of stack for
-   which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
+ recursion so that heap is used instead. However, pattern matching is
-   version mismatch. I'm including an easy workaround below, if you'd like to
+ significantly slower when this is done. There is more about stack usage in the
-   include it in the non-unix instructions:
+ "pcrestack" documentation.
-   When linking a project with BCC5.5, pcre.lib must be included before any of
-   the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
-   line.
+ LINKING PROGRAMS IN WINDOWS ENVIRONMENTS
- OUT-OF-DATE COMMENTS ABOUT WIN32 BUILDS
+ If you want to statically link a program against a PCRE library in the form of
+ a non-dll .a file, you must define PCRE_STATIC before including pcre.h,
+ otherwise the pcre_malloc() and pcre_free() exported functions will be declared
+ __declspec(dllimport), with unwanted results.
- [These comments need looking at by someone who knows about Windows.]
- Some help in building a Win32 DLL of PCRE in GnuWin32 environments was
+ COMMENTS ABOUT WIN32 BUILDS (see also "BUILDING PCRE WITH CMAKE" below)
- contributed by Paul Sokolovsky. These environments are Mingw32
- (http://www.xraylith.wisc.edu/~khan/software/gnu-win32/) and CygWin
- (http://sourceware.cygnus.com/cygwin/). Paul comments:
-   For CygWin, set CFLAGS=-mno-cygwin, and do 'make dll'. You'll get
-   pcre.dll (containing pcreposix also), libpcre.dll.a, and dynamically
-   linked pgrep and pcretest. If you have /bin/sh, run RunTest (three
-   main test go ok, locale not supported).
- Changes to do MinGW with autoconf 2.50 were supplied by Fred Cox
- <sailorFred@yahoo.com>, who comments as follows:
-   If you are using the PCRE DLL, the normal Unix style configure && make &&
-   make check && make install should just work[*]. If you want to statically
-   link against the .a file, you must define PCRE_STATIC before including
-   pcre.h, otherwise the pcre_malloc and pcre_free exported functions will be
-   declared __declspec(dllimport), with hilarious results.  See the configure.in
-   and pcretest.c for how it is done for the static test.
-   Also, there will only be a libpcre.la, not a libpcreposix.la, as you
-   would expect from the Unix version. The single DLL includes the pcreposix
-   interface.
- [*] But note that the supplied test files are in Unix format, with just LF
- characters as line terminators. You will have to edit them to change to CR LF
- terminators.
- A script for building PCRE using Borland's C++ compiler for use with VPASCAL
+ There are two ways of building PCRE using the "configure, make, make install"
- was contributed by Alexander Tokarev. It is called makevp.bat.
+ paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
+ the same thing; they are completely different from each other. There is also
+ support for building using CMake, which some users find a more straightforward
+ way of building PCRE under Windows. However, the tests are not run
+ automatically when CMake is used.
- These are some further comments about Win32 builds from Mark Evans. They
+ The MinGW home page (http://www.mingw.org/) says this:
- were contributed before Fred Cox's changes were made, so it is possible that
- they may no longer be relevant.
- "The documentation for Win32 builds is a bit shy.  Under MSVC6 I
- followed their instructions to the letter, but there were still
- some things missing.
- (1) Must #define STATIC for entire project if linking statically.
-     (I see no reason to use DLLs for code this compact.)  This of
-     course is a project setting in MSVC under Preprocessor.
- (2) Missing some #ifdefs relating to the function pointers
-     pcre_malloc and pcre_free.  See my solution below.  (The stubs
-     may not be mandatory but they made me feel better.)"
- =========================
+   MinGW: A collection of freely available and freely distributable Windows
- #ifdef _WIN32
+   specific header files and import libraries combined with GNU toolsets that
- #include <malloc.h>
+   allow one to produce native Windows programs that do not rely on any
+rd-party C runtime DLLs.
- void* malloc_stub(size_t N)
+ The Cygwin home page (http://www.cygwin.com/) says this:
- { return malloc(N); }
- void free_stub(void* p)
- { free(p); }
- void *(*pcre_malloc)(size_t) = &malloc_stub;
- void  (*pcre_free)(void *) = &free_stub;
- #else
+   Cygwin is a Linux-like environment for Windows. It consists of two parts:
- void *(*pcre_malloc)(size_t) = malloc;
+   . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
- void  (*pcre_free)(void *) = free;
+     substantial Linux API functionality
- #endif
+   . A collection of tools which provide Linux look and feel.
- =========================
+   The Cygwin DLL currently works with all recent, commercially released x86 32
+   bit and 64 bit versions of Windows, with the exception of Windows CE.
+ On both MinGW and Cygwin, PCRE should build correctly using:
+   ./configure && make && make install
+ This should create two libraries called libpcre and libpcreposix, and, if you
+ have enabled building the C++ wrapper, a third one called libpcrecpp. These are
+ independent libraries: when you like with libpcreposix or libpcrecpp you must
+ also link with libpcre, which contains the basic functions. (Some earlier
+ releases of PCRE included the basic libpcre functions in libpcreposix. This no
+ longer happens.)
+ A user submitted a special-purpose patch that makes it easy to create
+ "pcre.dll" under mingw32 using the "msys" environment. It provides "pcre.dll"
+ as a special target. If you use this target, no other files are built, and in
+ particular, the pcretest and pcregrep programs are not built. An example of how
+ this might be used is:
+   ./configure --enable-utf --disable-cpp CFLAGS="-03 -s"; make pcre.dll
+ Using Cygwin's compiler generates libraries and executables that depend on
+ cygwin1.dll. If a library that is generated this way is distributed,
+ cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
+ licence, this forces not only PCRE to be under the GPL, but also the entire
+ application. A distributor who wants to keep their own code proprietary must
+ purchase an appropriate Cygwin licence.
+ MinGW has no such restrictions. The MinGW compiler generates a library or
+ executable that can run standalone on Windows without any third party dll or
+ licensing issues.
+ But there is more complication:
+ If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
+ to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
+ front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
+ gcc and MinGW's gcc). So, a user can:
+ . Build native binaries by using MinGW or by getting Cygwin and using
+   -mno-cygwin.
+ . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
+   compiler flags.
+ The test files that are supplied with PCRE are in Unix format, with LF
+ characters as line terminators. It may be necessary to change the line
+ terminators in order to get some of the tests to work. We hope to improve
+ things in this area in future.
+ BUILDING PCRE ON WINDOWS WITH CMAKE
+ CMake is an alternative build facility that can be used instead of the
+ traditional Unix "configure". CMake version 2.4.7 supports Borland makefiles,
+ MinGW makefiles, MSYS makefiles, NMake makefiles, UNIX makefiles, Visual Studio
+, Visual Studio 7, Visual Studio 8, and Watcom W8. The following instructions
+ were contributed by a PCRE user.
+.  Download CMake 2.4.7 or above from http://www.cmake.org/, install and ensure
+     that cmake\bin is on your path.
+.  Unzip (retaining folder structure) the PCRE source tree into a source
+     directory such as C:\pcre.
+.  Create a new, empty build directory: C:\pcre\build\
+.  Run CMakeSetup from the Shell envirornment of your build tool, e.g., Msys
+     for Msys/MinGW or Visual Studio Command Prompt for VC/VC++
+.  Enter C:\pcre\pcre-xx and C:\pcre\build for the source and build
+     directories, respectively
+.  Hit the "Configure" button.
+.  Select the particular IDE / build tool that you are using (Visual Studio,
+     MSYS makefiles, MinGW makefiles, etc.)
+.  The GUI will then list several configuration options. This is where you can
+     enable UTF-8 support, etc.
+.  Hit "Configure" again. The adjacent "OK" button should now be active.
+. Hit "OK".
+. The build directory should now contain a usable build system, be it a
+     solution file for Visual Studio, makefiles for MinGW, etc.
+ USE OF RELATIVE PATHS WITH CMAKE ON WINDOWS
+ A PCRE user comments as follows:
+ I thought that others may want to know the current state of
+ CMAKE_USE_RELATIVE_PATHS support on Windows.
+ Here it is:
+ -- AdditionalIncludeDirectories is only partially modified (only the
+ first path - see below)
+ -- Only some of the contained file paths are modified - shown below for
+ pcre.vcproj
+ -- It properly modifies
+ I am sure CMake people can fix that if they want to. Until then one will
+ need to replace existing absolute paths in project files with relative
+ paths manually (e.g. from VS) - relative to project file location. I did
+ just that before being told to try CMAKE_USE_RELATIVE_PATHS. Not a big
+ deal.
+ AdditionalIncludeDirectories="E:\builds\pcre\build;E:\builds\pcre\pcre-7.5;"
+ AdditionalIncludeDirectories=".;E:\builds\pcre\pcre-7.5;"
+ RelativePath="pcre.h">
+ RelativePath="pcre_chartables.c">
+ RelativePath="pcre_chartables.c.rule">
+ TESTING WITH RUNTEST.BAT
+. Copy RunTest.bat into the directory where pcretest.exe has been created.
+. Edit RunTest.bat and insert a line that indentifies the relative location of
+    the pcre source, e.g.:
+    set srcdir=..\pcre-7.4-RC3
+. Run RunTest.bat from a command shell environment. Test outputs will
+    automatically be compared to expected results, and discrepancies will
+    identified in the console output.
+. To test pcrecpp, run pcrecpp_unittest.exe, pcre_stringpiece_unittest.exe and
+    pcre_scanner_unittest.exe.
+ BUILDING UNDER WINDOWS WITH BCC5.5
+ Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
+   Some of the core BCC libraries have a version of PCRE from 1998 built in,
+   which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
+   version mismatch. I'm including an easy workaround below, if you'd like to
+   include it in the non-unix instructions:
+   When linking a project with BCC5.5, pcre.lib must be included before any of
+   the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
+   line.
  BUILDING PCRE ON OPENVMS
-Line 246 
 $!   Locale could not be set to fr
+Line 428 
 $!   Locale could not be set to fr
  $!
  =========================
+ Last Updated: 25 January 2008
  ****

 Legend:



Removed from v.111
 


changed lines


 
Added in v.317
 Legend:



Removed from v.111
 


changed lines


 
Added in v.317
-Removed from v.111
+Added in v.317

webmaster@exim.org	ViewVC Help
Powered by ViewVC 1.1.12