Read the new s-expression based KiCad netlist format. More...

#include <netlist_reader.h>

Inheritance diagram for KICAD_NETLIST_READER:

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

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

virtual	~KICAD_NETLIST_READER ()

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

LINE_READER *	GetLineReader ()

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...

Private Attributes
KICAD_NETLIST_PARSER *	m_parser
	The s-expression format parser. More...

Detailed Description

Read the new s-expression based KiCad netlist format.

Definition at line 361 of file netlist_reader.h.

Member Enumeration Documentation

◆ NETLIST_FILE_T

enum NETLIST_READER::NETLIST_FILE_T

inherited

Enumerator
UNKNOWN
ORCAD
LEGACY
KICAD

Definition at line 110 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

◆ KICAD_NETLIST_READER()

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

inline

Definition at line 364 of file netlist_reader.h.

  :
  NETLIST_READER( aLineReader, aNetlist, aFootprintLinkReader ),
  m_parser( new KICAD_NETLIST_PARSER( aLineReader, aNetlist ) )
  {
  }

◆ ~KICAD_NETLIST_READER()

virtual KICAD_NETLIST_READER::~KICAD_NETLIST_READER ( )

inlinevirtual

Definition at line 372 of file netlist_reader.h.

  {
  delete m_parser;
  }

References m_parser.

Member Function Documentation

◆ GetLineReader()

LINE_READER* NETLIST_READER::GetLineReader ( )

inherited

Returns: the LINE_READER associated with the NETLIST_READER.

◆ GetNetlistReader()

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

staticinherited

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 NETLIST_READER::GuessNetlistFileType(), NETLIST_READER::KICAD, NETLIST_READER::LEGACY, and NETLIST_READER::ORCAD.

Referenced by TEST_NETLISTS_FIXTURE::compareNetlists(), and PCB_EDIT_FRAME::ReadNetlistFromFile().

◆ GuessNetlistFileType()

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

staticinherited

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(), NETLIST_READER::KICAD, NETLIST_READER::LEGACY, LINE_READER::Line(), NETLIST_READER::ORCAD, LINE_READER::ReadLine(), and NETLIST_READER::UNKNOWN.

Referenced by NETLIST_READER::GetNetlistReader().

◆ LoadNetlist()

void KICAD_NETLIST_READER::LoadNetlist ( )

overridevirtual

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.

Implements NETLIST_READER.

Definition at line 37 of file kicad_netlist_reader.cpp.

 {
  m_parser->Parse();
 
  if( m_footprintReader )
  {
  m_footprintReader->Load( m_netlist );
 
  // Sort the component pins so they are in the same order as the legacy format. This
  // is useful for comparing legacy and s-expression netlist dumps.
  for( unsigned i = 0; i < m_netlist->GetCount(); i++ )
  m_netlist->GetComponent( i )->SortPins();
  }
 }

Referenced by PCB_EDIT_FRAME::FetchNetlistFromSchematic(), and CVPCB_MAINFRAME::ReadSchematicNetlist().

Member Data Documentation

◆ m_footprintReader

CMP_READER* NETLIST_READER::m_footprintReader

protectedinherited

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

Definition at line 187 of file netlist_reader.h.

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

◆ m_lineReader

LINE_READER* NETLIST_READER::m_lineReader

protectedinherited

The line reader of the netlist.

Definition at line 184 of file netlist_reader.h.

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

◆ m_loadFootprintFilters

bool NETLIST_READER::m_loadFootprintFilters

protectedinherited

Load the component footprint filters section if true.

Definition at line 182 of file netlist_reader.h.

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

◆ m_loadNets

bool NETLIST_READER::m_loadNets

protectedinherited

Load the nets section of the netlist file if true.

Definition at line 183 of file netlist_reader.h.

Referenced by NETLIST_READER::NETLIST_READER().

◆ m_netlist

NETLIST* NETLIST_READER::m_netlist

protectedinherited

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

Definition at line 181 of file netlist_reader.h.

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

◆ m_parser

KICAD_NETLIST_PARSER* KICAD_NETLIST_READER::m_parser

private

The s-expression format parser.

Definition at line 380 of file netlist_reader.h.

Referenced by ~KICAD_NETLIST_READER().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ NETLIST_FILE_T

Constructor & Destructor Documentation

◆ KICAD_NETLIST_READER()

◆ ~KICAD_NETLIST_READER()

Member Function Documentation

◆ GetLineReader()

◆ GetNetlistReader()

◆ GuessNetlistFileType()

◆ LoadNetlist()

Member Data Documentation

◆ m_footprintReader

◆ m_lineReader

◆ m_loadFootprintFilters

◆ m_loadNets

◆ m_netlist

◆ m_parser