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