A pure virtual class to derive a specific type of netlist reader from. More...

#include <netlist_reader.h>

Inheritance diagram for NETLIST_READER:

Public Types
enum	NETLIST_FILE_T { UNKNOWN = -1 , ORCAD , LEGACY , KICAD }

Public Member Functions
	NETLIST_READER (LINE_READER aLineReader, NETLIST aNetlist, CMP_READER *aFootprintLinkReader=nullptr)

virtual	~NETLIST_READER ()

virtual void	LoadNetlist ()=0
	Load the contents of the netlist file into aNetlist. More...

Static Public Member Functions
static NETLIST_FILE_T	GuessNetlistFileType (LINE_READER *aLineReader)
	Look at aFileHeaderLine to see if it matches any of the netlist file types it knows about. More...

static NETLIST_READER *	GetNetlistReader (NETLIST *aNetlist, const wxString &aNetlistFileName, const wxString &aCompFootprintFileName=wxEmptyString)
	Attempt to determine the net list file type of aNetlistFileName and return the appropriate NETLIST_READER type. More...

Protected Attributes
NETLIST *	m_netlist
	The net list to read the file(s) into. More...

bool	m_loadFootprintFilters
	Load the component footprint filters section if true. More...

bool	m_loadNets
	Load the nets section of the netlist file if true. More...

LINE_READER *	m_lineReader
	The line reader of the netlist. More...

CMP_READER *	m_footprintReader
	The reader used to load the footprint links. If NULL, footprint links are not read. More...

Detailed Description

A pure virtual class to derive a specific type of netlist reader from.

Definition at line 102 of file netlist_reader.h.

Member Enumeration Documentation

◆ NETLIST_FILE_T

enum NETLIST_READER::NETLIST_FILE_T

Enumerator
UNKNOWN
ORCAD
LEGACY
KICAD

Definition at line 106 of file netlist_reader.h.

 {
 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.
 };

Constructor & Destructor Documentation

◆ NETLIST_READER()

NETLIST_READER::NETLIST_READER	(	LINE_READER *	aLineReader,
		NETLIST *	aNetlist,
		CMP_READER *	aFootprintLinkReader = `nullptr`
	)

inline

Parameters

aLineReader	ownership is taken of this LINE_READER.
aNetlist	the NETLIST object to read into.
aFootprintLinkReader	ownership is taken of this CMP_READER.

Definition at line 123 of file netlist_reader.h.

 {
 wxASSERT( aLineReader != nullptr );
 
 m_lineReader = aLineReader;
 m_footprintReader = aFootprintLinkReader;
 m_netlist = aNetlist;
 m_loadFootprintFilters = true;
 m_loadNets = true;
 }

References m_footprintReader, m_lineReader, m_loadFootprintFilters, m_loadNets, and m_netlist.

◆ ~NETLIST_READER()

NETLIST_READER::~NETLIST_READER ( )

virtual

Definition at line 41 of file netlist_reader.cpp.

{
 delete m_lineReader;
 delete m_footprintReader;
}

References m_footprintReader, and m_lineReader.

Member Function Documentation

◆ GetNetlistReader()

NETLIST_READER * NETLIST_READER::GetNetlistReader	(	NETLIST *	aNetlist,
		const wxString &	aNetlistFileName,
		const wxString &	aCompFootprintFileName = `wxEmptyString`
	)

static

Attempt to determine the net list file type of aNetlistFileName and return the appropriate NETLIST_READER type.

Parameters

aNetlist	is the netlist to load aNetlistFileName into.
aNetlistFileName	is the full path and file name of the net list to read.
aCompFootprintFileName	is the full path and file name of the component footprint associations to read. Set to wxEmptyString if loading the footprint association file is not required.

Returns: the appropriate NETLIST_READER if aNetlistFileName is a valid netlist or NULL if aNetlistFileName is not a valid netlist files.

Definition at line 81 of file netlist_reader.cpp.

{
 wxASSERT( aNetlist != nullptr );
 
 std::unique_ptr<FILE_LINE_READER> file_rdr =
 std::make_unique<FILE_LINE_READER>( aNetlistFileName );
 
 NETLIST_FILE_T type = GuessNetlistFileType( file_rdr.get() );
 file_rdr->Rewind();
 
 // The component footprint link reader is NULL if no file name was specified.
 std::unique_ptr<CMP_READER> cmp_rdr( aCompFootprintFileName.IsEmpty() ?
 nullptr :
 new CMP_READER( new FILE_LINE_READER( aCompFootprintFileName ) ) );
 
 switch( type )
 {
 case LEGACY:
 case ORCAD:
 return new LEGACY_NETLIST_READER( file_rdr.release(), aNetlist, cmp_rdr.release() );
 
 case KICAD:
 return new KICAD_NETLIST_READER( file_rdr.release(), aNetlist, cmp_rdr.release() );
 
 default: // Unrecognized format:
 break;
 }
 
 return nullptr;
}

