ref-filter.h

   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_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
  26 struct atom_value;
  27
  28 struct ref_sorting {
  29         struct ref_sorting *next;
  30         int atom; /* index into used_atom array (internal) */
  31         enum {
  32                 REF_SORTING_REVERSE = 1<<0,
  33                 REF_SORTING_ICASE = 1<<1,
  34                 REF_SORTING_VERSION = 1<<2,
  35                 REF_SORTING_DETACHED_HEAD_FIRST = 1<<3,
  36         } sort_flags;
  37 };
  38
  39 struct ref_array_item {
  40         struct object_id objectname;
  41         const char *rest;
  42         int flag;
  43         unsigned int kind;
  44         const char *symref;
  45         struct commit *commit;
  46         struct atom_value *value;
  47         char refname[FLEX_ARRAY];
  48 };
  49
  50 struct ref_array {
  51         int nr, alloc;
  52         struct ref_array_item **items;
  53         struct rev_info *revs;
  54 };
  55
  56 struct ref_filter {
  57         const char **name_patterns;
  58         struct oid_array points_at;
  59         struct commit_list *with_commit;
  60         struct commit_list *no_commit;
  61         struct commit_list *reachable_from;
  62         struct commit_list *unreachable_from;
  63
  64         unsigned int with_commit_tag_algo : 1,
  65                 match_as_path : 1,
  66                 ignore_case : 1,
  67                 detached : 1;
  68         unsigned int kind,
  69                 lines;
  70         int abbrev,
  71                 verbose;
  72 };
  73
  74 struct ref_format {
  75         /*
  76          * Set these to define the format; make sure you call
  77          * verify_ref_format() afterwards to finalize.
  78          */
  79         const char *format;
  80         const char *rest;
  81         int quote_style;
  82         int use_rest;
  83         int use_color;
  84
  85         /* Internal state to ref-filter */
  86         int need_color_reset_at_eol;
  87 };
  88
  89 #define REF_FORMAT_INIT { .use_color = -1 }
  90
  91 /*  Macros for checking --merged and --no-merged options */
  92 #define _OPT_MERGED_NO_MERGED(option, filter, h) \
  93         { OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
  94           PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \
  95           parse_opt_merge_filter, (intptr_t) "HEAD" \
  96         }
  97 #define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
  98 #define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)
  99
 100 #define OPT_REF_SORT(var) \
 101         OPT_CALLBACK_F(0, "sort", (var), \
 102                        N_("key"), N_("field name to sort on"), \
 103                        PARSE_OPT_NONEG, parse_opt_ref_sorting)
 104
 105 /*
 106  * API for filtering a set of refs. Based on the type of refs the user
 107  * has requested, we iterate through those refs and apply filters
 108  * as per the given ref_filter structure and finally store the
 109  * filtered refs in the ref_array structure.
 110  */
 111 int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type);
 112 /*  Clear all memory allocated to ref_array */
 113 void ref_array_clear(struct ref_array *array);
 114 /*  Used to verify if the given format is correct and to parse out the used atoms */
 115 int verify_ref_format(struct ref_format *format);
 116 /*  Sort the given ref_array as per the ref_sorting provided */
 117 void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
 118 /*  Set REF_SORTING_* sort_flags for all elements of a sorting list */
 119 void ref_sorting_set_sort_flags_all(struct ref_sorting *sorting, unsigned int mask, int on);
 120 /*  Based on the given format and quote_style, fill the strbuf */
 121 int format_ref_array_item(struct ref_array_item *info,
 122                           struct ref_format *format,
 123                           struct strbuf *final_buf,
 124                           struct strbuf *error_buf);
 125 /*  Parse a single sort specifier and add it to the list */
 126 void parse_ref_sorting(struct ref_sorting **sorting_tail, const char *atom);
 127 /*  Callback function for parsing the sort option */
 128 int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset);
 129 /*  Default sort option based on refname */
 130 struct ref_sorting *ref_default_sorting(void);
 131 /*  Function to parse --merged and --no-merged options */
 132 int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
 133 /*  Get the current HEAD's description */
 134 char *get_head_description(void);
 135 /*  Set up translated strings in the output. */
 136 void setup_ref_filter_porcelain_msg(void);
 137
 138 /*
 139  * Print a single ref, outside of any ref-filter. Note that the
 140  * name must be a fully qualified refname.
 141  */
 142 void pretty_print_ref(const char *name, const struct object_id *oid,
 143                       struct ref_format *format);
 144
 145 /*
 146  * Push a single ref onto the array; this can be used to construct your own
 147  * ref_array without using filter_refs().
 148  */
 149 struct ref_array_item *ref_array_push(struct ref_array *array,
 150                                       const char *refname,
 151                                       const struct object_id *oid);
 152
 153 #endif /*  REF_FILTER_H  */