kwset.h 2.48 KB
Newer Older
Fredrik K's avatar
Fredrik K committed
1 2 3 4 5
/* This file has been copied from commit e7ac713d^ in the GNU grep git
 * repository. A few small changes have been made to adapt the code to
 * Git.
 */

6 7 8 9 10 11 12 13 14 15 16 17 18 19
/* kwset.h - header declaring the keyword set library.
   Copyright (C) 1989, 1998, 2005 Free Software Foundation, Inc.

   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, 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.

   You should have received a copy of the GNU General Public License
20
   along with this program; if not, see <http://www.gnu.org/licenses/>. */
21 22 23 24 25 26 27 28 29 30 31 32

/* Written August 1989 by Mike Haertel.
   The author may be reached (Email) at the address mike@ai.mit.edu,
   or (US mail) as Mike Haertel c/o Free Software Foundation. */

struct kwsmatch
{
  int index;			/* Index number of matching keyword. */
  size_t offset[1];		/* Offset of each submatch. */
  size_t size[1];		/* Length of each submatch. */
};

Fredrik K's avatar
Fredrik K committed
33 34
struct kwset_t;
typedef struct kwset_t* kwset_t;
35 36 37 38 39

/* Return an opaque pointer to a newly allocated keyword set, or NULL
   if enough memory cannot be obtained.  The argument if non-NULL
   specifies a table of character translations to be applied to all
   pattern and search text. */
40
extern kwset_t kwsalloc(unsigned char const *);
41 42 43 44

/* Incrementally extend the keyword set to include the given string.
   Return NULL for success, or an error message.  Remember an index
   number for each keyword included in the set. */
Fredrik K's avatar
Fredrik K committed
45
extern const char *kwsincr(kwset_t, char const *, size_t);
46 47 48

/* When the keyword set has been completely built, prepare it for
   use.  Return NULL for success, or an error message. */
Fredrik K's avatar
Fredrik K committed
49
extern const char *kwsprep(kwset_t);
50 51 52 53 54 55 56

/* Search through the given buffer for a member of the keyword set.
   Return a pointer to the leftmost longest match found, or NULL if
   no match is found.  If foundlen is non-NULL, store the length of
   the matching substring in the integer it points to.  Similarly,
   if foundindex is non-NULL, store the index of the particular
   keyword found therein. */
Fredrik K's avatar
Fredrik K committed
57
extern size_t kwsexec(kwset_t, char const *, size_t, struct kwsmatch *);
58 59

/* Deallocate the given keyword set and all its associated storage. */
Fredrik K's avatar
Fredrik K committed
60 61
extern void kwsfree(kwset_t);