References GuessNetlistFileType(), KICAD, LEGACY, and ORCAD.

Referenced by TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), and PCB_EDIT_FRAME::ReadNetlistFromFile().

◆ GuessNetlistFileType()

NETLIST_READER::NETLIST_FILE_T NETLIST_READER::GuessNetlistFileType ( LINE_READER * aLineReader )

static

Look at aFileHeaderLine to see if it matches any of the netlist file types it knows about.

Parameters

aLineReader is the LINE_READER object containing lines from the netlist to test.

Returns: the NETLIST_FILE_T of aLineReader.

Definition at line 48 of file netlist_reader.cpp.

{
 // Orcad Pcb2 netlist format starts by "( {", followed by an unknown comment,
 // depending on the tool which created the file
 wxRegEx reOrcad( wxT( "(?i)[ ]*\\([ \t]+{+" ), wxRE_ADVANCED );
 wxASSERT( reOrcad.IsValid() );
 
 // Our legacy netlist format starts by "# EESchema Netlist "
 wxRegEx reLegacy( wxT( "(?i)#[ \t]+EESchema[ \t]+Netlist[ \t]+" ), wxRE_ADVANCED );
 wxASSERT( reLegacy.IsValid() );
 
 // Our new netlist format starts by "(export (version "
 wxRegEx reKicad( wxT( "[ ]*\\(export[ ]+" ), wxRE_ADVANCED );
 wxASSERT( reKicad.IsValid() );
 
 wxString line;
 
 while( aLineReader->ReadLine() )
 {
 line = FROM_UTF8( aLineReader->Line() );
 
 if( reLegacy.Matches( line ) )
 return LEGACY;
 else if( reKicad.Matches( line ) )
 return KICAD;
 else if( reOrcad.Matches( line ) )
 return ORCAD;
 }
 
 return UNKNOWN;
}

References FROM_UTF8(), KICAD, LEGACY, LINE_READER::Line(), ORCAD, LINE_READER::ReadLine(), and UNKNOWN.

Referenced by GetNetlistReader().

◆ LoadNetlist()

virtual void NETLIST_READER::LoadNetlist ( )

pure virtual

Load the contents of the netlist file into aNetlist.

Exceptions

IO_ERROR	if a file IO error occurs.
PARSE_ERROR	if an error occurs while parsing the file.

Implemented in LEGACY_NETLIST_READER, and KICAD_NETLIST_READER.

Member Data Documentation

◆ m_footprintReader

CMP_READER* NETLIST_READER::m_footprintReader

protected

The reader used to load the footprint links. If NULL, footprint links are not read.

Definition at line 178 of file netlist_reader.h.

Referenced by LEGACY_NETLIST_READER::LoadNetlist(), KICAD_NETLIST_READER::LoadNetlist(), NETLIST_READER(), and ~NETLIST_READER().

◆ m_lineReader

LINE_READER* NETLIST_READER::m_lineReader

protected

The line reader of the netlist.

Definition at line 175 of file netlist_reader.h.

Referenced by LEGACY_NETLIST_READER::loadComponent(), LEGACY_NETLIST_READER::loadFootprintFilters(), LEGACY_NETLIST_READER::loadNet(), LEGACY_NETLIST_READER::LoadNetlist(), KICAD_NETLIST_READER::LoadNetlist(), NETLIST_READER(), and ~NETLIST_READER().

◆ m_loadFootprintFilters

bool NETLIST_READER::m_loadFootprintFilters

protected

Load the component footprint filters section if true.

Definition at line 173 of file netlist_reader.h.

Referenced by LEGACY_NETLIST_READER::LoadNetlist(), and NETLIST_READER().

◆ m_loadNets

bool NETLIST_READER::m_loadNets

protected

Load the nets section of the netlist file if true.

Definition at line 174 of file netlist_reader.h.

Referenced by NETLIST_READER().

◆ m_netlist

NETLIST* NETLIST_READER::m_netlist

protected

The net list to read the file(s) into.

Definition at line 172 of file netlist_reader.h.

Referenced by LEGACY_NETLIST_READER::loadComponent(), LEGACY_NETLIST_READER::loadFootprintFilters(), LEGACY_NETLIST_READER::LoadNetlist(), KICAD_NETLIST_READER::LoadNetlist(), and NETLIST_READER().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ NETLIST_FILE_T

Constructor & Destructor Documentation

◆ NETLIST_READER()

◆ ~NETLIST_READER()

Member Function Documentation

◆ GetNetlistReader()

◆ GuessNetlistFileType()

◆ LoadNetlist()

Member Data Documentation

◆ m_footprintReader

◆ m_lineReader

◆ m_loadFootprintFilters

◆ m_loadNets

◆ m_netlist