generate-cmds.sh: factor out synopsis extract code
[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 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         pcre_jit_stack *pcre1_jit_stack;
77         const unsigned char *pcre1_tables;
78         int pcre1_jit_on;
79         pcre2_code *pcre2_pattern;
80         pcre2_match_data *pcre2_match_data;
81         pcre2_compile_context *pcre2_compile_context;
82         pcre2_match_context *pcre2_match_context;
83         pcre2_jit_stack *pcre2_jit_stack;
84         uint32_t pcre2_jit_on;
85         kwset_t kws;
86         unsigned fixed:1;
87         unsigned ignore_case:1;
88         unsigned word_regexp:1;
89 };
90
91 enum grep_expr_node {
92         GREP_NODE_ATOM,
93         GREP_NODE_NOT,
94         GREP_NODE_AND,
95         GREP_NODE_TRUE,
96         GREP_NODE_OR
97 };
98
99 enum grep_pattern_type {
100         GREP_PATTERN_TYPE_UNSPECIFIED = 0,
101         GREP_PATTERN_TYPE_BRE,
102         GREP_PATTERN_TYPE_ERE,
103         GREP_PATTERN_TYPE_FIXED,
104         GREP_PATTERN_TYPE_PCRE
105 };
106
107 struct grep_expr {
108         enum grep_expr_node node;
109         unsigned hit;
110         union {
111                 struct grep_pat *atom;
112                 struct grep_expr *unary;
113                 struct {
114                         struct grep_expr *left;
115                         struct grep_expr *right;
116                 } binary;
117         } u;
118 };
119
120 struct grep_opt {
121         struct grep_pat *pattern_list;
122         struct grep_pat **pattern_tail;
123         struct grep_pat *header_list;
124         struct grep_pat **header_tail;
125         struct grep_expr *pattern_expression;
126         const char *prefix;
127         int prefix_length;
128         regex_t regexp;
129         int linenum;
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 color;
153         int max_depth;
154         int funcname;
155         int funcbody;
156         int extended_regexp_option;
157         int pattern_type_option;
158         char color_context[COLOR_MAXLEN];
159         char color_filename[COLOR_MAXLEN];
160         char color_function[COLOR_MAXLEN];
161         char color_lineno[COLOR_MAXLEN];
162         char color_match_context[COLOR_MAXLEN];
163         char color_match_selected[COLOR_MAXLEN];
164         char color_selected[COLOR_MAXLEN];
165         char color_sep[COLOR_MAXLEN];
166         unsigned pre_context;
167         unsigned post_context;
168         unsigned last_shown;
169         int show_hunk_mark;
170         int file_break;
171         int heading;
172         void *priv;
173
174         void (*output)(struct grep_opt *opt, const void *data, size_t size);
175         void *output_priv;
176 };
177
178 extern void init_grep_defaults(void);
179 extern int grep_config(const char *var, const char *value, void *);
180 extern void grep_init(struct grep_opt *, const char *prefix);
181 void grep_commit_pattern_type(enum grep_pattern_type, struct grep_opt *opt);
182
183 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);
184 extern void append_grep_pattern(struct grep_opt *opt, const char *pat, const char *origin, int no, enum grep_pat_token t);
185 extern void append_header_grep_pattern(struct grep_opt *, enum grep_header_field, const char *);
186 extern void compile_grep_patterns(struct grep_opt *opt);
187 extern void free_grep_patterns(struct grep_opt *opt);
188 extern int grep_buffer(struct grep_opt *opt, char *buf, unsigned long size);
189
190 struct grep_source {
191         char *name;
192
193         enum grep_source_type {
194                 GREP_SOURCE_OID,
195                 GREP_SOURCE_FILE,
196                 GREP_SOURCE_BUF,
197         } type;
198         void *identifier;
199
200         char *buf;
201         unsigned long size;
202
203         char *path; /* for attribute lookups */
204         struct userdiff_driver *driver;
205 };
206
207 void grep_source_init(struct grep_source *gs, enum grep_source_type type,
208                       const char *name, const char *path,
209                       const void *identifier);
210 void grep_source_clear_data(struct grep_source *gs);
211 void grep_source_clear(struct grep_source *gs);
212 void grep_source_load_driver(struct grep_source *gs);
213
214
215 int grep_source(struct grep_opt *opt, struct grep_source *gs);
216
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
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  */
225 extern int grep_use_locks;
226 extern pthread_mutex_t grep_attr_mutex;
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()
244 #endif
245
246 #endif