[thirdparty/git.git] / grep.h

#ifndef GREP_H
#define GREP_H
#include "color.h"
#ifdef USE_LIBPCRE1
#include <pcre.h>
#ifdef PCRE_CONFIG_JIT
#if PCRE_MAJOR >= 8 && PCRE_MINOR >= 32
#ifndef NO_LIBPCRE1_JIT
#define GIT_PCRE1_USE_JIT
#endif
#endif
#endif
#ifndef PCRE_STUDY_JIT_COMPILE
#define PCRE_STUDY_JIT_COMPILE 0
#endif
#if PCRE_MAJOR <= 8 && PCRE_MINOR < 20
typedef int pcre_jit_stack;
#endif
#else
typedef int pcre;
typedef int pcre_extra;
typedef int pcre_jit_stack;
#endif
#ifdef USE_LIBPCRE2
#define PCRE2_CODE_UNIT_WIDTH 8
#include <pcre2.h>
#else
typedef int pcre2_code;
typedef int pcre2_match_data;
typedef int pcre2_compile_context;
typedef int pcre2_match_context;
typedef int pcre2_jit_stack;
#endif
#include "kwset.h"
#include "thread-utils.h"
#include "userdiff.h"

enum grep_pat_token {
	GREP_PATTERN,
	GREP_PATTERN_HEAD,
	GREP_PATTERN_BODY,
	GREP_AND,
	GREP_OPEN_PAREN,
	GREP_CLOSE_PAREN,
	GREP_NOT,
	GREP_OR
};

enum grep_context {
	GREP_CONTEXT_HEAD,
	GREP_CONTEXT_BODY
};

enum grep_header_field {
	GREP_HEADER_FIELD_MIN = 0,
	GREP_HEADER_AUTHOR = GREP_HEADER_FIELD_MIN,
	GREP_HEADER_COMMITTER,
	GREP_HEADER_REFLOG,

	/* Must be at the end of the enum */
	GREP_HEADER_FIELD_MAX
};

struct grep_pat {
	struct grep_pat *next;
	const char *origin;
	int no;
	enum grep_pat_token token;
	char *pattern;
	size_t patternlen;
	enum grep_header_field field;
	regex_t regexp;
	pcre *pcre1_regexp;
	pcre_extra *pcre1_extra_info;
	pcre_jit_stack *pcre1_jit_stack;
	const unsigned char *pcre1_tables;
	int pcre1_jit_on;
	pcre2_code *pcre2_pattern;
	pcre2_match_data *pcre2_match_data;
	pcre2_compile_context *pcre2_compile_context;
	pcre2_match_context *pcre2_match_context;
	pcre2_jit_stack *pcre2_jit_stack;
	uint32_t pcre2_jit_on;
	kwset_t kws;
	unsigned fixed:1;
	unsigned ignore_case:1;
	unsigned word_regexp:1;
};

enum grep_expr_node {
	GREP_NODE_ATOM,
	GREP_NODE_NOT,
	GREP_NODE_AND,
	GREP_NODE_TRUE,
	GREP_NODE_OR
};

enum grep_pattern_type {
	GREP_PATTERN_TYPE_UNSPECIFIED = 0,
	GREP_PATTERN_TYPE_BRE,
	GREP_PATTERN_TYPE_ERE,
	GREP_PATTERN_TYPE_FIXED,
	GREP_PATTERN_TYPE_PCRE
};

struct grep_expr {
	enum grep_expr_node node;
	unsigned hit;
	union {
		struct grep_pat *atom;
		struct grep_expr *unary;
		struct {
			struct grep_expr *left;
			struct grep_expr *right;
		} binary;
	} u;
};

