KiCad PCB EDA Suite
Loading...
Searching...
No Matches
trace_helpers.h File Reference

wxLogTrace helper definitions. More...

#include <kicommon.h>
#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

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

Variables

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

Definition at line 284 of file trace_helpers.h.

Function Documentation

◆ dump() [1/2]

KICOMMON_API wxString dump ( const wxArrayString &  aArray)

Debug helper for printing wxArrayString contents.

Parameters
aArrayis 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.

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]

KICOMMON_API wxString dump ( const wxKeyEvent &  aEvent)

Debug helper for printing wxKeyEvent information.

Parameters
aEventis the wxKeyEvent to generate the print string from.
Returns
the wxKeyEvent information.

Definition at line 234 of file trace_helpers.cpp.

References GetKeyName().