182 lines
4.6 KiB
C
182 lines
4.6 KiB
C
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2018 Wayne Stambaugh <stambaughw@gmail.com>
|
|
* Copyright (C) 2018-2019 KiCad Developers, see change_log.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
/**
|
|
* @file trace_helpers.h
|
|
* @brief wxLogTrace helper definitions.
|
|
*/
|
|
|
|
#ifndef _TRACE_HELPERS_H_
|
|
#define _TRACE_HELPERS_H_
|
|
|
|
#include <wx/arrstr.h>
|
|
#include <wx/event.h>
|
|
#include <wx/string.h>
|
|
|
|
/**
|
|
* @defgroup trace_env_vars Trace Environment Variables
|
|
*
|
|
* 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 <a href="http://docs.wxwidgets.org/3.0/
|
|
* group__group__funcmacro__log.html#ga947e317db477914c12b13c4534867ec9"> wxLogTrace </a>
|
|
* documentation for more information.
|
|
*/
|
|
|
|
///@{
|
|
/// \ingroup trace_env_vars
|
|
|
|
/**
|
|
* Flag to enable find debug tracing.
|
|
*
|
|
* Use "KICAD_FIND_ITEM" to enable.
|
|
*/
|
|
extern const wxChar* const traceFindItem;
|
|
|
|
/**
|
|
* Flag to enable find and replace debug tracing.
|
|
*
|
|
* Use "KICAD_FIND_REPLACE" to enable.
|
|
*/
|
|
extern const wxChar* const traceFindReplace;
|
|
|
|
/**
|
|
* Flag to enable draw panel coordinate debug tracing.
|
|
*
|
|
* Use "KICAD_COORDS" to enable.
|
|
*/
|
|
extern const wxChar* const kicadTraceCoords;
|
|
|
|
/**
|
|
* Flag to enable wxKeyEvent debug tracing.
|
|
*
|
|
* Use "KICAD_KEY_EVENTS" to enable.
|
|
*/
|
|
extern const wxChar* const kicadTraceKeyEvent;
|
|
|
|
/**
|
|
* Flag to enable tracing of the tool handling stack.
|
|
*
|
|
* Use "KICAD_TOOL_STACK" to enable.
|
|
*/
|
|
extern const wxChar* const kicadTraceToolStack;
|
|
|
|
/**
|
|
* Flag to enable auto save feature debug tracing.
|
|
*
|
|
* Use "KICAD_AUTOSAVE" to enable.
|
|
*/
|
|
extern const wxChar* const traceAutoSave;
|
|
|
|
/**
|
|
* Flag to enable schematic library memory deletion debug output.
|
|
*
|
|
* Use "KICAD_SCH_LIB_MEM" to enable.
|
|
*/
|
|
extern const wxChar* const traceSchLibMem;
|
|
|
|
/**
|
|
* Flag to enable legacy schematic plugin debug output.
|
|
*
|
|
* Use "KICAD_SCH_LEGACY_PLUGIN" to enable.
|
|
*/
|
|
extern const wxChar* const traceSchLegacyPlugin;
|
|
|
|
/**
|
|
* Flag to enable GEDA PCB plugin debug output.
|
|
*
|
|
* Use "KICAD_PCB_PLUGIN" to enable.
|
|
*/
|
|
extern const wxChar* const traceKicadPcbPlugin;
|
|
|
|
/**
|
|
* Flag to enable GEDA PCB plugin debug output.
|
|
*
|
|
* Use "KICAD_GEDA_PLUGIN" to enable.
|
|
*/
|
|
extern const wxChar* const traceGedaPcbPlugin;
|
|
|
|
/**
|
|
* Flag to enable print controller debug output.
|
|
*
|
|
* Use "KICAD_PRINT" to enable.
|
|
*/
|
|
extern const wxChar* const tracePrinting;
|
|
|
|
/**
|
|
* Flag to enable path and file name debug output.
|
|
*
|
|
* Use "KICAD_PATHS_AND_FILES" to enable.
|
|
*/
|
|
extern const wxChar* const tracePathsAndFiles;
|
|
|
|
/**
|
|
* Flag to enable locale debug output.
|
|
*
|
|
* Use "KICAD_LOCALE" to enable.
|
|
*/
|
|
extern const wxChar* const traceLocale;
|
|
|
|
/**
|
|
* Flag to enable debug output of #BASE_SCREEN and it's derivatives.
|
|
*
|
|
* Use "KICAD_SCREEN" to enable.
|
|
*/
|
|
extern const wxChar* const traceScreen;
|
|
|
|
/**
|
|
* Flag to enable debug output of zoom-scrolling calculations in
|
|
* #KIGFX::ZOOM_CONTROLLER and derivatives.
|
|
*
|
|
* Use "KICAD_ZOOM_SCROLL" to enable.
|
|
*/
|
|
extern const wxChar* const traceZoomScroll;
|
|
|
|
/**
|
|
* Flag to enable debug output of symbol library resolver results
|
|
*
|
|
* Use "KICAD_SYM_RESOLVE" to enable.
|
|
*/
|
|
extern const wxChar* const traceSymbolResolver;
|
|
|
|
///@}
|
|
|
|
/**
|
|
* Debug helper for printing wxKeyEvent information.
|
|
*
|
|
* @param aEvent is the wxKeyEvent to generate the print string from.
|
|
* @return the wxKeyEvent information.
|
|
*/
|
|
extern wxString dump( const wxKeyEvent& aEvent );
|
|
|
|
/**
|
|
* Debug helper for printing wxArrayString contents.
|
|
*
|
|
* @param aArray is the string array to output.
|
|
* @return the wxArrayString contents in a formatted string for debugging output.
|
|
*/
|
|
extern wxString dump( const wxArrayString& aArray );
|
|
|
|
#endif // _TRACE_HELPERS_H_
|