1 #ifndef PCRS_H_INCLUDED
2 #define PCRS_H_INCLUDED
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/pcrs.h,v $
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.
12 * Apart from the code being quite a mess, no inconsistencies,
13 * memory leaks or functional bugs **should** be present.
15 * While you ROTFL at the code, you could just as well mail me
16 * (oes@paradis.rhein.de) with advice for improvement.
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.
22 * Currently, there's no documentation besides comments and the
25 * Copyright : Written and copyright 2001 by Sourceforge IJBSWA team.
29 * Revision 1.5 2001/07/18 17:27:00 oes
30 * Changed interface; Cosmetics
32 * Revision 1.4 2001/06/29 13:33:19 oes
33 * - Cleaned up, commented and adapted to reflect the
35 * - Introduced the PCRS_* flags
37 * Revision 1.3 2001/06/09 10:58:57 jongfoster
38 * Removing a single unused #define which referenced BUFSIZ
40 * Revision 1.2 2001/05/25 11:03:55 oes
41 * Added sanity check for NULL jobs to pcrs_exec_substitution
43 * Revision 1.1.1.1 2001/05/15 13:59:02 oes
44 * Initial import of version 2.9.3 source tree
46 * Revision 1.4 2001/05/11 01:57:02 rodney
47 * Added new file header standard w/RCS control tags.
49 * revision 1.3 2001/05/08 02:38:13 rodney
50 * Changed C++ "//" style comment to C style comments.
52 * revision 1.2 2001/04/30 02:39:24 rodney
53 * Made this pcrs.h file conditionally included.
55 * revision 1.1 2001/04/16 21:10:38 rodney
58 *********************************************************************/
60 #define PCRS_H_VERSION "$Id: pcrs.h,v 1.5 2001/07/18 17:27:00 oes Exp $"
77 #define PCRS_MAX_MATCHES 300
78 #define PCRS_MAX_SUBMATCHES 33
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 */
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 */
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 */
105 typedef struct PCRS_MATCH {
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 */
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 */
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);
131 extern pcrs_job *pcrs_free_job(pcrs_job *job);
132 extern void pcrs_free_joblist(pcrs_job *joblist);
135 extern int pcrs_compile_perl_options(char *optstring, int *flags);
136 extern pcrs_substitute *pcrs_compile_replacement(char *replacement, int trivialflag, int *errptr);
142 #endif /* ndef PCRS_H_INCLUDED */