[thirdparty/git.git] / grep.h

#ifndef GREP_H
#define GREP_H
#include "color.h"
#ifdef USE_LIBPCRE1
#include <pcre.h>
#ifndef PCRE_NO_UTF8_CHECK
#define PCRE_NO_UTF8_CHECK 0
#endif
#else
typedef int pcre;
typedef int pcre_extra;
#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;
#endif
#include "thread-utils.h"
#include "userdiff.h"

struct repository;

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
};

enum grep_color {
	GREP_COLOR_CONTEXT,
	GREP_COLOR_FILENAME,
	GREP_COLOR_FUNCTION,
	GREP_COLOR_LINENO,
	GREP_COLOR_COLUMNNO,
	GREP_COLOR_MATCH_CONTEXT,
	GREP_COLOR_MATCH_SELECTED,
	GREP_COLOR_SELECTED,
	GREP_COLOR_SEP,
	NR_GREP_COLORS
};

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;
	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;
	const uint8_t *pcre2_tables;
	uint32_t pcre2_jit_on;
	unsigned fixed:1;
	unsigned is_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;
	struct repository *repo;
	const char *prefix;
	int prefix_length;
	regex_t regexp;
	int linenum;
	int columnnum;
	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 only_matching;
	int color;
	int max_depth;
	int funcname;
	int funcbody;
	int extended_regexp_option;
	int pattern_type_option;
	int ignore_locale;
	char colors[NR_GREP_COLORS][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;
};

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

void append_grep_pat(struct grep_opt *opt, const char *pat, size_t patlen, const char *origin, int no, enum grep_pat_token t);
void append_grep_pattern(struct grep_opt *opt, const char *pat, const char *origin, int no, enum grep_pat_token t);
void append_header_grep_pattern(struct grep_opt *, enum grep_header_field, const char *);
void compile_grep_patterns(struct grep_opt *opt);
void free_grep_patterns(struct grep_opt *opt);
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,
	} 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,
			     struct index_state *istate);


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

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

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

