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

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

Parent Directory | Revision Log | View Patch Patch

-revision 63 by nigel,
Sat Feb 24 21:40:03 2007 UTC
+revision 144 by ph10,
Mon Apr  2 13:32:07 2007 UTC
 Line 1
  Compiling PCRE on non-Unix systems
  ----------------------------------
- See below for comments on Cygwin or MinGW usage.
+ This document contains the following sections:
- If you want to compile PCRE for a non-Unix system, note that it consists
+   General
- entirely of code written in Standard C, and so should compile successfully
+   Generic instructions for the PCRE C library
- on any machine with a Standard C compiler and library, using normal compiling
+   The C++ wrapper functions
- commands to do the following:
+   Building for virtual Pascal
+   Comments about Win32 builds
- (1) Copy or rename the file config.in as config.h, and change the macros that
+   Building under Windows with BCC5.5
- define HAVE_STRERROR and HAVE_MEMMOVE to define them as 1 rather than 0.
+   Building PCRE on OpenVMS
- Unfortunately, because of the way Unix autoconf works, the default setting has
- to be 0. You may also want to make changes to other macros in config.h. In
- particular, if you want to force a specific value for newline, you can define
+ GENERAL
- the NEWLINE macro. The default is to use '\n', thereby using whatever value
- your compiler gives to '\n'.
+ I (Philip Hazel) have no knowledge of Windows or VMS sytems and how their
+ libraries work. The items in the PCRE distribution and Makefile that relate to
- (2) Copy or rename the file pcre.in as pcre.h, and change the macro definitions
+ anything other than Unix-like systems are untested by me.
- for PCRE_MAJOR, PCRE_MINOR, and PCRE_DATE near its start to the values set in
- configure.in.
+ There are some other comments and files in the Contrib directory on the ftp
+ site that you may find useful. See
- (3) Compile dftables.c as a stand-alone program, and then run it with
- the standard output sent to chartables.c. This generates a set of standard
+   ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
- character tables.
+ If you want to compile PCRE for a non-Unix system (especially for a system that
- (4) Compile maketables.c, get.c, study.c and pcre.c and link them all
+ does not support "configure" and "make" files), note that the basic PCRE
- together into an object library in whichever form your system keeps such
+ library consists entirely of code written in Standard C, and so should compile
- libraries. This is the pcre library (chartables.c is included by means of an
+ successfully on any system that has a Standard C compiler and library. The C++
- #include directive).
+ wrapper functions are a separate issue (see below).
+ The PCRE distribution contains some experimental support for "cmake", but this
+ is incomplete and not documented. However if you are a "cmake" user you might
+ like to try building with "cmake".
+ 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
+     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
+     define the NEWLINE macro.
+     An alternative approach is not to edit config.h, but to use -D on the
+     compiler command line to make any changes that you need.
+ (2) Copy or rename the file pcre.h.generic as pcre.h.
+ (3) EITHER:
+       Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
+     OR:
+       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
+       character tables and writes them to that file. The tables are generated
+       using the default C locale for your system. If you want to use a locale
+       that is specified by LC_xxx environment variables, add the -L option to
+       the dftables command. You must use this method if you are building on
+       a system that uses EBCDIC code.
+     The tables in pcre_chartables.c are defaults. The caller of PCRE can
+     specify alternative tables at run time.
+ (4) Compile the following source files:
+       pcre_chartables.c
+       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
+     Now link them all together 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.
- (5) Similarly, compile pcreposix.c and link it as the pcreposix library.
+ (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix
+     library.
  (6) Compile the test program pcretest.c. This needs the functions in the
- pcre and pcreposix libraries when linking.
+     pcre and pcreposix libraries when linking.
  (7) Run pcretest on the testinput files in the testdata directory, and check
- that the output matches the corresponding testoutput files. You must use the
+     that the output matches the corresponding testoutput files. Note that the
- -i option when checking testinput2. Note that the supplied files are in Unix
+     supplied files are in Unix format, with just LF characters as line
- format, with just LF characters as line terminators. You may need to edit them
+     terminators. You may need to edit them to change this if your system uses a
- to change this if your system uses a different convention.
+     different convention.
- If you have a system without "configure" but where you can use a Makefile, edit
+ (8) If you want to use the pcregrep command, compile and link pcregrep.c; it
- Makefile.in to create Makefile, substituting suitable values for the variables
+     uses only the basic PCRE library (it does not need the pcreposix library).
- at the head of the file.
- Some help in building a Win32 DLL of PCRE in GnuWin32 environments was
+ THE C++ WRAPPER FUNCTIONS
- contributed by Paul Sokolovsky. These environments are Mingw32
- (http://www.xraylith.wisc.edu/~khan/software/gnu-win32/) and CygWin
+ The PCRE distribution also contains some C++ wrapper functions and tests,
- (http://sourceware.cygnus.com/cygwin/). Paul comments:
+ contributed by Google Inc. On a system that can use "configure" and "make",
+ the functions are automatically built into a library called pcrecpp. It should
-   For CygWin, set CFLAGS=-mno-cygwin, and do 'make dll'. You'll get
+ be straightforward to compile the .cc files manually on other systems. The
-   pcre.dll (containing pcreposix also), libpcre.dll.a, and dynamically
+ files called xxx_unittest.cc are test programs for each of the corresponding
-   linked pgrep and pcretest. If you have /bin/sh, run RunTest (three
+ xxx.cc files.
-   main test go ok, locale not supported).
- Changes to do MinGW with autoconf 2.50 were supplied by Fred Cox
+ BUILDING FOR VIRTUAL PASCAL
- <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
- was contributed by Alexander Tokarev. It is called makevp.bat.
+ was contributed by Alexander Tokarev. Stefan Weber updated the script and added
+ 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.
- These are some further comments about Win32 builds from Mark Evans. They
- 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.)
- =========================
+ COMMENTS ABOUT WIN32 BUILDS
- #ifdef _WIN32
- #include <malloc.h>
+ There are two ways of building PCRE using the "congifure, make, make install"
+ 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
+ some experimental, undocumented support for building using "cmake", which you
+ might like to try if you are familiar with "cmake". However, at the present
+ time, the "cmake" process builds only a static library (not a dll), and the
+ tests are not automatically run.
+ The MinGW home page (http://www.mingw.org/) says this:
+   MinGW: A collection of freely available and freely distributable Windows
+   specific header files and import libraries combined with GNU toolsets that
+   allow one to produce native Windows programs that do not rely on any
+rd-party C runtime DLLs.
+ The Cygwin home page (http://www.cygwin.com/) says this:
+   Cygwin is a Linux-like environment for Windows. It consists of two parts:
+   . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
+     substantial Linux API functionality
+   . 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
- void* malloc_stub(size_t N)
+ However, if you want to statically link your program against the .a file, you
- { return malloc(N); }
+ must define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc()
- void free_stub(void* p)
+ and pcre_free() exported functions will be declared __declspec(dllimport), with
- { free(p); }
+ unwanted results.
- void *(*pcre_malloc)(size_t) = &malloc_stub;
- void  (*pcre_free)(void *) = &free_stub;
- #else
+ 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.
- void *(*pcre_malloc)(size_t) = malloc;
+ MinGW has no such restrictions. The MinGW compiler generates a library or
- void  (*pcre_free)(void *) = free;
+ executable that can run standalone on Windows without any third party dll or
+ licensing issues.
- #endif
+ 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 improves
+ things in this area in future.
+ 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
+ Dan Mooney sent the following comments about building PCRE on OpenVMS. They
+ relate to an older version of PCRE that used fewer source files, so the exact
+ commands will need changing. See the current list of source files above.
+ "It was quite easy to compile and link the library. I don't have a formal
+ make file but the attached file [reproduced below] contains the OpenVMS DCL
+ commands I used to build the library. I had to add #define
+ POSIX_MALLOC_THRESHOLD 10 to pcre.h since it was not defined anywhere.
+ The library was built on:
+ O/S: HP OpenVMS v7.3-1
+ Compiler: Compaq C v6.5-001-48BCD
+ Linker: vA13-01
+ The test results did not match 100% due to the issues you mention in your
+ documentation regarding isprint(), iscntrl(), isgraph() and ispunct(). I
+ modified some of the character tables temporarily and was able to get the
+ results to match. Tests using the fr locale did not match since I don't have
+ that locale loaded. The study size was always reported to be 3 less than the
+ value in the standard test output files."
+ =========================
+ $! This DCL procedure builds PCRE on OpenVMS
+ $!
+ $! I followed the instructions in the non-unix-use file in the distribution.
+ $!
+ $ COMPILE == "CC/LIST/NOMEMBER_ALIGNMENT/PREFIX_LIBRARY_ENTRIES=ALL_ENTRIES
+ $ COMPILE DFTABLES.C
+ $ LINK/EXE=DFTABLES.EXE DFTABLES.OBJ
+ $ RUN DFTABLES.EXE/OUTPUT=CHARTABLES.C
+ $ COMPILE MAKETABLES.C
+ $ COMPILE GET.C
+ $ COMPILE STUDY.C
+ $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
+ $! did not seem to be defined anywhere.
+ $! I edited pcre.h and added #DEFINE SUPPORT_UTF8 to enable UTF8 support.
+ $ COMPILE PCRE.C
+ $ LIB/CREATE PCRE MAKETABLES.OBJ, GET.OBJ, STUDY.OBJ, PCRE.OBJ
+ $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
+ $! did not seem to be defined anywhere.
+ $ COMPILE PCREPOSIX.C
+ $ LIB/CREATE PCREPOSIX PCREPOSIX.OBJ
+ $ COMPILE PCRETEST.C
+ $ LINK/EXE=PCRETEST.EXE PCRETEST.OBJ, PCRE/LIB, PCREPOSIX/LIB
+ $! C programs that want access to command line arguments must be
+ $! defined as a symbol
+ $ PCRETEST :== "$ SYS$ROADSUSERS:[DMOONEY.REGEXP]PCRETEST.EXE"
+ $! Arguments must be enclosed in quotes.
+ $ PCRETEST "-C"
+ $! Test results:
+ $!
+ $!   The test results did not match 100%. The functions isprint(), iscntrl(),
+ $!   isgraph() and ispunct() on OpenVMS must not produce the same results
+ $!   as the system that built the test output files provided with the
+ $!   distribution.
+ $!
+ $!   The study size did not match and was always 3 less on OpenVMS.
+ $!
+ $!   Locale could not be set to fr
+ $!
  =========================
+ Last Updated: 26 March 2007
  ****

 Legend:



Removed from v.63
 


changed lines


 
Added in v.144
 Legend:



Removed from v.63
 


changed lines


 
Added in v.144
-Removed from v.63
+Added in v.144

webmaster@exim.org	ViewVC Help
Powered by ViewVC 1.1.12