pcrs.h

   1 #ifndef PCRS_H_INCLUDED
   2 #define PCRS_H_INCLUDED
   3
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/pcrs.h,v $
   7  *
   8  * Purpose     :  Header file for pcrs.c
   9  *
  10  * Copyright   :  see pcrs.c
  11  *
  12  * Revisions   :
  13  *    $Log: pcrs.h,v $
  14  *    Revision 1.9  2001/08/18 11:35:29  oes
  15  *    - Introduced pcrs_strerror()
  16  *    - added pcrs_execute_list()
  17  *
  18  *    Revision 1.8  2001/08/15 15:32:50  oes
  19  *    Replaced the hard limit for the maximum number of matches
  20  *    by dynamic reallocation
  21  *
  22  *    Revision 1.7  2001/08/05 13:13:11  jongfoster
  23  *    Making parameters "const" where possible.
  24  *
  25  *    Revision 1.6  2001/07/29 18:52:06  jongfoster
  26  *    Renaming _PCRS_H, and adding "extern C {}"
  27  *
  28  *    Revision 1.5  2001/07/18 17:27:00  oes
  29  *    Changed interface; Cosmetics
  30  *
  31  *    Revision 1.4  2001/06/29 13:33:19  oes
  32  *    - Cleaned up, commented and adapted to reflect the
  33  *      changes in pcrs.c
  34  *    - Introduced the PCRS_* flags
  35  *
  36  *    Revision 1.3  2001/06/09 10:58:57  jongfoster
  37  *    Removing a single unused #define which referenced BUFSIZ
  38  *
  39  *    Revision 1.2  2001/05/25 11:03:55  oes
  40  *    Added sanity check for NULL jobs to pcrs_exec_substitution
  41  *
  42  *    Revision 1.1.1.1  2001/05/15 13:59:02  oes
  43  *    Initial import of version 2.9.3 source tree
  44  *
  45  *    Revision 1.4  2001/05/11 01:57:02  rodney
  46  *    Added new file header standard w/RCS control tags.
  47  *
  48  *    revision 1.3  2001/05/08 02:38:13  rodney
  49  *    Changed C++ "//" style comment to C style comments.
  50  *
  51  *    revision 1.2  2001/04/30 02:39:24  rodney
  52  *    Made this pcrs.h file conditionally included.
  53  *
  54  *    revision 1.1  2001/04/16 21:10:38  rodney
  55  *    Initial checkin
  56  *
  57  *********************************************************************/
  58
  59 #define PCRS_H_VERSION "$Id: pcrs.h,v 1.9 2001/08/18 11:35:29 oes Exp $"
  60 \f
  61
  62 #ifndef _PCRE_H
  63 #include <pcre.h>
  64 #endif
  65
  66 #ifdef __cplusplus
  67 extern "C" {
  68 #endif
  69
  70 /*
  71  * Constants:
  72  */
  73
  74 #define FALSE 0
  75 #define TRUE 1
  76
  77 /* Capacity */
  78 #define PCRS_MAX_SUBMATCHES  33     /* Maximum number of capturing subpatterns allowed. MUST be <= 99! FIXME: Should be dynamic */
  79 #define PCRS_MAX_MATCH_INIT  40     /* Initial amount of matches that can be stored in global searches */
  80 #define PCRS_MAX_MATCH_GROW  1.6    /* Factor by which storage for matches is extended if exhausted */
  81
  82 /* Error codes */
  83 #define PCRS_ERR_NOMEM     -10      /* Failed to acquire memory. */
  84 #define PCRS_ERR_CMDSYNTAX -11      /* Syntax of s///-command */
  85 #define PCRS_ERR_STUDY     -12      /* pcre error while studying the pattern */
  86 #define PCRS_ERR_BADJOB    -13      /* NULL job pointer, pattern or substitute */
  87 #define PCRS_WARN_BADREF   -14      /* Backreference out of range */
  88
  89 /* Flags */
  90 #define PCRS_GLOBAL          1      /* Job should be applied globally, as with perl's g option */
  91 #define PCRS_TRIVIAL         2      /* Backreferences in the substitute are ignored */
  92 #define PCRS_SUCCESS         4      /* Job did previously match */
  93
  94
  95 /*
  96  * Data types:
  97  */
  98
  99 /* A compiled substitute */
 100
 101 typedef struct {
 102   char *text;                                 /* The plaintext part of the substitute, with all backreferences stripped */
 103   int backrefs;                               /* The number of backreferences */
 104   int block_offset[PCRS_MAX_SUBMATCHES];      /* Array with the offsets of all plaintext blocks in text */
 105   int block_length[PCRS_MAX_SUBMATCHES];      /* Array with the lengths of all plaintext blocks in text */
 106   int backref[PCRS_MAX_SUBMATCHES];           /* Array with the backref number for all plaintext block borders */
 107   int backref_count[PCRS_MAX_SUBMATCHES + 2]; /* Array with the number of references to each backref index */
 108 } pcrs_substitute;
 109
 110
 111 /*
 112  * A match, including all captured subpatterns (submatches)
 113  * Note: The zeroth is the whole match, the PCRS_MAX_SUBMATCHES + 0th
 114  * is the range before the match, the PCRS_MAX_SUBMATCHES + 1th is the
 115  * range after the match.
 116  */
 117
 118 typedef struct {
 119   int submatches;                               /* Number of captured subpatterns */
 120   int submatch_offset[PCRS_MAX_SUBMATCHES + 2]; /* Offset for each submatch in the subject */
 121   int submatch_length[PCRS_MAX_SUBMATCHES + 2]; /* Length of each submatch in the subject */
 122 } pcrs_match;
 123
 124
 125 /* A PCRS job */
 126
 127 typedef struct PCRS_JOB {
 128   pcre *pattern;                            /* The compiled pcre pattern */
 129   pcre_extra *hints;                        /* The pcre hints for the pattern */
 130   int options;                              /* The pcre options (numeric) */
 131   int flags;                                /* The pcrs and user flags (see "Flags" above) */
 132   pcrs_substitute *substitute;              /* The compiled pcrs substitute */
 133   struct PCRS_JOB *next;                    /* Pointer for chaining jobs to joblists */
 134 } pcrs_job;
 135
 136
 137 /*
 138  * Prototypes:
 139  */
 140
 141 /* Main usage */
 142 extern pcrs_job        *pcrs_compile_command(const char *command, int *errptr);
 143 extern pcrs_job        *pcrs_compile(const char *pattern, const char *substitute, const char *options, int *errptr);
 144 extern int              pcrs_execute(pcrs_job *job, char *subject, size_t subject_length, char **result, size_t *result_length);
 145 extern int              pcrs_execute_list(pcrs_job *joblist, char *subject, size_t subject_length, char **result, size_t *result_length);
 146
 147 /* Freeing jobs */
 148 extern pcrs_job        *pcrs_free_job(pcrs_job *job);
 149 extern void             pcrs_free_joblist(pcrs_job *joblist);
 150
 151 /* Info on errors: */
 152 extern const char *pcrs_strerror(const int error);
 153
 154
 155 #ifdef __cplusplus
 156 } /* extern "C" */
 157 #endif
 158
 159 #endif /* ndef PCRS_H_INCLUDED */
 160
 161 /*
 162   Local Variables:
 163   tab-width: 3
 164   end:
 165 */