---

Debugable.h

#ifndef _LCORE_Debugable_H_  // -*-c++-*-

#ifdef __GNUG__
#  pragma interface
#endif

/*
 * Copyright (C) 1991-9 Eric M. Hopper <hopper@omnifarious.mn.org>
 * 
 *     This program is free software; you can redistribute it and/or modify it
 *     under the terms of the GNU Lesser 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
 *     Lesser General Public License for more details.
 * 
 *     You should have received a copy of the GNU Lesser General Public
 *     License along with this program; if not, write to the Free Software
 *     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/* $Header: /home/hopper/src/cvs/C++/LCore/LCore/Debugable.h,v 1.7 2002/11/25 05:40:05 hopper Exp $ */

// For a log, see ../ChangeLog

#include <LCore/HopClTypes.h>
#include <LCore/Protocol.h>

#define _LCORE_Debugable_H_

namespace strmod {
namespace lcore {

/** \class Debugable Debugable.h LCore/Debugable.h
 * Interface class for things that have certain common debugging functions.
 * You'll probable need to use a dynamic_cast to use this interface in a
 * generic way in most cases.
 */
class Debugable : virtual public Protocol {
 public:
   static const LCore_ClassIdent identifier;

   inline virtual int AreYouA(const lcore::ClassIdent &cid) const;

   /** \brief This should ALWAYS return true.  It says whether the class
    * invariant holds or not.
    *
    * Your class invariant should be as strict as possible.  The class
    * invariant is used to detect when the class goes into a bad state, so all
    * possible bad states should be caught by the invariant.  */
   virtual bool invariant() const = 0;

   /** This should print out as much of the internal state of a class as would
    * be needed to debug it properly.
    */
   virtual void printState(::std::ostream &os) const = 0;

 protected:
   virtual const ClassIdent *i_GetIdent() const         { return(&identifier); }
};

//-----------------------------inline functions--------------------------------

inline int Debugable::AreYouA(const ClassIdent &cid) const
{
   return((identifier == cid) || Protocol::AreYouA(cid));
}

} // namespace lcore
} // namespace strmod

#endif

---