gliftObject.h

Go to the documentation of this file.

//////////////////////////////////////////////////////////////////////
// 7/15/03      Joe M. Kniss    Scientific Computing and Imaging Institute
// School of Computing          University of Utah
//
//  This library 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.1 of the License, or (at your option) any later version.
//
//  This library 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 library; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
/////////////////////////////////////////////////////////////////////////


/// gliftObject.h
///  the base class for all Glift Objects

#ifndef __GLIFT_OBJECT_DOT_H
#define __GLIFT_OBJECT_DOT_H

#include <iostream>
#include <assert.h>

namespace glift {

class GliftObject {
public:
   GliftObject() 
      : m_err(&std::cerr) 
   {}
   virtual ~GliftObject()
   {}

   //////////////////////////////////////
   /// Where do you want gl errors to go?
   /// they must go somewhere, so don't set
   /// it to zero please.
   virtual void          setErrStream(std::ostream *os)
   { assert(os); m_err = os; return; }

   //////////////////////////////////////
   /// Where are gl errors going?
   virtual std::ostream *getErrStream() const { return m_err; }

protected:

   ///////////////////////////////////////////
   /// error reporting, most of these attach
   /// the object name, except estr(), which
   /// just returns a reference to the stream
   ///////////////////////////////////////////

   ///////////////////////////////////////////
   /// error report always,
   ///  standard: where = function name,
   ///            when  = what happend?
   /// sometimes you have to dis-abiguate this call:
   /// GliftObject::err(), or MyObj::GliftObject::err()
   void err(const char *where, const char *when =0) const;
   
   ///////////////////////////////////////////
   /// error report only in debug mode
   void derr(const char *where, const char *when =0) const;

   ///////////////////////////////////////////
   /// gl error report only in debug mode, only
   /// if there is an error, if so return true
   bool glerr(const char *where, const char *when =0) const;

   ///////////////////////////////////////////
   /// a simpler way, just use the stream!
   /// only for always print, this one automatically adds the
   /// objects name
   std::ostream &err() const;
   
   ///////////////////////////////////////////
   /// this one just gives you the stream
   std::ostream &estr() const { assert(m_err); return (*m_err); }


   mutable std::ostream *m_err;

};

/////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////
/// some implementation
/////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////

/////////////////////////////////////////////////////////////////////////
/// error
/////////////////////////////////////////////////////////////////////////
inline
void GliftObject::err(const char *where, const char *when) const
{
   assert(m_err);
   (*m_err) << typeid(*this).name() << "::" << where;
   if(when)
      (*m_err) << ", " << when;
   (*m_err) << "\n";
}

inline
std::ostream &GliftObject::err() const
{
   assert(m_err);
   (*m_err) << typeid(*this).name() << "::";
   return(*m_err);

}
/////////////////////////////////////////////////////////////////////////
/// debug error
/////////////////////////////////////////////////////////////////////////
inline
void GliftObject::derr(const char *where, const char *when) const
{
#ifdef _DEBUG
   if(!m_err) return;
   (*m_err) << typeid(*this).name() << "::" << where;
   if(when)
      (*m_err) << ", " << when;
   (*m_err) << "\n";
#endif
}


} /// end namespace glift

#endif

---

Send questions, comments, and bug reports to: