kicad/eeschema/sim/sim_plot_frame.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 CERN
 * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
 * @author Maciej Suminski <maciej.suminski@cern.ch>
 *
 * 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
 */

#include <schframe.h>
#include <eeschema_id.h>
#include <kiway.h>

#include "netlist_exporter_pspice_sim.h"

#include "sim_plot_frame.h"
#include "sim_plot_panel.h"
#include "spice_simulator.h"
#include "spice_reporter.h"

class SIM_THREAD_REPORTER : public SPICE_REPORTER
{
public:
    SIM_THREAD_REPORTER( SIM_PLOT_FRAME* aParent )
        : m_parent( aParent )
    {
    }

    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_UNDEFINED ) override
    {
        wxCommandEvent* event = new wxCommandEvent( EVT_SIM_REPORT );
        event->SetString( aText );
        wxQueueEvent( m_parent, event );
        return *this;
    }

    void OnSimStateChange( SPICE_SIMULATOR* aObject, SIM_STATE aNewState ) override
    {
        wxCommandEvent* event = NULL;

        switch( aNewState )
        {
            case SIM_IDLE:
                event = new wxCommandEvent( EVT_SIM_FINISHED );
                break;

            case SIM_RUNNING:
                event = new wxCommandEvent( EVT_SIM_STARTED );
                break;
        }

        wxQueueEvent( m_parent, event );
    }

private:
    SIM_PLOT_FRAME* m_parent;
};


SIM_PLOT_FRAME::SIM_PLOT_FRAME( KIWAY* aKiway, wxWindow* aParent )
    : SIM_PLOT_FRAME_BASE( aParent ), m_settingsDlg( this )
{
    SetKiway( this, aKiway );

    Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( SIM_PLOT_FRAME::onClose ), NULL, this );
    Connect( EVT_SIM_REPORT, wxCommandEventHandler( SIM_PLOT_FRAME::onSimReport ), NULL, this );
    Connect( EVT_SIM_STARTED, wxCommandEventHandler( SIM_PLOT_FRAME::onSimStarted ), NULL, this );
    Connect( EVT_SIM_FINISHED, wxCommandEventHandler( SIM_PLOT_FRAME::onSimFinished ), NULL, this );
    Connect( EVT_SIM_CURSOR_UPDATE, wxCommandEventHandler( SIM_PLOT_FRAME::onCursorUpdate ), NULL, this );
}


SIM_PLOT_FRAME::~SIM_PLOT_FRAME()
{
}


void SIM_PLOT_FRAME::StartSimulation()
{
    STRING_FORMATTER formatter;

    m_simConsole->Clear();

    // TODO check if there is a valid simulation command

    /// @todo is it necessary to recreate simulator every time?
    m_simulator.reset( SPICE_SIMULATOR::CreateInstance( "ngspice" ) );
    m_simulator->SetReporter( new SIM_THREAD_REPORTER( this ) );
    m_simulator->Init();

    updateNetlistExporter();
    m_exporter->SetSimCommand( m_simCommand );
    m_exporter->Format( &formatter, NET_ALL_FLAGS );

    m_simulator->LoadNetlist( formatter.GetString() );
    m_simulator->Run();
}


void SIM_PLOT_FRAME::StopSimulation()
{
    m_simulator->Stop();
}


void SIM_PLOT_FRAME::NewPlotPanel( SIM_TYPE aSimType )
{
    SIM_PLOT_PANEL* plot = new SIM_PLOT_PANEL( aSimType, m_plotNotebook, wxID_ANY );

    m_plotNotebook->AddPage( plot,
            wxString::Format( wxT( "Plot%lu" ), m_plotNotebook->GetPageCount() + 1 ), true );
}


void SIM_PLOT_FRAME::AddVoltagePlot( const wxString& aNetName )
{
    int nodeNumber = getNodeNumber( aNetName );

    if( nodeNumber >= -1 )
    {
        updatePlot( wxString::Format( "V(%d)", nodeNumber ), aNetName, CurrentPlot() );
    }
}


SIM_PLOT_PANEL* SIM_PLOT_FRAME::CurrentPlot() const
{
    return static_cast<SIM_PLOT_PANEL*>( m_plotNotebook->GetCurrentPage() );
}


bool SIM_PLOT_FRAME::isSimulationRunning()
{
    return m_simulator ? m_simulator->IsRunning() : false;
}


void SIM_PLOT_FRAME::updateNetlistExporter()
{
    m_exporter.reset( new NETLIST_EXPORTER_PSPICE_SIM( m_schematicFrame->BuildNetListBase(),
        Prj().SchLibs(), Prj().SchSearchS() ) );
}


