1 #ifndef REF_FILTER_H 2 #define REF_FILTER_H 3 4 #include "oid-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_TAGS 0x0002 17 #define FILTER_REFS_BRANCHES 0x0004 18 #define FILTER_REFS_REMOTES 0x0008 19 #define FILTER_REFS_OTHERS 0x0010 20 #define FILTER_REFS_ALL (FILTER_REFS_TAGS | FILTER_REFS_BRANCHES | \ 21 FILTER_REFS_REMOTES | FILTER_REFS_OTHERS) 22 #define FILTER_REFS_DETACHED_HEAD 0x0020 23 #define FILTER_REFS_KIND_MASK (FILTER_REFS_ALL | FILTER_REFS_DETACHED_HEAD) 24 25 struct atom_value; 26 27 struct ref_sorting { 28 struct ref_sorting *next; 29 int atom; /* index into used_atom array (internal) */ 30 enum { 31 REF_SORTING_REVERSE = 1<<0, 32 REF_SORTING_ICASE = 1<<1, 33 REF_SORTING_VERSION = 1<<2, 34 REF_SORTING_DETACHED_HEAD_FIRST = 1<<3, 35 } sort_flags; 36 }; 37 38 struct ref_array_item { 39 struct object_id objectname; 40 const char *rest; 41 int flag; 42 unsigned int kind; 43 const char *symref; 44 struct commit *commit; 45 struct atom_value *value; 46 char refname[FLEX_ARRAY]; 47 }; 48 49 struct ref_array { 50 int nr, alloc; 51 struct ref_array_item **items; 52 struct rev_info *revs; 53 }; 54 55 struct ref_filter { 56 const char **name_patterns; 57 struct oid_array points_at; 58 struct commit_list *with_commit; 59 struct commit_list *no_commit; 60 struct commit_list *reachable_from; 61 struct commit_list *unreachable_from; 62 63 unsigned int with_commit_tag_algo : 1, 64 match_as_path : 1, 65 ignore_case : 1, 66 detached : 1; 67 unsigned int kind, 68 lines; 69 int abbrev, 70 verbose; 71 }; 72 73 struct ref_format { 74 /* 75 * Set these to define the format; make sure you call 76 * verify_ref_format() afterwards to finalize. 77 */ 78 const char *format; 79 const char *rest; 80 int quote_style; 81 int use_rest; 82 int use_color; 83 84 /* Internal state to ref-filter */ 85 int need_color_reset_at_eol; 86 }; 87 88 #define REF_FORMAT_INIT { .use_color = -1 } 89 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 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 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 */ 110 int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type); 111 /* Clear all memory allocated to ref_array */ 112 void ref_array_clear(struct ref_array *array); 113 /* Used to verify if the given format is correct and to parse out the used atoms */ 114 int verify_ref_format(struct ref_format *format); 115 /* Sort the given ref_array as per the ref_sorting provided */ 116 void ref_array_sort(struct ref_sorting *sort, struct ref_array *array); 117 /* Set REF_SORTING_* sort_flags for all elements of a sorting list */ 118 void ref_sorting_set_sort_flags_all(struct ref_sorting *sorting, unsigned int mask, int on); 119 /* Based on the given format and quote_style, fill the strbuf */ 120 int format_ref_array_item(struct ref_array_item *info, 121 struct ref_format *format, 122 struct strbuf *final_buf, 123 struct strbuf *error_buf); 124 /* Parse a single sort specifier and add it to the list */ 125 void parse_ref_sorting(struct ref_sorting **sorting_tail, const char *atom); 126 /* Callback function for parsing the sort option */ 127 int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset); 128 /* Default sort option based on refname */ 129 struct ref_sorting *ref_default_sorting(void); 130 /* Release a "struct ref_sorting" */ 131 void ref_sorting_release(struct ref_sorting *); 132 /* Function to parse --merged and --no-merged options */ 133 int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset); 134 /* Get the current HEAD's description */ 135 char *get_head_description(void); 136 /* Set up translated strings in the output. */ 137 void setup_ref_filter_porcelain_msg(void); 138 139 /* 140 * Print a single ref, outside of any ref-filter. Note that the 141 * name must be a fully qualified refname. 142 */ 143 void pretty_print_ref(const char *name, const struct object_id *oid, 144 struct ref_format *format); 145 146 /* 147 * Push a single ref onto the array; this can be used to construct your own 148 * ref_array without using filter_refs(). 149 */ 150 struct ref_array_item *ref_array_push(struct ref_array *array, 151 const char *refname, 152 const struct object_id *oid); 153 154 #endif /* REF_FILTER_H */ 155