1*a28cd43dSSascha Wildner /*
2*a28cd43dSSascha Wildner  * Copyright (c) 2016-2020, Yann Collet, Facebook, Inc.
3*a28cd43dSSascha Wildner  * All rights reserved.
4*a28cd43dSSascha Wildner  *
5*a28cd43dSSascha Wildner  * This source code is licensed under both the BSD-style license (found in the
6*a28cd43dSSascha Wildner  * LICENSE file in the root directory of this source tree) and the GPLv2 (found
7*a28cd43dSSascha Wildner  * in the COPYING file in the root directory of this source tree).
8*a28cd43dSSascha Wildner  * You may select, at your option, one of the above-listed licenses.
9*a28cd43dSSascha Wildner  */
10*a28cd43dSSascha Wildner 
11*a28cd43dSSascha Wildner /* Note : this module is expected to remain private, do not expose it */
12*a28cd43dSSascha Wildner 
13*a28cd43dSSascha Wildner #ifndef ERROR_H_MODULE
14*a28cd43dSSascha Wildner #define ERROR_H_MODULE
15*a28cd43dSSascha Wildner 
16*a28cd43dSSascha Wildner #if defined (__cplusplus)
17*a28cd43dSSascha Wildner extern "C" {
18*a28cd43dSSascha Wildner #endif
19*a28cd43dSSascha Wildner 
20*a28cd43dSSascha Wildner 
21*a28cd43dSSascha Wildner /* ****************************************
22*a28cd43dSSascha Wildner *  Dependencies
23*a28cd43dSSascha Wildner ******************************************/
24*a28cd43dSSascha Wildner #include "zstd_deps.h"    /* size_t */
25*a28cd43dSSascha Wildner #include "zstd_errors.h"  /* enum list */
26*a28cd43dSSascha Wildner 
27*a28cd43dSSascha Wildner 
28*a28cd43dSSascha Wildner /* ****************************************
29*a28cd43dSSascha Wildner *  Compiler-specific
30*a28cd43dSSascha Wildner ******************************************/
31*a28cd43dSSascha Wildner #if defined(__GNUC__)
32*a28cd43dSSascha Wildner #  define ERR_STATIC static __attribute__((unused))
33*a28cd43dSSascha Wildner #elif defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
34*a28cd43dSSascha Wildner #  define ERR_STATIC static inline
35*a28cd43dSSascha Wildner #elif defined(_MSC_VER)
36*a28cd43dSSascha Wildner #  define ERR_STATIC static __inline
37*a28cd43dSSascha Wildner #else
38*a28cd43dSSascha Wildner #  define ERR_STATIC static  /* this version may generate warnings for unused static functions; disable the relevant warning */
39*a28cd43dSSascha Wildner #endif
40*a28cd43dSSascha Wildner 
41*a28cd43dSSascha Wildner 
42*a28cd43dSSascha Wildner /*-****************************************
43*a28cd43dSSascha Wildner *  Customization (error_public.h)
44*a28cd43dSSascha Wildner ******************************************/
45*a28cd43dSSascha Wildner typedef ZSTD_ErrorCode ERR_enum;
46*a28cd43dSSascha Wildner #define PREFIX(name) ZSTD_error_##name
47*a28cd43dSSascha Wildner 
48*a28cd43dSSascha Wildner 
49*a28cd43dSSascha Wildner /*-****************************************
50*a28cd43dSSascha Wildner *  Error codes handling
51*a28cd43dSSascha Wildner ******************************************/
52*a28cd43dSSascha Wildner #undef ERROR   /* already defined on Visual Studio */
53*a28cd43dSSascha Wildner #define ERROR(name) ZSTD_ERROR(name)
54*a28cd43dSSascha Wildner #define ZSTD_ERROR(name) ((size_t)-PREFIX(name))
55*a28cd43dSSascha Wildner 
ERR_isError(size_t code)56*a28cd43dSSascha Wildner ERR_STATIC unsigned ERR_isError(size_t code) { return (code > ERROR(maxCode)); }
57*a28cd43dSSascha Wildner 
ERR_getErrorCode(size_t code)58*a28cd43dSSascha Wildner ERR_STATIC ERR_enum ERR_getErrorCode(size_t code) { if (!ERR_isError(code)) return (ERR_enum)0; return (ERR_enum) (0-code); }
59*a28cd43dSSascha Wildner 
60*a28cd43dSSascha Wildner /* check and forward error code */
61*a28cd43dSSascha Wildner #define CHECK_V_F(e, f) size_t const e = f; if (ERR_isError(e)) return e
62*a28cd43dSSascha Wildner #define CHECK_F(f)   { CHECK_V_F(_var_err__, f); }
63*a28cd43dSSascha Wildner 
64*a28cd43dSSascha Wildner 
65*a28cd43dSSascha Wildner /*-****************************************
66*a28cd43dSSascha Wildner *  Error Strings
67*a28cd43dSSascha Wildner ******************************************/
68*a28cd43dSSascha Wildner 
69*a28cd43dSSascha Wildner const char* ERR_getErrorString(ERR_enum code);   /* error_private.c */
70*a28cd43dSSascha Wildner 
ERR_getErrorName(size_t code)71*a28cd43dSSascha Wildner ERR_STATIC const char* ERR_getErrorName(size_t code)
72*a28cd43dSSascha Wildner {
73*a28cd43dSSascha Wildner     return ERR_getErrorString(ERR_getErrorCode(code));
74*a28cd43dSSascha Wildner }
75*a28cd43dSSascha Wildner 
76*a28cd43dSSascha Wildner #if defined (__cplusplus)
77*a28cd43dSSascha Wildner }
78*a28cd43dSSascha Wildner #endif
79*a28cd43dSSascha Wildner 
80*a28cd43dSSascha Wildner #endif /* ERROR_H_MODULE */
81