void SIM_PLOT_FRAME::updatePlot( const wxString& aSpiceName, const wxString& aName, SIM_PLOT_PANEL* aPanel )
{
    // First, handle the x axis
    wxString xAxisName;
    SIM_TYPE simType = m_exporter->GetSimType();

    if( !SIM_PLOT_PANEL::IsPlottable( simType ) )
    {
        // There is no plot to be shown
        m_simulator->Command( wxString::Format( "print %s", aSpiceName ).ToStdString() );
        return;
    }

    switch( simType )
    {
        /// @todo x axis names should be moved to simulator iface, so they are not hardcoded for ngspice
        case ST_AC:
        case ST_NOISE:
            xAxisName = "frequency";
            break;

        case ST_DC:
            xAxisName = "v-sweep";
            break;

        case ST_TRANSIENT:
            xAxisName = "time";
            break;

        case ST_OP:
            break;

        default:
            break;
    }

    auto data_x = m_simulator->GetMagPlot( (const char*) xAxisName.c_str() );
    int size = data_x.size();

    if( data_x.empty() )
        return;

    // Now, Y axis data
    switch( m_exporter->GetSimType() )
    {
        /// @todo x axis names should be moved to simulator iface
        case ST_AC:
        {
            auto data_mag = m_simulator->GetMagPlot( (const char*) aSpiceName.c_str() );
            auto data_phase = m_simulator->GetPhasePlot( (const char*) aSpiceName.c_str() );
            aPanel->AddTrace( aSpiceName, aName + " (mag)", size, data_x.data(), data_mag.data(), 0 );
            aPanel->AddTrace( aSpiceName, aName + " (phase)", size, data_x.data(), data_phase.data(), 0 );
        }
        break;

        case ST_NOISE:
        case ST_DC:
        case ST_TRANSIENT:
        {
            auto data_y = m_simulator->GetMagPlot( (const char*) aSpiceName.c_str() );
            aPanel->AddTrace( aSpiceName, aName, size, data_x.data(), data_y.data(), 0 );
        }
        break;

        default:
            return;
    }
}


int SIM_PLOT_FRAME::getNodeNumber( const wxString& aNetName )
{
    if( !m_exporter )
        return -1;

    const auto& netMapping = m_exporter->GetNetIndexMap();
    auto it = netMapping.find( aNetName );

    if( it == netMapping.end() )
        return -1;

    return it->second;
}


void SIM_PLOT_FRAME::menuNewPlot( wxCommandEvent& aEvent )
{
    if( m_exporter )
    {
        SIM_TYPE type = m_exporter->GetSimType();

        if( SIM_PLOT_PANEL::IsPlottable( type ) )
            NewPlotPanel( type );
    }
}


void SIM_PLOT_FRAME::menuSaveImage( wxCommandEvent& event )
{
    wxFileDialog saveDlg( this, wxT( "Save plot as image" ), "", "",
                "PNG file (*.png)|*.png", wxFD_SAVE | wxFD_OVERWRITE_PROMPT );

    if( saveDlg.ShowModal() == wxID_CANCEL )
        return;

    CurrentPlot()->SaveScreenshot( saveDlg.GetPath(), wxBITMAP_TYPE_PNG );
}


void SIM_PLOT_FRAME::menuSaveCsv( wxCommandEvent& event )
{
    const wxChar SEPARATOR = ';';

    wxFileDialog saveDlg( this, wxT( "Save plot data" ), "", "",
                "CSV file (*.csv)|*.csv", wxFD_SAVE | wxFD_OVERWRITE_PROMPT );

    if( saveDlg.ShowModal() == wxID_CANCEL )
        return;

    wxFile out( saveDlg.GetPath(), wxFile::write );
    bool timeWritten = false;

    for( const auto& t : CurrentPlot()->GetTraces() )
    {
        const TRACE* trace = t.second;

        if( !timeWritten )
        {
            out.Write( wxString::Format( "Time%c", SEPARATOR ) );

            for( double v : trace->GetDataX() )
                out.Write( wxString::Format( "%f%c", v, SEPARATOR ) );

            out.Write( "\r\n" );
            timeWritten = true;
        }

        out.Write( wxString::Format( "%s%c", t.first, SEPARATOR ) );

        for( double v : trace->GetDataY() )
            out.Write( wxString::Format( "%f%c", v, SEPARATOR ) );

        out.Write( "\r\n" );
    }

    out.Close();
}


void SIM_PLOT_FRAME::menuZoomIn( wxCommandEvent& event )
{
    CurrentPlot()->ZoomIn();
}


void SIM_PLOT_FRAME::menuZoomOut( wxCommandEvent& event )
{
    CurrentPlot()->ZoomOut();
}


