KiCad PCB EDA Suite
Trace Environment Variables

wxWidgets provides trace control of debug messages using the WXTRACE environment variable. More...

Variables

static const wxChar * DRC_COURTYARD_TRACE = wxT( "KICAD_DRC_COURTYARD" )
 Flag to enable courtyard DRC debug tracing. More...
 
const wxChar *const traceHiDpi = wxT( "KICAD_TRACE_HIGH_DPI" )
 Flag to enable trace for HiDPI scaling factors. More...
 
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 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 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 traceScreen
 Flag to enable debug output of BASE_SCREEN and it's derivatives. More...
 
const wxChar *const traceZoomScroll
 Flag to enable debug output of zoom-scrolling calculations in KIGFX::ZOOM_CONTROLLER and derivatives. More...
 
static const wxChar * EDA_3D_CANVAS::m_logTrace = wxT( "KI_TRACE_EDA_3D_CANVAS" )
 Trace mask used to enable or disable the trace output of this class. More...
 
static const wxChar * EDA_3D_VIEWER::m_logTrace = wxT( "KI_TRACE_EDA_3D_VIEWER" )
 Trace mask used to enable or disable the trace output of this class. More...
 

Detailed Description

wxWidgets provides trace control of debug messages using the WXTRACE environment variable.

This section defines the strings passed to WXTRACE to for debug output control of various sections of the KiCad code. See the wxWidgets wxLogTrace documentation for more information.

Variable Documentation

◆ DRC_COURTYARD_TRACE

const wxChar* DRC_COURTYARD_TRACE = wxT( "KICAD_DRC_COURTYARD" )
static

Flag to enable courtyard DRC debug tracing.

Use "KICAD_DRC_COURTYARD" to enable.

Definition at line 46 of file courtyard_overlap.cpp.

Referenced by DRC_COURTYARD_OVERLAP::RunDRC().

◆ kicadTraceCoords

const wxChar* const kicadTraceCoords

Flag to enable draw panel coordinate debug tracing.

Use "KICAD_COORDS" to enable.

Definition at line 34 of file trace_helpers.cpp.

Referenced by EDA_DRAW_PANEL::OnMouseWheel(), EDA_DRAW_PANEL::OnPan(), and EDA_DRAW_PANEL::OnScroll().

◆ kicadTraceKeyEvent

const wxChar* const kicadTraceKeyEvent

Flag to enable wxKeyEvent debug tracing.

Use "KICAD_KEY_EVENTS" to enable.

Definition at line 35 of file trace_helpers.cpp.

Referenced by TOOL_DISPATCHER::DispatchWxEvent(), EDA_DRAW_FRAME::OnCharHook(), EDA_DRAW_PANEL::OnCharHook(), and EDA_DRAW_PANEL::OnKeyEvent().

◆ m_logTrace [1/2]

const wxChar * EDA_3D_VIEWER::m_logTrace = wxT( "KI_TRACE_EDA_3D_VIEWER" )
staticprivate

◆ m_logTrace [2/2]

const wxChar * EDA_3D_CANVAS::m_logTrace = wxT( "KI_TRACE_EDA_3D_CANVAS" )
staticprivate

Trace mask used to enable or disable the trace output of this class.

Flag to enable 3D canvas debug tracing.

The debug output can be turned on by setting the WXTRACE environment variable to "KI_TRACE_EDA_3D_CANVAS". See the wxWidgets documentation on wxLogTrace for more information.

Use "KI_TRACE_EDA_3D_CANVAS" to enable.

Definition at line 289 of file eda_3d_canvas.h.

Referenced by EDA_3D_CANVAS::initializeOpenGL(), EDA_3D_CANVAS::OnEraseBackground(), EDA_3D_CANVAS::OnMouseWheel(), EDA_3D_CANVAS::OnPaint(), EDA_3D_CANVAS::OnPopUpMenu(), EDA_3D_CANVAS::OnRightClick(), and EDA_3D_CANVAS::~EDA_3D_CANVAS().

◆ traceAutoSave

const wxChar* const traceAutoSave

Flag to enable auto save feature debug tracing.

Use "KICAD_AUTOSAVE" to enable.

Definition at line 42 of file trace_helpers.cpp.

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), PCB_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::OnCloseWindow(), EDA_BASE_FRAME::ProcessEvent(), and SCH_EDIT_FRAME::SaveEEFile().

◆ traceFindItem

const wxChar* const traceFindItem

Flag to enable find debug tracing.

Use "KICAD_FIND_ITEM" to enable.

Definition at line 37 of file trace_helpers.cpp.

