netlist_exporter_pspice.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2013 jp.charras at wanadoo.fr
 * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
 * Copyright (C) 1992-2021 KiCad Developers
 *
 * 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 NETLIST_EXPORTER_PSPICE_H
#define NETLIST_EXPORTER_PSPICE_H

#include "netlist_exporter_base.h"
#include <list>
#include <map>

class PROJECT;

enum SPICE_NETLIST_OPTIONS {
    NET_ADJUST_INCLUDE_PATHS = 8, // use full paths for included files (if they are in search path)
    NET_ADJUST_PASSIVE_VALS = 16, // reformat passive component values (e.g. 1M -> 1Meg)
    NET_ALL_FLAGS = 0xffff
};

enum SPICE_FIELD {
    SF_PRIMITIVE,
    SF_MODEL,
    SF_ENABLED,
    SF_NODE_SEQUENCE,
    SF_LIB_FILE,
    SF_END     // sentinel
};

enum SPICE_PRIMITIVE {
    SP_UNKNOWN      = ' ',
    SP_RESISTOR     = 'R',
    SP_CAPACITOR    = 'C',
    SP_INDUCTOR     = 'L',
    SP_DIODE        = 'D',
    SP_BJT          = 'Q',
    SP_MOSFET       = 'M',
    SP_JFET         = 'J',
    SP_SUBCKT       = 'X',
    SP_VSOURCE      = 'V',
    SP_ISOURCE      = 'I'
};


struct SPICE_ITEM
{
    SCH_COMPONENT* m_parent;

    wxChar m_primitive;

    wxString m_model;

    wxString m_refName;

    bool m_enabled;

    std::vector<wxString> m_pins;

    std::vector<int> m_pinSequence;
};


class NETLIST_EXPORTER_PSPICE : public NETLIST_EXPORTER_BASE
{
public:
    NETLIST_EXPORTER_PSPICE( SCHEMATIC* aSchematic ) :
            NETLIST_EXPORTER_BASE( aSchematic )
    {
    }

    virtual ~NETLIST_EXPORTER_PSPICE()
    {
    }

    typedef std::list<SPICE_ITEM> SPICE_ITEM_LIST;

    typedef std::map<wxString, int> NET_INDEX_MAP;

    const SPICE_ITEM_LIST& GetSpiceItems() const
    {
        return m_spiceItems;
    }

    wxString GetSpiceDevice( const wxString& aComponent ) const;

    bool WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions ) override;

    bool Format( OUTPUTFORMATTER* aFormatter, unsigned aCtl );

    bool ProcessNetlist( unsigned aCtl );


     static void ReplaceForbiddenChars( wxString& aNetName );

    const NET_INDEX_MAP& GetNetIndexMap() const
    {
        return m_netMap;
    }

    static const std::vector<wxString>& GetSpiceFields()
    {
        return m_spiceFields;
    }

    static const wxString& GetSpiceFieldName( SPICE_FIELD aField )
    {
        return m_spiceFields[(int) aField];
    }

    static wxString GetSpiceField( SPICE_FIELD aField, SCH_COMPONENT* aComponent, unsigned aCtl );

    static wxString GetSpiceFieldDefVal( SPICE_FIELD aField, SCH_COMPONENT* aComponent,
                                         unsigned aCtl );

    void UpdateDirectives( unsigned aCtl );

    const std::vector<wxString> GetDirectives() const
    {
        return m_directives;
    }

    static bool StringToBool( const wxString& aStr )
    {
        if( aStr.IsEmpty() )
            return false;

        char c = tolower( aStr[0] );

        // Different ways of saying false (no/false/0)
        return !( c == 'n' || c == 'f' || c == '0' );
    }

protected:
    virtual void writeDirectives( OUTPUTFORMATTER* aFormatter, unsigned aCtl ) const;

private:
    wxString m_title;

    std::vector<wxString> m_directives;

    std::set<wxString> m_libraries;

    NET_INDEX_MAP m_netMap;

    SPICE_ITEM_LIST m_spiceItems;

    // Component fields that are processed during netlist export & simulation
    static const std::vector<wxString> m_spiceFields;
};

#endif