Public API Reference

csutil/callstack.h

Go to the documentation of this file.

/*
  Call stack creation helper
  Copyright (C) 2004 by Jorrit Tyberghein
            (C) 2004 by Frank Richter

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public
  License along with this library; if not, write to the Free
  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __CS_UTIL_CALLSTACK_H__
#define __CS_UTIL_CALLSTACK_H__

#include "csextern.h"
#include "csutil/csstring.h"

// Avoid using csRefCount, which uses the ref tracker, which in turn uses csCallStack
class CS_CRYSTALSPACE_EXPORT csCallStack
{
protected:
  int ref_count;

  virtual ~csCallStack() {}
public:
  csCallStack () : ref_count (1) { }

  void IncRef () { ref_count++; }
  void DecRef ()
  {
    ref_count--;
    if (ref_count <= 0)
      Free ();
  }
  int GetRefCount () const { return ref_count; }

  virtual void Free() = 0;
  
  virtual size_t GetEntryCount () = 0;
  //{@
  virtual bool GetFunctionName (size_t num, char*& str) = 0;
  bool GetFunctionName (size_t num, csString& str)
  {
    char* cstr;
    if (GetFunctionName (num, cstr))
    {
      str = cstr;
      free (cstr);
      return true;
    }
    return false;
  }
  //{@
  virtual bool GetLineNumber (size_t num, char*& str) = 0;
  bool GetLineNumber (size_t num, csString& str)
  {
    char* cstr;
    if (GetLineNumber (num, cstr))
    {
      str = cstr;
      free (cstr);
      return true;
    }
    return false;
  }
  //{@
  virtual bool GetParameters (size_t num, char*& str) = 0;
  bool GetParameters (size_t num, csString& str)
  {
    char* cstr;
    if (GetParameters (num, cstr))
    {
      str = cstr;
      free (cstr);
      return true;
    }
    return false;
  }

  void Print (FILE* f = stdout, bool brief = false)
  {
    for (size_t i = 0; i < GetEntryCount(); i++)
    {
      char* s;
      bool hasFunc = GetFunctionName (i, s);
      fprintf (f, "%s", hasFunc ? (const char*)s : "<unknown>");
      if (hasFunc) free (s);
      if (!brief && (GetLineNumber (i, s)))
      {
        fprintf (f, " @%s", (const char*)s);
        free (s);
      }
      if (!brief && (GetParameters (i, s)))
      {
        fprintf (f, " (%s)", (const char*)s);
        free (s);
      }
      fprintf (f, "\n");
    }
    fflush (f);
  }
  csString GetEntryAll (size_t i, bool brief = false)
  {
    csString line;
    char* s;
    bool hasFunc = GetFunctionName (i, s);
    line << (hasFunc ? (const char*)s : "<unknown>");
    if (hasFunc) free (s);
    if (!brief && GetLineNumber (i, s))
    {
      line << " @" << s;
      free (s);
    }
    if (!brief && GetParameters (i, s))
    {
      line << " (" << s << ")";
      free (s);
    }
    return line;
  }
};

class CS_CRYSTALSPACE_EXPORT csCallStackHelper
{
public:
  static csCallStack* CreateCallStack (int skip = 0, bool fast = false);
};

#endif // __CS_UTIL_CALLSTACK_H__

---