tree-walk.hon commit Merge branch 'dl/format-patch-doc-test-cleanup' (1c6fc94)
   1#ifndef TREE_WALK_H
   2#define TREE_WALK_H
   3
   4#include "cache.h"
   5
   6struct name_entry {
   7        struct object_id oid;
   8        const char *path;
   9        int pathlen;
  10        unsigned int mode;
  11};
  12
  13struct tree_desc {
  14        const void *buffer;
  15        struct name_entry entry;
  16        unsigned int size;
  17};
  18
  19static inline const struct object_id *tree_entry_extract(struct tree_desc *desc, const char **pathp, unsigned short *modep)
  20{
  21        *pathp = desc->entry.path;
  22        *modep = desc->entry.mode;
  23        return &desc->entry.oid;
  24}
  25
  26static inline int tree_entry_len(const struct name_entry *ne)
  27{
  28        return ne->pathlen;
  29}
  30
  31/*
  32 * The _gently versions of these functions warn and return false on a
  33 * corrupt tree entry rather than dying,
  34 */
  35
  36void update_tree_entry(struct tree_desc *);
  37int update_tree_entry_gently(struct tree_desc *);
  38void init_tree_desc(struct tree_desc *desc, const void *buf, unsigned long size);
  39int init_tree_desc_gently(struct tree_desc *desc, const void *buf, unsigned long size);
  40
  41/*
  42 * Helper function that does both tree_entry_extract() and update_tree_entry()
  43 * and returns true for success
  44 */
  45int tree_entry(struct tree_desc *, struct name_entry *);
  46int tree_entry_gently(struct tree_desc *, struct name_entry *);
  47
  48void *fill_tree_descriptor(struct repository *r,
  49                           struct tree_desc *desc,
  50                           const struct object_id *oid);
  51
  52struct traverse_info;
  53typedef int (*traverse_callback_t)(int n, unsigned long mask, unsigned long dirmask, struct name_entry *entry, struct traverse_info *);
  54int traverse_trees(struct index_state *istate, int n, struct tree_desc *t, struct traverse_info *info);
  55
  56enum get_oid_result get_tree_entry_follow_symlinks(struct repository *r, struct object_id *tree_oid, const char *name, struct object_id *result, struct strbuf *result_path, unsigned short *mode);
  57
  58struct traverse_info {
  59        const char *traverse_path;
  60        struct traverse_info *prev;
  61        const char *name;
  62        size_t namelen;
  63        unsigned mode;
  64
  65        size_t 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
  74int get_tree_entry(struct repository *, const struct object_id *, const char *, struct object_id *, unsigned short *);
  75char *make_traverse_path(char *path, size_t pathlen, const struct traverse_info *info,
  76                         const char *name, size_t namelen);
  77void strbuf_make_traverse_path(struct strbuf *out,
  78                               const struct traverse_info *info,
  79                               const char *name, size_t namelen);
  80void setup_traverse_info(struct traverse_info *info, const char *base);
  81
  82static inline size_t traverse_path_len(const struct traverse_info *info,
  83                                       size_t namelen)
  84{
  85        return st_add(info->pathlen, namelen);
  86}
  87
  88/* in general, positive means "kind of interesting" */
  89enum interesting {
  90        all_entries_not_interesting = -1, /* no, and no subsequent entries will be either */
  91        entry_not_interesting = 0,
  92        entry_interesting = 1,
  93        all_entries_interesting = 2 /* yes, and all subsequent entries will be */
  94};
  95
  96enum interesting tree_entry_interesting(struct index_state *istate,
  97                                        const struct name_entry *,
  98                                        struct strbuf *, int,
  99                                        const struct pathspec *ps);
 100
 101#endif