kicad/eeschema/dialogs/dialog_spice_model.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 CERN
 * @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 3
 * 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:
 * https://www.gnu.org/licenses/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#include "dialog_spice_model.h"
#include <netlist_exporters/netlist_exporter_pspice.h>

#include <wx/tokenzr.h>

// Helper function to shorten conditions
static bool empty( const wxTextCtrl* aCtrl )
{
    return aCtrl->GetValue().IsEmpty();
}


// Function to sort PWL values list
static int wxCALLBACK comparePwlValues( wxIntPtr aItem1, wxIntPtr aItem2, wxIntPtr WXUNUSED( aSortData ) )
{
    float* t1 = reinterpret_cast<float*>( &aItem1 );
    float* t2 = reinterpret_cast<float*>( &aItem2 );

    if( *t1 > *t2 )
        return 1;

    if( *t1 < *t2 )
        return -1;

    return 0;
}


DIALOG_SPICE_MODEL::DIALOG_SPICE_MODEL( wxWindow* aParent, SCH_COMPONENT& aComponent, SCH_FIELDS& aFields )
    : DIALOG_SPICE_MODEL_BASE( aParent ), m_component( aComponent ), m_fields( aFields )
{
    m_pwlTimeCol = m_pwlValList->AppendColumn( "Time [s]", wxLIST_FORMAT_LEFT, 100 );
    m_pwlValueCol = m_pwlValList->AppendColumn( "Value [V/A]", wxLIST_FORMAT_LEFT, 100 );

    m_sdbSizerOK->SetDefault();
}

// TODO validators


bool DIALOG_SPICE_MODEL::TransferDataFromWindow()
{
    if( !DIALOG_SPICE_MODEL_BASE::TransferDataFromWindow() )
        return false;

    wxWindow* page = m_notebook->GetCurrentPage();

    // Passive
    if( page == m_passive )
    {
        switch( m_pasType->GetSelection() )
        {
            case 0: m_fieldsTmp[SPICE_PRIMITIVE] = (char) SP_RESISTOR; break;
            case 1: m_fieldsTmp[SPICE_PRIMITIVE] = (char) SP_CAPACITOR; break;
            case 2: m_fieldsTmp[SPICE_PRIMITIVE] = (char) SP_INDUCTOR; break;

            default:
                wxASSERT_MSG( false, "Unhandled passive type" );
                return false;
                break;
        }

        m_fieldsTmp[SPICE_MODEL] = m_pasValue->GetValue();
    }


    // Semiconductor
    else if( page == m_semiconductor )
    {
        switch( m_semiType->GetSelection() )
        {
            case 0: m_fieldsTmp[SPICE_PRIMITIVE] = (char) SP_DIODE; break;
            case 1: m_fieldsTmp[SPICE_PRIMITIVE] = (char) SP_BJT; break;
            case 2: m_fieldsTmp[SPICE_PRIMITIVE] = (char) SP_MOSFET; break;

            default:
                wxASSERT_MSG( false, "Unhandled semiconductor type" );
                return false;
                break;
        }

        m_fieldsTmp[SPICE_MODEL] = m_semiModel->GetValue();

        if( !empty( m_semiLib ) )
            m_fieldsTmp[SPICE_LIB_FILE] = m_semiLib->GetValue();
    }


    // Integrated circuit
    else if( page == m_ic )
    {
        m_fieldsTmp[SPICE_PRIMITIVE] = (char) SP_SUBCKT;
        m_fieldsTmp[SPICE_MODEL] = m_icModel->GetValue();

        if( !empty( m_icLib ) )
            m_fieldsTmp[SPICE_LIB_FILE] = m_icLib->GetValue();
    }


    // Power source
    else if( page == m_power )
    {
        wxString model;

        if( !generatePowerSource( model ) )
            return false;

        m_fieldsTmp[SPICE_PRIMITIVE] = (char)( m_pwrType->GetSelection() ? SP_ISOURCE : SP_VSOURCE );
        m_fieldsTmp[SPICE_MODEL] = model;
    }


    else
    {
        wxASSERT_MSG( false, "Unhandled model type" );
        return false;
    }

    m_fieldsTmp[SPICE_ENABLED] = !m_disabled->GetValue() ? "Y" : "N";        // note bool inversion
    m_fieldsTmp[SPICE_NODE_SEQUENCE] = m_nodeSeqCheck->IsChecked() ? m_nodeSeqVal->GetValue() : "";

    // Apply the settings
    for( int i = 0; i < SPICE_FIELD_END; ++i )
    {
        if( m_fieldsTmp.count( (SPICE_FIELD) i ) > 0 && !m_fieldsTmp.at( i ).IsEmpty() )
        {
            getField( i ).SetText( m_fieldsTmp[i] );
        }
        else
        {
            // Erase empty fields (having empty fields causes a warning in the properties dialog)
            const wxString& spiceField = NETLIST_EXPORTER_PSPICE::GetSpiceFieldName( (SPICE_FIELD) i );

            auto fieldIt = std::find_if( m_fields.begin(), m_fields.end(), [&]( const SCH_FIELD& f ) {
                return f.GetName() == spiceField;
            } );

            if( fieldIt != m_fields.end() )
                m_fields.erase( fieldIt );
        }
    }

    return true;
}


