KiCad PCB EDA Suite
Loading...
Searching...
No Matches
trace_helpers.cpp
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, see <https://www.gnu.org/licenses/>.
19 */
20
25
26#include <trace_helpers.h>
27
28#include <wx/tokenzr.h>
29
30const wxChar* const traceFindReplace = wxT( "KICAD_FIND_REPLACE" );
31const wxChar* const kicadTraceCoords = wxT( "KICAD_COORDS" );
32const wxChar* const kicadTraceKeyEvent = wxT( "KICAD_KEY_EVENTS" );
33const wxChar* const kicadTraceToolStack = wxT( "KICAD_TOOL_STACK" );
34const wxChar* const kicadTraceCoroutineStack = wxT( "KICAD_COROUTINE_STACK" );
35const wxChar* const traceSchLibMem = wxT( "KICAD_SCH_LIB_MEM" );
36const wxChar* const traceFindItem = wxT( "KICAD_FIND_ITEM" );
37const wxChar* const traceSchLegacyPlugin = wxT( "KICAD_SCH_LEGACY_PLUGIN" );
38const wxChar* const traceSchPlugin = wxT( "KICAD_SCH_PLUGIN" );
39const wxChar* const traceGedaPcbPlugin = wxT( "KICAD_GEDA_PLUGIN" );
40const wxChar* const traceKicadPcbPlugin = wxT( "KICAD_PCB_PLUGIN" );
41const wxChar* const tracePrinting = wxT( "KICAD_PRINT" );
42const wxChar* const traceAutoSave = wxT( "KICAD_AUTOSAVE" );
43const wxChar* const tracePathsAndFiles = wxT( "KICAD_PATHS_AND_FILES" );
44const wxChar* const traceLocale = wxT( "KICAD_LOCALE" );
45const wxChar* const traceFonts = wxT( "KICAD_FONTS" );
46const wxChar* const traceScreen = wxT( "KICAD_SCREEN" );
47const wxChar* const traceZoomScroll = wxT( "KICAD_ZOOM_SCROLL" );
48const wxChar* const traceSymbolResolver = wxT( "KICAD_SYM_RESOLVE" );
49const wxChar* const traceDisplayLocation = wxT( "KICAD_DISPLAY_LOCATION" );
50const wxChar* const traceSchSheetPaths = wxT( "KICAD_SCH_SHEET_PATHS" );
51const wxChar* const traceSchCurrentSheet = wxT( "KICAD_SCH_CURRENT_SHEET" );
52const wxChar* const traceSchFieldRendering = wxT( "KICAD_SCH_FIELD_RENDERING" );
53const wxChar* const traceSchPainter = wxT( "KICAD_SCH_PAINTER" );
54const wxChar* const traceSchSymbolRef = wxT( "KICAD_SCH_SYMBOL_REF" );
55const wxChar* const traceEnvVars = wxT( "KICAD_ENV_VARS" );
56const wxChar* const traceSchDragNetCollision = wxT( "KICAD_SCH_DRAG_NET_COLLISION" );
57const wxChar* const traceCrossProbeFlash = wxT( "CROSS_PROBE_FLASH" );
58const wxChar* const traceGalProfile = wxT( "KICAD_GAL_PROFILE" );
59const wxChar* const traceGalContext = wxT( "KICAD_GAL_CONTEXT" );
60const wxChar* const traceGalGroups = wxT( "KICAD_GAL_GROUPS" );
61const wxChar* const traceRhi = wxT( "KICAD_RHI" );
62const wxChar* const traceStackedPins = wxT( "KICAD_STACKED_PINS" );
63const wxChar* const traceLibWatch = wxT( "KICAD_LIB_WATCH" );
64const wxChar* const traceKiCad2Step = wxT( "KICAD2STEP" );
65const wxChar* const traceUiProfile = wxT( "KICAD_UI_PROFILE" );
66const wxChar* const traceGit = wxT( "KICAD_GIT" );
67const wxChar* const traceModelPreview = wxT( "KICAD_MODEL_PREVIEW" );
68const wxChar* const traceDiffMerge = wxT( "KICAD_DIFF_MERGE" );
69const wxChar* const traceEagleIo = wxT( "KICAD_EAGLE_IO" );
70const wxChar* const traceDiptraceIo = wxT( "KICAD_DIPTRACE_IO" );
71const wxChar* const traceEasyPc = wxT( "KICAD_EASYPC_IO" );
72const wxChar* const traceCadstarIo = wxT( "KICAD_CADSTAR_IO" );
73const wxChar* const traceFabmaster = wxT( "KICAD_FABMASTER" );
74const wxChar* const traceAltiumIo = wxT( "KICAD_ALTIUM_IO" );
75const wxChar* const traceOdbppIo = wxT( "KICAD_ODBPP_IO" );
76const wxChar* const traceEasyEdaIo = wxT( "KICAD_EASYEDA_IO" );
77const wxChar* const tracePadsIo = wxT( "KICAD_PADS_IO" );
78const wxChar* const tracePcadIo = wxT( "KICAD_PCAD_IO" );
79const wxChar* const traceDesignBlocks = wxT( "KICAD_DESIGN_BLOCK" );
80const wxChar* const traceLibFieldTable = wxT( "KICAD_LIB_FIELD_TABLE" );
81const wxChar* const tracePdfPlotter = wxT( "KICAD_PDF_PLOTTER" );
82const wxChar* const traceSnap = wxT( "KICAD_SNAP" );
83const wxChar* const traceLibraries = wxT( "KICAD_LIBRARIES" );
84const wxChar* const traceDatabase = wxT( "KICAD_DATABASE" );
85const wxChar* const traceSchMove = wxT( "KICAD_SCH_MOVE" );
86const wxChar* const traceSymbolInheritance = wxT( "KICAD_SYMBOL_INHERITANCE" );
87const wxChar* const traceSchNetChain = wxT( "KICAD_SCH_NETCHAIN" );
88const wxChar* const traceImportNetNames = wxT( "KICAD_IMPORT_NET_NAMES" );
89
90#ifdef KICAD_GAL_PROFILE
91LATENCY_PROBE latencyProbeZoomToRender( "zoom-to-render", 16 );
92LATENCY_PROBE latencyProbeRepaintToMotion( "repaint-to-motion", 16 );
93#endif
94
95wxString dump( const wxArrayString& aArray )
96{
97 wxString tmp;
98
99 for( unsigned i = 0; i < aArray.GetCount(); i++ )
100 {
101 if( aArray[i].IsEmpty() )
102 tmp << wxT( "\"\" " );
103 else
104 tmp << aArray[i] << wxT( " " );
105 }
106
107 return tmp;
108}
109
110
111// The following code was shamelessly copied from the wxWidgets keyboard sample
112// at https://github.com/wxWidgets/wxWidgets/blob/master/samples/keyboard/keyboard.cpp.
113
115// Author: Vadim Zeitlin
116// Modified by: Marcin Wojdyr
117// Created: 07.04.02
118// Copyright: (c) 2002 Vadim Zeitlin
119// Licence: wxWindows licence
121
122// helper function that returns textual description of wx virtual keycode
123const char* GetVirtualKeyCodeName(int keycode)
124{
125 switch ( keycode )
126 {
127#define WXK_(x) \
128 case WXK_##x: return #x;
129
130 WXK_(BACK)
131 WXK_(TAB)
132 WXK_(RETURN)
133 WXK_(ESCAPE)
134 WXK_(SPACE)
135 WXK_(DELETE)
136 WXK_(START)
137 WXK_(LBUTTON)
138 WXK_(RBUTTON)
139 WXK_(CANCEL)
140 WXK_(MBUTTON)
141 WXK_(CLEAR)
142 WXK_(SHIFT)
143 WXK_(ALT)
145 WXK_(MENU)
146 WXK_(PAUSE)
147 WXK_(CAPITAL)
148 WXK_(END)
149 WXK_(HOME)
150 WXK_(LEFT)
151 WXK_(UP)
152 WXK_(RIGHT)
153 WXK_(DOWN)
154 WXK_(SELECT)
155 WXK_(PRINT)
156 WXK_(EXECUTE)
157 WXK_(SNAPSHOT)
158 WXK_(INSERT)
159 WXK_(HELP)
160 WXK_(NUMPAD0)
161 WXK_(NUMPAD1)
162 WXK_(NUMPAD2)
163 WXK_(NUMPAD3)
164 WXK_(NUMPAD4)
165 WXK_(NUMPAD5)
166 WXK_(NUMPAD6)
167 WXK_(NUMPAD7)
168 WXK_(NUMPAD8)
169 WXK_(NUMPAD9)
171 WXK_(ADD)
174 WXK_(DECIMAL)
175 WXK_(DIVIDE)
176 WXK_(F1)
177 WXK_(F2)
178 WXK_(F3)
179 WXK_(F4)
180 WXK_(F5)
181 WXK_(F6)
182 WXK_(F7)
183 WXK_(F8)
184 WXK_(F9)
185 WXK_(F10)
186 WXK_(F11)
187 WXK_(F12)
188 WXK_(F13)
189 WXK_(F14)
190 WXK_(F15)
191 WXK_(F16)
192 WXK_(F17)
193 WXK_(F18)
194 WXK_(F19)
195 WXK_(F20)
196 WXK_(F21)
197 WXK_(F22)
198 WXK_(F23)
199 WXK_(F24)
200 WXK_(NUMLOCK)
201 WXK_(SCROLL)
202 WXK_(PAGEUP)
203 WXK_(PAGEDOWN)
204 WXK_(NUMPAD_SPACE)
205 WXK_(NUMPAD_TAB)
206 WXK_(NUMPAD_ENTER)
207 WXK_(NUMPAD_F1)
208 WXK_(NUMPAD_F2)
209 WXK_(NUMPAD_F3)
210 WXK_(NUMPAD_F4)
211 WXK_(NUMPAD_HOME)
212 WXK_(NUMPAD_LEFT)
213 WXK_(NUMPAD_UP)
214 WXK_(NUMPAD_RIGHT)
215 WXK_(NUMPAD_DOWN)
216 WXK_(NUMPAD_PAGEUP)
217 WXK_(NUMPAD_PAGEDOWN)
218 WXK_(NUMPAD_END)
219 WXK_(NUMPAD_BEGIN)
220 WXK_(NUMPAD_INSERT)
221 WXK_(NUMPAD_DELETE)
222 WXK_(NUMPAD_EQUAL)
223 WXK_(NUMPAD_MULTIPLY)
224 WXK_(NUMPAD_ADD)
225 WXK_(NUMPAD_SEPARATOR)
226 WXK_(NUMPAD_SUBTRACT)
227 WXK_(NUMPAD_DECIMAL)
228 WXK_(NUMPAD_DIVIDE)
229
230 WXK_(WINDOWS_LEFT)
231 WXK_(WINDOWS_RIGHT)
232#ifdef __WXOSX__
233 WXK_(RAW_CONTROL)
234#endif
235#undef WXK_
236
237 default:
238 return nullptr;
239 }
240}
241
242
243// helper function that returns textual description of key in the event
244wxString GetKeyName( const wxKeyEvent &aEvent )
245{
246 int keycode = aEvent.GetKeyCode();
247 const char* virt = GetVirtualKeyCodeName( keycode );
248
249 if( virt )
250 return virt;
251
252 if( keycode > 0 && keycode < 32 )
253 return wxString::Format( "Ctrl-%c", (unsigned char)('A' + keycode - 1) );
254
255 if( keycode >= 32 && keycode < 128 )
256 return wxString::Format( "'%c'", (unsigned char)keycode );
257
258#if wxUSE_UNICODE
259 int uc = aEvent.GetUnicodeKey();
260
261 if( uc != WXK_NONE )
262 return wxString::Format( "'%c'", uc );
263#endif
264
265 return "unknown";
266}
267
268
269wxString dump( const wxKeyEvent& aEvent )
270{
271 wxString msg;
272 wxString eventType = wxS( "unknown" );
273
274 if( aEvent.GetEventType() == wxEVT_KEY_DOWN )
275 eventType = wxS( "KeyDown" );
276 else if( aEvent.GetEventType() == wxEVT_KEY_UP )
277 eventType = wxS( "KeyUp" );
278 else if( aEvent.GetEventType() == wxEVT_CHAR )
279 eventType = wxS( "Char" );
280 else if( aEvent.GetEventType() == wxEVT_CHAR_HOOK )
281 eventType = wxS( "Hook" );
282
283 // event key_name KeyCode modifiers Unicode raw_code raw_flags pos
284 msg.Printf( "%7s %15s %5d %c%c%c%c"
285#if wxUSE_UNICODE
286 "%5d (U+%04x)"
287#else
288 " none "
289#endif
290#ifdef wxHAS_RAW_KEY_CODES
291 " %7lu 0x%08lx"
292#else
293 " not-set not-set"
294#endif
295 " (%5d,%5d)",
296 eventType,
297 GetKeyName( aEvent ),
298 aEvent.GetKeyCode(),
299 aEvent.ControlDown() ? 'C' : '-',
300 aEvent.AltDown() ? 'A' : '-',
301 aEvent.ShiftDown() ? 'S' : '-',
302 aEvent.MetaDown() ? 'M' : '-'
303#if wxUSE_UNICODE
304 , aEvent.GetUnicodeKey()
305 , aEvent.GetUnicodeKey()
306#endif
307#ifdef wxHAS_RAW_KEY_CODES
308 , (unsigned long) aEvent.GetRawKeyCode()
309 , (unsigned long) aEvent.GetRawKeyFlags()
310#endif
311 , aEvent.GetX()
312 , aEvent.GetY()
313 );
314
315 return msg;
316}
317
@ ADD
Definition am_param.h:146
@ SUBTRACT
Definition cursors.h:69
const wxChar *const traceSchPainter
Flag to enable debug output of schematic painter operations.
const wxChar *const traceOdbppIo
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 traceDiffMerge
Flag to enable diff/merge engine and renderer debugging output.
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 traceEasyEdaIo
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 traceImportNetNames
Flag to enable tracing of imported net-name reconciliation between a schematic and its board.
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 traceDatabase
Flag to enable database library tracing.
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 traceFabmaster
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 traceEasyPc
const wxChar *const tracePrinting
Flag to enable print controller debug output.
const wxChar *const traceCadstarIo
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 traceGalContext
Flag to enable debug output of GAL context binding.
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 traceModelPreview
Flag to enable native operating-system model preview debug output.
const wxChar *const traceGalGroups
Flag to enable debug output of GAL cached group creation and drawing.
const wxChar *const tracePcadIo
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 traceAltiumIo
const wxChar *const tracePadsIo
const wxChar *const traceDesignBlocks
const wxChar *const traceRhi
Flag to enable debug output of the RHI rendering backend.
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 traceDiptraceIo
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.
@ START
First endpoint of a segment or arc.
static VECTOR2D CLEAR
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.
#define WXK_(x)
wxString GetKeyName(const wxKeyEvent &aEvent)
const char * GetVirtualKeyCodeName(int keycode)
wxLogTrace helper definitions.
#define SEPARATOR