LEGACY_NETLIST_READER Class Reference

Read the KiCad legacy and the old Orcad netlist formats. More...

#include <netlist_reader.h>

Inheritance diagram for LEGACY_NETLIST_READER:

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

Public Member Functions
	LEGACY_NETLIST_READER (LINE_READER *aLineReader, NETLIST *aNetlist, CMP_READER *aFootprintLinkReader=nullptr)
virtual void	LoadNetlist () override
	Read the netlist file in the legacy format 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...

Private Member Functions
COMPONENT *	loadComponent (char *aText)
	Read the aLine containing the description of a component from a legacy format netlist and add it to the netlist. More...
void	loadFootprintFilters ()
	Load the footprint filter section of netlist file. More...
void	loadNet (char *aText, COMPONENT *aComponent)
	Function loadNet read a component net description from aText. More...

Detailed Description

Read the KiCad legacy and the old Orcad netlist formats.

The KiCad legacy netlist format was derived directly from an old Orcad netlist format. The primary difference is the header was changed so this reader can read both formats.

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

LEGACY_NETLIST_READER()

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

inline

Definition at line 235 of file netlist_reader.h.

 :
 NETLIST_READER( aLineReader, aNetlist, aFootprintLinkReader )
 {
 }

Member Function Documentation

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_NETLIST_EXPORTER_KICAD_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().

loadComponent()

COMPONENT * LEGACY_NETLIST_READER::loadComponent ( char *  aText )

private

Read the aLine containing the description of a component from a legacy format netlist and add it to the netlist.

