thodg/libgit2/src/git/odb.h

• Show log

  Commit

• Hash : 43288a07
  Author :
  Date : 2008-11-29T19:18:43
  

  Fixup documentation to reflect the "git_obj" rename commit dff79e27d3d2cdc09790ded80fe2ea8ff5d61034 renamed the (small object) "git_sobj" to a plain "git_obj", but neglected to update some of the documentation to reflect that change. Signed-off-by: Ramsay Jones <ramsay@ramsay1.demon.co.uk> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>

Download

• src/git/odb.h

• #ifndef INCLUDE_git_odb_h__
  #define INCLUDE_git_odb_h__
  
  #include "common.h"
  #include "oid.h"
  #include <stdlib.h>
  
  /**
   * @file git/odb.h
   * @brief Git object database routines
   * @defgroup git_odb Git object database routines
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /** An open object database handle. */
  typedef struct git_odb git_odb;
  
  /**
   * Open an object database for read/write access.
   * @param out location to store the database pointer, if opened.
   *            Set to NULL if the open failed.
   * @param objects_dir path of the database's "objects" directory.
   * @return GIT_SUCCESS if the database opened; otherwise an error
   *         code describing why the open was not possible.
   */
  GIT_EXTERN(int) git_odb_open(git_odb **out, const char *objects_dir);
  
  /**
   * Close an open object database.
   * @param db database pointer to close.  If NULL no action is taken.
   */
  GIT_EXTERN(void) git_odb_close(git_odb *db);
  
  /** Basic type (loose or packed) of any Git object. */
  typedef enum {
  	GIT_OBJ_BAD = -1,       /**< Object is invalid. */
  	GIT_OBJ__EXT1 = 0,      /**< Reserved for future use. */
  	GIT_OBJ_COMMIT = 1,     /**< A commit object. */
  	GIT_OBJ_TREE = 2,       /**< A tree (directory listing) object. */
  	GIT_OBJ_BLOB = 3,       /**< A file revision object. */
  	GIT_OBJ_TAG = 4,        /**< An annotated tag object. */
  	GIT_OBJ__EXT2 = 5,      /**< Reserved for future use. */
  	GIT_OBJ_OFS_DELTA = 6,  /**< A delta, base is given by an offset. */
  	GIT_OBJ_REF_DELTA = 7,  /**< A delta, base is given by object id. */
  } git_otype;
  
  /** An object read from the database. */
  typedef struct {
  	void *data;          /**< Raw, decompressed object data. */
  	size_t len;          /**< Total number of bytes in data. */
  	git_otype type;      /**< Type of this object. */
  } git_obj;
  
  /**
   * Read an object from the database.
   *
   * If GIT_ENOTFOUND then out->data is set to NULL.
   *
   * @param out object descriptor to populate upon reading.
   * @param db database to search for the object in.
   * @param id identity of the object to read.
   * @return
   * - GIT_SUCCESS if the object was read;
   * - GIT_ENOTFOUND if the object is not in the database.
   */
  GIT_EXTERN(int) git_odb_read(git_obj *out, git_odb *db, const git_oid *id);
  
  /**
   * Read an object from the database using only pack files.
   *
   * If GIT_ENOTFOUND then out->data is set to NULL.
   *
   * @param out object descriptor to populate upon reading.
   * @param db database to search for the object in.
   * @param id identity of the object to read.
   * @return
   * - GIT_SUCCESS if the object was read.
   * - GIT_ENOTFOUND if the object is not in the database.
   */
  GIT_EXTERN(int) git_odb__read_packed(git_obj *out, git_odb *db, const git_oid *id);
  
  /**
   * Read an object from the database using only loose object files.
   *
   * If GIT_ENOTFOUND then out->data is set to NULL.
   *
   * @param out object descriptor to populate upon reading.
   * @param db database to search for the object in.
   * @param id identity of the object to read.
   * @return
   * - GIT_SUCCESS if the object was read.
   * - GIT_ENOTFOUND if the object is not in the database.
   */
  GIT_EXTERN(int) git_odb__read_loose(git_obj *out, git_odb *db, const git_oid *id);
  
  /**
   * Release all memory used by the obj structure.
   *
   * As a result of this call, obj->data will be set to NULL.
   *
   * If obj->data is already NULL, nothing happens.
   *
   * @param obj object descriptor to free.
   */
  GIT_INLINE(void) git_obj_close(git_obj *obj)
  {
  	free(obj->data);
  	obj->data = NULL;
  }
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download