bool DIALOG_SPICE_MODEL::TransferDataToWindow()
{
    const auto& spiceFields = NETLIST_EXPORTER_PSPICE::GetSpiceFields();

    // Fill out the working buffer
    for( unsigned int idx = 0; idx < spiceFields.size(); ++idx )
    {
        const wxString& spiceField = spiceFields[idx];

        auto fieldIt = std::find_if( m_fields.begin(), m_fields.end(), [&]( const SCH_FIELD& f ) {
            return f.GetName() == spiceField;
        } );

        // Do not modify the existing value, just add missing fields with default values
        if( fieldIt != m_fields.end() && !fieldIt->GetText().IsEmpty() )
            m_fieldsTmp[idx] = fieldIt->GetText();
        else
            m_fieldsTmp[idx] = NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal( (SPICE_FIELD) idx, &m_component,
                NET_USE_X_PREFIX | NET_ADJUST_INCLUDE_PATHS | NET_ADJUST_PASSIVE_VALS );
    }

    // Analyze the component fields to fill out the dialog
    char primitive = toupper( m_fieldsTmp[SPICE_PRIMITIVE][0] );

    switch( primitive )
    {
        case SP_RESISTOR:
        case SP_CAPACITOR:
        case SP_INDUCTOR:
            m_notebook->SetSelection( m_notebook->FindPage( m_passive ) );
            m_pasType->SetSelection( primitive == SP_RESISTOR ? 0
                    : primitive == SP_CAPACITOR ? 1
                    : primitive == SP_INDUCTOR ? 2
                    : -1 );
            m_pasValue->SetValue( m_fieldsTmp[SPICE_MODEL] );
            break;

        case SP_DIODE:
        case SP_BJT:
        case SP_MOSFET:
            m_notebook->SetSelection( m_notebook->FindPage( m_semiconductor ) );
            m_semiType->SetSelection( primitive == SP_DIODE ? 0
                    : primitive == SP_BJT ? 1
                    : primitive == SP_MOSFET ? 2
                    : -1 );
            m_semiModel->SetValue( m_fieldsTmp[SPICE_MODEL] );
            m_semiLib->SetValue( m_fieldsTmp[SPICE_LIB_FILE] );

            if( !empty( m_semiLib ) )
            {
                const wxString& libFile = m_semiLib->GetValue();
                m_fieldsTmp[SPICE_LIB_FILE] = libFile;
                updateFromFile( m_semiModel, libFile, "model" );
            }
            break;

        case SP_SUBCKT:
            m_notebook->SetSelection( m_notebook->FindPage( m_ic ) );
            m_icModel->SetValue( m_fieldsTmp[SPICE_MODEL] );
            m_icLib->SetValue( m_fieldsTmp[SPICE_LIB_FILE] );

            if( !empty( m_icLib ) )
            {
                const wxString& libFile = m_icLib->GetValue();
                m_fieldsTmp[SPICE_LIB_FILE] = libFile;
                updateFromFile( m_icModel, libFile, "subckt" );
            }
            break;

        case SP_VSOURCE:
        case SP_ISOURCE:
            if( !parsePowerSource( m_fieldsTmp[SPICE_MODEL] ) )
                return false;

            m_notebook->SetSelection( m_notebook->FindPage( m_power ) );
            m_pwrType->SetSelection( primitive == SP_ISOURCE ? 1 : 0 );
            break;

        default:
            wxASSERT_MSG( false, "Unhandled Spice primitive type" );
            break;
    }

    m_disabled->SetValue( !NETLIST_EXPORTER_PSPICE::StringToBool( m_fieldsTmp[SPICE_ENABLED] ) );

    // Check if node sequence is different than the default one
    if( m_fieldsTmp[SPICE_NODE_SEQUENCE]
            != NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal( SPICE_NODE_SEQUENCE, &m_component, 0 ) )
    {
        m_nodeSeqCheck->SetValue( true );
        m_nodeSeqVal->SetValue( m_fieldsTmp[SPICE_NODE_SEQUENCE] );
    }

    return DIALOG_SPICE_MODEL_BASE::TransferDataToWindow();
}


