KiCad PCB EDA Suite
Loading...
Searching...
No Matches
trace_helpers.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018 Wayne Stambaugh <[email protected]>
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
29
30#ifndef _TRACE_HELPERS_H_
31#define _TRACE_HELPERS_H_
32
33#include <kicommon.h>
34#include <wx/arrstr.h>
35#include <wx/event.h>
36#include <wx/string.h>
37
38#include <stdarg.h>
39#include <map>
40
41#ifdef KICAD_GAL_PROFILE
42#include <core/profile.h>
43#endif
44
54
57
63extern KICOMMON_API const wxChar* const traceFindItem;
64
70extern KICOMMON_API const wxChar* const traceFindReplace;
71
77extern KICOMMON_API const wxChar* const kicadTraceCoords;
78
84extern KICOMMON_API const wxChar* const kicadTraceKeyEvent;
85
91extern KICOMMON_API const wxChar* const kicadTraceToolStack;
92
98extern KICOMMON_API const wxChar* const kicadTraceCoroutineStack;
99
105extern KICOMMON_API const wxChar* const traceAutoSave;
106
112extern KICOMMON_API const wxChar* const traceSchLibMem;
113
119extern KICOMMON_API const wxChar* const traceSchPlugin;
120
126extern KICOMMON_API const wxChar* const traceSchLegacyPlugin;
127
133extern KICOMMON_API const wxChar* const traceKicadPcbPlugin;
134
140extern KICOMMON_API const wxChar* const traceGedaPcbPlugin;
141
147extern KICOMMON_API const wxChar* const tracePrinting;
148
154extern KICOMMON_API const wxChar* const tracePathsAndFiles;
155
161extern KICOMMON_API const wxChar* const traceLocale;
162
168extern KICOMMON_API const wxChar* const traceFonts;
169
175extern KICOMMON_API const wxChar* const traceScreen;
176
182extern KICOMMON_API const wxChar* const traceDisplayLocation;
183
190extern KICOMMON_API const wxChar* const traceZoomScroll;
191
197extern KICOMMON_API const wxChar* const traceSymbolResolver;
198
204extern KICOMMON_API const wxChar* const traceSchSheetPaths;
205
211extern KICOMMON_API const wxChar* const traceSchCurrentSheet;
212
218extern KICOMMON_API const wxChar* const traceSchFieldRendering;
219
225extern KICOMMON_API const wxChar* const traceSchPainter;
226
232extern KICOMMON_API const wxChar* const traceSchSymbolRef;
233
239extern KICOMMON_API const wxChar* const traceSchDragNetCollision;
240
246extern KICOMMON_API const wxChar* const traceCrossProbeFlash;
247
253extern KICOMMON_API const wxChar* const traceEnvVars;
254
260extern KICOMMON_API const wxChar* const traceGalProfile;
261
267extern KICOMMON_API const wxChar* const traceKiCad2Step;
268
274extern KICOMMON_API const wxChar* const traceUiProfile;
275
281extern KICOMMON_API const wxChar* const traceGit;
282
283/*
284 * Flag to enable Eagle I/O debug tracing.
285 *
286 * Use "KICAD_EAGLE_IO" to enable.
287 */
288extern KICOMMON_API const wxChar* const traceEagleIo;
289
290/*
291 * Flag to enable Design Block O debug tracing.
292 *
293 * Use "KICAD_EAGLE_IO" to enable.
294 */
295extern KICOMMON_API const wxChar* const traceDesignBlocks;
296
297/*
298 * Flag to enable library field table debug tracing.
299 *
300 * Use "KICAD_LIB_FIELD_TABLE" to enable.
301 */
302extern KICOMMON_API const wxChar* const traceLibFieldTable;
303
309extern KICOMMON_API const wxChar* const tracePdfPlotter;
310
316extern KICOMMON_API const wxChar* const traceSnap;
317
323extern KICOMMON_API const wxChar* const traceStackedPins;
324
330extern KICOMMON_API const wxChar* const traceLibWatch;
331
336extern KICOMMON_API const wxChar* const traceLibraries;
337
343extern KICOMMON_API const wxChar* const traceSchMove;
344
350extern KICOMMON_API const wxChar* const traceSymbolInheritance;
351
357extern KICOMMON_API const wxChar* const traceSchNetChain;
358
360
367extern KICOMMON_API wxString dump( const wxKeyEvent& aEvent );
368
375extern KICOMMON_API wxString dump( const wxArrayString& aArray );
376
377
378#ifdef KICAD_GAL_PROFILE
379extern KICOMMON_API LATENCY_PROBE latencyProbeZoomToRender;
380extern KICOMMON_API LATENCY_PROBE latencyProbeRepaintToMotion;
381#endif
382
383#endif // _TRACE_HELPERS_H_
const wxChar *const traceSchPainter
Flag to enable debug output of schematic painter operations.
const wxChar *const traceSchSymbolRef
Flag to enable debug output of schematic symbol reference resolution.
const wxChar *const traceLibraries
Flag to enable library table and library manager tracing.
const wxChar *const traceSymbolResolver
Flag to enable debug output of symbol library resolver results.
const wxChar *const traceSchFieldRendering
Flag to enable debug output of schematic field rendering and positioning.
const wxChar *const traceLibWatch
Flag to enable debug output for library file watch refreshes.
const wxChar *const traceSymbolInheritance
Flag to enable tracing of circular symbol inheritance detection.
const wxChar *const traceLocale
Flag to enable locale debug output.
const wxChar *const traceSchCurrentSheet
Flag to enable debug output of current sheet tracking in the schematic editor.
const wxChar *const traceKicadPcbPlugin
Flag to enable KiCad PCB plugin debug output.
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.
const wxChar *const traceUiProfile
Flag to enable user interface profile tracing.
const wxChar *const traceEnvVars
Flag to enable debug output of environment variable operations.
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
const wxChar *const traceFindItem
Flag to enable find debug tracing.
const wxChar *const kicadTraceCoroutineStack
Flag to enable tracing of the coroutine call stack.
const wxChar *const traceSchLibMem
Flag to enable schematic library memory deletion debug output.
const wxChar *const traceEagleIo
const wxChar *const tracePathsAndFiles
Flag to enable path and file name debug output.
const wxChar *const traceKiCad2Step
Flag to enable KiCad2Step debug tracing.
const wxChar *const traceSchPlugin
Flag to enable legacy schematic plugin debug output.
const wxChar *const traceSchSheetPaths
Flag to enable debug output of schematic symbol sheet path manipulation code.
const wxChar *const traceSchNetChain
Flag to enable tracing of schematic net chain rebuild and ERC cross-chain checks.
const wxChar *const traceSchDragNetCollision
Flag to enable debug output of schematic drag net collision detection.
const wxChar *const traceCrossProbeFlash
Flag to enable debug output for cross-probe flash operations.
const wxChar *const traceSchLegacyPlugin
Flag to enable legacy schematic plugin debug output.
const wxChar *const traceSchMove
Flag to watch how schematic move tool actions are handled.
const wxChar *const tracePrinting
Flag to enable print controller debug output.
const wxChar *const kicadTraceCoords
Flag to enable draw panel coordinate debug tracing.
const wxChar *const traceZoomScroll
Flag to enable debug output of zoom-scrolling calculations in KIGFX::ZOOM_CONTROLLER and derivatives.
const wxChar *const traceGedaPcbPlugin
Flag to enable GEDA PCB plugin debug output.
const wxChar *const traceScreen
Flag to enable debug output of BASE_SCREEN and it's derivatives.
const wxChar *const traceSnap
Flag to enable snap/grid helper debug tracing.
const wxChar *const tracePdfPlotter
Flag to enable PDF plotter debug tracing.
const wxChar *const traceDesignBlocks
const wxChar *const traceStackedPins
Flag to enable debug output for stacked pins handling in symbol/pin code.
const wxChar *const traceFonts
Flag to enable locale debug output.
const wxChar *const traceGit
Flag to enable Git debugging output.
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
const wxChar *const traceLibFieldTable
const wxChar *const kicadTraceToolStack
Flag to enable tracing of the tool handling stack.
const wxChar *const traceGalProfile
Flag to enable debug output of GAL performance profiling.
#define KICOMMON_API
Definition kicommon.h:27
KICOMMON_API wxString dump(const wxKeyEvent &aEvent)
Debug helper for printing wxKeyEvent information.