struct grep_opt {
	struct grep_pat *pattern_list;
	struct grep_pat **pattern_tail;
	struct grep_pat *header_list;
	struct grep_pat **header_tail;
	struct grep_expr *pattern_expression;
	const char *prefix;
	int prefix_length;
	regex_t regexp;
	int linenum;
	int invert;
	int ignore_case;
	int status_only;
	int name_only;
	int unmatch_name_only;
	int count;
	int word_regexp;
	int fixed;
	int all_match;
	int debug;
#define GREP_BINARY_DEFAULT	0
#define GREP_BINARY_NOMATCH	1
#define GREP_BINARY_TEXT	2
	int binary;
	int allow_textconv;
	int extended;
	int use_reflog_filter;
	int pcre1;
	int pcre2;
	int relative;
	int pathname;
	int null_following_name;
	int color;
	int max_depth;
	int funcname;
	int funcbody;
	int extended_regexp_option;
	int pattern_type_option;
	char color_context[COLOR_MAXLEN];
	char color_filename[COLOR_MAXLEN];
	char color_function[COLOR_MAXLEN];
	char color_lineno[COLOR_MAXLEN];
	char color_match_context[COLOR_MAXLEN];
	char color_match_selected[COLOR_MAXLEN];
	char color_selected[COLOR_MAXLEN];
	char color_sep[COLOR_MAXLEN];
	unsigned pre_context;
	unsigned post_context;
	unsigned last_shown;
	int show_hunk_mark;
	int file_break;
	int heading;
	void *priv;

	void (*output)(struct grep_opt *opt, const void *data, size_t size);
	void *output_priv;
};

extern void init_grep_defaults(void);
extern int grep_config(const char *var, const char *value, void *);
extern void grep_init(struct grep_opt *, const char *prefix);
void grep_commit_pattern_type(enum grep_pattern_type, struct grep_opt *opt);

extern void append_grep_pat(struct grep_opt *opt, const char *pat, size_t patlen, const char *origin, int no, enum grep_pat_token t);
extern void append_grep_pattern(struct grep_opt *opt, const char *pat, const char *origin, int no, enum grep_pat_token t);
extern void append_header_grep_pattern(struct grep_opt *, enum grep_header_field, const char *);
extern void compile_grep_patterns(struct grep_opt *opt);
extern void free_grep_patterns(struct grep_opt *opt);
extern int grep_buffer(struct grep_opt *opt, char *buf, unsigned long size);

struct grep_source {
	char *name;

	enum grep_source_type {
		GREP_SOURCE_OID,
		GREP_SOURCE_FILE,
		GREP_SOURCE_BUF,
		GREP_SOURCE_SUBMODULE,
	} type;
	void *identifier;

	char *buf;
	unsigned long size;

	char *path; /* for attribute lookups */
	struct userdiff_driver *driver;
};

void grep_source_init(struct grep_source *gs, enum grep_source_type type,
		      const char *name, const char *path,
		      const void *identifier);
void grep_source_clear_data(struct grep_source *gs);
void grep_source_clear(struct grep_source *gs);
void grep_source_load_driver(struct grep_source *gs);


int grep_source(struct grep_opt *opt, struct grep_source *gs);

extern struct grep_opt *grep_opt_dup(const struct grep_opt *opt);
extern int grep_threads_ok(const struct grep_opt *opt);

#ifndef NO_PTHREADS
/*
 * Mutex used around access to the attributes machinery if
 * opt->use_threads.  Must be initialized/destroyed by callers!
 */
extern int grep_use_locks;
extern pthread_mutex_t grep_attr_mutex;
extern pthread_mutex_t grep_read_mutex;

static inline void grep_read_lock(void)
{
	if (grep_use_locks)
		pthread_mutex_lock(&grep_read_mutex);
}

static inline void grep_read_unlock(void)
{
	if (grep_use_locks)
		pthread_mutex_unlock(&grep_read_mutex);
}

#else
#define grep_read_lock()
#define grep_read_unlock()
#endif