bool DIALOG_SPICE_MODEL::parsePowerSource( const wxString& aModel )
{
    if( aModel.IsEmpty() )
        return false;

    // Variables used for generic values processing (filling out wxTextCtrls in sequence)
    bool genericProcessing = false;
    unsigned int genericReqParamsCount = 0;
    std::vector<wxTextCtrl*> genericControls;

    wxStringTokenizer tokenizer( aModel, " ()" );
    wxString tkn = tokenizer.GetNextToken().Lower();

    try
    {
        if( tkn == "dc" )
        {
            m_powerNotebook->SetSelection( m_powerNotebook->FindPage( m_pwrGeneric ) );
            tkn = tokenizer.GetNextToken().Lower();

            // it might be an optional "dc" or "trans" directive
            if( tkn == "dc" || tkn == "trans" )
                tkn = tokenizer.GetNextToken().Lower();

            // DC value
            m_genDc->SetValue( SPICE_VALUE( tkn ).ToString() );

            if( !tokenizer.HasMoreTokens() )
                return true;

            tkn = tokenizer.GetNextToken().Lower();

            if( tkn != "ac" )
                return false;

            // AC magnitude
            tkn = tokenizer.GetNextToken().Lower();
            m_genAcMag->SetValue( SPICE_VALUE( tkn ).ToString() );

            // AC phase
            tkn = tokenizer.GetNextToken().Lower();
            m_genAcMag->SetValue( SPICE_VALUE( tkn ).ToString() );
        }


        else if( tkn == "pulse" )
        {
            m_powerNotebook->SetSelection( m_powerNotebook->FindPage( m_pwrPulse ) );

            genericProcessing = true;
            genericReqParamsCount = 2;
            genericControls = { m_pulseInit, m_pulseNominal, m_pulseDelay,
                m_pulseRise, m_pulseFall, m_pulseWidth, m_pulsePeriod };
        }


        else if( tkn == "sin" )
        {
            m_powerNotebook->SetSelection( m_powerNotebook->FindPage( m_pwrSin ) );

            genericProcessing = true;
            genericReqParamsCount = 2;
            genericControls = { m_sinOffset, m_sinAmplitude, m_sinFreq, m_sinDelay, m_sinDampFactor };
        }


        else if( tkn == "exp" )
        {
            m_powerNotebook->SetSelection( m_powerNotebook->FindPage( m_pwrExp ) );

            genericProcessing = true;
            genericReqParamsCount = 2;
            genericControls = { m_expInit, m_expPulsed,
                m_expRiseDelay, m_expRiseConst, m_expFallDelay, m_expFallConst };
        }


        else if( tkn == "pwl" )
        {
            m_powerNotebook->SetSelection( m_powerNotebook->FindPage( m_pwrPwl ) );

            while( tokenizer.HasMoreTokens() )
            {
                tkn = tokenizer.GetNextToken();
                SPICE_VALUE time( tkn );

                tkn = tokenizer.GetNextToken();
                SPICE_VALUE value( tkn );

                addPwlValue( time.ToString(), value.ToString() );
            }
        }


        else
        {
            // Unhandled power source type
            return false;
        }


        if( genericProcessing )
        {
            for( unsigned int i = 0; i < genericControls.size(); ++i )
            {
                // If there are no more tokens, let's check if we got at least required fields
                if( !tokenizer.HasMoreTokens() )
                    return ( i >= genericReqParamsCount );

                tkn = tokenizer.GetNextToken().Lower();
                genericControls[i]->SetValue( SPICE_VALUE( tkn ).ToString() );
            }
        }
    }
    catch( std::exception& e )
    {
        // Nothing, the dialog simply will not be filled
        return false;
    }

    return true;
}


