wx_debugger.h

Go to the documentation of this file.

#ifndef WX_DEBUGGER_CLASS
#define WX_DEBUGGER_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : wx_debugger                                                       *
*  Author : Aaron Buchanan                                                    *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Provides a mechanism for printing debugging information and either       *
*    displaying it to a wxEventHandler recipient.  Also allows the            *
*    information  to be saved in a log file.                                  *
*                                                                             *
*******************************************************************************
* Copyright (c) 1995-$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 "dll_wx_ext.h"

#include <basis/portable.h>
#include <win_ext/debugger.h>

#include <basis/trap_new.addin>
#undef GetClassInfo
#include <wx/event.h>
#include <basis/untrap_new.addin>

class WX_EXTENSIONS_CLASS_STYLE wx_debugger : public debugger
{
public:
  wx_debugger(wxEvtHandler *recipient, synchronicity synch = delayed,
        line_ending ending = LF_AT_END,
        time_stamp_method stamp = NO_STAMP);
    // allows debugging information to be fired at a previously existing
    // event handler.  the "recipient" is the wxEvtHandler of the
    // handler, the "synch" determines how the information is sent, and the
    // "ending" defines how the ends of lines are treated.  if the "stamp" is
    // ADD_STAMP, then each line is prefixed with the current date and time.

  virtual ~wx_debugger();

  virtual outcome log(const istring &info, int filter = ALWAYS_PRINT);
    // logs information to the log file as well as showing it in the debugging
    // window.

  static const int &EVENT();
    // sent as the "msg" in a windows message structure when classes have debug
    // information that they want a debug window to receive.  this is the
    // message to look for in your window's event handler (or to put in an OWL
    // response table using the below macro).
};

#endif

---