netlist_exporter_base.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, 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, 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_H
#define NETLIST_EXPORTER_H

#include <lib_pin.h>
#include <sch_symbol.h>
#include <sch_text.h>
#include <sch_sheet.h>
#include <schematic.h>

class UNIQUE_STRINGS
{
public:
    void Clear()  {  m_set.clear();  }

    bool Lookup( const wxString& aString )
    {
        std::pair<us_iterator, bool> pair = m_set.insert( aString );

        return !pair.second;
    }

    std::set<wxString>      m_set;    

    typedef std::set<wxString>::iterator us_iterator;
};

struct LIB_SYMBOL_LESS_THAN
{
    // a "less than" test on two LIB_SYMBOLs (.m_name wxStrings)
    bool operator()( LIB_SYMBOL* const& libsymbol1, LIB_SYMBOL* const& libsymbol2 ) const
    {
        // Use case specific GetName() wxString compare
        return libsymbol1->GetLibId() < libsymbol2->GetLibId();
    }
};


struct PIN_INFO
{
    PIN_INFO( const wxString& aPinNumber, const wxString& aNetName ) :
            num( aPinNumber ),
            netName( aNetName )
    {}

    wxString num;
    wxString netName;
};


class NETLIST_EXPORTER_BASE
{
public:
    NETLIST_EXPORTER_BASE( SCHEMATIC_IFACE* aSchematic ) :
        m_schematic( aSchematic )
    {
        wxASSERT( aSchematic );
        m_savedCurrentSheet = m_schematic->CurrentSheet();
    }

    virtual ~NETLIST_EXPORTER_BASE()
    {
        m_schematic->SetCurrentSheet( m_savedCurrentSheet );
    }

    virtual bool WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions )
    {
        return false;
    }

    static wxString MakeCommandLine( const wxString& aFormatString, const wxString& aNetlistFile,
                                     const wxString& aFinalFile,
                                     const wxString& aProjectDirectory );

protected:
    void CreatePinList( SCH_SYMBOL* aSymbol, SCH_SHEET_PATH* aSheetPath,
                        bool aKeepUnconnectedPins );

    SCH_SYMBOL* findNextSymbol( EDA_ITEM* aItem, SCH_SHEET_PATH* aSheetPath );

    void eraseDuplicatePins();

    void findAllUnitsOfSymbol( SCH_SYMBOL* aSchSymbol, LIB_SYMBOL* aLibSymbol,
                               SCH_SHEET_PATH* aSheetPath, bool aKeepUnconnectedPins );

    std::vector<PIN_INFO> m_sortedSymbolPinList;

    UNIQUE_STRINGS        m_referencesAlreadyFound;

    std::set<LIB_SYMBOL*, LIB_SYMBOL_LESS_THAN> m_libParts;

    SCHEMATIC_IFACE*      m_schematic;

    SCH_SHEET_PATH        m_savedCurrentSheet;
};

#endif