bool DIALOG_SPICE_MODEL::generatePowerSource( wxString& aTarget ) const
{
    wxString res;
    wxWindow* page = m_powerNotebook->GetCurrentPage();

    // Variables for generic processing
    bool genericProcessing = false;
    unsigned int genericReqParamsCount = 0;
    std::vector<wxTextCtrl*> genericControls;

    if( page == m_pwrGeneric )
    {
        if( empty( m_genDc ) && empty( m_genAcMag ) )
            return false;

        if( !empty( m_genDc ) )
            res += wxString::Format( "dc %s", m_genDc->GetValue() );

        if( !empty( m_genAcMag ) )
        {
            res += wxString::Format( " ac %s", m_genAcMag->GetValue() );

            if( !empty( m_genAcPhase ) )
            res += wxString::Format( " %s", m_genAcPhase->GetValue() );
        }
    }


    else if( page == m_pwrPulse )
    {
        genericProcessing = true;
        res = "pulse";
        genericReqParamsCount = 2;
        genericControls = { m_pulseInit, m_pulseNominal, m_pulseDelay,
            m_pulseRise, m_pulseFall, m_pulseWidth, m_pulsePeriod };
    }


    else if( page == m_pwrSin )
    {
        genericProcessing = true;
        res = "sin";
        genericReqParamsCount = 2;
        genericControls = { m_sinOffset, m_sinAmplitude, m_sinFreq, m_sinDelay, m_sinDampFactor };
    }


    else if( page == m_pwrExp )
    {
        genericProcessing = true;
        res = "exp";
        genericReqParamsCount = 2;
        genericControls = { m_expInit, m_expPulsed,
            m_expRiseDelay, m_expRiseConst, m_expFallDelay, m_expFallConst };
    }


    else if( page == m_pwrPwl )
    {
        res = "pwl(";

        for( int i = 0; i < m_pwlValList->GetItemCount(); ++i )
        {
            res += wxString::Format( "%s %s ", m_pwlValList->GetItemText( i, m_pwlTimeCol ),
                                                m_pwlValList->GetItemText( i, m_pwlValueCol ) );
        }

        res += ")";
    }

    if( genericProcessing )
    {
        unsigned int paramCounter = 0;

        res += "(";

        for( auto textCtrl : genericControls )
        {
            if( empty( textCtrl ) )
            {
                if( paramCounter < genericReqParamsCount )
                    return false;

                break;
            }

            res += wxString::Format( "%s ", textCtrl->GetValue() );
            ++paramCounter;
        }

        res += ")";
    }

    aTarget = res;

    return true;
}