Referenced by LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_SHEET::Matches(), and SCH_COMPONENT::Matches().

◆ traceFindReplace

const wxChar* const traceFindReplace

Flag to enable find and replace debug tracing.

Use "KICAD_FIND_REPLACE" to enable.

Definition at line 33 of file trace_helpers.cpp.

Referenced by EDA_ITEM::Replace(), and SCH_EDIT_FRAME::updateFindReplaceView().

◆ traceGedaPcbPlugin

const wxChar* const traceGedaPcbPlugin

Flag to enable GEDA PCB plugin debug output.

Use "KICAD_GEDA_PLUGIN" to enable.

Definition at line 39 of file trace_helpers.cpp.

Referenced by GPCB_PLUGIN::FootprintLibDelete(), GPCB_FPL_CACHE::parseMODULE(), and GPCB_FPL_CACHE::parseParameters().

◆ traceHiDpi

const wxChar* const traceHiDpi = wxT( "KICAD_TRACE_HIGH_DPI" )

Flag to enable trace for HiDPI scaling factors.

Use "KICAD_TRACE_HIGH_DPI" to enable.

Definition at line 42 of file dpi_scaling.cpp.

Referenced by DPI_SCALING::GetCanvasIsAutoScaled(), getEnviromentScale(), getKiCadConfiguredScale(), and DPI_SCALING::GetScaleFactor().

◆ traceKicadPcbPlugin

const wxChar* const traceKicadPcbPlugin

Flag to enable GEDA PCB plugin debug output.

Use "KICAD_PCB_PLUGIN" to enable.

Definition at line 40 of file trace_helpers.cpp.

Referenced by PCB_IO::FootprintLibDelete(), PCB_IO::FootprintSave(), and FP_CACHE::Save().

◆ traceLocale

const wxChar* const traceLocale

Flag to enable locale debug output.

Use "KICAD_LOCALE" to enable.

Definition at line 44 of file trace_helpers.cpp.

Referenced by PGM_BASE::SetLanguage(), PGM_BASE::SetLanguageIdentifier(), and PGM_BASE::SetLanguagePath().

◆ tracePathsAndFiles

const wxChar* const tracePathsAndFiles

Flag to enable path and file name debug output.

Use "KICAD_PATHS_AND_FILES" to enable.

Definition at line 43 of file trace_helpers.cpp.

Referenced by copy_pro_file_template(), TREE_PROJECT_FRAME::FileWatcherReset(), FindFileInSearchPaths(), PGM_BASE::InitPgm(), FILENAME_RESOLVER::ResolvePath(), SearchHelpFileFullPath(), and PROJECT::SetProjectFullName().

◆ tracePrinting

const wxChar* const tracePrinting

Flag to enable print controller debug output.

Use "KICAD_PRINT" to enable.

Definition at line 41 of file trace_helpers.cpp.

◆ traceSchLegacyPlugin

const wxChar* const traceSchLegacyPlugin

Flag to enable legacy schematic plugin debug output.

Use "KICAD_SCH_LEGACY_PLUGIN" to enable.

Definition at line 38 of file trace_helpers.cpp.

Referenced by SCH_LEGACY_PLUGIN::Load(), SCH_LEGACY_PLUGIN_CACHE::Load(), SCH_LEGACY_PLUGIN::loadHierarchy(), and SCH_LEGACY_PLUGIN_CACHE::~SCH_LEGACY_PLUGIN_CACHE().

◆ traceSchLibMem

const wxChar* const traceSchLibMem

Flag to enable schematic library memory deletion debug output.

Use "KICAD_SCH_LIB_MEM" to enable.

Definition at line 36 of file trace_helpers.cpp.

Referenced by LIB_PART::RemoveAlias(), LIB_ALIAS::~LIB_ALIAS(), and LIB_PART::~LIB_PART().

◆ traceScreen

const wxChar* const traceScreen

Flag to enable debug output of BASE_SCREEN and it's derivatives.

Use "KICAD_SCREEN" to enable.

Definition at line 45 of file trace_helpers.cpp.

Referenced by BASE_SCREEN::AddGrid(), and BASE_SCREEN::SetZoom().

◆ traceZoomScroll

const wxChar* const traceZoomScroll

Flag to enable debug output of zoom-scrolling calculations in KIGFX::ZOOM_CONTROLLER and derivatives.

Use "KICAD_ZOOM_SCROLL" to enable.

Definition at line 46 of file trace_helpers.cpp.

Referenced by KIGFX::ACCELERATING_ZOOM_CONTROLLER::GetScaleForRotation(), and KIGFX::CONSTANT_ZOOM_CONTROLLER::GetScaleForRotation().