Annotation of embedaddon/pcre/NON-AUTOTOOLS-BUILD, revision 1.1.1.3

1.1       misho       1: Building PCRE without using autotools
                      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:   Linking programs in Windows environments
1.1.1.2   misho      12:   Calling conventions in Windows environments
1.1       misho      13:   Comments about Win32 builds
                     14:   Building PCRE on Windows with CMake
                     15:   Use of relative paths with CMake on Windows
                     16:   Testing with RunTest.bat
1.1.1.2   misho      17:   Building under Windows CE with Visual Studio 200x
1.1       misho      18:   Building under Windows with BCC5.5
1.1.1.2   misho      19:   Building using Borland C++ Builder 2007 (CB2007) and higher
1.1       misho      20:   Building PCRE on OpenVMS
                     21:   Building PCRE on Stratus OpenVOS
1.1.1.2   misho      22:   Building PCRE on native z/OS and z/VM
1.1       misho      23: 
                     24: 
                     25: GENERAL
                     26: 
                     27: I (Philip Hazel) have no experience of Windows or VMS sytems and how their
                     28: libraries work. The items in the PCRE distribution and Makefile that relate to
                     29: anything other than Linux systems are untested by me.
                     30: 
                     31: There are some other comments and files (including some documentation in CHM
                     32: format) in the Contrib directory on the FTP site:
                     33: 
                     34:   ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/Contrib
                     35: 
                     36: The basic PCRE library consists entirely of code written in Standard C, and so
                     37: should compile successfully on any system that has a Standard C compiler and
                     38: library. The C++ wrapper functions are a separate issue (see below).
                     39: 
                     40: The PCRE distribution includes a "configure" file for use by the configure/make
                     41: (autotools) build system, as found in many Unix-like environments. The README
                     42: file contains information about the options for "configure".
                     43: 
                     44: There is also support for CMake, which some users prefer, especially in Windows
                     45: environments, though it can also be run in Unix-like environments. See the
                     46: section entitled "Building PCRE on Windows with CMake" below.
                     47: 
                     48: Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
                     49: names config.h.generic and pcre.h.generic. These are provided for those who
                     50: build PCRE without using "configure" or CMake. If you use "configure" or CMake,
                     51: the .generic versions are not used.
                     52: 
                     53: 
                     54: GENERIC INSTRUCTIONS FOR THE PCRE C LIBRARY
                     55: 
                     56: The following are generic instructions for building the PCRE C library "by
1.1.1.2   misho      57: hand". If you are going to use CMake, this section does not apply to you; you
                     58: can skip ahead to the CMake section.
1.1       misho      59: 
                     60:  (1) Copy or rename the file config.h.generic as config.h, and edit the macro
                     61:      settings that it contains to whatever is appropriate for your environment.
1.1.1.2   misho      62: 
                     63:      In particular, you can alter the definition of the NEWLINE macro to
                     64:      specify what character(s) you want to be interpreted as line terminators.
                     65:      In an EBCDIC environment, you MUST change NEWLINE, because its default
                     66:      value is 10, an ASCII LF. The usual EBCDIC newline character is 21 (0x15,
                     67:      NL), though in some cases it may be 37 (0x25).
                     68: 
                     69:      When you compile any of the PCRE modules, you must specify -DHAVE_CONFIG_H
                     70:      to your compiler so that config.h is included in the sources.
1.1       misho      71: 
                     72:      An alternative approach is not to edit config.h, but to use -D on the
                     73:      compiler command line to make any changes that you need to the
                     74:      configuration options. In this case -DHAVE_CONFIG_H must not be set.
                     75: 
                     76:      NOTE: There have been occasions when the way in which certain parameters
                     77:      in config.h are used has changed between releases. (In the configure/make
                     78:      world, this is handled automatically.) When upgrading to a new release,
                     79:      you are strongly advised to review config.h.generic before re-using what
                     80:      you had previously.
                     81: 
                     82:  (2) Copy or rename the file pcre.h.generic as pcre.h.
                     83: 
                     84:  (3) EITHER:
                     85:        Copy or rename file pcre_chartables.c.dist as pcre_chartables.c.
                     86: 
                     87:      OR:
                     88:        Compile dftables.c as a stand-alone program (using -DHAVE_CONFIG_H if
                     89:        you have set up config.h), and then run it with the single argument
                     90:        "pcre_chartables.c". This generates a set of standard character tables
                     91:        and writes them to that file. The tables are generated using the default
                     92:        C locale for your system. If you want to use a locale that is specified
                     93:        by LC_xxx environment variables, add the -L option to the dftables
                     94:        command. You must use this method if you are building on a system that
                     95:        uses EBCDIC code.
                     96: 
                     97:      The tables in pcre_chartables.c are defaults. The caller of PCRE can
                     98:      specify alternative tables at run time.
                     99: 
                    100:  (4) Ensure that you have the following header files:
                    101: 
                    102:        pcre_internal.h
                    103:        ucp.h
                    104: 
                    105:  (5) For an 8-bit library, compile the following source files, setting
                    106:      -DHAVE_CONFIG_H as a compiler option if you have set up config.h with your
                    107:      configuration, or else use other -D settings to change the configuration
                    108:      as required.
                    109: 
                    110:        pcre_byte_order.c
                    111:        pcre_chartables.c
                    112:        pcre_compile.c
                    113:        pcre_config.c
                    114:        pcre_dfa_exec.c
                    115:        pcre_exec.c
                    116:        pcre_fullinfo.c
                    117:        pcre_get.c
                    118:        pcre_globals.c