void SIM_PLOT_FRAME::menuZoomFit( wxCommandEvent& event )
{
    CurrentPlot()->Fit();
}


void SIM_PLOT_FRAME::menuShowGrid( wxCommandEvent& event )
{
    SIM_PLOT_PANEL* plot = CurrentPlot();
    plot->ShowGrid( !plot->IsGridShown() );
}


void SIM_PLOT_FRAME::menuShowGridUpdate( wxUpdateUIEvent& event )
{
    SIM_PLOT_PANEL* plot = CurrentPlot();
    event.Check( plot ? plot->IsGridShown() : false );
}


void SIM_PLOT_FRAME::menuShowLegend( wxCommandEvent& event )
{
    SIM_PLOT_PANEL* plot = CurrentPlot();
    plot->ShowLegend( !plot->IsLegendShown() );
}


void SIM_PLOT_FRAME::menuShowLegendUpdate( wxUpdateUIEvent& event )
{
    SIM_PLOT_PANEL* plot = CurrentPlot();
    event.Check( plot ? plot->IsLegendShown() : false );
}


void SIM_PLOT_FRAME::menuShowCoords( wxCommandEvent& event )
{
    SIM_PLOT_PANEL* plot = CurrentPlot();
    plot->ShowCoords( !plot->IsCoordsShown() );
}


void SIM_PLOT_FRAME::menuShowCoordsUpdate( wxUpdateUIEvent& event )
{
    SIM_PLOT_PANEL* plot = CurrentPlot();
    event.Check( plot ? plot->IsCoordsShown() : false );
}


void SIM_PLOT_FRAME::onPlotChanged( wxNotebookEvent& event )
{
    wxQueueEvent( this, new wxCommandEvent( EVT_SIM_CURSOR_UPDATE ) );
}


void SIM_PLOT_FRAME::onSignalDblClick( wxCommandEvent& event )
{
    int idx = m_signals->GetSelection();
    SIM_PLOT_PANEL* plot = CurrentPlot();
    SIM_TYPE simType = m_exporter->GetSimType();

    // Create a new plot if the current one displays a different type
    if( SIM_PLOT_PANEL::IsPlottable( simType ) && ( plot == nullptr || plot->GetType() != simType ) )
    {
        NewPlotPanel( simType );
        plot = CurrentPlot();
    }

    if( idx != wxNOT_FOUND )
    {
        const wxString& netName = m_signals->GetString( idx );

        if( plot->IsShown( netName ) )
            plot->DeleteTrace( netName );
        else
            AddVoltagePlot( netName );

        plot->Fit();
    }
}


void SIM_PLOT_FRAME::onSignalRClick( wxMouseEvent& event )
{
    int idx = m_signals->HitTest( event.GetPosition() );

    if( idx != wxNOT_FOUND )
        m_signals->SetSelection( idx );

    idx = m_signals->GetSelection();

    if( idx != wxNOT_FOUND )
    {
        const wxString& netName = m_signals->GetString( idx );
        SIGNAL_CONTEXT_MENU ctxMenu( netName, this );
        m_signals->PopupMenu( &ctxMenu );
    }
}


void SIM_PLOT_FRAME::onSimulate( wxCommandEvent& event )
{
    if( isSimulationRunning() )
        StopSimulation();
    else
        StartSimulation();
}


void SIM_PLOT_FRAME::onSettings( wxCommandEvent& event )
{
    updateNetlistExporter();
    m_exporter->ProcessNetlist( NET_ALL_FLAGS );

    m_settingsDlg.SetNetlistExporter( m_exporter.get() );

    if( m_settingsDlg.ShowModal() == wxID_OK )
        m_simCommand = m_settingsDlg.GetSimCommand();
}


void SIM_PLOT_FRAME::onPlaceProbe( wxCommandEvent& event )
{
    if( m_schematicFrame == NULL )
        return;

    wxCommandEvent* placeProbe = new wxCommandEvent( wxEVT_TOOL, ID_SIM_ADD_PROBE );
    wxQueueEvent( m_schematicFrame, placeProbe );
}


void SIM_PLOT_FRAME::onClose( wxCloseEvent& aEvent )
{
    if( isSimulationRunning() )
        m_simulator->Stop();

    Destroy();
}


