Merge branch 'cs/pretty-formats-doc-typofix'
[git/git.git] / ref-filter.h
CommitLineData
69b1cf91
KN
1#ifndef REF_FILTER_H
2#define REF_FILTER_H
3
4#include "sha1-array.h"
5#include "refs.h"
6#include "commit.h"
7#include "parse-options.h"
8
9/* Quoting styles */
10#define QUOTE_NONE 0
11#define QUOTE_SHELL 1
12#define QUOTE_PERL 2
13#define QUOTE_PYTHON 4
14#define QUOTE_TCL 8
15
5b4f2851
KN
16#define FILTER_REFS_INCLUDE_BROKEN 0x0001
17#define FILTER_REFS_TAGS 0x0002
18#define FILTER_REFS_BRANCHES 0x0004
19#define FILTER_REFS_REMOTES 0x0008
20#define FILTER_REFS_OTHERS 0x0010
21#define FILTER_REFS_ALL (FILTER_REFS_TAGS | FILTER_REFS_BRANCHES | \
22 FILTER_REFS_REMOTES | FILTER_REFS_OTHERS)
23#define FILTER_REFS_DETACHED_HEAD 0x0020
24#define FILTER_REFS_KIND_MASK (FILTER_REFS_ALL | FILTER_REFS_DETACHED_HEAD)
14de7fba 25
3a25761a 26struct atom_value;
69b1cf91
KN
27
28struct ref_sorting {
29 struct ref_sorting *next;
30 int atom; /* index into used_atom array (internal) */
90c00408 31 unsigned reverse : 1,
3bb16a8b 32 ignore_case : 1,
90c00408 33 version : 1;
69b1cf91
KN
34};
35
36struct ref_array_item {
cedfc41a 37 struct object_id objectname;
69b1cf91 38 int flag;
5b4f2851 39 unsigned int kind;
69b1cf91 40 const char *symref;
35257aa0 41 struct commit *commit;
69b1cf91 42 struct atom_value *value;
1958a6eb 43 char refname[FLEX_ARRAY];
69b1cf91
KN
44};
45
46struct ref_array {
47 int nr, alloc;
48 struct ref_array_item **items;
1511b22d 49 struct rev_info *revs;
69b1cf91
KN
50};
51
52struct ref_filter {
53 const char **name_patterns;
910650d2 54 struct oid_array points_at;
ee2bd06b 55 struct commit_list *with_commit;
ac3f5a34 56 struct commit_list *no_commit;
35257aa0
KN
57
58 enum {
59 REF_FILTER_MERGED_NONE = 0,
60 REF_FILTER_MERGED_INCLUDE,
61 REF_FILTER_MERGED_OMIT
62 } merge;
63 struct commit *merge_commit;
ee2bd06b 64
bef0e12b 65 unsigned int with_commit_tag_algo : 1,
1511b22d 66 match_as_path : 1,
3bb16a8b 67 ignore_case : 1,
1511b22d 68 detached : 1;
1bb38e5a
KN
69 unsigned int kind,
70 lines;
1511b22d
KN
71 int abbrev,
72 verbose;
69b1cf91
KN
73};
74
4a68e36d
JK
75struct ref_format {
76 /*
77 * Set these to define the format; make sure you call
78 * verify_ref_format() afterwards to finalize.
79 */
80 const char *format;
81 int quote_style;
11b087ad 82 int use_color;
bf285ae6
JK
83
84 /* Internal state to ref-filter */
85 int need_color_reset_at_eol;
4a68e36d
JK
86};
87
11b087ad 88#define REF_FORMAT_INIT { NULL, 0, -1 }
4a68e36d 89
5afcb905
KN
90/* Macros for checking --merged and --no-merged options */
91#define _OPT_MERGED_NO_MERGED(option, filter, h) \
92 { OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
93 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \
94 parse_opt_merge_filter, (intptr_t) "HEAD" \
95 }
96#define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
97#define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)
98
95be717c
JK
99#define OPT_REF_SORT(var) \
100 OPT_CALLBACK_F(0, "sort", (var), \
101 N_("key"), N_("field name to sort on"), \
102 PARSE_OPT_NONEG, parse_opt_ref_sorting)
103
14de7fba
KN
104/*
105 * API for filtering a set of refs. Based on the type of refs the user
106 * has requested, we iterate through those refs and apply filters
107 * as per the given ref_filter structure and finally store the
108 * filtered refs in the ref_array structure.
109 */
110int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type);
69b1cf91
KN
111/* Clear all memory allocated to ref_array */
112void ref_array_clear(struct ref_array *array);
69b1cf91 113/* Used to verify if the given format is correct and to parse out the used atoms */
4a68e36d 114int verify_ref_format(struct ref_format *format);
69b1cf91
KN
115/* Sort the given ref_array as per the ref_sorting provided */
116void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
99c6a71d 117/* Based on the given format and quote_style, fill the strbuf */
3019eca9
OT
118int format_ref_array_item(struct ref_array_item *info,
119 const struct ref_format *format,
120 struct strbuf *final_buf,
121 struct strbuf *error_buf);
69b1cf91 122/* Print the ref using the given format and quote_style */
4a68e36d 123void show_ref_array_item(struct ref_array_item *info, const struct ref_format *format);
18a25650
JK
124/* Parse a single sort specifier and add it to the list */
125void parse_ref_sorting(struct ref_sorting **sorting_tail, const char *atom);
69b1cf91
KN
126/* Callback function for parsing the sort option */
127int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset);
128/* Default sort option based on refname */
129struct ref_sorting *ref_default_sorting(void);
5afcb905
KN
130/* Function to parse --merged and --no-merged options */
131int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
d4919bb2
KN
132/* Get the current HEAD's description */
133char *get_head_description(void);
6eac70fa
KN
134/* Set up translated strings in the output. */
135void setup_ref_filter_porcelain_msg(void);
69b1cf91 136
2111aa79
LP
137/*
138 * Print a single ref, outside of any ref-filter. Note that the
139 * name must be a fully qualified refname.
140 */
53df97a2 141void pretty_print_ref(const char *name, const struct object_id *oid,
4a68e36d 142 const struct ref_format *format);
2111aa79 143
427cbc9d
JK
144/*
145 * Push a single ref onto the array; this can be used to construct your own
146 * ref_array without using filter_refs().
147 */
148struct ref_array_item *ref_array_push(struct ref_array *array,
149 const char *refname,
150 const struct object_id *oid);
151
69b1cf91 152#endif /* REF_FILTER_H */