FilesExpand file tree

master

/

errors.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

152 lines (138 loc) · 4.89 KB

master

/

errors.h

Copy path

Top

File metadata and controls

• Code
• Blame

152 lines (138 loc) · 4.89 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

/*

* 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, /**< No error */

GIT_ERROR = -1, /**< Generic error */

GIT_ENOTFOUND = -3, /**< Requested object could not be found */

GIT_EEXISTS = -4, /**< Object exists preventing operation */

GIT_EAMBIGUOUS = -5, /**< More than one object matches */

GIT_EBUFS = -6, /**< Output buffer too short to hold data */

/* GIT_EUSER is a special error that is never generated by libgit2

* code. You can return it from a callback (e.g to stop an iteration)

* to know that it was generated by the callback and not by libgit2.

*/

GIT_EUSER = -7,

GIT_EBAREREPO = -8, /**< Operation not allowed on bare repository */

GIT_EUNBORNBRANCH = -9, /**< HEAD refers to branch with no commits */

GIT_EUNMERGED = -10, /**< Merge in progress prevented operation */

GIT_ENONFASTFORWARD = -11, /**< Reference was not fast-forwardable */

GIT_EINVALIDSPEC = -12, /**< Name/ref spec was not in a valid format */

GIT_ECONFLICT = -13, /**< Checkout conflicts prevented operation */

GIT_ELOCKED = -14, /**< Lock file prevented operation */

GIT_EMODIFIED = -15, /**< Reference value does not match expected */

GIT_EAUTH = -16, /**< Authentication error */

GIT_ECERTIFICATE = -17, /**< Server certificate is invalid */

GIT_EAPPLIED = -18, /**< Patch/merge has already been applied */

GIT_EPEEL = -19, /**< The requested peel operation is not possible */

GIT_EEOF = -20, /**< Unexpected EOF */

GIT_EINVALID = -21, /**< Invalid operation or input */

GIT_EUNCOMMITTED = -22, /**< Uncommitted changes in index prevented operation */

GIT_EDIRECTORY = -23, /**< The operation is not valid for a directory */

GIT_EMERGECONFLICT = -24, /**< A merge conflict exists and cannot continue */

GIT_PASSTHROUGH = -30, /**< Internal only */

GIT_ITEROVER = -31, /**< Signals end of iteration with iterator */

GIT_RETRY = -32, /**< Internal only */

} git_error_code;

/**

* Structure to store extra details of the last error that occurred.

*

* This is kept on a per-thread basis if GIT_THREADS was defined when the

* library was build, otherwise one is kept globally for the library

*/

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,

GITERR_CHERRYPICK,

GITERR_DESCRIBE,

GITERR_REBASE,

GITERR_FILESYSTEM,

GITERR_PATCH,

GITERR_WORKTREE,

GITERR_SHA1

} 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);

/**

* 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.

*

* @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