Yann Collet | 32fb407 | 2017-08-18 16:52:05 -0700 | [diff] [blame^] | 1 | /* |
Yann Collet | 4ded9e5 | 2016-08-30 10:04:33 -0700 | [diff] [blame] | 2 | * Copyright (c) 2016-present, Yann Collet, Facebook, Inc. |
| 3 | * All rights reserved. |
| 4 | * |
Yann Collet | 32fb407 | 2017-08-18 16:52:05 -0700 | [diff] [blame^] | 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). |
Yann Collet | 4ded9e5 | 2016-08-30 10:04:33 -0700 | [diff] [blame] | 8 | */ |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 9 | |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 10 | /* Note : this module is expected to remain private, do not expose it */ |
| 11 | |
| 12 | #ifndef ERROR_H_MODULE |
| 13 | #define ERROR_H_MODULE |
| 14 | |
| 15 | #if defined (__cplusplus) |
| 16 | extern "C" { |
| 17 | #endif |
| 18 | |
| 19 | |
Yann Collet | 72bff50 | 2016-02-03 12:06:24 +0100 | [diff] [blame] | 20 | /* **************************************** |
| 21 | * Dependencies |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 22 | ******************************************/ |
Yann Collet | 72bff50 | 2016-02-03 12:06:24 +0100 | [diff] [blame] | 23 | #include <stddef.h> /* size_t */ |
Yann Collet | a17fd73 | 2016-10-11 16:41:09 -0700 | [diff] [blame] | 24 | #include "zstd_errors.h" /* enum list */ |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 25 | |
| 26 | |
Yann Collet | 72bff50 | 2016-02-03 12:06:24 +0100 | [diff] [blame] | 27 | /* **************************************** |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 28 | * Compiler-specific |
| 29 | ******************************************/ |
| 30 | #if defined(__GNUC__) |
| 31 | # define ERR_STATIC static __attribute__((unused)) |
| 32 | #elif defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */) |
| 33 | # define ERR_STATIC static inline |
| 34 | #elif defined(_MSC_VER) |
| 35 | # define ERR_STATIC static __inline |
| 36 | #else |
| 37 | # define ERR_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */ |
| 38 | #endif |
| 39 | |
| 40 | |
Yann Collet | 72bff50 | 2016-02-03 12:06:24 +0100 | [diff] [blame] | 41 | /*-**************************************** |
Yann Collet | de406ee | 2016-03-20 15:46:10 +0100 | [diff] [blame] | 42 | * Customization (error_public.h) |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 43 | ******************************************/ |
Yann Collet | 982ffc7 | 2016-02-05 02:33:10 +0100 | [diff] [blame] | 44 | typedef ZSTD_ErrorCode ERR_enum; |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 45 | #define PREFIX(name) ZSTD_error_##name |
| 46 | |
Yann Collet | 72bff50 | 2016-02-03 12:06:24 +0100 | [diff] [blame] | 47 | |
| 48 | /*-**************************************** |
| 49 | * Error codes handling |
| 50 | ******************************************/ |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 51 | #ifdef ERROR |
Yann Collet | 72bff50 | 2016-02-03 12:06:24 +0100 | [diff] [blame] | 52 | # undef ERROR /* reported already defined on VS 2015 (Rich Geldreich) */ |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 53 | #endif |
Yann Collet | de406ee | 2016-03-20 15:46:10 +0100 | [diff] [blame] | 54 | #define ERROR(name) ((size_t)-PREFIX(name)) |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 55 | |
| 56 | ERR_STATIC unsigned ERR_isError(size_t code) { return (code > ERROR(maxCode)); } |
| 57 | |
Yann Collet | c75e4c2 | 2016-05-10 17:47:11 +0200 | [diff] [blame] | 58 | ERR_STATIC ERR_enum ERR_getErrorCode(size_t code) { if (!ERR_isError(code)) return (ERR_enum)0; return (ERR_enum) (0-code); } |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 59 | |
Yann Collet | 72bff50 | 2016-02-03 12:06:24 +0100 | [diff] [blame] | 60 | |
| 61 | /*-**************************************** |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 62 | * Error Strings |
| 63 | ******************************************/ |
| 64 | |
Yann Collet | ef2357d | 2016-10-11 17:24:50 -0700 | [diff] [blame] | 65 | const char* ERR_getErrorString(ERR_enum code); /* error_private.c */ |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 66 | |
Yann Collet | c75e4c2 | 2016-05-10 17:47:11 +0200 | [diff] [blame] | 67 | ERR_STATIC const char* ERR_getErrorName(size_t code) |
| 68 | { |
| 69 | return ERR_getErrorString(ERR_getErrorCode(code)); |
| 70 | } |
Yann Collet | 977f1f3 | 2016-01-21 15:38:47 +0100 | [diff] [blame] | 71 | |
| 72 | #if defined (__cplusplus) |
| 73 | } |
| 74 | #endif |
| 75 | |
| 76 | #endif /* ERROR_H_MODULE */ |