KiCad PCB EDA Suite
Loading...
Searching...
No Matches
netlist_exporter_allegro.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 <[email protected]>
6 * Copyright (C) 1992-2023 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#ifndef NETLIST_EXPORTER_ALLEGRO_H
27#define NETLIST_EXPORTER_ALLEGRO_H
28
30
35{
36public:
38 NETLIST_EXPORTER_BASE( aSchematic ),
39 m_f( nullptr )
40 {
41 }
42
47 bool WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions,
48 REPORTER& aReporter ) override;
49
57 static bool CompareSymbolSheetpath( const std::pair<SCH_SYMBOL*, SCH_SHEET_PATH>& aItem1,
58 const std::pair<SCH_SYMBOL*, SCH_SHEET_PATH>& aItem2 );
59
67 static bool CompareSymbolRef( const wxString& aRefText1, const wxString& aRefText2 );
68
76 static bool CompareLibPin( const SCH_PIN* aPin1, const SCH_PIN* aPin2 );
77
78private:
80
85 void toAllegroPackages();
86
91 void toAllegroNets();
92
98
109 wxString formatDevice( wxString aString );
110
121 wxString formatText( wxString aString );
122
135 wxString formatPin( const SCH_PIN& aPin );
136
145 wxString formatFunction( wxString aName, std::vector<SCH_PIN*> aPinList );
146
158 wxString getGroupField( int aGroupIndex, const wxArrayString& aFieldArray,
159 bool aSanitize = true );
160
167 static wxString removeTailDigits( wxString aString );
168
175 static unsigned int extractTailNumber( wxString aString );
176
177 struct NET_NODE
178 {
179 NET_NODE( SCH_PIN* aPin, const SCH_SHEET_PATH& aSheet, bool aNoConnect ) :
180 m_Pin( aPin ),
181 m_Sheet( aSheet ),
182 m_NoConnect( aNoConnect )
183 {}
184
185 bool operator<( const NET_NODE& aNetNode ) const
186 {
187 wxString refText1 = m_Pin->GetParentSymbol()->GetRef( &m_Sheet );
188 wxString refText2 = aNetNode.m_Pin->GetParentSymbol()->GetRef( &aNetNode.m_Sheet );
189
190 if( refText1 == refText2 )
191 {
192 unsigned long val1, val2;
193
194 //From wxWidgets 3.1.6, the function ToULong can be replaced with ToUInt
195 bool convertingResult = m_Pin->GetShownNumber().ToULong( &val1 );
196 convertingResult &= aNetNode.m_Pin->GetShownNumber().ToULong( &val2 );
197
198 if( convertingResult )
199 {
200 return val1 < val2;
201 }
202 else
203 {
204 return m_Pin->GetShownNumber() < aNetNode.m_Pin->GetShownNumber();
205 }
206 }
207
208 return CompareSymbolRef( refText1, refText2 );
209 }
210
214 };
215
216 FILE* m_f ;
217 wxString m_exportPath;
218 std::multimap<wxString, wxString> m_packageProperties;
219
221 std::multimap<int, std::pair<SCH_SYMBOL*, SCH_SHEET_PATH> > m_componentGroups;
222
224 std::list<std::pair<SCH_SYMBOL*, SCH_SHEET_PATH>> m_orderedSymbolsSheetpath;
225 std::multimap<wxString, NET_NODE> m_netNameNodes;
226};
227
228#endif
Generate a netlist compatible with Allegro.
wxString formatDevice(wxString aString)
Convert a string into one safe for a Telesis device name.
wxString m_exportPath
Directory to store device files.
static unsigned int extractTailNumber(wxString aString)
Extract the str's tailing number.
FILE * m_f
File pointer for netlist file writing operation.
static wxString removeTailDigits(wxString aString)
Remove the str's tailing digits.
void toAllegroPackageProperties()
Write $A_PROPERTIES section.
NETLIST_EXPORTER_ALLEGRO(SCHEMATIC *aSchematic)
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions, REPORTER &aReporter) override
Write netlist to aOutFileName.
std::list< std::pair< SCH_SYMBOL *, SCH_SHEET_PATH > > m_orderedSymbolsSheetpath
Store the ordered symbols with sheetpath.
static bool CompareSymbolSheetpath(const std::pair< SCH_SYMBOL *, SCH_SHEET_PATH > &aItem1, const std::pair< SCH_SYMBOL *, SCH_SHEET_PATH > &aItem2)
Compare two std::pair<SCH_SYMBOL*, SCH_SHEET_PATH> variables.
wxString formatText(wxString aString)
Convert a string into Telesis-safe format.
std::multimap< wxString, wxString > m_packageProperties
wxString formatFunction(wxString aName, std::vector< SCH_PIN * > aPinList)
Generate the definition of a function in Telesis format, which consists of multiple declarations (PIN...
static bool CompareLibPin(const SCH_PIN *aPin1, const SCH_PIN *aPin2)
Compare two SCH_PIN* variables.
wxString formatPin(const SCH_PIN &aPin)
Generate a Telesis-compatible pin name from a pin node.
static bool CompareSymbolRef(const wxString &aRefText1, const wxString &aRefText2)
Compare two wxString variables.
wxString getGroupField(int aGroupIndex, const wxArrayString &aFieldArray, bool aSanitize=true)
Look up a field for a component group, which may have mismatched case, or the component group may not...
void toAllegroPackages()
Write the $PACKAGES section.
std::multimap< wxString, NET_NODE > m_netNameNodes
Store the NET_NODE with the net name.
std::multimap< int, std::pair< SCH_SYMBOL *, SCH_SHEET_PATH > > m_componentGroups
Store the component group.
void toAllegroNets()
Write the $NETS section.
An abstract class used for the netlist exporters that Eeschema supports.
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
Holds all the data relating to one schematic.
Definition: schematic.h:75
const SYMBOL * GetParentSymbol() const
Definition: sch_item.cpp:166
wxString GetShownNumber() const
Definition: sch_pin.cpp:458
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
virtual const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const =0
bool operator<(const NET_NODE &aNetNode) const
NET_NODE(SCH_PIN *aPin, const SCH_SHEET_PATH &aSheet, bool aNoConnect)