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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 359 - (hide annotations) (download)
Wed Jul 9 16:20:19 2008 UTC (6 years, 2 months ago) by ph10
File size: 18279 byte(s)
Add PCRE_CALL_CONVENTION for MSVC users; add some missing PCRE_EXP_DEFNs.

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