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
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)
25
26struct atom_value;
27
28struct ref_sorting {
29 struct ref_sorting *next;
30 int atom; /* index into used_atom array (internal) */
31 unsigned reverse : 1,
32 ignore_case : 1,
33 version : 1;
34};
35
36struct ref_array_item {
37 struct object_id objectname;
38 int flag;
39 unsigned int kind;
40 const char *symref;
41 struct commit *commit;
42 struct atom_value *value;
43 char refname[FLEX_ARRAY];
44};
45
46struct ref_array {
47 int nr, alloc;
48 struct ref_array_item **items;
49 struct rev_info *revs;
50};
51
52struct ref_filter {
53 const char **name_patterns;
54 struct oid_array points_at;
55 struct commit_list *with_commit;
56 struct commit_list *no_commit;
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;
64
65 unsigned int with_commit_tag_algo : 1,
66 match_as_path : 1,
67 ignore_case : 1,
68 detached : 1;
69 unsigned int kind,
70 lines;
71 int abbrev,
72 verbose;
73};
74
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;
82};
83
84#define REF_FORMAT_INIT { NULL, 0 }
85
86/* Macros for checking --merged and --no-merged options */
87#define _OPT_MERGED_NO_MERGED(option, filter, h) \
88 { OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
89 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \
90 parse_opt_merge_filter, (intptr_t) "HEAD" \
91 }
92#define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
93#define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)
94
95/*
96 * API for filtering a set of refs. Based on the type of refs the user
97 * has requested, we iterate through those refs and apply filters
98 * as per the given ref_filter structure and finally store the
99 * filtered refs in the ref_array structure.
100 */
101int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type);
102/* Clear all memory allocated to ref_array */
103void ref_array_clear(struct ref_array *array);
104/* Parse format string and sort specifiers */
105int parse_ref_filter_atom(const char *atom, const char *ep);
106/* Used to verify if the given format is correct and to parse out the used atoms */
107int verify_ref_format(struct ref_format *format);
108/* Sort the given ref_array as per the ref_sorting provided */
109void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
110/* Based on the given format and quote_style, fill the strbuf */
111void format_ref_array_item(struct ref_array_item *info,
112 const struct ref_format *format,
113 struct strbuf *final_buf);
114/* Print the ref using the given format and quote_style */
115void show_ref_array_item(struct ref_array_item *info, const struct ref_format *format);
116/* Callback function for parsing the sort option */
117int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset);
118/* Default sort option based on refname */
119struct ref_sorting *ref_default_sorting(void);
120/* Function to parse --merged and --no-merged options */
121int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
122/* Get the current HEAD's description */
123char *get_head_description(void);
124/* Set up translated strings in the output. */
125void setup_ref_filter_porcelain_msg(void);
126
127/*
128 * Print a single ref, outside of any ref-filter. Note that the
129 * name must be a fully qualified refname.
130 */
131void pretty_print_ref(const char *name, const unsigned char *sha1,
132 const struct ref_format *format);
133
134#endif /* REF_FILTER_H */