mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-02 14:37:30 +00:00
72a3fe42fb
Hey. Apologies in advance -- I broke your bindings. This is a major commit that includes a long-overdue redesign of the whole object-database structure. This is expected to be the last major external API redesign of the library until the first non-alpha release. Please get your bindings up to date with these changes. They will be included in the next minor release. Sorry again! Major features include: - Real caching and refcounting on parsed objects - Real caching and refcounting on objects read from the ODB - Streaming writes & reads from the ODB - Single-method writes for all object types - The external API is now partially thread-safe The speed increases are significant in all aspects, specially when reading an object several times from the ODB (revwalking) and when writing big objects to the ODB. Here's a full changelog for the external API: blob.h ------ - Remove `git_blob_new` - Remove `git_blob_set_rawcontent` - Remove `git_blob_set_rawcontent_fromfile` - Rename `git_blob_writefile` -> `git_blob_create_fromfile` - Change `git_blob_create_fromfile`: The `path` argument is now relative to the repository's working dir - Add `git_blob_create_frombuffer` commit.h -------- - Remove `git_commit_new` - Remove `git_commit_add_parent` - Remove `git_commit_set_message` - Remove `git_commit_set_committer` - Remove `git_commit_set_author` - Remove `git_commit_set_tree` - Add `git_commit_create` - Add `git_commit_create_v` - Add `git_commit_create_o` - Add `git_commit_create_ov` tag.h ----- - Remove `git_tag_new` - Remove `git_tag_set_target` - Remove `git_tag_set_name` - Remove `git_tag_set_tagger` - Remove `git_tag_set_message` - Add `git_tag_create` - Add `git_tag_create_o` tree.h ------ - Change `git_tree_entry_2object`: New signature is `(git_object **object_out, git_repository *repo, git_tree_entry *entry)` - Remove `git_tree_new` - Remove `git_tree_add_entry` - Remove `git_tree_remove_entry_byindex` - Remove `git_tree_remove_entry_byname` - Remove `git_tree_clearentries` - Remove `git_tree_entry_set_id` - Remove `git_tree_entry_set_name` - Remove `git_tree_entry_set_attributes` object.h ------------ - Remove `git_object_new - Remove `git_object_write` - Change `git_object_close`: This method is now *mandatory*. Not closing an object causes a memory leak. odb.h ----- - Remove type `git_rawobj` - Remove `git_rawobj_close` - Rename `git_rawobj_hash` -> `git_odb_hash` - Change `git_odb_hash`: New signature is `(git_oid *id, const void *data, size_t len, git_otype type)` - Add type `git_odb_object` - Add `git_odb_object_close` - Change `git_odb_read`: New signature is `(git_odb_object **out, git_odb *db, const git_oid *id)` - Change `git_odb_read_header`: New signature is `(size_t *len_p, git_otype *type_p, git_odb *db, const git_oid *id)` - Remove `git_odb_write` - Add `git_odb_open_wstream` - Add `git_odb_open_rstream` odb_backend.h ------------- - Change type `git_odb_backend`: New internal signatures are as follows int (* read)(void **, size_t *, git_otype *, struct git_odb_backend *, const git_oid *) int (* read_header)(size_t *, git_otype *, struct git_odb_backend *, const git_oid *) int (* writestream)(struct git_odb_stream **, struct git_odb_backend *, size_t, git_otype) int (* readstream)( struct git_odb_stream **, struct git_odb_backend *, const git_oid *) - Add type `git_odb_stream` - Add enum `git_odb_streammode` Signed-off-by: Vicent Marti <tanoku@gmail.com>
148 lines
4.5 KiB
C
148 lines
4.5 KiB
C
/*
|
|
* This file is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License, version 2,
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* In addition to the permissions in the GNU General Public License,
|
|
* the authors give you unlimited permission to link the compiled
|
|
* version of this file into combinations with other programs,
|
|
* and to distribute those combinations without any restriction
|
|
* coming from the use of this file. (The General Public License
|
|
* restrictions do apply in other respects; for example, they cover
|
|
* modification of the file, and distribution when not linked into
|
|
* a combined executable.)
|
|
*
|
|
* This file is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; see the file COPYING. If not, write to
|
|
* the Free Software Foundation, 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
#ifndef INCLUDE_git_object_h__
|
|
#define INCLUDE_git_object_h__
|
|
|
|
#include "common.h"
|
|
#include "types.h"
|
|
#include "oid.h"
|
|
|
|
/**
|
|
* @file git2/object.h
|
|
* @brief Git revision object management routines
|
|
* @defgroup git_object Git revision object management routines
|
|
* @ingroup Git
|
|
* @{
|
|
*/
|
|
GIT_BEGIN_DECL
|
|
|
|
/**
|
|
* Lookup a reference to one of the objects in a repostory.
|
|
*
|
|
* The generated reference is owned by the repository and
|
|
* should be closed with the `git_object_close` method
|
|
* instead of free'd manually.
|
|
*
|
|
* The 'type' parameter must match the type of the object
|
|
* in the odb; the method will fail otherwise.
|
|
* The special value 'GIT_OBJ_ANY' may be passed to let
|
|
* the method guess the object's type.
|
|
*
|
|
* @param object pointer to the looked-up object
|
|
* @param repo the repository to look up the object
|
|
* @param id the unique identifier for the object
|
|
* @param type the type of the object
|
|
* @return a reference to the object
|
|
*/
|
|
GIT_EXTERN(int) git_object_lookup(git_object **object, git_repository *repo, const git_oid *id, git_otype type);
|
|
|
|
/**
|
|
* Get the id (SHA1) of a repository object
|
|
*
|
|
* @param obj the repository object
|
|
* @return the SHA1 id
|
|
*/
|
|
GIT_EXTERN(const git_oid *) git_object_id(const git_object *obj);
|
|
|
|
/**
|
|
* Get the object type of an object
|
|
*
|
|
* @param obj the repository object
|
|
* @return the object's type
|
|
*/
|
|
GIT_EXTERN(git_otype) git_object_type(const git_object *obj);
|
|
|
|
/**
|
|
* Get the repository that owns this object
|
|
*
|
|
* @param obj the object
|
|
* @return the repository who owns this object
|
|
*/
|
|
GIT_EXTERN(git_repository *) git_object_owner(const git_object *obj);
|
|
|
|
/**
|
|
* Close an open object
|
|
*
|
|
* This method instructs the library to close an existing
|
|
* object; note that git_objects are owned and cached by the repository
|
|
* so the object may or may not be freed after this library call,
|
|
* depending on how agressive is the caching mechanism used
|
|
* by the repository.
|
|
*
|
|
* IMPORTANT:
|
|
* It *is* necessary to call this method when you stop using
|
|
* an object. Failure to do so will cause a memory leak.
|
|
*
|
|
* @param object the object to close
|
|
*/
|
|
GIT_EXTERN(void) git_object_close(git_object *object);
|
|
|
|
/**
|
|
* Convert an object type to it's string representation.
|
|
*
|
|
* The result is a pointer to a string in static memory and
|
|
* should not be free()'ed.
|
|
*
|
|
* @param type object type to convert.
|
|
* @return the corresponding string representation.
|
|
*/
|
|
GIT_EXTERN(const char *) git_object_type2string(git_otype type);
|
|
|
|
/**
|
|
* Convert a string object type representation to it's git_otype.
|
|
*
|
|
* @param str the string to convert.
|
|
* @return the corresponding git_otype.
|
|
*/
|
|
GIT_EXTERN(git_otype) git_object_string2type(const char *str);
|
|
|
|
/**
|
|
* Determine if the given git_otype is a valid loose object type.
|
|
*
|
|
* @param type object type to test.
|
|
* @return true if the type represents a valid loose object type,
|
|
* false otherwise.
|
|
*/
|
|
GIT_EXTERN(int) git_object_typeisloose(git_otype type);
|
|
|
|
/**
|
|
* Get the size in bytes for the structure which
|
|
* acts as an in-memory representation of any given
|
|
* object type.
|
|
*
|
|
* For all the core types, this would the equivalent
|
|
* of calling `sizeof(git_commit)` if the core types
|
|
* were not opaque on the external API.
|
|
*
|
|
* @param type object type to get its size
|
|
* @return size in bytes of the object
|
|
*/
|
|
GIT_EXTERN(size_t) git_object__size(git_otype type);
|
|
|
|
/** @} */
|
|
GIT_END_DECL
|
|
|
|
#endif
|