Andrew's git - gitweb.git/blob

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