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

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

Parent Directory | Revision Log | View Patch Patch

-revision 198 by ph10,
Tue Jul 31 11:11:23 2007 UTC
+revision 371 by ph10,
Mon Aug 25 18:28:05 2008 UTC
 Line 8 
 This document contains the following sec
    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 knowledge of Windows or VMS sytems and how their
+ 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 are untested by me.
-Line 30 
 library consists entirely of code writte
+Line 34 
 library consists entirely of code writte
  successfully on any system that has a Standard C compiler and library. The C++
  wrapper functions are a separate issue (see below).
- The PCRE distribution contains some experimental support for "cmake", but this
+ The PCRE distribution includes a "configure" file for use by the Configure/Make
- 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
- like to try building with "cmake".
+ 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 PCRE C LIBRARY
-Line 42 
 The following are generic comments about
+Line 49 
 The following are generic comments about
   (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.
+      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
+      in the sources.
       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.
+      compiler command line to make any changes that you need to the
+      configuration options. In this case -DHAVE_CONFIG_H must not be set.
       NOTE: There have been occasions when the way in which certain parameters
       in config.h are used has changed between releases. (In the configure/make
-Line 59 
 The following are generic comments about
+Line 69 
 The following are generic comments about
         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
+        Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
-        single argument "pcre_chartables.c". This generates a set of standard
+        you have set up config.h), and then run it with the single argument
-        character tables and writes them to that file. The tables are generated
+        "pcre_chartables.c". This generates a set of standard character tables
-        using the default C locale for your system. If you want to use a locale
+        and writes them to that file. The tables are generated using the default
-        that is specified by LC_xxx environment variables, add the -L option to
+        C locale for your system. If you want to use a locale that is specified
-        the dftables command. You must use this method if you are building on
+        by LC_xxx environment variables, add the -L option to the dftables
-        a system that uses EBCDIC code.
+        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.
-Line 78 
 The following are generic comments about
+Line 89 
 The following are generic comments about
         ucptable.h
   (5) Also ensure that you have the following file, which is #included as source
-      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.
         pcre_printint.src
-  (6) Compile the following source files:
+  (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
+      option if you have set up config.h with your configuration, or else use
+      other -D settings to change the configuration as required.
         pcre_chartables.c
         pcre_compile.c
-Line 105 
 The following are generic comments about
+Line 118 
 The following are generic comments about
         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 and link the result (on its own) as the
+  (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
-      pcreposix library.
+      and link the result (on its own) as the pcreposix library.
-  (9) Compile the test program pcretest.c. This needs the functions in the
+  (9) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
-      pcre and pcreposix libraries when linking. It also needs the
+      This needs the functions in the pcre and pcreposix libraries when linking.
-      pcre_printint.src source file, which it #includes.
+      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.
+      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.
  (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).
-Line 151 
 The default processor stack size of 1Mb
+Line 172 
 The default processor stack size of 1Mb
  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. There is more about stack
+ be too small for some pattern/subject combinations.
- usage in the "pcrestack" documentation.
+ PCRE has a compile configuration option to disable the use of stack for
+ recursion so that heap is used instead. However, pattern matching is
+ significantly slower when this is done. There is more about stack usage in the
+ "pcrestack" documentation.
+ LINKING PROGRAMS IN WINDOWS ENVIRONMENTS
+ 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.
- COMMENTS ABOUT WIN32 BUILDS
+ CALLING CONVENTIONS IN WINDOWS ENVIRONMENTS
+ It is possible to compile programs to use different calling conventions using
+ MSVC. Search the web for "calling conventions" for more information. To make it
+ easier to change the calling convention for the exported functions in the
+ PCRE library, the macro PCRE_CALL_CONVENTION is present in all the external
+ definitions. It can be set externally when compiling (e.g. in CFLAGS). If it is
+ not set, it defaults to empty; the default calling convention is then used
+ (which is what is wanted most of the time).
+ COMMENTS ABOUT WIN32 BUILDS (see also "BUILDING PCRE WITH CMAKE" below)
  There are two ways of building PCRE using the "configure, 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
+ support for building using CMake, which some users find a more straightforward
- 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
- time, the "cmake" process builds only a static library (not a dll), and the
+ automatically when CMake is used.
- tests are not automatically run.
  The MinGW home page (http://www.mingw.org/) says this:
-Line 197 
 also link with libpcre, which contains t
+Line 240 
 also link with libpcre, which contains t
  releases of PCRE included the basic libpcre functions in libpcreposix. This no
  longer happens.)
- 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
- define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
+ "pcre.dll" under mingw32 using the "msys" environment. It provides "pcre.dll"
- 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
- unwanted results.
+ 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,
-Line 232 
 terminators in order to get some of the
+Line 278 
 terminators in order to get some of the
  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:
-Line 310 
 $!   Locale could not be set to fr
+Line 439 
 $!   Locale could not be set to fr
  $!
  =========================
- Last Updated: 05 July 2007
+ Last Updated: 09 July 2008
  ****

 Legend:



Removed from v.198
 


changed lines


 
Added in v.371
 Legend:



Removed from v.198
 


changed lines


 
Added in v.371
-Removed from v.198
+Added in v.371

webmaster@exim.org	ViewVC Help
Powered by ViewVC 1.1.12