[thirdparty/git.git] / kwset.h

#ifndef KWSET_H
#define KWSET_H

/* 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.
 */

/* 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
   along with this program; if not, see <https://www.gnu.org/licenses/>. */

/* 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. */

extern const unsigned char tolower_trans_tbl[256];

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. */
};

struct kwset_t;
typedef struct kwset_t* kwset_t;

/* 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. */
kwset_t kwsalloc(unsigned char const *);

/* 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. */
const char *kwsincr(kwset_t, char const *, size_t);

/* When the keyword set has been completely built, prepare it for
   use.  Return NULL for success, or an error message. */
const char *kwsprep(kwset_t);

/* 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. */
size_t kwsexec(kwset_t, char const *, size_t, struct kwsmatch *);

/* Deallocate the given keyword set and all its associated storage. */
void kwsfree(kwset_t);

#endif /* KWSET_H */
Commit	Line	Data
46efd28b EP	1	#ifndef KWSET_H
	2	#define KWSET_H
	3
fca65d4b FK	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	*/
	8
05f3dbba FK	9	/* kwset.h - header declaring the keyword set library.
	10	Copyright (C) 1989, 1998, 2005 Free Software Foundation, Inc.
	11
	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.
	16
	17	This program is distributed in the hope that it will be useful,
	18	but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	GNU General Public License for more details.
	21
	22	You should have received a copy of the GNU General Public License
d05b08cd	23	along with this program; if not, see <https://www.gnu.org/licenses/>. */
05f3dbba FK	24
	25	/* Written August 1989 by Mike Haertel.
	26	The author may be reached (Email) at the address mike@ai.mit.edu,
	27	or (US mail) as Mike Haertel c/o Free Software Foundation. */
	28
28aed75a CW	29	extern const unsigned char tolower_trans_tbl[256];
28aed75a CW	30
05f3dbba FK	31	struct kwsmatch
	32	{
	33	int index; /* Index number of matching keyword. */
	34	size_t offset[1]; /* Offset of each submatch. */
	35	size_t size[1]; /* Length of each submatch. */
	36	};
	37
fca65d4b FK	38	struct kwset_t;
fca65d4b FK	39	typedef struct kwset_t* kwset_t;
05f3dbba FK	40
	41	/* Return an opaque pointer to a newly allocated keyword set, or NULL
	42	if enough memory cannot be obtained. The argument if non-NULL
	43	specifies a table of character translations to be applied to all
	44	pattern and search text. */
55454427	45	kwset_t kwsalloc(unsigned char const *);
05f3dbba FK	46
	47	/* Incrementally extend the keyword set to include the given string.
	48	Return NULL for success, or an error message. Remember an index
	49	number for each keyword included in the set. */
55454427	50	const char kwsincr(kwset_t, char const , size_t);
05f3dbba FK	51
	52	/* When the keyword set has been completely built, prepare it for
	53	use. Return NULL for success, or an error message. */
55454427	54	const char *kwsprep(kwset_t);
05f3dbba FK	55
	56	/* Search through the given buffer for a member of the keyword set.
	57	Return a pointer to the leftmost longest match found, or NULL if
	58	no match is found. If foundlen is non-NULL, store the length of
	59	the matching substring in the integer it points to. Similarly,
	60	if foundindex is non-NULL, store the index of the particular
	61	keyword found therein. */
55454427	62	size_t kwsexec(kwset_t, char const , size_t, struct kwsmatch );
05f3dbba FK	63
05f3dbba FK	64	/* Deallocate the given keyword set and all its associated storage. */
55454427	65	void kwsfree(kwset_t);
fca65d4b	66
46efd28b	67	#endif /* KWSET_H */