Merge branch 'ab/fsck-doc-fix' into maint
[git] / grep.h
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 int grep_config(const char *var, const char *value, void *);
174 void grep_init(struct grep_opt *, struct repository *repo, const char *prefix);
175 void grep_destroy(void);
176 void grep_commit_pattern_type(enum grep_pattern_type, struct grep_opt *opt);
177
178 void append_grep_pat(struct grep_opt *opt, const char *pat, size_t patlen, const char *origin, int no, enum grep_pat_token t);
179 void append_grep_pattern(struct grep_opt *opt, const char *pat, const char *origin, int no, enum grep_pat_token t);
180 void append_header_grep_pattern(struct grep_opt *, enum grep_header_field, const char *);
181 void compile_grep_patterns(struct grep_opt *opt);
182 void free_grep_patterns(struct grep_opt *opt);
183 int grep_buffer(struct grep_opt *opt, char *buf, unsigned long size);
184
185 struct grep_source {
186         char *name;
187
188         enum grep_source_type {
189                 GREP_SOURCE_OID,
190                 GREP_SOURCE_FILE,
191                 GREP_SOURCE_BUF,
192         } type;
193         void *identifier;
194
195         char *buf;
196         unsigned long size;
197
198         char *path; /* for attribute lookups */
199         struct userdiff_driver *driver;
200 };
201
202 void grep_source_init(struct grep_source *gs, enum grep_source_type type,
203                       const char *name, const char *path,
204                       const void *identifier);
205 void grep_source_clear_data(struct grep_source *gs);
206 void grep_source_clear(struct grep_source *gs);
207 void grep_source_load_driver(struct grep_source *gs,
208                              struct index_state *istate);
209
210
211 int grep_source(struct grep_opt *opt, struct grep_source *gs);
212
213 struct grep_opt *grep_opt_dup(const struct grep_opt *opt);
214 int grep_threads_ok(const struct grep_opt *opt);
215
216 /*
217  * Mutex used around access to the attributes machinery if
218  * opt->use_threads.  Must be initialized/destroyed by callers!
219  */
220 extern int grep_use_locks;
221 extern pthread_mutex_t grep_attr_mutex;
222
223 #endif