thodg/libgit2/src/git/repository.h

• Show log

  Commit

• Hash : 3315782c
  Author :
  Date : 2010-08-08T14:12:17
  

  Redesigned the walking/object lookup interface The old 'git_revpool' object has been removed and split into two distinct objects with separate functionality, in order to have separate methods for object management and object walking. * A new object 'git_repository' does the high-level management of a repository's objects (commits, trees, tags, etc) on top of a 'git_odb'. Eventually, it will also manage other repository attributes (e.g. tag resolution, references, etc). See: src/git/repository.h * A new external method 'git_repository_lookup(repo, oid, type)' has been added to the 'git_repository' API. All object lookups (git_XXX_lookup()) are now wrappers to this method, and duplicated code has been removed. The method does automatic type checking and returns a generic 'git_revpool_object' that can be cast to any specific object. See: src/git/repository.h * The external methods for object parsing of repository objects (git_XXX_parse()) have been removed. Loading objects from the repository is now managed through the 'lookup' functions. These objects are loaded with minimal information, and the relevant parsing is done automatically when the user requests any of the parsed attributes through accessor methods. An attribute has been added to 'git_repository' in order to force the parsing of all the repository objects immediately after lookup. See: src/git/commit.h See: src/git/tag.h See: src/git/tree.h * The previous walking functionality of the revpool is now found in 'git_revwalk', which does the actual revision walking on a repository; the attributes when walking through commits in a database have been decoupled from the actual commit objects. This increases performance when accessing commits during the walk and allows to have several 'git_revwalk' instances working at the same time on top of the same repository, without having to load commits in memory several times. See: src/git/revwalk.h * The old 'git_revpool_table' has been renamed to 'git_hashtable' and now works as a generic hashtable with support for any kind of object and custom hash functions. See: src/hashtable.h * All the relevant unit tests have been updated, renamed and grouped accordingly. Signed-off-by: Vicent Marti <tanoku@gmail.com>

Download

• src/git/repository.h

• #ifndef INCLUDE_git_repository_h__
  #define INCLUDE_git_repository_h__
  
  #include "common.h"
  #include "odb.h"
  #include "commit.h"
  
  /**
   * @file git/repository.h
   * @brief Git revision object management routines
   * @defgroup git_repository Git revision object management routines
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /**
   * Allocate a new repository object.
   *
   * TODO: specify the repository's path instead
   * of its object database
   *
   * @param odb an existing object database to back the repo
   * @return the new repository handle; NULL on error 
   */
  GIT_EXTERN(git_repository *) git_repository_alloc(git_odb *odb);
  
  
  /**
   * Lookup a reference to one of the objects in the repostory.
   * 
   * The generated reference is owned by the repository and
   * should not be freed by the user.
   * The generated reference should be cast back to the
   * expected type; e.g.
   *
   *	git_commit *c = (git_commit *)
   *		git_repository_lookup(repo, id, GIT_OBJ_COMMIT);
   *
   * 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 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(git_repository_object *) git_repository_lookup(git_repository *repo, const git_oid *id, git_otype type);
  
  /**
   * Free a previously allocated repository
   * @param repo repository handle to close. If NULL nothing occurs.
   */
  GIT_EXTERN(void) git_repository_free(git_repository *repo);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download