#endif
Commit	Line	Data
83b5d2f5 JH	1	#ifndef GREP_H
83b5d2f5 JH	2	#define GREP_H
7e8f59d5	3	#include "color.h"
3485bea1	4	#ifdef USE_LIBPCRE1
63e7e9d8	5	#include <pcre.h>
e87de7ca ÆAB	6	#ifdef PCRE_CONFIG_JIT
e87de7ca ÆAB	7	#if PCRE_MAJOR >= 8 && PCRE_MINOR >= 32
fb95e2e3	8	#ifndef NO_LIBPCRE1_JIT
e87de7ca ÆAB	9	#define GIT_PCRE1_USE_JIT
	10	#endif
	11	#endif
fb95e2e3	12	#endif
fbaceaac ÆAB	13	#ifndef PCRE_STUDY_JIT_COMPILE
	14	#define PCRE_STUDY_JIT_COMPILE 0
	15	#endif
c30cf827 ÆAB	16	#if PCRE_MAJOR <= 8 && PCRE_MINOR < 20
	17	typedef int pcre_jit_stack;
	18	#endif
63e7e9d8 MK	19	#else
	20	typedef int pcre;
	21	typedef int pcre_extra;
fbaceaac	22	typedef int pcre_jit_stack;
63e7e9d8	23	#endif
94da9193 ÆAB	24	#ifdef USE_LIBPCRE2
	25	#define PCRE2_CODE_UNIT_WIDTH 8
	26	#include <pcre2.h>
	27	#else
	28	typedef int pcre2_code;
	29	typedef int pcre2_match_data;
	30	typedef int pcre2_compile_context;
	31	typedef int pcre2_match_context;
	32	typedef int pcre2_jit_stack;
	33	#endif
9eceddee	34	#include "kwset.h"
0579f91d	35	#include "thread-utils.h"
94ad9d9e	36	#include "userdiff.h"
83b5d2f5 JH	37
	38	enum grep_pat_token {
	39	GREP_PATTERN,
480c1ca6 JH	40	GREP_PATTERN_HEAD,
480c1ca6 JH	41	GREP_PATTERN_BODY,
83b5d2f5 JH	42	GREP_AND,
	43	GREP_OPEN_PAREN,
	44	GREP_CLOSE_PAREN,
	45	GREP_NOT,
4b05548f	46	GREP_OR
83b5d2f5 JH	47	};
83b5d2f5 JH	48
480c1ca6 JH	49	enum grep_context {
480c1ca6 JH	50	GREP_CONTEXT_HEAD,
4b05548f	51	GREP_CONTEXT_BODY
480c1ca6 JH	52	};
480c1ca6 JH	53
a4d7d2c6	54	enum grep_header_field {
3ce3ffb8 AP	55	GREP_HEADER_FIELD_MIN = 0,
3ce3ffb8 AP	56	GREP_HEADER_AUTHOR = GREP_HEADER_FIELD_MIN,
ad4813b3	57	GREP_HEADER_COMMITTER,
72fd13f7	58	GREP_HEADER_REFLOG,
ad4813b3 NTND	59
	60	/* Must be at the end of the enum */
	61	GREP_HEADER_FIELD_MAX
a4d7d2c6 JH	62	};
a4d7d2c6 JH	63
83b5d2f5 JH	64	struct grep_pat {
	65	struct grep_pat *next;
	66	const char *origin;
	67	int no;
	68	enum grep_pat_token token;
526a858a	69	char *pattern;
ed40a095	70	size_t patternlen;
a4d7d2c6	71	enum grep_header_field field;
83b5d2f5	72	regex_t regexp;
6d4b5747 ÆAB	73	pcre *pcre1_regexp;
6d4b5747 ÆAB	74	pcre_extra *pcre1_extra_info;
fbaceaac	75	pcre_jit_stack *pcre1_jit_stack;
6d4b5747	76	const unsigned char *pcre1_tables;
fbaceaac	77	int pcre1_jit_on;
94da9193 ÆAB	78	pcre2_code *pcre2_pattern;
	79	pcre2_match_data *pcre2_match_data;
	80	pcre2_compile_context *pcre2_compile_context;
	81	pcre2_match_context *pcre2_match_context;
	82	pcre2_jit_stack *pcre2_jit_stack;
	83	uint32_t pcre2_jit_on;
9eceddee	84	kwset_t kws;
c822255c	85	unsigned fixed:1;
5183bf67	86	unsigned ignore_case:1;
d7eb527d	87	unsigned word_regexp:1;
83b5d2f5 JH	88	};
	89
	90	enum grep_expr_node {
	91	GREP_NODE_ATOM,
	92	GREP_NODE_NOT,
	93	GREP_NODE_AND,
5aaeb733	94	GREP_NODE_TRUE,
4b05548f	95	GREP_NODE_OR
83b5d2f5 JH	96	};
83b5d2f5 JH	97
84befcd0 S	98	enum grep_pattern_type {
	99	GREP_PATTERN_TYPE_UNSPECIFIED = 0,
	100	GREP_PATTERN_TYPE_BRE,
	101	GREP_PATTERN_TYPE_ERE,
	102	GREP_PATTERN_TYPE_FIXED,
	103	GREP_PATTERN_TYPE_PCRE
	104	};
	105
