"Fossies" - the Fresh Open Source Software Archive
Member "AutoHotkey_L-1.1.33.09/source/lib_pcre/pcre/NON-UNIX-USE" (8 May 2021, 23892 Bytes) of package /windows/misc/AutoHotkey_L-1.1.33.09.zip:
As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard
) with prefixed line numbers.
Alternatively you can here view
the uninterpreted source code file.
1 Compiling PCRE on non-Unix systems
4 This document contains the following sections:
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 Linking programs in Windows environments
12 Comments about Win32 builds
13 Building PCRE on Windows with CMake
14 Use of relative paths with CMake on Windows
15 Testing with RunTest.bat
16 Building under Windows with BCC5.5
17 Building PCRE on OpenVMS
18 Building PCRE on Stratus OpenVOS
23 I (Philip Hazel) have no experience of Windows or VMS sytems and how their
24 libraries work. The items in the PCRE distribution and Makefile that relate to
25 anything other than Unix-like systems are untested by me.
27 There are some other comments and files (including some documentation in CHM
28 format) in the Contrib directory on the FTP site:
32 If you want to compile PCRE for a non-Unix system (especially for a system that
33 does not support "configure" and "make" files), note that the basic PCRE
34 library consists entirely of code written in Standard C, and so should compile
35 successfully on any system that has a Standard C compiler and library. The C++
36 wrapper functions are a separate issue (see below).
38 The PCRE distribution includes a "configure" file for use by the Configure/Make
39 build system, as found in many Unix-like environments. There is also support
40 for CMake, which some users prefer, especially in Windows environments. See
41 the instructions for CMake under Windows in the section entitled "Building
42 PCRE with CMake" below. CMake can also be used to build PCRE in Unix-like
46 GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
48 The following are generic instructions for building the PCRE C library "by
51 (1) Copy or rename the file config.h.generic as config.h, and edit the macro
52 settings that it contains to whatever is appropriate for your environment.
53 In particular, if you want to force a specific value for newline, you can
54 define the NEWLINE macro. When you compile any of the PCRE modules, you
55 must specify -DHAVE_CONFIG_H to your compiler so that config.h is included
56 in the sources.
58 An alternative approach is not to edit config.h, but to use -D on the
59 compiler command line to make any changes that you need to the
60 configuration options. In this case -DHAVE_CONFIG_H must not be set.
62 NOTE: There have been occasions when the way in which certain parameters
63 in config.h are used has changed between releases. (In the configure/make
64 world, this is handled automatically.) When upgrading to a new release,
65 you are strongly advised to review config.h.generic before re-using what
66 you had previously.
68 (2) Copy or rename the file pcre.h.generic as pcre.h.
70 (3) EITHER:
71 Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
74 Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
75 you have set up config.h), and then run it with the single argument
76 "pcre_chartables.c". This generates a set of standard character tables
77 and writes them to that file. The tables are generated using the default
78 C locale for your system. If you want to use a locale that is specified
79 by LC_xxx environment variables, add the -L option to the dftables
80 command. You must use this method if you are building on a system that
81 uses EBCDIC code.
83 The tables in pcre_chartables.c are defaults. The caller of PCRE can
84 specify alternative tables at run time.
86 (4) Ensure that you have the following header files:
91 (5) For an 8-bit library, compile the following source files, setting
92 -DHAVE_CONFIG_H as a compiler option if you have set up config.h with your
93 configuration, or else use other -D settings to change the configuration
94 as required.
117 Make sure that you include -I. in the compiler command (or equivalent for
118 an unusual compiler) so that all included PCRE header files are first
119 sought in the current directory. Otherwise you run the risk of picking up
120 a previously-installed file from somewhere else.
122 (6) If you have defined SUPPORT_JIT in config.h, you must also compile
126 This file #includes sources from the sljit subdirectory, where there
127 should be 16 files, all of whose names begin with "sljit".
129 (7) Now link all the compiled code into an object library in whichever form
130 your system keeps such libraries. This is the basic PCRE C 8-bit library.
131 If your system has static and shared libraries, you may have to do this
132 once for each type.
134 (8) If you want to build a 16-bit library (as well as, or instead of the 8-bit
135 library) repeat steps 5-7 with the following files:
146 pcre16_jit_compile.c (if SUPPORT_JIT is defined)
160 (9) If you want to build the POSIX wrapper functions (which apply only to the
161 8-bit library), ensure that you have the pcreposix.h file and then compile
162 pcreposix.c (remembering -DHAVE_CONFIG_H if necessary). Link the result
163 (on its own) as the pcreposix library.
165 (10) The pcretest program can be linked with either or both of the 8-bit and
166 16-bit libraries (depending on what you selected in config.h). Compile
167 pcretest.c and pcre_printint.c (again, don't forget -DHAVE_CONFIG_H) and
168 link them together with the appropriate library/ies. If you compiled an
169 8-bit library, pcretest also needs the pcreposix wrapper library unless
170 you compiled it with -DNOPOSIX.
172 (11) Run pcretest on the testinput files in the testdata directory, and check
173 that the output matches the corresponding testoutput files. If you
174 compiled both an 8-bit and a 16-bit library, you need to run pcretest with
175 the -16 option to do 16-bit tests.
177 Some tests are relevant only when certain build-time options are selected.
178 For example, test 4 is for UTF-8 or UTF-16 support, and will not run if
179 you have built PCRE without it. See the comments at the start of each
180 testinput file. If you have a suitable Unix-like shell, the RunTest script
181 will run the appropriate tests for you.
183 Note that the supplied files are in Unix format, with just LF characters
184 as line terminators. You may need to edit them to change this if your
185 system uses a different convention. If you are using Windows, you probably
186 should use the wintestinput3 file instead of testinput3 (and the
187 corresponding output file). This is a locale test; wintestinput3 sets the
188 locale to "french" rather than "fr_FR", and there some minor output
191 (12) If you have built PCRE with SUPPORT_JIT, the JIT features will be tested
192 by the testdata files. However, you might also like to build and run
193 the JIT test program, pcre_jit_test.c.
195 (13) If you want to use the pcregrep command, compile and link pcregrep.c; it
196 uses only the basic 8-bit PCRE library (it does not need the pcreposix
200 THE C++ WRAPPER FUNCTIONS
202 The PCRE distribution also contains some C++ wrapper functions and tests,
203 applicable to the 8-bit library, which were contributed by Google Inc. On a
204 system that can use "configure" and "make", the functions are automatically
205 built into a library called pcrecpp. It should be straightforward to compile
206 the .cc files manually on other systems. The files called xxx_unittest.cc are
207 test programs for each of the corresponding xxx.cc files.
210 BUILDING FOR VIRTUAL PASCAL
212 A script for building PCRE using Borland's C++ compiler for use with VPASCAL
213 was contributed by Alexander Tokarev. Stefan Weber updated the script and added
214 additional files. The following files in the distribution are for building PCRE
215 for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
218 STACK SIZE IN WINDOWS ENVIRONMENTS
220 The default processor stack size of 1Mb in some Windows environments is too
221 small for matching patterns that need much recursion. In particular, test 2 may
222 fail because of this. Normally, running out of stack causes a crash, but there
223 have been cases where the test program has just died silently. See your linker
224 documentation for how to increase stack size if you experience problems. The
225 Linux default of 8Mb is a reasonable choice for the stack, though even that can
226 be too small for some pattern/subject combinations.
228 PCRE has a compile configuration option to disable the use of stack for
229 recursion so that heap is used instead. However, pattern matching is
230 significantly slower when this is done. There is more about stack usage in the
231 "pcrestack" documentation.
234 LINKING PROGRAMS IN WINDOWS ENVIRONMENTS
236 If you want to statically link a program against a PCRE library in the form of
237 a non-dll .a file, you must define PCRE_STATIC before including pcre.h or
238 pcrecpp.h, otherwise the pcre_malloc() and pcre_free() exported functions will
239 be declared __declspec(dllimport), with unwanted results.
242 CALLING CONVENTIONS IN WINDOWS ENVIRONMENTS
244 It is possible to compile programs to use different calling conventions using
245 MSVC. Search the web for "calling conventions" for more information. To make it
246 easier to change the calling convention for the exported functions in the
247 PCRE library, the macro PCRE_CALL_CONVENTION is present in all the external
248 definitions. It can be set externally when compiling (e.g. in CFLAGS). If it is
249 not set, it defaults to empty; the default calling convention is then used
250 (which is what is wanted most of the time).
253 COMMENTS ABOUT WIN32 BUILDS (see also "BUILDING PCRE WITH CMAKE" below)
255 There are two ways of building PCRE using the "configure, make, make install"
256 paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
257 the same thing; they are completely different from each other. There is also
258 support for building using CMake, which some users find a more straightforward
259 way of building PCRE under Windows.
261 The MinGW home page (http://www.mingw.org/) says this:
263 MinGW: A collection of freely available and freely distributable Windows
264 specific header files and import libraries combined with GNU toolsets that
265 allow one to produce native Windows programs that do not rely on any
266 3rd-party C runtime DLLs.
268 The Cygwin home page (http://www.cygwin.com/) says this:
270 Cygwin is a Linux-like environment for Windows. It consists of two parts:
272 . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
273 substantial Linux API functionality
275 . A collection of tools which provide Linux look and feel.
277 The Cygwin DLL currently works with all recent, commercially released x86 32
278 bit and 64 bit versions of Windows, with the exception of Windows CE.
280 On both MinGW and Cygwin, PCRE should build correctly using:
282 ./configure && make && make install
284 This should create two libraries called libpcre and libpcreposix, and, if you
285 have enabled building the C++ wrapper, a third one called libpcrecpp. These are
286 independent libraries: when you link with libpcreposix or libpcrecpp you must
287 also link with libpcre, which contains the basic functions. (Some earlier
288 releases of PCRE included the basic libpcre functions in libpcreposix. This no
289 longer happens.)
291 A user submitted a special-purpose patch that makes it easy to create
292 "pcre.dll" under mingw32 using the "msys" environment. It provides "pcre.dll"
293 as a special target. If you use this target, no other files are built, and in
294 particular, the pcretest and pcregrep programs are not built. An example of how
295 this might be used is:
297 ./configure --enable-utf --disable-cpp CFLAGS="-03 -s"; make pcre.dll
299 Using Cygwin's compiler generates libraries and executables that depend on
300 cygwin1.dll. If a library that is generated this way is distributed,
301 cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
302 licence, this forces not only PCRE to be under the GPL, but also the entire
303 application. A distributor who wants to keep their own code proprietary must
304 purchase an appropriate Cygwin licence.
306 MinGW has no such restrictions. The MinGW compiler generates a library or
307 executable that can run standalone on Windows without any third party dll or
308 licensing issues.
310 But there is more complication:
312 If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
313 to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
314 front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
315 gcc and MinGW's gcc). So, a user can:
317 . Build native binaries by using MinGW or by getting Cygwin and using
320 . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
321 compiler flags.
323 The test files that are supplied with PCRE are in UNIX format, with LF
324 characters as line terminators. Unless your PCRE library uses a default newline
325 option that includes LF as a valid newline, it may be necessary to change the
326 line terminators in the test files to get some of the tests to work.
328 BUILDING PCRE ON WINDOWS WITH CMAKE
330 CMake is an alternative configuration facility that can be used instead of the
331 traditional Unix "configure". CMake creates project files (make files, solution
332 files, etc.) tailored to numerous development environments, including Visual
333 Studio, Borland, Msys, MinGW, NMake, and Unix. If possible, use short paths
334 with no spaces in the names for your CMake installation and your pcre
335 source and build directories.
337 The following instructions were contributed by a PCRE user.
339 1. Install the latest CMake version available from http://www.cmake.org/, and
340 ensure that cmake\bin is on your path.
342 2. Unzip (retaining folder structure) the PCRE source tree into a source
343 directory such as C:\pcre. You should ensure your local date and time
344 is not earlier than the file dates in your source dir if the release is
345 very new.
347 3. Create a new, empty build directory, preferably a subdirectory of the
348 source dir. For example, C:\pcre\pcre-xx\build.
350 4. Run cmake-gui from the Shell envirornment of your build tool, for example,
351 Msys for Msys/MinGW or Visual Studio Command Prompt for VC/VC++.
353 5. Enter C:\pcre\pcre-xx and C:\pcre\pcre-xx\build for the source and build
354 directories, respectively.
356 6. Hit the "Configure" button.
358 7. Select the particular IDE / build tool that you are using (Visual
359 Studio, MSYS makefiles, MinGW makefiles, etc.)
361 8. The GUI will then list several configuration options. This is where
362 you can enable UTF-8 support or other PCRE optional features.
364 9. Hit "Configure" again. The adjacent "Generate" button should now be
367 10. Hit "Generate".
369 11. The build directory should now contain a usable build system, be it a
370 solution file for Visual Studio, makefiles for MinGW, etc. Exit from
371 cmake-gui and use the generated build system with your compiler or IDE.
372 E.g., for MinGW you can run "make", or for Visual Studio, open the PCRE
373 solution, select the desired configuration (Debug, or Release, etc.) and
374 build the ALL_BUILD project.
376 12. If during configuration with cmake-gui you've elected to build the test
377 programs, you can execute them by building the test project. E.g., for
378 MinGW: "make test"; for Visual Studio build the RUN_TESTS project. The
379 most recent build configuration is targeted by the tests. A summary of
380 test results is presented. Complete test output is subsequently
381 available for review in Testing\Temporary under your build dir.
383 USE OF RELATIVE PATHS WITH CMAKE ON WINDOWS
385 A PCRE user comments as follows:
387 I thought that others may want to know the current state of
388 CMAKE_USE_RELATIVE_PATHS support on Windows.
390 Here it is:
391 -- AdditionalIncludeDirectories is only partially modified (only the
392 first path - see below)
393 -- Only some of the contained file paths are modified - shown below for
395 -- It properly modifies
397 I am sure CMake people can fix that if they want to. Until then one will
398 need to replace existing absolute paths in project files with relative
399 paths manually (e.g. from VS) - relative to project file location. I did
400 just that before being told to try CMAKE_USE_RELATIVE_PATHS. Not a big
411 TESTING WITH RUNTEST.BAT
413 If configured with CMake, building the test project ("make test" or building
414 ALL_TESTS in Visual Studio) creates (and runs) pcre_test.bat (and depending
415 on your configuration options, possibly other test programs) in the build
416 directory. Pcre_test.bat runs RunTest.Bat with correct source and exe paths.
418 For manual testing with RunTest.bat, provided the build dir is a subdirectory
419 of the source directory: Open command shell window. Chdir to the location
420 of your pcretest.exe and pcregrep.exe programs. Call RunTest.bat with
421 "..\RunTest.Bat" or "..\..\RunTest.bat" as appropriate.
423 To run only a particular test with RunTest.Bat provide a test number argument.
427 1. Copy RunTest.bat into the directory where pcretest.exe and pcregrep.exe
428 have been created.
430 2. Edit RunTest.bat to indentify the full or relative location of
431 the pcre source (wherein which the testdata folder resides), e.g.:
433 set srcdir=C:\pcre\pcre-8.20
435 3. In a Windows command environment, chdir to the location of your bat and
436 exe programs.
438 4. Run RunTest.bat. Test outputs will automatically be compared to expected
439 results, and discrepancies will be identified in the console output.
441 To independently test the just-in-time compiler, run pcre_jit_test.exe.
442 To test pcrecpp, run pcrecpp_unittest.exe, pcre_stringpiece_unittest.exe and
445 BUILDING UNDER WINDOWS WITH BCC5.5
447 Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
449 Some of the core BCC libraries have a version of PCRE from 1998 built in,
450 which can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a
451 version mismatch. I'm including an easy workaround below, if you'd like to
452 include it in the non-unix instructions:
454 When linking a project with BCC5.5, pcre.lib must be included before any of
455 the libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command
459 BUILDING UNDER WINDOWS CE WITH VISUAL STUDIO 200x
461 Vincent Richomme sent a zip archive of files to help with this process. They
462 can be found in the file "pcre-vsbuild.zip" in the Contrib directory of the FTP
466 BUILDING PCRE ON OPENVMS
468 Dan Mooney sent the following comments about building PCRE on OpenVMS. They
469 relate to an older version of PCRE that used fewer source files, so the exact
470 commands will need changing. See the current list of source files above.
472 "It was quite easy to compile and link the library. I don't have a formal
473 make file but the attached file [reproduced below] contains the OpenVMS DCL
474 commands I used to build the library. I had to add #define
475 POSIX_MALLOC_THRESHOLD 10 to pcre.h since it was not defined anywhere.
477 The library was built on:
478 O/S: HP OpenVMS v7.3-1
479 Compiler: Compaq C v6.5-001-48BCD
480 Linker: vA13-01
482 The test results did not match 100% due to the issues you mention in your
483 documentation regarding isprint(), iscntrl(), isgraph() and ispunct(). I
484 modified some of the character tables temporarily and was able to get the
485 results to match. Tests using the fr locale did not match since I don't have
486 that locale loaded. The study size was always reported to be 3 less than the
487 value in the standard test output files."
490 $! This DCL procedure builds PCRE on OpenVMS
492 $! I followed the instructions in the non-unix-use file in the distribution.
494 $ COMPILE == "CC/LIST/NOMEMBER_ALIGNMENT/PREFIX_LIBRARY_ENTRIES=ALL_ENTRIES
495 $ COMPILE DFTABLES.C
496 $ LINK/EXE=DFTABLES.EXE DFTABLES.OBJ
497 $ RUN DFTABLES.EXE/OUTPUT=CHARTABLES.C
498 $ COMPILE MAKETABLES.C
499 $ COMPILE GET.C
500 $ COMPILE STUDY.C
501 $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
502 $! did not seem to be defined anywhere.
503 $! I edited pcre.h and added #DEFINE SUPPORT_UTF8 to enable UTF8 support.
504 $ COMPILE PCRE.C
505 $ LIB/CREATE PCRE MAKETABLES.OBJ, GET.OBJ, STUDY.OBJ, PCRE.OBJ
506 $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
507 $! did not seem to be defined anywhere.
508 $ COMPILE PCREPOSIX.C
509 $ LIB/CREATE PCREPOSIX PCREPOSIX.OBJ
510 $ COMPILE PCRETEST.C
511 $ LINK/EXE=PCRETEST.EXE PCRETEST.OBJ, PCRE/LIB, PCREPOSIX/LIB
512 $! C programs that want access to command line arguments must be
513 $! defined as a symbol
514 $ PCRETEST :== "$ SYS$ROADSUSERS:[DMOONEY.REGEXP]PCRETEST.EXE"
515 $! Arguments must be enclosed in quotes.
516 $ PCRETEST "-C"
517 $! Test results:
519 $! The test results did not match 100%. The functions isprint(), iscntrl(),
520 $! isgraph() and ispunct() on OpenVMS must not produce the same results
521 $! as the system that built the test output files provided with the
522 $! distribution.
524 $! The study size did not match and was always 3 less on OpenVMS.
526 $! Locale could not be set to fr
531 BUILDING PCRE ON STRATUS OPENVOS
533 These notes on the port of PCRE to VOS (lightly edited) were supplied by
534 Ashutosh Warikoo, whose email address has the local part awarikoo and the
535 domain nse.co.in. The port was for version 7.9 in August 2009.
537 1. Building PCRE
539 I built pcre on OpenVOS Release 17.0.1at using GNU Tools 3.4a without any
540 problems. I used the following packages to build PCRE:
544 Please read and follow the instructions that come with these packages. To start
545 the build of pcre, from the root of the package type:
549 2. Installing PCRE
551 Once you have successfully built PCRE, login to the SysAdmin group, switch to
552 the root user, and type
554 [ !create_dir (master_disk)>usr --if needed ]
555 [ !create_dir (master_disk)>usr>local --if needed ]
556 !gmake install
558 This installs PCRE and its man pages into /usr/local. You can add
559 (master_disk)>usr>local>bin to your command search paths, or if you are in
560 BASH, add /usr/local/bin to the PATH environment variable.
562 4. Restrictions
564 This port requires readline library optionally. However during the build I
565 faced some yet unexplored errors while linking with readline. As it was an
566 optional component I chose to disable it.
568 5. Known Problems
570 I ran the test suite, but you will have to be your own judge of whether this
571 command, and this port, suits your purposes. If you find any problems that
572 appear to be related to the port itself, please let me know. Please see the
573 build.log file in the root of the package also.
577 Last Updated: 30 December 2011