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
|
/*===-- clang-c/CXErrorCode.h - C Index Error Codes --------------*- C -*-===*\
|* *|
|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
|* Exceptions. *|
|* See https://llvm.org/LICENSE.txt for license information. *|
|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
|* *|
|*===----------------------------------------------------------------------===*|
|* *|
|* This header provides the CXErrorCode enumerators. *|
|* *|
\*===----------------------------------------------------------------------===*/
#ifndef LLVM_CLANG_C_CXERRORCODE_H
#define LLVM_CLANG_C_CXERRORCODE_H
#include "clang-c/ExternC.h"
#include "clang-c/Platform.h"
LLVM_CLANG_C_EXTERN_C_BEGIN
/**
* Error codes returned by libclang routines.
*
* Zero (\c CXError_Success) is the only error code indicating success. Other
* error codes, including not yet assigned non-zero values, indicate errors.
*/
enum CXErrorCode {
/**
* No error.
*/
CXError_Success = 0,
/**
* A generic error code, no further details are available.
*
* Errors of this kind can get their own specific error codes in future
* libclang versions.
*/
CXError_Failure = 1,
/**
* libclang crashed while performing the requested operation.
*/
CXError_Crashed = 2,
/**
* The function detected that the arguments violate the function
* contract.
*/
CXError_InvalidArguments = 3,
/**
* An AST deserialization error has occurred.
*/
CXError_ASTReadError = 4,
/**
* \brief A refactoring action is not available at the given location
* or in the given source range.
*/
CXError_RefactoringActionUnavailable = 5,
/**
* \brief A refactoring action is not able to use the given name because
* it contains an unexpected number of strings.
*/
CXError_RefactoringNameSizeMismatch = 6,
/**
* \brief A name of a symbol is invalid, i.e. it is reserved by the source
* language and can't be used as a name for this symbol.
*/
CXError_RefactoringNameInvalid = 7
};
/**
* Represents an error with error code and description string.
*/
typedef struct CXOpaqueError *CXError;
/**
* \returns the error code.
*/
CINDEX_LINKAGE enum CXErrorCode clang_Error_getCode(CXError);
/**
* \returns the error description string.
*/
CINDEX_LINKAGE const char *clang_Error_getDescription(CXError);
/**
* Dispose of a \c CXError object.
*/
CINDEX_LINKAGE void clang_Error_dispose(CXError);
LLVM_CLANG_C_EXTERN_C_END
#endif
|
