KiCad PCB EDA Suite
netlist_exporter_generic.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 1992-2013 jp.charras at wanadoo.fr
5  * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 1992-2018 KiCad Developers
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #ifndef NETLIST_EXPORT_GENERIC_H
27 #define NETLIST_EXPORT_GENERIC_H
28 
29 #include <netlist_exporter.h>
30 
31 #include <project.h>
32 #include <xnode.h> // also nests: <wx/xml/xml.h>
33 
34 #include <sch_edit_frame.h>
35 
36 class CONNECTION_GRAPH;
37 class SYMBOL_LIB_TABLE;
38 
39 #define GENERIC_INTERMEDIATE_NETLIST_EXT wxT( "xml" )
40 
45 enum GNL_T
46 {
47  GNL_LIBRARIES = 1 << 0,
48  GNL_COMPONENTS = 1 << 1,
49  GNL_PARTS = 1 << 2,
50  GNL_HEADER = 1 << 3,
51  GNL_NETS = 1 << 4,
52 };
53 
54 
61 {
62 private:
63  std::set< wxString > m_libraries;
64 
66 
67 protected:
69 
70 public:
72  NETLIST_OBJECT_LIST* aMasterList,
73  CONNECTION_GRAPH* aGraph = nullptr ) :
74  NETLIST_EXPORTER( aMasterList ),
75  m_libTable( aFrame->Prj().SchSymbolLibTable() ),
76  m_graph( aGraph )
77  {}
78 
83  bool WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions ) override;
84 
85 #define GNL_ALL ( GNL_LIBRARIES | GNL_COMPONENTS | GNL_PARTS | GNL_HEADER | GNL_NETS )
86 
87 protected:
97  XNODE* node( const wxString& aName, const wxString& aTextualContent = wxEmptyString );
98 
107  XNODE* makeRoot( int aCtl = GNL_ALL );
108 
114 
121 
127  XNODE* makeLibParts();
128 
134  XNODE* makeListOfNets( bool aUseGraph = true );
135 
142  XNODE* makeLibraries();
143 
144  void addComponentFields( XNODE* xcomp, SCH_COMPONENT* comp, SCH_SHEET_PATH* aSheet );
145 };
146 
147 #endif
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions) override
Function WriteNetlist writes to specified output file.
XNODE * makeComponents()
Function makeComponents.
XNODE * node(const wxString &aName, const wxString &aTextualContent=wxEmptyString)
Function node is a convenience function that creates a new XNODE with an optional textual child.
XNODE * makeListOfNets(bool aUseGraph=true)
Function makeListOfNets fills out an XML node with a list of nets and returns it.
Calculates the connectivity of a schematic and generates netlists.
PROJECT & Prj()
Definition: kicad.cpp:297
Schematic editor (Eeschema) main window.
Class NETLIST_OBJECT_LIST is a container holding and owning NETLIST_OBJECTs, which are connected item...
XNODE * makeRoot(int aCtl=GNL_ALL)
Function makeGenericRoot builds the entire document tree for the generic export.
std::set< wxString > m_libraries
Set of library nicknames.
Class NETLIST_EXPORTER is a abstract class used for the netlist exporters that eeschema supports.
NETLIST_EXPORTER_GENERIC(SCH_EDIT_FRAME *aFrame, NETLIST_OBJECT_LIST *aMasterList, CONNECTION_GRAPH *aGraph=nullptr)
GNL_T
Enum GNL is a set of bit which control the totality of the tree built by makeRoot()
void addComponentFields(XNODE *xcomp, SCH_COMPONENT *comp, SCH_SHEET_PATH *aSheet)
Class NETLIST_EXPORTER_GENERIC generates a generic XML based netlist file.
XNODE * makeDesignHeader()
Function makeDesignHeader fills out a project "design" header into an XML node.
Class SCH_SHEET_PATH.
Class XNODE holds an XML or S-expression element.
Definition: xnode.h:43
#define GNL_ALL
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
XNODE * makeLibraries()
Function makeLibraries fills out an XML node with a list of used libraries and returns it.
XNODE * makeLibParts()
Function makeLibParts fills out an XML node with the unique library parts and returns it.