difftool: rename variables for consistency
[git] / tree-walk.h
1 #ifndef TREE_WALK_H
2 #define TREE_WALK_H
3
4 struct name_entry {
5         const struct object_id *oid;
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 struct object_id *tree_entry_extract(struct tree_desc *desc, const char **pathp, unsigned int *modep)
17 {
18         *pathp = desc->entry.path;
19         *modep = desc->entry.mode;
20         return desc->entry.oid;
21 }
22
23 static inline int tree_entry_len(const struct name_entry *ne)
24 {
25         return (const char *)ne->oid - 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 enum follow_symlinks_result {
44         FOUND = 0, /* This includes out-of-tree links */
45         MISSING_OBJECT = -1, /* The initial symlink is missing */
46         DANGLING_SYMLINK = -2, /*
47                                 * The initial symlink is there, but
48                                 * (transitively) points to a missing
49                                 * in-tree file
50                                 */
51         SYMLINK_LOOP = -3,
52         NOT_DIR = -4, /*
53                        * Somewhere along the symlink chain, a path is
54                        * requested which contains a file as a
55                        * non-final element.
56                        */
57 };
58
59 enum follow_symlinks_result get_tree_entry_follow_symlinks(unsigned char *tree_sha1, const char *name, unsigned char *result, struct strbuf *result_path, unsigned *mode);
60
61 struct traverse_info {
62         const char *traverse_path;
63         struct traverse_info *prev;
64         struct name_entry name;
65         int pathlen;
66         struct pathspec *pathspec;
67
68         unsigned long df_conflicts;
69         traverse_callback_t fn;
70         void *data;
71         int show_all_errors;
72 };
73
74 int get_tree_entry(const unsigned char *, const char *, unsigned char *, unsigned *);
75 extern char *make_traverse_path(char *path, const struct traverse_info *info, const struct name_entry *n);
76 extern void setup_traverse_info(struct traverse_info *info, const char *base);
77
78 static inline int traverse_path_len(const struct traverse_info *info, const struct name_entry *n)
79 {
80         return info->pathlen + tree_entry_len(n);
81 }
82
83 /* in general, positive means "kind of interesting" */
84 enum interesting {
85         all_entries_not_interesting = -1, /* no, and no subsequent entries will be either */
86         entry_not_interesting = 0,
87         entry_interesting = 1,
88         all_entries_interesting = 2 /* yes, and all subsequent entries will be */
89 };
90
91 extern enum interesting tree_entry_interesting(const struct name_entry *,
92                                                struct strbuf *, int,
93                                                const struct pathspec *ps);
94
95 #endif