-#ifndef _PCRS_H
-#define _PCRS_H
+#ifndef PCRS_H_INCLUDED
+#define PCRS_H_INCLUDED
/*********************************************************************
*
* 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
- * needed for a new feature in JunkBuster.
+ * Purpose : Header file for pcrs.c
*
- * Apart from the code being quite a mess, no inconsistencies,
- * memory leaks or functional bugs **should** be present.
+ * Copyright : Written and Copyright (C) 2000, 2001 by Andreas S. Oesterhelt
+ * <andreas@oesterhelt.org>
*
- * While you ROTFL at the code, you could just as well mail me
- * (oes@paradis.rhein.de) with advice for improvement.
+ * Copyright (C) 2006, 2007 Fabian Keil <fk@fabiankeil.de>
*
- * pcrs is a supplement to the brilliant pcre library by Philip
- * Hazel (ph10@cam.ac.uk) and adds Perl-style substitution. That
- * is, it mimics Perl's 's' operator.
+ * This program is free software; you can redistribute it
+ * and/or modify it under the terms of the GNU General
+ * Public License as published by the Free Software
+ * Foundation; either version 2 of the License, or (at
+ * your option) any later version.
*
- * Currently, there's no documentation besides comments and the
- * source itself ;-)
+ * This program is distributed in the hope that it will
+ * be useful, but WITHOUT ANY WARRANTY; without even the
+ * implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU General Public
+ * License for more details.
*
- * Copyright : Written and copyright 2001 by Sourceforge IJBSWA team.
- *
- * Revisions :
- * $Log: pcrs.h,v $
- * 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.
- *
- * revision 1.3 2001/05/08 02:38:13 rodney
- * Changed C++ "//" style comment to C style comments.
- *
- * revision 1.2 2001/04/30 02:39:24 rodney
- * Made this pcrs.h file conditionally included.
- *
- * revision 1.1 2001/04/16 21:10:38 rodney
- * Initial checkin
+ * The GNU General Public License should be included with
+ * this file. If not, you can view it at
+ * http://www.gnu.org/copyleft/gpl.html
+ * or write to the Free Software Foundation, Inc., 59
+ * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*********************************************************************/
-#define PCRS_H_VERSION "$Id: pcrs.h,v 1.2 2001/05/25 11:03:55 oes Exp $"
-\f
-
+#ifndef _PCRE_H
#include <pcre.h>
+#endif
+
+/*
+ * Constants:
+ */
#define FALSE 0
#define TRUE 1
-#define PCRS_MAX_MATCHES 300
-#define PCRS_MAX_SUBMATCHES 33
-
-#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 */
-
-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];
+
+/* Capacity */
+#define PCRS_MAX_SUBMATCHES 33 /* Maximum number of capturing subpatterns allowed. MUST be <= 99! FIXME: Should be dynamic */
+#define PCRS_MAX_MATCH_INIT 40 /* Initial amount of matches that can be stored in global searches */
+#define PCRS_MAX_MATCH_GROW 1.6 /* Factor by which storage for matches is extended if exhausted */
+
+/*
+ * PCRS error codes
+ *
+ * They are supposed to be handled together with PCRE error
+ * codes and have to start with an offset to prevent overlaps.
+ *
+ * PCRE 6.7 uses error codes from -1 to -21, PCRS error codes
+ * below -100 should be safe for a while.
+ */
+#define PCRS_ERR_NOMEM -100 /* Failed to acquire memory. */
+#define PCRS_ERR_CMDSYNTAX -101 /* Syntax of s///-command */
+#define PCRS_ERR_STUDY -102 /* pcre error while studying the pattern */
+#define PCRS_ERR_BADJOB -103 /* NULL job pointer, pattern or substitute */
+#define PCRS_WARN_BADREF -104 /* Backreference out of range */
+#define PCRS_WARN_TRUNCATION -105 /* At least one pcrs variable was too big,
+ * only the first part was used. */
+
+/* Flags */
+#define PCRS_GLOBAL 1 /* Job should be applied globally, as with perl's g option */
+#define PCRS_TRIVIAL 2 /* Backreferences in the substitute are ignored */
+#define PCRS_SUCCESS 4 /* Job did previously match */
+
+
+/*
+ * Data types:
+ */
+
+/* A compiled substitute */
+
+typedef struct {
+ char *text; /* The plaintext part of the substitute, with all backreferences stripped */
+ size_t length; /* The substitute may not be a valid C string so we can't rely on strlen(). */
+ int backrefs; /* The number of backreferences */
+ int block_offset[PCRS_MAX_SUBMATCHES]; /* Array with the offsets of all plaintext blocks in text */
+ size_t 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 + 2]; /* Array with the number of references to each backref index */
} pcrs_substitute;
-typedef struct S_PCRS_MATCH {
- /* char *buffer; */
- int submatches;
- int submatch_offset[PCRS_MAX_SUBMATCHES];
- int submatch_length[PCRS_MAX_SUBMATCHES];
+
+/*
+ * A match, including all captured subpatterns (submatches)
+ * Note: The zeroth is the whole match, the PCRS_MAX_SUBMATCHES + 0th
+ * is the range before the match, the PCRS_MAX_SUBMATCHES + 1th is the
+ * range after the match.
+ */
+
+typedef struct {
+ int submatches; /* Number of captured subpatterns */
+ int submatch_offset[PCRS_MAX_SUBMATCHES + 2]; /* Offset for each submatch in the subject */
+ size_t submatch_length[PCRS_MAX_SUBMATCHES + 2]; /* 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;
+
+/* A PCRS job */
+
+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 compiled 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(const char *command, int *errptr);
+extern pcrs_job *pcrs_compile(const char *pattern, const char *substitute, const char *options, int *errptr);
+extern int pcrs_execute(pcrs_job *job, const char *subject, size_t subject_length, char **result, size_t *result_length);
+extern int pcrs_execute_list(pcrs_job *joblist, char *subject, size_t subject_length, char **result, size_t *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);
+
+/* Info on errors: */
+extern const char *pcrs_strerror(const int error);
+
+extern int pcrs_job_is_dynamic(char *job);
+extern char pcrs_get_delimiter(const char *string);
+extern char *pcrs_execute_single_command(const char *subject, const char *pcrs_command, int *hits);
+/*
+ * Variable/value pair for dynamic pcrs commands.
+ */
+struct pcrs_variable
+{
+ const char *name;
+ char *value;
+ int static_value;
+};
+
+extern pcrs_job *pcrs_compile_dynamic_command(char *pcrs_command, const struct pcrs_variable v[], int *error);
+
+/* Only relevant for maximum pcrs variable size */
+#ifndef PCRS_BUFFER_SIZE
+#define PCRS_BUFFER_SIZE 4000
+#endif /* ndef PCRS_BUFFER_SIZE */
+#ifdef FUZZ
+extern pcrs_substitute *pcrs_compile_fuzzed_replacement(const char *replacement, int *errptr);
+#endif
-#endif /* ndef _PCRS_H */
+#endif /* ndef PCRS_H_INCLUDED */
/*
Local Variables:
projects / privoxy.git / blobdiff