/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 1992-2013 jp.charras at wanadoo.fr * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck * Copyright (C) 1992-2018 KiCad Developers * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ #ifndef NETLIST_EXPORTER_H #define NETLIST_EXPORTER_H #include #include #include #include #include #include #include /** * Class UNIQUE_STRINGS * tracks unique wxStrings and is useful in telling if a string * has been seen before. */ class UNIQUE_STRINGS { std::set m_set; ///< set of wxStrings already found typedef std::set::iterator us_iterator; public: /** * Function Clear * erases the record. */ void Clear() { m_set.clear(); } /** * Function Lookup * returns true if \a aString already exists in the set, otherwise returns * false and adds \a aString to the set for next time. */ bool Lookup( const wxString& aString ) { std::pair pair = m_set.insert( aString ); return !pair.second; } }; /** * Struct LIB_PART_LESS_THAN * is used by std:set instantiation which uses LIB_PART name as its key. */ struct LIB_PART_LESS_THAN { // a "less than" test on two LIB_PARTs (.m_name wxStrings) bool operator()( LIB_PART* const& libpart1, LIB_PART* const& libpart2 ) const { // Use case specific GetName() wxString compare return libpart1->GetLibId() < libpart2->GetLibId(); } }; /** * Class NETLIST_EXPORTER * is a abstract class used for the netlist exporters that eeschema supports. */ class NETLIST_EXPORTER { protected: NETLIST_OBJECT_LIST* m_masterList; /// yes ownership, connected items flat list /// Used to temporarily store and filter the list of pins of a schematic component /// when generating schematic component data in netlist (comp section). No ownership /// of members. NETLIST_OBJECTS m_SortedComponentPinList; /// Used for "multi parts per package" components, /// avoids processing a lib component more than once. UNIQUE_STRINGS m_ReferencesAlreadyFound; /// unique library parts used. LIB_PART items are sorted by names std::set m_LibParts; /** * Function sprintPinNetName * formats the net name for \a aPin using \a aNetNameFormat into \a aResult. *

* Net name is: *

    *
  • "?" if pin not connected *
  • "netname" for global net (like gnd, vcc .. *
  • "/path/netname" for the usual nets *
* if aUseNetcodeAsNetName is true, the net name is just the net code (SPICE only) */ static void sprintPinNetName( wxString& aResult, const wxString& aNetNameFormat, NETLIST_OBJECT* aPin, bool aUseNetcodeAsNetName = false ); /** * Function findNextComponentAndCreatePinList * finds a component from the DrawList and builds * its pin list in m_SortedComponentPinList. This list is sorted by pin num. * the component is the next actual component after aItem * (power symbols and virtual components that have their reference starting by '#'are skipped). */ SCH_COMPONENT* findNextComponentAndCreatePinList( EDA_ITEM* aItem, SCH_SHEET_PATH* aSheetPath ); SCH_COMPONENT* findNextComponent( EDA_ITEM* aItem, SCH_SHEET_PATH* aSheetPath ); /** * Function eraseDuplicatePins * erase duplicate Pins from m_SortedComponentPinList (i.e. set pointer in this list to NULL). * (This is a list of pins found in the whole schematic, for a single * component.) These duplicate pins were put in list because some pins (powers... ) * are found more than one time when we have a multiple parts per package * component. For instance, a 74ls00 has 4 parts, 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 */ void eraseDuplicatePins(); /** * Function addPinToComponentPinList * adds a new pin description to the pin list m_SortedComponentPinList. * A pin description is a pointer to the corresponding structure * created by BuildNetList() in the table g_NetObjectslist. */ bool addPinToComponentPinList( SCH_COMPONENT* Component, SCH_SHEET_PATH* sheet, LIB_PIN* PinEntry ); /** * Function findAllUnitsOfComponent * is used for "multiple parts per package" components. *

* Search the entire design for all units of \a aComponent based on * matching reference designator, and for each unit, add all its pins * to the temporary sorted pin list, m_SortedComponentPinList. */ void findAllUnitsOfComponent( SCH_COMPONENT* aComponent, LIB_PART* aEntry, SCH_SHEET_PATH* aSheetPath ); public: /** * Constructor * @param aMasterList we take ownership of this here. * @param aLibTable is the symbol library table of the project. */ NETLIST_EXPORTER( NETLIST_OBJECT_LIST* aMasterList ) : m_masterList( aMasterList ) { wxASSERT( aMasterList ); } virtual ~NETLIST_EXPORTER() { delete m_masterList; // I own the list itself in this instance. } /** * Function WriteNetlist * writes to specified output file */ virtual bool WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions ) { return false; } /** * Function MakeCommandLine * builds 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. * * @param aFormatString holds: *

    *
  • the name of the external program *
  • any options needed by that program *
  • formatting sequences, see below. *
* * @param aNetlistFile is the name of the input file for the * external program, that is a intermediate netlist file in xml format. * @param aFinalFile is the name of the output file that * the user expects. * @param 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 '/' *
*/ static wxString MakeCommandLine( const wxString& aFormatString, const wxString& aNetlistFile, const wxString& aFinalFile, const wxString& aProjectDirectory ); }; #endif