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 <[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_H
#define NETLIST_EXPORTER_H
 
#include <schematic.h>
 
#include <map>
#include <set>
#include <optional>
#include <unordered_map>
 
class SCH_SYMBOL;
class SCH_PIN;
class LIB_SYMBOL;
class REPORTER;
class KIWAY;

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;
};
 
 
struct PIN_INFO
{
    PIN_INFO( const wxString& aPinNumber, const wxString& aNetName, const wxString& aPinName,
              const wxString& aSourcePin = wxEmptyString ) :
            num( aPinNumber ),
            netName( aNetName ),
            pinName( aPinName ),
            srcPin( aSourcePin )
    {}
 
    wxString num; 
    wxString netName;
    wxString pinName;
    wxString srcPin; 
};
 

class NETLIST_EXPORTER_BASE
{
public:
    NETLIST_EXPORTER_BASE( SCHEMATIC* aSchematic ) :
        m_schematic( aSchematic )
    {
        wxASSERT( aSchematic );
    }
 
    virtual ~NETLIST_EXPORTER_BASE() = default;
 
    void SetKiway( KIWAY* aKiway ) { m_kiway = aKiway; }

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

    static wxString MakeCommandLine( const wxString& aFormatString, const wxString& aNetlistFile,
                                     const wxString& aFinalFile,
                                     const wxString& aProjectDirectory );
 
protected:
    class CONNECTIVITY_SCOPE
    {
    public:
        explicit CONNECTIVITY_SCOPE( NETLIST_EXPORTER_BASE& aExporter );
        ~CONNECTIVITY_SCOPE();
        CONNECTIVITY_SCOPE( const CONNECTIVITY_SCOPE& ) = delete;
        CONNECTIVITY_SCOPE& operator=( const CONNECTIVITY_SCOPE& ) = delete;
 
    private:
        NETLIST_EXPORTER_BASE& m_exporter;
    };
 
    virtual bool writeNetlist( const wxString& aOutFileName, unsigned aNetlistOptions,
                              REPORTER& aReporter ) { return false; }
 
    struct EXPORT_NET
    {
        wxString name;
        bool hasNoConnect = false;
        std::vector<std::pair<SCH_PIN*, SCH_SHEET_PATH>> pins;
    };
 
    void rebuildConnectivity();
    std::optional<wxString> itemNetName( const SCH_ITEM& aItem, const SCH_SHEET_PATH& aPath ) const;
    SCH_SHEET_LIST m_exportSheets;
    std::vector<EXPORT_NET> m_exportNets;
    std::map<SCH_SHEET_PATH, std::unordered_map<KIID, wxString>> m_exportItemNets;
    unsigned m_connectivityDepth = 0;

    std::vector<PIN_INFO> CreatePinList( SCH_SYMBOL* aSymbol, const SCH_SHEET_PATH& aSheetPath );

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

    void eraseDuplicatePins( std::vector<PIN_INFO>& pins );

    void appendResolvedPins( std::vector<PIN_INFO>& aPins, const SCH_PIN* aPin, const SCH_SHEET_PATH& aSheetPath,
                             const wxString& aNetName );

    std::vector<wxString> resolvePadNumbers( const SCH_PIN* aPin, const SCH_SHEET_PATH& aSheetPath ) const;
 
    const std::set<wxString>& footprintPads( const wxString& aFootprintId ) const;

    void findAllUnitsOfSymbol( SCH_SYMBOL* aSchSymbol, const SCH_SHEET_PATH& aSheetPath,
                               std::vector<PIN_INFO>& aPins );

    UNIQUE_STRINGS        m_referencesAlreadyFound;

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

    SCHEMATIC*      m_schematic;
 
    KIWAY* m_kiway = nullptr;
 
    mutable std::map<wxString, std::set<wxString>> m_footprintPadCache;
};
 
#endif