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