ref-filter.h

   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 0x1
  17 #define FILTER_REFS_ALL 0x2
  18
  19 struct atom_value;
  20
  21 struct ref_sorting {
  22         struct ref_sorting *next;
  23         int atom; /* index into used_atom array (internal) */
  24         unsigned reverse : 1;
  25 };
  26
  27 struct ref_array_item {
  28         unsigned char objectname[20];
  29         int flag;
  30         const char *symref;
  31         struct commit *commit;
  32         struct atom_value *value;
  33         char refname[FLEX_ARRAY];
  34 };
  35
  36 struct ref_array {
  37         int nr, alloc;
  38         struct ref_array_item **items;
  39 };
  40
  41 struct ref_filter {
  42         const char **name_patterns;
  43         struct sha1_array points_at;
  44         struct commit_list *with_commit;
  45
  46         enum {
  47                 REF_FILTER_MERGED_NONE = 0,
  48                 REF_FILTER_MERGED_INCLUDE,
  49                 REF_FILTER_MERGED_OMIT
  50         } merge;
  51         struct commit *merge_commit;
  52
  53         unsigned int with_commit_tag_algo : 1;
  54 };
  55
  56 struct ref_filter_cbdata {
  57         struct ref_array *array;
  58         struct ref_filter *filter;
  59 };
  60
  61 /*  Macros for checking --merged and --no-merged options */
  62 #define _OPT_MERGED_NO_MERGED(option, filter, h) \
  63         { OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
  64           PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \
  65           parse_opt_merge_filter, (intptr_t) "HEAD" \
  66         }
  67 #define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
  68 #define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)
  69
  70 /*
  71  * API for filtering a set of refs. Based on the type of refs the user
  72  * has requested, we iterate through those refs and apply filters
  73  * as per the given ref_filter structure and finally store the
  74  * filtered refs in the ref_array structure.
  75  */
  76 int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type);
  77 /*  Clear all memory allocated to ref_array */
  78 void ref_array_clear(struct ref_array *array);
  79 /*  Parse format string and sort specifiers */
  80 int parse_ref_filter_atom(const char *atom, const char *ep);
  81 /*  Used to verify if the given format is correct and to parse out the used atoms */
  82 int verify_ref_format(const char *format);
  83 /*  Sort the given ref_array as per the ref_sorting provided */
  84 void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
  85 /*  Print the ref using the given format and quote_style */
  86 void show_ref_array_item(struct ref_array_item *info, const char *format, int quote_style);
  87 /*  Callback function for parsing the sort option */
  88 int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset);
  89 /*  Default sort option based on refname */
  90 struct ref_sorting *ref_default_sorting(void);
  91 /*  Function to parse --merged and --no-merged options */
  92 int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
  93
  94 #endif /*  REF_FILTER_H  */