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