mirror of
https://github.com/git/git
synced 2024-08-27 11:39:22 +00:00
![Glen Choo](/assets/img/avatar_default.png)
Add a new "const struct config_context *ctx" arg to config_fn_t to hold additional information about the config iteration operation. config_context has a "struct key_value_info kvi" member that holds metadata about the config source being read (e.g. what kind of config source it is, the filename, etc). In this series, we're only interested in .kvi, so we could have just used "struct key_value_info" as an arg, but config_context makes it possible to add/adjust members in the future without changing the config_fn_t signature. We could also consider other ways of organizing the args (e.g. moving the config name and value into config_context or key_value_info), but in my experiments, the incremental benefit doesn't justify the added complexity (e.g. a config_fn_t will sometimes invoke another config_fn_t but with a different config value). In subsequent commits, the .kvi member will replace the global "struct config_reader" in config.c, making config iteration a global-free operation. It requires much more work for the machinery to provide meaningful values of .kvi, so for now, merely change the signature and call sites, pass NULL as a placeholder value, and don't rely on the arg in any meaningful way. Most of the changes are performed by contrib/coccinelle/config_fn_ctx.pending.cocci, which, for every config_fn_t: - Modifies the signature to accept "const struct config_context *ctx" - Passes "ctx" to any inner config_fn_t, if needed - Adds UNUSED attributes to "ctx", if needed Most config_fn_t instances are easily identified by seeing if they are called by the various config functions. Most of the remaining ones are manually named in the .cocci patch. Manual cleanups are still needed, but the majority of it is trivial; it's either adjusting config_fn_t that the .cocci patch didn't catch, or adding forward declarations of "struct config_context ctx" to make the signatures make sense. The non-trivial changes are in cases where we are invoking a config_fn_t outside of config machinery, and we now need to decide what value of "ctx" to pass. These cases are: - trace2/tr2_cfg.c:tr2_cfg_set_fl() This is indirectly called by git_config_set() so that the trace2 machinery can notice the new config values and update its settings using the tr2 config parsing function, i.e. tr2_cfg_cb(). - builtin/checkout.c:checkout_main() This calls git_xmerge_config() as a shorthand for parsing a CLI arg. This might be worth refactoring away in the future, since git_xmerge_config() can call git_default_config(), which can do much more than just parsing. Handle them by creating a KVI_INIT macro that initializes "struct key_value_info" to a reasonable default, and use that to construct the "ctx" arg. Signed-off-by: Glen Choo <chooglen@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
267 lines
6.6 KiB
C
267 lines
6.6 KiB
C
#ifndef GREP_H
|
|
#define GREP_H
|
|
#include "color.h"
|
|
#ifdef USE_LIBPCRE2
|
|
#define PCRE2_CODE_UNIT_WIDTH 8
|
|
#include <pcre2.h>
|
|
#if (PCRE2_MAJOR >= 10 && PCRE2_MINOR >= 36) || PCRE2_MAJOR >= 11
|
|
#define GIT_PCRE2_VERSION_10_36_OR_HIGHER
|
|
#endif
|
|
#if (PCRE2_MAJOR >= 10 && PCRE2_MINOR >= 35) || PCRE2_MAJOR >= 11
|
|
#define GIT_PCRE2_VERSION_10_35_OR_HIGHER
|
|
#endif
|
|
#if (PCRE2_MAJOR >= 10 && PCRE2_MINOR >= 34) || PCRE2_MAJOR >= 11
|
|
#define GIT_PCRE2_VERSION_10_34_OR_HIGHER
|
|
#endif
|
|
#else
|
|
typedef int pcre2_code;
|
|
typedef int pcre2_match_data;
|
|
typedef int pcre2_compile_context;
|
|
typedef int pcre2_general_context;
|
|
#endif
|
|
#ifndef PCRE2_MATCH_INVALID_UTF
|
|
/* PCRE2_MATCH_* dummy also with !USE_LIBPCRE2, for test-pcre2-config.c */
|
|
#define PCRE2_MATCH_INVALID_UTF 0
|
|
#endif
|
|
#include "thread-utils.h"
|
|
#include "userdiff.h"
|
|
|
|
struct repository;
|
|
|
|
enum grep_pat_token {
|
|
GREP_PATTERN,
|
|
GREP_PATTERN_HEAD,
|
|
GREP_PATTERN_BODY,
|
|
GREP_AND,
|
|
GREP_OPEN_PAREN,
|
|
GREP_CLOSE_PAREN,
|
|
GREP_NOT,
|
|
GREP_OR
|
|
};
|
|
|
|
enum grep_context {
|
|
GREP_CONTEXT_HEAD,
|
|
GREP_CONTEXT_BODY
|
|
};
|
|
|
|
enum grep_header_field {
|
|
GREP_HEADER_FIELD_MIN = 0,
|
|
GREP_HEADER_AUTHOR = GREP_HEADER_FIELD_MIN,
|
|
GREP_HEADER_COMMITTER,
|
|
GREP_HEADER_REFLOG,
|
|
|
|
/* Must be at the end of the enum */
|
|
GREP_HEADER_FIELD_MAX
|
|
};
|
|
|
|
enum grep_color {
|
|
GREP_COLOR_CONTEXT,
|
|
GREP_COLOR_FILENAME,
|
|
GREP_COLOR_FUNCTION,
|
|
GREP_COLOR_LINENO,
|
|
GREP_COLOR_COLUMNNO,
|
|
GREP_COLOR_MATCH_CONTEXT,
|
|
GREP_COLOR_MATCH_SELECTED,
|
|
GREP_COLOR_SELECTED,
|
|
GREP_COLOR_SEP,
|
|
NR_GREP_COLORS
|
|
};
|
|
|
|
struct grep_pat {
|
|
struct grep_pat *next;
|
|
const char *origin;
|
|
int no;
|
|
enum grep_pat_token token;
|
|
char *pattern;
|
|
size_t patternlen;
|
|
enum grep_header_field field;
|
|
regex_t regexp;
|
|
pcre2_code *pcre2_pattern;
|
|
pcre2_match_data *pcre2_match_data;
|
|
pcre2_compile_context *pcre2_compile_context;
|
|
pcre2_general_context *pcre2_general_context;
|
|
const uint8_t *pcre2_tables;
|
|
uint32_t pcre2_jit_on;
|
|
unsigned fixed:1;
|
|
unsigned is_fixed:1;
|
|
unsigned ignore_case:1;
|
|
unsigned word_regexp:1;
|
|
};
|
|
|
|
enum grep_expr_node {
|
|
GREP_NODE_ATOM,
|
|
GREP_NODE_NOT,
|
|
GREP_NODE_AND,
|
|
GREP_NODE_TRUE,
|
|
GREP_NODE_OR
|
|
};
|
|
|
|
enum grep_pattern_type {
|
|
GREP_PATTERN_TYPE_UNSPECIFIED = 0,
|
|
GREP_PATTERN_TYPE_BRE,
|
|
GREP_PATTERN_TYPE_ERE,
|
|
GREP_PATTERN_TYPE_FIXED,
|
|
GREP_PATTERN_TYPE_PCRE
|
|
};
|
|
|
|
struct grep_expr {
|
|
enum grep_expr_node node;
|
|
unsigned hit;
|
|
union {
|
|
struct grep_pat *atom;
|
|
struct grep_expr *unary;
|
|
struct {
|
|
struct grep_expr *left;
|
|
struct grep_expr *right;
|
|
} binary;
|
|
} u;
|
|
};
|
|
|
|
struct grep_opt {
|
|
struct grep_pat *pattern_list;
|
|
struct grep_pat **pattern_tail;
|
|
struct grep_pat *header_list;
|
|
struct grep_pat **header_tail;
|
|
struct grep_expr *pattern_expression;
|
|
|
|
/*
|
|
* NEEDSWORK: See if we can remove this field, because the repository
|
|
* should probably be per-source. That is, grep.c functions using this
|
|
* field should probably start using "repo" in "struct grep_source"
|
|
* instead.
|
|
*
|
|
* This is potentially the cause of at least one bug - "git grep"
|
|
* using the textconv attributes from the superproject on the
|
|
* submodules. See the failing "git grep --textconv" tests in
|
|
* t7814-grep-recurse-submodules.sh for more information.
|
|
*/
|
|
struct repository *repo;
|
|
|
|
int linenum;
|
|
int columnnum;
|
|
int invert;
|
|
int ignore_case;
|
|
int status_only;
|
|
int name_only;
|
|
int unmatch_name_only;
|
|
int count;
|
|
int word_regexp;
|
|
int all_match;
|
|
int no_body_match;
|
|
int body_hit;
|
|
#define GREP_BINARY_DEFAULT 0
|
|
#define GREP_BINARY_NOMATCH 1
|
|
#define GREP_BINARY_TEXT 2
|
|
int binary;
|
|
int allow_textconv;
|
|
int use_reflog_filter;
|
|
int relative;
|
|
int pathname;
|
|
int null_following_name;
|
|
int only_matching;
|
|
int color;
|
|
int max_depth;
|
|
int funcname;
|
|
int funcbody;
|
|
int extended_regexp_option;
|
|
enum grep_pattern_type pattern_type_option;
|
|
int ignore_locale;
|
|
char colors[NR_GREP_COLORS][COLOR_MAXLEN];
|
|
unsigned pre_context;
|
|
unsigned post_context;
|
|
unsigned last_shown;
|
|
int show_hunk_mark;
|
|
int file_break;
|
|
int heading;
|
|
int max_count;
|
|
void *priv;
|
|
|
|
void (*output)(struct grep_opt *opt, const void *data, size_t size);
|
|
void *output_priv;
|
|
};
|
|
|
|
#define GREP_OPT_INIT { \
|
|
.relative = 1, \
|
|
.pathname = 1, \
|
|
.max_depth = -1, \
|
|
.max_count = -1, \
|
|
.pattern_type_option = GREP_PATTERN_TYPE_UNSPECIFIED, \
|
|
.colors = { \
|
|
[GREP_COLOR_CONTEXT] = "", \
|
|
[GREP_COLOR_FILENAME] = GIT_COLOR_MAGENTA, \
|
|
[GREP_COLOR_FUNCTION] = "", \
|
|
[GREP_COLOR_LINENO] = GIT_COLOR_GREEN, \
|
|
[GREP_COLOR_COLUMNNO] = GIT_COLOR_GREEN, \
|
|
[GREP_COLOR_MATCH_CONTEXT] = GIT_COLOR_BOLD_RED, \
|
|
[GREP_COLOR_MATCH_SELECTED] = GIT_COLOR_BOLD_RED, \
|
|
[GREP_COLOR_SELECTED] = "", \
|
|
[GREP_COLOR_SEP] = GIT_COLOR_CYAN, \
|
|
}, \
|
|
.only_matching = 0, \
|
|
.color = -1, \
|
|
.output = std_output, \
|
|
}
|
|
|
|
struct config_context;
|
|
int grep_config(const char *var, const char *value,
|
|
const struct config_context *ctx, void *data);
|
|
void grep_init(struct grep_opt *, struct repository *repo);
|
|
|
|
void append_grep_pat(struct grep_opt *opt, const char *pat, size_t patlen, const char *origin, int no, enum grep_pat_token t);
|
|
void append_grep_pattern(struct grep_opt *opt, const char *pat, const char *origin, int no, enum grep_pat_token t);
|
|
void append_header_grep_pattern(struct grep_opt *, enum grep_header_field, const char *);
|
|
void compile_grep_patterns(struct grep_opt *opt);
|
|
void free_grep_patterns(struct grep_opt *opt);
|
|
int grep_buffer(struct grep_opt *opt, const char *buf, unsigned long size);
|
|
|
|
/* The field parameter is only used to filter header patterns
|
|
* (where appropriate). If filtering isn't desirable
|
|
* GREP_HEADER_FIELD_MAX should be supplied.
|
|
*/
|
|
int grep_next_match(struct grep_opt *opt,
|
|
const char *bol, const char *eol,
|
|
enum grep_context ctx, regmatch_t *pmatch,
|
|
enum grep_header_field field, int eflags);
|
|
|
|
struct grep_source {
|
|
char *name;
|
|
|
|
enum grep_source_type {
|
|
GREP_SOURCE_OID,
|
|
GREP_SOURCE_FILE,
|
|
GREP_SOURCE_BUF,
|
|
} type;
|
|
void *identifier;
|
|
struct repository *repo; /* if GREP_SOURCE_OID */
|
|
|
|
const char *buf;
|
|
unsigned long size;
|
|
|
|
char *path; /* for attribute lookups */
|
|
struct userdiff_driver *driver;
|
|
};
|
|
|
|
void grep_source_init_file(struct grep_source *gs, const char *name,
|
|
const char *path);
|
|
void grep_source_init_oid(struct grep_source *gs, const char *name,
|
|
const char *path, const struct object_id *oid,
|
|
struct repository *repo);
|
|
void grep_source_clear_data(struct grep_source *gs);
|
|
void grep_source_clear(struct grep_source *gs);
|
|
void grep_source_load_driver(struct grep_source *gs,
|
|
struct index_state *istate);
|
|
|
|
|
|
int grep_source(struct grep_opt *opt, struct grep_source *gs);
|
|
|
|
struct grep_opt *grep_opt_dup(const struct grep_opt *opt);
|
|
|
|
/*
|
|
* Mutex used around access to the attributes machinery if
|
|
* opt->use_threads. Must be initialized/destroyed by callers!
|
|
*/
|
|
extern int grep_use_locks;
|
|
extern pthread_mutex_t grep_attr_mutex;
|
|
|
|
#endif
|