NETLIST_EXPORTER_XML Class Reference

Generate a generic XML based netlist file. More...

#include <netlist_exporter_xml.h>

Inheritance diagram for NETLIST_EXPORTER_XML:

Public Member Functions
	NETLIST_EXPORTER_XML (SCHEMATIC *aSchematic)
bool	WriteNetlist (const wxString &aOutFileName, unsigned aNetlistOptions, REPORTER &aReporter) override
	Write generic netlist to aOutFileName. More...

Static Public Member Functions
static wxString	MakeCommandLine (const wxString &aFormatString, const wxString &aNetlistFile, const wxString &aFinalFile, const wxString &aProjectDirectory)
	Build up a string that describes a command line for executing a child process. More...

Protected Member Functions
XNODE *	node (const wxString &aName, const wxString &aTextualContent=wxEmptyString)
	A convenience function that creates a new XNODE with an optional textual child. More...
XNODE *	makeRoot (unsigned aCtl=GNL_ALL)
	Build the entire document tree for the generic export. More...
XNODE *	makeSymbols (unsigned aCtl)
XNODE *	makeDesignHeader ()
	Fill out a project "design" header into an XML node. More...
XNODE *	makeLibParts ()
	Fill out an XML node with the unique library parts and returns it. More...
XNODE *	makeListOfNets (unsigned aCtl)
	Fill out an XML node with a list of nets and returns it. More...
XNODE *	makeLibraries ()
	Fill out an XML node with a list of used libraries and returns it. More...
void	addSymbolFields (XNODE *aNode, SCH_SYMBOL *aSymbol, SCH_SHEET_PATH *aSheet)
	Holder for multi-unit symbol fields. More...
std::vector< PIN_INFO >	CreatePinList (SCH_SYMBOL *aSymbol, SCH_SHEET_PATH *aSheetPath, bool aKeepUnconnectedPins)
	Find a symbol from the DrawList and builds its pin list. More...
SCH_SYMBOL *	findNextSymbol (EDA_ITEM *aItem, SCH_SHEET_PATH *aSheetPath)
	Check if the given symbol should be processed for netlisting. More...
void	eraseDuplicatePins (std::vector< PIN_INFO > &pins)
	Erase duplicate pins. More...
void	findAllUnitsOfSymbol (SCH_SYMBOL *aSchSymbol, SCH_SHEET_PATH *aSheetPath, std::vector< PIN_INFO > &aPins, bool aKeepUnconnectedPins)
	Find all units for symbols with multiple symbols per package. More...

Protected Attributes
bool	m_resolveTextVars
UNIQUE_STRINGS	m_referencesAlreadyFound
	Used for "multiple symbols per package" symbols to avoid processing a lib symbol more than once. More...
std::set< LIB_SYMBOL *, LIB_SYMBOL_LESS_THAN >	m_libParts
	unique library symbols used. LIB_SYMBOL items are sorted by names More...
SCHEMATIC_IFACE *	m_schematic
	The schematic we're generating a netlist for. More...

Private Attributes
std::set< wxString >	m_libraries

Detailed Description

Generate a generic XML based netlist file.

This allows using XSLT or other methods to transform the XML to other netlist formats outside of the C++ codebase.

Definition at line 62 of file netlist_exporter_xml.h.

Constructor & Destructor Documentation

NETLIST_EXPORTER_XML()

NETLIST_EXPORTER_XML::NETLIST_EXPORTER_XML ( SCHEMATIC *  aSchematic )

inline

Definition at line 65 of file netlist_exporter_xml.h.

 :
 NETLIST_EXPORTER_BASE( aSchematic ),
 m_resolveTextVars( true )
 {}

Member Function Documentation

addSymbolFields()

void NETLIST_EXPORTER_XML::addSymbolFields ( XNODE *  aNode, SCH_SYMBOL *  aSymbol, SCH_SHEET_PATH *  aSheet  )

protected

Holder for multi-unit symbol fields.

Definition at line 93 of file netlist_exporter_xml.cpp.

{
 wxString value;
 wxString datasheet;
 wxString footprint;
 wxString candidate;
 std::map<wxString, wxString> userFields;
 
 if( aSymbol->GetUnitCount() > 1 )
 {
 // Sadly, each unit of a symbol can have its own unique fields. This
 // block finds the unit with the lowest number having a non blank field
 // value and records it. Therefore user is best off setting fields
 // into only the first unit. But this scavenger algorithm will find
 // any non blank fields in all units and use the first non-blank field
 // for each unique field name.
 
 wxString ref = aSymbol->GetRef( aSheet );
 
 SCH_SHEET_LIST sheetList = m_schematic->GetSheets();
 int minUnit = aSymbol->GetUnitSelection( aSheet );
 
 for( unsigned i = 0; i < sheetList.size(); i++ )
 {
 for( SCH_ITEM* item : sheetList[i].LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol2 = (SCH_SYMBOL*) item;
 
 wxString ref2 = symbol2->GetRef( &sheetList[i] );
 
 if( ref2.CmpNoCase( ref ) != 0 )
 continue;
 
 int unit = symbol2->GetUnitSelection( aSheet );
 
 // The lowest unit number wins. User should only set fields in any one unit.
 candidate = symbol2->GetValueFieldText( m_resolveTextVars );
 
 if( !candidate.IsEmpty() && ( unit < minUnit || value.IsEmpty() ) )
 value = candidate;
 
 candidate = symbol2->GetFootprintFieldText( m_resolveTextVars );
 
 if( !candidate.IsEmpty() && ( unit < minUnit || footprint.IsEmpty() ) )
 footprint = candidate;
 
 candidate = m_resolveTextVars ? symbol2->GetField( DATASHEET_FIELD )->GetShownText()
 : symbol2->GetField( DATASHEET_FIELD )->GetText();
 
 if( !candidate.IsEmpty() && ( unit < minUnit || datasheet.IsEmpty() ) )
 datasheet = candidate;
 
 for( int ii = MANDATORY_FIELDS; ii < symbol2->GetFieldCount(); ++ii )
 {
 const SCH_FIELD& f = symbol2->GetFields()[ ii ];
 
 if( f.GetText().size()
 && ( unit < minUnit || userFields.count( f.GetName() ) == 0 ) )
 {
 if( m_resolveTextVars )
 userFields[ f.GetName() ] = f.GetShownText();
 else
 userFields[ f.GetName() ] = f.GetText();
 }
 }
 
 minUnit = std::min( unit, minUnit );
 }
 }
 }
 else
 {
 value = aSymbol->GetValueFieldText( m_resolveTextVars );
 footprint = aSymbol->GetFootprintFieldText( m_resolveTextVars );
 
 if( m_resolveTextVars )
 datasheet = aSymbol->GetField( DATASHEET_FIELD )->GetShownText();
 else
 datasheet = aSymbol->GetField( DATASHEET_FIELD )->GetText();
 
 for( int ii = MANDATORY_FIELDS; ii < aSymbol->GetFieldCount(); ++ii )
 {
 const SCH_FIELD& f = aSymbol->GetFields()[ ii ];
 
 if( f.GetText().size() )
 {
 if( m_resolveTextVars )
 userFields[ f.GetName() ] = f.GetShownText();
 else
 userFields[ f.GetName() ] = f.GetText();
 }
 }
 }
 
 // Do not output field values blank in netlist:
 if( value.size() )
 aNode->AddChild( node( wxT( "value" ), UnescapeString( value ) ) );
 else // value field always written in netlist
 aNode->AddChild( node( wxT( "value" ), wxT( "~" ) ) );
 
 if( footprint.size() )
 aNode->AddChild( node( wxT( "footprint" ), UnescapeString( footprint ) ) );
 
 if( datasheet.size() )
 aNode->AddChild( node( wxT( "datasheet" ), UnescapeString( datasheet ) ) );
 
 if( userFields.size() )
 {
 XNODE* xfields;
 aNode->AddChild( xfields = node( wxT( "fields" ) ) );
 
 // non MANDATORY fields are output alphabetically
 for( const std::pair<const wxString, wxString>& f : userFields )
 {
 XNODE* xfield = node( wxT( "field" ), UnescapeString( f.second ) );
 xfield->AddAttribute( wxT( "name" ), UnescapeString( f.first ) );
 xfields->AddChild( xfield );
 }
 }
}

