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

Compiling PCRE on non-Unix systems
----------------------------------

This document contains the following sections:

  General
  Generic instructions for the PCRE C library
  The C++ wrapper functions
  Building for virtual Pascal
  Comments about Win32 builds
  Building under Windows with BCC5.5
  Building PCRE on OpenVMS


GENERAL

I (Philip Hazel) have no knowledge of Windows or VMS sytems and how their
libraries work. The items in the PCRE distribution and Makefile that relate to
anything other than Unix-like systems are untested by me.

There are some other comments and files in the Contrib directory on the ftp
site that you may find useful. See

  ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib

If you want to compile PCRE for a non-Unix system (especially for a system that
does not support "configure" and "make" files), note that the basic PCRE
library consists entirely of code written in Standard C, and so should compile
successfully on any system that has a Standard C compiler and library. The C++
wrapper functions are a separate issue (see below).

The PCRE distribution contains some experimental support for "cmake", but this
is incomplete and not documented. However if you are a "cmake" user you might
like to try building with "cmake".


GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY

The following are generic comments about building the PCRE C library "by hand".

(1) Copy or rename the file config.h.generic as config.h, and edit the macro
    settings that it contains to whatever is appropriate for your environment.
    In particular, if you want to force a specific value for newline, you can
    define the NEWLINE macro.

    An alternative approach is not to edit config.h, but to use -D on the
    compiler command line to make any changes that you need.

(2) Copy or rename the file pcre.h.generic as pcre.h.

(3) EITHER:
      Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.

    OR:
      Compile dftables.c as a stand-alone program, and then run it with the
      single argument "pcre_chartables.c". This generates a set of standard
      character tables and writes them to that file. The tables are generated
      using the default C locale for your system. If you want to use a locale
      that is specified by LC_xxx environment variables, add the -L option to
      the dftables command. You must use this method if you are building on
      a system that uses EBCDIC code.

    The tables in pcre_chartables.c are defaults. The caller of PCRE can
    specify alternative tables at run time.

(4) Compile the following source files:

      pcre_chartables.c
      pcre_compile.c
      pcre_config.c
      pcre_dfa_exec.c
      pcre_exec.c
      pcre_fullinfo.c
      pcre_get.c
      pcre_globals.c
      pcre_info.c
      pcre_maketables.c
      pcre_newline.c
      pcre_ord2utf8.c
      pcre_refcount.c
      pcre_study.c
      pcre_tables.c
      pcre_try_flipped.c
      pcre_ucp_searchfuncs.c
      pcre_valid_utf8.c
      pcre_version.c
      pcre_xclass.c

    Now link them all together into an object library in whichever form your
    system keeps such libraries. This is the basic PCRE C library. If your
    system has static and shared libraries, you may have to do this once for
    each type.

