Documentation/git-clone: improve description for submodule recursing
[git] / cache-tree.h
1 #ifndef CACHE_TREE_H
2 #define CACHE_TREE_H
3
4 #include "cache.h"
5 #include "tree.h"
6 #include "tree-walk.h"
7
8 struct cache_tree;
9 struct cache_tree_sub {
10         struct cache_tree *cache_tree;
11         int count;              /* internally used by update_one() */
12         int namelen;
13         int used;
14         char name[FLEX_ARRAY];
15 };
16
17 struct cache_tree {
18         int entry_count; /* negative means "invalid" */
19         struct object_id oid;
20         int subtree_nr;
21         int subtree_alloc;
22         struct cache_tree_sub **down;
23 };
24
25 struct cache_tree *cache_tree(void);
26 void cache_tree_free(struct cache_tree **);
27 void cache_tree_invalidate_path(struct index_state *, const char *);
28 struct cache_tree_sub *cache_tree_sub(struct cache_tree *, const char *);
29
30 void cache_tree_write(struct strbuf *, struct cache_tree *root);
31 struct cache_tree *cache_tree_read(const char *buffer, unsigned long size);
32
33 int cache_tree_fully_valid(struct cache_tree *);
34 int cache_tree_update(struct index_state *, int);
35
36 int update_main_cache_tree(int);
37
38 /* bitmasks to write_cache_as_tree flags */
39 #define WRITE_TREE_MISSING_OK 1
40 #define WRITE_TREE_IGNORE_CACHE_TREE 2
41 #define WRITE_TREE_DRY_RUN 4
42 #define WRITE_TREE_SILENT 8
43 #define WRITE_TREE_REPAIR 16
44
45 /* error return codes */
46 #define WRITE_TREE_UNREADABLE_INDEX (-1)
47 #define WRITE_TREE_UNMERGED_INDEX (-2)
48 #define WRITE_TREE_PREFIX_ERROR (-3)
49
50 int write_index_as_tree(unsigned char *sha1, struct index_state *index_state, const char *index_path, int flags, const char *prefix);
51 int write_cache_as_tree(unsigned char *sha1, int flags, const char *prefix);
52 void prime_cache_tree(struct index_state *, struct tree *);
53
54 extern int cache_tree_matches_traversal(struct cache_tree *, struct name_entry *ent, struct traverse_info *info);
55
56 #endif