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