defines.h

Go to the documentation of this file.

/* Libmacro - A multi-platform, extendable macro and hotkey C library
  Copyright (C) 2013 Jonathan Pelletier, New Paradigm Software

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef MCR_DEFINES_H_
#define MCR_DEFINES_H_

#ifdef __cplusplus
#include <cerrno>
#include <ctime>
#include <cstdbool>
#include <cstdint>
#ifdef MCR_DEBUG
    #include <cassert>
#endif
extern "C" {
#else
#include <errno.h>
#include <time.h>
#include <stdbool.h>
#include <stdint.h>
#ifdef MCR_DEBUG
    #include <assert.h>
#endif
#endif

/* Doxygen in-doxy-comment references */
#ifndef reterr

    #define reterr int
    #undef reterr
#endif

#ifndef retind

    #define retind size_t
    #undef retind
#endif

#ifndef retid

    #define retid size_t
    #undef retid
#endif

#ifndef retcmp

    #define retcmp int
    #undef retcmp
#endif

#ifndef opt

    #define opt
    #undef opt
#endif

#ifndef ctor

    #define ctor
    #undef ctor
#endif
#ifndef dtor

    #define dtor
    #undef dtor
#endif

#ifndef mcr_cpp_only

    #define mcr_cpp_only
    #undef mcr_cpp_only
#endif

#ifndef mcr_platform

    #define mcr_platform
    #undef mcr_platform
#endif

#ifndef mcr_future

    #define mcr_future
    #undef mcr_future
#endif

#ifndef MCR_PLATFORM_DEFINES_H

    #define MCR_PLATFORM_DEFINES_H
    #undef MCR_PLATFORM_DEFINES_H
#endif

/* Library export */
#ifdef MCR_PLATFORM_WINDOWS
    #define MCR_EXPORT __declspec(dllexport)
    #define MCR_IMPORT __declspec(dllimport)
#else
    #define MCR_EXPORT __attribute__((visibility("default")))
    #define MCR_IMPORT __attribute__((visibility("default")))
#endif

#ifndef MCR_API
    #ifdef MCR_STATIC
        #define MCR_API
    #else
        #ifdef LIBMACRO_LIBRARY
            #define MCR_API MCR_EXPORT
        #else
            #define MCR_API MCR_IMPORT
        #endif
    #endif
#endif

#ifndef MCR_INLINE
    #ifdef _MSC_VER

        #define MCR_INLINE __inline
    #else
        #define MCR_INLINE inline
    #endif
#endif


/* Rest of file is helpers and finally the platform definitions. */


#define MCR_STR_HELPER(x) #x

#define MCR_STR(x) MCR_STR_HELPER(x)

#define MCR_EXP_HELPER(x) x

#define MCR_EXP(x) MCR_EXP_HELPER(x)

#define MCR_TOKEN_HELPER(x, y) x ##y
#define MCR_SNAKE_HELPER(x, y) x ##_ ##y

#define MCR_TOKEN(x, y) MCR_TOKEN_HELPER(x, y)

#define MCR_SNAKE(x, y) MCR_SNAKE_HELPER(x, y)

#ifndef MCR_LINE

    #define MCR_LINE __FILE__ "(" MCR_STR(__LINE__) ")"
#endif

#ifndef MCR_PLATFORM
    #define MCR_PLATFORM none
    #pragma message "Warning: MCR_PLATFORM is not defined.  Please provide MCR_PLATFORM as a preprocessor definition for your platform."
    #include "mcr/warn.h"
#endif
#ifndef UNUSED

    #define UNUSED(x) ((void)(x))
#endif
#ifndef MCR_CMP

    #define MCR_CMP(lhs, rhs) (((lhs) > (rhs)) - ((lhs) < (rhs)))
#endif
#ifndef MCR_CMP_CAST

    #define MCR_CMP_CAST(casting, lhs, rhs) MCR_CMP(casting(lhs), casting(rhs))
#endif
#ifndef MCR_CMP_PTR

#define MCR_CMP_PTR(T, lhsPtr, rhsPtr) (lhsPtr && rhsPtr ? \
        MCR_CMP(*mcr_castpt(T, lhsPtr), *mcr_castpt(T, rhsPtr)) : \
        MCR_CMP(lhsPtr, rhsPtr))
#endif

#ifndef MCR_OFFSET

#define MCR_OFFSET(structDecl, memberName, outSizeVariable) \
{ \
    structDecl *__internalStruct = mcr_null; \
    outSizeVariable = mcr_cast(size_t, &(__internalStruct).memberName); \
}
#endif

#ifndef mcr_cast
    #ifdef __cplusplus

        #define mcr_cast(T, obj) static_cast<T>(obj)

        #define mcr_castpt(T, obj) reinterpret_cast<T *>(obj)

        #define mcr_null nullptr
    #else
        #define mcr_cast(T, obj) ((T)(obj))
        #define mcr_castpt(T, obj) ((T *)(obj))
        #define mcr_null NULL
    #endif
