1 /* 2 * Copyright (c) 2016-present, Yann Collet, Facebook, Inc. 3 * All rights reserved. 4 * 5 * This source code is licensed under both the BSD-style license (found in the 6 * LICENSE file in the root directory of this source tree) and the GPLv2 (found 7 * in the COPYING file in the root directory of this source tree). 8 * You may select, at your option, one of the above-listed licenses. 9 */ 10 11 #ifndef ZSTD_ERRORS_H_398273423 12 #define ZSTD_ERRORS_H_398273423 13 14 #if defined (__cplusplus) 15 extern "C" { 16 #endif 17 18 /*===== dependency =====*/ 19 #include <stddef.h> /* size_t */ 20 21 22 /* ===== ZSTDERRORLIB_API : control library symbols visibility ===== */ 23 #ifndef ZSTDERRORLIB_VISIBILITY 24 # if defined(__GNUC__) && (__GNUC__ >= 4) 25 # define ZSTDERRORLIB_VISIBILITY __attribute__ ((visibility ("default"))) 26 # else 27 # define ZSTDERRORLIB_VISIBILITY 28 # endif 29 #endif 30 #if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1) 31 # define ZSTDERRORLIB_API __declspec(dllexport) ZSTDERRORLIB_VISIBILITY 32 #elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1) 33 # define ZSTDERRORLIB_API __declspec(dllimport) ZSTDERRORLIB_VISIBILITY /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/ 34 #else 35 # define ZSTDERRORLIB_API ZSTDERRORLIB_VISIBILITY 36 #endif 37 38 /*-**************************************** 39 * error codes list 40 * note : this API is still considered unstable 41 * and shall not be used with a dynamic library. 42 * only static linking is allowed 43 ******************************************/ 44 typedef enum { 45 ZSTD_error_no_error = 0, 46 ZSTD_error_GENERIC = 1, 47 ZSTD_error_prefix_unknown = 10, 48 ZSTD_error_version_unsupported = 12, 49 ZSTD_error_frameParameter_unsupported = 14, 50 ZSTD_error_frameParameter_windowTooLarge = 16, 51 ZSTD_error_corruption_detected = 20, 52 ZSTD_error_checksum_wrong = 22, 53 ZSTD_error_dictionary_corrupted = 30, 54 ZSTD_error_dictionary_wrong = 32, 55 ZSTD_error_dictionaryCreation_failed = 34, 56 ZSTD_error_parameter_unsupported = 40, 57 ZSTD_error_parameter_outOfBound = 42, 58 ZSTD_error_tableLog_tooLarge = 44, 59 ZSTD_error_maxSymbolValue_tooLarge = 46, 60 ZSTD_error_maxSymbolValue_tooSmall = 48, 61 ZSTD_error_stage_wrong = 60, 62 ZSTD_error_init_missing = 62, 63 ZSTD_error_memory_allocation = 64, 64 ZSTD_error_dstSize_tooSmall = 70, 65 ZSTD_error_srcSize_wrong = 72, 66 /* following error codes are not stable and may be removed or changed in a future version */ 67 ZSTD_error_frameIndex_tooLarge = 100, 68 ZSTD_error_seekableIO = 102, 69 ZSTD_error_maxCode = 120 /* never EVER use this value directly, it can change in future versions! Use ZSTD_isError() instead */ 70 } ZSTD_ErrorCode; 71 72 /*! ZSTD_getErrorCode() : 73 convert a `size_t` function result into a `ZSTD_ErrorCode` enum type, 74 which can be used to compare with enum list published above */ 75 ZSTDERRORLIB_API ZSTD_ErrorCode ZSTD_getErrorCode(size_t functionResult); 76 ZSTDERRORLIB_API const char* ZSTD_getErrorString(ZSTD_ErrorCode code); /**< Same as ZSTD_getErrorName, but using a `ZSTD_ErrorCode` enum argument */ 77 78 79 #if defined (__cplusplus) 80 } 81 #endif 82 83 #endif /* ZSTD_ERRORS_H_398273423 */ 84