Merge branch 'cb/test-lint-cp-a'
[git.git] / tree-walk.h
blobeefd26bb6214916f7c451d97710b5ee443e52088
1 #ifndef TREE_WALK_H
2 #define TREE_WALK_H
4 struct index_state;
5 struct strbuf;
7 struct name_entry {
8 const struct object_id *oid;
9 const char *path;
10 unsigned int mode;
13 struct tree_desc {
14 const void *buffer;
15 struct name_entry entry;
16 unsigned int size;
19 static inline const struct object_id *tree_entry_extract(struct tree_desc *desc, const char **pathp, unsigned int *modep)
21 *pathp = desc->entry.path;
22 *modep = desc->entry.mode;
23 return desc->entry.oid;
26 static inline int tree_entry_len(const struct name_entry *ne)
28 return (const char *)ne->oid - ne->path - 1;
32 * The _gently versions of these functions warn and return false on a
33 * corrupt tree entry rather than dying,
36 void update_tree_entry(struct tree_desc *);
37 int update_tree_entry_gently(struct tree_desc *);
38 void init_tree_desc(struct tree_desc *desc, const void *buf, unsigned long size);
39 int init_tree_desc_gently(struct tree_desc *desc, const void *buf, unsigned long size);
42 * Helper function that does both tree_entry_extract() and update_tree_entry()
43 * and returns true for success
45 int tree_entry(struct tree_desc *, struct name_entry *);
46 int tree_entry_gently(struct tree_desc *, struct name_entry *);
48 void *fill_tree_descriptor(struct tree_desc *desc, const struct object_id *oid);
50 struct traverse_info;
51 typedef int (*traverse_callback_t)(int n, unsigned long mask, unsigned long dirmask, struct name_entry *entry, struct traverse_info *);
52 int traverse_trees(struct index_state *istate, int n, struct tree_desc *t, struct traverse_info *info);
54 enum follow_symlinks_result {
55 FOUND = 0, /* This includes out-of-tree links */
56 MISSING_OBJECT = -1, /* The initial symlink is missing */
57 DANGLING_SYMLINK = -2, /*
58 * The initial symlink is there, but
59 * (transitively) points to a missing
60 * in-tree file
62 SYMLINK_LOOP = -3,
63 NOT_DIR = -4, /*
64 * Somewhere along the symlink chain, a path is
65 * requested which contains a file as a
66 * non-final element.
70 enum follow_symlinks_result get_tree_entry_follow_symlinks(struct object_id *tree_oid, const char *name, struct object_id *result, struct strbuf *result_path, unsigned *mode);
72 struct traverse_info {
73 const char *traverse_path;
74 struct traverse_info *prev;
75 struct name_entry name;
76 int pathlen;
77 struct pathspec *pathspec;
79 unsigned long df_conflicts;
80 traverse_callback_t fn;
81 void *data;
82 int show_all_errors;
85 int get_tree_entry(const struct object_id *, const char *, struct object_id *, unsigned *);
86 extern char *make_traverse_path(char *path, const struct traverse_info *info, const struct name_entry *n);
87 extern void setup_traverse_info(struct traverse_info *info, const char *base);
89 static inline int traverse_path_len(const struct traverse_info *info, const struct name_entry *n)
91 return info->pathlen + tree_entry_len(n);
94 /* in general, positive means "kind of interesting" */
95 enum interesting {
96 all_entries_not_interesting = -1, /* no, and no subsequent entries will be either */
97 entry_not_interesting = 0,
98 entry_interesting = 1,
99 all_entries_interesting = 2 /* yes, and all subsequent entries will be */
102 enum interesting tree_entry_interesting(struct index_state *istate,
103 const struct name_entry *,
104 struct strbuf *, int,
105 const struct pathspec *ps);
107 #endif