References datasheet, DATASHEET_FIELD, SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFieldCount(), SCH_SYMBOL::GetFields(), SCH_SYMBOL::GetFootprintFieldText(), SCH_FIELD::GetName(), SCH_SYMBOL::GetRef(), SCHEMATIC_IFACE::GetSheets(), SCH_FIELD::GetShownText(), EDA_TEXT::GetText(), SCH_SYMBOL::GetUnitCount(), SCH_SYMBOL::GetUnitSelection(), SCH_SYMBOL::GetValueFieldText(), m_resolveTextVars, NETLIST_EXPORTER_BASE::m_schematic, MANDATORY_FIELDS, node(), SCH_SYMBOL_T, and UnescapeString().

Referenced by makeSymbols().

CreatePinList()

std::vector< PIN_INFO > NETLIST_EXPORTER_BASE::CreatePinList ( SCH_SYMBOL *  aSymbol, SCH_SHEET_PATH *  aSheetPath, bool  aKeepUnconnectedPins  )

protectedinherited

Find a symbol from the DrawList and builds its pin list.

This list is sorted by pin number. The symbol is the next actual symbol after aSymbol. Power symbols and virtual symbols that have their reference designators starting with '#' are skipped. if aKeepUnconnectedPins = false, unconnected pins will be removed from list but usually we need all pins in netlists.

Definition at line 116 of file netlist_exporter_base.cpp.

{
 wxString ref( aSymbol->GetRef( aSheetPath ) );
 std::vector<PIN_INFO> pins;
 
 // Power symbols and other symbols which have the reference starting with "#" are not
 // included in netlist (pseudo or virtual symbols)
 
 if( ref[0] == wxChar( '#' ) )
 return pins;
 
 // if( aSymbol->m_FlagControlMulti == 1 )
 // continue; /* yes */
 // removed because with multiple instances of one schematic (several sheets pointing to
 // 1 screen), this will be erroneously be toggled.
 
 if( !aSymbol->GetLibSymbolRef() )
 return pins;
 
 // If symbol is a "multi parts per package" type
 if( aSymbol->GetLibSymbolRef()->GetUnitCount() > 1 )
 {
 // Collect all pins for this reference designator by searching the entire design for
 // other parts with the same reference designator.
 // This is only done once, it would be too expensive otherwise.
 findAllUnitsOfSymbol( aSymbol, aSheetPath, pins, aKeepUnconnectedPins );
 }
 
 else // GetUnitCount() <= 1 means one part per package
 {
 CONNECTION_GRAPH* graph = m_schematic->ConnectionGraph();
 
 for( const SCH_PIN* pin : aSymbol->GetPins( aSheetPath ) )
 {
 if( SCH_CONNECTION* conn = pin->Connection( aSheetPath ) )
 {
 const wxString& netName = conn->Name();
 
 if( !aKeepUnconnectedPins ) // Skip unconnected pins if requested
 {
 CONNECTION_SUBGRAPH* sg = graph->FindSubgraphByName( netName, *aSheetPath );
 
 if( !sg || sg->GetNoConnect() || sg->GetItems().size() < 2 )
 continue;
 }
 
 pins.emplace_back( pin->GetShownNumber(), netName );
 }
 }
 }
 
 // Sort pins in m_SortedSymbolPinList by pin number
 std::sort( pins.begin(), pins.end(),
 []( const PIN_INFO& lhs, const PIN_INFO& rhs )
 {
 return StrNumCmp( lhs.num, rhs.num, true ) < 0;
 } );
 
 // Remove duplicate Pins in m_SortedSymbolPinList
 eraseDuplicatePins( pins );
 
 // record the usage of this library symbol
 m_libParts.insert( aSymbol->GetLibSymbolRef().get() ); // rejects non-unique pointers
 
 return pins;
}