#endif
Commit	Line	Data
	1	#ifndef GREP_H
	2	#define GREP_H
	3	#include "color.h"
	4	#ifdef USE_LIBPCRE1
	5	#include <pcre.h>
	6	#ifndef PCRE_NO_UTF8_CHECK
	7	#define PCRE_NO_UTF8_CHECK 0
	8	#endif
	9	#else
	10	typedef int pcre;
	11	typedef int pcre_extra;
	12	#endif
	13	#ifdef USE_LIBPCRE2
	14	#define PCRE2_CODE_UNIT_WIDTH 8
	15	#include <pcre2.h>
	16	#else
	17	typedef int pcre2_code;
	18	typedef int pcre2_match_data;
	19	typedef int pcre2_compile_context;
	20	#endif
	21	#include "thread-utils.h"
	22	#include "userdiff.h"
	23
	24	struct repository;
	25
	26	enum grep_pat_token {
	27	GREP_PATTERN,
	28	GREP_PATTERN_HEAD,
	29	GREP_PATTERN_BODY,
	30	GREP_AND,
	31	GREP_OPEN_PAREN,
	32	GREP_CLOSE_PAREN,
	33	GREP_NOT,
	34	GREP_OR
	35	};
	36
	37	enum grep_context {
	38	GREP_CONTEXT_HEAD,
	39	GREP_CONTEXT_BODY
	40	};
	41
	42	enum grep_header_field {
	43	GREP_HEADER_FIELD_MIN = 0,
	44	GREP_HEADER_AUTHOR = GREP_HEADER_FIELD_MIN,
	45	GREP_HEADER_COMMITTER,
	46	GREP_HEADER_REFLOG,
	47
	48	/* Must be at the end of the enum */
	49	GREP_HEADER_FIELD_MAX
	50	};
	51
	52	enum grep_color {
	53	GREP_COLOR_CONTEXT,
	54	GREP_COLOR_FILENAME,
	55	GREP_COLOR_FUNCTION,
	56	GREP_COLOR_LINENO,
	57	GREP_COLOR_COLUMNNO,
	58	GREP_COLOR_MATCH_CONTEXT,
	59	GREP_COLOR_MATCH_SELECTED,
	60	GREP_COLOR_SELECTED,
	61	GREP_COLOR_SEP,
	62	NR_GREP_COLORS
	63	};
	64
	65	struct grep_pat {
	66	struct grep_pat *next;
	67	const char *origin;
	68	int no;
	69	enum grep_pat_token token;
	70	char *pattern;
	71	size_t patternlen;
	72	enum grep_header_field field;
	73	regex_t regexp;
	74	pcre *pcre1_regexp;
	75	pcre_extra *pcre1_extra_info;
	76	const unsigned char *pcre1_tables;
	77	int pcre1_jit_on;
	78	pcre2_code *pcre2_pattern;
	79	pcre2_match_data *pcre2_match_data;
	80	pcre2_compile_context *pcre2_compile_context;
	81	const uint8_t *pcre2_tables;
	82	uint32_t pcre2_jit_on;
	83	unsigned fixed:1;
	84	unsigned is_fixed:1;
	85	unsigned ignore_case:1;
	86	unsigned word_regexp:1;
	87	};
	88
	89	enum grep_expr_node {
	90	GREP_NODE_ATOM,
	91	GREP_NODE_NOT,
	92	GREP_NODE_AND,
	93	GREP_NODE_TRUE,
	94	GREP_NODE_OR
	95	};
	96
	97	enum grep_pattern_type {
	98	GREP_PATTERN_TYPE_UNSPECIFIED = 0,
	99	GREP_PATTERN_TYPE_BRE,
	100	GREP_PATTERN_TYPE_ERE,
	101	GREP_PATTERN_TYPE_FIXED,
	102	GREP_PATTERN_TYPE_PCRE
	103	};
	104
	105	struct grep_expr {
	106	enum grep_expr_node node;
	107	unsigned hit;
	108	union {
	109	struct grep_pat *atom;
	110	struct grep_expr *unary;
	111	struct {
	112	struct grep_expr *left;
	113	struct grep_expr *right;
	114	} binary;
	115	} u;
	116	};
	117
	118	struct grep_opt {
	119	struct grep_pat *pattern_list;
	120	struct grep_pat **pattern_tail;
	121	struct grep_pat *header_list;
	122	struct grep_pat **header_tail;
	123	struct grep_expr *pattern_expression;
	124	struct repository *repo;
	125	const char *prefix;
	126	int prefix_length;
	127	regex_t regexp;
	128	int linenum;
	129	int columnnum;
	130	int invert;
	131	int ignore_case;
	132	int status_only;
	133	int name_only;
	134	int unmatch_name_only;
	135	int count;
	136	int word_regexp;
	137	int fixed;
	138	int all_match;
	139	int debug;
	140	#define GREP_BINARY_DEFAULT 0
	141	#define GREP_BINARY_NOMATCH 1
	142	#define GREP_BINARY_TEXT 2
	143	int binary;
	144	int allow_textconv;
	145	int extended;
	146	int use_reflog_filter;
	147	int pcre1;
	148	int pcre2;
	149	int relative;
	150	int pathname;
	151	int null_following_name;
	152	int only_matching;
	153	int color;
	154	int max_depth;
	155	int funcname;
	156	int funcbody;
	157	int extended_regexp_option;
	158	int pattern_type_option;
	159	int ignore_locale;
	160	char colors[NR_GREP_COLORS][COLOR_MAXLEN];
	161	unsigned pre_context;
	162	unsigned post_context;
	163	unsigned last_shown;
	164	int show_hunk_mark;
	165	int file_break;
	166	int heading;
	167	void *priv;
	168
	169	void (output)(struct grep_opt opt, const void *data, size_t size);
	170	void *output_priv;
	171	};
	172
	173	void init_grep_defaults(struct repository *);
	174	int grep_config(const char var, const char value, void *);
	175	void grep_init(struct grep_opt , struct repository repo, const char *prefix);
	176	void grep_destroy(void);
	177	void grep_commit_pattern_type(enum grep_pattern_type, struct grep_opt *opt);
	178
	179	void append_grep_pat(struct grep_opt opt, const char pat, size_t patlen, const char *origin, int no, enum grep_pat_token t);
	180	void append_grep_pattern(struct grep_opt opt, const char pat, const char *origin, int no, enum grep_pat_token t);
	181	void append_header_grep_pattern(struct grep_opt , enum grep_header_field, const char );
	182	void compile_grep_patterns(struct grep_opt *opt);
	183	void free_grep_patterns(struct grep_opt *opt);
	184	int grep_buffer(struct grep_opt opt, char buf, unsigned long size);
	185
	186	struct grep_source {
	187	char *name;
	188
	189	enum grep_source_type {
	190	GREP_SOURCE_OID,
	191	GREP_SOURCE_FILE,
	192	GREP_SOURCE_BUF,
	193	} type;
	194	void *identifier;
	195
	196	char *buf;
	197	unsigned long size;
	198
	199	char path; / for attribute lookups */
	200	struct userdiff_driver *driver;
	201	};
	202
	203	void grep_source_init(struct grep_source *gs, enum grep_source_type type,
	204	const char name, const char path,
	205	const void *identifier);
	206	void grep_source_clear_data(struct grep_source *gs);
	207	void grep_source_clear(struct grep_source *gs);
	208	void grep_source_load_driver(struct grep_source *gs,
	209	struct index_state *istate);
	210
	211
	212	int grep_source(struct grep_opt opt, struct grep_source gs);
	213
	214	struct grep_opt grep_opt_dup(const struct grep_opt opt);
	215	int grep_threads_ok(const struct grep_opt *opt);
	216
	217	/*
	218	* Mutex used around access to the attributes machinery if
	219	* opt->use_threads. Must be initialized/destroyed by callers!
	220	*/
	221	extern int grep_use_locks;
	222	extern pthread_mutex_t grep_attr_mutex;
	223	extern pthread_mutex_t grep_read_mutex;
	224
	225	static inline void grep_read_lock(void)
	226	{
	227	if (grep_use_locks)
	228	pthread_mutex_lock(&grep_read_mutex);
	229	}
	230
	231	static inline void grep_read_unlock(void)
	232	{
	233	if (grep_use_locks)
	234	pthread_mutex_unlock(&grep_read_mutex);
	235	}
	236
	237	#endif