83b5d2f5 JH	106	struct grep_expr {
83b5d2f5 JH	107	enum grep_expr_node node;
0ab7befa	108	unsigned hit;
83b5d2f5 JH	109	union {
	110	struct grep_pat *atom;
	111	struct grep_expr *unary;
	112	struct {
	113	struct grep_expr *left;
	114	struct grep_expr *right;
	115	} binary;
	116	} u;
	117	};
	118
	119	struct grep_opt {
	120	struct grep_pat *pattern_list;
	121	struct grep_pat **pattern_tail;
80235ba7 JH	122	struct grep_pat *header_list;
80235ba7 JH	123	struct grep_pat **header_tail;
83b5d2f5	124	struct grep_expr *pattern_expression;
493b7a08	125	const char *prefix;
83b5d2f5 JH	126	int prefix_length;
83b5d2f5 JH	127	regex_t regexp;
3e230fa1 RS	128	int linenum;
3e230fa1 RS	129	int invert;
5183bf67	130	int ignore_case;
3e230fa1 RS	131	int status_only;
	132	int name_only;
	133	int unmatch_name_only;
	134	int count;
	135	int word_regexp;
	136	int fixed;
	137	int all_match;
17bf35a3	138	int debug;
83b5d2f5 JH	139	#define GREP_BINARY_DEFAULT 0
	140	#define GREP_BINARY_NOMATCH 1
	141	#define GREP_BINARY_TEXT 2
3e230fa1	142	int binary;
335ec3bf	143	int allow_textconv;
3e230fa1	144	int extended;
baa6378f	145	int use_reflog_filter;
6d4b5747	146	int pcre1;
94da9193	147	int pcre2;
3e230fa1 RS	148	int relative;
	149	int pathname;
	150	int null_following_name;
7e8f59d5	151	int color;
a91f453f	152	int max_depth;
2944e4e6	153	int funcname;
ba8ea749	154	int funcbody;
84befcd0 S	155	int extended_regexp_option;
84befcd0 S	156	int pattern_type_option;
00588bb5	157	char color_context[COLOR_MAXLEN];
55f638bd	158	char color_filename[COLOR_MAXLEN];
00588bb5	159	char color_function[COLOR_MAXLEN];
55f638bd	160	char color_lineno[COLOR_MAXLEN];
79a77109 RS	161	char color_match_context[COLOR_MAXLEN];
79a77109 RS	162	char color_match_selected[COLOR_MAXLEN];
00588bb5	163	char color_selected[COLOR_MAXLEN];
55f638bd	164	char color_sep[COLOR_MAXLEN];
83b5d2f5 JH	165	unsigned pre_context;
83b5d2f5 JH	166	unsigned post_context;
5dd06d38	167	unsigned last_shown;
046802d0	168	int show_hunk_mark;
a8f0e764	169	int file_break;
1d84f72e	170	int heading;
60ecac98	171	void *priv;
5b594f45 FK	172
	173	void (output)(struct grep_opt opt, const void *data, size_t size);
	174	void *output_priv;
83b5d2f5 JH	175	};
83b5d2f5 JH	176
7687a054 JH	177	extern void init_grep_defaults(void);
	178	extern int grep_config(const char var, const char value, void *);
	179	extern void grep_init(struct grep_opt , const char prefix);
