common/netlist_reader/netlist_reader.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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, 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
 */
 
#pragma once
 
#include <macros.h>
#include <lib_id.h>
#include <netlist_reader/netlist.h>
 
 
class LINE_READER;
 

class CMP_READER
{
public:
    CMP_READER( LINE_READER* aLineReader )
    {
        m_lineReader = aLineReader;
    }
 
    ~CMP_READER();

    bool Load( NETLIST* aNetlist );
 
private:
    LINE_READER* m_lineReader;            
};
 

class NETLIST_READER
{
public:
 
    enum NETLIST_FILE_T
    {
        UNKNOWN = -1,
        ORCAD,
        LEGACY,
        KICAD,
 
        // Add new types here.  Don't forget to create the appropriate class derived from
        // NETCLASS_READER and add the entry to the NETLIST_READER::GetNetlistReader()
        // function.
    };

    NETLIST_READER( LINE_READER*  aLineReader,
                    NETLIST*      aNetlist,
                    CMP_READER*   aFootprintLinkReader = nullptr )
    {
        wxASSERT( aLineReader != nullptr );
 
        m_lineReader           = aLineReader;
        m_footprintReader      = aFootprintLinkReader;
        m_netlist              = aNetlist;
        m_loadFootprintFilters = true;
        m_loadNets             = true;
    }
 
    virtual ~NETLIST_READER();

    static NETLIST_FILE_T GuessNetlistFileType( LINE_READER* aLineReader );

    static NETLIST_READER* GetNetlistReader( NETLIST*        aNetlist,
                                             const wxString& aNetlistFileName,
                                             const wxString& aCompFootprintFileName = wxEmptyString );

    virtual void LoadNetlist() = 0;
 
protected:
    NETLIST*     m_netlist;               
    bool         m_loadFootprintFilters;  
    bool         m_loadNets;              
    LINE_READER* m_lineReader;            

    CMP_READER*  m_footprintReader;
};
 

class LEGACY_NETLIST_READER : public NETLIST_READER
{
    COMPONENT* loadComponent( char* aText );

    void loadFootprintFilters();

    void loadNet( char* aText, COMPONENT* aComponent );
 
public:
 
    LEGACY_NETLIST_READER( LINE_READER*  aLineReader,
                           NETLIST*      aNetlist,
                           CMP_READER*   aFootprintLinkReader = nullptr ) :
        NETLIST_READER( aLineReader, aNetlist, aFootprintLinkReader )
    {
    }

    virtual void LoadNetlist() override;
};
 

class KICAD_NETLIST_READER : public NETLIST_READER
{
public:
    KICAD_NETLIST_READER( LINE_READER*  aLineReader,
                          NETLIST*      aNetlist,
                          CMP_READER*   aFootprintLinkReader = nullptr ) :
        NETLIST_READER( aLineReader, aNetlist, aFootprintLinkReader )
    { }
 
    virtual ~KICAD_NETLIST_READER()
    { }
 
    virtual void LoadNetlist() override;
};