stash: teach 'push' (and 'create_stash') to honor pathspec
[git.git] / ref-filter.h
blob14d435e2ccf0204312d1f72555f1c2c36fabd215
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 version : 1;
35 struct ref_array_item {
36 unsigned char objectname[20];
37 int flag;
38 unsigned int kind;
39 const char *symref;
40 struct commit *commit;
41 struct atom_value *value;
42 char refname[FLEX_ARRAY];
45 struct ref_array {
46 int nr, alloc;
47 struct ref_array_item **items;
48 struct rev_info *revs;
51 struct ref_filter {
52 const char **name_patterns;
53 struct sha1_array points_at;
54 struct commit_list *with_commit;
56 enum {
57 REF_FILTER_MERGED_NONE = 0,
58 REF_FILTER_MERGED_INCLUDE,
59 REF_FILTER_MERGED_OMIT
60 } merge;
61 struct commit *merge_commit;
63 unsigned int with_commit_tag_algo : 1,
64 match_as_path : 1,
65 detached : 1;
66 unsigned int kind,
67 lines;
68 int abbrev,
69 verbose;
72 struct ref_filter_cbdata {
73 struct ref_array *array;
74 struct ref_filter *filter;
77 /* Macros for checking --merged and --no-merged options */
78 #define _OPT_MERGED_NO_MERGED(option, filter, h) \
79 { OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
80 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \
81 parse_opt_merge_filter, (intptr_t) "HEAD" \
83 #define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
84 #define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)
87 * API for filtering a set of refs. Based on the type of refs the user
88 * has requested, we iterate through those refs and apply filters
89 * as per the given ref_filter structure and finally store the
90 * filtered refs in the ref_array structure.
92 int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type);
93 /* Clear all memory allocated to ref_array */
94 void ref_array_clear(struct ref_array *array);
95 /* Parse format string and sort specifiers */
96 int parse_ref_filter_atom(const char *atom, const char *ep);
97 /* Used to verify if the given format is correct and to parse out the used atoms */
98 int verify_ref_format(const char *format);
99 /* Sort the given ref_array as per the ref_sorting provided */
100 void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
101 /* Print the ref using the given format and quote_style */
102 void show_ref_array_item(struct ref_array_item *info, const char *format, int quote_style);
103 /* Callback function for parsing the sort option */
104 int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset);
105 /* Default sort option based on refname */
106 struct ref_sorting *ref_default_sorting(void);
107 /* Function to parse --merged and --no-merged options */
108 int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
110 #endif /* REF_FILTER_H */