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     :  This is the pre-pre-alpha realease of libpcrs. It is only
   9  *                published at this (ugly) stage of development, because it is
  10  *                needed for a new feature in JunkBuster.
  11  *
  12  *                Apart from the code being quite a mess, no inconsistencies,
  13  *                memory leaks or functional bugs **should** be present.
  14  *
  15  *                While you ROTFL at the code, you could just as well mail me
  16  *                (oes@paradis.rhein.de) with advice for improvement.
  17  *
  18  *                pcrs is a supplement to the brilliant pcre library by Philip
  19  *                Hazel (ph10@cam.ac.uk) and adds Perl-style substitution. That
  20  *                is, it mimics Perl's 's' operator.
  21  *
  22  *                Currently, there's no documentation besides comments and the
  23  *                source itself ;-)
  24  *
  25  * Copyright   :  Written and copyright 2001 by Sourceforge IJBSWA team.
  26  *
  27  * Revisions   :
  28  *    $Log: pcrs.h,v $
  29  *    Revision 1.5  2001/07/18 17:27:00  oes
  30  *    Changed interface; Cosmetics
  31  *
  32  *    Revision 1.4  2001/06/29 13:33:19  oes
  33  *    - Cleaned up, commented and adapted to reflect the
  34  *      changes in pcrs.c
  35  *    - Introduced the PCRS_* flags
  36  *
  37  *    Revision 1.3  2001/06/09 10:58:57  jongfoster
  38  *    Removing a single unused #define which referenced BUFSIZ
  39  *
  40  *    Revision 1.2  2001/05/25 11:03:55  oes
  41  *    Added sanity check for NULL jobs to pcrs_exec_substitution
  42  *
  43  *    Revision 1.1.1.1  2001/05/15 13:59:02  oes
  44  *    Initial import of version 2.9.3 source tree
  45  *
  46  *    Revision 1.4  2001/05/11 01:57:02  rodney
  47  *    Added new file header standard w/RCS control tags.
  48  *
  49  *    revision 1.3  2001/05/08 02:38:13  rodney
  50  *    Changed C++ "//" style comment to C style comments.
  51  *
  52  *    revision 1.2  2001/04/30 02:39:24  rodney
  53  *    Made this pcrs.h file conditionally included.
  54  *
  55  *    revision 1.1  2001/04/16 21:10:38  rodney
  56  *    Initial checkin
  57  *
  58  *********************************************************************/
  59
  60 #define PCRS_H_VERSION "$Id: pcrs.h,v 1.5 2001/07/18 17:27:00 oes Exp $"
  61 \f
  62
  63 #include <pcre.h>
  64
  65 #ifdef __cplusplus
  66 extern "C" {
  67 #endif
  68
  69 /*
  70  * Constants:
  71  */
  72
  73 #define FALSE 0
  74 #define TRUE 1
  75
  76 /* Capacity */
  77 #define PCRS_MAX_MATCHES 300
  78 #define PCRS_MAX_SUBMATCHES 33
  79
  80 /* Error codes */
  81 #define PCRS_ERR_NOMEM     -10      /* Failed to acquire memory. */
  82 #define PCRS_ERR_CMDSYNTAX -11      /* Syntax of s///-command */
  83 #define PCRS_ERR_STUDY     -12      /* pcre error while studying the pattern */
  84 #define PCRS_ERR_BADJOB    -13      /* NULL job pointer, pattern or substitute */
  85
  86 /* Flags */
  87 #define PCRS_GLOBAL          1      /* Job should be applied globally, as with perl's g option */
  88 #define PCRS_SUCCESS         2      /* Job did previously match */
  89 #define PCRS_TRIVIAL         4      /* Backreferences in the substitute are ignored */
  90
  91 /*
  92  * Data types:
  93  */
  94
  95 /* A compiled substitute */
  96 typedef struct PCRS_SUBSTITUTE {
  97   char *text;                               /* The plaintext part of the substitute, with all backreferences stripped */
  98   int backrefs;                             /* The number of backreferences */
  99   int block_offset[PCRS_MAX_SUBMATCHES];    /* Array with the offsets of all plaintext blocks in text */
 100   int block_length[PCRS_MAX_SUBMATCHES];    /* Array with the lengths of all plaintext blocks in text */
 101   int backref[PCRS_MAX_SUBMATCHES];         /* Array with the backref number for all plaintext block borders */
 102   int backref_count[PCRS_MAX_SUBMATCHES];   /* Array with the number of reference to each backref index */
 103 } pcrs_substitute;
 104
 105 typedef struct PCRS_MATCH {
 106   /* char *buffer; */
 107   int submatches;                           /* Number of submatches. Note: The zeroth is the whole match */
 108   int submatch_offset[PCRS_MAX_SUBMATCHES]; /* Offset for each submatch in the subject */
 109   int submatch_length[PCRS_MAX_SUBMATCHES]; /* Length of each submatch in the subject */
 110 } pcrs_match;
 111
 112 typedef struct PCRS_JOB {
 113   pcre *pattern;                            /* The compiled pcre pattern */
 114   pcre_extra *hints;                        /* The pcre hints for the pattern */
 115   int options;                              /* The pcre options (numeric) */
 116   int flags;                                /* The pcrs and user flags (see "Flags" above) */
 117   pcrs_substitute *substitute;              /* The compiles pcrs substitute */
 118   struct PCRS_JOB *next;                    /* Pointer for chaining jobs to joblists */
 119 } pcrs_job;
 120
 121 /*
 122  * Prototypes:
 123  */
 124
 125 /* Main usage */
 126 extern pcrs_job        *pcrs_compile_command(char *command, int *errptr);
 127 extern pcrs_job        *pcrs_compile(char *pattern, char *substitute, char *options, int *errptr);
 128 extern int              pcrs_execute(pcrs_job *job, char *subject, int subject_length, char **result, int *result_length);
 129
 130 /* Freeing jobs */
 131 extern pcrs_job        *pcrs_free_job(pcrs_job *job);
 132 extern void             pcrs_free_joblist(pcrs_job *joblist);
 133
 134 /* Expert usage */
 135 extern int              pcrs_compile_perl_options(char *optstring, int *flags);
 136 extern pcrs_substitute *pcrs_compile_replacement(char *replacement, int trivialflag, int *errptr);
 137
 138 #ifdef __cplusplus
 139 } /* extern "C" */
 140 #endif
 141
 142 #endif /* ndef PCRS_H_INCLUDED */
 143
 144 /*
 145   Local Variables:
 146   tab-width: 3
 147   end:
 148 */