References SCHEMATIC_IFACE::ConnectionGraph(), NETLIST_EXPORTER_BASE::eraseDuplicatePins(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), CONNECTION_GRAPH::FindSubgraphByName(), CONNECTION_SUBGRAPH::GetItems(), SCH_SYMBOL::GetLibSymbolRef(), CONNECTION_SUBGRAPH::GetNoConnect(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRef(), NETLIST_EXPORTER_BASE::m_libParts, NETLIST_EXPORTER_BASE::m_schematic, and pin.

Referenced by NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

eraseDuplicatePins()

void NETLIST_EXPORTER_BASE::eraseDuplicatePins ( std::vector< PIN_INFO > &  pins )

protectedinherited

Erase duplicate pins.

(This is a list of pins found in the whole schematic, for a single symbol.) These duplicate pins were put in list because some pins (power pins...) are found more than once when in "multiple symbols per package" symbols. For instance, a 74ls00 has 4 symbols, and therefore the VCC pin and GND pin appears 4 times in the list. Note: this list MUST be sorted by pin number (.m_PinNum member value) Also set the m_Flag member of "removed" NETLIST_OBJECT pin item to 1

Definition at line 186 of file netlist_exporter_base.cpp.

{
 for( unsigned ii = 0; ii < aPins.size(); ii++ )
 {
 if( aPins[ii].num.empty() ) /* already deleted */
 continue;
 
 /* Search for duplicated pins
 * If found, remove duplicates. The priority is to keep connected pins
 * and remove unconnected
 * - So this allows (for instance when using multi op amps per package
 * - to connect only one op amp to power
 * Because the pin list is sorted by m_PinNum value, duplicated pins
 * are necessary successive in list
 */
 int idxref = ii;
 
 for( unsigned jj = ii + 1; jj < aPins.size(); jj++ )
 {
  if( aPins[jj].num.empty() ) // Already removed
 continue;
 
 // if other pin num, stop search,
 // because all pins having the same number are consecutive in list.
 if( aPins[idxref].num != aPins[jj].num )
 break;
 
 aPins[jj].num.clear();
 }
 }
}

Referenced by NETLIST_EXPORTER_BASE::CreatePinList().

findAllUnitsOfSymbol()

void NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol ( SCH_SYMBOL *  aSchSymbol, SCH_SHEET_PATH *  aSheetPath, std::vector< PIN_INFO > &  aPins, bool  aKeepUnconnectedPins  )

protectedinherited

Find all units for symbols with multiple symbols per package.

Search the entire design for all units of aSymbol based on matching reference designator, and for each unit, add all its pins to the sorted pin list. if aKeepUnconnectedPins = false, unconnected pins will be removed from list but usually we need all pins in netlists.

Definition at line 219 of file netlist_exporter_base.cpp.

{
 wxString ref = aSchSymbol->GetRef( aSheetPath );
 wxString ref2;
 
 SCH_SHEET_LIST sheetList = m_schematic->GetSheets();
 CONNECTION_GRAPH* graph = m_schematic->ConnectionGraph();
 
 for( unsigned i = 0; i < sheetList.size(); i++ )
 {
 SCH_SHEET_PATH& sheet = sheetList[i];
 
 for( SCH_ITEM* item : sheetList[i].LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* comp2 = static_cast<SCH_SYMBOL*>( item );
 
 ref2 = comp2->GetRef( &sheet );
 
 if( ref2.CmpNoCase( ref ) != 0 )
 continue;
 
 for( const SCH_PIN* pin : comp2->GetPins( &sheet ) )
 {
 if( SCH_CONNECTION* conn = pin->Connection( &sheet ) )
 {
 const wxString& netName = conn->Name();
 
 if( !aKeepUnconnectedPins ) // Skip unconnected pins if requested
 {
 CONNECTION_SUBGRAPH* sg = graph->FindSubgraphByName( netName, sheet );
 
 if( !sg || sg->GetNoConnect() || sg->GetItems().size() < 2 )
 continue;
 }
 
 aPins.emplace_back( pin->GetShownNumber(), netName );
 }
 }
 }
 }
}

References SCHEMATIC_IFACE::ConnectionGraph(), CONNECTION_GRAPH::FindSubgraphByName(), CONNECTION_SUBGRAPH::GetItems(), CONNECTION_SUBGRAPH::GetNoConnect(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRef(), SCHEMATIC_IFACE::GetSheets(), NETLIST_EXPORTER_BASE::m_schematic, pin, and SCH_SYMBOL_T.

Referenced by NETLIST_EXPORTER_BASE::CreatePinList().

findNextSymbol()

SCH_SYMBOL * NETLIST_EXPORTER_BASE::findNextSymbol ( EDA_ITEM *  aItem, SCH_SHEET_PATH *  aSheetPath  )

protectedinherited

Check if the given symbol should be processed for netlisting.

Prevent processing multi-unit symbols more than once, etc.

Parameters

aItem	is a symbol to check
aSheetPath	is the sheet to check the symbol for

Returns

the symbol if it should be processed, or nullptr

Definition at line 73 of file netlist_exporter_base.cpp.

{
 wxCHECK( aItem, nullptr );
 wxCHECK( aSheetPath, nullptr );
 
 wxString ref;
 
 if( aItem->Type() != SCH_SYMBOL_T )
 return nullptr;
 
 // found next symbol
 SCH_SYMBOL* symbol = (SCH_SYMBOL*) aItem;
 
 // Power symbols and other symbols which have the reference starting with "#" are not
 // included in netlist (pseudo or virtual symbols)
 ref = symbol->GetRef( aSheetPath );
 
 if( ref[0] == wxChar( '#' ) )
 return nullptr;
 
 SCH_SCREEN* screen = aSheetPath->LastScreen();
 
 wxCHECK( screen, nullptr );
 
 LIB_SYMBOL* libSymbol = screen->GetLibSymbols()[ symbol->GetSchSymbolLibraryName() ];
 
 wxCHECK( libSymbol, nullptr );
 
 // If symbol is a "multi parts per package" type
 if( libSymbol->GetUnitCount() > 1 )
 {
 // test if this reference has already been processed, and if so skip
 if( m_referencesAlreadyFound.Lookup( ref ) )
 return nullptr;
 }
 
 // record the usage of this library symbol entry.
 m_libParts.insert( libSymbol ); // rejects non-unique pointers
 
 return symbol;
}

References SCH_SCREEN::GetLibSymbols(), SCH_SYMBOL::GetRef(), SCH_SYMBOL::GetSchSymbolLibraryName(), LIB_SYMBOL::GetUnitCount(), SCH_SHEET_PATH::LastScreen(), UNIQUE_STRINGS::Lookup(), NETLIST_EXPORTER_BASE::m_libParts, NETLIST_EXPORTER_BASE::m_referencesAlreadyFound, SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by makeSymbols(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

MakeCommandLine()

wxString NETLIST_EXPORTER_BASE::MakeCommandLine ( const wxString &  aFormatString, const wxString &  aNetlistFile, const wxString &  aFinalFile, const wxString &  aProjectDirectory  )

staticinherited

Build up a string that describes a command line for executing a child process.

The input and output file names along with any options to the executable are all possibly in the returned string.

Parameters

aFormatString	holds: the name of the external program any options needed by that program formatting sequences, see below.
aNetlistFile	is the name of the input file for the external program, that is a intermediate netlist file in xml format.
aFinalFile	is the name of the output file that the user expects.
aProjectDirectory	is used for P replacement, it should omit the trailing '/'.

Supported formatting sequences and their meaning:

• B => base filename of selected output file, minus path and extension.
• I => complete filename and path of the temporary input file.
• O => complete filename and path of the user chosen output file.
• P => project directory, without name and without trailing '/'

Definition at line 37 of file netlist_exporter_base.cpp.

{
 // Expand format symbols in the command line:
 // %B => base filename of selected output file, minus path and extension.
 // %P => project directory name, without trailing '/' or '\'.
 // %I => full filename of the input file (the intermediate net file).
 // %O => complete filename and path (but without extension) of the user chosen output file.
 
 wxString ret = aFormatString;
 wxFileName in = aNetlistFile;
 wxFileName out = aFinalFile;
 wxString str_out = out.GetFullPath();
 
 ret.Replace( "%P", aProjectPath, true );
 ret.Replace( "%B", out.GetName(), true );
 ret.Replace( "%I", in.GetFullPath(), true );
 
#ifdef __WINDOWS__
 // A ugly hack to run xsltproc that has a serious bug on Window since a long time:
 // the filename given after -o option (output filename) cannot use '\' in filename
 // so replace if by '/' if possible (I mean if the filename does not start by "\\"
 // that is a filename on a Windows server)
 
 if( !str_out.StartsWith( "\\\\" ) )
 str_out.Replace( "\\", "/" );
#endif
 
 ret.Replace( "%O", str_out, true );
 
 return ret;
}

Referenced by SCH_EDIT_FRAME::WriteNetListFile().

makeDesignHeader()

XNODE * NETLIST_EXPORTER_XML::makeDesignHeader ( )

protected

Fill out a project "design" header into an XML node.

Returns

the design header

Definition at line 406 of file netlist_exporter_xml.cpp.

{
 SCH_SCREEN* screen;
 XNODE* xdesign = node( wxT( "design" ) );
 XNODE* xtitleBlock;
 XNODE* xsheet;
 XNODE* xcomment;
 XNODE* xtextvar;
 wxString sheetTxt;
 wxFileName sourceFileName;
 
 // the root sheet is a special sheet, call it source
 xdesign->AddChild( node( wxT( "source" ), m_schematic->GetFileName() ) );
 
 xdesign->AddChild( node( wxT( "date" ), DateAndTime() ) );
 
 // which Eeschema tool
 xdesign->AddChild( node( wxT( "tool" ), wxT( "Eeschema " ) + GetBuildVersion() ) );
 
 const std::map<wxString, wxString>& properties = m_schematic->Prj().GetTextVars();
 
 for( const std::pair<const wxString, wxString>& prop : properties )
 {
 xdesign->AddChild( xtextvar = node( wxT( "textvar" ), prop.second ) );
 xtextvar->AddAttribute( wxT( "name" ), prop.first );
 }
 
 /*
 * Export the sheets information
 */
 SCH_SHEET_LIST sheetList = m_schematic->GetSheets();
 
 for( unsigned i = 0; i < sheetList.size(); i++ )
 {
 screen = sheetList[i].LastScreen();
 
 xdesign->AddChild( xsheet = node( wxT( "sheet" ) ) );
 
 // get the string representation of the sheet index number.
 // Note that sheet->GetIndex() is zero index base and we need to increment the
 // number by one to make it human readable
 sheetTxt.Printf( wxT( "%u" ), i + 1 );
 xsheet->AddAttribute( wxT( "number" ), sheetTxt );
 xsheet->AddAttribute( wxT( "name" ), sheetList[i].PathHumanReadable() );
 xsheet->AddAttribute( wxT( "tstamps" ), sheetList[i].PathAsString() );
 
 TITLE_BLOCK tb = screen->GetTitleBlock();
 PROJECT* prj = &m_schematic->Prj();
 
 xsheet->AddChild( xtitleBlock = node( wxT( "title_block" ) ) );
 
 xtitleBlock->AddChild( node( wxT( "title" ), ExpandTextVars( tb.GetTitle(), prj ) ) );
 xtitleBlock->AddChild( node( wxT( "company" ), ExpandTextVars( tb.GetCompany(), prj ) ) );
 xtitleBlock->AddChild( node( wxT( "rev" ), ExpandTextVars( tb.GetRevision(), prj ) ) );
 xtitleBlock->AddChild( node( wxT( "date" ), ExpandTextVars( tb.GetDate(), prj ) ) );
 
 // We are going to remove the fileName directories.
 sourceFileName = wxFileName( screen->GetFileName() );
 xtitleBlock->AddChild( node( wxT( "source" ), sourceFileName.GetFullName() ) );
 
 xtitleBlock->AddChild( xcomment = node( wxT( "comment" ) ) );
 xcomment->AddAttribute( wxT( "number" ), wxT( "1" ) );
 xcomment->AddAttribute( wxT( "value" ), ExpandTextVars( tb.GetComment( 0 ), prj ) );
 
 xtitleBlock->AddChild( xcomment = node( wxT( "comment" ) ) );
 xcomment->AddAttribute( wxT( "number" ), wxT( "2" ) );
 xcomment->AddAttribute( wxT( "value" ), ExpandTextVars( tb.GetComment( 1 ), prj ) );
 
  xtitleBlock->AddChild( xcomment = node( wxT( "comment" ) ) );
 xcomment->AddAttribute( wxT( "number" ), wxT( "3" ) );
 xcomment->AddAttribute( wxT( "value" ), ExpandTextVars( tb.GetComment( 2 ), prj ) );
 
 xtitleBlock->AddChild( xcomment = node( wxT( "comment" ) ) );
 xcomment->AddAttribute( wxT( "number" ), wxT( "4" ) );
 xcomment->AddAttribute( wxT( "value" ), ExpandTextVars( tb.GetComment( 3 ), prj ) );
 
 xtitleBlock->AddChild( xcomment = node( wxT( "comment" ) ) );
 xcomment->AddAttribute( wxT( "number" ), wxT( "5" ) );
 xcomment->AddAttribute( wxT( "value" ), ExpandTextVars( tb.GetComment( 4 ), prj ) );
 
 xtitleBlock->AddChild( xcomment = node( wxT( "comment" ) ) );
 xcomment->AddAttribute( wxT( "number" ), wxT( "6" ) );
 xcomment->AddAttribute( wxT( "value" ), ExpandTextVars( tb.GetComment( 5 ), prj ) );
 
 xtitleBlock->AddChild( xcomment = node( wxT( "comment" ) ) );
 xcomment->AddAttribute( wxT( "number" ), wxT( "7" ) );
 xcomment->AddAttribute( wxT( "value" ), ExpandTextVars( tb.GetComment( 6 ), prj ) );
 
 xtitleBlock->AddChild( xcomment = node( wxT( "comment" ) ) );
 xcomment->AddAttribute( wxT( "number" ), wxT( "8" ) );
 xcomment->AddAttribute( wxT( "value" ), ExpandTextVars( tb.GetComment( 7 ), prj ) );
 
 xtitleBlock->AddChild( xcomment = node( wxT( "comment" ) ) );
 xcomment->AddAttribute( wxT( "number" ), wxT( "9" ) );
 xcomment->AddAttribute( wxT( "value" ), ExpandTextVars( tb.GetComment( 8 ), prj ) );
 }
 
 return xdesign;
}

References DateAndTime(), ExpandTextVars(), GetBuildVersion(), TITLE_BLOCK::GetComment(), TITLE_BLOCK::GetCompany(), TITLE_BLOCK::GetDate(), SCH_SCREEN::GetFileName(), SCHEMATIC_IFACE::GetFileName(), TITLE_BLOCK::GetRevision(), SCHEMATIC_IFACE::GetSheets(), PROJECT::GetTextVars(), TITLE_BLOCK::GetTitle(), SCH_SCREEN::GetTitleBlock(), NETLIST_EXPORTER_BASE::m_schematic, node(), and SCHEMATIC_IFACE::Prj().

Referenced by makeRoot().

makeLibParts()

XNODE * NETLIST_EXPORTER_XML::makeLibParts ( )

protected

Fill out an XML node with the unique library parts and returns it.

Returns

the library parts nodes

Definition at line 531 of file netlist_exporter_xml.cpp.

{
 XNODE* xlibparts = node( wxT( "libparts" ) ); // auto_ptr
 
 LIB_PINS pinList;
 std::vector<LIB_FIELD*> fieldList;
 
 m_libraries.clear();
 
 for( LIB_SYMBOL* lcomp : m_libParts )
 {
 wxString libNickname = lcomp->GetLibId().GetLibNickname();;
 
 // The library nickname will be empty if the cache library is used.
 if( !libNickname.IsEmpty() )
 m_libraries.insert( libNickname ); // inserts symbol's library if unique
 
 XNODE* xlibpart;
 xlibparts->AddChild( xlibpart = node( wxT( "libpart" ) ) );
 xlibpart->AddAttribute( wxT( "lib" ), libNickname );
 xlibpart->AddAttribute( wxT( "part" ), lcomp->GetName() );
 
 //----- show the important properties -------------------------
 if( !lcomp->GetDescription().IsEmpty() )
 xlibpart->AddChild( node( wxT( "description" ), lcomp->GetDescription() ) );
 
 if( !lcomp->GetDatasheetField().GetText().IsEmpty() )
 xlibpart->AddChild( node( wxT( "docs" ), lcomp->GetDatasheetField().GetText() ) );
 
 // Write the footprint list
 if( lcomp->GetFPFilters().GetCount() )
 {
 XNODE* xfootprints;
 xlibpart->AddChild( xfootprints = node( wxT( "footprints" ) ) );
 
 for( unsigned i = 0; i < lcomp->GetFPFilters().GetCount(); ++i )
 xfootprints->AddChild( node( wxT( "fp" ), lcomp->GetFPFilters()[i] ) );
 }
 
 //----- show the fields here ----------------------------------
 fieldList.clear();
 lcomp->GetFields( fieldList );
 
 XNODE* xfields;
 xlibpart->AddChild( xfields = node( "fields" ) );
 
 for( const LIB_FIELD* field : fieldList )
 {
 if( !field->GetText().IsEmpty() )
 {
 XNODE* xfield;
 xfields->AddChild( xfield = node( wxT( "field" ), field->GetText() ) );
 xfield->AddAttribute( wxT( "name" ), field->GetCanonicalName() );
 }
 }
 
 //----- show the pins here ------------------------------------
 pinList.clear();
 lcomp->GetPins( pinList, 0, 0 );
 
 /*
 * We must erase redundant Pins references in pinList
 * These redundant pins exist because some pins are found more than one time when a
 * symbol has multiple parts per package or has 2 representations (DeMorgan conversion).
 * For instance, a 74ls00 has DeMorgan conversion, with different pin shapes, and
 * therefore each pin appears 2 times in the list. Common pins (VCC, GND) can also be
 * found more than once.
 */
 sort( pinList.begin(), pinList.end(), sortPinsByNumber );
 for( int ii = 0; ii < (int)pinList.size()-1; ii++ )
 {
 if( pinList[ii]->GetNumber() == pinList[ii+1]->GetNumber() )
 { // 2 pins have the same number, remove the redundant pin at index i+1
 pinList.erase(pinList.begin() + ii + 1);
 ii--;
 }
 }
 
 if( pinList.size() )
 {
 XNODE* pins;
 
 xlibpart->AddChild( pins = node( wxT( "pins" ) ) );
 for( unsigned i=0; i<pinList.size(); ++i )
 {
 XNODE* pin;
 
 pins->AddChild( pin = node( wxT( "pin" ) ) );
 pin->AddAttribute( wxT( "num" ), pinList[i]->GetShownNumber() );
 pin->AddAttribute( wxT( "name" ), pinList[i]->GetShownName() );
 pin->AddAttribute( wxT( "type" ), pinList[i]->GetCanonicalElectricalTypeName() );
 
 // caution: construction work site here, drive slowly
 }
 }
 }
 
 return xlibparts;
}

References NETLIST_EXPORTER_BASE::m_libParts, m_libraries, node(), pin, and sortPinsByNumber().

Referenced by makeRoot().

makeLibraries()

XNODE * NETLIST_EXPORTER_XML::makeLibraries ( )

protected

Fill out an XML node with a list of used libraries and returns it.

Must have called makeGenericLibParts() before this function.

Returns

the library nodes

Definition at line 507 of file netlist_exporter_xml.cpp.

{
 XNODE* xlibs = node( wxT( "libraries" ) ); // auto_ptr
 SYMBOL_LIB_TABLE* symbolLibTable = m_schematic->Prj().SchSymbolLibTable();
 
 for( std::set<wxString>::iterator it = m_libraries.begin(); it!=m_libraries.end(); ++it )
 {
 wxString libNickname = *it;
 XNODE* xlibrary;
 
 if( symbolLibTable->HasLibrary( libNickname ) )
 {
 xlibs->AddChild( xlibrary = node( wxT( "library" ) ) );
 xlibrary->AddAttribute( wxT( "logical" ), libNickname );
 xlibrary->AddChild( node( wxT( "uri" ), symbolLibTable->GetFullURI( libNickname ) ) );
 }
 
 // @todo: add more fun stuff here
 }
 
 return xlibs;
}

References LIB_TABLE::GetFullURI(), LIB_TABLE::HasLibrary(), m_libraries, NETLIST_EXPORTER_BASE::m_schematic, node(), and SCHEMATIC_IFACE::Prj().

Referenced by makeRoot().

makeListOfNets()

XNODE * NETLIST_EXPORTER_XML::makeListOfNets ( unsigned  aCtl )

protected

Fill out an XML node with a list of nets and returns it.

Returns

the list of nets nodes

Definition at line 632 of file netlist_exporter_xml.cpp.

{
 XNODE* xnets = node( wxT( "nets" ) ); // auto_ptr if exceptions ever get used.
 wxString netCodeTxt;
 wxString netName;
 wxString ref;
 
 XNODE* xnet = nullptr;
 
 /* output:
 <net code="123" name="/cfcard.sch/WAIT#">
 <node ref="R23" pin="1"/>
 <node ref="U18" pin="12"/>
 </net>
 */
 
 struct NET_NODE
 {
 NET_NODE( SCH_PIN* aPin, const SCH_SHEET_PATH& aSheet ) : m_Pin( aPin ), m_Sheet( aSheet )
 {}
 
 SCH_PIN* m_Pin;
 SCH_SHEET_PATH m_Sheet;
 };
 
 struct NET_RECORD
 {
 NET_RECORD( const wxString& aName ) : m_Name( aName ), m_HasNoConnect( false ){};
 
 wxString m_Name;
 bool m_HasNoConnect;
 std::vector<NET_NODE> m_Nodes;
 };
 
 std::vector<NET_RECORD*> nets;
 
 for( const auto& [ key, subgraphs ] : m_schematic->ConnectionGraph()->GetNetMap() )
 {
 wxString net_name = key.Name;
 NET_RECORD* net_record = nullptr;
 
 if( subgraphs.empty() )
 continue;
 
 nets.emplace_back( new NET_RECORD( net_name ) );
 net_record = nets.back();
 
 for( CONNECTION_SUBGRAPH* subgraph : subgraphs )
 {
 bool nc = subgraph->GetNoConnect() && subgraph->GetNoConnect()->Type() == SCH_NO_CONNECT_T;
 const SCH_SHEET_PATH& sheet = subgraph->GetSheet();
 
 if( nc )
 net_record->m_HasNoConnect = true;
 
 for( SCH_ITEM* item : subgraph->GetItems() )
 {
 if( item->Type() == SCH_PIN_T )
 {
 SCH_PIN* pin = static_cast<SCH_PIN*>( item );
 SCH_SYMBOL* symbol = pin->GetParentSymbol();
 
 if( !symbol
 || ( ( aCtl & GNL_OPT_BOM ) && !symbol->GetIncludeInBom() )
 || ( ( aCtl & GNL_OPT_KICAD ) && !symbol->GetIncludeOnBoard() ) )
 {
 continue;
 }
 
 net_record->m_Nodes.emplace_back( pin, sheet );
 }
 }
 }
 }
 
 // Netlist ordering: Net name, then ref des, then pin name
 std::sort( nets.begin(), nets.end(),
 []( const NET_RECORD* a, const NET_RECORD*b )
 {
 return StrNumCmp( a->m_Name, b->m_Name ) < 0;
 } );
 
 for( int i = 0; i < (int) nets.size(); ++i )
 {
 NET_RECORD* net_record = nets[i];
 bool added = false;
 XNODE* xnode;
 
 // Netlist ordering: Net name, then ref des, then pin name
 std::sort( net_record->m_Nodes.begin(), net_record->m_Nodes.end(),
 []( const NET_NODE& a, const NET_NODE& b )
 {
 wxString refA = a.m_Pin->GetParentSymbol()->GetRef( &a.m_Sheet );
 wxString refB = b.m_Pin->GetParentSymbol()->GetRef( &b.m_Sheet );
 
 if( refA == refB )
 return a.m_Pin->GetShownNumber() < b.m_Pin->GetShownNumber();
 
 return refA < refB;
 } );
 
 // Some duplicates can exist, for example on multi-unit parts with duplicated pins across
 // units. If the user connects the pins on each unit, they will appear on separate
 // subgraphs. Remove those here:
 alg::remove_duplicates( net_record->m_Nodes,
 []( const NET_NODE& a, const NET_NODE& b )
 {
 wxString refA = a.m_Pin->GetParentSymbol()->GetRef( &a.m_Sheet );
 wxString refB = b.m_Pin->GetParentSymbol()->GetRef( &b.m_Sheet );
 
 return refA == refB && a.m_Pin->GetShownNumber() == b.m_Pin->GetShownNumber();
 } );
 
 // Determine if all pins in the net are stacked (nets with only one pin are implicitly
 // taken to be stacked)
 bool allNetPinsStacked = true;
 
 if( net_record->m_Nodes.size() > 1 )
 {
 SCH_PIN* firstPin = net_record->m_Nodes.begin()->m_Pin;
 allNetPinsStacked =
 std::all_of( net_record->m_Nodes.begin() + 1, net_record->m_Nodes.end(),
 [=]( auto& node )
 {
 return firstPin->GetParent() == node.m_Pin->GetParent()
 && firstPin->GetPosition() == node.m_Pin->GetPosition()
 && firstPin->GetName() == node.m_Pin->GetName();
 } );
 }
 
 for( const NET_NODE& netNode : net_record->m_Nodes )
 {
 wxString refText = netNode.m_Pin->GetParentSymbol()->GetRef( &netNode.m_Sheet );
 wxString pinText = netNode.m_Pin->GetShownNumber();
 
 // Skip power symbols and virtual symbols
 if( refText[0] == wxChar( '#' ) )
 continue;
 
 if( !added )
 {
 netCodeTxt.Printf( wxT( "%d" ), i + 1 );
 
 xnets->AddChild( xnet = node( wxT( "net" ) ) );
 xnet->AddAttribute( wxT( "code" ), netCodeTxt );
 xnet->AddAttribute( wxT( "name" ), net_record->m_Name );
 
 added = true;
 }
 
 xnet->AddChild( xnode = node( wxT( "node" ) ) );
 xnode->AddAttribute( wxT( "ref" ), refText );
 xnode->AddAttribute( wxT( "pin" ), pinText );
 
 wxString pinName = netNode.m_Pin->GetShownName();
 wxString pinType = netNode.m_Pin->GetCanonicalElectricalTypeName();
 
 if( !pinName.IsEmpty() )
 xnode->AddAttribute( wxT( "pinfunction" ), pinName );
 
 if( net_record->m_HasNoConnect
 && ( net_record->m_Nodes.size() == 1 || allNetPinsStacked ) )
 pinType += wxT( "+no_connect" );
 
 xnode->AddAttribute( wxT( "pintype" ), pinType );
 }
 }
 
 for( NET_RECORD* record : nets )
 delete record;
 
 return xnets;
}

References SCHEMATIC_IFACE::ConnectionGraph(), SCH_SYMBOL::GetIncludeInBom(), SCH_SYMBOL::GetIncludeOnBoard(), CONNECTION_GRAPH::GetNetMap(), SCH_SHEET_PATH::GetSheet(), GNL_OPT_BOM, GNL_OPT_KICAD, NETLIST_EXPORTER_BASE::m_schematic, node(), pin, alg::remove_duplicates(), SCH_NO_CONNECT_T, and SCH_PIN_T.

Referenced by makeRoot().

makeRoot()

XNODE * NETLIST_EXPORTER_XML::makeRoot ( unsigned  aCtl = GNL_ALL )

protected

Build the entire document tree for the generic export.

This is factored out here so we can write the tree in either S-expression file format or in XML if we put the tree built here into a wxXmlDocument.

Parameters

aCtl	a bitset or-ed together from GNL_ENUM values

Returns

the root nodes

Definition at line 63 of file netlist_exporter_xml.cpp.

{
 XNODE* xroot = node( wxT( "export" ) );
 
 xroot->AddAttribute( wxT( "version" ), wxT( "E" ) );
 
 if( aCtl & GNL_HEADER )
 // add the "design" header
 xroot->AddChild( makeDesignHeader() );
 
 if( aCtl & GNL_SYMBOLS )
 xroot->AddChild( makeSymbols( aCtl ) );
 
 if( aCtl & GNL_PARTS )
 xroot->AddChild( makeLibParts() );
 
 if( aCtl & GNL_LIBRARIES )
 // must follow makeGenericLibParts()
 xroot->AddChild( makeLibraries() );
 
 if( aCtl & GNL_NETS )
 xroot->AddChild( makeListOfNets( aCtl ) );
 
 return xroot;
}

References GNL_HEADER, GNL_LIBRARIES, GNL_NETS, GNL_PARTS, GNL_SYMBOLS, makeDesignHeader(), makeLibParts(), makeLibraries(), makeListOfNets(), makeSymbols(), and node().

Referenced by NETLIST_EXPORTER_KICAD::Format(), and WriteNetlist().

makeSymbols()

XNODE * NETLIST_EXPORTER_XML::makeSymbols ( unsigned  aCtl )

protected

Returns

a sub-tree holding all the schematic symbols.

Definition at line 216 of file netlist_exporter_xml.cpp.

{
 XNODE* xcomps = node( wxT( "components" ) );
 
 m_referencesAlreadyFound.Clear();
 m_libParts.clear();
 
 SCH_SHEET_LIST sheetList = m_schematic->GetSheets();
 
 // Output is xml, so there is no reason to remove spaces from the field values.
 // And XML element names need not be translated to various languages.
 
 for( unsigned ii = 0; ii < sheetList.size(); ii++ )
 {
 SCH_SHEET_PATH sheet = sheetList[ii];
 
 auto cmp = [sheet]( SCH_SYMBOL* a, SCH_SYMBOL* b )
 {
 return ( StrNumCmp( a->GetRef( &sheet, false ),
 b->GetRef( &sheet, false ), true ) < 0 );
 };
 
 std::set<SCH_SYMBOL*, decltype( cmp )> ordered_symbols( cmp );
 std::multiset<SCH_SYMBOL*, decltype( cmp )> extra_units( cmp );
 
 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
 auto test = ordered_symbols.insert( symbol );
 
 if( !test.second )
 {
 if( ( *( test.first ) )->m_Uuid > symbol->m_Uuid )
 {
 extra_units.insert( *( test.first ) );
 ordered_symbols.erase( test.first );
 ordered_symbols.insert( symbol );
 }
 else
 {
 extra_units.insert( symbol );
 }
 }
 }
 
 for( EDA_ITEM* item : ordered_symbols )
 {
 SCH_SYMBOL* symbol = findNextSymbol( item, &sheet );
 
 if( !symbol
 || ( ( aCtl & GNL_OPT_BOM ) && !symbol->GetIncludeInBom() )
 || ( ( aCtl & GNL_OPT_KICAD ) && !symbol->GetIncludeOnBoard() ) )
 {
 continue;
 }
 
 // Output the symbol's elements in order of expected access frequency. This may
 // not always look best, but it will allow faster execution under XSL processing
 // systems which do sequential searching within an element.
 
 XNODE* xcomp; // current symbol being constructed
 xcomps->AddChild( xcomp = node( wxT( "comp" ) ) );
 
 xcomp->AddAttribute( wxT( "ref" ), symbol->GetRef( &sheet ) );
 addSymbolFields( xcomp, symbol, &sheet );
 
 XNODE* xlibsource;
 xcomp->AddChild( xlibsource = node( wxT( "libsource" ) ) );
 
 // "logical" library name, which is in anticipation of a better search algorithm
  // for parts based on "logical_lib.part" and where logical_lib is merely the library
 // name minus path and extension.
 wxString libName;
 wxString partName;
 
 if( symbol->UseLibIdLookup() )
 {
 libName = symbol->GetLibId().GetLibNickname();
 partName = symbol->GetLibId().GetLibItemName();
 }
 else
 {
 partName = symbol->GetSchSymbolLibraryName();
 }
 
 xlibsource->AddAttribute( wxT( "lib" ), libName );
 
 // We only want the symbol name, not the full LIB_ID.
 xlibsource->AddAttribute( wxT( "part" ), partName );
 
 xlibsource->AddAttribute( wxT( "description" ), symbol->GetDescription() );
 
 XNODE* xproperty;
 
 std::vector<SCH_FIELD>& fields = symbol->GetFields();
 
 for( size_t jj = MANDATORY_FIELDS; jj < fields.size(); ++jj )
 {
 xcomp->AddChild( xproperty = node( wxT( "property" ) ) );
 xproperty->AddAttribute( wxT( "name" ), fields[jj].GetCanonicalName() );
 
 if( m_resolveTextVars )
 xproperty->AddAttribute( wxT( "value" ), fields[jj].GetShownText() );
 else
 xproperty->AddAttribute( wxT( "value" ), fields[jj].GetText() );
 }
 
 for( const SCH_FIELD& sheetField : sheet.Last()->GetFields() )
 {
 xcomp->AddChild( xproperty = node( wxT( "property" ) ) );
 xproperty->AddAttribute( wxT( "name" ), sheetField.GetCanonicalName() );
 
 if( m_resolveTextVars )
 // do not allow GetShownText() to add any prefix useful only when displaying
 // the field on screen
 xproperty->AddAttribute( wxT( "value" ), sheetField.GetShownText( 0, false ) );
 else
 xproperty->AddAttribute( wxT( "value" ), sheetField.GetText() );
 }
 
 if( !symbol->GetIncludeInBom() )
 {
 xcomp->AddChild( xproperty = node( wxT( "property" ) ) );
 xproperty->AddAttribute( wxT( "name" ), wxT( "exclude_from_bom" ) );
 }
 
 if( !symbol->GetIncludeOnBoard() )
 {
 xcomp->AddChild( xproperty = node( wxT( "property" ) ) );
 xproperty->AddAttribute( wxT( "name" ), wxT( "exclude_from_board" ) );
 }
 
 if( symbol->GetDNP() )
 {
 xcomp->AddChild( xproperty = node( wxT( "property" ) ) );
 xproperty->AddAttribute( wxT( "name" ), wxT( "dnp" ) );
 }
 
 if( const std::unique_ptr<LIB_SYMBOL>& part = symbol->GetLibSymbolRef() )
 {
 if( part->GetDescription().size() )
 {
 xcomp->AddChild( xproperty = node( wxT( "property" ) ) );
 xproperty->AddAttribute( wxT( "name" ), wxT( "ki_description" ) );
 xproperty->AddAttribute( wxT( "value" ), part->GetDescription() );
 }
 
 if( part->GetKeyWords().size() )
 {
 xcomp->AddChild( xproperty = node( wxT( "property" ) ) );
 xproperty->AddAttribute( wxT( "name" ), wxT( "ki_keywords" ) );
 xproperty->AddAttribute( wxT( "value" ), part->GetKeyWords() );
 }
 }
 
 XNODE* xsheetpath;
 xcomp->AddChild( xsheetpath = node( wxT( "sheetpath" ) ) );
 
 xsheetpath->AddAttribute( wxT( "names" ), sheet.PathHumanReadable() );
 xsheetpath->AddAttribute( wxT( "tstamps" ), sheet.PathAsString() );
 
 XNODE* xunits; // Node for extra units
 xcomp->AddChild( xunits = node( wxT( "tstamps" ) ) );
 
 auto range = extra_units.equal_range( symbol );
 wxString uuid;
 
 // Output a series of children with all UUIDs associated with the REFDES
 for( auto it = range.first; it != range.second; ++it )
 {
 uuid = ( *it )->m_Uuid.AsString();
 
 // Add a space between UUIDs, if not in KICAD mode (i.e.
 // using wxXmlDocument::Save()). KICAD MODE has its own XNODE::Format function.
 if( !( aCtl & GNL_OPT_KICAD ) ) // i.e. for .xml format
 uuid += ' ';
 
 xunits->AddChild( new XNODE( wxXML_TEXT_NODE, wxEmptyString, uuid ) );
 }
 
 // Output the primary UUID
 uuid = symbol->m_Uuid.AsString();
 xunits->AddChild( new XNODE( wxXML_TEXT_NODE, wxEmptyString, uuid ) );
 }
 }
 
 return xcomps;
}

References addSymbolFields(), KIID::AsString(), UNIQUE_STRINGS::Clear(), NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_SYMBOL::GetDescription(), SCH_SYMBOL::GetDNP(), SCH_SHEET::GetFields(), SCH_SYMBOL::GetFields(), SCH_SYMBOL::GetIncludeInBom(), SCH_SYMBOL::GetIncludeOnBoard(), SCH_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetRef(), SCH_SYMBOL::GetSchSymbolLibraryName(), SCHEMATIC_IFACE::GetSheets(), EDA_UNIT_UTILS::GetText(), GNL_OPT_BOM, GNL_OPT_KICAD, SCH_SCREEN::Items(), SCH_SHEET_PATH::Last(), SCH_SHEET_PATH::LastScreen(), NETLIST_EXPORTER_BASE::m_libParts, NETLIST_EXPORTER_BASE::m_referencesAlreadyFound, m_resolveTextVars, NETLIST_EXPORTER_BASE::m_schematic, EDA_ITEM::m_Uuid, MANDATORY_FIELDS, node(), EE_RTREE::OfType(), SCH_SHEET_PATH::PathAsString(), SCH_SHEET_PATH::PathHumanReadable(), SCH_SYMBOL_T, StrNumCmp(), and SCH_SYMBOL::UseLibIdLookup().

Referenced by makeRoot().

node()

XNODE * NETLIST_EXPORTER_XML::node ( const wxString &  aName, const wxString &  aTextualContent = wxEmptyString  )

protected

A convenience function that creates a new XNODE with an optional textual child.

It also provides some insulation from a possible change in XML library.

Parameters

aName	is the name to associate with a new node of type wxXML_ELEMENT_NODE.
aTextualContent	is optional, and if given is the text to include in a child of the returned node, and has type wxXML_TEXT_NODE.

Definition at line 807 of file netlist_exporter_xml.cpp.

{
 XNODE* n = new XNODE( wxXML_ELEMENT_NODE, aName );
 
 if( aTextualContent.Len() > 0 ) // excludes wxEmptyString, the parameter's default value
 n->AddChild( new XNODE( wxXML_TEXT_NODE, wxEmptyString, aTextualContent ) );
 
 return n;
}

Referenced by addSymbolFields(), makeDesignHeader(), makeLibParts(), makeLibraries(), makeListOfNets(), makeRoot(), and makeSymbols().

WriteNetlist()

bool NETLIST_EXPORTER_XML::WriteNetlist ( const wxString &  aOutFileName, unsigned  aNetlistOptions, REPORTER &  aReporter  )

overridevirtual

Write generic netlist to aOutFileName.

Parameters

aOutFileName	is the file name to write.
aNetlistOptions	are the options used to control the netlist output.

Returns

true if the netlist was written successfully.

Reimplemented from NETLIST_EXPORTER_BASE.

Definition at line 44 of file netlist_exporter_xml.cpp.

{
 // output the XML format netlist.
 
 // declare the stream ourselves to use the buffered FILE api
 // instead of letting wx use the syscall variant
 wxFFileOutputStream stream( aOutFileName );
 
 if( !stream.IsOk() )
 return false;
 
 wxXmlDocument xdoc;
 xdoc.SetRoot( makeRoot( GNL_ALL | aNetlistOptions ) );
 
 return xdoc.Save( stream, 2 /* indent bug, today was ignored by wxXml lib */ );
}

References GNL_ALL, and makeRoot().

Member Data Documentation

m_libParts

std::set<LIB_SYMBOL*, LIB_SYMBOL_LESS_THAN> NETLIST_EXPORTER_BASE::m_libParts

protectedinherited

unique library symbols used. LIB_SYMBOL items are sorted by names

Definition at line 200 of file netlist_exporter_base.h.

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), NETLIST_EXPORTER_BASE::findNextSymbol(), makeLibParts(), makeSymbols(), and NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries().

m_libraries

std::set<wxString> NETLIST_EXPORTER_XML::m_libraries

private

Definition at line 138 of file netlist_exporter_xml.h.

Referenced by makeLibParts(), and makeLibraries().

m_referencesAlreadyFound

UNIQUE_STRINGS NETLIST_EXPORTER_BASE::m_referencesAlreadyFound

protectedinherited

Used for "multiple symbols per package" symbols to avoid processing a lib symbol more than once.

Definition at line 197 of file netlist_exporter_base.h.

Referenced by NETLIST_EXPORTER_BASE::findNextSymbol(), makeSymbols(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

m_resolveTextVars

bool NETLIST_EXPORTER_XML::m_resolveTextVars

protected

Definition at line 135 of file netlist_exporter_xml.h.

Referenced by addSymbolFields(), and makeSymbols().

m_schematic

SCHEMATIC_IFACE* NETLIST_EXPORTER_BASE::m_schematic

protectedinherited

The schematic we're generating a netlist for.

Definition at line 203 of file netlist_exporter_base.h.

Referenced by addSymbolFields(), NETLIST_EXPORTER_BASE::CreatePinList(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), NETLIST_EXPORTER_SPICE::GetSheets(), makeDesignHeader(), makeLibraries(), makeListOfNets(), makeSymbols(), NETLIST_EXPORTER_SPICE::readModel(), NETLIST_EXPORTER_SPICE_MODEL::WriteHead(), NETLIST_EXPORTER_SPICE::writeInclude(), NETLIST_EXPORTER_CADSTAR::writeListOfNets(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

---

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

• netlist_exporter_xml.h
• netlist_exporter_xml.cpp