| 1 | /*===-- clang-c/CXErrorCode.h - C Index Error Codes --------------*- C -*-===*\ |
|---|---|
| 2 | |* *| |
| 3 | |* Part of the LLVM Project, under the Apache License v2.0 with LLVM *| |
| 4 | |* Exceptions. *| |
| 5 | |* See https://llvm.org/LICENSE.txt for license information. *| |
| 6 | |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *| |
| 7 | |* *| |
| 8 | |*===----------------------------------------------------------------------===*| |
| 9 | |* *| |
| 10 | |* This header provides the CXErrorCode enumerators. *| |
| 11 | |* *| |
| 12 | \*===----------------------------------------------------------------------===*/ |
| 13 | |
| 14 | #ifndef LLVM_CLANG_C_CXERRORCODE_H |
| 15 | #define LLVM_CLANG_C_CXERRORCODE_H |
| 16 | |
| 17 | #include "clang-c/Platform.h" |
| 18 | |
| 19 | #ifdef __cplusplus |
| 20 | extern "C" { |
| 21 | #endif |
| 22 | |
| 23 | /** |
| 24 | * Error codes returned by libclang routines. |
| 25 | * |
| 26 | * Zero (\c CXError_Success) is the only error code indicating success. Other |
| 27 | * error codes, including not yet assigned non-zero values, indicate errors. |
| 28 | */ |
| 29 | enum CXErrorCode { |
| 30 | /** |
| 31 | * No error. |
| 32 | */ |
| 33 | CXError_Success = 0, |
| 34 | |
| 35 | /** |
| 36 | * A generic error code, no further details are available. |
| 37 | * |
| 38 | * Errors of this kind can get their own specific error codes in future |
| 39 | * libclang versions. |
| 40 | */ |
| 41 | CXError_Failure = 1, |
| 42 | |
| 43 | /** |
| 44 | * libclang crashed while performing the requested operation. |
| 45 | */ |
| 46 | CXError_Crashed = 2, |
| 47 | |
| 48 | /** |
| 49 | * The function detected that the arguments violate the function |
| 50 | * contract. |
| 51 | */ |
| 52 | CXError_InvalidArguments = 3, |
| 53 | |
| 54 | /** |
| 55 | * An AST deserialization error has occurred. |
| 56 | */ |
| 57 | CXError_ASTReadError = 4 |
| 58 | }; |
| 59 | |
| 60 | #ifdef __cplusplus |
| 61 | } |
| 62 | #endif |
| 63 | #endif |
| 64 | |
| 65 |