Add string search routines from GNU grep
[git/git.git] / kwset.h
CommitLineData
05f3dbba
FK
1/* kwset.h - header declaring the keyword set library.
2 Copyright (C) 1989, 1998, 2005 Free Software Foundation, Inc.
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2, or (at your option)
7 any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
17 02110-1301, USA. */
18
19/* Written August 1989 by Mike Haertel.
20 The author may be reached (Email) at the address mike@ai.mit.edu,
21 or (US mail) as Mike Haertel c/o Free Software Foundation. */
22
23struct kwsmatch
24{
25 int index; /* Index number of matching keyword. */
26 size_t offset[1]; /* Offset of each submatch. */
27 size_t size[1]; /* Length of each submatch. */
28};
29
30typedef ptr_t kwset_t;
31
32/* Return an opaque pointer to a newly allocated keyword set, or NULL
33 if enough memory cannot be obtained. The argument if non-NULL
34 specifies a table of character translations to be applied to all
35 pattern and search text. */
36extern kwset_t kwsalloc PARAMS((char const *));
37
38/* Incrementally extend the keyword set to include the given string.
39 Return NULL for success, or an error message. Remember an index
40 number for each keyword included in the set. */
41extern const char *kwsincr PARAMS((kwset_t, char const *, size_t));
42
43/* When the keyword set has been completely built, prepare it for
44 use. Return NULL for success, or an error message. */
45extern const char *kwsprep PARAMS((kwset_t));
46
47/* Search through the given buffer for a member of the keyword set.
48 Return a pointer to the leftmost longest match found, or NULL if
49 no match is found. If foundlen is non-NULL, store the length of
50 the matching substring in the integer it points to. Similarly,
51 if foundindex is non-NULL, store the index of the particular
52 keyword found therein. */
53extern size_t kwsexec PARAMS((kwset_t, char const *, size_t, struct kwsmatch *));
54
55/* Deallocate the given keyword set and all its associated storage. */
56extern void kwsfree PARAMS((kwset_t));