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 , UNKNOWN = -1 , ORCAD , LEGACY , KICAD }

enum	NETLIST_FILE_T { UNKNOWN = -1 , ORCAD , LEGACY , KICAD , 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.

	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.

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.

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.

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.

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.

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

bool	m_loadFootprintFilters
	Load the component footprint filters section if true.

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

LINE_READER *	m_lineReader
	The line reader of the netlist.

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

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.

void	loadFootprintFilters ()
	Load the footprint filter section of netlist file.

void	loadNet (char aText, COMPONENT aComponent)
	Function loadNet read a component net description from aText.

COMPONENT *	loadComponent (char *aText)
	Read the aLine containing the description of a component from a legacy format netlist and add it to the netlist.

void	loadFootprintFilters ()
	Load the footprint filter section of netlist file.

void	loadNet (char aText, COMPONENT aComponent)
	Function loadNet read a component net description from aText.

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

Member Enumeration Documentation

◆ NETLIST_FILE_T [1/2]

enum NETLIST_READER::NETLIST_FILE_T

inherited

Enumerator
UNKNOWN
ORCAD
LEGACY
KICAD
UNKNOWN
ORCAD
LEGACY
KICAD

Definition at line 96 of file common/netlist_reader/netlist_reader.h.

◆ NETLIST_FILE_T [2/2]

enum NETLIST_READER::NETLIST_FILE_T

inherited

Enumerator
UNKNOWN
ORCAD
LEGACY
KICAD
UNKNOWN
ORCAD
LEGACY
KICAD

Definition at line 97 of file pcbnew/netlist_reader/netlist_reader.h.

Constructor & Destructor Documentation

◆ LEGACY_NETLIST_READER() [1/2]

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

inline

Definition at line 225 of file common/netlist_reader/netlist_reader.h.

References NETLIST_READER::NETLIST_READER().

◆ LEGACY_NETLIST_READER() [2/2]

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

inline

Definition at line 226 of file pcbnew/netlist_reader/netlist_reader.h.

References NETLIST_READER::NETLIST_READER().

Member Function Documentation

◆ GetNetlistReader() [1/2]

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 76 of file common/netlist_reader/netlist_reader.cpp.

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

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

◆ GetNetlistReader() [2/2]

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

References NETLIST_READER().

◆ GuessNetlistFileType() [1/2]

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 43 of file common/netlist_reader/netlist_reader.cpp.

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

Referenced by GetNetlistReader().

◆ GuessNetlistFileType() [2/2]

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

◆ loadComponent() [1/2]

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 95 of file common/netlist_reader/legacy_netlist_reader.cpp.

References _, COMPONENT, From_UTF8(), NETLIST_READER::m_lineReader, NETLIST_READER::m_netlist, name, path, LIB_ID::SetLibItemName(), COMPONENT::SetName(), text, and THROW_PARSE_ERROR.

Referenced by LoadNetlist().

◆ loadComponent() [2/2]

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.

◆ loadFootprintFilters() [1/2]

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 209 of file common/netlist_reader/legacy_netlist_reader.cpp.

References _, From_UTF8(), NETLIST_READER::m_lineReader, NETLIST_READER::m_netlist, COMPONENT::SetFootprintFilters(), and THROW_PARSE_ERROR.

Referenced by LoadNetlist().

◆ loadFootprintFilters() [2/2]

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.

◆ loadNet() [1/2]

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 175 of file common/netlist_reader/legacy_netlist_reader.cpp.

References _, COMPONENT::AddNet(), From_UTF8(), NETLIST_READER::m_lineReader, and THROW_PARSE_ERROR.

Referenced by LoadNetlist().

◆ loadNet() [2/2]

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.

◆ LoadNetlist() [1/2]

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 33 of file common/netlist_reader/legacy_netlist_reader.cpp.

References loadComponent(), loadFootprintFilters(), loadNet(), NETLIST_READER::m_footprintReader, NETLIST_READER::m_lineReader, NETLIST_READER::m_loadFootprintFilters, NETLIST_READER::m_netlist, and StrPurge().

◆ LoadNetlist() [2/2]

virtual 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