Analyze the first line of a component description in netlist: ( /40C08647 $noname R20 4.7K {Lib=R}

Parameters

aText

contains the first line of description.

Returns

the new component created by parsing aLine.

Exceptions

PARSE_ERROR

when aLine is not a valid component description.

Definition at line 98 of file legacy_netlist_reader.cpp.

{
 char* text;
 wxString msg;
 wxString footprintName; // the footprint name read from netlist
 wxString value; // the component value read from netlist
 wxString reference; // the component schematic reference designator read from netlist
 wxString name; // the name of component that was placed in the schematic
 char line[1024];
 
 strncpy( line, aText, sizeof(line)-1 );
 line[sizeof(line)-1] = '\0';
 
 value = wxT( "~" );
 
 // Sample component line: /68183921-93a5-49ac-91b0-49d05a0e1647 $noname R20 4.7K {Lib=R}
 
 // Read time stamp (first word)
 if( ( text = strtok( line, " ()\t\n" ) ) == nullptr )
 {
 msg = _( "Cannot parse time stamp in symbol section of netlist." );
 THROW_PARSE_ERROR( msg, m_lineReader->GetSource(), line, m_lineReader->LineNumber(),
 m_lineReader->Length() );
 }
 
 KIID_PATH path( FROM_UTF8( text ) );
 
 // Read footprint name (second word)
 if( ( text = strtok( nullptr, " ()\t\n" ) ) == nullptr )
 {
 msg = _( "Cannot parse footprint name in symbol section of netlist." );
 THROW_PARSE_ERROR( msg, m_lineReader->GetSource(), aText, m_lineReader->LineNumber(),
 m_lineReader->Length() );
 }
 
 footprintName = FROM_UTF8( text );
 
 // The footprint name will have to be looked up in the *.cmp file.
 if( footprintName == wxT( "$noname" ) )
 footprintName = wxEmptyString;
 
 // Read schematic reference designator (third word)
 if( ( text = strtok( nullptr, " ()\t\n" ) ) == nullptr )
 {
 msg = _( "Cannot parse reference designator in symbol section of netlist." );
 THROW_PARSE_ERROR( msg, m_lineReader->GetSource(), aText, m_lineReader->LineNumber(),
 m_lineReader->Length() );
 }
 
 reference = FROM_UTF8( text );
 
 // Read schematic value (forth word)
 if( ( text = strtok( nullptr, " ()\t\n" ) ) == nullptr )
 {
 msg = _( "Cannot parse value in symbol section of netlist." );
 THROW_PARSE_ERROR( msg, m_lineReader->GetSource(), aText, m_lineReader->LineNumber(),
 m_lineReader->Length() );
 }
 
 value = FROM_UTF8( text );
 
 // Read component name (fifth word) {Lib=C}
 // This is an optional field (a comment), which does not always exists
 if( ( text = strtok( nullptr, " ()\t\n" ) ) != nullptr )
 {
 name = FROM_UTF8( text ).AfterFirst( wxChar( '=' ) ).BeforeLast( wxChar( '}' ) );
 }
 
 LIB_ID fpid;
 
 if( !footprintName.IsEmpty() )
 fpid.SetLibItemName( footprintName );
 
 COMPONENT* component = new COMPONENT( fpid, reference, value, path, {} );
 component->SetName( name );
 m_netlist->AddComponent( component );
 return component;
}

References _, NETLIST::AddComponent(), COMPONENT, FROM_UTF8(), LINE_READER::GetSource(), LINE_READER::Length(), LINE_READER::LineNumber(), NETLIST_READER::m_lineReader, NETLIST_READER::m_netlist, name, path, LIB_ID::SetLibItemName(), COMPONENT::SetName(), text, and THROW_PARSE_ERROR.

Referenced by LoadNetlist().

loadFootprintFilters()

void LEGACY_NETLIST_READER::loadFootprintFilters ( )

private

Load the footprint filter section of netlist file.

Sample legacy footprint filter section: { Allowed footprints by component: $component R11 R? SM0603 SM0805 R?-* SM1206 $endlist $endfootprintlist }

Exceptions

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

Definition at line 212 of file legacy_netlist_reader.cpp.

{
 wxArrayString filters;
 wxString cmpRef;
 char* line;
 COMPONENT* component = nullptr; // Suppress compile warning
 
 while( ( line = m_lineReader->ReadLine() ) != nullptr )
 {
 if( strncasecmp( line, "$endlist", 8 ) == 0 ) // end of list for the current component
 {
 wxASSERT( component != nullptr );
 component->SetFootprintFilters( filters );
 component = nullptr;
 filters.Clear();
 continue;
 }
 
 if( strncasecmp( line, "$endfootprintlist", 4 ) == 0 )
 // End of this section
 return;
 
 if( strncasecmp( line, "$component", 10 ) == 0 ) // New component reference found
 {
 cmpRef = FROM_UTF8( line + 11 );
 cmpRef.Trim( true );
 cmpRef.Trim( false );
 
 component = m_netlist->GetComponentByReference( cmpRef );
 
 // Cannot happen if the netlist is valid.
 if( component == nullptr )
 {
 wxString msg;
 msg.Printf( _( "Cannot find symbol %s in footprint filter section of netlist." ),
  cmpRef );
 THROW_PARSE_ERROR( msg, m_lineReader->GetSource(), line, m_lineReader->LineNumber(),
 m_lineReader->Length() );
 }
 }
 else
 {
 // Add new filter to list
 wxString fp = FROM_UTF8( line + 1 );
 fp.Trim( false );
 fp.Trim( true );
 filters.Add( fp );
 }
 }
}

References _, FROM_UTF8(), NETLIST::GetComponentByReference(), LINE_READER::GetSource(), LINE_READER::Length(), LINE_READER::LineNumber(), NETLIST_READER::m_lineReader, NETLIST_READER::m_netlist, LINE_READER::ReadLine(), COMPONENT::SetFootprintFilters(), and THROW_PARSE_ERROR.

Referenced by LoadNetlist().

loadNet()

void LEGACY_NETLIST_READER::loadNet ( char *  aText, COMPONENT *  aComponent  )

private

Function loadNet read a component net description from aText.

Parameters

aText	is current line read from the netlist.
aComponent	is the component to add the net to.

Exceptions

PARSE_ERROR

if a error occurs reading aText.

Definition at line 178 of file legacy_netlist_reader.cpp.

{
 wxString msg;
 char* p;
 char line[256];
 
 strncpy( line, aText, sizeof( line ) );
 line[ sizeof(line) - 1 ] = '\0';
 
 if( ( p = strtok( line, " ()\t\n" ) ) == nullptr )
 {
 msg = _( "Cannot parse pin name in symbol net section of netlist." );
 THROW_PARSE_ERROR( msg, m_lineReader->GetSource(), line, m_lineReader->LineNumber(),
  m_lineReader->Length() );
 }
 
 wxString pinName = FROM_UTF8( p );
 
 if( ( p = strtok( nullptr, " ()\t\n" ) ) == nullptr )
 {
 msg = _( "Cannot parse net name in symbol net section of netlist." );
 THROW_PARSE_ERROR( msg, m_lineReader->GetSource(), line, m_lineReader->LineNumber(),
 m_lineReader->Length() );
 }
 
 wxString netName = FROM_UTF8( p );
 
 if( (char) netName[0] == '?' ) // ? indicates no net connected to pin.
 netName = wxEmptyString;
 
 aComponent->AddNet( pinName, netName, wxEmptyString, wxEmptyString );
}

References _, COMPONENT::AddNet(), FROM_UTF8(), LINE_READER::GetSource(), LINE_READER::Length(), LINE_READER::LineNumber(), NETLIST_READER::m_lineReader, and THROW_PARSE_ERROR.

Referenced by LoadNetlist().

LoadNetlist()

void LEGACY_NETLIST_READER::LoadNetlist ( )

overridevirtual

Read the netlist file in the legacy format into aNetlist.

The legacy netlist format is: # EESchema Netlist Version 1.0 generee le 18/5/2005-12:30:22 ( ( 40C08647 $noname R20 4,7K {Lib=R} ( 1 VCC ) ( 2 MODB_1 ) ) ( 40C0863F $noname R18 4,7_k {Lib=R} ( 1 VCC ) ( 2 MODA_1 ) ) } #End

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 36 of file legacy_netlist_reader.cpp.

{
 int state = 0;
 bool is_comment = false;
 COMPONENT* component = nullptr;
 
 while( m_lineReader->ReadLine() )
 {
 char* line = StrPurge( m_lineReader->Line() );
 
 if( is_comment ) // Comments in progress
 {
 // Test for end of the current comment
 if( ( line = strchr( line, '}' ) ) == nullptr )
 continue;
 
 is_comment = false;
 }
 
 if( *line == '{' ) // Start Comment or Pcbnew info section
 {
 is_comment = true;
 
 if( m_loadFootprintFilters && state == 0
 && (strncasecmp( line, "{ Allowed footprints", 20 ) == 0) )
 {
 loadFootprintFilters();
 continue;
 }
 
 if( ( line = strchr( line, '}' ) ) == nullptr )
 continue;
 }
 
 if( *line == '(' )
 state++;
 
 if( *line == ')' )
 state--;
 
 if( state == 2 )
 {
 component = loadComponent( line );
 continue;
 }
 
 if( state >= 3 ) // Pad descriptions are read here.
 {
 wxASSERT( component != nullptr );
 
 loadNet( line, component );
 state--;
 }
 }
 
 if( m_footprintReader )
 {
 m_footprintReader->Load( m_netlist );
 }
}

References LINE_READER::Line(), CMP_READER::Load(), loadComponent(), loadFootprintFilters(), loadNet(), NETLIST_READER::m_footprintReader, NETLIST_READER::m_lineReader, NETLIST_READER::m_loadFootprintFilters, NETLIST_READER::m_netlist, LINE_READER::ReadLine(), and StrPurge().

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 178 of file netlist_reader.h.

Referenced by LoadNetlist(), KICAD_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 175 of file netlist_reader.h.

Referenced by loadComponent(), loadFootprintFilters(), loadNet(), LoadNetlist(), KICAD_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 173 of file netlist_reader.h.

Referenced by 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 174 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 172 of file netlist_reader.h.

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

---

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

• netlist_reader.h
• legacy_netlist_reader.cpp