/usr/include/cjose/error.h is in libcjose-dev 0.4.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | /**
* \file
* \brief
* Datatypes and functions for error reporting.
*
* Copyrights
*
* Portions created or assigned to Cisco Systems, Inc. are
* Copyright (c) 2014-2016 Cisco Systems, Inc. All Rights Reserved.
*/
#ifndef CJOSE_ERROR_H
#define CJOSE_ERROR_H
#ifdef __cplusplus
extern "C"
{
#endif
/**
* Temporarily disable compiler warnings, if possible (>=gcc-4.6).
*
* In some cases (particularly within macros), certain compiler warnings are
* unavoidable. In order to allow these warnings to be treated as errors in
* most cases, these macros will disable particular warnings only during
* specific points in the compilation.
*/
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
# define GCC_END_IGNORED_WARNING _Pragma("GCC diagnostic pop")
# define GCC_BEGIN_IGNORED_WARNING_ADDRESS \
_Pragma("GCC diagnostic push"); \
_Pragma("GCC diagnostic ignored \"-Waddress\"")
# define GCC_END_IGNORED_WARNING_ADDRESS GCC_END_IGNORED_WARNING
#else
# define GCC_BEGIN_IGNORED_WARNING_ADDRESS
# define GCC_END_IGNORED_WARNING_ADDRESS
#endif /* defined(__GNUC__) && (__GNUC__ > 3) && (__GNUC_MINOR__ > 5) */
/**
* Enumeration of defined error codes.
*/
typedef enum
{
/** No error */
CJOSE_ERR_NONE = 0,
/** argument was invalid (beyond invariants) */
CJOSE_ERR_INVALID_ARG,
/** context is not in a valid state */
CJOSE_ERR_INVALID_STATE,
/** out of memory */
CJOSE_ERR_NO_MEMORY,
/** an error returned from the crypto libraries */
CJOSE_ERR_CRYPTO,
} cjose_errcode;
/**
* An instance of an error context. Unlike other structures, it
* is the API user's responsibility to allocate the structure; however
* the values provided are considered constants, and MUST NOT be
* deallocated.
*/
typedef struct
{
/** The error code */
cjose_errcode code;
/** The human readable message for the error code */
const char * message;
/** The function where the error occured, or "<unknown>"
if it cannot be determined */
const char * function;
/** The file where the error occured */
const char * file;
/** The line number in the file where the error occured */
unsigned long line;
} cjose_err;
/**
* Retrieves the error message for the given error code.
*
* \param code The error code to lookup
* \retval const char * The message for {code}
*/
const char * cjose_err_message(cjose_errcode code);
/**
* \def CJOSE_ERROR(err, code)
*
* Macro to initialize an error context.
*
* \param err The pointer to the error context, or NULL if none
* \param errcode The error code
*/
#define CJOSE_ERROR(err, errcode) \
GCC_BEGIN_IGNORED_WARNING_ADDRESS \
if ((err) != NULL && (errcode) != CJOSE_ERR_NONE) \
{ \
(err)->code = (errcode); \
(err)->message = cjose_err_message((errcode)); \
(err)->function = __func__; \
(err)->file = __FILE__; \
(err)->line = __LINE__; \
} \
GCC_END_IGNORED_WARNING_ADDRESS
#ifdef __cplusplus
}
#endif
#endif /* CJOSE_ERROR_H */
|