wxLogTrace helper definitions. More...

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

Classes
class	TRACE_MANAGER

Macros
#define	KI_TRACE(aWhat, ...)

Functions
KICOMMON_API wxString	dump (const wxKeyEvent &aEvent)
	Debug helper for printing wxKeyEvent information.

KICOMMON_API wxString	dump (const wxArrayString &aArray)
	Debug helper for printing wxArrayString contents.

Variables
KICOMMON_API const wxChar *const	traceFindItem
	Flag to enable find debug tracing.

KICOMMON_API const wxChar *const	traceFindReplace
	Flag to enable find and replace debug tracing.

KICOMMON_API const wxChar *const	kicadTraceCoords
	Flag to enable draw panel coordinate debug tracing.

KICOMMON_API const wxChar *const	kicadTraceKeyEvent
	Flag to enable wxKeyEvent debug tracing.

KICOMMON_API const wxChar *const	kicadTraceToolStack
	Flag to enable tracing of the tool handling stack.

KICOMMON_API const wxChar *const	kicadTraceCoroutineStack
	Flag to enable tracing of the coroutine call stack.

KICOMMON_API const wxChar *const	traceAutoSave
	Flag to enable auto save feature debug tracing.

KICOMMON_API const wxChar *const	traceSchLibMem
	Flag to enable schematic library memory deletion debug output.

KICOMMON_API const wxChar *const	traceSchPlugin
	Flag to enable legacy schematic plugin debug output.

KICOMMON_API const wxChar *const	traceSchLegacyPlugin
	Flag to enable legacy schematic plugin debug output.

KICOMMON_API const wxChar *const	traceKicadPcbPlugin
	Flag to enable GEDA PCB plugin debug output.

KICOMMON_API const wxChar *const	traceGedaPcbPlugin
	Flag to enable GEDA PCB plugin debug output.

KICOMMON_API const wxChar *const	tracePrinting
	Flag to enable print controller debug output.

KICOMMON_API const wxChar *const	tracePathsAndFiles
	Flag to enable path and file name debug output.

KICOMMON_API const wxChar *const	traceLocale
	Flag to enable locale debug output.

KICOMMON_API const wxChar *const	traceFonts
	Flag to enable locale debug output.

KICOMMON_API const wxChar *const	traceScreen
	Flag to enable debug output of BASE_SCREEN and it's derivatives.

KICOMMON_API const wxChar *const	traceDisplayLocation
	Flag to enable debug output of display positioning logic.

KICOMMON_API const wxChar *const	traceZoomScroll
	Flag to enable debug output of zoom-scrolling calculations in KIGFX::ZOOM_CONTROLLER and derivatives.

KICOMMON_API const wxChar *const	traceSymbolResolver
	Flag to enable debug output of symbol library resolver results.

KICOMMON_API const wxChar *const	traceSchSheetPaths
	Flag to enable debug output of schematic symbol sheet path manipulation code.

KICOMMON_API const wxChar *const	traceSchCurrentSheet
	Flag to enable debug output of current sheet tracking in the schematic editor.

KICOMMON_API const wxChar *const	traceSchFieldRendering
	Flag to enable debug output of schematic field rendering and positioning.

KICOMMON_API const wxChar *const	traceSchPainter
	Flag to enable debug output of schematic painter operations.

KICOMMON_API const wxChar *const	traceSchSymbolRef
	Flag to enable debug output of schematic symbol reference resolution.

KICOMMON_API const wxChar *const	traceSchDragNetCollision
	Flag to enable debug output of schematic drag net collision detection.

KICOMMON_API const wxChar *const	traceCrossProbeFlash
	Flag to enable debug output for cross-probe flash operations.

KICOMMON_API const wxChar *const	traceEnvVars
	Flag to enable debug output of environment variable operations.

KICOMMON_API const wxChar *const	traceGalProfile
	Flag to enable debug output of GAL performance profiling.

KICOMMON_API const wxChar *const	traceKiCad2Step
	Flag to enable KiCad2Step debug tracing.

KICOMMON_API const wxChar *const	traceUiProfile
	Flag to enable user interface profile tracing.

KICOMMON_API const wxChar *const	traceGit
	Flag to enable Git debugging output.

KICOMMON_API const wxChar *const	traceEagleIo

KICOMMON_API const wxChar *const	traceDesignBlocks

KICOMMON_API const wxChar *const	traceLibFieldTable

KICOMMON_API const wxChar *const	tracePdfPlotter
	Flag to enable PDF plotter debug tracing.

KICOMMON_API const wxChar *const	traceSnap
	Flag to enable snap/grid helper debug tracing.

KICOMMON_API const wxChar *const	traceStackedPins
	Flag to enable debug output for stacked pins handling in symbol/pin code.

KICOMMON_API const wxChar *const	traceLibWatch
	Flag to enable debug output for library file watch refreshes.

KICOMMON_API const wxChar *const	traceLibraries
	Flag to enable library table and library manager tracing.

KICOMMON_API const wxChar *const	traceSchMove
	Flag to watch how schematic move tool actions are handled.

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 402 of file trace_helpers.h.

Referenced by KIGFX::CACHED_CONTAINER_GPU::CACHED_CONTAINER_GPU(), KIGFX::CACHED_CONTAINER_GPU::defragmentResize(), KIGFX::CACHED_CONTAINER_GPU::defragmentResizeMemcpy(), EDA_DRAW_PANEL_GAL::DoRePaint(), KIGFX::GPU_CACHED_MANAGER::EndDrawing(), KIGFX::OPENGL_GAL::EndDrawing(), SYM_CHOOSER_TIMING::STEP_LOGGER::Log(), SYM_CHOOSER_TIMING::LogRaw(), PCB_TEST_FRAME_BASE::SetBoard(), and KIGFX::VIEW::UpdateItems().

Function Documentation

◆ dump() [1/2]

KICOMMON_API wxString dump ( const wxArrayString & aArray )

extern

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 76 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 )

extern

Debug helper for printing wxKeyEvent information.

Parameters

aEvent is the wxKeyEvent to generate the print string from.

Returns: the wxKeyEvent information.

Definition at line 250 of file trace_helpers.cpp.

References GetKeyName().

Classes

Macros