guards.h

Go to the documentation of this file.

#ifndef GUARDS_GROUP
#define GUARDS_GROUP
 
// Name   : guards
// 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:
//     http://www.gnu.org/licenses/gpl.html
// or under the terms of the GNU Library license:
//     http://www.gnu.org/licenses/lgpl.html
// at your preference.  Those licenses describe your legal rights to this
// software, and no other rights or warranties apply.
// Please send updates for this code to: fred@gruntose.com -- Thanks, fred.
 
 
namespace basis {
 
// forward declaration.
class astring;
class base_string;
 
 
// simpler guards first...
 
template <class contents>
bool in_range(const contents &value, const contents &low, const contents &high)
{ return !( (high < low) || (value < low) || (value > high) ); }
 
 
 
#define bounds_return(value, low, high, to_return) \
    { if (!basis::in_range(value, low, high)) return to_return; }
 
 
 
#ifdef CATCH_ERRORS
  #define bounds_halt(value, low, high, to_return) { \
    if (((value) < (low)) || ((value) > (high))) { \
      throw_error(basis::astring(static_class_name()), basis::astring(func), \
          basis::astring("value ") + #value \
          + " was not in range " + #low + " to " + #high \
          + " at " + __WHERE__); \
      return to_return; \
    } \
  }
#else
  #define bounds_halt(a, b, c, d) bounds_return(a, b, c, d)
#endif
 
 
void format_error(const base_string &class_name, const base_string &func_name,
    const base_string &error_message, base_string &to_fill);
 
void throw_error(const base_string &class_name, const base_string &func_name,
    const base_string &error_message);
 
void throw_error(const astring &class_name, const astring &func_name,
    const astring &error_message);
 
 
}  // namespace.
 
#endif