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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 316 - (hide annotations) (download)
Fri Jan 25 17:38:26 2008 UTC (6 years, 7 months ago) by ph10
File size: 17241 byte(s)
Update comments about CMake.

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