123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166 |
- #ifndef PCRS_H_INCLUDED
- #define PCRS_H_INCLUDED
- /*********************************************************************
- *
- * File : $Source: /cvsroot/ijbswa/current/pcrs.h,v $
- *
- * Purpose : Header file for pcrs.c
- *
- * Copyright : Written and Copyright (C) 2000, 2001 by Andreas S. Oesterhelt
- * <andreas@oesterhelt.org>
- *
- * Copyright (C) 2006, 2007 Fabian Keil <fk@fabiankeil.de>
- *
- * 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.
- *
- * 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.
- *
- * 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.
- *
- *********************************************************************/
- #ifndef _PCRE_H
- #include <pcre.h>
- #endif
- /*
- * Constants:
- */
- #define FALSE 0
- #define TRUE 1
- /* 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 */
- #define PCRS_DYNAMIC 8 /* Job is dynamic (used to disable JIT compilation) */
- /*
- * 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;
- /*
- * 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 compiled pcrs substitute */
- struct PCRS_JOB *next; /* Pointer for chaining jobs to joblists */
- } pcrs_job;
- /*
- * 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 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_INCLUDED */
- /*
- Local Variables:
- tab-width: 3
- end:
- */
|