KiCad PCB EDA Suite
netlist_exporter_cadstar.cpp
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-2018 jp.charras at wanadoo.fr
5 * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
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#include <build_version.h>
27#include <confirm.h>
28
29#include <connection_graph.h>
30#include <string_utils.h>
31#include <sch_edit_frame.h>
32#include <sch_reference_list.h>
33
35
36/* Generate CADSTAR net list. */
37static wxString StartLine( wxT( "." ) );
38
39bool NETLIST_EXPORTER_CADSTAR::WriteNetlist( const wxString& aOutFileName,
40 unsigned /* aNetlistOptions */,
41 REPORTER& aReporter )
42{
43 int ret = 0;
44 FILE* f = nullptr;
45
46 if( ( f = wxFopen( aOutFileName, wxT( "wt" ) ) ) == nullptr )
47 {
48 wxString msg = wxString::Format( _( "Failed to create file '%s'." ), aOutFileName );
49 aReporter.Report( msg, RPT_SEVERITY_ERROR );
50 return false;
51 }
52
53 wxString StartCmpDesc = StartLine + wxT( "ADD_COM" );
54 wxString msg;
55 wxString footprint;
56 SCH_SYMBOL* symbol;
57 wxString title = wxT( "Eeschema " ) + GetBuildVersion();
58
59 ret |= fprintf( f, "%sHEA\n", TO_UTF8( StartLine ) );
60 ret |= fprintf( f, "%sTIM %s\n", TO_UTF8( StartLine ), TO_UTF8( DateAndTime() ) );
61 ret |= fprintf( f, "%sAPP ", TO_UTF8( StartLine ) );
62 ret |= fprintf( f, "\"%s\"\n", TO_UTF8( title ) );
63 ret |= fprintf( f, ".TYP FULL\n\n" );
64
65 // Create netlist footprints section
67
69
70 for( unsigned i = 0; i < sheetList.size(); i++ )
71 {
72 for( SCH_ITEM* item : sheetList[i].LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
73 {
74 symbol = findNextSymbol( item, &sheetList[ i ] );
75
76 if( !symbol )
77 continue;
78
79 if( !symbol->GetIncludeOnBoard() )
80 continue;
81
82 footprint = symbol->GetFootprintFieldText( true );
83
84 if( footprint.IsEmpty() )
85 footprint = "$noname";
86
87 msg = symbol->GetRef( &sheetList[i] );
88 ret |= fprintf( f, "%s ", TO_UTF8( StartCmpDesc ) );
89 ret |= fprintf( f, "%s", TO_UTF8( msg ) );
90
91 msg = symbol->GetValueFieldText( true );
92 msg.Replace( wxT( " " ), wxT( "_" ) );
93 ret |= fprintf( f, " \"%s\"", TO_UTF8( msg ) );
94 ret |= fprintf( f, " \"%s\"", TO_UTF8( footprint ) );
95 ret |= fprintf( f, "\n" );
96 }
97 }
98
99 ret |= fprintf( f, "\n" );
100
101 if( ! writeListOfNets( f ) )
102 ret = -1; // set error
103
104 ret |= fprintf( f, "\n%sEND\n", TO_UTF8( StartLine ) );
105
106 fclose( f );
107
108 return ret >= 0;
109}
110
111
113{
114 int ret = 0;
115 int print_ter = 0;
116
117 wxString InitNetDesc = StartLine + wxT( "ADD_TER" );
118 wxString StartNetDesc = StartLine + wxT( "TER" );
119 wxString InitNetDescLine;
120 wxString netName;
121
122 for( const auto& [ key, subgraphs ] : m_schematic->ConnectionGraph()->GetNetMap() )
123 {
124 netName.Printf( wxT( "\"%s\"" ), key.Name );
125
126 std::vector<std::pair<SCH_PIN*, SCH_SHEET_PATH>> sorted_items;
127
128 for( CONNECTION_SUBGRAPH* subgraph : subgraphs )
129 {
130 SCH_SHEET_PATH sheet = subgraph->m_sheet;
131
132 for( SCH_ITEM* item : subgraph->m_items )
133 {
134 if( item->Type() == SCH_PIN_T )
135 sorted_items.emplace_back( static_cast<SCH_PIN*>( item ), sheet );
136 }
137 }
138
139 // Netlist ordering: Net name, then ref des, then pin name
140 std::sort( sorted_items.begin(), sorted_items.end(),
141 []( std::pair<SCH_PIN*, SCH_SHEET_PATH> a, std::pair<SCH_PIN*, SCH_SHEET_PATH> b )
142 {
143 wxString ref_a = a.first->GetParentSymbol()->GetRef( &a.second );
144 wxString ref_b = b.first->GetParentSymbol()->GetRef( &b.second );
145
146 if( ref_a == ref_b )
147 return a.first->GetShownNumber() < b.first->GetShownNumber();
148
149 return ref_a < ref_b;
150 } );
151
152 // Some duplicates can exist, for example on multi-unit parts with duplicated
153 // pins across units. If the user connects the pins on each unit, they will
154 // appear on separate subgraphs. Remove those here:
155 sorted_items.erase( std::unique( sorted_items.begin(), sorted_items.end(),
156 []( std::pair<SCH_PIN*, SCH_SHEET_PATH> a, std::pair<SCH_PIN*, SCH_SHEET_PATH> b )
157 {
158 wxString ref_a = a.first->GetParentSymbol()->GetRef( &a.second );
159 wxString ref_b = b.first->GetParentSymbol()->GetRef( &b.second );
160
161 return ref_a == ref_b && a.first->GetShownNumber() == b.first->GetShownNumber();
162 } ),
163 sorted_items.end() );
164
165 print_ter = 0;
166
167 for( const std::pair<SCH_PIN*, SCH_SHEET_PATH>& pair : sorted_items )
168 {
169 SCH_PIN* pin = pair.first;
170 SCH_SHEET_PATH sheet = pair.second;
171
172 wxString refText = pin->GetParentSymbol()->GetRef( &sheet );
173 wxString pinText = pin->GetShownNumber();
174
175 // Skip power symbols and virtual symbols
176 if( refText[0] == wxChar( '#' ) )
177 continue;
178
179 switch( print_ter )
180 {
181 case 0:
182 InitNetDescLine.Printf( wxT( "\n%s %s %.4s %s" ),
183 InitNetDesc,
184 refText,
185 pinText,
186 netName );
187 print_ter++;
188 break;
189
190 case 1:
191 ret |= fprintf( f, "%s\n", TO_UTF8( InitNetDescLine ) );
192 ret |= fprintf( f, "%s %s %.4s\n",
193 TO_UTF8( StartNetDesc ),
194 TO_UTF8( refText ),
195 TO_UTF8( pinText ) );
196 print_ter++;
197 break;
198
199 default:
200 ret |= fprintf( f, " %s %.4s\n",
201 TO_UTF8( refText ),
202 TO_UTF8( pinText ) );
203 break;
204 }
205 }
206 }
207
208 return ret >= 0;
209}
wxString GetBuildVersion()
Get the full KiCad version string.
const NET_MAP & GetNetMap() const
A subgraph is a set of items that are electrically connected on a single sheet.
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
UNIQUE_STRINGS m_referencesAlreadyFound
Used for "multiple symbols per package" symbols to avoid processing a lib symbol more than once.
SCH_SYMBOL * findNextSymbol(EDA_ITEM *aItem, SCH_SHEET_PATH *aSheetPath)
Check if the given symbol should be processed for netlisting.
SCHEMATIC_IFACE * m_schematic
The schematic we're generating a netlist for.
bool writeListOfNets(FILE *f)
Write a net list (ranked by Netcode), and pins connected to it.
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions, REPORTER &aReporter) override
Write to specified output file.
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
virtual CONNECTION_GRAPH * ConnectionGraph() const =0
virtual SCH_SHEET_LIST GetSheets() const =0
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:147
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Schematic symbol object.
Definition: sch_symbol.h:81
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:652
bool GetIncludeOnBoard() const
Definition: sch_symbol.h:750
const wxString GetFootprintFieldText(bool aResolve) const
Definition: sch_symbol.cpp:828
const wxString GetValueFieldText(bool aResolve) const
Definition: sch_symbol.cpp:813
void Clear()
Erase the record.
This file is part of the common library.
#define _(s)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
static wxString StartLine(wxT("."))
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
@ RPT_SEVERITY_ERROR
wxString DateAndTime()
@ SCH_SYMBOL_T
Definition: typeinfo.h:156
@ SCH_PIN_T
Definition: typeinfo.h:159