backtrace.h

Go to the documentation of this file.
00001 /** @file rutz/backtrace.h represents the state of the call stack as
00002     given by GVX_TRACE statements */
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: Wed Oct 13 16:32:38 2004
00011 // commit: $Id: backtrace.h 8249 2007-04-12 06:03:40Z rjpeters $
00012 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/rutz/backtrace.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_BACKTRACE_H_UTC20050626084020_DEFINED
00036 #define GROOVX_RUTZ_BACKTRACE_H_UTC20050626084020_DEFINED
00037 
00038 #include "rutz/staticstack.h"
00039 
00040 #include <iosfwd>
00041 
00042 namespace rutz
00043 {
00044   class backtrace;
00045   class prof;
00046 }
00047 
00048 /// Represents an instantaneous state of the call stack.
00049 class rutz::backtrace
00050 {
00051 public:
00052   /// Default construct an empty call stack.
00053   backtrace() throw();
00054 
00055   /// Copy constructor.
00056   backtrace(const backtrace& other) throw();
00057 
00058   /// Assignment operator.
00059   backtrace& operator=(const backtrace& other) throw();
00060 
00061   /// Destructor.
00062   ~backtrace() throw();
00063 
00064   /// Access the current call stack.
00065   static backtrace& current() throw();
00066 
00067   /// Push a new element onto the call stack. Returns true if successful.
00068   bool push(rutz::prof* p) throw();
00069 
00070   /// Pop the most recent element off of the call stack.
00071   void pop() throw();
00072 
00073   /// Get the number of elements in the call stack.
00074   unsigned int size() const throw();
00075 
00076   /// Get the top stack frame, or null if the backtrace is empty.
00077   rutz::prof* top() const throw();
00078 
00079   /// Will return a null pointer if i is out of range.
00080   rutz::prof* at(unsigned int i) const throw();
00081 
00082   /// Shorthand for at(i).
00083   rutz::prof* operator[](unsigned int i) const throw() { return at(i); }
00084 
00085   /// Print the call stack on stderr.
00086   void print() const throw();
00087 
00088   /// Print the call stack to the given stream.
00089   void print(std::ostream& os) const throw();
00090 
00091 private:
00092   rutz::static_stack<rutz::prof*, 256> m_vec;
00093 };
00094 
00095 static const char __attribute__((used)) vcid_groovx_rutz_backtrace_h_utc20050626084020[] = "$Id: backtrace.h 8249 2007-04-12 06:03:40Z rjpeters $ $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/rutz/backtrace.h $";
00096 #endif // !GROOVX_RUTZ_BACKTRACE_H_UTC20050626084020_DEFINED
Generated on Sun May 8 08:42:09 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3