#endif
/* Debugging definitions */
#ifndef mcr_ddo
    #ifdef MCR_DEBUG

        #define mcr_ddo(stuff) stuff
    #else
        /* Empty blocks.  Non-empty interferes with one-liners. */
        #define mcr_ddo(stuff) {}
    #endif
#endif
/* Do function pointer if defined */
#ifndef mcr_ifdo
#define mcr_ifdo(fnPtr, ...) \
    if (fnPtr) { \
        (fnPtr)(__VA_ARGS__); \
    }
#endif
/* Do function pointer if defined and return result */
#ifndef mcr_ifreturndo
#define mcr_ifreturndo(fnPtr, ...) \
    if (fnPtr) { \
        return (fnPtr)(__VA_ARGS__); \
    }
#endif
#ifndef mcr_dprint

    #define mcr_dprint(...) mcr_ddo(printf(__VA_ARGS__))
#endif
#ifndef mcr_dexit

    #define mcr_dexit mcr_ddo({ mcr_dmsg; exit(mcr_err); })
#endif
#ifndef mcr_dmsg

#define mcr_dmsg \
mcr_ddo(fprintf(stderr, "Error %d: " MCR_LINE ", %s: %s.\n", \
        mcr_err, mcr_timestamp(), mcr_error_str(mcr_err)))
#endif
#ifndef mcr_dassert

    #define mcr_dassert(expression) mcr_ddo(assert(expression))
#endif
#ifndef mcr_arrlen

    #define mcr_arrlen(arr) (sizeof(arr) / sizeof(*(arr)))
#endif
#ifndef mcr_errno

#define mcr_errno(fallbackError) { \
    mcr_err = errno; \
    if (!mcr_err) \
        mcr_err = (fallbackError); \
    mcr_dmsg; \
}
#endif
#ifndef mcr_error_return

#define mcr_error_return { \
    mcr_dmsg; \
    return mcr_err; \
}
#endif
#ifndef mcr_error_set

#define mcr_error_set(errorNumber) { \
    mcr_err = (errorNumber); \
    mcr_dmsg; \
}
#endif
#ifndef mcr_error_set_return

#define mcr_error_set_return(errorNumber) { \
    mcr_err = (errorNumber); \
    mcr_dmsg; \
    return errorNumber; \
}
#endif

#ifndef ZERO
    #define ZERO(inst) memset(&(inst), 0, sizeof(inst))
#endif
#ifndef ZERO_PTR
    #define ZERO_PTR(ptr) memset(ptr, 0, sizeof(*(ptr)))
#endif

#ifndef dmsg

    #define dmsg mcr_dmsg
#endif
#ifndef dassert

    #define dassert(expr) mcr_dassert(expr)
#endif
#ifndef arrlen

    #define arrlen(arr) mcr_arrlen(arr)
#endif
#ifndef mset_error

    #define mset_error(errorNumber) mcr_error_set(errorNumber)
#endif
#ifndef error_set_return

    #define error_set_return(errorNumber) mcr_error_set_return(errorNumber)
#endif

#define MCR_MOD_ANY ((unsigned int) ~0)

#ifndef MCR_THREAD_MAX

    #define MCR_THREAD_MAX 0x10
#endif

#ifndef MCR_MACRO_JOIN_TIMEOUT

    #define MCR_MACRO_JOIN_TIMEOUT 2
#endif

#ifndef MCR_MAX_PAUSE_COUNT

    #define MCR_MAX_PAUSE_COUNT 5
#endif

#define MCR_HIDECHO_ANY mcr_cast(size_t, ~0)

#define MCR_KEY_ANY mcr_cast(int, 0)

#ifndef mcr_throwif

#define mcr_throwif(condition, errorNumber) \
    if (condition) { \
        mcr_dassert(condition); \
        ::mcr::throwError(MCR_LINE, errorNumber); \
    }
#endif

#ifndef mcr_assert_receive_function

#define mcr_assert_receive_function(receiver, receiveFnc) \
    mcr_throwif(!receiveFnc, EFAULT); \
    mcr_throwif((receiverFnc == mcr_Trigger_receive \
                 || receiverFnc == mcr_Macro_receive) && !receiver, EINVAL);
#endif

#define MCR_DECL_INTERFACE(className) \
    className() = default; \
    className(const className &) = default; \
    virtual ~className() = default; \
    className &operator =(const className &) = default;

#ifdef __cplusplus
}
#endif

#ifdef MCR_PLATFORM_DEFINES_H
#include MCR_PLATFORM_DEFINES_H
#endif
#ifndef MCR_PLATFORM_H
#define MCR_PLATFORM_H MCR_STR(mcr/MCR_PLATFORM/p_libmacro.h)
#endif

#endif