thodg/libgit2/src/git2/common.h

• Show log

  Commit

• Hash : 13710f1e
  Author :
  Date : 2010-12-10T16:30:06
  

  Added timezone offset parsing and outputting.

Download

• src/git2/common.h

• /*
   * 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_common_h__
  #define INCLUDE_git_common_h__
  
  #include "thread-utils.h"
  #include <time.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
  #elif defined(_MSC_VER)
  # define GIT_EXTERN(type) __declspec(dllexport) 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 git2/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)
  
  /** The specified repository is invalid */
  #define GIT_ENOTAREPO (GIT_ERROR - 7)
  
  /** The object type is invalid or doesn't match */
  #define GIT_EINVALIDTYPE (GIT_ERROR - 8)
  
  /** The object cannot be written that because it's missing internal data */
  #define GIT_EMISSINGOBJDATA (GIT_ERROR - 9)
  
  /** The packfile for the ODB is corrupted */
  #define GIT_EPACKCORRUPTED (GIT_ERROR - 10)
  
  /** Failed to adquire or release a file lock */
  #define GIT_EFLOCKFAIL (GIT_ERROR - 11)
  
  /** The Z library failed to inflate/deflate an object's data */
  #define GIT_EZLIB (GIT_ERROR - 12)
  
  /** The queried object is currently busy */
  #define GIT_EBUSY (GIT_ERROR - 13)
  
  /** The index file is not backed up by an existing repository */
  #define GIT_EBAREINDEX (GIT_ERROR -14)
  
  
  GIT_BEGIN_DECL
  
  /** Parsed representation of a person */
  typedef struct git_person git_person;
  
  const char *git_person_name(git_person *person);
  const char *git_person_email(git_person *person);
  time_t git_person_time(git_person *person);
  int git_person_timezone_offset(git_person *person);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download