Backtrace.h

Go to the documentation of this file.

#ifndef CARMA_UTIL_BACKTRACE_H
#define CARMA_UTIL_BACKTRACE_H


#include <string>
#include <vector>


namespace carma {
namespace util {


class Backtrace {
    public:
        explicit Backtrace( );
        
        ~Backtrace( );
        
        bool captured() const;
        bool capturedAndValid() const;
        
        bool captureNoThrow( );
        
        bool captureNoThrow( size_t maxDepth );
        
        bool captureNoThrow( bool convertToSymbols );
        
        bool captureNoThrow( size_t maxDepth,
                             bool   convertToSymbols );

        void convertToSymbols( );
        
        ::std::string formattedAsString( ) const;

        ::std::string formattedAsString( const char * linePrefix,
                                         const char * lineSuffix ) const;

        ::std::string
        formattedAsString( const ::std::string & linePrefix,
                           const ::std::string & lineSuffix ) const;

        static ::std::string captureAsString( );

        static ::std::string captureAsString( const char * linePrefix,
                                              const char * lineSuffix );

        static ::std::string
        captureAsString( const ::std::string & linePrefix,
                         const ::std::string & lineSuffix );
        
        static void demangleSymbolLineInPlace( ::std::string & line );

        static ::std::string demangleSymbolLine( const ::std::string & line );
        
        static ::std::string demangleSymbolLine( const char * line );
        
    private:
        typedef enum {
            NOT_CAPTURED_STATE,
            INVALID_CAPTURE_STATE,
            NUMERIC_STATE,
            MANGLED_STATE,
            DEMANGLED_STATE
        } State;
        
        
        State                         state_;
        bool                          complete_;
        ::std::vector< void * >       numeric_;
        ::std::vector< ::std::string> symbolic_;
};


}  // namespace carma::util
}  // namespace carma


#endif