X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=pcrs.h;h=abff3caa5418ca3c4bcd08c4d5fe111b7d9f4961;hp=8f2af81c1bdd36b18edaa350dc7ecca98b0e9da7;hb=31265b1b2d8f5b81cbde0fcada6271d800430c59;hpb=fe13479b5c64c6f057385dc44aacdd24f82a4a1c diff --git a/pcrs.h b/pcrs.h index 8f2af81c..abff3caa 100644 --- a/pcrs.h +++ b/pcrs.h @@ -5,68 +5,36 @@ * * 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 + * * - * 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 * - * 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.6 2001/07/29 18:52:06 jongfoster - * Renaming _PCRS_H, and adding "extern C {}" - * - * Revision 1.5 2001/07/18 17:27:00 oes - * Changed interface; Cosmetics - * - * 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. - * - * 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.6 2001/07/29 18:52:06 jongfoster Exp $" - +#ifndef _PCRE_H #include - -#ifdef __cplusplus -extern "C" { #endif /* @@ -77,50 +45,77 @@ extern "C" { #define TRUE 1 /* Capacity */ -#define PCRS_MAX_MATCHES 300 -#define PCRS_MAX_SUBMATCHES 33 +#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 */ -/* 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 */ +/* + * 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_SUCCESS 2 /* Job did previously match */ -#define PCRS_TRIVIAL 4 /* Backreferences in the substitute are ignored */ +#define PCRS_TRIVIAL 2 /* Backreferences in the substitute are ignored */ +#define PCRS_SUCCESS 4 /* Job did previously match */ +#define PCRS_DYNAMIC 8 /* Job is dynamic (used to disable JIT compilation) */ + /* * Data types: */ /* 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 */ + +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 PCRS_MATCH { - /* char *buffer; */ - 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 */ + +/* + * 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; + +/* 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 compiles pcrs substitute */ + pcrs_substitute *substitute; /* The compiled pcrs substitute */ struct PCRS_JOB *next; /* Pointer for chaining jobs to joblists */ } pcrs_job; + /* * Prototypes: */ @@ -128,18 +123,38 @@ typedef struct PCRS_JOB { /* 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, char *subject, int subject_length, char **result, int *result_length); +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 void pcrs_free_joblist(pcrs_job *joblist); -/* Expert usage */ -extern int pcrs_compile_perl_options(const char *optstring, int *flags); -extern pcrs_substitute *pcrs_compile_replacement(const char *replacement, int trivialflag, int *errptr); +/* Info on errors: */ +extern const char *pcrs_strerror(const int error); -#ifdef __cplusplus -} /* extern "C" */ +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_INCLUDED */