wx_debugging_base Class Reference

#include <wx_debugging_base.h>

Inheritance diagram for wx_debugging_base:

[legend]Collaboration diagram for wx_debugging_base:


Public Member Functions
	wx_debugging_base (wxTextCtrl &to_manipulate, int buffer_size=2 MEGABYTE, int file_size=int(1.2 MEGABYTE))
virtual	~wx_debugging_base ()
	IMPLEMENT_CLASS_NAME ("wx_debugging_base")
void	setup ()
void	shut_down ()
int	current_length ()
virtual outcome	log (const istring &info, int filter=ALWAYS_PRINT)
	writes the information in "info" to the log using the "filter" value.
void	log_ending (const istring &to_show, int filter=ALWAYS_PRINT, line_ending ending=CRLF_AT_END)
void	display_message (byte_array &message)
outcome	print (const istring &to_show, int filter=ALWAYS_PRINT)
istring	name () const
void	name (const istring &new_name)
int	buffer_limit ()
void	buffer_limit (int new_limit)
int	file_limit () const
void	file_limit (int new_limit)
void	go_to_end ()
bool	get_contents (istring &to_fill)
bool	get_selection (int &start, int &end)
void	select (int start, int end)
void	reset ()
wxTextCtrl &	get_editor ()

Detailed Description

Definition at line 34 of file wx_debugging_base.h.

Constructor & Destructor Documentation

wx_debugging_base::wx_debugging_base	(	wxTextCtrl &	to_manipulate,
		int	buffer_size = `2 *MEGABYTE`,
		int	file_size = `int(1.2 *MEGABYTE)`
	)

Definition at line 55 of file wx_debugging_base.cpp.

References buffer_limit(), and file_limit().

wx_debugging_base::~wx_debugging_base ( ) [virtual]

Definition at line 68 of file wx_debugging_base.cpp.

References shut_down(), and WHACK().

Member Function Documentation

wx_debugging_base::IMPLEMENT_CLASS_NAME ( "wx_debugging_base" )

void wx_debugging_base::setup ( )

Definition at line 121 of file wx_debugging_base.cpp.

References istring::t(), and ULS_BUFFER_SIZE.

Referenced by wx_debugging_console_panel::wx_debugging_console_panel().

void wx_debugging_base::shut_down ( )

Definition at line 137 of file wx_debugging_base.cpp.

References WHACK().

Referenced by ~wx_debugging_base(), and wx_debugging_console_panel::~wx_debugging_console_panel().

int wx_debugging_base::current_length ( )

Definition at line 167 of file wx_debugging_base.cpp.

References DISABLE, and REENABLE.

outcome wx_debugging_base::log	(	const istring &	info,
		int	filter = `ALWAYS_PRINT`
	)			`[virtual]`

writes the information in "info" to the log using the "filter" value.

the "filter" value must be checked to see if it is in the current set of allowed filters (using member()). this function _must_ be provided by derived classes and it _must_ check the filter before printing if it wants to be in compliance with log_base protocols. it also must implement the line_ending appropriately. the return value will often be a member of the common outcomes, but derived classes may see fit to return other things. note that an object derived from log_base should be thread-safe and protect its own member attributes through synchronization.

Implements log_base.

Definition at line 198 of file wx_debugging_base.cpp.

References log_base::ALWAYS_PRINT, DISABLE, log_base::eol(), log_base::get_ending(), LENGTH_CHOP_FACTOR, log_base::member(), minimum(), log_base::NO_ENDING, common::OKAY, REENABLE, istring::SPRINTF, to_unicode_wx, wxstring_crlf, and wxstring_lf.