(5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix
    library.

(6) Compile the test program pcretest.c. This needs the functions in the
    pcre and pcreposix libraries when linking.

(7) Run pcretest on the testinput files in the testdata directory, and check
    that the output matches the corresponding testoutput files. Note that the
    supplied files are in Unix format, with just LF characters as line
    terminators. You may need to edit them to change this if your system uses a
    different convention.

(8) If you want to use the pcregrep command, compile and link pcregrep.c; it
    uses only the basic PCRE library (it does not need the pcreposix library).


THE C++ WRAPPER FUNCTIONS

The PCRE distribution also contains some C++ wrapper functions and tests,
contributed by Google Inc. On a system that can use "configure" and "make",
the functions are automatically built into a library called pcrecpp. It should
be straightforward to compile the .cc files manually on other systems. The
files called xxx_unittest.cc are test programs for each of the corresponding
xxx.cc files.


BUILDING FOR VIRTUAL PASCAL

A script for building PCRE using Borland's C++ compiler for use with VPASCAL
was contributed by Alexander Tokarev. Stefan Weber updated the script and added
additional files. The following files in the distribution are for building PCRE
for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.


COMMENTS ABOUT WIN32 BUILDS

There are two ways of building PCRE using the "congifure, make, make install"
paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
the same thing; they are completely different from each other. There is also
some experimental, undocumented support for building using "cmake", which you
might like to try if you are familiar with "cmake". However, at the present
time, the "cmake" process builds only a static library (not a dll), and the
tests are not automatically run.

The MinGW home page (http://www.mingw.org/) says this:

  MinGW: A collection of freely available and freely distributable Windows
  specific header files and import libraries combined with GNU toolsets that
  allow one to produce native Windows programs that do not rely on any
  3rd-party C runtime DLLs.

The Cygwin home page (http://www.cygwin.com/) says this:

  Cygwin is a Linux-like environment for Windows. It consists of two parts:

  . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
    substantial Linux API functionality

  . A collection of tools which provide Linux look and feel.

  The Cygwin DLL currently works with all recent, commercially released x86 32
  bit and 64 bit versions of Windows, with the exception of Windows CE.

On both MinGW and Cygwin, PCRE should build correctly using:

  ./configure && make && make install

This should create two libraries called libpcre and libpcreposix, and, if you
have enabled building the C++ wrapper, a third one called libpcrecpp.

If you want to statically link your program against a non-dll .a file, you must
define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
pcre_free() exported functions will be declared __declspec(dllimport), with
unwanted results.

Using Cygwin's compiler generates libraries and executables that depend on
cygwin1.dll. If a library that is generated this way is distributed,
cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
licence, this forces not only PCRE to be under the GPL, but also the entire
application. A distributor who wants to keep their own code proprietary must
purchase an appropriate Cygwin licence.

MinGW has no such restrictions. The MinGW compiler generates a library or
executable that can run standalone on Windows without any third party dll or
licensing issues.

But there is more complication:

If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
gcc and MinGW's gcc). So, a user can:

. Build native binaries by using MinGW or by getting Cygwin and using
  -mno-cygwin.

. Build binaries that depend on cygwin1.dll by using Cygwin with the normal
  compiler flags.

The test files that are supplied with PCRE are in Unix format, with LF
characters as line terminators. It may be necessary to change the line
terminators in order to get some of the tests to work. We hope to improve
things in this area in future.


BUILDING UNDER WINDOWS WITH BCC5.5

Michael Roy sent these comments about building PCRE under Windows with BCC5.5:

  Some of the core BCC libraries have a version of PCRE from 1998 built in,
  which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
  version mismatch. I'm including an easy workaround below, if you'd like to
  include it in the non-unix instructions:

  When linking a project with BCC5.5, pcre.lib must be included before any of
  the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
  line.


BUILDING PCRE ON OPENVMS

Dan Mooney sent the following comments about building PCRE on OpenVMS. They
relate to an older version of PCRE that used fewer source files, so the exact
commands will need changing. See the current list of source files above.

"It was quite easy to compile and link the library. I don't have a formal
make file but the attached file [reproduced below] contains the OpenVMS DCL
commands I used to build the library. I had to add #define
POSIX_MALLOC_THRESHOLD 10 to pcre.h since it was not defined anywhere.

The library was built on:
O/S: HP OpenVMS v7.3-1
Compiler: Compaq C v6.5-001-48BCD
Linker: vA13-01

The test results did not match 100% due to the issues you mention in your
documentation regarding isprint(), iscntrl(), isgraph() and ispunct(). I
modified some of the character tables temporarily and was able to get the
results to match. Tests using the fr locale did not match since I don't have
that locale loaded. The study size was always reported to be 3 less than the
value in the standard test output files."

=========================
$! This DCL procedure builds PCRE on OpenVMS
$!
$! I followed the instructions in the non-unix-use file in the distribution.
$!
$ COMPILE == "CC/LIST/NOMEMBER_ALIGNMENT/PREFIX_LIBRARY_ENTRIES=ALL_ENTRIES
$ COMPILE DFTABLES.C
$ LINK/EXE=DFTABLES.EXE DFTABLES.OBJ
$ RUN DFTABLES.EXE/OUTPUT=CHARTABLES.C
$ COMPILE MAKETABLES.C
$ COMPILE GET.C
$ COMPILE STUDY.C
$! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
$! did not seem to be defined anywhere.
$! I edited pcre.h and added #DEFINE SUPPORT_UTF8 to enable UTF8 support.
$ COMPILE PCRE.C
$ LIB/CREATE PCRE MAKETABLES.OBJ, GET.OBJ, STUDY.OBJ, PCRE.OBJ
$! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
$! did not seem to be defined anywhere.
$ COMPILE PCREPOSIX.C
$ LIB/CREATE PCREPOSIX PCREPOSIX.OBJ
$ COMPILE PCRETEST.C
$ LINK/EXE=PCRETEST.EXE PCRETEST.OBJ, PCRE/LIB, PCREPOSIX/LIB
$! C programs that want access to command line arguments must be
$! defined as a symbol
$ PCRETEST :== "$ SYS$ROADSUSERS:[DMOONEY.REGEXP]PCRETEST.EXE"
$! Arguments must be enclosed in quotes.
$ PCRETEST "-C"
$! Test results:
$!
$!   The test results did not match 100%. The functions isprint(), iscntrl(),
$!   isgraph() and ispunct() on OpenVMS must not produce the same results
$!   as the system that built the test output files provided with the
$!   distribution.
$!
$!   The study size did not match and was always 3 less on OpenVMS.
$!
$!   Locale could not be set to fr
$!
=========================

Last Updated: 24 April 2007
****
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	134	Comments about Win32 builds
11	ph10	131	Building under Windows with BCC5.5
12	ph10	134	Building PCRE on OpenVMS
13	ph10	131
14
15			GENERAL
16
17	ph10	101	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	ph10	122	anything other than Unix-like systems are untested by me.
20	nigel	63
21	ph10	101	There are some other comments and files in the Contrib directory on the ftp
22	ph10	128	site that you may find useful. See
23	ph10	101
24	nigel	75	ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
25	nigel	41
26	ph10	144	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	nigel	73
32	ph10	145	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	ph10	144	like to try building with "cmake".
35	nigel	75
36	ph10	144
37	ph10	131	GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
38	nigel	75
39	ph10	111	The following are generic comments about building the PCRE C library "by hand".
40	nigel	75
41	ph10	111	(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	nigel	41
46	ph10	111	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	nigel	75
49	ph10	122	(2) Copy or rename the file pcre.h.generic as pcre.h.
50	nigel	41
51	ph10	128	(3) EITHER:
52			Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
53	nigel	75
54	ph10	128	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	ph10	111	(4) Compile the following source files:
67	nigel	41
68	ph10	111	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	nigel	79
89	ph10	111	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	nigel	79
94	ph10	111	(5) Similarly, compile pcreposix.c and link it (on its own) as the pcreposix
95			library.
96	nigel	75
97	ph10	111	(6) Compile the test program pcretest.c. This needs the functions in the
98			pcre and pcreposix libraries when linking.
99	nigel	41
100	ph10	111	(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	nigel	75
106	ph10	111	(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	nigel	41
109	nigel	75
110	nigel	79	THE C++ WRAPPER FUNCTIONS
111
112	ph10	111	The PCRE distribution also contains some C++ wrapper functions and tests,
113	nigel	79	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	ph10	111	BUILDING FOR VIRTUAL PASCAL
121	nigel	75
122	ph10	128	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	ph10	135	for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
126	ph10	101
127	ph10	111
128	ph10	131	COMMENTS ABOUT WIN32 BUILDS
129	ph10	111
130	ph10	145	There are two ways of building PCRE using the "congifure, make, make install"
131	ph10	144	paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
132	ph10	145	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	ph10	144	time, the "cmake" process builds only a static library (not a dll), and the
136			tests are not automatically run.
137	nigel	93
138	ph10	131	The MinGW home page (http://www.mingw.org/) says this:
139	nigel	93
140	ph10	131	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	nigel	93
145	ph10	131	The Cygwin home page (http://www.cygwin.com/) says this:
146	ph10	111
147	ph10	134	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	ph10	131	substantial Linux API functionality
151	ph10	134
152	ph10	131	. A collection of tools which provide Linux look and feel.
153	ph10	111
154	ph10	134	The Cygwin DLL currently works with all recent, commercially released x86 32
155	ph10	131	bit and 64 bit versions of Windows, with the exception of Windows CE.
156	ph10	111
157	ph10	131	On both MinGW and Cygwin, PCRE should build correctly using:
158	nigel	41
159	ph10	134	./configure && make && make install
160	ph10	148
161	ph10	146	This should create two libraries called libpcre and libpcreposix, and, if you
162			have enabled building the C++ wrapper, a third one called libpcrecpp.
163	ph10	134
164	ph10	146	If you want to statically link your program against a non-dll .a file, you must
165			define PCRE_STATIC before including pcre.h, otherwise the pcre_malloc() and
166			pcre_free() exported functions will be declared __declspec(dllimport), with
167	ph10	131	unwanted results.
168	nigel	41
169	ph10	131	Using Cygwin's compiler generates libraries and executables that depend on
170			cygwin1.dll. If a library that is generated this way is distributed,
171			cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
172			licence, this forces not only PCRE to be under the GPL, but also the entire
173			application. A distributor who wants to keep their own code proprietary must
174			purchase an appropriate Cygwin licence.
175	nigel	63
176	ph10	131	MinGW has no such restrictions. The MinGW compiler generates a library or
177			executable that can run standalone on Windows without any third party dll or
178			licensing issues.
179	nigel	63
180	ph10	131	But there is more complication:
181	nigel	63
182	ph10	131	If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
183			to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
184			front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
185			gcc and MinGW's gcc). So, a user can:
186	nigel	63
187	ph10	134	. Build native binaries by using MinGW or by getting Cygwin and using
188	ph10	131	-mno-cygwin.
189	nigel	63
190	ph10	134	. Build binaries that depend on cygwin1.dll by using Cygwin with the normal
191	ph10	131	compiler flags.
192	nigel	63
193	ph10	134	The test files that are supplied with PCRE are in Unix format, with LF
194			characters as line terminators. It may be necessary to change the line
195	ph10	155	terminators in order to get some of the tests to work. We hope to improve
196	ph10	131	things in this area in future.
197	nigel	63
198
199	ph10	131	BUILDING UNDER WINDOWS WITH BCC5.5
200	nigel	63
201	ph10	131	Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
202	nigel	63
203	ph10	131	Some of the core BCC libraries have a version of PCRE from 1998 built in,
204			which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
205			version mismatch. I'm including an easy workaround below, if you'd like to
206			include it in the non-unix instructions:
207	nigel	63
208	ph10	131	When linking a project with BCC5.5, pcre.lib must be included before any of
209			the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
210			line.
211	nigel	63
212
213	nigel	75	BUILDING PCRE ON OPENVMS
214
215	nigel	79	Dan Mooney sent the following comments about building PCRE on OpenVMS. They
216			relate to an older version of PCRE that used fewer source files, so the exact
217			commands will need changing. See the current list of source files above.
218	nigel	75
219			"It was quite easy to compile and link the library. I don't have a formal
220			make file but the attached file [reproduced below] contains the OpenVMS DCL
221			commands I used to build the library. I had to add #define
222			POSIX_MALLOC_THRESHOLD 10 to pcre.h since it was not defined anywhere.
223
224			The library was built on:
225			O/S: HP OpenVMS v7.3-1
226			Compiler: Compaq C v6.5-001-48BCD
227			Linker: vA13-01
228
229			The test results did not match 100% due to the issues you mention in your
230			documentation regarding isprint(), iscntrl(), isgraph() and ispunct(). I
231			modified some of the character tables temporarily and was able to get the
232			results to match. Tests using the fr locale did not match since I don't have
233			that locale loaded. The study size was always reported to be 3 less than the
234			value in the standard test output files."
235
236			=========================
237			$! This DCL procedure builds PCRE on OpenVMS
238			$!
239			$! I followed the instructions in the non-unix-use file in the distribution.
240			$!
241			$ COMPILE == "CC/LIST/NOMEMBER_ALIGNMENT/PREFIX_LIBRARY_ENTRIES=ALL_ENTRIES
242			$ COMPILE DFTABLES.C
243			$ LINK/EXE=DFTABLES.EXE DFTABLES.OBJ
244			$ RUN DFTABLES.EXE/OUTPUT=CHARTABLES.C
245			$ COMPILE MAKETABLES.C
246			$ COMPILE GET.C
247			$ COMPILE STUDY.C
248			$! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
249			$! did not seem to be defined anywhere.
250			$! I edited pcre.h and added #DEFINE SUPPORT_UTF8 to enable UTF8 support.
251			$ COMPILE PCRE.C
252			$ LIB/CREATE PCRE MAKETABLES.OBJ, GET.OBJ, STUDY.OBJ, PCRE.OBJ
253			$! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
254			$! did not seem to be defined anywhere.
255			$ COMPILE PCREPOSIX.C
256			$ LIB/CREATE PCREPOSIX PCREPOSIX.OBJ
257			$ COMPILE PCRETEST.C
258			$ LINK/EXE=PCRETEST.EXE PCRETEST.OBJ, PCRE/LIB, PCREPOSIX/LIB
259			$! C programs that want access to command line arguments must be
260			$! defined as a symbol
261			$ PCRETEST :== "$ SYS$ROADSUSERS:[DMOONEY.REGEXP]PCRETEST.EXE"
262			$! Arguments must be enclosed in quotes.
263			$ PCRETEST "-C"
264			$! Test results:
265			$!
266			$! The test results did not match 100%. The functions isprint(), iscntrl(),
267			$! isgraph() and ispunct() on OpenVMS must not produce the same results
268			$! as the system that built the test output files provided with the
269			$! distribution.
270			$!
271			$! The study size did not match and was always 3 less on OpenVMS.
272			$!
273			$! Locale could not be set to fr
274			$!
275			=========================
276
277	ph10	155	Last Updated: 24 April 2007
278	nigel	41	****
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"