critical_events.h

Go to the documentation of this file.

#ifndef CRITICAL_EVENTS_GROUP
#define CRITICAL_EVENTS_GROUP
 
/*****************************************************************************\
*                                                                             *
*  Name   : critical_events                                                   *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1989-$now By Author.  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 is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/astring.h>
 
namespace loggers {
 
//#ifndef _MSC_VER
  #define CAUSE_BREAKPOINT
//hmmm: need a unix equivalent for this, see old below for doze?
/*
#else
  #ifdef __MINGW32__
    extern "C" {
//      #include <ddk/winddi.h>
//for debugbreak.  does this cause other problems?
    }
    #define CAUSE_BREAKPOINT 
//    #define CAUSE_BREAKPOINT __debugbreak()
  #else
    #define CAUSE_BREAKPOINT __debugbreak()
  #endif
#endif
*/
 
 
#ifdef ERRORS_ARE_FATAL
  #define REQUIRE(check) if (!check) CAUSE_BREAKPOINT;
#else
  #define REQUIRE(check)
#endif
 
// now more dangerous or potent guards...
 
//#define BH_ERROR_ADDITION ((basis::astring(" in ") + _global_argv[0]).s())
 
 
//#ifdef CATCH_ERRORS
//  #define bounds_halt(value, low, high, to_return) { 
//    if (((value) < (low)) || ((value) > (high))) { 
//      critical_events::implement_bounds_halt(static_class_name(), func, #value, #low, 
//          #high, BH_ERROR_ADDITION); 
//      return to_return; 
//    } 
//  }
//#else
//  #define bounds_halt(a, b, c, d) bounds_return(a, b, c, d)
//#endif
 
 
 
#define non_continuable_error(c, f, i) \
  critical_events::FL_non_continuable_error(__FILE__, __LINE__, c, f, i, \
      "A Non-Continuable Runtime Problem Has Occurred")
#define continuable_error(c, f, i) \
  critical_events::FL_continuable_error(__FILE__, __LINE__, c, f, i, \
      "Runtime Problem Information")
#define console_error(c, f, i) \
  critical_events::FL_console_error(__FILE__, __LINE__, c, f, i)
#define deadly_error(c, f, i) \
  critical_events::FL_deadly_error(__FILE__, __LINE__, c, f, i)
#define out_of_memory_now(c, f) \
  critical_events::FL_out_of_memory_now(__FILE__, __LINE__, c, f)
 
 
 
class critical_events : public virtual basis::root_object
{
public:
  virtual ~critical_events() {}
 
  // super handy system inter-operation functions...
 
  static basis::un_int system_error();
 
  static basis::astring system_error_text(basis::un_int error_to_show);
 
  // some noisemaking methods...
 
  static void write_to_console(const char *message);
 
 
  static void alert_message(const char *info, const char *title = "Alert Message");
  static void alert_message(const basis::astring &info);  // uses default title.
  static void alert_message(const basis::astring &info, const basis::astring &title);  // use "title".
 
  static void write_to_critical_events(const char *message);
 
  static void set_critical_events_directory(const basis::astring &directory);
 
  static basis::astring critical_events_directory();
 
  // this section implements the error macros.
 
 
  static void FL_deadly_error(const char *file, int line, const char *classname,
      const char *function_name, const char *info);
  static void FL_deadly_error(const basis::astring &file, int line,
      const basis::astring &classname, const basis::astring &function_name,
      const basis::astring &info);
 
  static void FL_continuable_error(const char *file, int line,
      const char *classname, const char *function_name, const char *info,
      const char *title);
 
  static void FL_continuable_error(const basis::astring &file, int line,
      const basis::astring &classname, const basis::astring &function_name,
      const basis::astring &info, const basis::astring &title);
 
 
  static void FL_non_continuable_error(const char *file, int line,
      const char *classname, const char *function_name, const char *info,
      const char *title);
 
  static void FL_non_continuable_error(const basis::astring &file, int line,
      const basis::astring &classname, const basis::astring &function_name,
      const basis::astring &info, const basis::astring &title);
 
  static void FL_out_of_memory_now(const char *file, int line,
      const char *classname, const char *function_name);
  
  static void FL_console_error(const char *file, int line, const char *error_class,
      const char *error_function, const char *info);
 
 
  static void make_error_message(const char *file, int line,
      const char *error_class, const char *error_function,
      const char *info, char *guards_message_space);
 
  static void implement_bounds_halt(const char *the_class_name, const char *func,
      const char *value, const char *low, const char *high,
      const char *error_addition);
 
private:
  static basis::astring &hidden_critical_events_dir();
 
  static void FL_continuable_error_real(const char *file, int line,
      const char *error_class, const char *error_function, const char *info,
      const char *title);
};
 
} //namespace.
 
#endif