c5c31d33	180	void grep_commit_pattern_type(enum grep_pattern_type, struct grep_opt *opt);
7687a054	181
ed40a095	182	extern void append_grep_pat(struct grep_opt opt, const char pat, size_t patlen, const char *origin, int no, enum grep_pat_token t);
83b5d2f5	183	extern void append_grep_pattern(struct grep_opt opt, const char pat, const char *origin, int no, enum grep_pat_token t);
a4d7d2c6	184	extern void append_header_grep_pattern(struct grep_opt , enum grep_header_field, const char );
83b5d2f5	185	extern void compile_grep_patterns(struct grep_opt *opt);
b48fb5b6	186	extern void free_grep_patterns(struct grep_opt *opt);
c876d6da	187	extern int grep_buffer(struct grep_opt opt, char buf, unsigned long size);
83b5d2f5	188
e1327023 JK	189	struct grep_source {
	190	char *name;
	191
	192	enum grep_source_type {
1c41c82b	193	GREP_SOURCE_OID,
e1327023 JK	194	GREP_SOURCE_FILE,
e1327023 JK	195	GREP_SOURCE_BUF,
4538eef5	196	GREP_SOURCE_SUBMODULE,
e1327023 JK	197	} type;
	198	void *identifier;
	199
	200	char *buf;
	201	unsigned long size;
94ad9d9e	202
55c61688	203	char path; / for attribute lookups */
94ad9d9e	204	struct userdiff_driver *driver;
e1327023 JK	205	};
	206
	207	void grep_source_init(struct grep_source *gs, enum grep_source_type type,
55c61688 NTND	208	const char name, const char path,
55c61688 NTND	209	const void *identifier);
e1327023 JK	210	void grep_source_clear_data(struct grep_source *gs);
e1327023 JK	211	void grep_source_clear(struct grep_source *gs);
94ad9d9e	212	void grep_source_load_driver(struct grep_source *gs);
07a7d656	213
e1327023 JK	214
	215	int grep_source(struct grep_opt opt, struct grep_source gs);
	216
5b594f45 FK	217	extern struct grep_opt grep_opt_dup(const struct grep_opt opt);
	218	extern int grep_threads_ok(const struct grep_opt *opt);
	219
0579f91d TR	220	#ifndef NO_PTHREADS
	221	/*
	222	* Mutex used around access to the attributes machinery if
	223	* opt->use_threads. Must be initialized/destroyed by callers!
	224	*/
78db6ea9	225	extern int grep_use_locks;
0579f91d	226	extern pthread_mutex_t grep_attr_mutex;
b3aeb285 JK	227	extern pthread_mutex_t grep_read_mutex;
	228
	229	static inline void grep_read_lock(void)
	230	{
	231	if (grep_use_locks)
	232	pthread_mutex_lock(&grep_read_mutex);
	233	}
	234
	235	static inline void grep_read_unlock(void)
	236	{
	237	if (grep_use_locks)
	238	pthread_mutex_unlock(&grep_read_mutex);
	239	}
	240
	241	#else
	242	#define grep_read_lock()
	243	#define grep_read_unlock()
0579f91d TR	244	#endif
0579f91d TR	245
83b5d2f5	246	#endif