tools/pcre/pcreposix.h
author Nicholas Hastings <skamonkey@gmail.com>
Sun Jul 15 12:31:06 2012 -0400 (2012-07-15)
changeset 3579 6d730190a3e4
parent 2762 d2d467bf1b5a
child 3831 babd0eee3c5e
permissions -rw-r--r--
Added missing files to each core and logic makefiles (NPOTB).
     1 /*************************************************
     2 *       Perl-Compatible Regular Expressions      *
     3 *************************************************/
     4 
     5 #ifndef _PCREPOSIX_H
     6 #define _PCREPOSIX_H
     7 
     8 /* This is the header for the POSIX wrapper interface to the PCRE Perl-
     9 Compatible Regular Expression library. It defines the things POSIX says should
    10 be there. I hope.
    11 
    12             Copyright (c) 1997-2009 University of Cambridge
    13 
    14 -----------------------------------------------------------------------------
    15 Redistribution and use in source and binary forms, with or without
    16 modification, are permitted provided that the following conditions are met:
    17 
    18     * Redistributions of source code must retain the above copyright notice,
    19       this list of conditions and the following disclaimer.
    20 
    21     * Redistributions in binary form must reproduce the above copyright
    22       notice, this list of conditions and the following disclaimer in the
    23       documentation and/or other materials provided with the distribution.
    24 
    25     * Neither the name of the University of Cambridge nor the names of its
    26       contributors may be used to endorse or promote products derived from
    27       this software without specific prior written permission.
    28 
    29 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    30 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    31 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    32 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    33 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    34 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    35 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    36 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    37 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    38 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    39 POSSIBILITY OF SUCH DAMAGE.
    40 -----------------------------------------------------------------------------
    41 */
    42 
    43 /* Have to include stdlib.h in order to ensure that size_t is defined. */
    44 
    45 #include <stdlib.h>
    46 
    47 /* Allow for C++ users */
    48 
    49 #ifdef __cplusplus
    50 extern "C" {
    51 #endif
    52 
    53 /* Options, mostly defined by POSIX, but with a couple of extras. */
    54 
    55 #define REG_ICASE     0x0001
    56 #define REG_NEWLINE   0x0002
    57 #define REG_NOTBOL    0x0004
    58 #define REG_NOTEOL    0x0008
    59 #define REG_DOTALL    0x0010   /* NOT defined by POSIX. */
    60 #define REG_NOSUB     0x0020
    61 #define REG_UTF8      0x0040   /* NOT defined by POSIX. */
    62 #define REG_STARTEND  0x0080   /* BSD feature: pass subject string by so,eo */
    63 #define REG_NOTEMPTY  0x0100   /* NOT defined by POSIX. */
    64 
    65 /* This is not used by PCRE, but by defining it we make it easier
    66 to slot PCRE into existing programs that make POSIX calls. */
    67 
    68 #define REG_EXTENDED  0
    69 
    70 /* Error values. Not all these are relevant or used by the wrapper. */
    71 
    72 enum {
    73   REG_ASSERT = 1,  /* internal error ? */
    74   REG_BADBR,       /* invalid repeat counts in {} */
    75   REG_BADPAT,      /* pattern error */
    76   REG_BADRPT,      /* ? * + invalid */
    77   REG_EBRACE,      /* unbalanced {} */
    78   REG_EBRACK,      /* unbalanced [] */
    79   REG_ECOLLATE,    /* collation error - not relevant */
    80   REG_ECTYPE,      /* bad class */
    81   REG_EESCAPE,     /* bad escape sequence */
    82   REG_EMPTY,       /* empty expression */
    83   REG_EPAREN,      /* unbalanced () */
    84   REG_ERANGE,      /* bad range inside [] */
    85   REG_ESIZE,       /* expression too big */
    86   REG_ESPACE,      /* failed to get memory */
    87   REG_ESUBREG,     /* bad back reference */
    88   REG_INVARG,      /* bad argument */
    89   REG_NOMATCH      /* match failed */
    90 };
    91 
    92 
    93 /* The structure representing a compiled regular expression. */
    94 
    95 typedef struct {
    96   void *re_pcre;
    97   size_t re_nsub;
    98   size_t re_erroffset;
    99 } regex_t;
   100 
   101 /* The structure in which a captured offset is returned. */
   102 
   103 typedef int regoff_t;
   104 
   105 typedef struct {
   106   regoff_t rm_so;
   107   regoff_t rm_eo;
   108 } regmatch_t;
   109 
   110 /* When an application links to a PCRE DLL in Windows, the symbols that are
   111 imported have to be identified as such. When building PCRE, the appropriate
   112 export settings are needed, and are set in pcreposix.c before including this
   113 file. */
   114 
   115 #if defined(_WIN32) && !defined(PCRE_STATIC) && !defined(PCREPOSIX_EXP_DECL)
   116 #  define PCREPOSIX_EXP_DECL  extern __declspec(dllimport)
   117 #  define PCREPOSIX_EXP_DEFN  __declspec(dllimport)
   118 #endif
   119 
   120 /* By default, we use the standard "extern" declarations. */
   121 
   122 #ifndef PCREPOSIX_EXP_DECL
   123 #  ifdef __cplusplus
   124 #    define PCREPOSIX_EXP_DECL  extern "C"
   125 #    define PCREPOSIX_EXP_DEFN  extern "C"
   126 #  else
   127 #    define PCREPOSIX_EXP_DECL  extern
   128 #    define PCREPOSIX_EXP_DEFN  extern
   129 #  endif
   130 #endif
   131 
   132 /* The functions */
   133 
   134 PCREPOSIX_EXP_DECL int regcomp(regex_t *, const char *, int);
   135 PCREPOSIX_EXP_DECL int regexec(const regex_t *, const char *, size_t,
   136                      regmatch_t *, int);
   137 PCREPOSIX_EXP_DECL size_t regerror(int, const regex_t *, char *, size_t);
   138 PCREPOSIX_EXP_DECL void regfree(regex_t *);
   139 
   140 #ifdef __cplusplus
   141 }   /* extern "C" */
   142 #endif
   143 
   144 #endif /* End of pcreposix.h */