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