Fourth batch
[git.git] / kwset.h
1 #ifndef KWSET_H
2 #define KWSET_H
4 /* This file has been copied from commit e7ac713d^ in the GNU grep git
5 * repository. A few small changes have been made to adapt the code to
6 * Git.
7 */
9 /* kwset.h - header declaring the keyword set library.
10 Copyright (C) 1989, 1998, 2005 Free Software Foundation, Inc.
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2, or (at your option)
15 any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, see <>. */
25 /* Written August 1989 by Mike Haertel.
26 The author may be reached (Email) at the address,
27 or (US mail) as Mike Haertel c/o Free Software Foundation. */
29 struct kwsmatch
31 int index; /* Index number of matching keyword. */
32 size_t offset[1]; /* Offset of each submatch. */
33 size_t size[1]; /* Length of each submatch. */
36 struct kwset_t;
37 typedef struct kwset_t* kwset_t;
39 /* Return an opaque pointer to a newly allocated keyword set, or NULL
40 if enough memory cannot be obtained. The argument if non-NULL
41 specifies a table of character translations to be applied to all
42 pattern and search text. */
43 kwset_t kwsalloc(unsigned char const *);
45 /* Incrementally extend the keyword set to include the given string.
46 Return NULL for success, or an error message. Remember an index
47 number for each keyword included in the set. */
48 const char *kwsincr(kwset_t, char const *, size_t);
50 /* When the keyword set has been completely built, prepare it for
51 use. Return NULL for success, or an error message. */
52 const char *kwsprep(kwset_t);
54 /* Search through the given buffer for a member of the keyword set.
55 Return a pointer to the leftmost longest match found, or NULL if
56 no match is found. If foundlen is non-NULL, store the length of
57 the matching substring in the integer it points to. Similarly,
58 if foundindex is non-NULL, store the index of the particular
59 keyword found therein. */
60 size_t kwsexec(kwset_t, char const *, size_t, struct kwsmatch *);
62 /* Deallocate the given keyword set and all its associated storage. */
63 void kwsfree(kwset_t);
65 #endif /* KWSET_H */