1.1.1.2   misho     119:        pcre_jit_compile.c
1.1       misho     120:        pcre_maketables.c
                    121:        pcre_newline.c
                    122:        pcre_ord2utf8.c
                    123:        pcre_refcount.c
                    124:        pcre_string_utils.c
                    125:        pcre_study.c
                    126:        pcre_tables.c
                    127:        pcre_ucd.c
                    128:        pcre_valid_utf8.c
                    129:        pcre_version.c
                    130:        pcre_xclass.c
                    131: 
                    132:      Make sure that you include -I. in the compiler command (or equivalent for
                    133:      an unusual compiler) so that all included PCRE header files are first
                    134:      sought in the current directory. Otherwise you run the risk of picking up
                    135:      a previously-installed file from somewhere else.
                    136: 
1.1.1.2   misho     137:      Note that you must still compile pcre_jit_compile.c, even if you have not
                    138:      defined SUPPORT_JIT in config.h, because when JIT support is not
                    139:      configured, dummy functions are compiled. When JIT support IS configured,
                    140:      pcre_jit_compile.c #includes sources from the sljit subdirectory, where
                    141:      there should be 16 files, all of whose names begin with "sljit".
1.1       misho     142: 
1.1.1.2   misho     143:  (6) Now link all the compiled code into an object library in whichever form
1.1       misho     144:      your system keeps such libraries. This is the basic PCRE C 8-bit library.
                    145:      If your system has static and shared libraries, you may have to do this
                    146:      once for each type.
                    147: 
1.1.1.2   misho     148:  (7) If you want to build a 16-bit library (as well as, or instead of the 8-bit
                    149:      or 32-bit libraries) repeat steps 5-6 with the following files:
1.1       misho     150: 
                    151:        pcre16_byte_order.c
                    152:        pcre16_chartables.c
                    153:        pcre16_compile.c
                    154:        pcre16_config.c
                    155:        pcre16_dfa_exec.c
                    156:        pcre16_exec.c
                    157:        pcre16_fullinfo.c
                    158:        pcre16_get.c
                    159:        pcre16_globals.c
1.1.1.2   misho     160:        pcre16_jit_compile.c
1.1       misho     161:        pcre16_maketables.c
                    162:        pcre16_newline.c
                    163:        pcre16_ord2utf16.c
                    164:        pcre16_refcount.c
                    165:        pcre16_string_utils.c
                    166:        pcre16_study.c
                    167:        pcre16_tables.c
                    168:        pcre16_ucd.c
                    169:        pcre16_utf16_utils.c
                    170:        pcre16_valid_utf16.c
                    171:        pcre16_version.c
                    172:        pcre16_xclass.c
                    173: 
1.1.1.3 ! misho     174:  (8) If you want to build a 32-bit library (as well as, or instead of the 8-bit
        !           175:      or 16-bit libraries) repeat steps 5-6 with the following files:
1.1.1.2   misho     176: 
                    177:        pcre32_byte_order.c
                    178:        pcre32_chartables.c
                    179:        pcre32_compile.c
                    180:        pcre32_config.c
                    181:        pcre32_dfa_exec.c
                    182:        pcre32_exec.c
                    183:        pcre32_fullinfo.c
                    184:        pcre32_get.c
                    185:        pcre32_globals.c
                    186:        pcre32_jit_compile.c
                    187:        pcre32_maketables.c
                    188:        pcre32_newline.c
                    189:        pcre32_ord2utf32.c
                    190:        pcre32_refcount.c
                    191:        pcre32_string_utils.c
                    192:        pcre32_study.c
                    193:        pcre32_tables.c
                    194:        pcre32_ucd.c
                    195:        pcre32_utf32_utils.c
                    196:        pcre32_valid_utf32.c
                    197:        pcre32_version.c
                    198:        pcre32_xclass.c
                    199: 
1.1       misho     200:  (9) If you want to build the POSIX wrapper functions (which apply only to the
                    201:      8-bit library), ensure that you have the pcreposix.h file and then compile
                    202:      pcreposix.c (remembering -DHAVE_CONFIG_H if necessary). Link the result
                    203:      (on its own) as the pcreposix library.
                    204: 
