/[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 145 by ph10, Wed Apr 4 14:06:52 2007 UTC revision 252 by ph10, Mon Sep 17 10:38:40 2007 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    Comments about Win32 builds    Comments about Win32 builds
12    Building under Windows with BCC5.5    Building under Windows with BCC5.5
13    Building PCRE on OpenVMS    Building PCRE on OpenVMS
# Line 14  This document contains the following sec Line 15  This document contains the following sec
15    
16  GENERAL  GENERAL
17    
18  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
19  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
20  anything other than Unix-like systems are untested by me.  anything other than Unix-like systems are untested by me.
21    
# Line 38  GENERIC INSTRUCTIONS FOR THE PCRE C LIBR Line 39  GENERIC INSTRUCTIONS FOR THE PCRE C LIBR
39    
40  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".
41    
42  (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
43      settings that it contains to whatever is appropriate for your environment.       settings that it contains to whatever is appropriate for your environment.
44      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
45      define the NEWLINE macro.       define the NEWLINE macro. When you compile any of the PCRE modules, you
46         must specify -DHAVE_CONFIG_H to your compiler so that config.h is included
47      An alternative approach is not to edit config.h, but to use -D on the       in the sources.
48      compiler command line to make any changes that you need.  
49         An alternative approach is not to edit config.h, but to use -D on the
50  (2) Copy or rename the file pcre.h.generic as pcre.h.       compiler command line to make any changes that you need to the
51         configuration options. In this case -DHAVE_CONFIG_H must not be set.
52  (3) EITHER:  
53        Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.       NOTE: There have been occasions when the way in which certain parameters
54         in config.h are used has changed between releases. (In the configure/make
55      OR:       world, this is handled automatically.) When upgrading to a new release,
56        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
57        single argument "pcre_chartables.c". This generates a set of standard       you had previously.
58        character tables and writes them to that file. The tables are generated  
59        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.
60        that is specified by LC_xxx environment variables, add the -L option to  
61        the dftables command. You must use this method if you are building on   (3) EITHER:
62        a system that uses EBCDIC code.         Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
63    
64      The tables in pcre_chartables.c are defaults. The caller of PCRE can       OR:
65      specify alternative tables at run time.         Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
66           you have set up config.h), and then run it with the single argument
67  (4) Compile the following source files:         "pcre_chartables.c". This generates a set of standard character tables
68           and writes them to that file. The tables are generated using the default
69        pcre_chartables.c         C locale for your system. If you want to use a locale that is specified
70        pcre_compile.c         by LC_xxx environment variables, add the -L option to the dftables
71        pcre_config.c         command. You must use this method if you are building on a system that
72        pcre_dfa_exec.c         uses EBCDIC code.
73        pcre_exec.c  
74        pcre_fullinfo.c       The tables in pcre_chartables.c are defaults. The caller of PCRE can
75        pcre_get.c       specify alternative tables at run time.
76        pcre_globals.c  
77        pcre_info.c   (4) Ensure that you have the following header files:
78        pcre_maketables.c  
79        pcre_newline.c         pcre_internal.h
80        pcre_ord2utf8.c         ucp.h
81        pcre_refcount.c         ucpinternal.h
82        pcre_study.c         ucptable.h
83        pcre_tables.c  
84        pcre_try_flipped.c   (5) Also ensure that you have the following file, which is #included as source
85        pcre_ucp_searchfuncs.c       when building a debugging version of PCRE and is also used by pcretest.
86        pcre_valid_utf8.c  
87        pcre_version.c         pcre_printint.src
88        pcre_xclass.c  
89     (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
90      Now link them all together into an object library in whichever form your       option if you have set up config.h with your configuration, or else use
91      system keeps such libraries. This is the basic PCRE C library. If your       other -D settings to change the configuration as required.
92      system has static and shared libraries, you may have to do this once for  
93      each type.         pcre_chartables.c
94           pcre_compile.c
95  (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix         pcre_config.c
96      library.         pcre_dfa_exec.c
97           pcre_exec.c
98  (6) Compile the test program pcretest.c. This needs the functions in the         pcre_fullinfo.c
99      pcre and pcreposix libraries when linking.         pcre_get.c
100           pcre_globals.c
101  (7) Run pcretest on the testinput files in the testdata directory, and check         pcre_info.c
102      that the output matches the corresponding testoutput files. Note that the         pcre_maketables.c
103      supplied files are in Unix format, with just LF characters as line         pcre_newline.c
104      terminators. You may need to edit them to change this if your system uses a         pcre_ord2utf8.c
105      different convention.         pcre_refcount.c
106           pcre_study.c
107           pcre_tables.c
108           pcre_try_flipped.c
109           pcre_ucp_searchfuncs.c
110           pcre_valid_utf8.c
111           pcre_version.c
112           pcre_xclass.c
113    
114         Make sure that you include -I. in the compiler command (or equivalent for
115         an unusual compiler) so that all included PCRE header files are first
116         sought in the current directory. Otherwise you run the risk of picking up
117         a previously-installed file from somewhere else.
118    
119     (7) Now link all the compiled code into an object library in whichever form
120         your system keeps such libraries. This is the basic PCRE C library. If
121         your system has static and shared libraries, you may have to do this once
122         for each type.
123    
124     (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
125         and link the result (on its own) as the pcreposix library.
126    
127     (9) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
128         This needs the functions in the pcre and pcreposix libraries when linking.
129         It also needs the pcre_printint.src source file, which it #includes.
130    
131    (10) Run pcretest on the testinput files in the testdata directory, and check
132         that the output matches the corresponding testoutput files. Note that the
133         supplied files are in Unix format, with just LF characters as line
134         terminators. You may need to edit them to change this if your system uses
135         a different convention. If you are using Windows, you probably should use
136         the wintestinput3 file instead of testinput3 (and the corresponding output
137         file). This is a locale test; wintestinput3 sets the locale to "french"
138         rather than "fr_FR", and there some minor output differences.
139    
140  (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
141      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).
142    
143    
144  THE C++ WRAPPER FUNCTIONS  THE C++ WRAPPER FUNCTIONS
# Line 125  additional files. The following files in Line 159  additional files. The following files in
159  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.
160    
161    
162    STACK SIZE IN WINDOWS ENVIRONMENTS
163    
164    The default processor stack size of 1Mb in some Windows environments is too
165    small for matching patterns that need much recursion. In particular, test 2 may
166    fail because of this. Normally, running out of stack causes a crash, but there
167    have been cases where the test program has just died silently. See your linker
168    documentation for how to increase stack size if you experience problems. The
169    Linux default of 8Mb is a reasonable choice for the stack, though even that can
170    be too small for some pattern/subject combinations. There is more about stack
171    usage in the "pcrestack" documentation.
172    
173    
174  COMMENTS ABOUT WIN32 BUILDS  COMMENTS ABOUT WIN32 BUILDS
175    
176  There are two ways of building PCRE using the "congifure, make, make install"  There are two ways of building PCRE using the "configure, make, make install"
177  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
178  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
179  some experimental, undocumented support for building using "cmake", which you  some experimental, undocumented support for building using "cmake", which you
# Line 158  On both MinGW and Cygwin, PCRE should bu Line 204  On both MinGW and Cygwin, PCRE should bu
204    
205    ./configure && make && make install    ./configure && make && make install
206    
207  However, if you want to statically link your program against the .a file, you  This should create two libraries called libpcre and libpcreposix, and, if you
208  must define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc()  have enabled building the C++ wrapper, a third one called libpcrecpp. These are
209  and pcre_free() exported functions will be declared __declspec(dllimport), with  independent libraries: when you like with libpcreposix or libpcrecpp you must
210    also link with libpcre, which contains the basic functions. (Some earlier
211    releases of PCRE included the basic libpcre functions in libpcreposix. This no
212    longer happens.)
213    
214    If you want to statically link your program against a non-dll .a file, you must
215    define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
216    pcre_free() exported functions will be declared __declspec(dllimport), with
217  unwanted results.  unwanted results.
218    
219  Using Cygwin's compiler generates libraries and executables that depend on  Using Cygwin's compiler generates libraries and executables that depend on
# Line 189  gcc and MinGW's gcc). So, a user can: Line 242  gcc and MinGW's gcc). So, a user can:
242    
243  The test files that are supplied with PCRE are in Unix format, with LF  The test files that are supplied with PCRE are in Unix format, with LF
244  characters as line terminators. It may be necessary to change the line  characters as line terminators. It may be necessary to change the line
245  terminators in order to get some of the tests to work. We hope to improves  terminators in order to get some of the tests to work. We hope to improve
246  things in this area in future.  things in this area in future.
247    
248    
# Line 271  $! Locale could not be set to fr Line 324  $! Locale could not be set to fr
324  $!  $!
325  =========================  =========================
326    
327  Last Updated: 26 March 2007  Last Updated: 17 September 2007
328  ****  ****
Legend:
Removed from v.145  
changed lines
  Added in v.252
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12