diff options
author | Carlos Martín Nieto <cmn@elego.de> | 2011-03-22 16:15:50 +0100 |
---|---|---|
committer | Carlos Martín Nieto <cmn@elego.de> | 2011-03-23 11:08:42 +0100 |
commit | b0b8313583afdcd54a83ba3855cf3f6f287ae0ab (patch) | |
tree | 7afe2242087618b4d1ae15d42b7c52b7bf79a824 | |
parent | 7c80c19e1dffb4421f91913bc79b9cb7596634a4 (diff) | |
download | libgit2-b0b8313583afdcd54a83ba3855cf3f6f287ae0ab.tar.gz |
Add close wappers for commit, tree, tag and blob
In the same spirit that git_repository_lookup is no longer available,
add wrappers so the users don't have to cast when closing their
objects.
Signed-off-by: Carlos Martín Nieto <cmn@elego.de>
-rw-r--r-- | include/git2/blob.h | 18 | ||||
-rw-r--r-- | include/git2/commit.h | 17 | ||||
-rw-r--r-- | include/git2/tag.h | 18 | ||||
-rw-r--r-- | include/git2/tree.h | 18 |
4 files changed, 71 insertions, 0 deletions
diff --git a/include/git2/blob.h b/include/git2/blob.h index 3cd1467bf..c38a52f65 100644 --- a/include/git2/blob.h +++ b/include/git2/blob.h @@ -53,6 +53,24 @@ GIT_INLINE(int) git_blob_lookup(git_blob **blob, git_repository *repo, const git } /** + * Close an open blob + * + * This is a wrapper around git_object_close() + * + * IMPORTANT: + * It *is* necessary to call this method when you stop + * using a blob. Failure to do so will cause a memory leak. + * + * @param blob the blob to close + */ + +GIT_INLINE(void) git_blob_close(git_blob *blob) +{ + return git_object_close((git_object *) blob); +} + + +/** * Get a read-only buffer with the raw content of a blob. * * A pointer to the raw content of a blob is returned; diff --git a/include/git2/commit.h b/include/git2/commit.h index 8306eb152..d497324c6 100644 --- a/include/git2/commit.h +++ b/include/git2/commit.h @@ -54,6 +54,23 @@ GIT_INLINE(int) git_commit_lookup(git_commit **commit, git_repository *repo, con } /** + * Close an open commit + * + * This is a wrapper around git_object_close() + * + * IMPORTANT: + * It *is* necessary to call this method when you stop + * using a commit. Failure to do so will cause a memory leak. + * + * @param commit the commit to close + */ + +GIT_INLINE(void) git_commit_close(git_commit *commit) +{ + return git_object_close((git_object *) commit); +} + +/** * Get the id of a commit. * * @param commit a previously loaded commit. diff --git a/include/git2/tag.h b/include/git2/tag.h index c343f6bf4..845b20516 100644 --- a/include/git2/tag.h +++ b/include/git2/tag.h @@ -53,6 +53,24 @@ GIT_INLINE(int) git_tag_lookup(git_tag **tag, git_repository *repo, const git_oi } /** + * Close an open tag + * + * This is a wrapper around git_object_close() + * + * IMPORTANT: + * It *is* necessary to call this method when you stop + * using a tag. Failure to do so will cause a memory leak. + * + * @param tag the tag to close + */ + +GIT_INLINE(void) git_tag_close(git_tag *tag) +{ + return git_object_close((git_object *) tag); +} + + +/** * Get the id of a tag. * * @param tag a previously loaded tag. diff --git a/include/git2/tree.h b/include/git2/tree.h index ec2b51646..cb959a790 100644 --- a/include/git2/tree.h +++ b/include/git2/tree.h @@ -53,6 +53,24 @@ GIT_INLINE(int) git_tree_lookup(git_tree **tree, git_repository *repo, const git } /** + * Close an open tree + * + * This is a wrapper around git_object_close() + * + * IMPORTANT: + * It *is* necessary to call this method when you stop + * using a tree. Failure to do so will cause a memory leak. + * + * @param tree the tree to close + */ + +GIT_INLINE(void) git_tree_close(git_tree *tree) +{ + return git_object_close((git_object *) tree); +} + + +/** * Get the id of a tree. * * @param tree a previously loaded tree. |