thodg/libgit2/src/git/common.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/common.h

• #ifndef INCLUDE_git_common_h__
  #define INCLUDE_git_common_h__
  
  #include "thread-utils.h"
  
  #ifdef __cplusplus
  # define GIT_BEGIN_DECL  extern "C" {
  # define GIT_END_DECL    }
  #else
    /** Start declarations in C mode */
  # define GIT_BEGIN_DECL  /* empty */
    /** End declarations in C mode */
  # define GIT_END_DECL    /* empty */
  #endif
  
  /** Declare a public function exported for application use. */
  #ifdef __GNUC__
  # define GIT_EXTERN(type) extern \
  			  __attribute__((visibility("default"))) \
  			  type
  #else
  # define GIT_EXTERN(type) extern type
  #endif
  
  /** Declare a public TLS symbol exported for application use. */
  #ifdef __GNUC__
  # define GIT_EXTERN_TLS(type) extern \
  			      __attribute__((visibility("default"))) \
  			      GIT_TLS \
  			      type
  #else
  # define GIT_EXTERN_TLS(type) extern GIT_TLS type
  #endif
  
  /** Declare a function as always inlined. */
  #if defined(_MSC_VER)
  # define GIT_INLINE(type) static __inline type
  #else
  # define GIT_INLINE(type) static inline type
  #endif
  
  /** Declare a function's takes printf style arguments. */
  #ifdef __GNUC__
  # define GIT_FORMAT_PRINTF(a,b) __attribute__((format (printf, a, b)))
  #else
  # define GIT_FORMAT_PRINTF(a,b) /* empty */
  #endif
  
  /**
   * @file git/common.h
   * @brief Git common platform definitions
   * @defgroup git_common Git common platform definitions
   * @ingroup Git
   * @{
   */
  
  /** Operation completed successfully. */
  #define GIT_SUCCESS 0
  
  /**
   * Operation failed, with unspecified reason.
   * This value also serves as the base error code; all other
   * error codes are subtracted from it such that all errors
   * are < 0, in typical POSIX C tradition.
   */
  #define GIT_ERROR -1
  
  /** Input was not a properly formatted Git object id. */
  #define GIT_ENOTOID (GIT_ERROR - 1)
  
  /** Input does not exist in the scope searched. */
  #define GIT_ENOTFOUND (GIT_ERROR - 2)
  
  /** Not enough space available. */
  #define GIT_ENOMEM (GIT_ERROR - 3)
  
  /** Consult the OS error information. */
  #define GIT_EOSERR (GIT_ERROR - 4)
  
  /** The specified object is of invalid type */
  #define GIT_EOBJTYPE (GIT_ERROR - 5)
  
  /** The specified object has its data corrupted */
  #define GIT_EOBJCORRUPTED (GIT_ERROR - 6)
  
  GIT_BEGIN_DECL
  
  /** 
   * Representation of an existing git repository,
   * including all its object contents 
   */
  typedef struct git_repository git_repository;
  
  /* Representation of a generic object in a repository */
  typedef struct git_repository_object git_repository_object;
  
  /** Parsed representation of a person */
  typedef struct git_person {
  	char name[64]; /**< Full name */
  	char email[64]; /**< Email address */
  	time_t time; /**< Time when this person commited the change */
  } git_person;
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download