---

verifier.hh

/*
*  Name:      verifier.hh
*  Author:    Rafael Jesus Alcantara Perez
*  Summary:   Invariant Base verifier
*  Date:      $Date: 2003/08/08 23:30:33 $
*  Revision:  $Revision: 1.2 $
*
*  Copyright (C) 1994-2002  Rafael Jesus Alcantara Perez <rafa@dedalo-ing.com>
*
*  This program is free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  This program 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 General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with this program; if not, write to the Free Software
*  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
*  MA 02111-1307, USA.
*/

#ifndef _MPCL_INVARIANT_VERIFIER__
#define _MPCL_INVARIANT_VERIFIER__

#include <cstdarg>
#include "../text/string.hh"
#include "../util/collection/map.hh"
#include "../util/variable_argument_array.hh"
#include "defs.hh"


namespace mpcl
{

  namespace invariant
  {

    using text::TString;
    using util::collection::TMap;
    using util::TVariableArgumentArray;

    template <typename TParameter>
    class IVerifier
    {

      protected:

        class TInvariant
        {

          public:

            TString   yMessage;

            int   iConformanceLevel;


          public:

            //
            //  C O N S T R U C T O R S
            //

            TInvariant (const char* pkcMESSAGE, int iCONFORMANCE_LEVEL) :
              yMessage          (pkcMESSAGE)                            ,
              iConformanceLevel (iCONFORMANCE_LEVEL)                    {}

        };  // class TInvariant


      protected:

        int   iDefaultConformanceLevel;


      public:

        TMap<long int, TInvariant>   tInvariantMap;

        mutable TVariableArgumentArray<TParameter>   tArgumentArray;

        TConformanceLevelSet   tConformanceLevelSet;


      public:

        //
        //  C O N S T R U C T O R S
        //

        IVerifier (int iDEFAULT_CONFORMANCE_LEVEL)              :
          iDefaultConformanceLevel (iDEFAULT_CONFORMANCE_LEVEL) ,
          tInvariantMap        ()                               ,
          tArgumentArray       ()                               ,
          tConformanceLevelSet ()                               {}

        virtual ~IVerifier (void) {}

        void addInvariant ( long int    liINVARIANT_IDENTIFIER ,
                            int         iCONFORMANCE_LEVEL     ,
                            const char* pkcMESSAGE             )
        {
          tInvariantMap.bind ( liINVARIANT_IDENTIFIER                      ,
                               TInvariant (pkcMESSAGE, iCONFORMANCE_LEVEL) );
        }

        void addInvariant (long int liINVARIANT_IDENTIFIER, const char* pkcMESSAGE)
        {
          tInvariantMap.bind ( liINVARIANT_IDENTIFIER                            ,
                               TInvariant (pkcMESSAGE, iDefaultConformanceLevel) );
        }

        void addConformanceLevel (int iCONFORMANCE_LEVEL)
        {
          if ( tConformanceLevelSet.end() == tConformanceLevelSet.find (iCONFORMANCE_LEVEL) )
          {
            tConformanceLevelSet.insert (iCONFORMANCE_LEVEL);
          }
        }

        void removeConformanceLevel (int iCONFORMANCE_LEVEL)
        {
          if ( tConformanceLevelSet.end() != tConformanceLevelSet.find (iCONFORMANCE_LEVEL) )
          {
            tConformanceLevelSet.erase (iCONFORMANCE_LEVEL);
          }
        }

        void clearConformanceLevelSet (void)
        {
          tConformanceLevelSet.clear();
        }


        void resetConformanceLevelSet (void)
        {
          tConformanceLevelSet.erase();
          tConformanceLevelSet.insert (iDefaultConformanceLevel);
        }


      public:

        //
        //  S E L E C T O R S
        //

        void require (long int liINVARIANT_IDENTIFIER...) const
        {
          va_list   tVa_list;

          va_start (tVa_list, liINVARIANT_IDENTIFIER);
          requireList (liINVARIANT_IDENTIFIER, tVa_list);
          va_end (tVa_list);
        }

        void requireList (long int liINVARIANT_IDENTIFIER, va_list tVA_LIST) const
        {
          const TInvariant&   rktInvariant (tInvariantMap [liINVARIANT_IDENTIFIER]);

          //
          //  Only checks invariants that belong to an active
          //  conformance-level.
          //
          tArgumentArray.initialize (tVA_LIST);
          if ( tConformanceLevelSet.end() != tConformanceLevelSet.find (rktInvariant.iConformanceLevel) )
          {
            if ( !verify (liINVARIANT_IDENTIFIER) )
            {
              va_end (tVA_LIST);
              throw TViolationException ( rktInvariant.iConformanceLevel , 
                                          rktInvariant.yMessage.c_str()  );
            }
          }
        }

        virtual bool verify (long int liINVARIANT_IDENTIFIER) const = 0;

    };  // class IVerifier

  }  // namespace invariant

}  // namespace mpcl

  
#endif  // not _MPCL_INVARIANT_VERIFIER__

---