iqr_api.h

Go to the documentation of this file.

#ifndef IQR_API_H
#define IQR_API_H

#include <limits.h>

/* Compatibility check. */
#if CHAR_BIT != 8
#   error "This library assumes 8-bit byte sizes."
#endif

/* User defined overrides. */
#if defined(IQR_UNENFORCED_RETURNS)
#   define IQR_MUST_CHECK
#endif

#if defined(IQR_IGNORE_DEPRECATED)
#   define IQR_DEPRECATED
#   define IQR_DEPRECATED_MSG
#endif

/* Function Decorator Macros */
#if defined(__GNUC__) || defined(__clang__)
#   if defined(_WIN32) || defined(_WIN64)
#       define IQR_EXPORT               __attribute__((dllexport))
#       define IQR_IMPORT               __attribute__((dllimport))
#   else
#       define IQR_EXPORT               __attribute__((visibility("default")))
#       define IQR_IMPORT
#   endif
#   if !defined(IQR_UNENFORCED_RETURNS)
#       define IQR_MUST_CHECK           __attribute__((warn_unused_result))
#   endif
#   if !defined(IQR_IGNORE_DEPRECATED)
#       define IQR_DEPRECATED           __attribute__((deprecated))
#       define IQR_DEPRECATED_MSG(msg)  __attribute__((deprecated(msg)))
#   endif
#elif defined(_MSC_VER) || defined(__VISUAL_C__)
#   define IQR_EXPORT                   __declspec(dllexport)
#   define IQR_IMPORT                   __declspec(dllimport)
#   if !defined(IQR_UNENFORCED_RETURNS)
#       define IQR_MUST_CHECK           _Check_return_
#   endif
#   if !defined(IQR_IGNORE_DEPRECATED)
#       define IQR_DEPRECATED           __declspec(deprecated)
#       define IQR_DEPRECATED_MSG(msg)  __declspec(deprecated(msg))
#   endif
#elif defined(CPPCHECK)
#   define IQR_EXPORT
#   define IQR_IMPORT
#   define IQR_MUST_CHECK
#   define IQR_DEPRECATED
#   define IQR_DEPRECATED_MSG(msg)
#else
#   error "Unsupported compiler suite!"
#endif

/* API */
#if defined(IQR_ISARA_BUILD)
#   define IQR_API                      IQR_EXPORT IQR_MUST_CHECK
#   define IQR_API_UNENFORCED_RETURN    IQR_EXPORT
#   define IQR_EXTERN                   IQR_EXPORT extern
#else
#   define IQR_API                      IQR_MUST_CHECK
#   define IQR_API_UNENFORCED_RETURN
#   if defined(IQR_DLL)
#       define IQR_EXTERN               IQR_IMPORT extern
#   else
#       define IQR_EXTERN               extern
#   endif
#endif

#endif /* IQR_API_H */