netlist_exporter_spice.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 <[email protected]>
 * 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/>.
 */
 
#ifndef NETLIST_EXPORTER_SPICE_H
#define NETLIST_EXPORTER_SPICE_H
 
#include "netlist_exporter_base.h"
#include <sim/sim_lib_mgr.h>
#include <sim/sim_library.h>
#include <sim/sim_model.h>
#include <sim/sim_model_multiunit.h>
#include <sim/spice_generator.h>
 
#include <list>
 
 
class wxWindow;
 
// Test-only access seam for the private multi-unit helpers (see qa/tests/spice).
class NETLIST_EXPORTER_SPICE_PROBE;
 
 
class NAME_GENERATOR
{
public:
    std::string Generate( const std::string& aProposedName );

    void Clear() { m_names.clear(); }
 
private:
    std::unordered_set<std::string> m_names;
};
 
 
class NETLIST_EXPORTER_SPICE : public NETLIST_EXPORTER_BASE
{
public:
    friend class NETLIST_EXPORTER_SPICE_PROBE;
 
    enum OPTIONS
    {
        OPTION_ADJUST_INCLUDE_PATHS  = 0x0010,
        OPTION_ADJUST_PASSIVE_VALS   = 0x0020,
        OPTION_SAVE_ALL_VOLTAGES     = 0x0040,
        OPTION_SAVE_ALL_CURRENTS     = 0x0080,
        OPTION_SAVE_ALL_DISSIPATIONS = 0x0100,
        OPTION_CUR_SHEET_AS_ROOT     = 0x0200,
        OPTION_SIM_COMMAND           = 0x0400,
        OPTION_SAVE_ALL_EVENTS       = 0x0800,
        OPTION_DEFAULT_FLAGS =   OPTION_ADJUST_INCLUDE_PATHS
                               | OPTION_ADJUST_PASSIVE_VALS
                               | OPTION_SAVE_ALL_VOLTAGES
                               | OPTION_SAVE_ALL_CURRENTS
                               | OPTION_SAVE_ALL_DISSIPATIONS
                               | OPTION_SAVE_ALL_EVENTS
    };
 
    NETLIST_EXPORTER_SPICE( SCHEMATIC* aSchematic, KIWAY* aKiway );

    bool writeNetlist( const wxString& aOutFileName, unsigned aNetlistOptions,
                       REPORTER& aReporter ) override;

    bool DoWriteNetlist( const wxString& aSimCommand, unsigned aSimOptions,
                         OUTPUTFORMATTER& aFormatter, REPORTER& aReporter );

    virtual void WriteHead( OUTPUTFORMATTER& aFormatter, unsigned aNetlistOptions );

    virtual void WriteTail( OUTPUTFORMATTER& aFormatter, unsigned aNetlistOptions );

    virtual bool ReadSchematicAndLibraries( unsigned aNetlistOptions, REPORTER& aReporter );

    static void ConvertToSpiceMarkup( wxString* aNetName );

    std::set<wxString> GetNets() const { return m_nets; }

    wxString GetItemName( const wxString& aRefName ) const;

    const std::list<SPICE_ITEM>& GetItems() const { return m_items; }

    const SPICE_ITEM* FindItem( const wxString& aRefName ) const;
 
    const std::vector<wxString>& GetDirectives() { return m_directives; }
 
protected:
    void ReadDirectives( unsigned aNetlistOptions );
    virtual void WriteDirectives( const wxString& aSimCommand, unsigned aSimOptions,
                                  OUTPUTFORMATTER& candidate ) const;
 
    virtual wxString GenerateItemPinNetName( const wxString& aNetName, int& aNcCounter ) const;

    SCH_SHEET_LIST BuildSheetList( unsigned aNetlistOptions = 0 ) const;
 
private:
    void readRefName( SCH_SHEET_PATH& aSheet, SCH_SYMBOL& aSymbol, SPICE_ITEM& aItem,
                      std::set<std::string>& aRefNames );

    wxString collectMergedSimPins( SCH_SYMBOL& aSymbol, const SCH_SHEET_PATH& aSheet,
                                   const wxString& aVariantName );

    std::vector<UNIT_PIN_MAP> collectUnitPinMaps( SCH_SYMBOL& aSymbol, const SCH_SHEET_PATH& aSheet,
                                                  const wxString& aVariantName );

    SIM_DECOMPOSITION getDecomposition( SCH_SYMBOL& aSymbol, const SCH_SHEET_PATH& aSheet,
                                        const wxString& aVariantName ) const;
 
    void readModel( SCH_SHEET_PATH& aSheet, SCH_SYMBOL& aSymbol, SPICE_ITEM& aItem,
                    const wxString& aVariantName, REPORTER& aReporter );
    void readPinNumbers( SCH_SYMBOL& aSymbol, SPICE_ITEM& aItem,
                         const std::vector<PIN_INFO>& aPins );
    void readPinNetNames( SCH_SYMBOL& aSymbol, SPICE_ITEM& aItem,
                          const std::vector<PIN_INFO>& aPins, int& aNcCounter );
    void getNodePattern( SPICE_ITEM& aItem, std::vector<std::string>& aModifiers );
    void readNodePattern( SPICE_ITEM& aItem );
 
    void writeInclude( OUTPUTFORMATTER& aFormatter, unsigned aNetlistOptions,
                       const wxString& aPath );
 
    void writeIncludes( OUTPUTFORMATTER& aFormatter, unsigned aNetlistOptions );
    void writeModels( OUTPUTFORMATTER& aFormatter );
    void writeItems( OUTPUTFORMATTER& aFormatter );
 
private:
    SIM_LIB_MGR             m_libMgr;             
    NAME_GENERATOR          m_modelNameGenerator; 
 
    std::vector<wxString>   m_directives;         
    std::set<wxString>      m_rawIncludes;        
    std::set<wxString>      m_nets;

    std::list<SPICE_ITEM>   m_items;

    std::vector<std::unique_ptr<SIM_MODEL_MULTIUNIT>> m_multiunitModels;
};
 
 
#endif // NETLIST_EXPORTER_SPICE_H