summaryrefslogtreecommitdiff
path: root/src/git/tree.h
blob: d5f668c547ff80ee9c5ec24613a2e552cb531c59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
#ifndef INCLUDE_git_tree_h__
#define INCLUDE_git_tree_h__

#include "common.h"
#include "oid.h"

/**
 * @file git/tree.h
 * @brief Git tree parsing, loading routines
 * @defgroup git_tree Git tree parsing, loading routines
 * @ingroup Git
 * @{
 */
GIT_BEGIN_DECL

/** Representation of a tree object. */
typedef struct git_tree git_tree;

/**
 * Locate a reference to a tree without loading it.
 * The generated tree object is owned by the revision
 * pool and shall not be freed by the user.
 *
 * @param pool the pool to use when locating the tree.
 * @param id identity of the tree to locate.
 * @return the tree; NULL if the tree could not be created
 */
GIT_EXTERN(git_tree *) git_tree_lookup(git_revpool *pool, const git_oid *id);

/**
 * Get the id of a tree.
 * @param tree a previously loaded tree.
 * @return object identity for the tree.
 */
GIT_EXTERN(const git_oid *) git_tree_id(git_tree *tree);

/** @} */
GIT_END_DECL
#endif