void DIALOG_SPICE_MODEL::updateFromFile( wxComboBox* aComboBox,
        const wxString& aFilePath, const wxString& aKeyword )
{
    wxString curValue = aComboBox->GetValue();
    const wxString keyword( aKeyword.Lower() );
    wxTextFile file;

    if( !file.Open( aFilePath ) )
        return;

    aComboBox->Clear();

    // Process the file, looking for components
    for( wxString line = file.GetFirstLine().Lower(); !file.Eof(); line = file.GetNextLine().Lower() )
    {
        int idx = line.Find( keyword );

        if( idx != wxNOT_FOUND )
        {
            wxString data = line.Mid( idx );
            data = data.AfterFirst( ' ' );
            data = data.BeforeFirst( ' ' );
            data = data.Trim();

            if( !data.IsEmpty() )
                aComboBox->Append( data );
        }
    }

    // Restore the previous value
    if( !curValue.IsEmpty() )
        aComboBox->SetValue( curValue );
    else if( aComboBox->GetCount() > 0 )
        aComboBox->SetSelection( 0 );
}


SCH_FIELD& DIALOG_SPICE_MODEL::getField( int aFieldType )
{
    const wxString& spiceField = NETLIST_EXPORTER_PSPICE::GetSpiceFieldName( (SPICE_FIELD) aFieldType );

    auto fieldIt = std::find_if( m_fields.begin(), m_fields.end(), [&]( const SCH_FIELD& f ) {
        return f.GetName() == spiceField;
    } );

    // Found one, so return it
    if( fieldIt != m_fields.end() )
        return *fieldIt;

    // Create a new field with requested name
    m_fields.emplace_back( wxPoint(), m_fields.size(), &m_component, spiceField );
    return m_fields.back();
}


bool DIALOG_SPICE_MODEL::addPwlValue( const wxString& aTime, const wxString& aValue )
{
    // TODO execute validators
    if( aTime.IsEmpty() || aValue.IsEmpty() )
        return false;

    long idx = m_pwlValList->InsertItem( m_pwlTimeCol, aTime );
    m_pwlValList->SetItem( idx, m_pwlValueCol, aValue );

    // There is no wxString::ToFloat, but we need to guarantee it fits in 4 bytes
    double timeD;
    float timeF;
    m_pwlTime->GetValue().ToDouble( &timeD );
    timeF = timeD;

    // Store the time value, so the entries can be sorted
    m_pwlValList->SetItemData( idx, *reinterpret_cast<long*>( &timeF ) );

    // Sort items by timestamp
    m_pwlValList->SortItems( comparePwlValues, -1 );

    return true;
}


void DIALOG_SPICE_MODEL::onSemiSelectLib( wxCommandEvent& event )
{
    wxFileDialog openDlg( this, wxT( "Select library" ),
            wxFileName( m_semiLib->GetValue() ).GetPath(), "",
            "Spice library file (*.lib)|*.lib;*.LIB|Any file|*",
            wxFD_OPEN | wxFD_FILE_MUST_EXIST );

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

    m_semiLib->SetValue( openDlg.GetPath() );
    updateFromFile( m_semiModel, openDlg.GetPath(), "model" );
}


void DIALOG_SPICE_MODEL::onSelectIcLib( wxCommandEvent& event )
{
    wxFileDialog openDlg( this, wxT( "Select library" ),
            wxFileName( m_icLib->GetValue() ).GetPath(), "",
            "Spice library file (*.lib)|*.lib;*.LIB|Any file|*",
            wxFD_OPEN | wxFD_FILE_MUST_EXIST );

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

    m_icLib->SetValue( openDlg.GetPath() );
    updateFromFile( m_icModel, openDlg.GetPath(), "subckt" );
}


void DIALOG_SPICE_MODEL::onPwlAdd( wxCommandEvent& event )
{
    addPwlValue( m_pwlTime->GetValue(), m_pwlValue->GetValue() );
}


void DIALOG_SPICE_MODEL::onPwlRemove( wxCommandEvent& event )
{
    long idx = m_pwlValList->GetNextItem( -1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED );
    m_pwlValList->DeleteItem( idx );
}