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, 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#include <trace_helpers.h>
31
32#include <wx/tokenzr.h>
33
34const wxChar* const traceFindReplace = wxT( "KICAD_FIND_REPLACE" );
35const wxChar* const kicadTraceCoords = wxT( "KICAD_COORDS" );
36const wxChar* const kicadTraceKeyEvent = wxT( "KICAD_KEY_EVENTS" );
37const wxChar* const kicadTraceToolStack = wxT( "KICAD_TOOL_STACK" );
38const wxChar* const kicadTraceCoroutineStack = wxT( "KICAD_COROUTINE_STACK" );
39const wxChar* const traceSchLibMem = wxT( "KICAD_SCH_LIB_MEM" );
40const wxChar* const traceFindItem = wxT( "KICAD_FIND_ITEM" );
41const wxChar* const traceSchLegacyPlugin = wxT( "KICAD_SCH_LEGACY_PLUGIN" );
42const wxChar* const traceSchPlugin = wxT( "KICAD_SCH_PLUGIN" );
43const wxChar* const traceGedaPcbPlugin = wxT( "KICAD_GEDA_PLUGIN" );
44const wxChar* const traceKicadPcbPlugin = wxT( "KICAD_PCB_PLUGIN" );
45const wxChar* const tracePrinting = wxT( "KICAD_PRINT" );
46const wxChar* const traceAutoSave = wxT( "KICAD_AUTOSAVE" );
47const wxChar* const tracePathsAndFiles = wxT( "KICAD_PATHS_AND_FILES" );
48const wxChar* const traceLocale = wxT( "KICAD_LOCALE" );
49const wxChar* const traceFonts = wxT( "KICAD_FONTS" );
50const wxChar* const traceScreen = wxT( "KICAD_SCREEN" );
51const wxChar* const traceZoomScroll = wxT( "KICAD_ZOOM_SCROLL" );
52const wxChar* const traceSymbolResolver = wxT( "KICAD_SYM_RESOLVE" );
53const wxChar* const traceDisplayLocation = wxT( "KICAD_DISPLAY_LOCATION" );
54const wxChar* const traceSchSheetPaths = wxT( "KICAD_SCH_SHEET_PATHS" );
55const wxChar* const traceEnvVars = wxT( "KICAD_ENV_VARS" );
56const wxChar* const traceGalProfile = wxT( "KICAD_GAL_PROFILE" );
57const wxChar* const traceKiCad2Step = wxT( "KICAD2STEP" );
58const wxChar* const traceUiProfile = wxT( "KICAD_UI_PROFILE" );
59const wxChar* const traceGit = wxT( "KICAD_GIT" );
60const wxChar* const traceEagleIo = wxT( "KICAD_EAGLE_IO" );
61const wxChar* const traceDesignBlocks = wxT( "KICAD_DESIGN_BLOCK" );
62const wxChar* const traceLibFieldTable = wxT( "KICAD_LIB_FIELD_TABLE" );
63const wxChar* const tracePdfPlotter = wxT( "KICAD_PDF_PLOTTER" );
64
65
66wxString dump( const wxArrayString& aArray )
67{
68 wxString tmp;
69
70 for( unsigned i = 0; i < aArray.GetCount(); i++ )
71 {
72 if( aArray[i].IsEmpty() )
73 tmp << wxT( "\"\" " );
74 else
75 tmp << aArray[i] << wxT( " " );
76 }
77
78 return tmp;
79}
80
81
82// The following code was shamelessly copied from the wxWidgets keyboard sample
83// at https://github.com/wxWidgets/wxWidgets/blob/master/samples/keyboard/keyboard.cpp.
84
86// Author: Vadim Zeitlin
87// Modified by: Marcin Wojdyr
88// Created: 07.04.02
89// Copyright: (c) 2002 Vadim Zeitlin
90// Licence: wxWindows licence
92
93// helper function that returns textual description of wx virtual keycode
94const char* GetVirtualKeyCodeName(int keycode)
95{
96 switch ( keycode )
97 {
98#define WXK_(x) \
99 case WXK_##x: return #x;
100
101 WXK_(BACK)
102 WXK_(TAB)
103 WXK_(RETURN)
104 WXK_(ESCAPE)
105 WXK_(SPACE)
106 WXK_(DELETE)
107 WXK_(START)
108 WXK_(LBUTTON)
109 WXK_(RBUTTON)
110 WXK_(CANCEL)
111 WXK_(MBUTTON)
112 WXK_(CLEAR)
113 WXK_(SHIFT)
114 WXK_(ALT)
116 WXK_(MENU)
117 WXK_(PAUSE)
118 WXK_(CAPITAL)
119 WXK_(END)
120 WXK_(HOME)
121 WXK_(LEFT)
122 WXK_(UP)
123 WXK_(RIGHT)
124 WXK_(DOWN)
125 WXK_(SELECT)
126 WXK_(PRINT)
127 WXK_(EXECUTE)
128 WXK_(SNAPSHOT)
129 WXK_(INSERT)
130 WXK_(HELP)
131 WXK_(NUMPAD0)
132 WXK_(NUMPAD1)
133 WXK_(NUMPAD2)
134 WXK_(NUMPAD3)
135 WXK_(NUMPAD4)
136 WXK_(NUMPAD5)
137 WXK_(NUMPAD6)
138 WXK_(NUMPAD7)
139 WXK_(NUMPAD8)
140 WXK_(NUMPAD9)
142 WXK_(ADD)
145 WXK_(DECIMAL)
146 WXK_(DIVIDE)
147 WXK_(F1)
148 WXK_(F2)
149 WXK_(F3)
150 WXK_(F4)
151 WXK_(F5)
152 WXK_(F6)
153 WXK_(F7)
154 WXK_(F8)
155 WXK_(F9)
156 WXK_(F10)
157 WXK_(F11)
158 WXK_(F12)
159 WXK_(F13)
160 WXK_(F14)
161 WXK_(F15)
162 WXK_(F16)
163 WXK_(F17)
164 WXK_(F18)
165 WXK_(F19)
166 WXK_(F20)
167 WXK_(F21)
168 WXK_(F22)
169 WXK_(F23)
170 WXK_(F24)
171 WXK_(NUMLOCK)
172 WXK_(SCROLL)
173 WXK_(PAGEUP)
174 WXK_(PAGEDOWN)
175 WXK_(NUMPAD_SPACE)
176 WXK_(NUMPAD_TAB)
177 WXK_(NUMPAD_ENTER)
178 WXK_(NUMPAD_F1)
179 WXK_(NUMPAD_F2)
180 WXK_(NUMPAD_F3)
181 WXK_(NUMPAD_F4)
182 WXK_(NUMPAD_HOME)
183 WXK_(NUMPAD_LEFT)
184 WXK_(NUMPAD_UP)
185 WXK_(NUMPAD_RIGHT)
186 WXK_(NUMPAD_DOWN)
187 WXK_(NUMPAD_PAGEUP)
188 WXK_(NUMPAD_PAGEDOWN)
189 WXK_(NUMPAD_END)
190 WXK_(NUMPAD_BEGIN)
191 WXK_(NUMPAD_INSERT)
192 WXK_(NUMPAD_DELETE)
193 WXK_(NUMPAD_EQUAL)
194 WXK_(NUMPAD_MULTIPLY)
195 WXK_(NUMPAD_ADD)
196 WXK_(NUMPAD_SEPARATOR)
197 WXK_(NUMPAD_SUBTRACT)
198 WXK_(NUMPAD_DECIMAL)
199 WXK_(NUMPAD_DIVIDE)
200
201 WXK_(WINDOWS_LEFT)
202 WXK_(WINDOWS_RIGHT)
203#ifdef __WXOSX__
204 WXK_(RAW_CONTROL)
205#endif
206#undef WXK_
207
208 default:
209 return nullptr;
210 }
211}
212
213
214// helper function that returns textual description of key in the event
215wxString GetKeyName( const wxKeyEvent &aEvent )
216{
217 int keycode = aEvent.GetKeyCode();
218 const char* virt = GetVirtualKeyCodeName( keycode );
219
220 if( virt )
221 return virt;
222
223 if( keycode > 0 && keycode < 32 )
224 return wxString::Format( "Ctrl-%c", (unsigned char)('A' + keycode - 1) );
225
226 if( keycode >= 32 && keycode < 128 )
227 return wxString::Format( "'%c'", (unsigned char)keycode );
228
229#if wxUSE_UNICODE
230 int uc = aEvent.GetUnicodeKey();
231
232 if( uc != WXK_NONE )
233 return wxString::Format( "'%c'", uc );
234#endif
235
236 return "unknown";
237}
238
239
240wxString dump( const wxKeyEvent& aEvent )
241{
242 wxString msg;
243 wxString eventType = wxS( "unknown" );
244
245 if( aEvent.GetEventType() == wxEVT_KEY_DOWN )
246 eventType = wxS( "KeyDown" );
247 else if( aEvent.GetEventType() == wxEVT_KEY_UP )
248 eventType = wxS( "KeyUp" );
249 else if( aEvent.GetEventType() == wxEVT_CHAR )
250 eventType = wxS( "Char" );
251 else if( aEvent.GetEventType() == wxEVT_CHAR_HOOK )
252 eventType = wxS( "Hook" );
253
254 // event key_name KeyCode modifiers Unicode raw_code raw_flags pos
255 msg.Printf( "%7s %15s %5d %c%c%c%c"
256#if wxUSE_UNICODE
257 "%5d (U+%04x)"
258#else
259 " none "
260#endif
261#ifdef wxHAS_RAW_KEY_CODES
262 " %7lu 0x%08lx"
263#else
264 " not-set not-set"
265#endif
266 " (%5d,%5d)",
267 eventType,
268 GetKeyName( aEvent ),
269 aEvent.GetKeyCode(),
270 aEvent.ControlDown() ? 'C' : '-',
271 aEvent.AltDown() ? 'A' : '-',
272 aEvent.ShiftDown() ? 'S' : '-',
273 aEvent.MetaDown() ? 'M' : '-'
274#if wxUSE_UNICODE
275 , aEvent.GetUnicodeKey()
276 , aEvent.GetUnicodeKey()
277#endif
278#ifdef wxHAS_RAW_KEY_CODES
279 , (unsigned long) aEvent.GetRawKeyCode()
280 , (unsigned long) aEvent.GetRawKeyFlags()
281#endif
282 , aEvent.GetX()
283 , aEvent.GetY()
284 );
285
286 return msg;
287}
288
289
291{
292 static TRACE_MANAGER* self = nullptr;
293
294 if( !self )
295 {
296 self = new TRACE_MANAGER;
297 self->init();
298 }
299
300 return *self;
301}
302
303
304bool TRACE_MANAGER::IsTraceEnabled( const wxString& aWhat )
305{
306 if( !m_printAllTraces )
307 {
309 return false;
310
311 if( m_enabledTraces.find( aWhat ) == m_enabledTraces.end() )
312 return false;
313 }
314
315 return true;
316}
317
318
319void TRACE_MANAGER::traceV( const wxString& aWhat, const wxString& aFmt, va_list vargs )
320{
321 if( !IsTraceEnabled( aWhat ) )
322 return;
323
324 wxString str;
325 str.PrintfV( aFmt, vargs );
326
327#if defined( __UNIX__ ) || defined( _WIN32 )
328 fprintf( stderr, " %-30s | %s", aWhat.c_str().AsChar(), str.c_str().AsChar() );
329#endif
330}
331
332
334{
335 wxString traceVars;
336 m_globalTraceEnabled = wxGetEnv( wxT( "KICAD_TRACE" ), &traceVars );
337 m_printAllTraces = false;
338
340 return;
341
342 wxStringTokenizer tokenizer( traceVars, "," );
343
344 while( tokenizer.HasMoreTokens() )
345 {
346 wxString token = tokenizer.GetNextToken();
347 m_enabledTraces[token] = true;
348
349 if( token.Lower() == wxT( "all" ) )
350 m_printAllTraces = true;
351 }
352}
@ ADD
Definition am_param.h:150
static TRACE_MANAGER & Instance()
const wxChar * aFmt
traceV(aWhat, aFmt, argptr)
bool IsTraceEnabled(const wxString &aWhat)
bool m_globalTraceEnabled
std::map< wxString, bool > m_enabledTraces
@ SUBTRACT
Definition cursors.h:70
const wxChar *const traceSymbolResolver
Flag to enable debug output of symbol library resolver results.
const wxChar *const traceLocale
Flag to enable locale debug output.
const wxChar *const traceKicadPcbPlugin
Flag to enable GEDA 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 traceSchLegacyPlugin
Flag to enable legacy schematic plugin debug output.
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 tracePdfPlotter
Flag to enable PDF plotter debug tracing.
const wxChar *const traceDesignBlocks
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.
static VECTOR2D CLEAR
@ CANCEL
Action can be cancelled by clicking the toolbar button again.
Definition tool_action.h:65
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