/[pcre]/code/trunk/README
ViewVC logotype

Diff of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 127 by ph10, Mon Mar 19 11:44:45 2007 UTC revision 145 by ph10, Wed Apr 4 14:06:52 2007 UTC
# Line 30  The contents of this README file are: Line 30  The contents of this README file are:
30  The PCRE APIs  The PCRE APIs
31  -------------  -------------
32    
33  PCRE is written in C, and it has its own API. The distribution now includes a  PCRE is written in C, and it has its own API. The distribution also includes a
34  set of C++ wrapper functions, courtesy of Google Inc. (see the pcrecpp man page  set of C++ wrapper functions (see the pcrecpp man page for details), courtesy
35  for details).  of Google Inc.
36    
37  Also included in the distribution are a set of C wrapper functions that are  In addition, there is a set of C wrapper functions that are based on the POSIX
38  based on the POSIX API. These end up in the library called libpcreposix. Note  regular expression API (see the pcreposix man page). These end up in the
39  that this just provides a POSIX calling interface to PCRE; the regular  library called libpcreposix. Note that this just provides a POSIX calling
40  expressions themselves still follow Perl syntax and semantics. The POSIX API is  interface to PCRE; the regular expressions themselves still follow Perl syntax
41  restricted, and does not give full access to all of PCRE's facilities.  and semantics. The POSIX API is restricted, and does not give full access to
42    all of PCRE's facilities.
43    
44  The header file for the POSIX-style functions is called pcreposix.h. The  The header file for the POSIX-style functions is called pcreposix.h. The
45  official POSIX name is regex.h, but I did not want to risk possible problems  official POSIX name is regex.h, but I did not want to risk possible problems
# Line 91  You can find contributions from PCRE use Line 92  You can find contributions from PCRE use
92    
93  There is a README file giving brief descriptions of what they are. Some are  There is a README file giving brief descriptions of what they are. Some are
94  complete in themselves; others are pointers to URLs containing relevant files.  complete in themselves; others are pointers to URLs containing relevant files.
95  Some of this material is likely to be well out-of-date. In particular, several  Some of this material is likely to be well out-of-date. Several of the earlier
96  of the contributions provide support for compiling PCRE on various flavours of  contributions provided support for compiling PCRE on various flavours of
97  Windows (I myself do not use Windows), but nowadays there is more Windows  Windows (I myself do not use Windows). Nowadays there is more Windows support
98  support in the standard distribution.  in the standard distribution, so these contibutions have been archived.
99    
100    
101  Building PCRE on non-Unix systems  Building PCRE on non-Unix systems
# Line 115  Building PCRE on Unix-like systems Line 116  Building PCRE on Unix-like systems
116  If you are using HP's ANSI C++ compiler (aCC), please see the special note  If you are using HP's ANSI C++ compiler (aCC), please see the special note
117  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
118    
119    The following instructions assume the use of the widely used "configure, make,
120    make install" process. There is also some experimental support for "cmake" in
121    the PCRE distribution, but it is incomplete and not documented. However, if you
122    are a "cmake" user, you might want to try it.
123    
124  To build PCRE on a Unix-like system, first run the "configure" command from the  To build PCRE on a Unix-like system, first run the "configure" command from the
125  PCRE distribution directory, with your current directory set to the directory  PCRE distribution directory, with your current directory set to the directory
126  where you want the files to be created. This command is a standard GNU  where you want the files to be created. This command is a standard GNU
# Line 147  library. You can read more about them in Line 153  library. You can read more about them in
153    
154  . If you want to suppress the building of the C++ wrapper library, you can add  . If you want to suppress the building of the C++ wrapper library, you can add
155    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,    --disable-cpp to the "configure" command. Otherwise, when "configure" is run,
156    will try to find a C++ compiler and C++ header files, and if it succeeds, it    it will try to find a C++ compiler and C++ header files, and if it succeeds,
157    will try to build the C++ wrapper.    it will try to build the C++ wrapper.
158    
159  . If you want to make use of the support for UTF-8 character strings in PCRE,  . If you want to make use of the support for UTF-8 character strings in PCRE,
160    you must add --enable-utf8 to the "configure" command. Without it, the code    you must add --enable-utf8 to the "configure" command. Without it, the code
# Line 178  library. You can read more about them in Line 184  library. You can read more about them in
184    
185  . When called via the POSIX interface, PCRE uses malloc() to get additional  . When called via the POSIX interface, PCRE uses malloc() to get additional
186    storage for processing capturing parentheses if there are more than 10 of    storage for processing capturing parentheses if there are more than 10 of
187    them. You can increase this threshold by setting, for example,    them in a pattern. You can increase this threshold by setting, for example,
188    
189    --with-posix-malloc-threshold=20    --with-posix-malloc-threshold=20
190    
# Line 207  library. You can read more about them in Line 213  library. You can read more about them in
213  . The default maximum compiled pattern size is around 64K. You can increase  . The default maximum compiled pattern size is around 64K. You can increase
214    this by adding --with-link-size=3 to the "configure" command. You can    this by adding --with-link-size=3 to the "configure" command. You can
215    increase it even more by setting --with-link-size=4, but this is unlikely    increase it even more by setting --with-link-size=4, but this is unlikely
216    ever to be necessary.    ever to be necessary. Increasing the internal link size will reduce
217      performance.
218    
219  . You can build PCRE so that its internal match() function that is called from  . You can build PCRE so that its internal match() function that is called from
220    pcre_exec() does not call itself recursively. Instead, it uses memory blocks    pcre_exec() does not call itself recursively. Instead, it uses memory blocks
# Line 223  library. You can read more about them in Line 230  library. You can read more about them in
230    use deeply nested recursion. There is a discussion about stack sizes in the    use deeply nested recursion. There is a discussion about stack sizes in the
231    pcrestack man page.    pcrestack man page.
232    
233    . For speed, PCRE uses four tables for manipulating and identifying characters
234      whose code point values are less than 256. By default, it uses a set of
235      tables for ASCII encoding that is part of the distribution. If you specify
236    
237      --enable-rebuild-chartables
238    
239      a program called dftables is compiled and run in the default C locale when
240      you obey "make". It builds a source file called pcre_chartables.c. If you do
241      not specify this option, pcre_chartables.c is created as a copy of
242      pcre_chartables.c.dist. See "Character tables" below for further information.
243    
244    . It is possible to compile PCRE for use on systems that use EBCDIC as their
245      default character code (as opposed to ASCII) by specifying
246    
247      --enable-ebcdic
248    
249      This automatically implies --enable-rebuild-chartables (see above).
250    
251  The "configure" script builds the following files for the basic C library:  The "configure" script builds the following files for the basic C library:
252    
253  . Makefile is the makefile that builds the library  . Makefile is the makefile that builds the library
# Line 371  Cross-compiling on Unix-like systems Line 396  Cross-compiling on Unix-like systems
396  ------------------------------------  ------------------------------------
397    
398  You can specify CC and CFLAGS in the normal way to the "configure" command, in  You can specify CC and CFLAGS in the normal way to the "configure" command, in
399  order to cross-compile PCRE for some other host. However, during the building  order to cross-compile PCRE for some other host. However, you should NOT
400  process, the dftables.c source file is compiled *and run* on the local host, in  specify --enable-rebuild-chartables, because if you do, the dftables.c source
401  order to generate the default character tables (the chartables.c file). It  file is compiled and run on the local host, in order to generate the inbuilt
402  therefore needs to be compiled with the local compiler, not the cross compiler.  character tables (the pcre_chartables.c file). This will probably not work,
403  You can do this by specifying CC_FOR_BUILD (and if necessary CFLAGS_FOR_BUILD;  because dftables.c needs to be compiled with the local compiler, not the cross
404  there are also CXX_FOR_BUILD and CXXFLAGS_FOR_BUILD for the C++ wrapper)  compiler.
405  when calling the "configure" command. If they are not specified, they default  
406  to the values of CC and CFLAGS.  When --enable-rebuild-chartables is not specified, pcre_chartables.c is created
407    by making a copy of pcre_chartables.c.dist, which is a default set of tables
408    that assumes ASCII code. Cross-compiling with the default tables should not be
409    a problem.
410    
411    If you need to modify the character tables when cross-compiling, you should
412    move pcre_chartables.c.dist out of the way, then compile dftables.c by hand and
413    run it on the local host to make a new version of pcre_chartables.c.dist.
414    Then when you cross-compile PCRE this new version of the tables will be used.
415    
416    
417  Using HP's ANSI C++ compiler (aCC)  Using HP's ANSI C++ compiler (aCC)
# Line 461  is output to say why. If running this te Line 494  is output to say why. If running this te
494  in the comparison output, it means that locale is not available on your system,  in the comparison output, it means that locale is not available on your system,
495  despite being listed by "locale". This does not mean that PCRE is broken.  despite being listed by "locale". This does not mean that PCRE is broken.
496    
497    [If you are trying to run this test on Windows, you may be able to get it to
498    work by changing "fr_FR" to "french" everywhere it occurs.]
499    
500  The fourth test checks the UTF-8 support. It is not run automatically unless  The fourth test checks the UTF-8 support. It is not run automatically unless
501  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when  PCRE is built with UTF-8 support. To do this you must set --enable-utf8 when
502  running "configure". This file can be also fed directly to the perltest script,  running "configure". This file can be also fed directly to the perltest script,
# Line 490  concatenated tables. A call to pcre_make Line 526  concatenated tables. A call to pcre_make
526  of tables in the current locale. If the final argument for pcre_compile() is  of tables in the current locale. If the final argument for pcre_compile() is
527  passed as NULL, a set of default tables that is built into the binary is used.  passed as NULL, a set of default tables that is built into the binary is used.
528    
529  The source file called chartables.c contains the default set of tables. This is  The source file called pcre_chartables.c contains the default set of tables. By
530  not supplied in the distribution, but is built by the program dftables  default, this is created as a copy of pcre_chartables.c.dist, which contains
531  (compiled from dftables.c), which uses the ANSI C character handling functions  tables for ASCII coding. However, if --enable-rebuild-chartables is specified
532  such as isalnum(), isalpha(), isupper(), islower(), etc. to build the table  for ./configure, a different version of pcre_chartables.c is built by the
533  sources. This means that the default C locale which is set for your system will  program dftables (compiled from dftables.c), which uses the ANSI C character
534  control the contents of these default tables. You can change the default tables  handling functions such as isalnum(), isalpha(), isupper(), islower(), etc. to
535  by editing chartables.c and then re-building PCRE. If you do this, you should  build the table sources. This means that the default C locale which is set for
536  take care to ensure that the file does not get automaticaly re-generated.  your system will control the contents of these default tables. You can change
537    the default tables by editing pcre_chartables.c and then re-building PCRE. If
538    you do this, you should take care to ensure that the file does not get
539    automatically re-generated. The best way to do this is to move
540    pcre_chartables.c.dist out of the way and replace it with your customized
541    tables.
542    
543    When the dftables program is run as a result of --enable-rebuild-chartables,
544    it uses the default C locale that is set on your system. It does not pay
545    attention to the LC_xxx environment variables. In other words, it uses the
546    system's default locale rather than whatever the compiling user happens to have
547    set. If you really do want to build a source set of character tables in a
548    locale that is specified by the LC_xxx variables, you can run the dftables
549    program by hand with the -L option. For example:
550    
551      ./dftables -L pcre_chartables.c.special
552    
553  The first two 256-byte tables provide lower casing and case flipping functions,  The first two 256-byte tables provide lower casing and case flipping functions,
554  respectively. The next table consists of three 32-byte bit maps which identify  respectively. The next table consists of three 32-byte bit maps which identify
# Line 526  The distribution should contain the foll Line 577  The distribution should contain the foll
577    
578  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
579    
580    dftables.c             auxiliary program for building chartables.c    dftables.c              auxiliary program for building pcre_chartables.c
581                                when --enable-rebuild-chartables is specified
582    
583    pcreposix.c            )    pcre_chartables.c.dist  a default set of character tables that assume ASCII
584    pcre_compile.c         )                              coding; used, unless --enable-rebuild-chartables is
585    pcre_config.c          )                              specified, by copying to pcre_chartables.c
586    pcre_dfa_exec.c        )  
587    pcre_exec.c            )    pcreposix.c             )
588    pcre_fullinfo.c        )    pcre_compile.c          )
589    pcre_get.c             ) sources for the functions in the library,    pcre_config.c           )
590    pcre_globals.c         )   and some internal functions that they use    pcre_dfa_exec.c         )
591    pcre_info.c            )    pcre_exec.c             )
592    pcre_maketables.c      )    pcre_fullinfo.c         )
593    pcre_newline.c         )    pcre_get.c              ) sources for the functions in the library,
594    pcre_ord2utf8.c        )    pcre_globals.c          )   and some internal functions that they use
595    pcre_refcount.c        )    pcre_info.c             )
596    pcre_study.c           )    pcre_maketables.c       )
597    pcre_tables.c          )    pcre_newline.c          )
598    pcre_try_flipped.c     )    pcre_ord2utf8.c         )
599    pcre_ucp_searchfuncs.c )    pcre_refcount.c         )
600    pcre_valid_utf8.c      )    pcre_study.c            )
601    pcre_version.c         )    pcre_tables.c           )
602    pcre_xclass.c          )    pcre_try_flipped.c      )
603    pcre_printint.src      ) debugging function that is #included in pcretest,    pcre_ucp_searchfuncs.c  )
604                           )   and can also be #included in pcre_compile()    pcre_valid_utf8.c       )
605    pcre.h.in              template for pcre.h when built by "configure"    pcre_version.c          )
606    pcreposix.h            header for the external POSIX wrapper API    pcre_xclass.c           )
607    pcre_internal.h        header for internal use    pcre_printint.src       ) debugging function that is #included in pcretest,
608    ucp.h                  ) headers concerned with                            )   and can also be #included in pcre_compile()
609    ucpinternal.h          )   Unicode property handling    pcre.h.in               template for pcre.h when built by "configure"
610    ucptable.h             ) (this one is the data table)    pcreposix.h             header for the external POSIX wrapper API
611      pcre_internal.h         header for internal use
612    config.h.in            template for config.h, which is built by "configure"    ucp.h                   ) headers concerned with
613      ucpinternal.h           )   Unicode property handling
614    pcrecpp.h              public header file for the C++ wrapper    ucptable.h              ) (this one is the data table)
615    pcrecpparg.h.in        template for another C++ header file  
616    pcre_scanner.h         public header file for C++ scanner functions    config.h.in             template for config.h, which is built by "configure"
617    pcrecpp.cc             )  
618    pcre_scanner.cc        ) source for the C++ wrapper library    pcrecpp.h               public header file for the C++ wrapper
619      pcrecpparg.h.in         template for another C++ header file
620    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the    pcre_scanner.h          public header file for C++ scanner functions
621                             C++ stringpiece functions    pcrecpp.cc              )
622    pcre_stringpiece.cc    source for the C++ stringpiece functions    pcre_scanner.cc         ) source for the C++ wrapper library
623    
624      pcre_stringpiece.h.in   template for pcre_stringpiece.h, the header for the
625                                C++ stringpiece functions
626      pcre_stringpiece.cc     source for the C++ stringpiece functions
627    
628  (B) Source files for programs that use PCRE:  (B) Source files for programs that use PCRE:
629    
630    pcredemo.c             simple demonstration of coding calls to PCRE    pcredemo.c              simple demonstration of coding calls to PCRE
631    pcregrep.c             source of a grep utility that uses PCRE    pcregrep.c              source of a grep utility that uses PCRE
632    pcretest.c             comprehensive test program    pcretest.c              comprehensive test program
633    
634  (C) Auxiliary files:  (C) Auxiliary files:
635    
636    132html                script to turn "man" pages into HTML    132html                 script to turn "man" pages into HTML
637    AUTHORS                information about the author of PCRE    AUTHORS                 information about the author of PCRE
638    ChangeLog              log of changes to the code    ChangeLog               log of changes to the code
639    CleanTxt               script to clean nroff output for txt man pages    CleanTxt                script to clean nroff output for txt man pages
640    Detrail                script to remove trailing spaces    Detrail                 script to remove trailing spaces
641    HACKING                some notes about the internals of PCRE    HACKING                 some notes about the internals of PCRE
642    INSTALL                generic installation instructions    INSTALL                 generic installation instructions
643    LICENCE                conditions for the use of PCRE    LICENCE                 conditions for the use of PCRE
644    COPYING                the same, using GNU's standard name    COPYING                 the same, using GNU's standard name
645    Makefile.in            ) template for Unix Makefile, which is built by    Makefile.in             ) template for Unix Makefile, which is built by
646                           )   "configure"                            )   "configure"
647    Makefile.am            ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
648                           )   Makefile.in                            )   Makefile.in
649    NEWS                   important changes in this release    NEWS                    important changes in this release
650    NON-UNIX-USE           notes on building PCRE on non-Unix systems    NON-UNIX-USE            notes on building PCRE on non-Unix systems
651    PrepareRelease         script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
652    README                 this file    README                  this file
653    RunTest.in             template for a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
654    RunGrepTest.in         template for a Unix shell script for pcregrep tests    RunGrepTest             a Unix shell script for pcregrep tests
655    aclocal.m4             m4 macros (generated by "aclocal")    aclocal.m4              m4 macros (generated by "aclocal")
656    config.guess           ) files used by libtool,    config.guess            ) files used by libtool,
657    config.sub             )   used only when building a shared library    config.sub              )   used only when building a shared library
658    configure              a configuring shell script (built by autoconf)    configure               a configuring shell script (built by autoconf)
659    configure.ac           ) the autoconf input that was used to build    configure.ac            ) the autoconf input that was used to build
660                           )   "configure" and config.h                            )   "configure" and config.h
661    depcomp                ) script to find program dependencies, generated by    depcomp                 ) script to find program dependencies, generated by
662                           )   automake                            )   automake
663    doc/*.3                man page sources for the PCRE functions    doc/*.3                 man page sources for the PCRE functions
664    doc/*.1                man page sources for pcregrep and pcretest    doc/*.1                 man page sources for pcregrep and pcretest
665    doc/index.html.src     the base HTML page    doc/index.html.src      the base HTML page
666    doc/html/*             HTML documentation    doc/html/*              HTML documentation
667    doc/pcre.txt           plain text version of the man pages    doc/pcre.txt            plain text version of the man pages
668    doc/pcretest.txt       plain text documentation of test program    doc/pcretest.txt        plain text documentation of test program
669    doc/perltest.txt       plain text documentation of Perl test program    doc/perltest.txt        plain text documentation of Perl test program
670    install-sh             a shell script for installing files    install-sh              a shell script for installing files
671    libpcre.pc.in          template for libpcre.pc for pkg-config    libpcre.pc.in           template for libpcre.pc for pkg-config
672    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config    libpcrecpp.pc.in        template for libpcrecpp.pc for pkg-config
673    ltmain.sh              file used to build a libtool script    ltmain.sh               file used to build a libtool script
674    missing                ) common stub for a few missing GNU programs while    missing                 ) common stub for a few missing GNU programs while
675                           )   installing, generated by automake                            )   installing, generated by automake
676    mkinstalldirs          script for making install directories    mkinstalldirs           script for making install directories
677    perltest.pl            Perl test program    perltest.pl             Perl test program
678    pcre-config.in         source of script which retains PCRE information    pcre-config.in          source of script which retains PCRE information
679    pcrecpp_unittest.cc          )    pcrecpp_unittest.cc          )
680    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
681    pcre_stringpiece_unittest.cc )    pcre_stringpiece_unittest.cc )
682    testdata/testinput*    test data for main library tests    testdata/testinput*     test data for main library tests
683    testdata/testoutput*   expected test results    testdata/testoutput*    expected test results
684    testdata/grep*         input and output for pcregrep tests    testdata/grep*          input and output for pcregrep tests
685    
686  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
687    
# Line 635  The distribution should contain the foll Line 691  The distribution should contain the foll
691  (E) Auxiliary files for VPASCAL  (E) Auxiliary files for VPASCAL
692    
693    makevp.bat    makevp.bat
694    makevp-compile.txt    makevp_c.txt
695    makevp-linklib.txt    makevp_l.txt
696    pcregexp.pas    pcregexp.pas
697    
698  (F) Auxiliary files for building PCRE "by hand"  (F) Auxiliary files for building PCRE "by hand"
699    
700    pcre.h.generic         ) a version of the public PCRE header file    pcre.h.generic          ) a version of the public PCRE header file
701                           )   for use in non-"configure" environments                            )   for use in non-"configure" environments
702    config.h.generic       ) a version of config.h for use in non-"configure"    config.h.generic        ) a version of config.h for use in non-"configure"
703                           )   environments                            )   environments
704    
705  (F) Miscellaneous  (F) Miscellaneous
706    
# Line 653  The distribution should contain the foll Line 709  The distribution should contain the foll
709  Philip Hazel  Philip Hazel
710  Email local part: ph10  Email local part: ph10
711  Email domain: cam.ac.uk  Email domain: cam.ac.uk
712  Last updated: March 2007  Last updated: 29 March 2007

Legend:
Removed from v.127  
changed lines
  Added in v.145

  ViewVC Help
Powered by ViewVC 1.1.5