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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 258 - (show annotations) (download)
Wed Sep 19 09:27:50 2007 UTC (6 years, 11 months ago) by ph10
File size: 15615 byte(s)
Sheri's CMake updates and notes.

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

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