stash: remove now superfluos help for "stash push"
[git.git] / ref-filter.h
blob0d98342b343196387c0f4e2dcd5978a9361d8edb
1 #ifndef REF_FILTER_H
2 #define REF_FILTER_H
4 #include "sha1-array.h"
5 #include "refs.h"
6 #include "commit.h"
7 #include "parse-options.h"
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
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)
26 struct atom_value;
28 struct 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;
36 struct 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];
46 struct ref_array {
47 int nr, alloc;
48 struct ref_array_item **items;
49 struct rev_info *revs;
52 struct 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;
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;
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;
75 struct ref_format {
77 * Set these to define the format; make sure you call
78 * verify_ref_format() afterwards to finalize.
80 const char *format;
81 int quote_style;
82 int use_color;
84 /* Internal state to ref-filter */
85 int need_color_reset_at_eol;
88 #define REF_FORMAT_INIT { NULL, 0, -1 }
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" \
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)
100 * API for filtering a set of refs. Based on the type of refs the user
101 * has requested, we iterate through those refs and apply filters
102 * as per the given ref_filter structure and finally store the
103 * filtered refs in the ref_array structure.
105 int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type);
106 /* Clear all memory allocated to ref_array */
107 void ref_array_clear(struct ref_array *array);
108 /* Used to verify if the given format is correct and to parse out the used atoms */
109 int verify_ref_format(struct ref_format *format);
110 /* Sort the given ref_array as per the ref_sorting provided */
111 void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
112 /* Based on the given format and quote_style, fill the strbuf */
113 void format_ref_array_item(struct ref_array_item *info,
114 const struct ref_format *format,
115 struct strbuf *final_buf);
116 /* Print the ref using the given format and quote_style */
117 void show_ref_array_item(struct ref_array_item *info, const struct ref_format *format);
118 /* Parse a single sort specifier and add it to the list */
119 void parse_ref_sorting(struct ref_sorting **sorting_tail, const char *atom);
120 /* Callback function for parsing the sort option */
121 int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset);
122 /* Default sort option based on refname */
123 struct ref_sorting *ref_default_sorting(void);
124 /* Function to parse --merged and --no-merged options */
125 int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
126 /* Get the current HEAD's description */
127 char *get_head_description(void);
128 /* Set up translated strings in the output. */
129 void setup_ref_filter_porcelain_msg(void);
132 * Print a single ref, outside of any ref-filter. Note that the
133 * name must be a fully qualified refname.
135 void pretty_print_ref(const char *name, const unsigned char *sha1,
136 const struct ref_format *format);
138 #endif /* REF_FILTER_H */