DDD_ClassInvariant.h

Go to the documentation of this file.

#ifndef _DDD_CLASS_INVARIANT_H
#define _DDD_CLASS_INVARIANT_H

/*! \file DDD_ClassInvariant.h
  \brief  This header defines a DDD_DEBUG only macro for facilitating evaluating class invariants in
          the Data Director Runtime Library.

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#if defined( DDD_DEBUG )

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

/** declare an instance of a ClassInvariant evaluator for a class named ClassName */
#define DDD_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 DDD_CLASS_INVARIANT_EVALUATE( ClassName )   ClassName::Invariant()

#else // GLS_DEBUG is not defined

/** ClassInvariant evaluator class is disabled when GLS_DEBUG is not defined */
#define DDD_CLASS_INVARIANT_DECLARATION( ClassName )
#define DDD_CLASS_INVARIANT_CHECK( ClassName )
#define DDD_CLASS_INVARIANT_EVALUATE( ClassName )

#endif // GLS_DEBUG

#endif // _GLS_CLASS_INVARIANT_H