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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 401 - (hide annotations) (download)
Sat Mar 21 17:13:18 2009 UTC (5 years, 5 months ago) by ph10
File size: 18456 byte(s)
Add comments about contributed .chm files.

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