callstack_tracker.h

Go to the documentation of this file.

#ifndef CALLSTACK_TRACKER_CLASS
#define CALLSTACK_TRACKER_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : callstack_tracker                                                 *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2007-$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 "definitions.h"

#ifdef ENABLE_CALLSTACK_TRACKING

#include "build_configuration.h"
#include "object_base.h"

// forward.
class callstack_records;
class callstack_tracker;


callstack_tracker BASIS_EXTERN &program_wide_stack_trace();



class callstack_tracker
{
public:
  callstack_tracker();
  virtual ~callstack_tracker();

  IMPLEMENT_CLASS_NAME("callstack_tracker");

  bool push_frame(const char *class_name, const char *func, const char *file,
          int line);

  bool pop_frame();

  bool update_line(int line);

  char *full_trace() const;

  int full_trace_size() const;

  int depth() const { return _depth; }

  double frames_in() const { return _frames_in; }

  double frames_out() const { return _frames_out; }

  double highest() const { return _highest; }

private:
  callstack_records *_bt;  
  int _depth;  
  double _frames_in;  
  double _frames_out;  
  double _highest;  
  bool _unusable;  
};



class frame_tracking_instance
{
public:
  // these are not encapsulated, but be careful with the contents.
  bool _frame_involved;  
  char *_class, *_func, *_file;  
  int _line;

  frame_tracking_instance(const char *class_name = "", const char *func = "",
      const char *file = "", int line = 0, bool add_frame = false);

  frame_tracking_instance(const frame_tracking_instance &to_copy);

  ~frame_tracking_instance();

  frame_tracking_instance &operator =(const frame_tracking_instance &to_copy);

  void assign(const char *class_name, const char *func, const char *file,
          int line);

  void clean();
};

void update_current_stack_frame_line_number(int line);

#else // ENABLE_CALLSTACK_TRACKING
  // bogus replacements for most commonly used callstack tracking support.
  #define frame_tracking_instance
  #define __trail_of_function(p1, p2, p3, p4, p5) if (func) {}
    // the above actually trades on the name of the object we'd normally
    // define.  it must match the object name in the FUNCDEF macro.
  #define update_current_stack_frame_line_number(line)
#endif // ENABLE_CALLSTACK_TRACKING

#endif // outer guard.

---