blob: 6552024f09e4d4d587eaf49377e7504a79818c1d [file] [log] [blame]
Karthik Nayak69b1cf92015-06-14 01:07:26 +05301#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
Karthik Nayak5b4f2852015-09-10 21:18:23 +053016#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)
Karthik Nayak14de7fb2015-06-14 01:07:28 +053025
Karthik Nayak3a257612015-08-22 09:09:37 +053026struct atom_value;
Karthik Nayak69b1cf92015-06-14 01:07:26 +053027
28struct ref_sorting {
29 struct ref_sorting *next;
30 int atom; /* index into used_atom array (internal) */
Karthik Nayak90c00402015-09-10 21:18:25 +053031 unsigned reverse : 1,
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +070032 ignore_case : 1,
Karthik Nayak90c00402015-09-10 21:18:25 +053033 version : 1;
Karthik Nayak69b1cf92015-06-14 01:07:26 +053034};
35
36struct ref_array_item {
brian m. carlsoncedfc412017-05-06 22:10:21 +000037 struct object_id objectname;
Karthik Nayak69b1cf92015-06-14 01:07:26 +053038 int flag;
Karthik Nayak5b4f2852015-09-10 21:18:23 +053039 unsigned int kind;
Karthik Nayak69b1cf92015-06-14 01:07:26 +053040 const char *symref;
Karthik Nayak35257aa2015-07-07 21:36:12 +053041 struct commit *commit;
Karthik Nayak69b1cf92015-06-14 01:07:26 +053042 struct atom_value *value;
Karthik Nayak1958a6e2015-06-14 01:07:29 +053043 char refname[FLEX_ARRAY];
Karthik Nayak69b1cf92015-06-14 01:07:26 +053044};
45
46struct ref_array {
47 int nr, alloc;
48 struct ref_array_item **items;
Karthik Nayak1511b222015-09-23 23:41:11 +053049 struct rev_info *revs;
Karthik Nayak69b1cf92015-06-14 01:07:26 +053050};
51
52struct ref_filter {
53 const char **name_patterns;
brian m. carlson910650d2017-03-31 01:40:00 +000054 struct oid_array points_at;
Karthik Nayakee2bd062015-07-07 21:36:16 +053055 struct commit_list *with_commit;
Ævar Arnfjörð Bjarmasonac3f5a32017-03-24 18:40:57 +000056 struct commit_list *no_commit;
Karthik Nayak35257aa2015-07-07 21:36:12 +053057
58 enum {
59 REF_FILTER_MERGED_NONE = 0,
60 REF_FILTER_MERGED_INCLUDE,
61 REF_FILTER_MERGED_OMIT
62 } merge;
63 struct commit *merge_commit;
Karthik Nayakee2bd062015-07-07 21:36:16 +053064
Karthik Nayakbef0e122015-09-10 21:18:26 +053065 unsigned int with_commit_tag_algo : 1,
Karthik Nayak1511b222015-09-23 23:41:11 +053066 match_as_path : 1,
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +070067 ignore_case : 1,
Karthik Nayak1511b222015-09-23 23:41:11 +053068 detached : 1;
Karthik Nayak1bb38e52015-09-11 20:34:16 +053069 unsigned int kind,
70 lines;
Karthik Nayak1511b222015-09-23 23:41:11 +053071 int abbrev,
72 verbose;
Karthik Nayak69b1cf92015-06-14 01:07:26 +053073};
74
Karthik Nayak5afcb902015-07-07 21:36:11 +053075/* Macros for checking --merged and --no-merged options */
76#define _OPT_MERGED_NO_MERGED(option, filter, h) \
77 { OPTION_CALLBACK, 0, option, (filter), N_("commit"), (h), \
78 PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NONEG, \
79 parse_opt_merge_filter, (intptr_t) "HEAD" \
80 }
81#define OPT_MERGED(f, h) _OPT_MERGED_NO_MERGED("merged", f, h)
82#define OPT_NO_MERGED(f, h) _OPT_MERGED_NO_MERGED("no-merged", f, h)
83
Karthik Nayak14de7fb2015-06-14 01:07:28 +053084/*
85 * API for filtering a set of refs. Based on the type of refs the user
86 * has requested, we iterate through those refs and apply filters
87 * as per the given ref_filter structure and finally store the
88 * filtered refs in the ref_array structure.
89 */
90int filter_refs(struct ref_array *array, struct ref_filter *filter, unsigned int type);
Karthik Nayak69b1cf92015-06-14 01:07:26 +053091/* Clear all memory allocated to ref_array */
92void ref_array_clear(struct ref_array *array);
93/* Parse format string and sort specifiers */
94int parse_ref_filter_atom(const char *atom, const char *ep);
95/* Used to verify if the given format is correct and to parse out the used atoms */
96int verify_ref_format(const char *format);
97/* Sort the given ref_array as per the ref_sorting provided */
98void ref_array_sort(struct ref_sorting *sort, struct ref_array *array);
Karthik Nayak99c6a712017-01-10 14:19:39 +053099/* Based on the given format and quote_style, fill the strbuf */
100void format_ref_array_item(struct ref_array_item *info, const char *format,
101 int quote_style, struct strbuf *final_buf);
Karthik Nayak69b1cf92015-06-14 01:07:26 +0530102/* Print the ref using the given format and quote_style */
103void show_ref_array_item(struct ref_array_item *info, const char *format, int quote_style);
104/* Callback function for parsing the sort option */
105int parse_opt_ref_sorting(const struct option *opt, const char *arg, int unset);
106/* Default sort option based on refname */
107struct ref_sorting *ref_default_sorting(void);
Karthik Nayak5afcb902015-07-07 21:36:11 +0530108/* Function to parse --merged and --no-merged options */
109int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset);
Karthik Nayakd4919bb2017-01-10 14:19:38 +0530110/* Get the current HEAD's description */
111char *get_head_description(void);
Karthik Nayak6eac70f2017-01-10 14:19:50 +0530112/* Set up translated strings in the output. */
113void setup_ref_filter_porcelain_msg(void);
Karthik Nayak69b1cf92015-06-14 01:07:26 +0530114
Lukas Puehringer2111aa72017-01-17 18:37:19 -0500115/*
116 * Print a single ref, outside of any ref-filter. Note that the
117 * name must be a fully qualified refname.
118 */
119void pretty_print_ref(const char *name, const unsigned char *sha1,
120 const char *format);
121
Karthik Nayak69b1cf92015-06-14 01:07:26 +0530122#endif /* REF_FILTER_H */