qassert.h

Go to the documentation of this file.

/*============================================================================
* QP/C Real-Time Embedded Framework (RTEF)
* Copyright (C) 2005 Quantum Leaps, LLC. All rights reserved.
*
* SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-QL-commercial
*
* This software is dual-licensed under the terms of the open source GNU
* General Public License version 3 (or any later version), or alternatively,
* under the terms of one of the closed source Quantum Leaps commercial
* licenses.
*
* The terms of the open source GNU General Public License version 3
* can be found at: <www.gnu.org/licenses/gpl-3.0>
*
* The terms of the closed source Quantum Leaps commercial licenses
* can be found at: <www.state-machine.com/licensing>
*
* Redistributions in source code must retain this top-level comment block.
* Plagiarizing this software to sidestep the license obligations is illegal.
*
* Contact information:
* <www.state-machine.com>
* <info@state-machine.com>
============================================================================*/
#ifndef QASSERT_H
#define QASSERT_H
 
#ifdef Q_NASSERT /* Q_NASSERT defined--assertion checking disabled */
 
    /* provide dummy (empty) definitions that don't generate any code... */
    #define Q_DEFINE_THIS_FILE
    #define Q_DEFINE_THIS_MODULE(name_)
    #define Q_ASSERT(test_)             ((void)0)
    #define Q_ASSERT_ID(id_, test_)     ((void)0)
    #define Q_ALLEGE(test_)             ((void)(test_))
    #define Q_ALLEGE_ID(id_, test_)     ((void)(test_))
    #define Q_ERROR()                   ((void)0)
    #define Q_ERROR_ID(id_)             ((void)0)
 
#else  /* Q_NASSERT not defined--assertion checking enabled */
 
#ifndef QP_VERSION /* is quassert.h used outside QP? */
 
    /* provide typedefs so that qassert.h could be used "standalone"... */
 
    typedef int int_t;
 
#endif
 
    #define Q_DEFINE_THIS_FILE \
        static char const Q_this_module_[] = __FILE__;
 
    #define Q_DEFINE_THIS_MODULE(name_) \
        static char const Q_this_module_[] = name_;
 
    #define Q_ASSERT(test_) ((test_) \
        ? (void)0 : Q_onAssert(&Q_this_module_[0], __LINE__))
 
    #define Q_ASSERT_ID(id_, test_) ((test_) \
        ? (void)0 : Q_onAssert(&Q_this_module_[0], (id_)))
 
    #define Q_ALLEGE(test_)    Q_ASSERT(test_)
 
    #define Q_ALLEGE_ID(id_, test_) Q_ASSERT_ID((id_), (test_))
 
    #define Q_ERROR() \
        Q_onAssert(&Q_this_module_[0], __LINE__)
 
    #define Q_ERROR_ID(id_) \
        Q_onAssert(&Q_this_module_[0], (id_))
 
#endif /* Q_NASSERT */
 
/*==========================================================================*/
#ifdef __cplusplus
    extern "C" {
#endif
 
#ifndef Q_NORETURN
    #define Q_NORETURN    void
#endif /*  Q_NORETURN */
 
Q_NORETURN Q_onAssert(char const * const module, int_t const location);
 
#ifdef __cplusplus
    }
#endif
 
#define Q_REQUIRE(test_)         Q_ASSERT(test_)
 
#define Q_REQUIRE_ID(id_, test_) Q_ASSERT_ID((id_), (test_))
 
#define Q_ENSURE(test_) Q_ASSERT(test_)
 
#define Q_ENSURE_ID(id_, test_) Q_ASSERT_ID((id_), (test_))
 
#define Q_INVARIANT(test_) Q_ASSERT(test_)
 
#define Q_INVARIANT_ID(id_, test_) Q_ASSERT_ID((id_), (test_))
 
#define Q_ASSERT_STATIC(test_) \
    extern int_t Q_assert_static[(test_) ? 1 : -1]
 
#define Q_ASSERT_COMPILE(test_) Q_ASSERT_STATIC(test_)
 
#define Q_DIM(array_) (sizeof(array_) / sizeof((array_)[0U]))
 
#endif /* QASSERT_H */