KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2023, 2024 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( GetISO8601CurrentDateTime() ) );
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
68 for( const SCH_SHEET_PATH& sheet : m_schematic->Hierarchy() )
69 {
70 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
71 {
72 symbol = findNextSymbol( item, sheet );
73
74 if( !symbol )
75 continue;
76
77 if( symbol->GetExcludedFromBoard() )
78 continue;
79
80 footprint = symbol->GetFootprintFieldText( true, &sheet, false );
81
82 if( footprint.IsEmpty() )
83 footprint = "$noname";
84
85 msg = symbol->GetRef( &sheet );
86 ret |= fprintf( f, "%s ", TO_UTF8( StartCmpDesc ) );
87 ret |= fprintf( f, "%s", TO_UTF8( msg ) );
88
89 msg = symbol->GetValue( true, &sheet, false );
90 msg.Replace( wxT( " " ), wxT( "_" ) );
91 ret |= fprintf( f, " \"%s\"", TO_UTF8( msg ) );
92 ret |= fprintf( f, " \"%s\"", TO_UTF8( footprint ) );
93 ret |= fprintf( f, "\n" );
94 }
95 }
96
97 ret |= fprintf( f, "\n" );
98
99 if( ! writeListOfNets( f ) )
100 ret = -1; // set error
101
102 ret |= fprintf( f, "\n%sEND\n", TO_UTF8( StartLine ) );
103
104 fclose( f );
105
106 return ret >= 0;
107}
108
109
111{
112 int ret = 0;
113 int print_ter = 0;
114
115 wxString InitNetDesc = StartLine + wxT( "ADD_TER" );
116 wxString StartNetDesc = StartLine + wxT( "TER" );
117 wxString InitNetDescLine;
118 wxString netName;
119
120 for( const auto& [ key, subgraphs ] : m_schematic->ConnectionGraph()->GetNetMap() )
121 {
122 netName.Printf( wxT( "\"%s\"" ), key.Name );
123
124 std::vector<std::pair<SCH_PIN*, SCH_SHEET_PATH>> sorted_items;
125
126 for( CONNECTION_SUBGRAPH* subgraph : subgraphs )
127 {
128 SCH_SHEET_PATH sheet = subgraph->GetSheet();
129
130 for( SCH_ITEM* item : subgraph->GetItems() )
131 {
132 if( item->Type() == SCH_PIN_T )
133 sorted_items.emplace_back( static_cast<SCH_PIN*>( item ), sheet );
134 }
135 }
136
137 // Netlist ordering: Net name, then ref des, then pin name
138 std::sort( sorted_items.begin(), sorted_items.end(),
139 []( std::pair<SCH_PIN*, SCH_SHEET_PATH> a, std::pair<SCH_PIN*, SCH_SHEET_PATH> b )
140 {
141 wxString ref_a = a.first->GetParentSymbol()->GetRef( &a.second );
142 wxString ref_b = b.first->GetParentSymbol()->GetRef( &b.second );
143
144 if( ref_a == ref_b )
145 return a.first->GetShownNumber() < b.first->GetShownNumber();
146
147 return ref_a < ref_b;
148 } );
149
150 // Some duplicates can exist, for example on multi-unit parts with duplicated
151 // pins across units. If the user connects the pins on each unit, they will
152 // appear on separate subgraphs. Remove those here:
153 sorted_items.erase( std::unique( sorted_items.begin(), sorted_items.end(),
154 []( std::pair<SCH_PIN*, SCH_SHEET_PATH> a, std::pair<SCH_PIN*, SCH_SHEET_PATH> b )
155 {
156 wxString ref_a = a.first->GetParentSymbol()->GetRef( &a.second );
157 wxString ref_b = b.first->GetParentSymbol()->GetRef( &b.second );
158
159 return ref_a == ref_b && a.first->GetShownNumber() == b.first->GetShownNumber();
160 } ),
161 sorted_items.end() );
162
163 print_ter = 0;
164
165 for( const std::pair<SCH_PIN*, SCH_SHEET_PATH>& pair : sorted_items )
166 {
167 SCH_PIN* pin = pair.first;
168 SCH_SHEET_PATH sheet = pair.second;
169
170 wxString refText = pin->GetParentSymbol()->GetRef( &sheet );
171 wxString pinText = pin->GetShownNumber();
172
173 // Skip power symbols and virtual symbols
174 if( refText[0] == wxChar( '#' ) )
175 continue;
176
177 switch( print_ter )
178 {
179 case 0:
180 InitNetDescLine.Printf( wxT( "\n%s %s %.4s %s" ),
181 InitNetDesc,
182 refText,
183 pinText,
184 netName );
185 print_ter++;
186 break;
187
188 case 1:
189 ret |= fprintf( f, "%s\n", TO_UTF8( InitNetDescLine ) );
190 ret |= fprintf( f, "%s %s %.4s\n",
191 TO_UTF8( StartNetDesc ),
192 TO_UTF8( refText ),
193 TO_UTF8( pinText ) );
194 print_ter++;
195 break;
196
197 default:
198 ret |= fprintf( f, " %s %.4s\n",
199 TO_UTF8( refText ),
200 TO_UTF8( pinText ) );
201 break;
202 }
203 }
204 }
205
206 return ret >= 0;
207}
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.
SCH_SYMBOL * findNextSymbol(EDA_ITEM *aItem, const SCH_SHEET_PATH &aSheetPath)
Check if the given symbol should be processed for netlisting.
UNIQUE_STRINGS m_referencesAlreadyFound
Used for "multiple symbols per package" symbols to avoid processing a lib symbol more than once.
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:72
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 Hierarchy() const =0
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:166
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
const SCH_SHEET * GetSheet(unsigned aIndex) const
Schematic symbol object.
Definition: sch_symbol.h:104
const wxString GetValue(bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const override
Definition: sch_symbol.cpp:903
const wxString GetFootprintFieldText(bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const
Definition: sch_symbol.cpp:919
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
Definition: sch_symbol.cpp:736
bool GetExcludedFromBoard() const
Definition: symbol.h:148
void Clear()
Erase the record.
This file is part of the common library.
#define _(s)
static wxString StartLine(wxT("."))
@ RPT_SEVERITY_ERROR
wxString GetISO8601CurrentDateTime()
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:391
@ SCH_SYMBOL_T
Definition: typeinfo.h:172
@ SCH_PIN_T
Definition: typeinfo.h:153