wx_tiny_shell.h

Go to the documentation of this file.

#ifndef WX_TINY_SHELL_CLASS
#define WX_TINY_SHELL_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : wx_tiny_shell                                                     *
*  Author : Aaron Buchanan                                                    *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    The tiny shell provides a simple way to create an application.           *
*  It will automatically provide an ini editor, a debugging console and       *
*  some miscellaneous windows support.                                        *
*                                                                             *
*******************************************************************************
* Copyright (c) 1995-$now By Authors.  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 <opsystem/application_shell.h>

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

// forward.
class debugger;
class log_base;
class outcome;
class wx_debugging_console_panel;

class WX_EXTENSIONS_CLASS_STYLE wx_tiny_shell
: public wxFrame,
  public application_shell
{
public:  
  wx_tiny_shell(const istring &window_title, const istring &name_root,
                    int file_size = int(1.2 * MEGABYTE),
                    const istring &logfile_name = "");
    // constructs a wx_tiny_shell window with the "window_title".  the
    // "name_root" is used as the base part of the config file's name and
    // diagnostic log file's name.  if the "logfile_name" is not empty, then
    // it is used for the diagnostic log instead of basing the name on
    // "name_root".

  virtual ~wx_tiny_shell();

  IMPLEMENT_CLASS_NAME("wx_tiny_shell");

  // IDs for the controls and the menu commands
  enum
  {
    // menu items
    Quit = wxID_EXIT
  };

  virtual int execute();
    // forwards the application_base responsibility upwards to derived objects.

  outcome log(const istring &to_print);
  outcome print(const istring &to_print);
    // sends a debugging line into the debugging console and also to the
    // log file.

  debugger &debug() const;
    // this object is pointed at the "console" to allow debugging information
    // to be sent.  it also is valid by the time the execute() function is
    // called.  it can be passed around as a valid log_base object before then,
    // but items logged to it will be discarded until the wx_tiny_shell
    // window is created (just before execute() is invoked).  the initial style
    // of delivery for the debugging items is "delayed" (see debugger.h), but
    // this can be changed.  however, it is not recommended because that can
    // cause misordering of debug messages when other senders are targeting the
    // same debugging window.

  wx_debugging_console_panel &panel();
    // wx component that holds the logging information.

protected:
    void OnCloseWindow(wxCloseEvent& event);
    void OnDebugEvent(wxCommandEvent &event);

    // event handlers (these functions should _not_ be virtual)
    void OnQuit(wxCommandEvent& event);

private:
  wx_debugging_console_panel *_panel;   // logging panel
  debugger *_debug;  // our debugging message zinger.
  log_base *_held_logger;  // tracks the prior logger.
  bool _exiting;  // is the application shutting down?
  istring *_logfile_name;

  DECLARE_EVENT_TABLE()
};

#endif 

---