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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 306 - (hide annotations) (download)
Sun Jan 20 20:17:10 2008 UTC (6 years, 2 months ago) by ph10
File size: 17112 byte(s)
Added user-suggested comments about CMake relative paths to NON-UNIX-USE.

1 nigel 41 Compiling PCRE on non-Unix systems
2     ----------------------------------
3    
4 ph10 131 This document contains the following sections:
5    
6     General
7 ph10 134 Generic instructions for the PCRE C library
8 ph10 131 The C++ wrapper functions
9     Building for virtual Pascal
10 ph10 198 Stack size in Windows environments
11 ph10 134 Comments about Win32 builds
12 ph10 260 Building PCRE with CMake
13 ph10 306 Use of relative paths with CMake on Windows
14     Testing with runtest.bat
15 ph10 131 Building under Windows with BCC5.5
16 ph10 134 Building PCRE on OpenVMS
17 ph10 131
18    
19     GENERAL
20    
21 ph10 200 I (Philip Hazel) have no experience of Windows or VMS sytems and how their
22 ph10 101 libraries work. The items in the PCRE distribution and Makefile that relate to
23 ph10 122 anything other than Unix-like systems are untested by me.
24 nigel 63
25 ph10 101 There are some other comments and files in the Contrib directory on the ftp
26 ph10 128 site that you may find useful. See
27 ph10 101
28 nigel 75 ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
29 nigel 41
30 ph10 144 If you want to compile PCRE for a non-Unix system (especially for a system that
31     does not support "configure" and "make" files), note that the basic PCRE
32     library consists entirely of code written in Standard C, and so should compile
33     successfully on any system that has a Standard C compiler and library. The C++
34     wrapper functions are a separate issue (see below).
35 nigel 73
36 ph10 260 The PCRE distribution includes support for CMake. This support is relatively
37     new, but has already been used successfully to build PCRE in multiple build
38     environments on Windows. There are some instructions in the section entitled
39     "Building PCRE with CMake" below.
40 nigel 75
41 ph10 144
42 ph10 131 GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
43 nigel 75
44 ph10 111 The following are generic comments about building the PCRE C library "by hand".
45 nigel 75
46 ph10 188 (1) Copy or rename the file config.h.generic as config.h, and edit the macro
47     settings that it contains to whatever is appropriate for your environment.
48     In particular, if you want to force a specific value for newline, you can
49 ph10 237 define the NEWLINE macro. When you compile any of the PCRE modules, you
50     must specify -DHAVE_CONFIG_H to your compiler so that config.h is included
51     in the sources.
52 ph10 197
53 ph10 188 An alternative approach is not to edit config.h, but to use -D on the
54 ph10 243 compiler command line to make any changes that you need to the
55 ph10 237 configuration options. In this case -DHAVE_CONFIG_H must not be set.
56 ph10 197
57 ph10 188 NOTE: There have been occasions when the way in which certain parameters
58     in config.h are used has changed between releases. (In the configure/make
59     world, this is handled automatically.) When upgrading to a new release,
60     you are strongly advised to review config.h.generic before re-using what
61     you had previously.
62 ph10 197
63 ph10 188 (2) Copy or rename the file pcre.h.generic as pcre.h.
64 ph10 197
65 ph10 188 (3) EITHER:
66     Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
67 ph10 197
68 ph10 188 OR:
69 ph10 243 Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
70 ph10 237 you have set up config.h), and then run it with the single argument
71     "pcre_chartables.c". This generates a set of standard character tables
72     and writes them to that file. The tables are generated using the default
73     C locale for your system. If you want to use a locale that is specified
74     by LC_xxx environment variables, add the -L option to the dftables
75     command. You must use this method if you are building on a system that
76     uses EBCDIC code.
77 ph10 197
78 ph10 188 The tables in pcre_chartables.c are defaults. The caller of PCRE can
79     specify alternative tables at run time.
80 ph10 197
81 ph10 188 (4) Ensure that you have the following header files:
82 ph10 197
83 ph10 188 pcre_internal.h
84     ucp.h
85     ucpinternal.h
86     ucptable.h
87 ph10 197
88 ph10 188 (5) Also ensure that you have the following file, which is #included as source
89 ph10 287 when building a debugging version of PCRE, and is also used by pcretest.
90 ph10 197
91 ph10 188 pcre_printint.src
92 ph10 197
93 ph10 237 (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
94 ph10 243 option if you have set up config.h with your configuration, or else use
95 ph10 237 other -D settings to change the configuration as required.
96 ph10 197
97 ph10 188 pcre_chartables.c
98     pcre_compile.c
99     pcre_config.c
100     pcre_dfa_exec.c
101     pcre_exec.c
102     pcre_fullinfo.c
103     pcre_get.c
104     pcre_globals.c
105     pcre_info.c
106     pcre_maketables.c
107     pcre_newline.c
108     pcre_ord2utf8.c
109     pcre_refcount.c
110     pcre_study.c
111     pcre_tables.c
112     pcre_try_flipped.c
113     pcre_ucp_searchfuncs.c
114     pcre_valid_utf8.c
115     pcre_version.c
116     pcre_xclass.c
117 ph10 197
118 ph10 200 Make sure that you include -I. in the compiler command (or equivalent for
119     an unusual compiler) so that all included PCRE header files are first
120     sought in the current directory. Otherwise you run the risk of picking up
121     a previously-installed file from somewhere else.
122    
123 ph10 188 (7) Now link all the compiled code into an object library in whichever form
124     your system keeps such libraries. This is the basic PCRE C library. If
125     your system has static and shared libraries, you may have to do this once
126     for each type.
127 ph10 197
128 ph10 237 (8) Similarly, compile pcreposix.c (remembering -DHAVE_CONFIG_H if necessary)
129     and link the result (on its own) as the pcreposix library.
130 nigel 41
131 ph10 237 (9) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
132     This needs the functions in the pcre and pcreposix libraries when linking.
133     It also needs the pcre_printint.src source file, which it #includes.
134 ph10 182
135 ph10 188 (10) Run pcretest on the testinput files in the testdata directory, and check
136     that the output matches the corresponding testoutput files. Note that the
137     supplied files are in Unix format, with just LF characters as line
138     terminators. You may need to edit them to change this if your system uses
139 ph10 254 a different convention. If you are using Windows, you probably should use
140     the wintestinput3 file instead of testinput3 (and the corresponding output
141     file). This is a locale test; wintestinput3 sets the locale to "french"
142     rather than "fr_FR", and there some minor output differences.
143 nigel 75
144 ph10 188 (11) If you want to use the pcregrep command, compile and link pcregrep.c; it
145     uses only the basic PCRE library (it does not need the pcreposix library).
146 nigel 41
147 nigel 75
148 nigel 79 THE C++ WRAPPER FUNCTIONS
149    
150 ph10 111 The PCRE distribution also contains some C++ wrapper functions and tests,
151 nigel 79 contributed by Google Inc. On a system that can use "configure" and "make",
152     the functions are automatically built into a library called pcrecpp. It should
153     be straightforward to compile the .cc files manually on other systems. The
154     files called xxx_unittest.cc are test programs for each of the corresponding
155     xxx.cc files.
156    
157    
158 ph10 111 BUILDING FOR VIRTUAL PASCAL
159 nigel 75
160 ph10 128 A script for building PCRE using Borland's C++ compiler for use with VPASCAL
161     was contributed by Alexander Tokarev. Stefan Weber updated the script and added
162     additional files. The following files in the distribution are for building PCRE
163 ph10 135 for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
164 ph10 101
165 ph10 111
166 ph10 198 STACK SIZE IN WINDOWS ENVIRONMENTS
167    
168     The default processor stack size of 1Mb in some Windows environments is too
169     small for matching patterns that need much recursion. In particular, test 2 may
170     fail because of this. Normally, running out of stack causes a crash, but there
171     have been cases where the test program has just died silently. See your linker
172 ph10 200 documentation for how to increase stack size if you experience problems. The
173     Linux default of 8Mb is a reasonable choice for the stack, though even that can
174 ph10 261 be too small for some pattern/subject combinations.
175 ph10 198
176 ph10 260 PCRE has a compile configuration option to disable the use of stack for
177     recursion so that heap is used instead. However, pattern matching is
178     significantly slower when this is done. There is more about stack usage in the
179     "pcrestack" documentation.
180 ph10 198
181 ph10 111
182 ph10 260 COMMENTS ABOUT WIN32 BUILDS (see also "BUILDING PCRE WITH CMAKE" below)
183    
184 ph10 177 There are two ways of building PCRE using the "configure, make, make install"
185 ph10 144 paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
186 ph10 145 the same thing; they are completely different from each other. There is also
187     some experimental, undocumented support for building using "cmake", which you
188     might like to try if you are familiar with "cmake". However, at the present
189 ph10 144 time, the "cmake" process builds only a static library (not a dll), and the
190     tests are not automatically run.
191 nigel 93
192 ph10 131 The MinGW home page (http://www.mingw.org/) says this:
193 nigel 93
194 ph10 131 MinGW: A collection of freely available and freely distributable Windows
195     specific header files and import libraries combined with GNU toolsets that
196     allow one to produce native Windows programs that do not rely on any
197     3rd-party C runtime DLLs.
198 nigel 93
199 ph10 131 The Cygwin home page (http://www.cygwin.com/) says this:
200 ph10 111
201 ph10 134 Cygwin is a Linux-like environment for Windows. It consists of two parts:
202    
203     . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
204 ph10 131 substantial Linux API functionality
205 ph10 134
206 ph10 131 . A collection of tools which provide Linux look and feel.
207 ph10 111
208 ph10 134 The Cygwin DLL currently works with all recent, commercially released x86 32
209 ph10 131 bit and 64 bit versions of Windows, with the exception of Windows CE.
210 ph10 111
211 ph10 131 On both MinGW and Cygwin, PCRE should build correctly using:
212 nigel 41
213 ph10 134 ./configure && make && make install
214 ph10 148
215 ph10 146 This should create two libraries called libpcre and libpcreposix, and, if you
216 ph10 182 have enabled building the C++ wrapper, a third one called libpcrecpp. These are
217     independent libraries: when you like with libpcreposix or libpcrecpp you must
218     also link with libpcre, which contains the basic functions. (Some earlier
219     releases of PCRE included the basic libpcre functions in libpcreposix. This no
220 ph10 181 longer happens.)
221 ph10 134
222 ph10 146 If you want to statically link your program against a non-dll .a file, you must
223     define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
224     pcre_free() exported functions will be declared __declspec(dllimport), with
225 ph10 131 unwanted results.
226 nigel 41
227 ph10 131 Using Cygwin's compiler generates libraries and executables that depend on
228     cygwin1.dll. If a library that is generated this way is distributed,
229     cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
230     licence, this forces not only PCRE to be under the GPL, but also the entire
231     application. A distributor who wants to keep their own code proprietary must
232     purchase an appropriate Cygwin licence.
233 nigel 63
234 ph10 131 MinGW has no such restrictions. The MinGW compiler generates a library or
235     executable that can run standalone on Windows without any third party dll or
236     licensing issues.
237 nigel 63
238 ph10 131 But there is more complication:
239 nigel 63
240 ph10 131 If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
241     to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
242     front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
243     gcc and MinGW's gcc). So, a user can:
244 nigel 63
245 ph10 134 . Build native binaries by using MinGW or by getting Cygwin and using
246 ph10 131 -mno-cygwin.
247 nigel 63
248 ph10 134 . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
249 ph10 131 compiler flags.
250 nigel 63
251 ph10 134 The test files that are supplied with PCRE are in Unix format, with LF
252     characters as line terminators. It may be necessary to change the line
253 ph10 155 terminators in order to get some of the tests to work. We hope to improve
254 ph10 131 things in this area in future.
255 nigel 63
256    
257 ph10 258 BUILDING PCRE WITH CMAKE
258    
259 ph10 260 CMake is an alternative build facility that can be used instead of the
260     traditional Unix "configure". CMake version 2.4.7 supports Borland makefiles,
261     MinGW makefiles, MSYS makefiles, NMake makefiles, UNIX makefiles, Visual Studio
262     6, Visual Studio 7, Visual Studio 8, and Watcom W8. The following instructions
263     were contributed by a PCRE user.
264 ph10 258
265 ph10 259 1. Download CMake 2.4.7 or above from http://www.cmake.org/, install and ensure
266 ph10 258 that cmake\bin is on your path.
267    
268     2. Unzip (retaining folder structure) the PCRE source tree into a source
269     directory such as C:\pcre.
270    
271     3. Create a new, empty build directory: C:\pcre\build\
272    
273     4. Run CMakeSetup from the Shell envirornment of your build tool, e.g., Msys
274     for Msys/MinGW or Visual Studio Command Prompt for VC/VC++
275    
276     5. Enter C:\pcre\pcre-xx and C:\pcre\build for the source and build
277     directories, respectively
278    
279     6. Hit the "Configure" button.
280    
281     7. Select the particular IDE / build tool that you are using (Visual Studio,
282     MSYS makefiles, MinGW makefiles, etc.)
283    
284     8. The GUI will then list several configuration options. This is where you can
285     enable UTF-8 support, etc.
286    
287     9. Hit "Configure" again. The adjacent "OK" button should now be active.
288    
289     10. Hit "OK".
290    
291     11. The build directory should now contain a usable build system, be it a
292     solution file for Visual Studio, makefiles for MinGW, etc.
293    
294    
295 ph10 306 USE OF RELATIVE PATHS WITH CMAKE ON WINDOWS
296    
297     A PCRE user comments as follows:
298    
299     I thought that others may want to know the current state of
300     CMAKE_USE_RELATIVE_PATHS support on Windows.
301    
302     Here it is:
303     -- AdditionalIncludeDirectories is only partially modified (only the
304     first path - see below)
305     -- Only some of the contained file paths are modified - shown below for
306     pcre.vcproj
307     -- It properly modifies
308    
309     I am sure CMake people can fix that if they want to. Until then one will
310     need to replace existing absolute paths in project files with relative
311     paths manually (e.g. from VS) - relative to project file location. I did
312     just that before being told to try CMAKE_USE_RELATIVE_PATHS. Not a big
313     deal.
314    
315     AdditionalIncludeDirectories="E:\builds\pcre\build;E:\builds\pcre\pcre-7.5;"
316     AdditionalIncludeDirectories=".;E:\builds\pcre\pcre-7.5;"
317    
318     RelativePath="pcre.h">
319     RelativePath="pcre_chartables.c">
320     RelativePath="pcre_chartables.c.rule">
321    
322    
323     TESTING WITH RUNTEST.BAT
324    
325 ph10 258 1. Copy RunTest.bat into the directory where pcretest.exe has been created.
326    
327     2. Edit RunTest.bat and insert a line that indentifies the relative location of
328     the pcre source, e.g.:
329    
330     set srcdir=..\pcre-7.4-RC3
331    
332     3. Run RunTest.bat from a command shell environment. Test outputs will
333     automatically be compared to expected results, and discrepancies will
334     identified in the console output.
335    
336     4. To test pcrecpp, run pcrecpp_unittest.exe, pcre_stringpiece_unittest.exe and
337     pcre_scanner_unittest.exe.
338 ph10 306
339 ph10 258
340 ph10 131 BUILDING UNDER WINDOWS WITH BCC5.5
341 nigel 63
342 ph10 131 Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
343 nigel 63
344 ph10 131 Some of the core BCC libraries have a version of PCRE from 1998 built in,
345     which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
346     version mismatch. I'm including an easy workaround below, if you'd like to
347     include it in the non-unix instructions:
348 nigel 63
349 ph10 131 When linking a project with BCC5.5, pcre.lib must be included before any of
350     the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
351     line.
352 nigel 63
353 ph10 259
354 nigel 75 BUILDING PCRE ON OPENVMS
355    
356 nigel 79 Dan Mooney sent the following comments about building PCRE on OpenVMS. They
357     relate to an older version of PCRE that used fewer source files, so the exact
358     commands will need changing. See the current list of source files above.
359 nigel 75
360     "It was quite easy to compile and link the library. I don't have a formal
361     make file but the attached file [reproduced below] contains the OpenVMS DCL
362     commands I used to build the library. I had to add #define
363     POSIX_MALLOC_THRESHOLD 10 to pcre.h since it was not defined anywhere.
364    
365     The library was built on:
366     O/S: HP OpenVMS v7.3-1
367     Compiler: Compaq C v6.5-001-48BCD
368     Linker: vA13-01
369    
370     The test results did not match 100% due to the issues you mention in your
371     documentation regarding isprint(), iscntrl(), isgraph() and ispunct(). I
372     modified some of the character tables temporarily and was able to get the
373     results to match. Tests using the fr locale did not match since I don't have
374     that locale loaded. The study size was always reported to be 3 less than the
375     value in the standard test output files."
376    
377     =========================
378     $! This DCL procedure builds PCRE on OpenVMS
379     $!
380     $! I followed the instructions in the non-unix-use file in the distribution.
381     $!
382     $ COMPILE == "CC/LIST/NOMEMBER_ALIGNMENT/PREFIX_LIBRARY_ENTRIES=ALL_ENTRIES
383     $ COMPILE DFTABLES.C
384     $ LINK/EXE=DFTABLES.EXE DFTABLES.OBJ
385     $ RUN DFTABLES.EXE/OUTPUT=CHARTABLES.C
386     $ COMPILE MAKETABLES.C
387     $ COMPILE GET.C
388     $ COMPILE STUDY.C
389     $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
390     $! did not seem to be defined anywhere.
391     $! I edited pcre.h and added #DEFINE SUPPORT_UTF8 to enable UTF8 support.
392     $ COMPILE PCRE.C
393     $ LIB/CREATE PCRE MAKETABLES.OBJ, GET.OBJ, STUDY.OBJ, PCRE.OBJ
394     $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
395     $! did not seem to be defined anywhere.
396     $ COMPILE PCREPOSIX.C
397     $ LIB/CREATE PCREPOSIX PCREPOSIX.OBJ
398     $ COMPILE PCRETEST.C
399     $ LINK/EXE=PCRETEST.EXE PCRETEST.OBJ, PCRE/LIB, PCREPOSIX/LIB
400     $! C programs that want access to command line arguments must be
401     $! defined as a symbol
402     $ PCRETEST :== "$ SYS$ROADSUSERS:[DMOONEY.REGEXP]PCRETEST.EXE"
403     $! Arguments must be enclosed in quotes.
404     $ PCRETEST "-C"
405     $! Test results:
406     $!
407     $! The test results did not match 100%. The functions isprint(), iscntrl(),
408     $! isgraph() and ispunct() on OpenVMS must not produce the same results
409     $! as the system that built the test output files provided with the
410     $! distribution.
411     $!
412     $! The study size did not match and was always 3 less on OpenVMS.
413     $!
414     $! Locale could not be set to fr
415     $!
416     =========================
417    
418 ph10 306 Last Updated: 20 January 2008
419 nigel 41 ****

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12