debugging_base Class Reference

#include <debugging_base.h>

Inheritance diagram for debugging_base:

[legend]Collaboration diagram for debugging_base:


Public Types
enum	debugging_defaults { MAX_BUFFER_SIZE = 2 * MEGABYTE, MAX_FILE_SIZE = int(1.2 * MEGABYTE) }
Public Member Functions
	debugging_base (CEdit &to_manipulate, int buffer_size=MAX_BUFFER_SIZE, int file_size=MAX_FILE_SIZE, bool logging_to_file=false)
virtual	~debugging_base ()
	IMPLEMENT_CLASS_NAME ("debugging_base")
void	setup (bool fixed_width=true)
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)
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, bool scroll=true)
void	reset ()
void	display_message (WPARAM wparam, LPARAM lparam)
CEdit &	get_editor ()
log_base &	logging ()

Detailed Description

Definition at line 33 of file debugging_base.h.

Member Enumeration Documentation

enum debugging_base::debugging_defaults

Enumerator:

MAX_BUFFER_SIZE
MAX_FILE_SIZE

Definition at line 36 of file debugging_base.h.

Constructor & Destructor Documentation

debugging_base::debugging_base	(	CEdit &	to_manipulate,
		int	buffer_size = `MAX_BUFFER_SIZE`,
		int	file_size = `MAX_FILE_SIZE`,
		bool	logging_to_file = `false`
	)

debugging_base::~debugging_base ( ) [virtual]

Definition at line 86 of file debugging_base.cpp.

References shut_down(), and WHACK().

Member Function Documentation

debugging_base::IMPLEMENT_CLASS_NAME ( "debugging_base" )

void debugging_base::setup ( bool fixed_width = true )

Definition at line 151 of file debugging_base.cpp.

References istring::t(), and ULS_BUFFER_SIZE.

Referenced by debugging_console_window::Create(), and debugging_console_view::Create().

void debugging_base::shut_down ( )

Definition at line 175 of file debugging_base.cpp.

References WHACK().

Referenced by debugging_console_view::OnClose(), and ~debugging_base().

int debugging_base::current_length ( )

Definition at line 202 of file debugging_base.cpp.

References DISABLE, and REENABLE.

outcome 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 233 of file debugging_base.cpp.

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