thodg/libgit2/src/common.h

• Show log

  Commit

• Hash : 72556cc6
  Author :
  Date : 2014-02-20T14:27:10
  

  Address PR comments * Make GIT_INLINE an internal definition so it cannot be used in public headers * Fix language in CONTRIBUTING * Make index caps API use signed instead of unsigned values

Download

• src/common.h

• /*
   * Copyright (C) the libgit2 contributors. All rights reserved.
   *
   * This file is part of libgit2, distributed under the GNU GPL v2 with
   * a Linking Exception. For full terms see the included COPYING file.
   */
  #ifndef INCLUDE_common_h__
  #define INCLUDE_common_h__
  
  #include "git2/common.h"
  #include "cc-compat.h"
  
  /** 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
  
  #include <assert.h>
  #include <errno.h>
  #include <limits.h>
  #include <stdlib.h>
  #include <stdio.h>
  #include <string.h>
  
  #include <sys/types.h>
  #include <sys/stat.h>
  
  #ifdef GIT_WIN32
  
  # include <io.h>
  # include <direct.h>
  # include <winsock2.h>
  # include <windows.h>
  # include "win32/msvc-compat.h"
  # include "win32/mingw-compat.h"
  # include "win32/error.h"
  # include "win32/version.h"
  # ifdef GIT_THREADS
  #	include "win32/pthread.h"
  # endif
  
  #else
  
  # include <unistd.h>
  # ifdef GIT_THREADS
  #	include <pthread.h>
  # endif
  #define GIT_STDLIB_CALL
  
  # include <arpa/inet.h>
  
  #endif
  
  #include "git2/types.h"
  #include "git2/errors.h"
  #include "thread-utils.h"
  #include "bswap.h"
  
  #include <regex.h>
  
  /**
   * Check a pointer allocation result, returning -1 if it failed.
   */
  #define GITERR_CHECK_ALLOC(ptr) if (ptr == NULL) { return -1; }
  
  /**
   * Check a return value and propogate result if non-zero.
   */
  #define GITERR_CHECK_ERROR(code) \
  	do { int _err = (code); if (_err) return _err; } while (0)
  
  /**
   * Set the error message for this thread, formatting as needed.
   */
  void giterr_set(int error_class, const char *string, ...);
  
  /**
   * Set the error message for a regex failure, using the internal regex
   * error code lookup and return a libgit error code.
   */
  int giterr_set_regex(const regex_t *regex, int error_code);
  
  /**
   * Set error message for user callback if needed.
   *
   * If the error code in non-zero and no error message is set, this
   * sets a generic error message.
   *
   * @return This always returns the `error_code` parameter.
   */
  GIT_INLINE(int) giterr_set_after_callback_function(
  	int error_code, const char *action)
  {
  	if (error_code) {
  		const git_error *e = giterr_last();
  		if (!e || !e->message)
  			giterr_set(e ? e->klass : GITERR_CALLBACK,
  				"%s callback returned %d", action, error_code);
  	}
  	return error_code;
  }
  
  #ifdef GIT_WIN32
  #define giterr_set_after_callback(code) \
  	giterr_set_after_callback_function((code), __FUNCTION__)
  #else
  #define giterr_set_after_callback(code) \
  	giterr_set_after_callback_function((code), __func__)
  #endif
  
  /**
   * Gets the system error code for this thread.
   */
  int giterr_system_last(void);
  
  /**
   * Sets the system error code for this thread.
   */
  void giterr_system_set(int code);
  
  /**
   * Structure to preserve libgit2 error state
   */
  typedef struct {
  	int       error_code;
  	git_error error_msg;
  } git_error_state;
  
  /**
   * Capture current error state to restore later, returning error code.
   * If `error_code` is zero, this does nothing and returns zero.
   */
  int giterr_capture(git_error_state *state, int error_code);
  
  /**
   * Restore error state to a previous value, returning saved error code.
   */
  int giterr_restore(git_error_state *state);
  
  /**
   * Check a versioned structure for validity
   */
  GIT_INLINE(int) giterr__check_version(const void *structure, unsigned int expected_max, const char *name)
  {
  	unsigned int actual;
  
  	if (!structure)
  		return 0;
  
  	actual = *(const unsigned int*)structure;
  	if (actual > 0 && actual <= expected_max)
  		return 0;
  
  	giterr_set(GITERR_INVALID, "Invalid version %d on %s", actual, name);
  	return -1;
  }
  #define GITERR_CHECK_VERSION(S,V,N) if (giterr__check_version(S,V,N) < 0) return -1
  
  /**
   * Initialize a structure with a version.
   */
  GIT_INLINE(void) git__init_structure(void *structure, size_t len, unsigned int version)
  {
  	memset(structure, 0, len);
  	*((int*)structure) = version;
  }
  #define GIT_INIT_STRUCTURE(S,V) git__init_structure(S, sizeof(*S), V)
  
  /* NOTE: other giterr functions are in the public errors.h header file */
  
  #include "util.h"
  
  #endif /* INCLUDE_common_h__ */
  

Download