qassert.h

Go to the documentation of this file.

/*****************************************************************************
* Product:  QP-nano
* Last Updated for Version: 4.2.01
* Date of the Last Update:  Aug 12, 2011
*
*                    Q u a n t u m     L e a P s
*                    ---------------------------
*                    innovating embedded systems
*
* Copyright (C) 2002-2011 Quantum Leaps, LLC. All rights reserved.
*
* This software may be distributed and modified under the terms of the GNU
* General Public License version 2 (GPL) as published by the Free Software
* Foundation and appearing in the file GPL.TXT included in the packaging of
* this file. Please note that GPL Section 2[b] requires that all works based
* on this software must also be made publicly available under the terms of
* the GPL ("Copyleft").
*
* Alternatively, this software may be distributed and modified under the
* terms of Quantum Leaps commercial licenses, which expressly supersede
* the GPL and are specifically designed for licensees interested in
* retaining the proprietary status of their code.
*
* Contact information:
* Quantum Leaps Web site:  http://www.quantum-leaps.com
* e-mail:                  info@quantum-leaps.com
*****************************************************************************/
#ifndef qassert_h
#define qassert_h

#ifdef Q_NASSERT          /* Q_NASSERT defined--assertion checking disabled */

    #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 */

    #ifdef __cplusplus
        extern "C" {
    #endif

    /*lint -sem(Q_onAssert, r_no)                Q_onAssert() never returns */
    void Q_onAssert(char const Q_ROM * const Q_ROM_VAR file, int line);

    #ifdef __cplusplus
        }
    #endif

    #define Q_DEFINE_THIS_FILE \
        static char const Q_ROM Q_ROM_VAR l_this_file[] = __FILE__;

    #define Q_DEFINE_THIS_MODULE(name_) \
        static char const Q_ROM Q_ROM_VAR l_this_file[] = #name_;

    #define Q_ASSERT(test_) \
        if (test_) { \
        } \
        else (Q_onAssert(&l_this_file[0], __LINE__))

    #define Q_ASSERT_ID(id_, test_) \
        if (test_) { \
        } \
        else (Q_onAssert(&l_this_file[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(l_this_file, __LINE__))

    #define Q_ERROR_ID(id_) \
        (Q_onAssert(l_this_file, (id_)))


#endif                                                         /* Q_NASSERT */

#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_COMPILE(test_) \
    extern char Q_assert_compile[(test_) ? 1 : -1]

#endif                                                         /* qassert_h */