warn_once.H

Go to the documentation of this file.

#ifndef WARN_ONCE_IS_INCLUDED
#define WARN_ONCE_IS_INCLUDED

#include "support.H"

/*****************************************************************
 * WarnOnce:
 *
 *   For when you want to print an error message about something,
 *   but once is enough, instead of over and over, every frame,
 *   like a brainless ninny.
 *****************************************************************/
class WarnOnce {
 public:
   WarnOnce(Cstr_ptr& msg) : _msg(msg), _done(false) {}

   // Print the message if it's the first time:
   void warn() {
      if (!_done) {
         _done = true;
         cerr << **_msg << endl;
      }
   }

   // Print the message if the condition is false:
   void check(bool condition) {
      if (!condition)
         warn();
   }

 protected:
   str_ptr      _msg;   // message to print
   bool         _done;  // true if it's been printed already
};

#endif // WARN_ONCE_IS_INCLUDED

/* end of file warn_once.H */

---