mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-02 17:42:31 +00:00
25e0b1576d
This changes the behavior of callbacks so that the callback error code is not converted into GIT_EUSER and instead we propagate the return value through to the caller. Instead of using the giterr_capture and giterr_restore functions, we now rely on all functions to pass back the return value from a callback. To avoid having a return value with no error message, the user can call the public giterr_set_str or some such function to set an error message. There is a new helper 'giterr_set_callback' that functions can invoke after making a callback which ensures that some error message was set in case the callback did not set one. In places where the sign of the callback return value is meaningful (e.g. positive to skip, negative to abort), only the negative values are returned back to the caller, obviously, since the other values allow for continuing the loop. The hardest parts of this were in the checkout code where positive return values were overloaded as meaningful values for checkout. I fixed this by adding an output parameter to many of the internal checkout functions and removing the overload. This added some code, but it is probably a better implementation. There is some funkiness in the network code where user provided callbacks could be returning a positive or a negative value and we want to rely on that to cancel the loop. There are still a couple places where an user error might get turned into GIT_EUSER there, I think, though none exercised by the tests.
139 lines
3.6 KiB
C
139 lines
3.6 KiB
C
/*
|
|
* 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_git_errors_h__
|
|
#define INCLUDE_git_errors_h__
|
|
|
|
#include "common.h"
|
|
|
|
/**
|
|
* @file git2/errors.h
|
|
* @brief Git error handling routines and variables
|
|
* @ingroup Git
|
|
* @{
|
|
*/
|
|
GIT_BEGIN_DECL
|
|
|
|
/** Generic return codes */
|
|
typedef enum {
|
|
GIT_OK = 0,
|
|
GIT_ERROR = -1,
|
|
GIT_ENOTFOUND = -3,
|
|
GIT_EEXISTS = -4,
|
|
GIT_EAMBIGUOUS = -5,
|
|
GIT_EBUFS = -6,
|
|
GIT_EUSER = -7,
|
|
GIT_EBAREREPO = -8,
|
|
GIT_EUNBORNBRANCH = -9,
|
|
GIT_EUNMERGED = -10,
|
|
GIT_ENONFASTFORWARD = -11,
|
|
GIT_EINVALIDSPEC = -12,
|
|
GIT_EMERGECONFLICT = -13,
|
|
GIT_ELOCKED = -14,
|
|
|
|
GIT_PASSTHROUGH = -30,
|
|
GIT_ITEROVER = -31,
|
|
} git_error_code;
|
|
|
|
typedef struct {
|
|
char *message;
|
|
int klass;
|
|
} git_error;
|
|
|
|
/** Error classes */
|
|
typedef enum {
|
|
GITERR_NONE = 0,
|
|
GITERR_NOMEMORY,
|
|
GITERR_OS,
|
|
GITERR_INVALID,
|
|
GITERR_REFERENCE,
|
|
GITERR_ZLIB,
|
|
GITERR_REPOSITORY,
|
|
GITERR_CONFIG,
|
|
GITERR_REGEX,
|
|
GITERR_ODB,
|
|
GITERR_INDEX,
|
|
GITERR_OBJECT,
|
|
GITERR_NET,
|
|
GITERR_TAG,
|
|
GITERR_TREE,
|
|
GITERR_INDEXER,
|
|
GITERR_SSL,
|
|
GITERR_SUBMODULE,
|
|
GITERR_THREAD,
|
|
GITERR_STASH,
|
|
GITERR_CHECKOUT,
|
|
GITERR_FETCHHEAD,
|
|
GITERR_MERGE,
|
|
GITERR_SSH,
|
|
GITERR_FILTER,
|
|
GITERR_REVERT,
|
|
GITERR_CALLBACK,
|
|
} git_error_t;
|
|
|
|
/**
|
|
* Return the last `git_error` object that was generated for the
|
|
* current thread or NULL if no error has occurred.
|
|
*
|
|
* @return A git_error object.
|
|
*/
|
|
GIT_EXTERN(const git_error *) giterr_last(void);
|
|
|
|
/**
|
|
* Clear the last library error that occurred for this thread.
|
|
*/
|
|
GIT_EXTERN(void) giterr_clear(void);
|
|
|
|
/**
|
|
* Get the last error data and clear it.
|
|
*
|
|
* This copies the last error into the given `git_error` struct
|
|
* and returns 0 if the copy was successful, leaving the error
|
|
* cleared as if `giterr_clear` had been called.
|
|
*
|
|
* If there was no existing error in the library, -1 will be returned
|
|
* and the contents of `cpy` will be left unmodified.
|
|
*/
|
|
GIT_EXTERN(int) giterr_detach(git_error *cpy);
|
|
|
|
/**
|
|
* Set the error message string for this thread.
|
|
*
|
|
* This function is public so that custom ODB backends and the like can
|
|
* relay an error message through libgit2. Most regular users of libgit2
|
|
* will never need to call this function -- actually, calling it in most
|
|
* circumstances (for example, calling from within a callback function)
|
|
* will just end up having the value overwritten by libgit2 internals.
|
|
*
|
|
* This error message is stored in thread-local storage and only applies
|
|
* to the particular thread that this libgit2 call is made from.
|
|
*
|
|
* NOTE: Passing the `error_class` as GITERR_OS has a special behavior: we
|
|
* attempt to append the system default error message for the last OS error
|
|
* that occurred and then clear the last error. The specific implementation
|
|
* of looking up and clearing this last OS error will vary by platform.
|
|
*
|
|
* @param error_class One of the `git_error_t` enum above describing the
|
|
* general subsystem that is responsible for the error.
|
|
* @param string The formatted error message to keep
|
|
*/
|
|
GIT_EXTERN(void) giterr_set_str(int error_class, const char *string);
|
|
|
|
/**
|
|
* Set the error message to a special value for memory allocation failure.
|
|
*
|
|
* The normal `giterr_set_str()` function attempts to `strdup()` the string
|
|
* that is passed in. This is not a good idea when the error in question
|
|
* is a memory allocation failure. That circumstance has a special setter
|
|
* function that sets the error string to a known and statically allocated
|
|
* internal value.
|
|
*/
|
|
GIT_EXTERN(void) giterr_set_oom(void);
|
|
|
|
/** @} */
|
|
GIT_END_DECL
|
|
#endif
|