trace_helpers.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2018-2024 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
 */
 
#ifndef _TRACE_HELPERS_H_
#define _TRACE_HELPERS_H_
 
#include <kicommon.h>
#include <wx/arrstr.h>
#include <wx/event.h>
#include <wx/string.h>
 
#include <stdarg.h>
#include <map>
 
 
extern KICOMMON_API const wxChar* const traceFindItem;
 
extern KICOMMON_API const wxChar* const traceFindReplace;
 
extern KICOMMON_API const wxChar* const kicadTraceCoords;
 
extern KICOMMON_API const wxChar* const kicadTraceKeyEvent;
 
extern KICOMMON_API const wxChar* const kicadTraceToolStack;
 
extern KICOMMON_API const wxChar* const kicadTraceCoroutineStack;
 
extern KICOMMON_API const wxChar* const traceAutoSave;
 
extern KICOMMON_API const wxChar* const traceSchLibMem;
 
extern KICOMMON_API const wxChar* const traceSchPlugin;
 
extern KICOMMON_API const wxChar* const traceSchLegacyPlugin;
 
extern KICOMMON_API const wxChar* const traceKicadPcbPlugin;
 
extern KICOMMON_API const wxChar* const traceGedaPcbPlugin;
 
extern KICOMMON_API const wxChar* const tracePrinting;
 
extern KICOMMON_API const wxChar* const tracePathsAndFiles;
 
extern KICOMMON_API const wxChar* const traceLocale;
 
extern KICOMMON_API const wxChar* const traceFonts;
 
extern KICOMMON_API const wxChar* const traceScreen;
 
extern KICOMMON_API const wxChar* const traceDisplayLocation;
 
extern KICOMMON_API const wxChar* const traceZoomScroll;
 
extern KICOMMON_API const wxChar* const traceSymbolResolver;
 
extern KICOMMON_API const wxChar* const traceSchSheetPaths;
 
extern KICOMMON_API const wxChar* const traceEnvVars;
 
extern KICOMMON_API const wxChar* const traceGalProfile;
 
extern KICOMMON_API const wxChar* const traceKiCad2Step;
 
extern KICOMMON_API const wxChar* const traceUiProfile;
 
extern KICOMMON_API const wxChar* const traceGit;
 
/*
 * Flag to enable Eagle I/O debug tracing.
 *
 * Use "KICAD_EAGLE_IO" to enable.
 */
extern KICOMMON_API const wxChar* const traceEagleIo;
 
/*
 * Flag to enable Design Block O debug tracing.
 *
 * Use "KICAD_EAGLE_IO" to enable.
 */
extern KICOMMON_API const wxChar* const traceDesignBlocks;
 
 
extern KICOMMON_API wxString dump( const wxKeyEvent& aEvent );
 
extern KICOMMON_API wxString dump( const wxArrayString& aArray );
 
class KICOMMON_API TRACE_MANAGER
{
public:
    TRACE_MANAGER() :
        m_globalTraceEnabled( false ),
        m_printAllTraces (false )
    {};
    ~TRACE_MANAGER(){};
 
    static TRACE_MANAGER& Instance();
 
    WX_DEFINE_VARARG_FUNC_VOID( Trace, 2, (const wxString, const wxFormatString&), DoTrace,
                                DoTraceUtf8 )
 
    void DoTrace( const wxString aWhat, const wxChar* aFmt, ... )
    {
        va_list argptr;
        va_start( argptr, aFmt );
        traceV( aWhat, aFmt, argptr );
        va_end( argptr );
    }
 
#if wxUSE_UNICODE_UTF8
    void DoTraceUtf8( const wxString aWhat, const wxChar* aFmt, ... )
    {
        va_list argptr;
        va_start( argptr, aFmt );
        traceV( aWhat, aFmt, argptr );
        va_end( argptr );
    }
#endif
 
    bool IsTraceEnabled( const wxString& aWhat );
 
private:
    void traceV( const wxString& aWhat, const wxString& aFmt, va_list vargs );
    void init();
 
    std::map<wxString, bool> m_enabledTraces;
    bool                     m_globalTraceEnabled;
    bool                     m_printAllTraces;
};
 
#define KI_TRACE( aWhat, ... )                                                                     \
    if( TRACE_MANAGER::Instance().IsTraceEnabled( aWhat ) )                                        \
    {                                                                                              \
        TRACE_MANAGER::Instance().Trace( aWhat, __VA_ARGS__ );                                     \
    }                                                                                              \
    else                                                                                           \
    {                                                                                              \
    }
 
#endif    // _TRACE_HELPERS_H_