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