simulator_control.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.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, see <https://www.gnu.org/licenses/>.
 */
 
#include "tools/simulator_control.h"
 
#define wxUSE_BASE64 1
#include <wx/base64.h>
 
#include <wx/ffile.h>
#include <wx/filedlg.h>
#include <wx_filename.h>
#include <kiplatform/ui.h>
#include <wx/stc/stc.h>
 
#include <kiway.h>
#include <confirm.h>
#include <wildcards_and_files_ext.h>
#include <widgets/wx_html_report_box.h>
#include <project/project_file.h>
#include <sch_edit_frame.h>
#include <sim/simulator_frame.h>
#include <sim/sim_plot_tab.h>
#include <tool/tool_manager.h>
#include <tools/sch_actions.h>
#include <scintilla_tricks.h>
#include <sim/spice_circuit_model.h>
#include <dialogs/dialog_user_defined_signals.h>
#include <wx/clipbrd.h>
#include <wx/dataobj.h>
#include <wx/mstream.h>
#include <richio.h>
#include <string_utils.h>
 
 
bool SIMULATOR_CONTROL::Init()
{
    Reset( MODEL_RELOAD );
    return true;
}
 
 
void SIMULATOR_CONTROL::Reset( RESET_REASON aReason )
{
    m_simulatorFrame = getEditFrame<SIMULATOR_FRAME>();
 
    if( m_simulatorFrame )
    {
        m_schematicFrame = m_simulatorFrame->GetSchematicFrame();
        m_circuitModel = m_simulatorFrame->GetCircuitModel();
        m_simulator = m_simulatorFrame->GetSimulator();
    }
}
 
 
int SIMULATOR_CONTROL::NewAnalysisTab( const TOOL_EVENT& aEvent )
{
    DIALOG_SIM_COMMAND dlg( m_simulatorFrame, m_circuitModel, m_simulator->Settings() );
    WX_STRING_REPORTER reporter;
 
    m_circuitModel->ReadSchematicAndLibraries( NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS,
                                               reporter );
 
    if( reporter.HasMessageOfSeverity( RPT_SEVERITY_UNDEFINED | RPT_SEVERITY_ERROR ) )
    {
        DisplayErrorMessage( m_simulatorFrame, _( "Errors during netlist generation." ),
                             reporter.GetMessages() );
    }
    else if( reporter.HasMessageOfSeverity( RPT_SEVERITY_WARNING ) )
    {
        DisplayInfoMessage( m_simulatorFrame, _( "Warnings during netlist generation." ),
                            reporter.GetMessages() );
    }
 
    dlg.SetSimCommand( wxS( "*" ) );
    dlg.SetSimOptions( NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS );
 
    if( dlg.ShowModal() == wxID_OK )
    {
        SIM_TAB* tab = m_simulatorFrame->NewSimTab( dlg.GetSimCommand() );
        dlg.ApplySettings( tab );
        m_simulatorFrame->OnModify();
    }
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::OpenWorkbook( const TOOL_EVENT& aEvent )
{
    wxFileDialog openDlg( m_simulatorFrame, _( "Open Simulation Workbook" ), getDefaultPath(), "",
                          FILEEXT::WorkbookFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST );
 
    KIPLATFORM::UI::AllowNetworkFileSystems( &openDlg );
 
    if( openDlg.ShowModal() == wxID_CANCEL )
        return -1;
 
    m_simulatorFrame->LoadWorkbook( openDlg.GetPath() );
    return 0;
}
 
 
wxString SIMULATOR_CONTROL::getDefaultFilename()
{
    wxFileName filename = m_simulator->Settings()->GetWorkbookFilename();
 
    if( filename.GetName().IsEmpty() )
    {
        if( m_simulatorFrame->Prj().GetProjectName().IsEmpty() )
        {
            filename.SetName( _( "noname" ) );
            filename.SetExt( FILEEXT::WorkbookFileExtension );
        }
        else
        {
            filename.SetName( m_simulatorFrame->Prj().GetProjectName() );
            filename.SetExt( FILEEXT::WorkbookFileExtension );
        }
    }
 
    return filename.GetFullName();
}
 
 
wxString SIMULATOR_CONTROL::getDefaultPath()
{
    wxFileName path = m_simulator->Settings()->GetWorkbookFilename();
 
    path.Normalize( FN_NORMALIZE_FLAGS|wxPATH_NORM_ENV_VARS,
                    m_simulatorFrame->Prj().GetProjectPath() );
    return path.GetPath();
}
 
 
int SIMULATOR_CONTROL::SaveWorkbook( const TOOL_EVENT& aEvent )
{
    wxString filename;
 
    if( aEvent.IsAction( &SCH_ACTIONS::saveWorkbook ) )
        filename = m_simulator->Settings()->GetWorkbookFilename();
 
    if( filename.IsEmpty() )
    {
        wxFileDialog saveAsDlg( m_simulatorFrame, _( "Save Simulation Workbook As" ),
                                getDefaultPath(), getDefaultFilename(),
                                FILEEXT::WorkbookFileWildcard(),
                                wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
        KIPLATFORM::UI::AllowNetworkFileSystems( &saveAsDlg );
 
        if( saveAsDlg.ShowModal() == wxID_CANCEL )
            return -1;
 
        filename = saveAsDlg.GetPath();
    }
 
    m_simulatorFrame->SaveWorkbook( m_simulatorFrame->Prj().AbsolutePath( filename ) );
    return 0;
}
 
 
int SIMULATOR_CONTROL::ExportPlotAsPNG( const TOOL_EVENT& aEvent )
{
    if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( getCurrentSimTab() ) )
    {
        wxFileDialog saveDlg( m_simulatorFrame, _( "Save Plot as Image" ), "", "",
                              FILEEXT::PngFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
        KIPLATFORM::UI::AllowNetworkFileSystems( &saveDlg );
 
        if( saveDlg.ShowModal() == wxID_CANCEL )
            return -1;
 
        wxImage screenImage;
        plotTab->GetPlotWin()->SaveScreenshot( screenImage );
        screenImage.SaveFile( saveDlg.GetPath(), wxBITMAP_TYPE_PNG );
    }
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::ExportPlotToClipboard( const TOOL_EVENT& aEvent )
{
    if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( getCurrentSimTab() ) )
    {
        wxImage screenImage;
        plotTab->GetPlotWin()->SaveScreenshot( screenImage );
 
        if( wxTheClipboard->Open() )
        {
            wxBitmap bm( screenImage );
 
            wxTheClipboard->SetData( new wxBitmapDataObject( bm ) );
            wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
            wxTheClipboard->Close();
        }
    }
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::ExportPlotToSchematic( const TOOL_EVENT& aEvent )
{
    if( m_schematicFrame == nullptr )
        return -1;
 
    if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( getCurrentSimTab() ) )
    {
        wxWindow* blocking_dialog = m_schematicFrame->Kiway().GetBlockingDialog();
 
        if( blocking_dialog )
            blocking_dialog->Close( true );
 
        wxImage screenImage;
        plotTab->GetPlotWin()->SaveScreenshot( screenImage );
 
        if( wxTheClipboard->Open() )
        {
            // Build a PNG bitmap:
            wxMemoryOutputStream stream;
            screenImage.SaveFile( stream, wxBITMAP_TYPE_PNG );
            stream.Close();
 
            // Create a SCH_BITMAP data string
            wxString string;
            string << "(image (at 0 0)\n";
            string << "  (data\n";
 
            wxMemoryBuffer buff;
            buff.GetWriteBuf( stream.GetLength() );
            stream.CopyTo( buff.GetData(), stream.GetLength() );
            buff.SetDataLen( stream.GetLength() );
 
            wxString out;
            out << wxBase64Encode( buff );
 
            #define MIME_BASE64_LENGTH 76
            size_t first = 0;
 
            while( first < out.Length() )
            {
                string << "    \"" << TO_UTF8( out( first, MIME_BASE64_LENGTH ) );
                string << "\"\n";
                first += MIME_BASE64_LENGTH;
            }
            string << "  )\n)\n";
 
            wxTheClipboard->SetData( new wxTextDataObject( string ) );
            wxTheClipboard->Close();
 
            m_schematicFrame->GetToolManager()->PostAction( ACTIONS::paste );
            m_schematicFrame->Raise();
        }
    }
 
    return 0;
}
 
 
SIM_TAB* SIMULATOR_CONTROL::getCurrentSimTab()
{
    return m_simulatorFrame->GetCurrentSimTab();
}
 
 
int SIMULATOR_CONTROL::ExportPlotAsCSV( const TOOL_EVENT& aEvent )
{
    if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( getCurrentSimTab() ) )
    {
        const wxChar SEPARATOR = ';';
 
        wxFileDialog saveDlg( m_simulatorFrame, _( "Save Plot Data" ), "", "",
                              FILEEXT::CsvFileWildcard(),
                              wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
        KIPLATFORM::UI::AllowNetworkFileSystems( &saveDlg );
 
        if( saveDlg.ShowModal() == wxID_CANCEL )
            return -1;
 
        wxFFile out( saveDlg.GetPath(), "wb" );
 
        std::map<wxString, TRACE*> traces = plotTab->GetTraces();
 
        if( traces.size() == 0 )
            return -1;
 
        SIM_TYPE simType = plotTab->GetSimType();
 
        if( plotTab->IsSmithMode() )
        {
            // smith traces hold Re/Im of the reflection coefficient, frequency lives beside them
            std::vector<SMITH_TRACE*> smithTraces;
 
            for( const auto& [name, trace] : traces )
            {
                if( SMITH_TRACE* smithTrace = dynamic_cast<SMITH_TRACE*>( trace ) )
                    smithTraces.push_back( smithTrace );
            }
 
            if( smithTraces.empty() )
                return -1;
 
            const std::vector<double>& freqs = smithTraces[0]->GetFrequencies();
 
            out.Write( wxString::Format( wxT( "%s%c" ), wxS( "frequency" ), SEPARATOR ) );
 
            for( SMITH_TRACE* trace : smithTraces )
            {
                out.Write( wxString::Format( wxT( "%s Re%c%s Im%c" ), trace->GetDisplayName(), SEPARATOR,
                                             trace->GetDisplayName(), SEPARATOR ) );
            }
 
            out.Write( wxS( "\r\n" ) );
 
            for( std::size_t curRow = 0; curRow < freqs.size(); curRow++ )
            {
                out.Write( wxString::Format( wxT( "%g%c" ), freqs[curRow], SEPARATOR ) );
 
                for( SMITH_TRACE* trace : smithTraces )
                {
                    double re = curRow < trace->GetDataX().size() ? trace->GetDataX()[curRow] : 0.0;
                    double im = curRow < trace->GetDataY().size() ? trace->GetDataY()[curRow] : 0.0;
 
                    out.Write( wxString::Format( wxT( "%g%c%g%c" ), re, SEPARATOR, im, SEPARATOR ) );
                }
 
                out.Write( wxS( "\r\n" ) );
            }
 
            out.Close();
            return 0;
        }
 
        std::size_t rowCount = traces.begin()->second->GetDataX().size();
 
        // write column header names on the first row
        wxString xAxisName( m_simulator->GetXAxis( simType ) );
        out.Write( wxString::Format( wxT( "%s%c" ), xAxisName, SEPARATOR ) );
 
        for( const auto& [name, trace] : traces )
            out.Write( wxString::Format( wxT( "%s%c" ), trace->GetDisplayName(), SEPARATOR ) );
 
        out.Write( wxS( "\r\n" ) );
 
        // write each row's numerical value
        for ( std::size_t curRow=0; curRow < rowCount; curRow++ )
        {
            double xAxisValue = traces.begin()->second->GetDataX().at( curRow );
            out.Write( wxString::Format( wxT( "%g%c" ), xAxisValue, SEPARATOR ) );
 
            for( const auto& [name, trace] : traces )
            {
                double yAxisValue = trace->GetDataY().at( curRow );
                out.Write( wxString::Format( wxT( "%g%c" ), yAxisValue, SEPARATOR ) );
            }
 
            out.Write( wxS( "\r\n" ) );
        }
 
        out.Close();
    }
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::Close( const TOOL_EVENT& aEvent )
{
    m_simulatorFrame->Close();
    return 0;
}
 
 
int SIMULATOR_CONTROL::Zoom( const TOOL_EVENT& aEvent )
{
    if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( getCurrentSimTab() ) )
    {
        mpWindow* plot = plotTab->GetPlotWin();
 
        if( plotTab->IsSmithMode() )
        {
            // the chart is drawn from the Smith view, not the hidden axes
            wxPoint center( plot->GetScrX() / 2, plot->GetScrY() / 2 );
 
            if( aEvent.IsAction( &ACTIONS::zoomInCenter ) )
            {
                plotTab->SmithZoomAt( center, 1.5 );
            }
            else if( aEvent.IsAction( &ACTIONS::zoomOutCenter ) )
            {
                plotTab->SmithZoomAt( center, 1.0 / 1.5 );
            }
            else if( aEvent.IsAction( &ACTIONS::zoomFitScreen ) )
            {
                plotTab->ResetSmithView();
                plot->Refresh();
            }
 
            return 0;
        }
 
        if( aEvent.IsAction( &ACTIONS::zoomInCenter ) )
        {
            plot->ZoomIn();
        }
        else if( aEvent.IsAction( &ACTIONS::zoomOutCenter ) )
        {
            plot->ZoomOut();
        }
        else if( aEvent.IsAction( &ACTIONS::zoomInHorizontally ) )
        {
            plot->ZoomIn( wxDefaultPosition, mpWindow::zoomIncrementalFactor, wxHORIZONTAL );
        }
        else if( aEvent.IsAction( &ACTIONS::zoomOutHorizontally ) )
        {
            plot->ZoomOut( wxDefaultPosition, mpWindow::zoomIncrementalFactor, wxHORIZONTAL );
        }
        else if( aEvent.IsAction( &ACTIONS::zoomInVertically ) )
        {
            plot->ZoomIn( wxDefaultPosition, mpWindow::zoomIncrementalFactor, wxVERTICAL );
        }
        else if( aEvent.IsAction( &ACTIONS::zoomOutVertically ) )
        {
            plot->ZoomOut( wxDefaultPosition, mpWindow::zoomIncrementalFactor, wxVERTICAL );
        }
        else if( aEvent.IsAction( &ACTIONS::zoomFitScreen ) )
        {
            wxCommandEvent dummy;
            plot->OnFit( dummy );
        }
    }
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::UndoZoom( const TOOL_EVENT& aEvent )
{
    if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( getCurrentSimTab() ) )
    {
        // the Smith view keeps no zoom history, and the hidden axes must not move
        if( !plotTab->IsSmithMode() )
            plotTab->GetPlotWin()->ZoomUndo();
    }
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::RedoZoom( const TOOL_EVENT& aEvent )
{
    if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( getCurrentSimTab() ) )
    {
        if( !plotTab->IsSmithMode() )
            plotTab->GetPlotWin()->ZoomRedo();
    }
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::ToggleSimConsolePanel( const TOOL_EVENT& aEvent )
{
    if( m_simulatorFrame )
        m_simulatorFrame->ToggleSimConsole();
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::ToggleSimSidePanel( const TOOL_EVENT& aEvent )
{
    if( m_simulatorFrame )
        m_simulatorFrame->ToggleSimSidePanel();
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::ToggleGrid( const TOOL_EVENT& aEvent )
{
    if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( getCurrentSimTab() ) )
    {
        plotTab->ShowGrid( !plotTab->IsGridShown() );
        m_simulatorFrame->OnModify();
    }
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::ToggleLegend( const TOOL_EVENT& aEvent )
{
    if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( getCurrentSimTab() ) )
    {
        plotTab->ShowLegend( !plotTab->IsLegendShown() );
        m_simulatorFrame->OnModify();
    }
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::ToggleDottedSecondary( const TOOL_EVENT& aEvent )
{
    if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( getCurrentSimTab() ) )
    {
        plotTab->SetDottedSecondary( !plotTab->GetDottedSecondary() );
        m_simulatorFrame->OnModify();
    }
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::ToggleSmithChart( const TOOL_EVENT& aEvent )
{
    m_simulatorFrame->ToggleSmithChart();
    return 0;
}
 
 
int SIMULATOR_CONTROL::ToggleDarkModePlots( const TOOL_EVENT& aEvent )
{
    m_simulatorFrame->ToggleDarkModePlots();
    return 0;
}
 
 
int SIMULATOR_CONTROL::EditAnalysisTab( const TOOL_EVENT& aEvent )
{
    m_simulatorFrame->EditAnalysis();
    return 0;
}
 
 
int SIMULATOR_CONTROL::RunSimulation( const TOOL_EVENT& aEvent )
{
    if( m_simulator->IsRunning() )
    {
        m_simulator->Stop();
        return 0;
    }
 
    if( !getCurrentSimTab() )
        NewAnalysisTab( aEvent );
 
    if( !getCurrentSimTab() )
        return 0;
 
    m_simulatorFrame->StartSimulation();
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::Probe( const TOOL_EVENT& aEvent )
{
    if( m_schematicFrame == nullptr )
        return -1;
 
    wxWindow* blocking_dialog = m_schematicFrame->Kiway().GetBlockingDialog();
 
    if( blocking_dialog )
        blocking_dialog->Close( true );
 
    m_schematicFrame->GetToolManager()->PostAction( SCH_ACTIONS::simProbe );
    m_schematicFrame->Raise();
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::Tune( const TOOL_EVENT& aEvent )
{
    if( m_schematicFrame == nullptr )
        return -1;
 
    wxWindow* blocking_dialog = m_schematicFrame->Kiway().GetBlockingDialog();
 
    if( blocking_dialog )
        blocking_dialog->Close( true );
 
    m_schematicFrame->GetToolManager()->PostAction( SCH_ACTIONS::simTune );
    m_schematicFrame->Raise();
 
    return 0;
}
 
 
class NETLIST_VIEW_DIALOG : public DIALOG_SHIM
{
public:
    enum
    {
        MARGIN_LINE_NUMBERS
    };
 
    void onClose( wxCloseEvent& evt )
    {
        wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL ) );
    }
 
    NETLIST_VIEW_DIALOG( wxWindow* parent ) :
            DIALOG_SHIM( parent, wxID_ANY, _( "SPICE Netlist" ), wxDefaultPosition,
                         wxSize( 800, 800 ), wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
            m_textCtrl( nullptr ),
            m_reporter( nullptr )
    {
        m_splitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
                                           wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
 
        //Avoid the splitter window being assigned as the Parent to additional windows
        m_splitter->SetExtraStyle( wxWS_EX_TRANSIENT );
 
        m_textCtrl = new wxStyledTextCtrl( m_splitter, wxID_ANY );
 
        m_textCtrl->SetMarginWidth( MARGIN_LINE_NUMBERS, 50 );
        m_textCtrl->StyleSetForeground( wxSTC_STYLE_LINENUMBER, wxColour( 75, 75, 75 ) );
        m_textCtrl->StyleSetBackground( wxSTC_STYLE_LINENUMBER, wxColour( 220, 220, 220 ) );
        m_textCtrl->SetMarginType( MARGIN_LINE_NUMBERS, wxSTC_MARGIN_NUMBER );
 
        wxFont fixedFont = KIUI::GetMonospacedUIFont();
 
        for( int i = 0; i < wxSTC_STYLE_MAX; ++i )
            m_textCtrl->StyleSetFont( i, fixedFont );
 
        m_textCtrl->StyleClearAll();  // Addresses a bug in wx3.0 where styles are not correctly set
 
        m_textCtrl->SetWrapMode( wxSTC_WRAP_WORD );
        m_textCtrl->SetLexer( wxSTC_LEX_SPICE );
        m_textCtrl->SetMinSize( wxSize( 40, 40 ) );
        m_textCtrl->SetSize( wxSize( 40, 40 ) );
 
        m_reporter = new WX_HTML_REPORT_BOX( m_splitter, wxID_ANY );
        m_reporter->SetMinSize( wxSize( 40, 40 ) );
        m_reporter->SetSize( wxSize( 40, 40 ) );
 
        m_splitter->SetMinimumPaneSize( 40 );
        m_splitter->SetSashPosition( 760 );
        m_splitter->SetSashGravity( 0.9 );
        m_splitter->SplitHorizontally( m_textCtrl, m_reporter );
 
        wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
        sizer->Add( m_splitter, 1, wxEXPAND | wxALL, 5 );
        SetSizer( sizer );
        Layout();
 
        Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( NETLIST_VIEW_DIALOG::onClose ),
                 nullptr, this );
 
        m_scintillaTricks = std::make_unique<SCINTILLA_TRICKS>( m_textCtrl, wxT( "{}" ), false );
 
        finishDialogSettings();
    }
 
    void SetNetlist( const wxString& aSource )
    {
        m_textCtrl->SetText( aSource );
        m_textCtrl->SetEditable( false );
 
        m_reporter->Flush();
    }
 
    REPORTER* GetReporter() { return m_reporter; }
 
private:
    wxSplitterWindow*                 m_splitter;
    wxStyledTextCtrl*                 m_textCtrl;
    WX_HTML_REPORT_BOX*               m_reporter;
 
    std::unique_ptr<SCINTILLA_TRICKS> m_scintillaTricks;
};
 
 
int SIMULATOR_CONTROL::EditUserDefinedSignals( const TOOL_EVENT& aEvent )
{
    std::map<int, wxString> userSignals = m_simulatorFrame->UserDefinedSignals();
 
    DIALOG_USER_DEFINED_SIGNALS dlg( m_simulatorFrame, &userSignals );
 
    // QuasiModal required for syntax help and Scintilla auto-complete
    if( dlg.ShowQuasiModal() == wxID_OK )
        m_simulatorFrame->SetUserDefinedSignals( userSignals );
 
    return 0;
}
 
 
int SIMULATOR_CONTROL::ShowNetlist( const TOOL_EVENT& aEvent )
{
    if( m_schematicFrame == nullptr || m_simulator == nullptr )
        return -1;
 
    STRING_FORMATTER    formatter;
    NETLIST_VIEW_DIALOG dlg( m_simulatorFrame );
 
    m_circuitModel->GetNetlist( m_simulatorFrame->GetCurrentSimCommand(),
                                m_simulatorFrame->GetCurrentOptions(),
                                &formatter, *dlg.GetReporter() );
 
    dlg.SetNetlist( wxString( formatter.GetString() ) );
    dlg.ShowModal();
 
    return 0;
}
 
 
void SIMULATOR_CONTROL::setTransitions()
{
    // clang-format off
    Go( &SIMULATOR_CONTROL::NewAnalysisTab,         SCH_ACTIONS::newAnalysisTab.MakeEvent() );
    Go( &SIMULATOR_CONTROL::OpenWorkbook,           SCH_ACTIONS::openWorkbook.MakeEvent() );
    Go( &SIMULATOR_CONTROL::SaveWorkbook,           SCH_ACTIONS::saveWorkbook.MakeEvent() );
    Go( &SIMULATOR_CONTROL::SaveWorkbook,           SCH_ACTIONS::saveWorkbookAs.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ExportPlotAsPNG,        SCH_ACTIONS::exportPlotAsPNG.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ExportPlotAsCSV,        SCH_ACTIONS::exportPlotAsCSV.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ExportPlotToClipboard,  SCH_ACTIONS::exportPlotToClipboard.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ExportPlotToSchematic,  SCH_ACTIONS::exportPlotToSchematic.MakeEvent() );
 
    Go( &SIMULATOR_CONTROL::ToggleSimConsolePanel,  SCH_ACTIONS::toggleSimConsole.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ToggleSimSidePanel,     SCH_ACTIONS::toggleSimSidePanel.MakeEvent() );
 
    Go( &SIMULATOR_CONTROL::Zoom,                   ACTIONS::zoomInCenter.MakeEvent() );
    Go( &SIMULATOR_CONTROL::Zoom,                   ACTIONS::zoomOutCenter.MakeEvent() );
    Go( &SIMULATOR_CONTROL::Zoom,                   ACTIONS::zoomInHorizontally.MakeEvent() );
    Go( &SIMULATOR_CONTROL::Zoom,                   ACTIONS::zoomOutHorizontally.MakeEvent() );
    Go( &SIMULATOR_CONTROL::Zoom,                   ACTIONS::zoomInVertically.MakeEvent() );
    Go( &SIMULATOR_CONTROL::Zoom,                   ACTIONS::zoomOutVertically.MakeEvent() );
    Go( &SIMULATOR_CONTROL::Zoom,                   ACTIONS::zoomFitScreen.MakeEvent() );
    Go( &SIMULATOR_CONTROL::UndoZoom,               ACTIONS::zoomUndo.MakeEvent() );
    Go( &SIMULATOR_CONTROL::RedoZoom,               ACTIONS::zoomRedo.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ToggleGrid,             ACTIONS::toggleGrid.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ToggleLegend,           SCH_ACTIONS::toggleLegend.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ToggleDottedSecondary,  SCH_ACTIONS::toggleDottedSecondary.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ToggleSmithChart,       SCH_ACTIONS::toggleSmithChart.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ToggleDarkModePlots,    SCH_ACTIONS::toggleDarkModePlots.MakeEvent() );
 
    Go( &SIMULATOR_CONTROL::EditAnalysisTab,        SCH_ACTIONS::simAnalysisProperties.MakeEvent() );
    Go( &SIMULATOR_CONTROL::RunSimulation,          SCH_ACTIONS::runSimulation.MakeEvent() );
    Go( &SIMULATOR_CONTROL::RunSimulation,          SCH_ACTIONS::stopSimulation.MakeEvent() );
    Go( &SIMULATOR_CONTROL::Probe,                  SCH_ACTIONS::simProbe.MakeEvent() );
    Go( &SIMULATOR_CONTROL::Tune,                   SCH_ACTIONS::simTune.MakeEvent() );
 
    Go( &SIMULATOR_CONTROL::EditUserDefinedSignals, SCH_ACTIONS::editUserDefinedSignals.MakeEvent() );
    Go( &SIMULATOR_CONTROL::ShowNetlist,            SCH_ACTIONS::showNetlist.MakeEvent() );
    // clang-format on
}