/*********************************************************************
*
- * File : $Source: /home/administrator/cvs/ijb/pcrs.h,v $
+ * File : $Source: /cvsroot/ijbswa/current/pcrs.h,v $
*
* Purpose : This is the pre-pre-alpha realease of libpcrs. It is only
* published at this (ugly) stage of development, because it is
*
* Revisions :
* $Log: pcrs.h,v $
+ * Revision 1.4 2001/06/29 13:33:19 oes
+ * - Cleaned up, commented and adapted to reflect the
+ * changes in pcrs.c
+ * - Introduced the PCRS_* flags
+ *
+ * Revision 1.3 2001/06/09 10:58:57 jongfoster
+ * Removing a single unused #define which referenced BUFSIZ
+ *
+ * Revision 1.2 2001/05/25 11:03:55 oes
+ * Added sanity check for NULL jobs to pcrs_exec_substitution
+ *
+ * Revision 1.1.1.1 2001/05/15 13:59:02 oes
+ * Initial import of version 2.9.3 source tree
+ *
* Revision 1.4 2001/05/11 01:57:02 rodney
* Added new file header standard w/RCS control tags.
*
*
*********************************************************************/
-#define PCRS_H_VERSION "$Id: pcrs.h,v 1.1 2001/05/13 21:57:07 administrator Exp $"
+#define PCRS_H_VERSION "$Id: pcrs.h,v 1.4 2001/06/29 13:33:19 oes Exp $"
\f
-
#include <pcre.h>
+/*
+ * Constants:
+ */
+
#define FALSE 0
#define TRUE 1
+
+/* Capacity */
#define PCRS_MAX_MATCHES 300
#define PCRS_MAX_SUBMATCHES 33
-#define CHARBUFSIZ BUFSIZ * sizeof(char)
+/* Error codes */
#define PCRS_ERR_NOMEM -10 /* Failed to acquire memory. */
#define PCRS_ERR_CMDSYNTAX -11 /* Syntax of s///-command */
#define PCRS_ERR_STUDY -12 /* pcre error while studying the pattern */
+#define PCRS_ERR_BADJOB -13 /* NULL job pointer, pattern or substitute */
+
+/* Flags */
+#define PCRS_GLOBAL 1 /* Job should be applied globally, as with perl's g option */
+#define PCRS_SUCCESS 2 /* Job did previously match */
+#define PCRS_TRIVIAL 4 /* Backreferences in the substitute are ignored */
+
+/*
+ * Data types:
+ */
-typedef struct S_PCRS_SUBSTITUTE {
- char *text;
- int backrefs;
- int block_offset[PCRS_MAX_SUBMATCHES];
- int block_length[PCRS_MAX_SUBMATCHES];
- int backref[PCRS_MAX_SUBMATCHES];
- int backref_count[PCRS_MAX_SUBMATCHES];
+/* A compiled substitute */
+typedef struct PCRS_SUBSTITUTE {
+ char *text; /* The plaintext part of the substitute, with all backreferences stripped */
+ int backrefs; /* The number of backreferences */
+ int block_offset[PCRS_MAX_SUBMATCHES]; /* Array with the offsets of all plaintext blocks in text */
+ int block_length[PCRS_MAX_SUBMATCHES]; /* Array with the lengths of all plaintext blocks in text */
+ int backref[PCRS_MAX_SUBMATCHES]; /* Array with the backref number for all plaintext block borders */
+ int backref_count[PCRS_MAX_SUBMATCHES]; /* Array with the number of reference to each backref index */
} pcrs_substitute;
-typedef struct S_PCRS_MATCH {
+typedef struct PCRS_MATCH {
/* char *buffer; */
- int submatches;
- int submatch_offset[PCRS_MAX_SUBMATCHES];
- int submatch_length[PCRS_MAX_SUBMATCHES];
+ int submatches; /* Number of submatches. Note: The zeroth is the whole match */
+ int submatch_offset[PCRS_MAX_SUBMATCHES]; /* Offset for each submatch in the subject */
+ int submatch_length[PCRS_MAX_SUBMATCHES]; /* Length of each submatch in the subject */
} pcrs_match;
-typedef struct S_PCRS_JOB {
- pcre *pattern;
- pcre_extra *hints;
- int options;
- int globalflag;
- int successflag;
- pcrs_substitute *substitute;
- struct S_PCRS_JOB *next;
+typedef struct PCRS_JOB {
+ pcre *pattern; /* The compiled pcre pattern */
+ pcre_extra *hints; /* The pcre hints for the pattern */
+ int options; /* The pcre options (numeric) */
+ int flags; /* The pcrs and user flags (see "Flags" above) */
+ pcrs_substitute *substitute; /* The compiles pcrs substitute */
+ struct PCRS_JOB *next; /* Pointer for chaining jobs to joblists */
} pcrs_job;
-extern int pcrs_compile_perl_options(char *optstring, int *globalflag);
-extern pcrs_substitute *pcrs_compile_replacement(char *replacement, int *errptr);
+/*
+ * Prototypes:
+ */
+
+/* Main usage */
+extern pcrs_job *pcrs_compile_command(char *command, int *errptr);
+extern pcrs_job *pcrs_compile(char *pattern, char *substitute, char *options, int *errptr);
+extern int pcrs_execute(pcrs_job *job, char *subject, int subject_length, char **result, int *result_length);
+
+/* Freeing jobs */
extern pcrs_job *pcrs_free_job(pcrs_job *job);
-extern pcrs_job *pcrs_make_job(char *command, int *errptr);
-extern pcrs_job *create_pcrs_job(pcre *pattern, pcre_extra *hints, int options, int globalflag, pcrs_substitute *substitute, int *errptr);
-extern int pcrs_exec_substitution(pcrs_job *job, char *subject, int subject_length, char **result, int *result_length);
+extern void pcrs_free_joblist(pcrs_job *joblist);
+/* Expert usage */
+extern int pcrs_compile_perl_options(char *optstring, int *flags);
+extern pcrs_substitute *pcrs_compile_replacement(char *replacement, int trivialflag, int *errptr);
#endif /* ndef _PCRS_H */