trace_helpers.h File Reference

wxLogTrace helper definitions. More...

#include <wx/arrstr.h>
#include <wx/event.h>
#include <wx/string.h>
#include <stdarg.h>
#include <map>

Go to the source code of this file.

Classes
class	TRACE_MANAGER

Macros
#define	KI_TRACE(aWhat, ...)

Functions
wxString	dump (const wxKeyEvent &aEvent)
	Debug helper for printing wxKeyEvent information. More...
wxString	dump (const wxArrayString &aArray)
	Debug helper for printing wxArrayString contents. More...

Variables
const wxChar *const	traceFindItem
	Flag to enable find debug tracing. More...
const wxChar *const	traceFindReplace
	Flag to enable find and replace debug tracing. More...
const wxChar *const	kicadTraceCoords
	Flag to enable draw panel coordinate debug tracing. More...
const wxChar *const	kicadTraceKeyEvent
	Flag to enable wxKeyEvent debug tracing. More...
const wxChar *const	kicadTraceToolStack
	Flag to enable tracing of the tool handling stack. More...
const wxChar *const	kicadTraceCoroutineStack
	Flag to enable tracing of the coroutine call stack. More...
const wxChar *const	traceAutoSave
	Flag to enable auto save feature debug tracing. More...
const wxChar *const	traceSchLibMem
	Flag to enable schematic library memory deletion debug output. More...
const wxChar *const	traceSchPlugin
	Flag to enable legacy schematic plugin debug output. More...
const wxChar *const	traceSchLegacyPlugin
	Flag to enable legacy schematic plugin debug output. More...
const wxChar *const	traceKicadPcbPlugin
	Flag to enable GEDA PCB plugin debug output. More...
const wxChar *const	traceGedaPcbPlugin
	Flag to enable GEDA PCB plugin debug output. More...
const wxChar *const	tracePrinting
	Flag to enable print controller debug output. More...
const wxChar *const	tracePathsAndFiles
	Flag to enable path and file name debug output. More...
const wxChar *const	traceLocale
	Flag to enable locale debug output. More...
const wxChar *const	traceFonts
	Flag to enable locale debug output. More...
const wxChar *const	traceScreen
	Flag to enable debug output of BASE_SCREEN and it's derivatives. More...
const wxChar *const	traceDisplayLocation
	Flag to enable debug output of display positioning logic. More...
const wxChar *const	traceZoomScroll
	Flag to enable debug output of zoom-scrolling calculations in KIGFX::ZOOM_CONTROLLER and derivatives. More...
const wxChar *const	traceSymbolResolver
	Flag to enable debug output of symbol library resolver results. More...
const wxChar *const	traceSchSheetPaths
	Flag to enable debug output of schematic symbol sheet path manipulation code. More...
const wxChar *const	traceEnvVars
	Flag to enable debug output of environment variable operations. More...
const wxChar *const	traceGalProfile
	Flag to enable debug output of GAL performance profiling. More...
const wxChar *const	traceKiCad2Step
	Flag to enable KiCad2Step debug tracing. More...

Detailed Description

wxLogTrace helper definitions.

Definition in file trace_helpers.h.

Macro Definition Documentation

KI_TRACE

#define KI_TRACE	(		aWhat,
			...
	)

Value:

 if( TRACE_MANAGER::Instance().IsTraceEnabled( aWhat ) ) \
 { \
 TRACE_MANAGER::Instance().Trace( aWhat, __VA_ARGS__ ); \
 } \
 else \
 { \
 }

Definition at line 283 of file trace_helpers.h.

Function Documentation

dump() [1/2]

wxString dump

(

const wxArrayString &

aArray

)

Debug helper for printing wxArrayString contents.

Parameters

aArray

is the string array to output.

Returns

the wxArrayString contents in a formatted string for debugging output.

Definition at line 60 of file trace_helpers.cpp.

{
 wxString tmp;
 
 for( unsigned i = 0; i < aArray.GetCount(); i++ )
 {
 if( aArray[i].IsEmpty() )
 tmp << wxT( "\"\" " );
 else
 tmp << aArray[i] << wxT( " " );
 }
 
 return tmp;
}

Referenced by TOOL_DISPATCHER::DispatchWxEvent(), LIBEVAL::COMPILER::generateUCode(), TOOL_DISPATCHER::GetToolEvent(), FOOTPRINTS_LISTBOX::OnChar(), LIBRARY_LISTBOX::OnChar(), SYMBOLS_LISTBOX::OnChar(), EDA_BASE_FRAME::OnCharHook(), and GPCB_FPL_CACHE::parseParameters().

dump() [2/2]

wxString dump

(

const wxKeyEvent &

aEvent

)

Debug helper for printing wxKeyEvent information.

Parameters

aEvent

is the wxKeyEvent to generate the print string from.

Returns

the wxKeyEvent information.

Definition at line 234 of file trace_helpers.cpp.

{
 wxString msg;
 wxString eventType = wxS( "unknown" );
 
 if( aEvent.GetEventType() == wxEVT_KEY_DOWN )
 eventType = wxS( "KeyDown" );
 else if( aEvent.GetEventType() == wxEVT_KEY_UP )
 eventType = wxS( "KeyUp" );
 else if( aEvent.GetEventType() == wxEVT_CHAR )
 eventType = wxS( "Char" );
 else if( aEvent.GetEventType() == wxEVT_CHAR_HOOK )
 eventType = wxS( "Hook" );
 
 // event key_name KeyCode modifiers Unicode raw_code raw_flags pos
 msg.Printf( "%7s %15s %5d %c%c%c%c"
#if wxUSE_UNICODE
 "%5d (U+%04x)"
#else
 " none "
#endif
#ifdef wxHAS_RAW_KEY_CODES
 " %7lu 0x%08lx"
#else
 " not-set not-set"
#endif
 " (%5d,%5d)",
 eventType,
 GetKeyName( aEvent ),
 aEvent.GetKeyCode(),
 aEvent.ControlDown() ? 'C' : '-',
 aEvent.AltDown() ? 'A' : '-',
 aEvent.ShiftDown() ? 'S' : '-',
 aEvent.MetaDown() ? 'M' : '-'
#if wxUSE_UNICODE
 , aEvent.GetUnicodeKey()
 , aEvent.GetUnicodeKey()
#endif
#ifdef wxHAS_RAW_KEY_CODES
 , (unsigned long) aEvent.GetRawKeyCode()
 , (unsigned long) aEvent.GetRawKeyFlags()
#endif
 , aEvent.GetX()
 , aEvent.GetY()
 );
 
 return msg;
}

References GetKeyName().