gls_class_invariant.h

Go to the documentation of this file.

#ifndef _GLS_CLASS_INVARIANT_H
#define _GLS_CLASS_INVARIANT_H

/*! \file gls_class_invariant.h
\brief  This header defines a GLS_DEBUG only macro for facilitating evaluating class invariants in
        the GL Studio DO-178B Runtime Library.

\par Copyright Information
Copyright (C) 1999-2012 The DiSTI Corporation<br>
Orlando, FL USA<br>
All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of
DiSTI, and embodies substantial creative efforts as well as confidential
information, ideas, and expressions.

  Permission to use, and copy this software and its documentation for any
purpose is hereby granted per the Distribution Agreement and/or the Licensing
Agreement signed with DiSTI. This permission is granted provided that:
    1.  The above copyright notice appears in all copies.
    2.  That both the copyright notice and this permission notice appear in
        the supporting documentation.
    3.  That the names DiSTI and GL Studio not be used in advertising or
        publicity pertaining to distribution of the software without specific,
        written prior permission of DiSTI.
 
  Permission to modify the software is granted, but not the right to
distribute the source code whether modified, or non-modified.  Modifying the
software might invalidate the DO-178B certification package.

  Permission to distribute binaries produced by compiling source code, or
modified source code is granted, provided you:
    1.  Provide your name and address as the primary contact for the support
        of your modified version.
    2.  Retain our contact information in regard to use of the base software. 

   DiSTI does not provide warranty for this software or guarantee that it
satisfies any specification or requirement unless otherwise stated in a
specific contractual arrangement between the customer and DiSTI.

*/

#include "gls_include.h"

#if defined( GLS_DEBUG )

/** declare a nested ClassInvariant evaluator class for a class named ClassName */
#define GLS_CLASS_INVARIANT_DECLARATION( ClassName )                            \
    class ClassInvariant                                                        \
    {                                                                           \
    public:                                                                     \
        ClassInvariant( const ClassName &inst ) :                               \
            _inst( inst )                                                       \
        {                                                                       \
            _inst.Invariant();                                                  \
        }                                                                       \
                                                                                \
        ~ClassInvariant()                                                       \
        {                                                                       \
            _inst.Invariant();                                                  \
        }                                                                       \
                                                                                \
    protected:                                                                  \
        const ClassName &_inst;                                                 \
    };                                                                          \
    virtual void Invariant( void ) const;

/** declare an instance of a ClassInvariant evaluator for a class named ClassName */
#define GLS_CLASS_INVARIANT_CHECK( ClassName )      ClassName::ClassInvariant localScopeClassInvariant( *this )

/** explicitly call ( non virtual call ) invariant method on the class named ClassName.
  * Typically used at the end of a constructor to ensure invariant for this class without
  * checking a subclass invariant through a virtual call to a class that is not constructed
  * yet. */
#define GLS_CLASS_INVARIANT_EVALUATE( ClassName )   ClassName::Invariant()

#else // GLS_DEBUG is not defined

/** ClassInvariant evaluator class is disabled when GLS_DEBUG is not defined */
#define GLS_CLASS_INVARIANT_DECLARATION( ClassName )
#define GLS_CLASS_INVARIANT_CHECK( ClassName )
#define GLS_CLASS_INVARIANT_EVALUATE( ClassName )

#endif // GLS_DEBUG

#endif // _GLS_CLASS_INVARIANT_H