tree_entry_interesting(): give meaningful names to return values
[git/git.git] / tree-walk.h
1 #ifndef TREE_WALK_H
2 #define TREE_WALK_H
3
4 struct name_entry {
5 const unsigned char *sha1;
6 const char *path;
7 unsigned int mode;
8 };
9
10 struct tree_desc {
11 const void *buffer;
12 struct name_entry entry;
13 unsigned int size;
14 };
15
16 static inline const unsigned char *tree_entry_extract(struct tree_desc *desc, const char **pathp, unsigned int *modep)
17 {
18 *pathp = desc->entry.path;
19 *modep = canon_mode(desc->entry.mode);
20 return desc->entry.sha1;
21 }
22
23 static inline int tree_entry_len(const struct name_entry *ne)
24 {
25 return (const char *)ne->sha1 - ne->path - 1;
26 }
27
28 void update_tree_entry(struct tree_desc *);
29 void init_tree_desc(struct tree_desc *desc, const void *buf, unsigned long size);
30
31 /*
32 * Helper function that does both tree_entry_extract() and update_tree_entry()
33 * and returns true for success
34 */
35 int tree_entry(struct tree_desc *, struct name_entry *);
36
37 void *fill_tree_descriptor(struct tree_desc *desc, const unsigned char *sha1);
38
39 struct traverse_info;
40 typedef int (*traverse_callback_t)(int n, unsigned long mask, unsigned long dirmask, struct name_entry *entry, struct traverse_info *);
41 int traverse_trees(int n, struct tree_desc *t, struct traverse_info *info);
42
43 struct traverse_info {
44 struct traverse_info *prev;
45 struct name_entry name;
46 int pathlen;
47 struct pathspec *pathspec;
48
49 unsigned long conflicts;
50 traverse_callback_t fn;
51 void *data;
52 int show_all_errors;
53 };
54
55 int get_tree_entry(const unsigned char *, const char *, unsigned char *, unsigned *);
56 extern char *make_traverse_path(char *path, const struct traverse_info *info, const struct name_entry *n);
57 extern void setup_traverse_info(struct traverse_info *info, const char *base);
58
59 static inline int traverse_path_len(const struct traverse_info *info, const struct name_entry *n)
60 {
61 return info->pathlen + tree_entry_len(n);
62 }
63
64 /* in general, positive means "kind of interesting" */
65 enum interesting {
66 all_entries_not_interesting = -1, /* no, and no subsequent entries will be either */
67 entry_not_interesting = 0,
68 entry_interesting = 1,
69 all_entries_interesting = 2 /* yes, and all subsequent entries will be */
70 };
71
72 extern enum interesting tree_entry_interesting(const struct name_entry *,
73 struct strbuf *, int,
74 const struct pathspec *ps);
75
76 #endif