basics.h

Go to the documentation of this file.

#ifndef JABBERWERX_BASICS_H
#define JABBERWERX_BASICS_H

#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>


#if defined(_WIN32) || defined(_WIN64)
#  ifdef jabberwerx_EXPORTS
#    define JABBERWERX_API __declspec(dllexport)
#  else
#    define JABBERWERX_API __declspec(dllimport)
#  endif
#else
#  define JABBERWERX_API
#endif

#ifndef UNUSED_PARAM

#  define UNUSED_PARAM(p) ((void)&(p))
#endif // UNUSED_PARAM

#ifndef __GNUC__

#  define __attribute__(x)
#endif // __GNUC__
 
#define PRAGMA(x) _Pragma(#x)

/*
 * 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_BEGIN_IGNORED_WARNING(x) \
     _Pragma("GCC diagnostic push"); \
     PRAGMA(GCC diagnostic ignored #x)
#  define GCC_END_IGNORED_WARNING(x) \
     _Pragma("GCC diagnostic pop")
#else

#  define GCC_BEGIN_IGNORED_WARNING(x)

#  define GCC_END_IGNORED_WARNING(x)
#endif // __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)

/*
 * Macros for calculating standard string lengths.
 *
 * FOO_MAX_WIDTH is at least as wide as the base10 string version of the largest
 * integer value of the relevant type.  A buffer of size FOO_MAX_WIDTH will be
 * large enough to sprintf a variable of the relevant type (including the
 * terminating NULL).
 */
#define BASE10_WIDTH2(s) sizeof(#s)

#define BASE10_WIDTH(s) BASE10_WIDTH2(s)

#define UINT64_MAX_WIDTH BASE10_WIDTH(UINT64_MAX)

#define UINT32_MAX_WIDTH BASE10_WIDTH(UINT32_MAX)

#define JABBERWERX_ERROR(err, errcode) \
    GCC_BEGIN_IGNORED_WARNING(-Waddress) \
        if ((err) != NULL) \
        { \
            (err)->code = (errcode); \
            (err)->message = jw_err_message((errcode)); \
            (err)->function = __func__; \
            (err)->file = __FILE__; \
            (err)->line = __LINE__; \
        } \
    GCC_END_IGNORED_WARNING(-Waddress)


typedef enum
{
    JW_ERR_NONE = 0,
    JW_ERR_INVALID_ARG,
    JW_ERR_INVALID_STATE,
    JW_ERR_NO_MEMORY,
    JW_ERR_OVERFLOW,
    JW_ERR_SOCKET_CONNECT,
    JW_ERR_BAD_FORMAT,
    JW_ERR_PROTOCOL,
    JW_ERR_TIMEOUT,
    JW_ERR_NOT_AUTHORIZED,
    JW_ERR_NOT_IMPLEMENTED,
    JW_ERR_USER,
} jw_errcode;

typedef struct
{
    jw_errcode   code;
    const char  *message;
    const char  *function;
    const char  *file;
    unsigned long line;
} jw_err;


#ifdef __cplusplus
extern "C"
{
#endif

JABBERWERX_API const char * jw_err_message(jw_errcode code);

JABBERWERX_API const char * jw_version(bool full);

JABBERWERX_API bool jw_global_init(jw_err *err);

JABBERWERX_API void jw_global_cleanup();

#ifdef __cplusplus
}
#endif

#endif /* JABBERWERX_BASICS_H */