void SIM_PLOT_FRAME::onCursorUpdate( wxCommandEvent& event )
{
    wxSize size = m_cursors->GetClientSize();
    m_cursors->ClearAll();

    const long SIGNAL_COL = m_cursors->AppendColumn( wxT( "Signal" ), wxLIST_FORMAT_LEFT, size.x / 2 );
    const long X_COL = m_cursors->AppendColumn( CurrentPlot()->GetLabelX(), wxLIST_FORMAT_LEFT, size.x / 4 );
    const long Y_COL = m_cursors->AppendColumn( CurrentPlot()->GetLabelY1(), wxLIST_FORMAT_LEFT, size.x / 4 );

    // Update cursor values
    for( const auto& trace : CurrentPlot()->GetTraces() )
    {
        if( CURSOR* cursor = trace.second->GetCursor() )
        {
            const wxRealPoint coords = cursor->GetCoords();
            long idx = m_cursors->InsertItem( SIGNAL_COL, trace.first );
            m_cursors->SetItem( idx, X_COL, wxString::Format( "%f", coords.x ) );
            m_cursors->SetItem( idx, Y_COL, wxString::Format( "%f", coords.y ) );
        }
    }
}


void SIM_PLOT_FRAME::onSimStarted( wxCommandEvent& aEvent )
{
    m_simulateBtn->SetLabel( wxT( "Stop" ) );
    SetCursor( wxCURSOR_ARROWWAIT );
}


void SIM_PLOT_FRAME::onSimFinished( wxCommandEvent& aEvent )
{
    m_simulateBtn->SetLabel( wxT( "Simulate" ) );
    SetCursor( wxCURSOR_ARROW );

    SIM_TYPE simType = m_exporter->GetSimType();

    // Fill the signals listbox
    m_signals->Clear();

    for( const auto& net : m_exporter->GetNetIndexMap() )
    {
        if( net.first != "GND" )
            m_signals->Append( net.first );
    }

    // If there are any signals plotted, update them
    if( SIM_PLOT_PANEL::IsPlottable( simType ) )
    {
        SIM_PLOT_PANEL* plotPanel = CurrentPlot();

        if( plotPanel == nullptr )
            return;

        for( const auto& trace : plotPanel->GetTraces() )
            updatePlot( trace.second->GetSpiceName(), trace.second->GetName(), plotPanel );

        plotPanel->UpdateAll();
    }
    else
    {
        /// @todo do not make it hardcoded for ngspice
        for( const auto& net : m_exporter->GetNetIndexMap() )
        {
            int node = net.second;
            if( node > 0 )
                m_simulator->Command( wxString::Format( "print v(%d)", node ).ToStdString() );
        }
    }
}


void SIM_PLOT_FRAME::onSimReport( wxCommandEvent& aEvent )
{
    std::cout << aEvent.GetString() << std::endl;
    m_simConsole->AppendText( aEvent.GetString() + "\n" );
    m_simConsole->SetInsertionPointEnd();
}


SIM_PLOT_FRAME::SIGNAL_CONTEXT_MENU::SIGNAL_CONTEXT_MENU( const wxString& aSignal,
        SIM_PLOT_FRAME* aPlotFrame )
    : m_signal( aSignal ), m_plotFrame( aPlotFrame )
{
    SIM_PLOT_PANEL* plot = m_plotFrame->CurrentPlot();

    if( plot->IsShown( m_signal ) )
    {
        Append( HIDE_SIGNAL, wxT( "Hide signal" ) );

        TRACE* trace = plot->GetTrace( m_signal );

        if( trace->HasCursor() )
            Append( HIDE_CURSOR, wxT( "Hide cursor" ) );
        else
            Append( SHOW_CURSOR, wxT( "Show cursor" ) );
    }
    else
    {
        Append( SHOW_SIGNAL, wxT( "Show signal" ) );
    }

    Connect( wxEVT_COMMAND_MENU_SELECTED, wxMenuEventHandler( SIGNAL_CONTEXT_MENU::onMenuEvent ), NULL, this );
}


void SIM_PLOT_FRAME::SIGNAL_CONTEXT_MENU::onMenuEvent( wxMenuEvent& aEvent )
{
    SIM_PLOT_PANEL* plot = m_plotFrame->CurrentPlot();

    switch( aEvent.GetId() )
    {
        case SHOW_SIGNAL:
            m_plotFrame->AddVoltagePlot( m_signal );
            plot->Fit();
            break;

            break;
        case HIDE_SIGNAL:
            plot->DeleteTrace( m_signal );
            break;

        case SHOW_CURSOR:
            plot->EnableCursor( m_signal, true );
            break;

        case HIDE_CURSOR:
            plot->EnableCursor( m_signal, false );
            break;
    }
}

wxDEFINE_EVENT( EVT_SIM_REPORT, wxCommandEvent );
wxDEFINE_EVENT( EVT_SIM_STARTED, wxCommandEvent );
wxDEFINE_EVENT( EVT_SIM_FINISHED, wxCommandEvent );