error.h

Go to the documentation of this file.
00001 /** @file rutz/error.h exception base class, derives from
00002     std::exception */
00003 
00004 ///////////////////////////////////////////////////////////////////////
00005 //
00006 // Copyright (c) 1999-2004 California Institute of Technology
00007 // Copyright (c) 2004-2007 University of Southern California
00008 // Rob Peters <rjpeters at usc dot edu>
00009 //
00010 // created: Tue Jun 22 14:59:47 1999
00011 // commit: $Id: error.h 8249 2007-04-12 06:03:40Z rjpeters $
00012 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/rutz/error.h $
00013 //
00014 // --------------------------------------------------------------------
00015 //
00016 // This file is part of GroovX.
00017 //   [http://ilab.usc.edu/rjpeters/groovx/]
00018 //
00019 // GroovX is free software; you can redistribute it and/or modify it
00020 // under the terms of the GNU General Public License as published by
00021 // the Free Software Foundation; either version 2 of the License, or
00022 // (at your option) any later version.
00023 //
00024 // GroovX is distributed in the hope that it will be useful, but
00025 // WITHOUT ANY WARRANTY; without even the implied warranty of
00026 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00027 // General Public License for more details.
00028 //
00029 // You should have received a copy of the GNU General Public License
00030 // along with GroovX; if not, write to the Free Software Foundation,
00031 // Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
00032 //
00033 ///////////////////////////////////////////////////////////////////////
00034 
00035 #ifndef GROOVX_RUTZ_ERROR_H_UTC20050626084020_DEFINED
00036 #define GROOVX_RUTZ_ERROR_H_UTC20050626084020_DEFINED
00037 
00038 #include "rutz/fileposition.h"
00039 #include "rutz/fstring.h"
00040 
00041 #include <exception>
00042 
00043 namespace rutz
00044 {
00045   class backtrace;
00046   class error;
00047 }
00048 
00049 //  ########################################################
00050 /// \c rutz::error is a basic exception class.
00051 /** It carries a string message describing the error as well as
00052     information about the location in the source code in which the
00053     exception was generated. */
00054 
00055 class rutz::error : public std::exception
00056 {
00057 public:
00058   /// Default construct with an empty message string.
00059   error(const rutz::file_pos& pos);
00060 
00061   /// Construct with an error message.
00062   error(const rutz::fstring& msg, const rutz::file_pos& pos);
00063 
00064   /// Copy constructor.
00065   error(const error& other) throw();
00066 
00067   /// Virtual destructor.
00068   virtual ~error() throw();
00069 
00070   /// Get the decorated error message as a C-style string.
00071   virtual const char* what() const throw();
00072 
00073   /// Get the source file position where the error was generated.
00074   const rutz::file_pos& src_pos() const throw() { return m_file_pos; }
00075 
00076   /// Get the stack back trace associated with this exception.
00077   const rutz::backtrace& get_backtrace() const throw() { return *m_backtrace; }
00078 
00079   /// Copy out the back trace most recently used in constructing a rutz::error.
00080   static void get_last_backtrace(rutz::backtrace& dst);
00081 
00082 protected:
00083   /// Reset the error message.
00084   void set_msg(const rutz::fstring& new_msg) throw() { m_msg = new_msg; }
00085 
00086   /// Get the (un-decorated) error message.
00087   const rutz::fstring& get_msg() const throw() { return m_msg; }
00088 
00089 private:
00090   error& operator=(const error& other);
00091 
00092   rutz::fstring          m_msg; // holds the user-provided info
00093   rutz::fstring          m_context; // holds text from a rutz::error_context
00094   mutable rutz::fstring  m_what; // holds m_msg plus decoration
00095   rutz::file_pos         m_file_pos;
00096   const rutz::backtrace* m_backtrace;
00097 };
00098 
00099 static const char __attribute__((used)) vcid_groovx_rutz_error_h_utc20050626084020[] = "$Id: error.h 8249 2007-04-12 06:03:40Z rjpeters $ $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/rutz/error.h $";
00100 #endif // !GROOVX_RUTZ_ERROR_H_UTC20050626084020_DEFINED
Generated on Sun May 8 08:42:09 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3