1.1.1.2   misho     205: (10) The pcretest program can be linked with any combination of the 8-bit,
                    206:      16-bit and 32-bit libraries (depending on what you selected in config.h).
                    207:      Compile pcretest.c and pcre_printint.c (again, don't forget
                    208:      -DHAVE_CONFIG_H) and link them together with the appropriate library/ies.
                    209:      If you compiled an 8-bit library, pcretest also needs the pcreposix
                    210:      wrapper library unless you compiled it with -DNOPOSIX.
1.1       misho     211: 
                    212: (11) Run pcretest on the testinput files in the testdata directory, and check
                    213:      that the output matches the corresponding testoutput files. There are
                    214:      comments about what each test does in the section entitled "Testing PCRE"
1.1.1.2   misho     215:      in the README file. If you compiled more than one of the 8-bit, 16-bit and
                    216:      32-bit libraries, you need to run pcretest with the -16 option to do
                    217:      16-bit tests and with the -32 option to do 32-bit tests.
1.1       misho     218: 
                    219:      Some tests are relevant only when certain build-time options are selected.
1.1.1.2   misho     220:      For example, test 4 is for UTF-8/UTF-16/UTF-32 support, and will not run
                    221:      if you have built PCRE without it. See the comments at the start of each
1.1       misho     222:      testinput file. If you have a suitable Unix-like shell, the RunTest script
1.1.1.2   misho     223:      will run the appropriate tests for you. The command "RunTest list" will
                    224:      output a list of all the tests.
1.1       misho     225: 
                    226:      Note that the supplied files are in Unix format, with just LF characters
                    227:      as line terminators. You may need to edit them to change this if your
                    228:      system uses a different convention. If you are using Windows, you probably
                    229:      should use the wintestinput3 file instead of testinput3 (and the
                    230:      corresponding output file). This is a locale test; wintestinput3 sets the
                    231:      locale to "french" rather than "fr_FR", and there some minor output
                    232:      differences.
                    233: 
                    234: (12) If you have built PCRE with SUPPORT_JIT, the JIT features will be tested
                    235:      by the testdata files. However, you might also like to build and run
