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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 144 - (show annotations) (download)
Mon Apr 2 13:32:07 2007 UTC (7 years, 6 months ago) by ph10
File size: 10907 byte(s)
Daniel's patches to add to the CMake support.

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 Comments about Win32 builds
11 Building under Windows with BCC5.5
12 Building PCRE on OpenVMS
13
14
15 GENERAL
16
17 I (Philip Hazel) have no knowledge of Windows or VMS sytems and how their
18 libraries work. The items in the PCRE distribution and Makefile that relate to
19 anything other than Unix-like systems are untested by me.
20
21 There are some other comments and files in the Contrib directory on the ftp
22 site that you may find useful. See
23
24 ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
25
26 If you want to compile PCRE for a non-Unix system (especially for a system that
27 does not support "configure" and "make" files), note that the basic PCRE
28 library consists entirely of code written in Standard C, and so should compile
29 successfully on any system that has a Standard C compiler and library. The C++
30 wrapper functions are a separate issue (see below).
31
32 The PCRE distribution contains some experimental support for "cmake", but this
33 is incomplete and not documented. However if you are a "cmake" user you might
34 like to try building with "cmake".
35
36
37 GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
38
39 The following are generic comments about building the PCRE C library "by hand".
40
41 (1) Copy or rename the file config.h.generic as config.h, and edit the macro
42 settings that it contains to whatever is appropriate for your environment.
43 In particular, if you want to force a specific value for newline, you can
44 define the NEWLINE macro.
45
46 An alternative approach is not to edit config.h, but to use -D on the
47 compiler command line to make any changes that you need.
48
49 (2) Copy or rename the file pcre.h.generic as pcre.h.
50
51 (3) EITHER:
52 Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
53
54 OR:
55 Compile dftables.c as a stand-alone program, and then run it with the
56 single argument "pcre_chartables.c". This generates a set of standard
57 character tables and writes them to that file. The tables are generated
58 using the default C locale for your system. If you want to use a locale
59 that is specified by LC_xxx environment variables, add the -L option to
60 the dftables command. You must use this method if you are building on
61 a system that uses EBCDIC code.
62
63 The tables in pcre_chartables.c are defaults. The caller of PCRE can
64 specify alternative tables at run time.
65
66 (4) Compile the following source files:
67
68 pcre_chartables.c
69 pcre_compile.c
70 pcre_config.c
71 pcre_dfa_exec.c
72 pcre_exec.c
73 pcre_fullinfo.c
74 pcre_get.c
75 pcre_globals.c
76 pcre_info.c
77 pcre_maketables.c
78 pcre_newline.c
79 pcre_ord2utf8.c
80 pcre_refcount.c
81 pcre_study.c
82 pcre_tables.c
83 pcre_try_flipped.c
84 pcre_ucp_searchfuncs.c
85 pcre_valid_utf8.c
86 pcre_version.c
87 pcre_xclass.c
88
89 Now link them all together into an object library in whichever form your
90 system keeps such libraries. This is the basic PCRE C library. If your
91 system has static and shared libraries, you may have to do this once for
92 each type.
93
94 (5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix
95 library.
96
97 (6) Compile the test program pcretest.c. This needs the functions in the
98 pcre and pcreposix libraries when linking.
99
100 (7) Run pcretest on the testinput files in the testdata directory, and check
101 that the output matches the corresponding testoutput files. Note that the
102 supplied files are in Unix format, with just LF characters as line
103 terminators. You may need to edit them to change this if your system uses a
104 different convention.
105
106 (8) If you want to use the pcregrep command, compile and link pcregrep.c; it
107 uses only the basic PCRE library (it does not need the pcreposix library).
108
109
110 THE C++ WRAPPER FUNCTIONS
111
112 The PCRE distribution also contains some C++ wrapper functions and tests,
113 contributed by Google Inc. On a system that can use "configure" and "make",
114 the functions are automatically built into a library called pcrecpp. It should
115 be straightforward to compile the .cc files manually on other systems. The
116 files called xxx_unittest.cc are test programs for each of the corresponding
117 xxx.cc files.
118
119
120 BUILDING FOR VIRTUAL PASCAL
121
122 A script for building PCRE using Borland's C++ compiler for use with VPASCAL
123 was contributed by Alexander Tokarev. Stefan Weber updated the script and added
124 additional files. The following files in the distribution are for building PCRE
125 for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
126
127
128 COMMENTS ABOUT WIN32 BUILDS
129
130 There are two ways of building PCRE using the "congifure, make, make install"
131 paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
132 the same thing; they are completely different from each other. There is also
133 some experimental, undocumented support for building using "cmake", which you
134 might like to try if you are familiar with "cmake". However, at the present
135 time, the "cmake" process builds only a static library (not a dll), and the
136 tests are not automatically run.
137
138 The MinGW home page (http://www.mingw.org/) says this:
139
140 MinGW: A collection of freely available and freely distributable Windows
141 specific header files and import libraries combined with GNU toolsets that
142 allow one to produce native Windows programs that do not rely on any
143 3rd-party C runtime DLLs.
144
145 The Cygwin home page (http://www.cygwin.com/) says this:
146
147 Cygwin is a Linux-like environment for Windows. It consists of two parts:
148
149 . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
150 substantial Linux API functionality
151
152 . A collection of tools which provide Linux look and feel.
153
154 The Cygwin DLL currently works with all recent, commercially released x86 32
155 bit and 64 bit versions of Windows, with the exception of Windows CE.
156
157 On both MinGW and Cygwin, PCRE should build correctly using:
158
159 ./configure && make && make install
160
161 However, if you want to statically link your program against the .a file, you
162 must define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc()
163 and pcre_free() exported functions will be declared __declspec(dllimport), with
164 unwanted results.
165
166 Using Cygwin's compiler generates libraries and executables that depend on
167 cygwin1.dll. If a library that is generated this way is distributed,
168 cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
169 licence, this forces not only PCRE to be under the GPL, but also the entire
170 application. A distributor who wants to keep their own code proprietary must
171 purchase an appropriate Cygwin licence.
172
173 MinGW has no such restrictions. The MinGW compiler generates a library or
174 executable that can run standalone on Windows without any third party dll or
175 licensing issues.
176
177 But there is more complication:
178
179 If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
180 to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
181 front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
182 gcc and MinGW's gcc). So, a user can:
183
184 . Build native binaries by using MinGW or by getting Cygwin and using
185 -mno-cygwin.
186
187 . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
188 compiler flags.
189
190 The test files that are supplied with PCRE are in Unix format, with LF
191 characters as line terminators. It may be necessary to change the line
192 terminators in order to get some of the tests to work. We hope to improves
193 things in this area in future.
194
195
196 BUILDING UNDER WINDOWS WITH BCC5.5
197
198 Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
199
200 Some of the core BCC libraries have a version of PCRE from 1998 built in,
201 which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
202 version mismatch. I'm including an easy workaround below, if you'd like to
203 include it in the non-unix instructions:
204
205 When linking a project with BCC5.5, pcre.lib must be included before any of
206 the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
207 line.
208
209
210 BUILDING PCRE ON OPENVMS
211
212 Dan Mooney sent the following comments about building PCRE on OpenVMS. They
213 relate to an older version of PCRE that used fewer source files, so the exact
214 commands will need changing. See the current list of source files above.
215
216 "It was quite easy to compile and link the library. I don't have a formal
217 make file but the attached file [reproduced below] contains the OpenVMS DCL
218 commands I used to build the library. I had to add #define
219 POSIX_MALLOC_THRESHOLD 10 to pcre.h since it was not defined anywhere.
220
221 The library was built on:
222 O/S: HP OpenVMS v7.3-1
223 Compiler: Compaq C v6.5-001-48BCD
224 Linker: vA13-01
225
226 The test results did not match 100% due to the issues you mention in your
227 documentation regarding isprint(), iscntrl(), isgraph() and ispunct(). I
228 modified some of the character tables temporarily and was able to get the
229 results to match. Tests using the fr locale did not match since I don't have
230 that locale loaded. The study size was always reported to be 3 less than the
231 value in the standard test output files."
232
233 =========================
234 $! This DCL procedure builds PCRE on OpenVMS
235 $!
236 $! I followed the instructions in the non-unix-use file in the distribution.
237 $!
238 $ COMPILE == "CC/LIST/NOMEMBER_ALIGNMENT/PREFIX_LIBRARY_ENTRIES=ALL_ENTRIES
239 $ COMPILE DFTABLES.C
240 $ LINK/EXE=DFTABLES.EXE DFTABLES.OBJ
241 $ RUN DFTABLES.EXE/OUTPUT=CHARTABLES.C
242 $ COMPILE MAKETABLES.C
243 $ COMPILE GET.C
244 $ COMPILE STUDY.C
245 $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
246 $! did not seem to be defined anywhere.
247 $! I edited pcre.h and added #DEFINE SUPPORT_UTF8 to enable UTF8 support.
248 $ COMPILE PCRE.C
249 $ LIB/CREATE PCRE MAKETABLES.OBJ, GET.OBJ, STUDY.OBJ, PCRE.OBJ
250 $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
251 $! did not seem to be defined anywhere.
252 $ COMPILE PCREPOSIX.C
253 $ LIB/CREATE PCREPOSIX PCREPOSIX.OBJ
254 $ COMPILE PCRETEST.C
255 $ LINK/EXE=PCRETEST.EXE PCRETEST.OBJ, PCRE/LIB, PCREPOSIX/LIB
256 $! C programs that want access to command line arguments must be
257 $! defined as a symbol
258 $ PCRETEST :== "$ SYS$ROADSUSERS:[DMOONEY.REGEXP]PCRETEST.EXE"
259 $! Arguments must be enclosed in quotes.
260 $ PCRETEST "-C"
261 $! Test results:
262 $!
263 $! The test results did not match 100%. The functions isprint(), iscntrl(),
264 $! isgraph() and ispunct() on OpenVMS must not produce the same results
265 $! as the system that built the test output files provided with the
266 $! distribution.
267 $!
268 $! The study size did not match and was always 3 less on OpenVMS.
269 $!
270 $! Locale could not be set to fr
271 $!
272 =========================
273
274 Last Updated: 26 March 2007
275 ****

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