KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_io_kicad_sexpr.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) 2020 CERN
5 * Copyright (C) 2021-2024 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Wayne Stambaugh <[email protected]>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23#include <algorithm>
24
25// For some reason wxWidgets is built with wxUSE_BASE64 unset so expose the wxWidgets
26// base64 code.
27#define wxUSE_BASE64 1
28#include <wx/base64.h>
29#include <wx/log.h>
30#include <wx/mstream.h>
31#include <advanced_config.h>
32#include <base_units.h>
33#include <build_version.h>
34#include <trace_helpers.h>
35#include <locale_io.h>
36#include <sch_bitmap.h>
37#include <sch_bus_entry.h>
38#include <sch_symbol.h>
39#include <sch_edit_frame.h> // SYMBOL_ORIENTATION_T
40#include <sch_junction.h>
41#include <sch_line.h>
42#include <sch_shape.h>
43#include <sch_no_connect.h>
44#include <sch_text.h>
45#include <sch_textbox.h>
46#include <sch_table.h>
47#include <sch_tablecell.h>
48#include <sch_sheet.h>
49#include <sch_sheet_pin.h>
50#include <schematic.h>
51#include <sch_screen.h>
52#include <lib_shape.h>
53#include <lib_pin.h>
54#include <lib_text.h>
55#include <lib_textbox.h>
56#include <eeschema_id.h> // for MAX_UNIT_COUNT_PER_PACKAGE definition
58#include <sch_file_versions.h>
59#include <schematic_lexer.h>
64#include <symbol_lib_table.h> // for PropPowerSymsOnly definition.
65#include <ee_selection.h>
66#include <string_utils.h>
67#include <wx_filename.h> // for ::ResolvePossibleSymlinks()
68#include <progress_reporter.h>
69#include <boost/algorithm/string/join.hpp>
70
71using namespace TSCHEMATIC_T;
72
73
74#define SCH_PARSE_ERROR( text, reader, pos ) \
75 THROW_PARSE_ERROR( text, reader.GetSource(), reader.Line(), \
76 reader.LineNumber(), pos - reader.Line() )
77
78
79SCH_IO_KICAD_SEXPR::SCH_IO_KICAD_SEXPR() : SCH_IO( wxS( "Eeschema s-expression" ) )
80{
81 init( nullptr );
82}
83
84
86{
87 delete m_cache;
88}
89
90
91void SCH_IO_KICAD_SEXPR::init( SCHEMATIC* aSchematic, const STRING_UTF8_MAP* aProperties )
92{
93 m_version = 0;
94 m_appending = false;
95 m_rootSheet = nullptr;
96 m_schematic = aSchematic;
97 m_cache = nullptr;
98 m_out = nullptr;
99 m_nextFreeFieldId = 100; // number arbitrarily > MANDATORY_FIELDS or SHEET_MANDATORY_FIELDS
100}
101
102
103SCH_SHEET* SCH_IO_KICAD_SEXPR::LoadSchematicFile( const wxString& aFileName, SCHEMATIC* aSchematic,
104 SCH_SHEET* aAppendToMe,
105 const STRING_UTF8_MAP* aProperties )
106{
107 wxASSERT( !aFileName || aSchematic != nullptr );
108
109 LOCALE_IO toggle; // toggles on, then off, the C locale.
110 SCH_SHEET* sheet;
111
112 wxFileName fn = aFileName;
113
114 // Unfortunately child sheet file names the legacy schematic file format are not fully
115 // qualified and are always appended to the project path. The aFileName attribute must
116 // always be an absolute path so the project path can be used for load child sheet files.
117 wxASSERT( fn.IsAbsolute() );
118
119 if( aAppendToMe )
120 {
121 m_appending = true;
122 wxLogTrace( traceSchPlugin, "Append \"%s\" to sheet \"%s\".",
123 aFileName, aAppendToMe->GetFileName() );
124
125 wxFileName normedFn = aAppendToMe->GetFileName();
126
127 if( !normedFn.IsAbsolute() )
128 {
129 if( aFileName.Right( normedFn.GetFullPath().Length() ) == normedFn.GetFullPath() )
130 m_path = aFileName.Left( aFileName.Length() - normedFn.GetFullPath().Length() );
131 }
132
133 if( m_path.IsEmpty() )
134 m_path = aSchematic->Prj().GetProjectPath();
135
136 wxLogTrace( traceSchPlugin, "Normalized append path \"%s\".", m_path );
137 }
138 else
139 {
140 m_path = aSchematic->Prj().GetProjectPath();
141 }
142
143 m_currentPath.push( m_path );
144 init( aSchematic, aProperties );
145
146 if( aAppendToMe == nullptr )
147 {
148 // Clean up any allocated memory if an exception occurs loading the schematic.
149 std::unique_ptr<SCH_SHEET> newSheet = std::make_unique<SCH_SHEET>( aSchematic );
150
151 wxFileName relPath( aFileName );
152
153 // Do not use wxPATH_UNIX as option in MakeRelativeTo(). It can create incorrect
154 // relative paths on Windows, because paths have a disk identifier (C:, D: ...)
155 relPath.MakeRelativeTo( aSchematic->Prj().GetProjectPath() );
156
157 newSheet->SetFileName( relPath.GetFullPath() );
158 m_rootSheet = newSheet.get();
159 loadHierarchy( SCH_SHEET_PATH(), newSheet.get() );
160
161 // If we got here, the schematic loaded successfully.
162 sheet = newSheet.release();
163 m_rootSheet = nullptr; // Quiet Coverity warning.
164 }
165 else
166 {
167 wxCHECK_MSG( aSchematic->IsValid(), nullptr, "Can't append to a schematic with no root!" );
168 m_rootSheet = &aSchematic->Root();
169 sheet = aAppendToMe;
170 loadHierarchy( SCH_SHEET_PATH(), sheet );
171 }
172
173 wxASSERT( m_currentPath.size() == 1 ); // only the project path should remain
174
175 m_currentPath.pop(); // Clear the path stack for next call to Load
176
177 return sheet;
178}
179
180
181// Everything below this comment is recursive. Modify with care.
182
183void SCH_IO_KICAD_SEXPR::loadHierarchy( const SCH_SHEET_PATH& aParentSheetPath, SCH_SHEET* aSheet )
184{
186
187 SCH_SCREEN* screen = nullptr;
188
189 if( !aSheet->GetScreen() )
190 {
191 // SCH_SCREEN objects store the full path and file name where the SCH_SHEET object only
192 // stores the file name and extension. Add the project path to the file name and
193 // extension to compare when calling SCH_SHEET::SearchHierarchy().
194 wxFileName fileName = aSheet->GetFileName();
195
196 if( !fileName.IsAbsolute() )
197 fileName.MakeAbsolute( m_currentPath.top() );
198
199 // Save the current path so that it gets restored when descending and ascending the
200 // sheet hierarchy which allows for sheet schematic files to be nested in folders
201 // relative to the last path a schematic was loaded from.
202 wxLogTrace( traceSchPlugin, "Saving path '%s'", m_currentPath.top() );
203 m_currentPath.push( fileName.GetPath() );
204 wxLogTrace( traceSchPlugin, "Current path '%s'", m_currentPath.top() );
205 wxLogTrace( traceSchPlugin, "Loading '%s'", fileName.GetFullPath() );
206
207 SCH_SHEET_PATH ancestorSheetPath = aParentSheetPath;
208
209 while( !ancestorSheetPath.empty() )
210 {
211 if( ancestorSheetPath.LastScreen()->GetFileName() == fileName.GetFullPath() )
212 {
213 if( !m_error.IsEmpty() )
214 m_error += "\n";
215
216 m_error += wxString::Format( _( "Could not load sheet '%s' because it already "
217 "appears as a direct ancestor in the schematic "
218 "hierarchy." ),
219 fileName.GetFullPath() );
220
221 fileName = wxEmptyString;
222
223 break;
224 }
225
226 ancestorSheetPath.pop_back();
227 }
228
229 if( ancestorSheetPath.empty() )
230 {
231 // Existing schematics could be either in the root sheet path or the current sheet
232 // load path so we have to check both.
233 if( !m_rootSheet->SearchHierarchy( fileName.GetFullPath(), &screen ) )
234 m_currentSheetPath.at( 0 )->SearchHierarchy( fileName.GetFullPath(), &screen );
235 }
236
237 if( screen )
238 {
239 aSheet->SetScreen( screen );
240 aSheet->GetScreen()->SetParent( m_schematic );
241 // Do not need to load the sub-sheets - this has already been done.
242 }
243 else
244 {
245 aSheet->SetScreen( new SCH_SCREEN( m_schematic ) );
246 aSheet->GetScreen()->SetFileName( fileName.GetFullPath() );
247
248 try
249 {
250 loadFile( fileName.GetFullPath(), aSheet );
251 }
252 catch( const IO_ERROR& ioe )
253 {
254 // If there is a problem loading the root sheet, there is no recovery.
255 if( aSheet == m_rootSheet )
256 throw;
257
258 // For all subsheets, queue up the error message for the caller.
259 if( !m_error.IsEmpty() )
260 m_error += "\n";
261
262 m_error += ioe.What();
263 }
264
265 if( fileName.FileExists() )
266 {
267 aSheet->GetScreen()->SetFileReadOnly( !fileName.IsFileWritable() );
268 aSheet->GetScreen()->SetFileExists( true );
269 }
270 else
271 {
272 aSheet->GetScreen()->SetFileReadOnly( !fileName.IsDirWritable() );
273 aSheet->GetScreen()->SetFileExists( false );
274 }
275
276 SCH_SHEET_PATH currentSheetPath = aParentSheetPath;
277 currentSheetPath.push_back( aSheet );
278
279 // This was moved out of the try{} block so that any sheet definitions that
280 // the plugin fully parsed before the exception was raised will be loaded.
281 for( SCH_ITEM* aItem : aSheet->GetScreen()->Items().OfType( SCH_SHEET_T ) )
282 {
283 wxCHECK2( aItem->Type() == SCH_SHEET_T, /* do nothing */ );
284 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( aItem );
285
286 // Recursion starts here.
287 loadHierarchy( currentSheetPath, sheet );
288 }
289 }
290
291 m_currentPath.pop();
292 wxLogTrace( traceSchPlugin, "Restoring path \"%s\"", m_currentPath.top() );
293 }
294
296}
297
298
299void SCH_IO_KICAD_SEXPR::loadFile( const wxString& aFileName, SCH_SHEET* aSheet )
300{
301 FILE_LINE_READER reader( aFileName );
302
303 size_t lineCount = 0;
304
306 {
307 m_progressReporter->Report( wxString::Format( _( "Loading %s..." ), aFileName ) );
308
310 THROW_IO_ERROR( _( "Open cancelled by user." ) );
311
312 while( reader.ReadLine() )
313 lineCount++;
314
315 reader.Rewind();
316 }
317
318 SCH_IO_KICAD_SEXPR_PARSER parser( &reader, m_progressReporter, lineCount, m_rootSheet,
319 m_appending );
320
321 parser.ParseSchematic( aSheet );
322}
323
324
325void SCH_IO_KICAD_SEXPR::LoadContent( LINE_READER& aReader, SCH_SHEET* aSheet, int aFileVersion )
326{
327 wxCHECK( aSheet, /* void */ );
328
329 LOCALE_IO toggle;
330 SCH_IO_KICAD_SEXPR_PARSER parser( &aReader );
331
332 parser.ParseSchematic( aSheet, true, aFileVersion );
333}
334
335
336void SCH_IO_KICAD_SEXPR::SaveSchematicFile( const wxString& aFileName, SCH_SHEET* aSheet,
337 SCHEMATIC* aSchematic,
338 const STRING_UTF8_MAP* aProperties )
339{
340 wxCHECK_RET( aSheet != nullptr, "NULL SCH_SHEET object." );
341 wxCHECK_RET( !aFileName.IsEmpty(), "No schematic file name defined." );
342
343 LOCALE_IO toggle; // toggles on, then off, the C locale, to write floating point values.
344
345 init( aSchematic, aProperties );
346
347 wxFileName fn = aFileName;
348
349 // File names should be absolute. Don't assume everything relative to the project path
350 // works properly.
351 wxASSERT( fn.IsAbsolute() );
352
353 PRETTIFIED_FILE_OUTPUTFORMATTER formatter( fn.GetFullPath() );
354
355 m_out = &formatter; // no ownership
356
357 Format( aSheet );
358
359 if( aSheet->GetScreen() )
360 aSheet->GetScreen()->SetFileExists( true );
361}
362
363
365{
366 wxCHECK_RET( aSheet != nullptr, "NULL SCH_SHEET* object." );
367 wxCHECK_RET( m_schematic != nullptr, "NULL SCHEMATIC* object." );
368
369 SCH_SCREEN* screen = aSheet->GetScreen();
370
371 wxCHECK( screen, /* void */ );
372
373 m_out->Print( 0, "(kicad_sch (version %d) (generator \"eeschema\") (generator_version \"%s\")\n\n",
375
377
378 screen->GetPageSettings().Format( m_out, 1, 0 );
379 m_out->Print( 0, "\n" );
380 screen->GetTitleBlock().Format( m_out, 1, 0 );
381
382 // Save cache library.
383 m_out->Print( 1, "(lib_symbols\n" );
384
385 for( const auto& [ libItemName, libSymbol ] : screen->GetLibSymbols() )
386 SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol( libSymbol, *m_out, 2, libItemName );
387
388 m_out->Print( 1, ")\n\n" );
389
390 for( const std::shared_ptr<BUS_ALIAS>& alias : screen->GetBusAliases() )
391 saveBusAlias( alias, 1 );
392
393 // Enforce item ordering
394 auto cmp =
395 []( const SCH_ITEM* a, const SCH_ITEM* b )
396 {
397 if( a->Type() != b->Type() )
398 return a->Type() < b->Type();
399
400 return a->m_Uuid < b->m_Uuid;
401 };
402
403 std::multiset<SCH_ITEM*, decltype( cmp )> save_map( cmp );
404
405 for( SCH_ITEM* item : screen->Items() )
406 {
407 // Markers are not saved, so keep them from being considered below
408 if( item->Type() != SCH_MARKER_T )
409 save_map.insert( item );
410 }
411
412 KICAD_T itemType = TYPE_NOT_INIT;
414
415 for( SCH_ITEM* item : save_map )
416 {
417 if( itemType != item->Type() )
418 {
419 itemType = item->Type();
420
421 if( itemType != SCH_SYMBOL_T
422 && itemType != SCH_JUNCTION_T
423 && itemType != SCH_SHEET_T )
424 {
425 m_out->Print( 0, "\n" );
426 }
427 }
428
429 switch( item->Type() )
430 {
431 case SCH_SYMBOL_T:
432 m_out->Print( 0, "\n" );
433 saveSymbol( static_cast<SCH_SYMBOL*>( item ), *m_schematic, 1, false );
434 break;
435
436 case SCH_BITMAP_T:
437 saveBitmap( static_cast<SCH_BITMAP*>( item ), 1 );
438 break;
439
440 case SCH_SHEET_T:
441 m_out->Print( 0, "\n" );
442 saveSheet( static_cast<SCH_SHEET*>( item ), 1 );
443 break;
444
445 case SCH_JUNCTION_T:
446 saveJunction( static_cast<SCH_JUNCTION*>( item ), 1 );
447 break;
448
449 case SCH_NO_CONNECT_T:
450 saveNoConnect( static_cast<SCH_NO_CONNECT*>( item ), 1 );
451 break;
452
455 saveBusEntry( static_cast<SCH_BUS_ENTRY_BASE*>( item ), 1 );
456 break;
457
458 case SCH_LINE_T:
459 if( layer != item->GetLayer() )
460 {
461 if( layer == SCH_LAYER_ID_START )
462 {
463 layer = item->GetLayer();
464 }
465 else
466 {
467 layer = item->GetLayer();
468 m_out->Print( 0, "\n" );
469 }
470 }
471
472 saveLine( static_cast<SCH_LINE*>( item ), 1 );
473 break;
474
475 case SCH_SHAPE_T:
476 saveShape( static_cast<SCH_SHAPE*>( item ), 1 );
477 break;
478
479 case SCH_TEXT_T:
480 case SCH_LABEL_T:
482 case SCH_HIER_LABEL_T:
484 saveText( static_cast<SCH_TEXT*>( item ), 1 );
485 break;
486
487 case SCH_TEXTBOX_T:
488 saveTextBox( static_cast<SCH_TEXTBOX*>( item ), 1 );
489 break;
490
491 case SCH_TABLE_T:
492 saveTable( static_cast<SCH_TABLE*>( item ), 1 );
493 break;
494
495 default:
496 wxASSERT( "Unexpected schematic object type in SCH_IO_KICAD_SEXPR::Format()" );
497 }
498 }
499
500 if( aSheet->HasRootInstance() )
501 {
502 std::vector< SCH_SHEET_INSTANCE> instances;
503
504 instances.emplace_back( aSheet->GetRootInstance() );
505 saveInstances( instances, 1 );
506 }
507
508 m_out->Print( 0, ")\n" );
509}
510
511
512void SCH_IO_KICAD_SEXPR::Format( EE_SELECTION* aSelection, SCH_SHEET_PATH* aSelectionPath,
513 SCHEMATIC& aSchematic, OUTPUTFORMATTER* aFormatter,
514 bool aForClipboard )
515{
516 wxCHECK( aSelection && aSelectionPath && aFormatter, /* void */ );
517
518 LOCALE_IO toggle;
519 SCH_SHEET_LIST fullHierarchy = aSchematic.GetSheets();
520
521 m_schematic = &aSchematic;
522 m_out = aFormatter;
523
524 size_t i;
525 SCH_ITEM* item;
526 std::map<wxString, LIB_SYMBOL*> libSymbols;
527 SCH_SCREEN* screen = aSelection->GetScreen();
528 std::set<SCH_TABLE*> promotedTables;
529
530 for( i = 0; i < aSelection->GetSize(); ++i )
531 {
532 item = dynamic_cast<SCH_ITEM*>( aSelection->GetItem( i ) );
533
534 wxCHECK2( item, continue );
535
536 if( item->Type() != SCH_SYMBOL_T )
537 continue;
538
539 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( item );
540
541 wxCHECK2( symbol, continue );
542
543 wxString libSymbolLookup = symbol->GetLibId().Format().wx_str();
544
545 if( !symbol->UseLibIdLookup() )
546 libSymbolLookup = symbol->GetSchSymbolLibraryName();
547
548 auto it = screen->GetLibSymbols().find( libSymbolLookup );
549
550 if( it != screen->GetLibSymbols().end() )
551 libSymbols[ libSymbolLookup ] = it->second;
552 }
553
554 if( !libSymbols.empty() )
555 {
556 m_out->Print( 0, "(lib_symbols\n" );
557
558 for( const std::pair<const wxString, LIB_SYMBOL*>& libSymbol : libSymbols )
559 {
560 SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol( libSymbol.second, *m_out, 1,
561 libSymbol.first );
562 }
563
564 m_out->Print( 0, ")\n\n" );
565 }
566
567 for( i = 0; i < aSelection->GetSize(); ++i )
568 {
569 item = (SCH_ITEM*) aSelection->GetItem( i );
570
571 switch( item->Type() )
572 {
573 case SCH_SYMBOL_T:
574 saveSymbol( static_cast<SCH_SYMBOL*>( item ), aSchematic, 0, aForClipboard,
575 aSelectionPath );
576 break;
577
578 case SCH_BITMAP_T:
579 saveBitmap( static_cast< SCH_BITMAP* >( item ), 0 );
580 break;
581
582 case SCH_SHEET_T:
583 saveSheet( static_cast< SCH_SHEET* >( item ), 0 );
584 break;
585
586 case SCH_JUNCTION_T:
587 saveJunction( static_cast< SCH_JUNCTION* >( item ), 0 );
588 break;
589
590 case SCH_NO_CONNECT_T:
591 saveNoConnect( static_cast< SCH_NO_CONNECT* >( item ), 0 );
592 break;
593
596 saveBusEntry( static_cast< SCH_BUS_ENTRY_BASE* >( item ), 0 );
597 break;
598
599 case SCH_LINE_T:
600 saveLine( static_cast< SCH_LINE* >( item ), 0 );
601 break;
602
603 case SCH_SHAPE_T:
604 saveShape( static_cast<SCH_SHAPE*>( item ), 0 );
605 break;
606
607 case SCH_TEXT_T:
608 case SCH_LABEL_T:
610 case SCH_HIER_LABEL_T:
612 saveText( static_cast<SCH_TEXT*>( item ), 0 );
613 break;
614
615 case SCH_TEXTBOX_T:
616 saveTextBox( static_cast<SCH_TEXTBOX*>( item ), 0 );
617 break;
618
619 case SCH_TABLECELL_T:
620 {
621 SCH_TABLE* table = static_cast<SCH_TABLE*>( item->GetParent() );
622
623 if( promotedTables.count( table ) )
624 break;
625
626 table->SetFlags( SKIP_STRUCT );
627 saveTable( table, 0 );
628 table->ClearFlags( SKIP_STRUCT );
629 promotedTables.insert( table );
630 break;
631 }
632
633 case SCH_TABLE_T:
634 item->ClearFlags( SKIP_STRUCT );
635 saveTable( static_cast<SCH_TABLE*>( item ), 0 );
636 break;
637
638 default:
639 wxASSERT( "Unexpected schematic object type in SCH_IO_KICAD_SEXPR::Format()" );
640 }
641 }
642}
643
644
645void SCH_IO_KICAD_SEXPR::saveSymbol( SCH_SYMBOL* aSymbol, const SCHEMATIC& aSchematic,
646 int aNestLevel, bool aForClipboard,
647 const SCH_SHEET_PATH* aRelativePath )
648{
649 wxCHECK_RET( aSymbol != nullptr && m_out != nullptr, "" );
650
651 std::string libName;
652
653 wxString symbol_name = aSymbol->GetLibId().Format();
654
655 if( symbol_name.size() )
656 {
657 libName = toUTFTildaText( symbol_name );
658 }
659 else
660 {
661 libName = "_NONAME_";
662 }
663
664 EDA_ANGLE angle;
665 int orientation = aSymbol->GetOrientation() & ~( SYM_MIRROR_X | SYM_MIRROR_Y );
666
667 if( orientation == SYM_ORIENT_90 )
668 angle = ANGLE_90;
669 else if( orientation == SYM_ORIENT_180 )
670 angle = ANGLE_180;
671 else if( orientation == SYM_ORIENT_270 )
672 angle = ANGLE_270;
673 else
674 angle = ANGLE_0;
675
676 m_out->Print( aNestLevel, "(symbol" );
677
678 if( !aSymbol->UseLibIdLookup() )
679 {
680 m_out->Print( 0, " (lib_name %s)",
681 m_out->Quotew( aSymbol->GetSchSymbolLibraryName() ).c_str() );
682 }
683
684 m_out->Print( 0, " (lib_id %s) (at %s %s %s)",
685 m_out->Quotew( aSymbol->GetLibId().Format().wx_str() ).c_str(),
687 aSymbol->GetPosition().x ).c_str(),
689 aSymbol->GetPosition().y ).c_str(),
690 EDA_UNIT_UTILS::FormatAngle( angle ).c_str() );
691
692 bool mirrorX = aSymbol->GetOrientation() & SYM_MIRROR_X;
693 bool mirrorY = aSymbol->GetOrientation() & SYM_MIRROR_Y;
694
695 if( mirrorX || mirrorY )
696 {
697 m_out->Print( 0, " (mirror" );
698
699 if( mirrorX )
700 m_out->Print( 0, " x" );
701
702 if( mirrorY )
703 m_out->Print( 0, " y" );
704
705 m_out->Print( 0, ")" );
706 }
707
708 // The symbol unit is always set to the first instance regardless of the current sheet
709 // instance to prevent file churn.
710 int unit = ( aSymbol->GetInstances().size() == 0 ) ?
711 aSymbol->GetUnit() :
712 aSymbol->GetInstances()[0].m_Unit;
713
714 if( aForClipboard && aRelativePath )
715 {
716 SCH_SYMBOL_INSTANCE unitInstance;
717
718 if( aSymbol->GetInstance( unitInstance, aRelativePath->Path() ) )
719 unit = unitInstance.m_Unit;
720 }
721
722 m_out->Print( 0, " (unit %d)", unit );
723
724 if( aSymbol->GetBodyStyle() == BODY_STYLE::DEMORGAN )
725 m_out->Print( 0, " (convert %d)", aSymbol->GetBodyStyle() );
726
727 m_out->Print( 0, "\n" );
728
729 m_out->Print( aNestLevel + 1, "(exclude_from_sim %s)",
730 ( aSymbol->GetExcludedFromSim() ) ? "yes" : "no" );
731 m_out->Print( 0, " (in_bom %s)", ( aSymbol->GetExcludedFromBOM() ) ? "no" : "yes" );
732 m_out->Print( 0, " (on_board %s)", ( aSymbol->GetExcludedFromBoard() ) ? "no" : "yes" );
733 m_out->Print( 0, " (dnp %s)", ( aSymbol->GetDNP() ) ? "yes" : "no" );
734
735 if( aSymbol->GetFieldsAutoplaced() != FIELDS_AUTOPLACED_NO )
736 m_out->Print( 0, " (fields_autoplaced yes)" );
737
738 m_out->Print( 0, "\n" );
739
741
743
744 for( SCH_FIELD& field : aSymbol->GetFields() )
745 {
746 int id = field.GetId();
747 wxString value = field.GetText();
748
749 if( !aForClipboard && aSymbol->GetInstances().size() )
750 {
751 // The instance fields are always set to the default instance regardless of the
752 // sheet instance to prevent file churn.
753 if( id == REFERENCE_FIELD )
754 {
755 field.SetText( aSymbol->GetInstances()[0].m_Reference );
756 }
757 else if( id == VALUE_FIELD )
758 {
759 field.SetText( aSymbol->GetField( VALUE_FIELD )->GetText() );
760 }
761 else if( id == FOOTPRINT_FIELD )
762 {
763 field.SetText( aSymbol->GetField( FOOTPRINT_FIELD )->GetText() );
764 }
765 }
766 else if( aForClipboard && aSymbol->GetInstances().size() && aRelativePath
767 && ( id == REFERENCE_FIELD ) )
768 {
769 SCH_SYMBOL_INSTANCE instance;
770
771 if( aSymbol->GetInstance( instance, aRelativePath->Path() ) )
772 field.SetText( instance.m_Reference );
773 }
774
775 try
776 {
777 saveField( &field, aNestLevel + 1 );
778 }
779 catch( ... )
780 {
781 // Restore the changed field text on write error.
782 if( id == REFERENCE_FIELD || id == VALUE_FIELD || id == FOOTPRINT_FIELD )
783 field.SetText( value );
784
785 throw;
786 }
787
788 if( id == REFERENCE_FIELD || id == VALUE_FIELD || id == FOOTPRINT_FIELD )
789 field.SetText( value );
790 }
791
792 for( const std::unique_ptr<SCH_PIN>& pin : aSymbol->GetRawPins() )
793 {
794 if( pin->GetAlt().IsEmpty() )
795 {
796 m_out->Print( aNestLevel + 1, "(pin %s ", m_out->Quotew( pin->GetNumber() ).c_str() );
798 m_out->Print( aNestLevel + 1, ")\n" );
799 }
800 else
801 {
802 m_out->Print( aNestLevel + 1, "(pin %s ", m_out->Quotew( pin->GetNumber() ).c_str() );
804 m_out->Print( aNestLevel + 1, " (alternate %s))\n",
805 m_out->Quotew( pin->GetAlt() ).c_str() );
806 }
807 }
808
809 if( !aSymbol->GetInstances().empty() )
810 {
811 m_out->Print( aNestLevel + 1, "(instances\n" );
812
813 KIID lastProjectUuid;
814 KIID rootSheetUuid = aSchematic.Root().m_Uuid;
815 SCH_SHEET_LIST fullHierarchy = aSchematic.GetSheets();
816 bool project_open = false;
817
818 for( size_t i = 0; i < aSymbol->GetInstances().size(); i++ )
819 {
820 // Zero length KIID_PATH objects are not valid and will cause a crash below.
821 wxCHECK2( aSymbol->GetInstances()[i].m_Path.size(), continue );
822
823 // If the instance data is part of this design but no longer has an associated sheet
824 // path, don't save it. This prevents large amounts of orphaned instance data for the
825 // current project from accumulating in the schematic files.
826 //
827 // Keep all instance data when copying to the clipboard. It may be needed on paste.
828 if( !aForClipboard
829 && ( aSymbol->GetInstances()[i].m_Path[0] == rootSheetUuid )
830 && !fullHierarchy.GetSheetPathByKIIDPath( aSymbol->GetInstances()[i].m_Path ) )
831 {
832 if( project_open && ( ( i + 1 == aSymbol->GetInstances().size() )
833 || lastProjectUuid != aSymbol->GetInstances()[i+1].m_Path[0] ) )
834 {
835 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project`.
836 project_open = false;
837 }
838
839 continue;
840 }
841
842 if( lastProjectUuid != aSymbol->GetInstances()[i].m_Path[0] )
843 {
844 wxString projectName;
845
846 if( aSymbol->GetInstances()[i].m_Path[0] == rootSheetUuid )
847 projectName = aSchematic.Prj().GetProjectName();
848 else
849 projectName = aSymbol->GetInstances()[i].m_ProjectName;
850
851 lastProjectUuid = aSymbol->GetInstances()[i].m_Path[0];
852 m_out->Print( aNestLevel + 2, "(project %s\n",
853 m_out->Quotew( projectName ).c_str() );
854 project_open = true;
855 }
856
857 wxString path;
858 KIID_PATH tmp = aSymbol->GetInstances()[i].m_Path;
859
860 if( aForClipboard && aRelativePath )
861 tmp.MakeRelativeTo( aRelativePath->Path() );
862
863 path = tmp.AsString();
864
865 m_out->Print( aNestLevel + 3, "(path %s\n",
866 m_out->Quotew( path ).c_str() );
867 m_out->Print( aNestLevel + 4, "(reference %s) (unit %d)\n",
868 m_out->Quotew( aSymbol->GetInstances()[i].m_Reference ).c_str(),
869 aSymbol->GetInstances()[i].m_Unit );
870 m_out->Print( aNestLevel + 3, ")\n" );
871
872 if( project_open && ( ( i + 1 == aSymbol->GetInstances().size() )
873 || lastProjectUuid != aSymbol->GetInstances()[i+1].m_Path[0] ) )
874 {
875 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project`.
876 project_open = false;
877 }
878 }
879
880 m_out->Print( aNestLevel + 1, ")\n" ); // Closes `instances`.
881 }
882
883 m_out->Print( aNestLevel, ")\n" ); // Closes `symbol`.
884}
885
886
887void SCH_IO_KICAD_SEXPR::saveField( SCH_FIELD* aField, int aNestLevel )
888{
889 wxCHECK_RET( aField != nullptr && m_out != nullptr, "" );
890
891 wxString fieldName = aField->GetCanonicalName();
892 // For some reason (bug in legacy parser?) the field ID for non-mandatory fields is -1 so
893 // check for this in order to correctly use the field name.
894
895 if( aField->GetId() == -1 /* undefined ID */ )
896 {
897 // Replace the default name built by GetCanonicalName() by
898 // the field name if exists
899 if( !aField->GetName().IsEmpty() )
900 fieldName = aField->GetName();
901
902 aField->SetId( m_nextFreeFieldId );
904 }
905 else if( aField->GetId() >= m_nextFreeFieldId )
906 {
907 m_nextFreeFieldId = aField->GetId() + 1;
908 }
909
910 m_out->Print( aNestLevel, "(property %s %s (at %s %s %s)",
911 m_out->Quotew( fieldName ).c_str(),
912 m_out->Quotew( aField->GetText() ).c_str(),
914 aField->GetPosition().x ).c_str(),
916 aField->GetPosition().y ).c_str(),
917 EDA_UNIT_UTILS::FormatAngle( aField->GetTextAngle() ).c_str() );
918
919 if( aField->IsNameShown() )
920 m_out->Print( 0, " (show_name yes)" );
921
922 if( !aField->CanAutoplace() )
923 m_out->Print( 0, " (do_not_autoplace yes)" );
924
925 if( !aField->IsDefaultFormatting()
926 || ( aField->GetTextHeight() != schIUScale.MilsToIU( DEFAULT_SIZE_TEXT ) ) )
927 {
928 m_out->Print( 0, "\n" );
929 aField->Format( m_out, aNestLevel, 0 );
930 m_out->Print( aNestLevel, ")\n" ); // Closes property token with font effects.
931 }
932 else
933 {
934 m_out->Print( 0, ")\n" ); // Closes property token without font effects.
935 }
936}
937
938
939void SCH_IO_KICAD_SEXPR::saveBitmap( SCH_BITMAP* aBitmap, int aNestLevel )
940{
941 wxCHECK_RET( aBitmap != nullptr && m_out != nullptr, "" );
942
943 const wxImage* image = aBitmap->GetImage()->GetImageData();
944
945 wxCHECK_RET( image != nullptr, "wxImage* is NULL" );
946
947 m_out->Print( aNestLevel, "(image (at %s %s)",
949 aBitmap->GetPosition().x ).c_str(),
951 aBitmap->GetPosition().y ).c_str() );
952
953 double scale = aBitmap->GetImage()->GetScale();
954
955 // 20230121 or older file format versions assumed 300 image PPI at load/save.
956 // Let's keep compatibility by changing image scale.
957 if( SEXPR_SCHEMATIC_FILE_VERSION <= 20230121 )
958 {
959 BITMAP_BASE* bm_image = aBitmap->GetImage();
960 scale = scale * 300.0 / bm_image->GetPPI();
961 }
962
963 if( scale != 1.0 )
964 m_out->Print( 0, " (scale %g)", scale );
965
966 m_out->Print( 0, "\n" );
967
969
970 m_out->Print( aNestLevel + 1, "(data" );
971
972 wxString out = wxBase64Encode( aBitmap->GetImage()->GetImageDataBuffer() );
973
974 // Apparently the MIME standard character width for base64 encoding is 76 (unconfirmed)
975 // so use it in a vein attempt to be standard like.
976#define MIME_BASE64_LENGTH 76
977
978 size_t first = 0;
979
980 while( first < out.Length() )
981 {
982 m_out->Print( 0, "\n" );
983 m_out->Print( aNestLevel + 2, "\"%s\"", TO_UTF8( out( first, MIME_BASE64_LENGTH ) ) );
984 first += MIME_BASE64_LENGTH;
985 }
986
987 m_out->Print( 0, "\n" );
988 m_out->Print( aNestLevel + 1, ")\n" ); // Closes data token.
989 m_out->Print( aNestLevel, ")\n" ); // Closes image token.
990}
991
992
993void SCH_IO_KICAD_SEXPR::saveSheet( SCH_SHEET* aSheet, int aNestLevel )
994{
995 wxCHECK_RET( aSheet != nullptr && m_out != nullptr, "" );
996
997 m_out->Print( aNestLevel, "(sheet (at %s %s) (size %s %s)",
999 aSheet->GetPosition().x ).c_str(),
1001 aSheet->GetPosition().y ).c_str(),
1003 aSheet->GetSize().x ).c_str(),
1005 aSheet->GetSize().y ).c_str() );
1006
1007 if( aSheet->GetFieldsAutoplaced() != FIELDS_AUTOPLACED_NO )
1008 m_out->Print( 0, " (fields_autoplaced yes)" );
1009
1010 m_out->Print( 0, "\n" );
1011
1012 STROKE_PARAMS stroke( aSheet->GetBorderWidth(), LINE_STYLE::SOLID, aSheet->GetBorderColor() );
1013
1014 stroke.SetWidth( aSheet->GetBorderWidth() );
1015 stroke.Format( m_out, schIUScale, aNestLevel + 1 );
1016
1017 m_out->Print( 0, "\n" );
1018
1019 m_out->Print( aNestLevel + 1, "(fill (color %d %d %d %0.4f))\n",
1020 KiROUND( aSheet->GetBackgroundColor().r * 255.0 ),
1021 KiROUND( aSheet->GetBackgroundColor().g * 255.0 ),
1022 KiROUND( aSheet->GetBackgroundColor().b * 255.0 ),
1023 aSheet->GetBackgroundColor().a );
1024
1026
1028
1029 for( SCH_FIELD& field : aSheet->GetFields() )
1030 {
1031 saveField( &field, aNestLevel + 1 );
1032 }
1033
1034 for( const SCH_SHEET_PIN* pin : aSheet->GetPins() )
1035 {
1036 m_out->Print( aNestLevel + 1, "(pin %s %s (at %s %s %s)\n",
1037 EscapedUTF8( pin->GetText() ).c_str(),
1038 getSheetPinShapeToken( pin->GetShape() ),
1040 pin->GetPosition().x ).c_str(),
1042 pin->GetPosition().y ).c_str(),
1043 EDA_UNIT_UTILS::FormatAngle( getSheetPinAngle( pin->GetSide() ) ).c_str() );
1044
1045 pin->Format( m_out, aNestLevel + 1, 0 );
1046
1048
1049 m_out->Print( aNestLevel + 1, ")\n" ); // Closes pin token.
1050 }
1051
1052 // Save all sheet instances here except the root sheet instance.
1053 std::vector< SCH_SHEET_INSTANCE > sheetInstances = aSheet->GetInstances();
1054
1055 auto it = sheetInstances.begin();
1056
1057 while( it != sheetInstances.end() )
1058 {
1059 if( it->m_Path.size() == 0 )
1060 it = sheetInstances.erase( it );
1061 else
1062 it++;
1063 }
1064
1065 if( !sheetInstances.empty() )
1066 {
1067 m_out->Print( aNestLevel + 1, "(instances\n" );
1068
1069 KIID lastProjectUuid;
1070 KIID rootSheetUuid = m_schematic->Root().m_Uuid;
1071 SCH_SHEET_LIST fullHierarchy = m_schematic->GetSheets();
1072 bool project_open = false;
1073
1074 for( size_t i = 0; i < sheetInstances.size(); i++ )
1075 {
1076 // If the instance data is part of this design but no longer has an associated sheet
1077 // path, don't save it. This prevents large amounts of orphaned instance data for the
1078 // current project from accumulating in the schematic files.
1079 //
1080 // Keep all instance data when copying to the clipboard. It may be needed on paste.
1081 if( ( sheetInstances[i].m_Path[0] == rootSheetUuid )
1082 && !fullHierarchy.GetSheetPathByKIIDPath( sheetInstances[i].m_Path, false ) )
1083 {
1084 if( project_open && ( ( i + 1 == sheetInstances.size() )
1085 || lastProjectUuid != sheetInstances[i+1].m_Path[0] ) )
1086 {
1087 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project` token.
1088 project_open = false;
1089 }
1090
1091 continue;
1092 }
1093
1094 if( lastProjectUuid != sheetInstances[i].m_Path[0] )
1095 {
1096 wxString projectName;
1097
1098 if( sheetInstances[i].m_Path[0] == rootSheetUuid )
1099 projectName = m_schematic->Prj().GetProjectName();
1100 else
1101 projectName = sheetInstances[i].m_ProjectName;
1102
1103 lastProjectUuid = sheetInstances[i].m_Path[0];
1104 m_out->Print( aNestLevel + 2, "(project %s\n",
1105 m_out->Quotew( projectName ).c_str() );
1106 project_open = true;
1107 }
1108
1109 wxString path = sheetInstances[i].m_Path.AsString();
1110
1111 m_out->Print( aNestLevel + 3, "(path %s (page %s))\n",
1112 m_out->Quotew( path ).c_str(),
1113 m_out->Quotew( sheetInstances[i].m_PageNumber ).c_str() );
1114
1115 if( project_open && ( ( i + 1 == sheetInstances.size() )
1116 || lastProjectUuid != sheetInstances[i+1].m_Path[0] ) )
1117 {
1118 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project` token.
1119 project_open = false;
1120 }
1121 }
1122
1123 m_out->Print( aNestLevel + 1, ")\n" ); // Closes `instances` token.
1124 }
1125
1126 m_out->Print( aNestLevel, ")\n" ); // Closes sheet token.
1127}
1128
1129
1130void SCH_IO_KICAD_SEXPR::saveJunction( SCH_JUNCTION* aJunction, int aNestLevel )
1131{
1132 wxCHECK_RET( aJunction != nullptr && m_out != nullptr, "" );
1133
1134 m_out->Print( aNestLevel, "(junction (at %s %s) (diameter %s) (color %d %d %d %s)\n",
1136 aJunction->GetPosition().x ).c_str(),
1138 aJunction->GetPosition().y ).c_str(),
1140 aJunction->GetDiameter() ).c_str(),
1141 KiROUND( aJunction->GetColor().r * 255.0 ),
1142 KiROUND( aJunction->GetColor().g * 255.0 ),
1143 KiROUND( aJunction->GetColor().b * 255.0 ),
1144 FormatDouble2Str( aJunction->GetColor().a ).c_str() );
1145
1146 KICAD_FORMAT::FormatUuid( m_out, aJunction->m_Uuid );
1147
1148 m_out->Print( aNestLevel, ")\n" );
1149}
1150
1151
1152void SCH_IO_KICAD_SEXPR::saveNoConnect( SCH_NO_CONNECT* aNoConnect, int aNestLevel )
1153{
1154 wxCHECK_RET( aNoConnect != nullptr && m_out != nullptr, "" );
1155
1156 m_out->Print( aNestLevel, "(no_connect (at %s %s)",
1158 aNoConnect->GetPosition().x ).c_str(),
1160 aNoConnect->GetPosition().y ).c_str() );
1161 KICAD_FORMAT::FormatUuid( m_out, aNoConnect->m_Uuid );
1162 m_out->Print( aNestLevel, ")\n" );
1163}
1164
1165
1167{
1168 wxCHECK_RET( aBusEntry != nullptr && m_out != nullptr, "" );
1169
1170 // Bus to bus entries are converted to bus line segments.
1171 if( aBusEntry->GetClass() == "SCH_BUS_BUS_ENTRY" )
1172 {
1173 SCH_LINE busEntryLine( aBusEntry->GetPosition(), LAYER_BUS );
1174
1175 busEntryLine.SetEndPoint( aBusEntry->GetEnd() );
1176 saveLine( &busEntryLine, aNestLevel );
1177 }
1178 else
1179 {
1180 m_out->Print( aNestLevel, "(bus_entry (at %s %s) (size %s %s)\n",
1182 aBusEntry->GetPosition().x ).c_str(),
1184 aBusEntry->GetPosition().y ).c_str(),
1186 aBusEntry->GetSize().x ).c_str(),
1188 aBusEntry->GetSize().y ).c_str() );
1189
1190 aBusEntry->GetStroke().Format( m_out, schIUScale, aNestLevel + 1 );
1191
1192 m_out->Print( 0, "\n" );
1193
1194 KICAD_FORMAT::FormatUuid( m_out, aBusEntry->m_Uuid );
1195
1196 m_out->Print( aNestLevel, ")\n" );
1197 }
1198}
1199
1200
1201void SCH_IO_KICAD_SEXPR::saveShape( SCH_SHAPE* aShape, int aNestLevel )
1202{
1203 wxCHECK_RET( aShape != nullptr && m_out != nullptr, "" );
1204
1205 switch( aShape->GetShape() )
1206 {
1207 case SHAPE_T::ARC:
1208 formatArc( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
1209 aShape->GetFillColor(), aShape->m_Uuid );
1210 break;
1211
1212 case SHAPE_T::CIRCLE:
1213 formatCircle( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
1214 aShape->GetFillColor(), aShape->m_Uuid );
1215 break;
1216
1217 case SHAPE_T::RECTANGLE:
1218 formatRect( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
1219 aShape->GetFillColor(), aShape->m_Uuid );
1220 break;
1221
1222 case SHAPE_T::BEZIER:
1223 formatBezier( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
1224 aShape->GetFillColor(), aShape->m_Uuid );
1225 break;
1226
1227 case SHAPE_T::POLY:
1228 formatPoly( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
1229 aShape->GetFillColor(), aShape->m_Uuid );
1230 break;
1231
1232 default:
1234 }
1235}
1236
1237
1238void SCH_IO_KICAD_SEXPR::saveLine( SCH_LINE* aLine, int aNestLevel )
1239{
1240 wxCHECK_RET( aLine != nullptr && m_out != nullptr, "" );
1241
1242 wxString lineType;
1243
1244 STROKE_PARAMS line_stroke = aLine->GetStroke();
1245
1246 switch( aLine->GetLayer() )
1247 {
1248 case LAYER_BUS: lineType = "bus"; break;
1249 case LAYER_WIRE: lineType = "wire"; break;
1250 case LAYER_NOTES: lineType = "polyline"; break;
1251 default:
1252 UNIMPLEMENTED_FOR( LayerName( aLine->GetLayer() ) );
1253 }
1254
1255 m_out->Print( aNestLevel, "(%s (pts (xy %s %s) (xy %s %s))\n",
1256 TO_UTF8( lineType ),
1258 aLine->GetStartPoint().x ).c_str(),
1260 aLine->GetStartPoint().y ).c_str(),
1262 aLine->GetEndPoint().x ).c_str(),
1264 aLine->GetEndPoint().y ).c_str() );
1265
1266 line_stroke.Format( m_out, schIUScale, aNestLevel + 1 );
1267 m_out->Print( 0, "\n" );
1268
1270
1271 m_out->Print( aNestLevel, ")\n" );
1272}
1273
1274
1275void SCH_IO_KICAD_SEXPR::saveText( SCH_TEXT* aText, int aNestLevel )
1276{
1277 wxCHECK_RET( aText != nullptr && m_out != nullptr, "" );
1278
1279 // Note: label is nullptr SCH_TEXT, but not for SCH_LABEL_XXX,
1280 SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( aText );
1281
1282 m_out->Print( aNestLevel, "(%s %s",
1283 getTextTypeToken( aText->Type() ),
1284 m_out->Quotew( aText->GetText() ).c_str() );
1285
1286 if( aText->Type() == SCH_TEXT_T )
1287 {
1288 m_out->Print( 0, " (exclude_from_sim %s)\n", aText->GetExcludedFromSim() ? "yes" : "no" );
1289 }
1290 else if( aText->Type() == SCH_DIRECTIVE_LABEL_T )
1291 {
1292 SCH_DIRECTIVE_LABEL* flag = static_cast<SCH_DIRECTIVE_LABEL*>( aText );
1293
1294 m_out->Print( 0, " (length %s)",
1296 flag->GetPinLength() ).c_str() );
1297 }
1298
1299 EDA_ANGLE angle = aText->GetTextAngle();
1300
1301 if( label )
1302 {
1303 if( label->Type() == SCH_GLOBAL_LABEL_T
1304 || label->Type() == SCH_HIER_LABEL_T
1305 || label->Type() == SCH_DIRECTIVE_LABEL_T )
1306 {
1307 m_out->Print( 0, " (shape %s)", getSheetPinShapeToken( label->GetShape() ) );
1308 }
1309
1310 // The angle of the text is always 0 or 90 degrees for readibility reasons,
1311 // but the item itself can have more rotation (-90 and 180 deg)
1312 switch( label->GetSpinStyle() )
1313 {
1314 default:
1315 case SPIN_STYLE::LEFT: angle += ANGLE_180; break;
1316 case SPIN_STYLE::UP: break;
1317 case SPIN_STYLE::RIGHT: break;
1318 case SPIN_STYLE::BOTTOM: angle += ANGLE_180; break;
1319 }
1320 }
1321
1322 if( aText->GetText().Length() < 50 )
1323 {
1324 m_out->Print( 0, " (at %s %s %s)",
1326 aText->GetPosition().x ).c_str(),
1328 aText->GetPosition().y ).c_str(),
1329 EDA_UNIT_UTILS::FormatAngle( angle ).c_str() );
1330 }
1331 else
1332 {
1333 m_out->Print( 0, "\n" );
1334 m_out->Print( aNestLevel + 1, "(at %s %s %s)",
1336 aText->GetPosition().x ).c_str(),
1338 aText->GetPosition().y ).c_str(),
1339 EDA_UNIT_UTILS::FormatAngle( angle ).c_str() );
1340 }
1341
1343 m_out->Print( 0, " (fields_autoplaced yes)" );
1344
1345 m_out->Print( 0, "\n" );
1346 aText->EDA_TEXT::Format( m_out, aNestLevel, 0 );
1347
1349
1350 if( label )
1351 {
1352 for( SCH_FIELD& field : label->GetFields() )
1353 saveField( &field, aNestLevel + 1 );
1354 }
1355
1356 m_out->Print( aNestLevel, ")\n" ); // Closes text token.
1357}
1358
1359
1360void SCH_IO_KICAD_SEXPR::saveTextBox( SCH_TEXTBOX* aTextBox, int aNestLevel )
1361{
1362 wxCHECK_RET( aTextBox != nullptr && m_out != nullptr, "" );
1363
1364 m_out->Print( aNestLevel, "(%s %s\n",
1365 aTextBox->Type() == SCH_TABLECELL_T ? "table_cell" : "text_box",
1366 m_out->Quotew( aTextBox->GetText() ).c_str() );
1367
1368 VECTOR2I pos = aTextBox->GetStart();
1369 VECTOR2I size = aTextBox->GetEnd() - pos;
1370
1371 m_out->Print( aNestLevel + 1, "(exclude_from_sim %s) (at %s %s %s) (size %s %s) (margins %s %s %s %s)",
1372 aTextBox->GetExcludedFromSim() ? "yes" : "no",
1375 EDA_UNIT_UTILS::FormatAngle( aTextBox->GetTextAngle() ).c_str(),
1382
1383 if( SCH_TABLECELL* cell = dynamic_cast<SCH_TABLECELL*>( aTextBox ) )
1384 m_out->Print( 0, " (span %d %d)", cell->GetColSpan(), cell->GetRowSpan() );
1385
1386 m_out->Print( 0, "\n" );
1387
1388 if( aTextBox->Type() != SCH_TABLECELL_T )
1389 {
1390 aTextBox->GetStroke().Format( m_out, schIUScale, aNestLevel + 1 );
1391 m_out->Print( 0, "\n" );
1392 }
1393
1394 formatFill( m_out, aNestLevel + 1, aTextBox->GetFillMode(), aTextBox->GetFillColor() );
1395 m_out->Print( 0, "\n" );
1396
1397 aTextBox->EDA_TEXT::Format( m_out, aNestLevel, 0 );
1398
1399 if( aTextBox->m_Uuid != niluuid )
1401
1402 m_out->Print( aNestLevel, ")\n" );
1403}
1404
1405
1406void SCH_IO_KICAD_SEXPR::saveTable( SCH_TABLE* aTable, int aNestLevel )
1407{
1408 if( aTable->GetFlags() & SKIP_STRUCT )
1409 {
1410 aTable = static_cast<SCH_TABLE*>( aTable->Clone() );
1411
1412 int minCol = aTable->GetColCount();
1413 int maxCol = -1;
1414 int minRow = aTable->GetRowCount();
1415 int maxRow = -1;
1416
1417 for( int row = 0; row < aTable->GetRowCount(); ++row )
1418 {
1419 for( int col = 0; col < aTable->GetColCount(); ++col )
1420 {
1421 SCH_TABLECELL* cell = aTable->GetCell( row, col );
1422
1423 if( cell->IsSelected() )
1424 {
1425 minRow = std::min( minRow, row );
1426 maxRow = std::max( maxRow, row );
1427 minCol = std::min( minCol, col );
1428 maxCol = std::max( maxCol, col );
1429 }
1430 else
1431 {
1432 cell->SetFlags( STRUCT_DELETED );
1433 }
1434 }
1435 }
1436
1437 wxCHECK_MSG( maxCol >= minCol && maxRow >= minRow, /*void*/, wxT( "No selected cells!" ) );
1438
1439 int destRow = 0;
1440
1441 for( int row = minRow; row <= maxRow; row++ )
1442 aTable->SetRowHeight( destRow++, aTable->GetRowHeight( row ) );
1443
1444 int destCol = 0;
1445
1446 for( int col = minCol; col <= maxCol; col++ )
1447 aTable->SetColWidth( destCol++, aTable->GetColWidth( col ) );
1448
1449 aTable->DeleteMarkedCells();
1450 aTable->SetColCount( ( maxCol - minCol ) + 1 );
1451 }
1452
1453 wxCHECK_RET( aTable != nullptr && m_out != nullptr, "" );
1454
1455 m_out->Print( aNestLevel, "(table (column_count %d)\n",
1456 aTable->GetColCount() );
1457
1458 m_out->Print( aNestLevel + 1, "(border (external %s) (header %s)",
1459 aTable->StrokeExternal() ? "yes" : "no",
1460 aTable->StrokeHeader() ? "yes" : "no" );
1461
1462 if( aTable->StrokeExternal() || aTable->StrokeHeader() )
1463 {
1464 m_out->Print( 0, " " );
1465 aTable->GetBorderStroke().Format( m_out, schIUScale, 0 );
1466 }
1467
1468 m_out->Print( 0, ")\n" );
1469
1470 m_out->Print( aNestLevel + 1, "(separators (rows %s) (cols %s)",
1471 aTable->StrokeRows() ? "yes" : "no",
1472 aTable->StrokeColumns() ? "yes" : "no" );
1473
1474 if( aTable->StrokeRows() || aTable->StrokeColumns() )
1475 {
1476 m_out->Print( 0, " " );
1477 aTable->GetSeparatorsStroke().Format( m_out, schIUScale, 0 );
1478 }
1479
1480 m_out->Print( 0, ")\n" ); // Close `separators` token.
1481
1482 m_out->Print( aNestLevel + 1, "(column_widths" );
1483
1484 for( int col = 0; col < aTable->GetColCount(); ++col )
1485 {
1486 m_out->Print( 0, " %s",
1488 aTable->GetColWidth( col ) ).c_str() );
1489 }
1490
1491 m_out->Print( 0, ")\n" );
1492
1493 m_out->Print( aNestLevel + 1, "(row_heights" );
1494
1495 for( int row = 0; row < aTable->GetRowCount(); ++row )
1496 {
1497 m_out->Print( 0, " %s",
1499 aTable->GetRowHeight( row ) ).c_str() );
1500 }
1501
1502 m_out->Print( 0, ")\n" );
1503
1504 m_out->Print( aNestLevel + 1, "(cells\n" );
1505
1506 for( SCH_TABLECELL* cell : aTable->GetCells() )
1507 saveTextBox( cell, aNestLevel + 2 );
1508
1509 m_out->Print( aNestLevel + 1, ")\n" ); // Close `cells` token.
1510 m_out->Print( aNestLevel, ")\n" ); // Close `table` token.
1511
1512 if( aTable->GetFlags() & SKIP_STRUCT )
1513 delete aTable;
1514}
1515
1516
1517void SCH_IO_KICAD_SEXPR::saveBusAlias( std::shared_ptr<BUS_ALIAS> aAlias, int aNestLevel )
1518{
1519 wxCHECK_RET( aAlias != nullptr, "BUS_ALIAS* is NULL" );
1520
1521 wxString members;
1522
1523 for( const wxString& member : aAlias->Members() )
1524 {
1525 if( !members.IsEmpty() )
1526 members += wxS( " " );
1527
1528 members += m_out->Quotew( member );
1529 }
1530
1531 m_out->Print( aNestLevel, "(bus_alias %s (members %s))\n",
1532 m_out->Quotew( aAlias->GetName() ).c_str(),
1533 TO_UTF8( members ) );
1534}
1535
1536
1537void SCH_IO_KICAD_SEXPR::saveInstances( const std::vector<SCH_SHEET_INSTANCE>& aInstances,
1538 int aNestLevel )
1539{
1540 if( aInstances.size() )
1541 {
1542 m_out->Print( 0, "\n" );
1543 m_out->Print( aNestLevel, "(sheet_instances\n" );
1544
1545 for( const SCH_SHEET_INSTANCE& instance : aInstances )
1546 {
1547 wxString path = instance.m_Path.AsString();
1548
1549 if( path.IsEmpty() )
1550 path = wxT( "/" ); // Root path
1551
1552 m_out->Print( aNestLevel + 1, "(path %s (page %s))\n",
1553 m_out->Quotew( path ).c_str(),
1554 m_out->Quotew( instance.m_PageNumber ).c_str() );
1555 }
1556
1557 m_out->Print( aNestLevel, ")\n" ); // Close sheet instances token.
1558 }
1559}
1560
1561
1562void SCH_IO_KICAD_SEXPR::cacheLib( const wxString& aLibraryFileName,
1563 const STRING_UTF8_MAP* aProperties )
1564{
1565 if( !m_cache || !m_cache->IsFile( aLibraryFileName ) || m_cache->IsFileChanged() )
1566 {
1567 // a spectacular episode in memory management:
1568 delete m_cache;
1569 m_cache = new SCH_IO_KICAD_SEXPR_LIB_CACHE( aLibraryFileName );
1570
1571 if( !isBuffering( aProperties ) )
1572 m_cache->Load();
1573 }
1574}
1575
1576
1578{
1579 return ( aProperties && aProperties->Exists( SCH_IO_KICAD_SEXPR::PropBuffering ) );
1580}
1581
1582
1584{
1585 if( m_cache )
1586 return m_cache->GetModifyHash();
1587
1588 // If the cache hasn't been loaded, it hasn't been modified.
1589 return 0;
1590}
1591
1592
1593void SCH_IO_KICAD_SEXPR::EnumerateSymbolLib( wxArrayString& aSymbolNameList,
1594 const wxString& aLibraryPath,
1595 const STRING_UTF8_MAP* aProperties )
1596{
1597 LOCALE_IO toggle; // toggles on, then off, the C locale.
1598
1599 bool powerSymbolsOnly = ( aProperties &&
1600 aProperties->find( SYMBOL_LIB_TABLE::PropPowerSymsOnly ) != aProperties->end() );
1601
1602 cacheLib( aLibraryPath, aProperties );
1603
1604 const LIB_SYMBOL_MAP& symbols = m_cache->m_symbols;
1605
1606 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
1607 {
1608 if( !powerSymbolsOnly || it->second->IsPower() )
1609 aSymbolNameList.Add( it->first );
1610 }
1611}
1612
1613
1614void SCH_IO_KICAD_SEXPR::EnumerateSymbolLib( std::vector<LIB_SYMBOL*>& aSymbolList,
1615 const wxString& aLibraryPath,
1616 const STRING_UTF8_MAP* aProperties )
1617{
1618 LOCALE_IO toggle; // toggles on, then off, the C locale.
1619
1620 bool powerSymbolsOnly = ( aProperties &&
1621 aProperties->find( SYMBOL_LIB_TABLE::PropPowerSymsOnly ) != aProperties->end() );
1622
1623 cacheLib( aLibraryPath, aProperties );
1624
1625 const LIB_SYMBOL_MAP& symbols = m_cache->m_symbols;
1626
1627 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
1628 {
1629 if( !powerSymbolsOnly || it->second->IsPower() )
1630 aSymbolList.push_back( it->second );
1631 }
1632}
1633
1634
1635LIB_SYMBOL* SCH_IO_KICAD_SEXPR::LoadSymbol( const wxString& aLibraryPath,
1636 const wxString& aSymbolName,
1637 const STRING_UTF8_MAP* aProperties )
1638{
1639 LOCALE_IO toggle; // toggles on, then off, the C locale.
1640
1641 cacheLib( aLibraryPath, aProperties );
1642
1643 LIB_SYMBOL_MAP::const_iterator it = m_cache->m_symbols.find( aSymbolName );
1644
1645 // We no longer escape '/' in symbol names, but we used to.
1646 if( it == m_cache->m_symbols.end() && aSymbolName.Contains( '/' ) )
1647 it = m_cache->m_symbols.find( EscapeString( aSymbolName, CTX_LEGACY_LIBID ) );
1648
1649 if( it == m_cache->m_symbols.end() && aSymbolName.Contains( wxT( "{slash}" ) ) )
1650 {
1651 wxString unescaped = aSymbolName;
1652 unescaped.Replace( wxT( "{slash}" ), wxT( "/" ) );
1653 it = m_cache->m_symbols.find( unescaped );
1654 }
1655
1656 if( it == m_cache->m_symbols.end() )
1657 return nullptr;
1658
1659 return it->second;
1660}
1661
1662
1663void SCH_IO_KICAD_SEXPR::SaveSymbol( const wxString& aLibraryPath, const LIB_SYMBOL* aSymbol,
1664 const STRING_UTF8_MAP* aProperties )
1665{
1666 LOCALE_IO toggle; // toggles on, then off, the C locale.
1667
1668 cacheLib( aLibraryPath, aProperties );
1669
1670 m_cache->AddSymbol( aSymbol );
1671
1672 if( !isBuffering( aProperties ) )
1673 m_cache->Save();
1674}
1675
1676
1677void SCH_IO_KICAD_SEXPR::DeleteSymbol( const wxString& aLibraryPath, const wxString& aSymbolName,
1678 const STRING_UTF8_MAP* aProperties )
1679{
1680 LOCALE_IO toggle; // toggles on, then off, the C locale.
1681
1682 cacheLib( aLibraryPath, aProperties );
1683
1684 m_cache->DeleteSymbol( aSymbolName );
1685
1686 if( !isBuffering( aProperties ) )
1687 m_cache->Save();
1688}
1689
1690
1691void SCH_IO_KICAD_SEXPR::CreateLibrary( const wxString& aLibraryPath,
1692 const STRING_UTF8_MAP* aProperties )
1693{
1694 if( wxFileExists( aLibraryPath ) )
1695 {
1696 THROW_IO_ERROR( wxString::Format( _( "Symbol library '%s' already exists." ),
1697 aLibraryPath.GetData() ) );
1698 }
1699
1700 LOCALE_IO toggle;
1701
1702 delete m_cache;
1703 m_cache = new SCH_IO_KICAD_SEXPR_LIB_CACHE( aLibraryPath );
1705 m_cache->Save();
1706 m_cache->Load(); // update m_writable and m_mod_time
1707}
1708
1709
1710bool SCH_IO_KICAD_SEXPR::DeleteLibrary( const wxString& aLibraryPath,
1711 const STRING_UTF8_MAP* aProperties )
1712{
1713 wxFileName fn = aLibraryPath;
1714
1715 if( !fn.FileExists() )
1716 return false;
1717
1718 // Some of the more elaborate wxRemoveFile() crap puts up its own wxLog dialog
1719 // we don't want that. we want bare metal portability with no UI here.
1720 if( wxRemove( aLibraryPath ) )
1721 {
1722 THROW_IO_ERROR( wxString::Format( _( "Symbol library '%s' cannot be deleted." ),
1723 aLibraryPath.GetData() ) );
1724 }
1725
1726 if( m_cache && m_cache->IsFile( aLibraryPath ) )
1727 {
1728 delete m_cache;
1729 m_cache = nullptr;
1730 }
1731
1732 return true;
1733}
1734
1735
1736void SCH_IO_KICAD_SEXPR::SaveLibrary( const wxString& aLibraryPath,
1737 const STRING_UTF8_MAP* aProperties )
1738{
1739 if( !m_cache )
1740 m_cache = new SCH_IO_KICAD_SEXPR_LIB_CACHE( aLibraryPath );
1741
1742 wxString oldFileName = m_cache->GetFileName();
1743
1744 if( !m_cache->IsFile( aLibraryPath ) )
1745 {
1746 m_cache->SetFileName( aLibraryPath );
1747 }
1748
1749 // This is a forced save.
1751 m_cache->Save();
1752 m_cache->SetFileName( oldFileName );
1753}
1754
1755
1756bool SCH_IO_KICAD_SEXPR::IsLibraryWritable( const wxString& aLibraryPath )
1757{
1758 wxFileName fn( aLibraryPath );
1759
1760 return ( fn.FileExists() && fn.IsFileWritable() ) || fn.IsDirWritable();
1761}
1762
1763
1764void SCH_IO_KICAD_SEXPR::GetAvailableSymbolFields( std::vector<wxString>& aNames )
1765{
1766 if( !m_cache )
1767 return;
1768
1769 const LIB_SYMBOL_MAP& symbols = m_cache->m_symbols;
1770
1771 std::set<wxString> fieldNames;
1772
1773 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
1774 {
1775 std::vector<LIB_FIELD*> fields;
1776 it->second->GetFields( fields );
1777
1778 for( LIB_FIELD* field : fields )
1779 {
1780 if( field->IsMandatory() )
1781 continue;
1782
1783 // TODO(JE): enable configurability of this outside database libraries?
1784 // if( field->ShowInChooser() )
1785 fieldNames.insert( field->GetName() );
1786 }
1787 }
1788
1789 std::copy( fieldNames.begin(), fieldNames.end(), std::back_inserter( aNames ) );
1790}
1791
1792
1793void SCH_IO_KICAD_SEXPR::GetDefaultSymbolFields( std::vector<wxString>& aNames )
1794{
1795 GetAvailableSymbolFields( aNames );
1796}
1797
1798
1799std::vector<LIB_SYMBOL*> SCH_IO_KICAD_SEXPR::ParseLibSymbols( std::string& aSymbolText,
1800 std::string aSource,
1801 int aFileVersion )
1802{
1803 LOCALE_IO toggle; // toggles on, then off, the C locale.
1804 LIB_SYMBOL* newSymbol = nullptr;
1805 LIB_SYMBOL_MAP map;
1806
1807 std::vector<LIB_SYMBOL*> newSymbols;
1808 std::unique_ptr<STRING_LINE_READER> reader = std::make_unique<STRING_LINE_READER>( aSymbolText,
1809 aSource );
1810
1811 do
1812 {
1813 SCH_IO_KICAD_SEXPR_PARSER parser( reader.get() );
1814
1815 newSymbol = parser.ParseSymbol( map, aFileVersion );
1816
1817 if( newSymbol )
1818 newSymbols.emplace_back( newSymbol );
1819
1820 reader.reset( new STRING_LINE_READER( *reader ) );
1821 }
1822 while( newSymbol );
1823
1824 return newSymbols;
1825}
1826
1827
1829{
1830
1831 LOCALE_IO toggle; // toggles on, then off, the C locale.
1832 SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol( symbol, formatter );
1833}
1834
1835
1836const char* SCH_IO_KICAD_SEXPR::PropBuffering = "buffering";
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:110
wxString GetMajorMinorVersion()
Get only the major and minor version in a string major.minor.
This class handle bitmap images in KiCad.
Definition: bitmap_base.h:48
double GetScale() const
Definition: bitmap_base.h:72
const wxMemoryBuffer & GetImageDataBuffer() const
Definition: bitmap_base.h:240
int GetPPI() const
Definition: bitmap_base.h:117
wxImage * GetImageData()
Definition: bitmap_base.h:67
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:126
const KIID m_Uuid
Definition: eda_item.h:485
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:100
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:128
bool IsSelected() const
Definition: eda_item.h:109
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:103
EDA_ITEM * GetParent() const
Definition: eda_item.h:102
EDA_ITEM_FLAGS GetFlags() const
Definition: eda_item.h:129
FILL_T GetFillMode() const
Definition: eda_shape.h:102
SHAPE_T GetShape() const
Definition: eda_shape.h:120
const VECTOR2I & GetEnd() const
Return the ending point of the graphic.
Definition: eda_shape.h:152
const VECTOR2I & GetStart() const
Return the starting point of the graphic.
Definition: eda_shape.h:127
COLOR4D GetFillColor() const
Definition: eda_shape.h:106
wxString SHAPE_T_asString() const
Definition: eda_shape.cpp:87
int GetTextHeight() const
Definition: eda_text.h:228
bool IsDefaultFormatting() const
Definition: eda_text.cpp:898
const EDA_ANGLE & GetTextAngle() const
Definition: eda_text.h:134
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:98
virtual void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Output the object to aFormatter in s-expression form.
Definition: eda_text.cpp:913
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:238
SCH_SCREEN * GetScreen()
Definition: ee_selection.h:52
A LINE_READER that reads from an open file.
Definition: richio.h:185
void Rewind()
Rewind the file and resets the line number back to zero.
Definition: richio.h:234
char * ReadLine() override
Read a line of text into the buffer and increments the line number counter.
Definition: richio.cpp:244
PROGRESS_REPORTER * m_progressReporter
Progress reporter to track the progress of the operation, may be nullptr.
Definition: io_base.h:210
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
double r
Red component.
Definition: color4d.h:392
double g
Green component.
Definition: color4d.h:393
double a
Alpha component.
Definition: color4d.h:395
double b
Blue component.
Definition: color4d.h:394
bool MakeRelativeTo(const KIID_PATH &aPath)
Definition: kiid.cpp:323
wxString AsString() const
Definition: kiid.cpp:368
Definition: kiid.h:49
Field object used in symbol libraries.
Definition: lib_field.h:62
UTF8 Format() const
Definition: lib_id.cpp:118
Define a library symbol object.
Definition: lib_symbol.h:79
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:93
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:49
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:322
std::string Quotew(const wxString &aWrapee) const
Definition: richio.cpp:526
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:458
void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Output the page class to aFormatter in s-expression form.
Definition: page_info.cpp:275
virtual bool KeepRefreshing(bool aWait=false)=0
Update the UI (if any).
virtual void Report(const wxString &aMessage)=0
Display aMessage in the progress bar dialog.
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:135
virtual const wxString GetProjectName() const
Return the short name of the project.
Definition: project.cpp:147
Holds all the data relating to one schematic.
Definition: schematic.h:75
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:100
bool IsValid() const
A simple test if the schematic is loaded, not a complete one.
Definition: schematic.h:121
SCH_SHEET & Root() const
Definition: schematic.h:105
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Definition: schematic.h:90
Object to handle a bitmap image that can be inserted in a schematic.
Definition: sch_bitmap.h:41
VECTOR2I GetPosition() const override
Definition: sch_bitmap.h:145
BITMAP_BASE * GetImage() const
Definition: sch_bitmap.h:54
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:38
VECTOR2I GetSize() const
Definition: sch_bus_entry.h:73
VECTOR2I GetPosition() const override
virtual STROKE_PARAMS GetStroke() const override
Definition: sch_bus_entry.h:81
VECTOR2I GetEnd() const
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:52
VECTOR2I GetPosition() const override
Definition: sch_field.cpp:1280
bool IsNameShown() const
Definition: sch_field.h:188
wxString GetCanonicalName() const
Get a non-language-specific name for a field which can be used for storage, variable look-up,...
Definition: sch_field.cpp:1043
int GetId() const
Definition: sch_field.h:129
wxString GetName(bool aUseDefaultName=true) const
Return the field name (not translated).
Definition: sch_field.cpp:1011
bool CanAutoplace() const
Definition: sch_field.h:199
void SetId(int aId)
Definition: sch_field.cpp:145
A cache assistant for the KiCad s-expression symbol libraries.
static void SaveSymbol(LIB_SYMBOL *aSymbol, OUTPUTFORMATTER &aFormatter, int aNestLevel=0, const wxString &aLibName=wxEmptyString)
void DeleteSymbol(const wxString &aName) override
void Save(const std::optional< bool > &aOpt=std::nullopt) override
Save the entire library to file m_libFileName;.
Object to parser s-expression symbol library and schematic file formats.
void ParseSchematic(SCH_SHEET *aSheet, bool aIsCopyablyOnly=false, int aFileVersion=SEXPR_SCHEMATIC_FILE_VERSION)
Parse the internal LINE_READER object into aSheet.
LIB_SYMBOL * ParseSymbol(LIB_SYMBOL_MAP &aSymbolLibMap, int aFileVersion=SEXPR_SYMBOL_LIB_FILE_VERSION)
Parse internal LINE_READER object into symbols and return all found.
wxString m_path
Root project path for loading child sheets.
void SaveSchematicFile(const wxString &aFileName, SCH_SHEET *aSheet, SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr) override
Write aSchematic to a storage file in a format that this SCH_IO implementation knows about,...
void GetDefaultSymbolFields(std::vector< wxString > &aNames) override
Retrieves a list of (custom) field names that should be shown by default for this library in the symb...
void saveBusEntry(SCH_BUS_ENTRY_BASE *aBusEntry, int aNestLevel)
void SaveLibrary(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
SCH_SHEET * LoadSchematicFile(const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const STRING_UTF8_MAP *aProperties=nullptr) override
Load information from some input file format that this SCH_IO implementation knows about,...
SCH_SHEET_PATH m_currentSheetPath
void LoadContent(LINE_READER &aReader, SCH_SHEET *aSheet, int aVersion=SEXPR_SCHEMATIC_FILE_VERSION)
void saveBitmap(SCH_BITMAP *aBitmap, int aNestLevel)
void saveText(SCH_TEXT *aText, int aNestLevel)
bool m_appending
Schematic load append status.
int m_version
Version of file being loaded.
void loadFile(const wxString &aFileName, SCH_SHEET *aSheet)
static void FormatLibSymbol(LIB_SYMBOL *aPart, OUTPUTFORMATTER &aFormatter)
void cacheLib(const wxString &aLibraryFileName, const STRING_UTF8_MAP *aProperties)
void loadHierarchy(const SCH_SHEET_PATH &aParentSheetPath, SCH_SHEET *aSheet)
static std::vector< LIB_SYMBOL * > ParseLibSymbols(std::string &aSymbolText, std::string aSource, int aFileVersion=SEXPR_SCHEMATIC_FILE_VERSION)
void SaveSymbol(const wxString &aLibraryPath, const LIB_SYMBOL *aSymbol, const STRING_UTF8_MAP *aProperties=nullptr) override
Write aSymbol to an existing library located at aLibraryPath.
void saveField(SCH_FIELD *aField, int aNestLevel)
OUTPUTFORMATTER * m_out
The formatter for saving SCH_SCREEN objects.
void saveBusAlias(std::shared_ptr< BUS_ALIAS > aAlias, int aNestLevel)
bool isBuffering(const STRING_UTF8_MAP *aProperties)
wxString m_error
For throwing exceptions or errors on partial loads.
static const char * PropBuffering
The property used internally by the plugin to enable cache buffering which prevents the library file ...
SCH_SHEET * m_rootSheet
The root sheet of the schematic being loaded.
void init(SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr)
initialize PLUGIN like a constructor would.
SCH_IO_KICAD_SEXPR_LIB_CACHE * m_cache
void Format(SCH_SHEET *aSheet)
bool IsLibraryWritable(const wxString &aLibraryPath) override
Return true if the library at aLibraryPath is writable.
void DeleteSymbol(const wxString &aLibraryPath, const wxString &aSymbolName, const STRING_UTF8_MAP *aProperties=nullptr) override
Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.
void saveNoConnect(SCH_NO_CONNECT *aNoConnect, int aNestLevel)
void saveShape(SCH_SHAPE *aShape, int aNestLevel)
int GetModifyHash() const override
Return the modification hash from the library cache.
void saveJunction(SCH_JUNCTION *aJunction, int aNestLevel)
void saveTextBox(SCH_TEXTBOX *aText, int aNestLevel)
LIB_SYMBOL * LoadSymbol(const wxString &aLibraryPath, const wxString &aAliasName, const STRING_UTF8_MAP *aProperties=nullptr) override
Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this...
void saveInstances(const std::vector< SCH_SHEET_INSTANCE > &aSheets, int aNestLevel)
bool DeleteLibrary(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Delete an existing library and returns true, or if library does not exist returns false,...
void CreateLibrary(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Create a new empty library at aLibraryPath empty.
void saveSymbol(SCH_SYMBOL *aSymbol, const SCHEMATIC &aSchematic, int aNestLevel, bool aForClipboard, const SCH_SHEET_PATH *aRelativePath=nullptr)
void saveLine(SCH_LINE *aLine, int aNestLevel)
void EnumerateSymbolLib(wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.
std::stack< wxString > m_currentPath
Stack to maintain nested sheet paths.
void saveSheet(SCH_SHEET *aSheet, int aNestLevel)
void saveTable(SCH_TABLE *aTable, int aNestLevel)
void GetAvailableSymbolFields(std::vector< wxString > &aNames) override
Retrieves a list of (custom) field names that are present on symbols in this library.
bool IsFile(const wxString &aFullPathAndFileName) const
void SetFileName(const wxString &aFileName)
virtual void AddSymbol(const LIB_SYMBOL *aSymbol)
LIB_SYMBOL_MAP m_symbols
bool IsFileChanged() const
wxString GetFileName() const
void SetModified(bool aModified=true)
Base class that schematic file and library loading and saving plugins should derive from.
Definition: sch_io.h:57
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:172
int GetBodyStyle() const
Definition: sch_item.h:238
int GetUnit() const
Definition: sch_item.h:235
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:287
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:554
wxString GetClass() const override
Return the class name.
Definition: sch_item.h:182
COLOR4D GetColor() const
Definition: sch_junction.h:119
int GetDiameter() const
Definition: sch_junction.h:114
VECTOR2I GetPosition() const override
Definition: sch_junction.h:107
SPIN_STYLE GetSpinStyle() const
Definition: sch_label.cpp:373
LABEL_FLAG_SHAPE GetShape() const
Definition: sch_label.h:170
std::vector< SCH_FIELD > & GetFields()
Definition: sch_label.h:194
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:40
virtual STROKE_PARAMS GetStroke() const override
Definition: sch_line.h:175
VECTOR2I GetEndPoint() const
Definition: sch_line.h:140
VECTOR2I GetStartPoint() const
Definition: sch_line.h:135
void SetEndPoint(const VECTOR2I &aPosition)
Definition: sch_line.h:141
VECTOR2I GetPosition() const override
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:131
auto & GetBusAliases() const
Return a set of bus aliases defined in this screen.
Definition: sch_screen.h:510
const std::map< wxString, LIB_SYMBOL * > & GetLibSymbols() const
Fetch a list of unique LIB_SYMBOL object pointers required to properly render each SCH_SYMBOL in this...
Definition: sch_screen.h:481
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:109
const wxString & GetFileName() const
Definition: sch_screen.h:144
void SetFileName(const wxString &aFileName)
Set the file name for this screen to aFileName.
Definition: sch_screen.cpp:115
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:155
KIID m_uuid
A unique identifier for each schematic file.
Definition: sch_screen.h:690
void SetFileReadOnly(bool aIsReadOnly)
Definition: sch_screen.h:146
void SetFileExists(bool aFileExists)
Definition: sch_screen.h:149
STROKE_PARAMS GetStroke() const override
Definition: sch_shape.h:65
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
std::optional< SCH_SHEET_PATH > GetSheetPathByKIIDPath(const KIID_PATH &aPath, bool aIncludeLastSheet=true) const
Finds a SCH_SHEET_PATH that matches the provided KIID_PATH.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
bool empty() const
Forwarded method from std::vector.
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
SCH_SCREEN * LastScreen()
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
void pop_back()
Forwarded method from std::vector.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:66
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:57
wxString GetFileName() const
Return the filename corresponding to this sheet.
Definition: sch_sheet.h:306
bool HasRootInstance() const
Check to see if this sheet has a root sheet instance.
Definition: sch_sheet.cpp:1358
std::vector< SCH_FIELD > & GetFields()
Definition: sch_sheet.h:93
bool SearchHierarchy(const wxString &aFilename, SCH_SCREEN **aScreen)
Search the existing hierarchy for an instance of screen loaded from aFileName.
Definition: sch_sheet.cpp:728
VECTOR2I GetSize() const
Definition: sch_sheet.h:112
SCH_SCREEN * GetScreen() const
Definition: sch_sheet.h:110
VECTOR2I GetPosition() const override
Definition: sch_sheet.h:376
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
Definition: sch_sheet.cpp:162
const SCH_SHEET_INSTANCE & GetRootInstance() const
Return the root sheet instance data.
Definition: sch_sheet.cpp:1370
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:118
int GetBorderWidth() const
Definition: sch_sheet.h:115
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition: sch_sheet.h:181
const std::vector< SCH_SHEET_INSTANCE > & GetInstances() const
Definition: sch_sheet.h:393
KIGFX::COLOR4D GetBackgroundColor() const
Definition: sch_sheet.h:121
Schematic symbol object.
Definition: sch_symbol.h:108
std::vector< std::unique_ptr< SCH_PIN > > & GetRawPins()
Definition: sch_symbol.h:632
const std::vector< SCH_SYMBOL_INSTANCE > & GetInstances() const
Definition: sch_symbol.h:167
bool UseLibIdLookup() const
Definition: sch_symbol.h:214
wxString GetSchSymbolLibraryName() const
Definition: sch_symbol.cpp:276
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:929
bool GetExcludedFromBOM() const
Definition: sch_symbol.h:837
VECTOR2I GetPosition() const override
Definition: sch_symbol.h:772
bool GetExcludedFromSim() const override
Definition: sch_symbol.h:834
const LIB_ID & GetLibId() const override
Definition: sch_symbol.h:197
bool GetInstance(SCH_SYMBOL_INSTANCE &aInstance, const KIID_PATH &aSheetPath, bool aTestFromEnd=false) const
Definition: sch_symbol.cpp:576
int GetOrientation() const
Get the display symbol orientation.
bool GetExcludedFromBoard() const
Definition: sch_symbol.h:840
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
Definition: sch_symbol.cpp:977
bool GetDNP() const
Definition: sch_symbol.h:843
void SetRowHeight(int aRow, int aHeight)
Definition: sch_table.h:121
const STROKE_PARAMS & GetSeparatorsStroke() const
Definition: sch_table.h:72
void SetColCount(int aCount)
Definition: sch_table.h:103
bool StrokeExternal() const
Definition: sch_table.h:54
int GetRowHeight(int aRow) const
Definition: sch_table.h:123
void SetColWidth(int aCol, int aWidth)
Definition: sch_table.h:111
std::vector< SCH_TABLECELL * > GetCells() const
Definition: sch_table.h:141
int GetColWidth(int aCol) const
Definition: sch_table.h:113
const STROKE_PARAMS & GetBorderStroke() const
Definition: sch_table.h:60
int GetColCount() const
Definition: sch_table.h:104
void DeleteMarkedCells()
Definition: sch_table.h:166
SCH_TABLECELL * GetCell(int aRow, int aCol) const
Definition: sch_table.h:131
bool StrokeColumns() const
Definition: sch_table.h:84
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: sch_table.h:210
bool StrokeRows() const
Definition: sch_table.h:87
int GetRowCount() const
Definition: sch_table.h:106
bool StrokeHeader() const
Definition: sch_table.h:57
int GetMarginBottom() const
Definition: sch_textbox.h:65
int GetMarginLeft() const
Definition: sch_textbox.h:62
bool GetExcludedFromSim() const override
Definition: sch_textbox.h:93
int GetMarginRight() const
Definition: sch_textbox.h:64
int GetMarginTop() const
Definition: sch_textbox.h:63
VECTOR2I GetPosition() const override
Definition: sch_text.h:132
bool GetExcludedFromSim() const override
Definition: sch_text.h:82
virtual KIGFX::VIEW_ITEM * GetItem(unsigned int aIdx) const override
Definition: selection.cpp:75
virtual unsigned int GetSize() const override
Return the number of stored items.
Definition: selection.h:99
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:253
A name/value tuple with unique names and optional values.
bool Exists(const std::string &aProperty) const
Simple container to manage line stroke parameters.
Definition: stroke_params.h:81
void SetWidth(int aWidth)
Definition: stroke_params.h:92
void Format(OUTPUTFORMATTER *out, const EDA_IU_SCALE &aIuScale, int nestLevel) const
static const char * PropPowerSymsOnly
virtual void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Output the object to aFormatter in s-expression form.
Definition: title_block.cpp:30
wxString wx_str() const
Definition: utf8.cpp:45
#define MIME_BASE64_LENGTH
#define _(s)
static constexpr EDA_ANGLE ANGLE_0
Definition: eda_angle.h:435
static constexpr EDA_ANGLE ANGLE_90
Definition: eda_angle.h:437
static constexpr EDA_ANGLE ANGLE_270
Definition: eda_angle.h:440
static constexpr EDA_ANGLE ANGLE_180
Definition: eda_angle.h:439
#define STRUCT_DELETED
flag indication structures to be erased
#define SKIP_STRUCT
flag indicating that the structure should be ignored
#define DEFAULT_SIZE_TEXT
This is the "default-of-the-default" hardcoded text size; individual application define their own def...
Definition: eda_text.h:73
const wxChar *const traceSchPlugin
Flag to enable legacy schematic plugin debug output.
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:39
KIID niluuid(0)
wxString LayerName(int aLayer)
Returns the default display name for a given layer.
Definition: layer_id.cpp:30
SCH_LAYER_ID
Eeschema drawing layers.
Definition: layer_ids.h:353
@ LAYER_WIRE
Definition: layer_ids.h:356
@ LAYER_NOTES
Definition: layer_ids.h:370
@ LAYER_BUS
Definition: layer_ids.h:357
@ SCH_LAYER_ID_START
Definition: layer_ids.h:354
#define UNIMPLEMENTED_FOR(type)
Definition: macros.h:96
KICOMMON_API std::string FormatInternalUnits(const EDA_IU_SCALE &aIuScale, int aValue)
Converts aValue from internal units to a string appropriate for writing to file.
Definition: eda_units.cpp:169
KICOMMON_API std::string FormatAngle(const EDA_ANGLE &aAngle)
Converts aAngle from board units to a string appropriate for writing to file.
Definition: eda_units.cpp:161
void FormatUuid(OUTPUTFORMATTER *aOut, const KIID &aUuid, char aSuffix)
#define SEXPR_SCHEMATIC_FILE_VERSION
Schematic file version.
void formatCircle(OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aCircle, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
void formatArc(OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aArc, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
const char * getSheetPinShapeToken(LABEL_FLAG_SHAPE aShape)
void formatFill(OUTPUTFORMATTER *aFormatter, int aNestLevel, FILL_T aFillMode, const COLOR4D &aFillColor)
Fill token formatting helper.
const char * getTextTypeToken(KICAD_T aType)
void formatRect(OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aRect, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
void formatBezier(OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aBezier, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
void formatPoly(OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aPolyLine, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
EDA_ANGLE getSheetPinAngle(SHEET_SIDE aSide)
@ FIELDS_AUTOPLACED_NO
Definition: sch_item.h:67
@ SHEET_MANDATORY_FIELDS
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:49
std::string toUTFTildaText(const wxString &txt)
Convert a wxString to UTF8 and replace any control characters with a ~, where a control character is ...
Definition: sch_symbol.cpp:57
@ SYM_ORIENT_270
Definition: sch_symbol.h:87
@ SYM_MIRROR_Y
Definition: sch_symbol.h:89
@ SYM_ORIENT_180
Definition: sch_symbol.h:86
@ SYM_MIRROR_X
Definition: sch_symbol.h:88
@ SYM_ORIENT_90
Definition: sch_symbol.h:85
const int scale
std::string FormatDouble2Str(double aValue)
Print a float number without using scientific notation and no trailing 0 This function is intended in...
std::string EscapedUTF8(const wxString &aString)
Return an 8 bit UTF8 string given aString in Unicode form.
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:391
@ CTX_LEGACY_LIBID
Definition: string_utils.h:55
constexpr int MilsToIU(int mils) const
Definition: base_units.h:93
A simple container for sheet instance information.
A simple container for schematic symbol instance information.
std::map< wxString, LIB_SYMBOL *, LibSymbolMapSort > LIB_SYMBOL_MAP
@ FOOTPRINT_FIELD
Field Name Module PCB, i.e. "16DIP300".
@ VALUE_FIELD
Field Value of part, i.e. "3.3K".
@ MANDATORY_FIELDS
The first 5 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".
wxLogTrace helper definitions.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ SCH_TABLE_T
Definition: typeinfo.h:153
@ SCH_LINE_T
Definition: typeinfo.h:148
@ SCH_NO_CONNECT_T
Definition: typeinfo.h:145
@ TYPE_NOT_INIT
Definition: typeinfo.h:81
@ SCH_SYMBOL_T
Definition: typeinfo.h:160
@ SCH_TABLECELL_T
Definition: typeinfo.h:154
@ SCH_DIRECTIVE_LABEL_T
Definition: typeinfo.h:158
@ SCH_LABEL_T
Definition: typeinfo.h:155
@ SCH_SHEET_T
Definition: typeinfo.h:162
@ SCH_MARKER_T
Definition: typeinfo.h:143
@ SCH_SHAPE_T
Definition: typeinfo.h:149
@ SCH_HIER_LABEL_T
Definition: typeinfo.h:157
@ SCH_BUS_BUS_ENTRY_T
Definition: typeinfo.h:147
@ SCH_TEXT_T
Definition: typeinfo.h:152
@ SCH_BUS_WIRE_ENTRY_T
Definition: typeinfo.h:146
@ SCH_BITMAP_T
Definition: typeinfo.h:150
@ SCH_TEXTBOX_T
Definition: typeinfo.h:151
@ SCH_GLOBAL_LABEL_T
Definition: typeinfo.h:156
@ SCH_JUNCTION_T
Definition: typeinfo.h:144
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:85