1.1.1.2   misho     236:      the freestanding JIT test program, pcre_jit_test.c.
1.1       misho     237: 
                    238: (13) If you want to use the pcregrep command, compile and link pcregrep.c; it
                    239:      uses only the basic 8-bit PCRE library (it does not need the pcreposix
                    240:      library).
                    241: 
                    242: 
                    243: THE C++ WRAPPER FUNCTIONS
                    244: 
                    245: The PCRE distribution also contains some C++ wrapper functions and tests,
                    246: applicable to the 8-bit library, which were contributed by Google Inc. On a
                    247: system that can use "configure" and "make", the functions are automatically
                    248: built into a library called pcrecpp. It should be straightforward to compile
                    249: the .cc files manually on other systems. The files called xxx_unittest.cc are
                    250: test programs for each of the corresponding xxx.cc files.
                    251: 
                    252: 
                    253: BUILDING FOR VIRTUAL PASCAL
                    254: 
                    255: A script for building PCRE using Borland's C++ compiler for use with VPASCAL
                    256: was contributed by Alexander Tokarev. Stefan Weber updated the script and added
                    257: additional files. The following files in the distribution are for building PCRE
                    258: for use with VP/Borland: makevp_c.txt, makevp_l.txt, makevp.bat, pcregexp.pas.
                    259: 
                    260: 
                    261: STACK SIZE IN WINDOWS ENVIRONMENTS
                    262: 
                    263: The default processor stack size of 1Mb in some Windows environments is too
                    264: small for matching patterns that need much recursion. In particular, test 2 may
                    265: fail because of this. Normally, running out of stack causes a crash, but there
                    266: have been cases where the test program has just died silently. See your linker
                    267: documentation for how to increase stack size if you experience problems. The
                    268: Linux default of 8Mb is a reasonable choice for the stack, though even that can
                    269: be too small for some pattern/subject combinations.
                    270: 
                    271: PCRE has a compile configuration option to disable the use of stack for
                    272: recursion so that heap is used instead. However, pattern matching is
                    273: significantly slower when this is done. There is more about stack usage in the
                    274: "pcrestack" documentation.
                    275: 
                    276: 
                    277: LINKING PROGRAMS IN WINDOWS ENVIRONMENTS
                    278: 
                    279: If you want to statically link a program against a PCRE library in the form of
                    280: a non-dll .a file, you must define PCRE_STATIC before including pcre.h or
                    281: pcrecpp.h, otherwise the pcre_malloc() and pcre_free() exported functions will
                    282: be declared __declspec(dllimport), with unwanted results.
                    283: 
                    284: 
                    285: CALLING CONVENTIONS IN WINDOWS ENVIRONMENTS
                    286: 
                    287: It is possible to compile programs to use different calling conventions using
                    288: MSVC. Search the web for "calling conventions" for more information. To make it
                    289: easier to change the calling convention for the exported functions in the
                    290: PCRE library, the macro PCRE_CALL_CONVENTION is present in all the external
                    291: definitions. It can be set externally when compiling (e.g. in CFLAGS). If it is
                    292: not set, it defaults to empty; the default calling convention is then used
                    293: (which is what is wanted most of the time).
                    294: 
                    295: 
                    296: COMMENTS ABOUT WIN32 BUILDS (see also "BUILDING PCRE ON WINDOWS WITH CMAKE")
                    297: 
                    298: There are two ways of building PCRE using the "configure, make, make install"
                    299: paradigm on Windows systems: using MinGW or using Cygwin. These are not at all
                    300: the same thing; they are completely different from each other. There is also
                    301: support for building using CMake, which some users find a more straightforward
                    302: way of building PCRE under Windows.
                    303: 
                    304: The MinGW home page (http://www.mingw.org/) says this:
                    305: 
                    306:   MinGW: A collection of freely available and freely distributable Windows
                    307:   specific header files and import libraries combined with GNU toolsets that
                    308:   allow one to produce native Windows programs that do not rely on any
                    309:   3rd-party C runtime DLLs.
                    310: 
                    311: The Cygwin home page (http://www.cygwin.com/) says this:
                    312: 
                    313:   Cygwin is a Linux-like environment for Windows. It consists of two parts:
                    314: 
                    315:   . A DLL (cygwin1.dll) which acts as a Linux API emulation layer providing
                    316:     substantial Linux API functionality
                    317: 
                    318:   . A collection of tools which provide Linux look and feel.
                    319: 
                    320:   The Cygwin DLL currently works with all recent, commercially released x86 32
                    321:   bit and 64 bit versions of Windows, with the exception of Windows CE.
                    322: 
                    323: On both MinGW and Cygwin, PCRE should build correctly using:
                    324: 
                    325:   ./configure && make && make install
                    326: 
                    327: This should create two libraries called libpcre and libpcreposix, and, if you
                    328: have enabled building the C++ wrapper, a third one called libpcrecpp. These are
                    329: independent libraries: when you link with libpcreposix or libpcrecpp you must
                    330: also link with libpcre, which contains the basic functions. (Some earlier
                    331: releases of PCRE included the basic libpcre functions in libpcreposix. This no
                    332: longer happens.)
                    333: 
                    334: A user submitted a special-purpose patch that makes it easy to create
                    335: "pcre.dll" under mingw32 using the "msys" environment. It provides "pcre.dll"
                    336: as a special target. If you use this target, no other files are built, and in
                    337: particular, the pcretest and pcregrep programs are not built. An example of how
                    338: this might be used is:
                    339: 
                    340:   ./configure --enable-utf --disable-cpp CFLAGS="-03 -s"; make pcre.dll
                    341: 
                    342: Using Cygwin's compiler generates libraries and executables that depend on
                    343: cygwin1.dll. If a library that is generated this way is distributed,
                    344: cygwin1.dll has to be distributed as well. Since cygwin1.dll is under the GPL
                    345: licence, this forces not only PCRE to be under the GPL, but also the entire
                    346: application. A distributor who wants to keep their own code proprietary must
                    347: purchase an appropriate Cygwin licence.
                    348: 
                    349: MinGW has no such restrictions. The MinGW compiler generates a library or
                    350: executable that can run standalone on Windows without any third party dll or
                    351: licensing issues.
                    352: 
                    353: But there is more complication:
                    354: 
                    355: If a Cygwin user uses the -mno-cygwin Cygwin gcc flag, what that really does is
                    356: to tell Cygwin's gcc to use the MinGW gcc. Cygwin's gcc is only acting as a
                    357: front end to MinGW's gcc (if you install Cygwin's gcc, you get both Cygwin's
                    358: gcc and MinGW's gcc). So, a user can:
                    359: 
                    360: . Build native binaries by using MinGW or by getting Cygwin and using
                    361:   -mno-cygwin.
                    362: 
                    363: . Build binaries that depend on cygwin1.dll by using Cygwin with the normal
                    364:   compiler flags.
                    365: 
                    366: The test files that are supplied with PCRE are in UNIX format, with LF
                    367: characters as line terminators. Unless your PCRE library uses a default newline
                    368: option that includes LF as a valid newline, it may be necessary to change the
                    369: line terminators in the test files to get some of the tests to work.
                    370: 
                    371: 
                    372: BUILDING PCRE ON WINDOWS WITH CMAKE
                    373: 
                    374: CMake is an alternative configuration facility that can be used instead of
                    375: "configure". CMake creates project files (make files, solution files, etc.)
                    376: tailored to numerous development environments, including Visual Studio,
1.1.1.2   misho     377: Borland, Msys, MinGW, NMake, and Unix. If possible, use short paths with no
1.1       misho     378: spaces in the names for your CMake installation and your PCRE source and build
                    379: directories.
                    380: 
1.1.1.2   misho     381: The following instructions were contributed by a PCRE user. If they are not
                    382: followed exactly, errors may occur. In the event that errors do occur, it is
                    383: recommended that you delete the CMake cache before attempting to repeat the
                    384: CMake build process. In the CMake GUI, the cache can be deleted by selecting
                    385: "File > Delete Cache".
1.1       misho     386: 
                    387: 1.  Install the latest CMake version available from http://www.cmake.org/, and
                    388:     ensure that cmake\bin is on your path.
                    389: 
                    390: 2.  Unzip (retaining folder structure) the PCRE source tree into a source
                    391:     directory such as C:\pcre. You should ensure your local date and time
                    392:     is not earlier than the file dates in your source dir if the release is
                    393:     very new.
                    394: 
                    395: 3.  Create a new, empty build directory, preferably a subdirectory of the
                    396:     source dir. For example, C:\pcre\pcre-xx\build.
                    397: 
                    398: 4.  Run cmake-gui from the Shell envirornment of your build tool, for example,
1.1.1.2   misho     399:     Msys for Msys/MinGW or Visual Studio Command Prompt for VC/VC++. Do not try
                    400:     to start Cmake from the Windows Start menu, as this can lead to errors.
1.1       misho     401: 
                    402: 5.  Enter C:\pcre\pcre-xx and C:\pcre\pcre-xx\build for the source and build
                    403:     directories, respectively.
                    404: 
                    405: 6.  Hit the "Configure" button.
                    406: 
                    407: 7.  Select the particular IDE / build tool that you are using (Visual
                    408:     Studio, MSYS makefiles, MinGW makefiles, etc.)
                    409: 
                    410: 8.  The GUI will then list several configuration options. This is where
                    411:     you can enable UTF-8 support or other PCRE optional features.
                    412: 
                    413: 9.  Hit "Configure" again. The adjacent "Generate" button should now be
                    414:     active.
                    415: 
                    416: 10. Hit "Generate".
                    417: 
                    418: 11. The build directory should now contain a usable build system, be it a
                    419:     solution file for Visual Studio, makefiles for MinGW, etc. Exit from
                    420:     cmake-gui and use the generated build system with your compiler or IDE.
                    421:     E.g., for MinGW you can run "make", or for Visual Studio, open the PCRE
                    422:     solution, select the desired configuration (Debug, or Release, etc.) and
                    423:     build the ALL_BUILD project.
                    424: 
                    425: 12. If during configuration with cmake-gui you've elected to build the test
                    426:     programs, you can execute them by building the test project. E.g., for
                    427:     MinGW: "make test"; for Visual Studio build the RUN_TESTS project. The
                    428:     most recent build configuration is targeted by the tests. A summary of
                    429:     test results is presented. Complete test output is subsequently
                    430:     available for review in Testing\Temporary under your build dir.
                    431: 
                    432: 
                    433: USE OF RELATIVE PATHS WITH CMAKE ON WINDOWS
                    434: 
1.1.1.2   misho     435: A PCRE user comments as follows: I thought that others may want to know the
                    436: current state of CMAKE_USE_RELATIVE_PATHS support on Windows. Here it is:
1.1       misho     437: 
                    438: -- AdditionalIncludeDirectories is only partially modified (only the
1.1.1.2   misho     439:    first path - see below)
1.1       misho     440: -- Only some of the contained file paths are modified - shown below for
1.1.1.2   misho     441:    pcre.vcproj
1.1       misho     442: -- It properly modifies
                    443: 
                    444: I am sure CMake people can fix that if they want to. Until then one will
                    445: need to replace existing absolute paths in project files with relative
                    446: paths manually (e.g. from VS) - relative to project file location. I did
                    447: just that before being told to try CMAKE_USE_RELATIVE_PATHS. Not a big
                    448: deal.
                    449: 
                    450: AdditionalIncludeDirectories="E:\builds\pcre\build;E:\builds\pcre\pcre-7.5;"
                    451: AdditionalIncludeDirectories=".;E:\builds\pcre\pcre-7.5;"
                    452: 
1.1.1.2   misho     453: RelativePath="pcre.h"
                    454: RelativePath="pcre_chartables.c"
                    455: RelativePath="pcre_chartables.c.rule"
1.1       misho     456: 
                    457: 
                    458: TESTING WITH RUNTEST.BAT
                    459: 
                    460: If configured with CMake, building the test project ("make test" or building
                    461: ALL_TESTS in Visual Studio) creates (and runs) pcre_test.bat (and depending
                    462: on your configuration options, possibly other test programs) in the build
                    463: directory. Pcre_test.bat runs RunTest.Bat with correct source and exe paths.
                    464: 
                    465: For manual testing with RunTest.bat, provided the build dir is a subdirectory
                    466: of the source directory: Open command shell window. Chdir to the location
                    467: of your pcretest.exe and pcregrep.exe programs. Call RunTest.bat with
                    468: "..\RunTest.Bat" or "..\..\RunTest.bat" as appropriate.
                    469: 
                    470: To run only a particular test with RunTest.Bat provide a test number argument.
                    471: 
                    472: Otherwise:
                    473: 
                    474: 1. Copy RunTest.bat into the directory where pcretest.exe and pcregrep.exe
                    475:    have been created.
                    476: 
                    477: 2. Edit RunTest.bat to indentify the full or relative location of
                    478:    the pcre source (wherein which the testdata folder resides), e.g.:
                    479: 
                    480:    set srcdir=C:\pcre\pcre-8.20
                    481: 
                    482: 3. In a Windows command environment, chdir to the location of your bat and
                    483:    exe programs.
                    484: 
                    485: 4. Run RunTest.bat. Test outputs will automatically be compared to expected
                    486:    results, and discrepancies will be identified in the console output.
                    487: 
                    488: To independently test the just-in-time compiler, run pcre_jit_test.exe.
                    489: To test pcrecpp, run pcrecpp_unittest.exe, pcre_stringpiece_unittest.exe and
                    490: pcre_scanner_unittest.exe.
                    491: 
                    492: 
1.1.1.2   misho     493: BUILDING UNDER WINDOWS CE WITH VISUAL STUDIO 200x
                    494: 
                    495: Vincent Richomme sent a zip archive of files to help with this process. They
                    496: can be found in the file "pcre-vsbuild.zip" in the Contrib directory of the FTP
                    497: site.
                    498: 
                    499: 
1.1       misho     500: BUILDING UNDER WINDOWS WITH BCC5.5
                    501: 
                    502: Michael Roy sent these comments about building PCRE under Windows with BCC5.5:
                    503: 
1.1.1.2   misho     504: Some of the core BCC libraries have a version of PCRE from 1998 built in, which
                    505: can lead to pcre_exec() giving an erroneous PCRE_ERROR_NULL from a version
                    506: mismatch. I'm including an easy workaround below, if you'd like to include it
                    507: in the non-unix instructions:
                    508: 
                    509: When linking a project with BCC5.5, pcre.lib must be included before any of the
                    510: libraries cw32.lib, cw32i.lib, cw32mt.lib, and cw32mti.lib on the command line.
                    511: 
                    512: 
                    513: BUILDING USING BORLAND C++ BUILDER 2007 (CB2007) AND HIGHER
                    514: 
                    515: A PCRE user sent these comments about this environment (see also the comment
                    516: from another user that follows them):
                    517: 
                    518: The XE versions of C++ Builder come with a RegularExpressionsCore class which
                    519: contain a version of TPerlRegEx. However, direct use of the C PCRE library may
                    520: be desirable.
                    521: 
                    522: The default makevp.bat, however, supplied with PCRE builds a version of PCRE
                    523: that is not usable with any version of C++ Builder because the compiler ships
                    524: with an embedded version of PCRE, version 2.01 from 1998! [See also the note
                    525: about BCC5.5 above.] If you want to use PCRE you'll need to rename the
                    526: functions (pcre_compile to pcre_compile_bcc, etc) or do as I have done and just
                    527: use the 16 bit versions. I'm using std::wstring everywhere anyway. Since the
                    528: embedded version of PCRE does not have the 16 bit function names, there is no
                    529: conflict.
                    530: 
                    531: Building PCRE using a C++ Builder static library project file (recommended):
                    532: 
                    533: 1. Rename or remove pcre.h, pcreposi.h, and pcreposix.h from your C++ Builder
                    534: original include path.
                    535: 
                    536: 2. Download PCRE from pcre.org and extract to a directory.
                    537: 
                    538: 3. Rename pcre_chartables.c.dist to pcre_chartables.c, pcre.h.generic to
                    539: pcre.h, and config.h.generic to config.h.
                    540: 
                    541: 4. Edit pcre.h and pcre_config.c so that they include config.h.
                    542: 
                    543: 5. Edit config.h like so:
                    544: 
                    545: Comment out the following lines:
                    546: #define PACKAGE "pcre"
                    547: #define PACKAGE_BUGREPORT ""
                    548: #define PACKAGE_NAME "PCRE"
                    549: #define PACKAGE_STRING "PCRE 8.32"
                    550: #define PACKAGE_TARNAME "pcre"
                    551: #define PACKAGE_URL ""
                    552: #define PACKAGE_VERSION "8.32"
                    553: 
                    554: Add the following lines:
                    555: #ifndef SUPPORT_UTF
                    556: #define SUPPORT_UTF 100 // any value is fine
                    557: #endif
                    558: 
                    559: #ifndef SUPPORT_UCP
                    560: #define SUPPORT_UCP 101 // any value is fine
                    561: #endif
                    562: 
                    563: #ifndef SUPPORT_UCP
                    564: #define SUPPORT_PCRE16 102 // any value is fine
                    565: #endif
                    566: 
                    567: #ifndef SUPPORT_UTF8
                    568: #define SUPPORT_UTF8 103 // any value is fine
                    569: #endif
                    570: 
                    571: 6. Build a C++ Builder project using the IDE. Go to File / New / Other and
                    572: choose Static Library. You can name it pcre.cbproj or whatever. Now set your
                    573: paths by going to Project / Options. Set the Include path. Do this from the
                    574: "Base" option to apply to both Release and Debug builds. Now add the following
                    575: files to the project:
                    576: 
                    577: pcre.h
                    578: pcre16_byte_order.c
                    579: pcre16_chartables.c
                    580: pcre16_compile.c
                    581: pcre16_config.c
                    582: pcre16_dfa_exec.c
                    583: pcre16_exec.c
                    584: pcre16_fullinfo.c
                    585: pcre16_get.c
                    586: pcre16_globals.c
                    587: pcre16_maketables.c
                    588: pcre16_newline.c
                    589: pcre16_ord2utf16.c
                    590: pcre16_printint.c
                    591: pcre16_refcount.c
                    592: pcre16_string_utils.c
                    593: pcre16_study.c
                    594: pcre16_tables.c
                    595: pcre16_ucd.c
                    596: pcre16_utf16_utils.c
                    597: pcre16_valid_utf16.c
                    598: pcre16_version.c
                    599: pcre16_xclass.c
                    600: 
                    601: //Optional
                    602: pcre_version.c
                    603: 
                    604: 7. After compiling the .lib file, copy the .lib and header files to a project
                    605: you want to use PCRE with. Enjoy.
                    606: 
                    607: Optional ... Building PCRE using the makevp.bat file:
                    608: 
                    609: 1. Edit makevp_c.txt and makevp_l.txt and change all the names to the 16 bit
                    610: versions.
                    611: 
                    612: 2. Edit makevp.bat and set the path to C++ Builder. Run makevp.bat.
                    613: 
                    614: Another PCRE user added this comment:
                    615: 
                    616: Another approach I successfully used for some years with BCB 5 and 6 was to
                    617: make sure that include and library paths of PCRE are configured before the
                    618: default paths of the IDE in the dialogs where one can manage those paths.
                    619: Afterwards one can open the project files using a text editor and manually add
                    620: the self created library for pcre itself, pcrecpp doesn't ship with the IDE, in
                    621: the library nodes where the IDE manages its own libraries to link against in
                    622: front of the IDE-own libraries. This way one can use the default PCRE function
                    623: names without getting access violations on runtime.
1.1       misho     624: 
1.1.1.2   misho     625:   <ALLLIB value="libpcre.lib $(LIBFILES) $(LIBRARIES) import32.lib cp32mt.lib"/>
1.1       misho     626: 
                    627: 
1.1.1.2   misho     628: BUILDING PCRE ON OPENVMS
1.1       misho     629: 
1.1.1.2   misho     630: Stephen Hoffman sent the following, in December 2012:
1.1       misho     631: 
1.1.1.2   misho     632: "Here <http://labs.hoffmanlabs.com/node/1847> is a very short write-up on the
                    633: OpenVMS port and here
1.1       misho     634: 
1.1.1.2   misho     635: <http://labs.hoffmanlabs.com/labsnotes/pcre-vms-8_32.zip>
                    636: 
                    637: is a zip with the OpenVMS files, and with one modified testing-related PCRE
                    638: file." This is a port of PCRE 8.32.
                    639: 
                    640: Earlier, Dan Mooney sent the following comments about building PCRE on OpenVMS.
                    641: They relate to an older version of PCRE that used fewer source files, so the
                    642: exact commands will need changing. See the current list of source files above.
1.1       misho     643: 
                    644: "It was quite easy to compile and link the library. I don't have a formal
                    645: make file but the attached file [reproduced below] contains the OpenVMS DCL
                    646: commands I used to build the library. I had to add #define
                    647: POSIX_MALLOC_THRESHOLD 10 to pcre.h since it was not defined anywhere.
                    648: 
                    649: The library was built on:
                    650: O/S: HP OpenVMS v7.3-1
                    651: Compiler: Compaq C v6.5-001-48BCD
                    652: Linker: vA13-01
                    653: 
                    654: The test results did not match 100% due to the issues you mention in your
                    655: documentation regarding isprint(), iscntrl(), isgraph() and ispunct(). I
                    656: modified some of the character tables temporarily and was able to get the
                    657: results to match. Tests using the fr locale did not match since I don't have
                    658: that locale loaded. The study size was always reported to be 3 less than the
                    659: value in the standard test output files."
                    660: 
                    661: =========================
                    662: $! This DCL procedure builds PCRE on OpenVMS
                    663: $!
                    664: $! I followed the instructions in the non-unix-use file in the distribution.
                    665: $!
                    666: $ COMPILE == "CC/LIST/NOMEMBER_ALIGNMENT/PREFIX_LIBRARY_ENTRIES=ALL_ENTRIES
                    667: $ COMPILE DFTABLES.C
                    668: $ LINK/EXE=DFTABLES.EXE DFTABLES.OBJ
                    669: $ RUN DFTABLES.EXE/OUTPUT=CHARTABLES.C
                    670: $ COMPILE MAKETABLES.C
                    671: $ COMPILE GET.C
                    672: $ COMPILE STUDY.C
                    673: $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
                    674: $! did not seem to be defined anywhere.
                    675: $! I edited pcre.h and added #DEFINE SUPPORT_UTF8 to enable UTF8 support.
                    676: $ COMPILE PCRE.C
                    677: $ LIB/CREATE PCRE MAKETABLES.OBJ, GET.OBJ, STUDY.OBJ, PCRE.OBJ
                    678: $! I had to set POSIX_MALLOC_THRESHOLD to 10 in PCRE.H since the symbol
                    679: $! did not seem to be defined anywhere.
                    680: $ COMPILE PCREPOSIX.C
                    681: $ LIB/CREATE PCREPOSIX PCREPOSIX.OBJ
                    682: $ COMPILE PCRETEST.C
                    683: $ LINK/EXE=PCRETEST.EXE PCRETEST.OBJ, PCRE/LIB, PCREPOSIX/LIB
                    684: $! C programs that want access to command line arguments must be
                    685: $! defined as a symbol
                    686: $ PCRETEST :== "$ SYS$ROADSUSERS:[DMOONEY.REGEXP]PCRETEST.EXE"
                    687: $! Arguments must be enclosed in quotes.
                    688: $ PCRETEST "-C"
                    689: $! Test results:
                    690: $!
                    691: $!   The test results did not match 100%. The functions isprint(), iscntrl(),
                    692: $!   isgraph() and ispunct() on OpenVMS must not produce the same results
                    693: $!   as the system that built the test output files provided with the
                    694: $!   distribution.
                    695: $!
                    696: $!   The study size did not match and was always 3 less on OpenVMS.
                    697: $!
                    698: $!   Locale could not be set to fr
                    699: $!
                    700: =========================
                    701: 
                    702: 
                    703: BUILDING PCRE ON STRATUS OPENVOS
                    704: 
                    705: These notes on the port of PCRE to VOS (lightly edited) were supplied by
                    706: Ashutosh Warikoo, whose email address has the local part awarikoo and the
                    707: domain nse.co.in. The port was for version 7.9 in August 2009.
                    708: 
                    709: 1.   Building PCRE
                    710: 
                    711: I built pcre on OpenVOS Release 17.0.1at using GNU Tools 3.4a without any
                    712: problems. I used the following packages to build PCRE:
                    713: 
                    714:   ftp://ftp.stratus.com/pub/vos/posix/ga/posix.save.evf.gz
                    715: 
                    716: Please read and follow the instructions that come with these packages. To start
                    717: the build of pcre, from the root of the package type:
                    718: 
                    719:   ./build.sh
                    720: 
                    721: 2. Installing PCRE
                    722: 
                    723: Once you have successfully built PCRE, login to the SysAdmin group, switch to
                    724: the root user, and type
                    725: 
                    726:   [ !create_dir (master_disk)>usr   --if needed ]
                    727:   [ !create_dir (master_disk)>usr>local   --if needed ]
                    728:     !gmake install
                    729: 
                    730: This installs PCRE and its man pages into /usr/local. You can add
                    731: (master_disk)>usr>local>bin to your command search paths, or if you are in
                    732: BASH, add /usr/local/bin to the PATH environment variable.
                    733: 
                    734: 4. Restrictions
                    735: 
                    736: This port requires readline library optionally. However during the build I
                    737: faced some yet unexplored errors while linking with readline. As it was an
                    738: optional component I chose to disable it.
                    739: 
                    740: 5. Known Problems
                    741: 
                    742: I ran the test suite, but you will have to be your own judge of whether this
                    743: command, and this port, suits your purposes. If you find any problems that
                    744: appear to be related to the port itself, please let me know. Please see the
                    745: build.log file in the root of the package also.
                    746: 
                    747: 
1.1.1.2   misho     748: BUILDING PCRE ON NATIVE Z/OS AND Z/VM
                    749: 
                    750: z/OS and z/VM are operating systems for mainframe computers, produced by IBM.
                    751: The character code used is EBCDIC, not ASCII or Unicode. In z/OS, UNIX APIs and
                    752: applications can be supported through UNIX System Services, and in such an
                    753: environment PCRE can be built in the same way as in other systems. However, in
                    754: native z/OS (without UNIX System Services) and in z/VM, special ports are
                    755: required. For details, please see this web site:
                    756: 
                    757:   http://www.zaconsultants.net
                    758: 
                    759: There is also a mirror here:
                    760: 
                    761:   http://www.vsoft-software.com/downloads.html
                    762: 
1.1       misho     763: ==========================
1.1.1.2   misho     764: Last Updated: 14 May 2013

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>