KiCad PCB EDA Suite
Loading...
Searching...
No Matches
netlist_exporter_allegro.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) 2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include <confirm.h>
25#include <refdes_utils.h>
26#include <sch_edit_frame.h>
27#include <sch_reference_list.h>
28#include <string_utils.h>
29#include <connection_graph.h>
30#include <core/kicad_algo.h>
31#include <symbol_library.h>
32#include <symbol_lib_table.h>
33#include <netlist.h>
36#include <regex>
37
38
39bool NETLIST_EXPORTER_ALLEGRO::WriteNetlist( const wxString& aOutFileName,
40 unsigned /* aNetlistOptions */,
41 REPORTER& aReporter )
42{
43 m_f = nullptr;
44 wxString field;
45 wxString footprint;
46 int ret = 0; // zero now, OR in the sign bit on error
47 wxString netName;
48
49 // Create the devices directory
50 m_exportPath = wxFileName( aOutFileName ).GetPath( wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR )
51 + wxString( "devices" );
52 if( !wxDirExists( m_exportPath ) )
53 {
54 if( !wxMkdir( m_exportPath, wxS_DIR_DEFAULT ) )
55 {
56 wxString msg = wxString::Format( _( "Failed to create directory 'devices' ." ) );
57 aReporter.Report( msg, RPT_SEVERITY_ERROR );
58 return false;
59 }
60 }
61
62 // Write the netlist file
63 if( ( m_f = wxFopen( aOutFileName, wxT( "wt" ) ) ) == nullptr )
64 {
65 wxString msg = wxString::Format( _( "Failed to create file '%s'." ), aOutFileName );
66 aReporter.Report( msg, RPT_SEVERITY_ERROR );
67 return false;
68 }
69
70 ret |= fprintf( m_f, "(Source: %s)\n", TO_UTF8( m_schematic->GetFileName() ) );
71 ret |= fprintf( m_f, "(Date: %s)\n", TO_UTF8( GetISO8601CurrentDateTime() ) );
72
73 m_packageProperties.clear();
74 m_componentGroups.clear();
76 m_netNameNodes.clear();
77
79
80 // Start with package definitions, which we create from component groups.
82
83 // Write out nets
85
86 // Write out package properties. NOTE: Allegro doesn't recognize much...
88
89 // Done with the netlist
90 fclose( m_f );
91
92 m_f = nullptr;
93
94 return ret >= 0;
95}
96
97
99 SCH_SHEET_PATH>& aItem1,
100 const std::pair<SCH_SYMBOL*,
101 SCH_SHEET_PATH>& aItem2 )
102{
103 wxString refText1 = aItem1.first->GetRef( &aItem1.second );
104 wxString refText2 = aItem2.first->GetRef( &aItem2.second );
105
106 if( refText1 == refText2 )
107 {
108 return aItem1.second.PathHumanReadable() < aItem2.second.PathHumanReadable();
109 }
110
111 return CompareSymbolRef( refText1, refText2 );
112}
113
114
115bool NETLIST_EXPORTER_ALLEGRO::CompareSymbolRef( const wxString& aRefText1,
116 const wxString& aRefText2 )
117{
118 if( removeTailDigits( aRefText1 ) == removeTailDigits( aRefText2 ) )
119 {
120 return extractTailNumber( aRefText1 ) < extractTailNumber( aRefText2 );
121 }
122
123 return aRefText1 < aRefText2;
124}
125
126
128{
129 // return "lhs < rhs"
130 return StrNumCmp( aPin1->GetShownNumber(), aPin2->GetShownNumber(), true ) < 0;
131}
132
133
135{
137 m_libParts.clear();
138
139 SCH_SHEET_LIST sheetList = m_schematic->GetSheets();
140
141 for( unsigned ii = 0; ii < sheetList.size(); ii++ )
142 {
143 SCH_SHEET_PATH sheet = sheetList[ii];
145
146 auto cmp = [sheet]( SCH_SYMBOL* a, SCH_SYMBOL* b )
147 {
148 return ( StrNumCmp( a->GetRef( &sheet, false ),
149 b->GetRef( &sheet, false ), true ) < 0 );
150 };
151
152 std::set<SCH_SYMBOL*, decltype( cmp )> ordered_symbols( cmp );
153 std::multiset<SCH_SYMBOL*, decltype( cmp )> extra_units( cmp );
154
155 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
156 {
157 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
158 auto test = ordered_symbols.insert( symbol );
159
160 if( !test.second )
161 {
162 if( ( *( test.first ) )->m_Uuid > symbol->m_Uuid )
163 {
164 extra_units.insert( *( test.first ) );
165 ordered_symbols.erase( test.first );
166 ordered_symbols.insert( symbol );
167 }
168 else
169 {
170 extra_units.insert( symbol );
171 }
172 }
173 }
174
175 for( EDA_ITEM* item : ordered_symbols )
176 {
177 SCH_SYMBOL* symbol = findNextSymbol( item, &sheet );
178
179 if( !symbol || symbol->GetExcludedFromBoard() )
180 continue;
181
182 if( symbol->GetLibPins().empty() )
183 continue;
184
185 m_packageProperties.insert( std::pair<wxString,
186 wxString>( sheet.PathHumanReadable(),
187 symbol->GetRef( &sheet ) ) );
188 m_orderedSymbolsSheetpath.push_back( std::pair<SCH_SYMBOL*,
189 SCH_SHEET_PATH>( symbol, sheet ) );
190 }
191 }
192
193 wxString netCodeTxt;
194 wxString netName;
195 wxString ref;
196
197 struct NET_RECORD
198 {
199 NET_RECORD( const wxString& aName ) :
200 m_Name( aName )
201 {};
202
203 wxString m_Name;
204 std::vector<NET_NODE> m_Nodes;
205 };
206
207 std::vector<NET_RECORD*> nets;
208
209 for( const auto& it : m_schematic->ConnectionGraph()->GetNetMap() )
210 {
211 wxString net_name = it.first.Name;
212 const std::vector<CONNECTION_SUBGRAPH*>& subgraphs = it.second;
213 NET_RECORD* net_record = nullptr;
214
215 if( subgraphs.empty() )
216 continue;
217
218 nets.emplace_back( new NET_RECORD( net_name ) );
219 net_record = nets.back();
220
221 for( CONNECTION_SUBGRAPH* subgraph : subgraphs )
222 {
223 bool nc = subgraph->GetNoConnect() &&
224 subgraph->GetNoConnect()->Type() == SCH_NO_CONNECT_T;
225 const SCH_SHEET_PATH& sheet = subgraph->GetSheet();
226
227 for( SCH_ITEM* item : subgraph->GetItems() )
228 {
229 if( item->Type() == SCH_PIN_T )
230 {
231 SCH_PIN* pin = static_cast<SCH_PIN*>( item );
232 SYMBOL* symbol = pin->GetParentSymbol();
233
234 if( !symbol || symbol->GetExcludedFromBoard() )
235 continue;
236
237 net_record->m_Nodes.emplace_back( pin, sheet, nc );
238 }
239 }
240 }
241 }
242
243 // Netlist ordering: Net name, then ref des, then pin name
244 std::sort( nets.begin(), nets.end(),
245 []( const NET_RECORD* a, const NET_RECORD*b )
246 {
247 return StrNumCmp( a->m_Name, b->m_Name ) < 0;
248 } );
249
250 for( NET_RECORD* net_record : nets )
251 {
252 // Netlist ordering: Net name, then ref des, then pin name
253 std::sort( net_record->m_Nodes.begin(), net_record->m_Nodes.end(),
254 []( const NET_NODE& a, const NET_NODE& b )
255 {
256 wxString refA = a.m_Pin->GetParentSymbol()->GetRef( &a.m_Sheet );
257 wxString refB = b.m_Pin->GetParentSymbol()->GetRef( &b.m_Sheet );
258
259 if( refA == refB )
260 return a.m_Pin->GetShownNumber() < b.m_Pin->GetShownNumber();
261
262 return refA < refB;
263 } );
264
265 // Some duplicates can exist, for example on multi-unit parts with duplicated pins across
266 // units. If the user connects the pins on each unit, they will appear on separate
267 // subgraphs. Remove those here:
268 alg::remove_duplicates( net_record->m_Nodes,
269 []( const NET_NODE& a, const NET_NODE& b )
270 {
271 wxString refA = a.m_Pin->GetParentSymbol()->GetRef( &a.m_Sheet );
272 wxString refB = b.m_Pin->GetParentSymbol()->GetRef( &b.m_Sheet );
273
274 return refA == refB && a.m_Pin->GetShownNumber() == b.m_Pin->GetShownNumber();
275 } );
276
277 for( const NET_NODE& netNode : net_record->m_Nodes )
278 {
279 wxString refText = netNode.m_Pin->GetParentSymbol()->GetRef( &netNode.m_Sheet );
280 wxString pinText = netNode.m_Pin->GetShownNumber();
281
282 // Skip power symbols and virtual symbols
283 if( refText[0] == wxChar( '#' ) )
284 {
285 continue;
286 }
287
288 m_netNameNodes.insert( std::pair<wxString, NET_NODE>( net_record->m_Name, netNode ) );
289 }
290 }
291
292 for( NET_RECORD* record : nets )
293 delete record;
294}
295
296
298{
299 int groupCount = 1;
300 wxString deviceFileCreatingError = wxString( "" );
301
302 //Group the components......
303 while(!m_orderedSymbolsSheetpath.empty())
304 {
305 std::pair<SCH_SYMBOL*, SCH_SHEET_PATH> first_ele = m_orderedSymbolsSheetpath.front();
306 m_orderedSymbolsSheetpath.pop_front();
307 m_componentGroups.insert( std::pair<int, std::pair<SCH_SYMBOL*,
308 SCH_SHEET_PATH>>( groupCount, first_ele ) );
309
310 for( auto it = m_orderedSymbolsSheetpath.begin(); it != m_orderedSymbolsSheetpath.end();
311 ++it )
312 {
313 if( it->first->GetValue( false, &it->second, false )
314 != first_ele.first->GetValue( false, &first_ele.second, false ) )
315 {
316 continue;
317 }
318
319 if( it->first->GetFootprintFieldText( false, &it->second, false )
320 != first_ele.first->GetFootprintFieldText( false, &first_ele.second, false ) )
321 {
322 continue;
323 }
324
325 wxString ref1 = it->first->GetRef( &it->second );
326 wxString ref2 = first_ele.first->GetRef( &first_ele.second );
327
328 if( removeTailDigits( ref1 ) == removeTailDigits( ref2 ) )
329 {
330 m_componentGroups.insert( std::pair<int, std::pair<SCH_SYMBOL*,
331 SCH_SHEET_PATH>>( groupCount, ( *it ) ) );
332 it = m_orderedSymbolsSheetpath.erase( it );
333
334 if( std::distance( it, m_orderedSymbolsSheetpath.begin() ) > 0 )
335 it--;
336 else if( it == m_orderedSymbolsSheetpath.end() )
337 break;
338 }
339 }
340 groupCount++;
341 }
342
343 struct COMP_PACKAGE_STRUCT
344 {
345 wxString m_value;
346 wxString m_tolerance;
347 std::vector<std::pair<SCH_SYMBOL*, SCH_SHEET_PATH>> m_symbolSheetpaths;
348 };
349
350 COMP_PACKAGE_STRUCT compPackageStruct;
351 std::map<wxString, COMP_PACKAGE_STRUCT> compPackageMap;
352
353 for( int groupIndex = 1; groupIndex < groupCount; groupIndex++ )
354 {
355 auto pairIter = m_componentGroups.equal_range( groupIndex );
356 auto beginIter = pairIter.first;
357 auto endIter = pairIter.second;
358
359 SCH_SYMBOL* sym = ( beginIter->second ).first;
360 SCH_SHEET_PATH sheetPath = ( beginIter->second ).second;
361
362 wxString valueText = sym->GetValue( false, &sheetPath, false );
363 wxString footprintText = sym->GetFootprintFieldText( false, &sheetPath, false);
364 wxString deviceType = valueText + wxString("_") + footprintText;
365
366 while( deviceType.GetChar(deviceType.Length()-1) == '_' )
367 {
368 deviceType.RemoveLast();
369 }
370
371 deviceType = formatDevice( deviceType );
372
373 wxArrayString fieldArray;
374 fieldArray.Add( "Spice_Model" );
375 fieldArray.Add( "VALUE" );
376
377 wxString value = getGroupField( groupIndex, fieldArray );
378
379 fieldArray.clear();
380 fieldArray.Add( "TOLERANCE" );
381 fieldArray.Add( "TOL" );
382 wxString tol = getGroupField( groupIndex, fieldArray );
383
384 std::vector<std::pair<SCH_SYMBOL*, SCH_SHEET_PATH>> symbolSheetpaths;
385
386 for( auto iter = beginIter; iter != endIter; iter++ )
387 {
388 symbolSheetpaths.push_back( std::pair<SCH_SYMBOL*,
389 SCH_SHEET_PATH>( iter->second.first,
390 iter->second.second ) );
391 }
392
393 std::stable_sort( symbolSheetpaths.begin(), symbolSheetpaths.end(),
395
396 compPackageStruct.m_value = value;
397 compPackageStruct.m_tolerance = tol;
398 compPackageStruct.m_symbolSheetpaths = symbolSheetpaths;
399 compPackageMap.insert( std::pair( deviceType, compPackageStruct ) );
400
401 // Write out the corresponding device file
402 FILE* d = nullptr;
403 wxString deviceFileName = wxFileName( m_exportPath, deviceType,
404 wxString( "txt" ) ).GetFullPath();
405
406 if( ( d = wxFopen( deviceFileName, wxT( "wt" ) ) ) == nullptr )
407 {
408 wxString msg;
409 msg.Printf( _( "Failed to create file '%s'.\n" ), deviceFileName );
410 deviceFileCreatingError += msg;
411 continue;
412 }
413
414 footprintText = footprintText.AfterLast( ':' );
415
416 wxArrayString footprintAlt;
417 wxArrayString footprintArray = sym->GetLibSymbolRef()->GetFPFilters();
418
419 for( const wxString& fp : footprintArray )
420 {
421 if( ( fp.Find( '*' ) != wxNOT_FOUND ) || ( fp.Find( '?' ) != wxNOT_FOUND ) )
422 {
423 continue;
424 }
425
426 footprintAlt.Add( fp.AfterLast( ':' ) );
427 }
428
429 if( footprintText.IsEmpty() )
430 {
431 if( !footprintAlt.IsEmpty() )
432 {
433 footprintText = footprintAlt[0];
434 footprintAlt.RemoveAt( 0 );
435 }
436 else
437 {
438 footprintText = deviceType;
439 }
440 }
441
442 fprintf( d, "PACKAGE '%s'\n", TO_UTF8( formatDevice( footprintText ) ) );
443 fprintf( d, "CLASS IC\n" );
444
445 std::vector<SCH_PIN*> pinList = sym->GetLibSymbolRef()->GetAllLibPins();
446
447 /*
448 * We must erase redundant Pins references in pinList
449 * These redundant pins exist because some pins are found more than one time when a
450 * symbol has multiple parts per package or has 2 representations (DeMorgan conversion).
451 * For instance, a 74ls00 has DeMorgan conversion, with different pin shapes, and
452 * therefore each pin appears 2 times in the list. Common pins (VCC, GND) can also be
453 * found more than once.
454 */
455 sort( pinList.begin(), pinList.end(), NETLIST_EXPORTER_ALLEGRO::CompareLibPin );
456
457 for( int ii = 0; ii < (int) pinList.size() - 1; ii++ )
458 {
459 if( pinList[ii]->GetNumber() == pinList[ii + 1]->GetNumber() )
460 {
461 // 2 pins have the same number, remove the redundant pin at index i+1
462 pinList.erase( pinList.begin() + ii + 1 );
463 ii--;
464 }
465 }
466
467 unsigned int pinCount = pinList.size();
468 fprintf( d, "PINCOUNT %u\n", pinCount );
469
470 if( pinCount > 0 )
471 {
472 fprintf( d, "%s", TO_UTF8( formatFunction( "main", pinList ) ) );
473 }
474
475 if( !value.IsEmpty() )
476 {
477 fprintf( d, "PACKAGEPROP VALUE %s\n", TO_UTF8( value ) );
478 }
479
480 if( !tol.IsEmpty() )
481 {
482 fprintf( d, "PACKAGEPROP TOL %s\n", TO_UTF8( tol ) );
483 }
484
485 if( !footprintAlt.IsEmpty() )
486 {
487 fprintf( d, "PACKAGEPROP ALT_SYMBOLS '(" );
488
489 wxString footprintAltSymbolsText;
490
491 for( const wxString& fp : footprintAlt )
492 {
493 footprintAltSymbolsText += fp + wxString( "," );
494 }
495
496 footprintAltSymbolsText.Truncate( footprintAltSymbolsText.Length() - 1 );
497 fprintf( d, "%s)'\n", TO_UTF8( footprintAltSymbolsText ) );
498 }
499
500 wxArrayString propArray;
501 propArray.Add( "PART_NUMBER" );
502 propArray.Add( "mpn" );
503 propArray.Add( "mfr_pn" );
504 wxString data = getGroupField( groupIndex, propArray );
505
506 if(!data.IsEmpty())
507 {
508 fprintf( d, "PACKAGEPROP %s %s\n", TO_UTF8( propArray[0] ), TO_UTF8( data ) );
509 }
510
511 propArray.clear();
512 propArray.Add( "HEIGHT" );
513 data = getGroupField( groupIndex, propArray );
514
515 if(!data.IsEmpty())
516 {
517 fprintf( d, "PACKAGEPROP %s %s\n", TO_UTF8( propArray[0] ), TO_UTF8( data ) );
518 }
519
520 fprintf( d, "END\n" );
521
522 fclose( d );
523 }
524
525 for( auto iter = compPackageMap.begin(); iter != compPackageMap.end(); iter++ )
526 {
527 wxString deviceType = iter->first;
528 wxString value = iter->second.m_value;
529 wxString tolerance = iter->second.m_tolerance;
530
531 if( value.IsEmpty() && tolerance.IsEmpty() )
532 {
533 fprintf( m_f, "!%s;", TO_UTF8( deviceType ) );
534 }
535 else if( tolerance.IsEmpty() )
536 {
537 fprintf( m_f, "!%s!%s;", TO_UTF8( deviceType ), TO_UTF8( value ) );
538 }
539 else
540 {
541 fprintf( m_f, "!%s!%s!%s;", TO_UTF8( deviceType ), TO_UTF8( value ),
542 TO_UTF8( tolerance ) );
543 }
544
545 std::vector<std::pair<SCH_SYMBOL*, SCH_SHEET_PATH>> symbolSheetpaths =
546 iter->second.m_symbolSheetpaths;
547
548 for( const auto& [ sym, sheetPath ] : symbolSheetpaths)
549 fprintf( m_f, ",\n\t%s", TO_UTF8( sym->GetRef( &sheetPath ) ) );
550
551 fprintf( m_f, "\n" );
552 }
553
554 if( !deviceFileCreatingError.IsEmpty() )
555 DisplayError( nullptr, deviceFileCreatingError );
556}
557
558
559wxString NETLIST_EXPORTER_ALLEGRO::formatText( wxString aString )
560{
561 if( aString.IsEmpty() )
562 return wxEmptyString;
563
564 aString.Replace( "\u03BC", "u" );
565
566 std::regex reg( "[!']|[^ -~]" );
567 wxString processedString = wxString( std::regex_replace( std::string( aString ), reg, "?" ) );
568
569 std::regex search_reg( "[^a-zA-Z0-9_/]" );
570
571 if( std::regex_search( std::string( processedString ), search_reg ) )
572 return wxString( "'" ) + processedString + wxString( "'" );
573
574 return processedString;
575}
576
577
579{
580 wxString pinName4Telesis = aPin.GetName() + wxString( "__" ) + aPin.GetNumber();
581 std::regex reg( "[^A-Za-z0-9_+?/-]" );
582 return wxString( std::regex_replace( std::string( pinName4Telesis ), reg, "?" ) );
583}
584
585
586wxString NETLIST_EXPORTER_ALLEGRO::formatFunction( wxString aName, std::vector<SCH_PIN*> aPinList )
587{
588 aName.MakeUpper();
589 std::list<wxString> pinNameList;
590
591 std::stable_sort( aPinList.begin(), aPinList.end(), NETLIST_EXPORTER_ALLEGRO::CompareLibPin );
592
593 for( auto pin : aPinList )
594 pinNameList.push_back( formatPin( *pin ) );
595
596 wxString out_str = "";
597 wxString str;
598
599 out_str.Printf( wxT( "PINORDER %s " ), TO_UTF8( aName ) );
600
601 for( const wxString& pinName : pinNameList )
602 {
603 str.Printf( ",\n\t%s", TO_UTF8( pinName ) );
604 out_str += str;
605 }
606 out_str += wxString( "\n" );
607
608 str.Printf( wxT( "FUNCTION %s %s " ), TO_UTF8( aName ), TO_UTF8( aName ) );
609 out_str += str;
610
611 for( auto pin : aPinList )
612 {
613 str.Printf( ",\n\t%s", TO_UTF8( pin->GetNumber() ) );
614 out_str += str;
615 }
616
617 out_str += wxString( "\n" );
618
619 return out_str;
620}
621
622
623wxString NETLIST_EXPORTER_ALLEGRO::getGroupField( int aGroupIndex, const wxArrayString& aFieldArray,
624 bool aSanitize )
625{
626 auto pairIter = m_componentGroups.equal_range( aGroupIndex );
627
628 for( auto iter = pairIter.first; iter != pairIter.second; ++iter )
629 {
630 SCH_SYMBOL* sym = ( iter->second ).first;
631 SCH_SHEET_PATH sheetPath = ( iter->second ).second;
632
633 for( const wxString& field : aFieldArray )
634 {
635 if( SCH_FIELD* fld = sym->FindField( field, true, true ) )
636 {
637 wxString fieldText = fld->GetShownText( &sheetPath, true );
638
639 if( !fieldText.IsEmpty() )
640 {
641 if( aSanitize )
642 return formatText( fieldText );
643 else
644 return fieldText;
645 }
646 }
647 }
648 }
649
650 for( auto iter = pairIter.first; iter != pairIter.second; ++iter )
651 {
652 SCH_SYMBOL* sym = ( iter->second ).first;
653
654 for( const wxString& field : aFieldArray )
655 {
656 if( SCH_FIELD* fld = sym->GetLibSymbolRef()->FindField( field, true ) )
657 {
658 wxString fieldText = fld->GetShownText( false, 0 );
659
660 if( !fieldText.IsEmpty() )
661 {
662 if( aSanitize )
663 return formatText( fieldText );
664 else
665 return fieldText;
666 }
667 }
668 }
669 }
670
671 return wxEmptyString;
672}
673
674
675wxString NETLIST_EXPORTER_ALLEGRO::formatDevice( wxString aString )
676{
677 aString.MakeLower();
678 std::regex reg( "[^a-z0-9_-]" );
679 return wxString( std::regex_replace( std::string( aString ), reg, "_" ) );
680}
681
682
684{
685 fprintf( m_f, "%s\n", "$PACKAGES" );
686 fprintf( m_f, "%s\n", "$A_PROPERTIES" );
687
688 while( !m_packageProperties.empty() )
689 {
690 std::multimap<wxString, wxString>::iterator iter = m_packageProperties.begin();
691 wxString sheetPathText = iter->first;
692
693 fprintf( m_f, "ROOM %s;", TO_UTF8( formatText( sheetPathText ) ) );
694
695 std::vector<wxString> refTexts;
696
697 auto pairIter = m_packageProperties.equal_range( sheetPathText );
698
699 for( iter = pairIter.first; iter != pairIter.second; ++iter )
700 {
701 wxString refText = iter->second;
702 refTexts.push_back( refText );
703 }
704
705 m_packageProperties.erase( pairIter.first, pairIter.second );
706
707 std::stable_sort( refTexts.begin(), refTexts.end(),
709
710 for( const wxString& ref : refTexts )
711 fprintf( m_f, ",\n\t%s", TO_UTF8( ref ) );
712
713 fprintf( m_f, "\n" );
714 }
715}
716
717
719{
720 fprintf( m_f, "%s\n", "$NETS" );
721
722 while( !m_netNameNodes.empty() )
723 {
724 std::multimap<wxString, NET_NODE>::iterator iter = m_netNameNodes.begin();
725 std::vector<NET_NODE> netNodes;
726
727 wxString netName = iter->first;
728
729 fprintf( m_f, "%s;", TO_UTF8( formatText( netName ).MakeUpper() ) );
730
731 auto pairIter = m_netNameNodes.equal_range( netName );
732
733 for( iter = pairIter.first; iter != pairIter.second; ++iter )
734 {
735 NET_NODE netNode = iter->second;
736 netNodes.push_back( netNode );
737 }
738
739 m_netNameNodes.erase( pairIter.first, pairIter.second );
740
741 std::stable_sort( netNodes.begin(), netNodes.end() );
742
743 for( const NET_NODE& netNode : netNodes )
744 {
745 wxString refText = netNode.m_Pin->GetParentSymbol()->GetRef( &netNode.m_Sheet );
746 wxString pinText = netNode.m_Pin->GetShownNumber();
747 fprintf( m_f, ",\n\t%s.%s", TO_UTF8( refText ), TO_UTF8( pinText ) );
748 }
749
750 fprintf( m_f, "\n" );
751 }
752}
753
754
756{
757 while( ( aString.GetChar( aString.Length() - 1 ) >= '0' )
758 && ( aString.GetChar( aString.Length() - 1 ) <= '9' ) )
759 {
760 aString.RemoveLast();
761 }
762
763 return aString;
764}
765
766
767unsigned int NETLIST_EXPORTER_ALLEGRO::extractTailNumber( wxString aString )
768{
769 wxString numString;
770
771 while( ( aString.GetChar( aString.Length() - 1 ) >= '0' )
772 && ( aString.GetChar( aString.Length() - 1 ) <= '9' ) )
773 {
774 numString.insert( 0, aString.GetChar( aString.Length() - 1 ) );
775 aString.RemoveLast();
776 }
777
778 unsigned long val;
779
780 //From wxWidgets 3.1.6, here we can use ToUInt instead of ToULong function.
781 numString.ToULong( &val );
782 return (unsigned int) val;
783}
const NET_MAP & GetNetMap() const
A subgraph is a set of items that are electrically connected on a single sheet.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
const KIID m_Uuid
Definition: eda_item.h:485
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:238
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.
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.
std::set< LIB_SYMBOL *, LIB_SYMBOL_LESS_THAN > m_libParts
unique library symbols used. LIB_SYMBOL items are sorted by names
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.
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 void SetCurrentSheet(const SCH_SHEET_PATH &aPath)=0
virtual wxString GetFileName() const =0
virtual CONNECTION_GRAPH * ConnectionGraph() const =0
virtual SCH_SHEET_LIST GetSheets() const =0
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:51
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:174
const SYMBOL * GetParentSymbol() const
Definition: sch_item.cpp:161
wxString GetShownNumber() const
Definition: sch_pin.cpp:458
const wxString & GetName() const
Definition: sch_pin.cpp:353
const wxString & GetNumber() const
Definition: sch_pin.h:111
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:108
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...
const SCH_SHEET * GetSheet(unsigned aIndex) const
wxString PathHumanReadable(bool aUseShortRootName=true, bool aStripTrailingSeparator=false) const
Return the sheet path in a human readable form made from the sheet names.
SCH_SCREEN * LastScreen()
Schematic symbol object.
Definition: sch_symbol.h:105
SCH_FIELD * FindField(const wxString &aFieldName, bool aIncludeDefaultFields=true, bool aCaseInsensitive=false)
Search for a SCH_FIELD with aFieldName.
Definition: sch_symbol.cpp:995
const wxString GetValue(bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const override
Definition: sch_symbol.cpp:880
const wxString GetFootprintFieldText(bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const
Definition: sch_symbol.cpp:896
std::vector< SCH_PIN * > GetLibPins() const
Populate a vector with all the pins from the library object that match the current unit and bodyStyle...
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
Definition: sch_symbol.h:213
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
Definition: sch_symbol.cpp:713
A base class for LIB_SYMBOL and SCH_SYMBOL.
Definition: symbol.h:34
bool GetExcludedFromBoard() const
Definition: symbol.h:148
virtual const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const =0
void Clear()
Erase the record.
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:170
This file is part of the common library.
#define _(s)
void remove_duplicates(_Container &__c)
Deletes all duplicate values from __c.
Definition: kicad_algo.h:183
Collection of utility functions for component reference designators (refdes)
@ RPT_SEVERITY_ERROR
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.
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
Definition for symbol library class.
@ SCH_NO_CONNECT_T
Definition: typeinfo.h:160
@ SCH_SYMBOL_T
Definition: typeinfo.h:172
@ SCH_PIN_T
Definition: typeinfo.h:153