KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_sexpr_plugin.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-2023 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 <trace_helpers.h>
34#include <locale_io.h>
35#include <sch_bitmap.h>
36#include <sch_bus_entry.h>
37#include <sch_symbol.h>
38#include <sch_edit_frame.h> // SYMBOL_ORIENTATION_T
39#include <sch_junction.h>
40#include <sch_line.h>
41#include <sch_shape.h>
42#include <sch_no_connect.h>
43#include <sch_text.h>
44#include <sch_textbox.h>
45#include <sch_sheet.h>
46#include <sch_sheet_pin.h>
47#include <schematic.h>
49#include <sch_screen.h>
50#include <lib_shape.h>
51#include <lib_pin.h>
52#include <lib_text.h>
53#include <lib_textbox.h>
54#include <eeschema_id.h> // for MAX_UNIT_COUNT_PER_PACKAGE definition
55#include <sch_file_versions.h>
56#include <schematic_lexer.h>
60#include <symbol_lib_table.h> // for PropPowerSymsOnly definition.
61#include <ee_selection.h>
62#include <string_utils.h>
63#include <wx_filename.h> // for ::ResolvePossibleSymlinks()
64#include <progress_reporter.h>
65#include <boost/algorithm/string/join.hpp>
66
67using namespace TSCHEMATIC_T;
68
69
70#define SCH_PARSE_ERROR( text, reader, pos ) \
71 THROW_PARSE_ERROR( text, reader.GetSource(), reader.Line(), \
72 reader.LineNumber(), pos - reader.Line() )
73
74
76 m_progressReporter( nullptr )
77{
78 init( nullptr );
79}
80
81
83{
84 delete m_cache;
85}
86
87
88void SCH_SEXPR_PLUGIN::init( SCHEMATIC* aSchematic, const STRING_UTF8_MAP* aProperties )
89{
90 m_version = 0;
91 m_appending = false;
92 m_rootSheet = nullptr;
93 m_schematic = aSchematic;
94 m_cache = nullptr;
95 m_out = nullptr;
96 m_nextFreeFieldId = 100; // number arbitrarily > MANDATORY_FIELDS or SHEET_MANDATORY_FIELDS
97}
98
99
100SCH_SHEET* SCH_SEXPR_PLUGIN::Load( const wxString& aFileName, SCHEMATIC* aSchematic,
101 SCH_SHEET* aAppendToMe, const STRING_UTF8_MAP* aProperties )
102{
103 wxASSERT( !aFileName || aSchematic != nullptr );
104
105 LOCALE_IO toggle; // toggles on, then off, the C locale.
106 SCH_SHEET* sheet;
107
108 wxFileName fn = aFileName;
109
110 // Unfortunately child sheet file names the legacy schematic file format are not fully
111 // qualified and are always appended to the project path. The aFileName attribute must
112 // always be an absolute path so the project path can be used for load child sheet files.
113 wxASSERT( fn.IsAbsolute() );
114
115 if( aAppendToMe )
116 {
117 m_appending = true;
118 wxLogTrace( traceSchPlugin, "Append \"%s\" to sheet \"%s\".",
119 aFileName, aAppendToMe->GetFileName() );
120
121 wxFileName normedFn = aAppendToMe->GetFileName();
122
123 if( !normedFn.IsAbsolute() )
124 {
125 if( aFileName.Right( normedFn.GetFullPath().Length() ) == normedFn.GetFullPath() )
126 m_path = aFileName.Left( aFileName.Length() - normedFn.GetFullPath().Length() );
127 }
128
129 if( m_path.IsEmpty() )
130 m_path = aSchematic->Prj().GetProjectPath();
131
132 wxLogTrace( traceSchPlugin, "Normalized append path \"%s\".", m_path );
133 }
134 else
135 {
136 m_path = aSchematic->Prj().GetProjectPath();
137 }
138
139 m_currentPath.push( m_path );
140 init( aSchematic, aProperties );
141
142 if( aAppendToMe == nullptr )
143 {
144 // Clean up any allocated memory if an exception occurs loading the schematic.
145 std::unique_ptr<SCH_SHEET> newSheet = std::make_unique<SCH_SHEET>( aSchematic );
146
147 wxFileName relPath( aFileName );
148
149 // Do not use wxPATH_UNIX as option in MakeRelativeTo(). It can create incorrect
150 // relative paths on Windows, because paths have a disk identifier (C:, D: ...)
151 relPath.MakeRelativeTo( aSchematic->Prj().GetProjectPath() );
152
153 newSheet->SetFileName( relPath.GetFullPath() );
154 m_rootSheet = newSheet.get();
155 loadHierarchy( SCH_SHEET_PATH(), newSheet.get() );
156
157 // If we got here, the schematic loaded successfully.
158 sheet = newSheet.release();
159 m_rootSheet = nullptr; // Quiet Coverity warning.
160 }
161 else
162 {
163 wxCHECK_MSG( aSchematic->IsValid(), nullptr, "Can't append to a schematic with no root!" );
164 m_rootSheet = &aSchematic->Root();
165 sheet = aAppendToMe;
166 loadHierarchy( SCH_SHEET_PATH(), sheet );
167 }
168
169 wxASSERT( m_currentPath.size() == 1 ); // only the project path should remain
170
171 m_currentPath.pop(); // Clear the path stack for next call to Load
172
173 return sheet;
174}
175
176
177// Everything below this comment is recursive. Modify with care.
178
179void SCH_SEXPR_PLUGIN::loadHierarchy( const SCH_SHEET_PATH& aParentSheetPath, SCH_SHEET* aSheet )
180{
182
183 SCH_SCREEN* screen = nullptr;
184
185 if( !aSheet->GetScreen() )
186 {
187 // SCH_SCREEN objects store the full path and file name where the SCH_SHEET object only
188 // stores the file name and extension. Add the project path to the file name and
189 // extension to compare when calling SCH_SHEET::SearchHierarchy().
190 wxFileName fileName = aSheet->GetFileName();
191
192 if( !fileName.IsAbsolute() )
193 fileName.MakeAbsolute( m_currentPath.top() );
194
195 // Save the current path so that it gets restored when descending and ascending the
196 // sheet hierarchy which allows for sheet schematic files to be nested in folders
197 // relative to the last path a schematic was loaded from.
198 wxLogTrace( traceSchPlugin, "Saving path '%s'", m_currentPath.top() );
199 m_currentPath.push( fileName.GetPath() );
200 wxLogTrace( traceSchPlugin, "Current path '%s'", m_currentPath.top() );
201 wxLogTrace( traceSchPlugin, "Loading '%s'", fileName.GetFullPath() );
202
203 SCH_SHEET_PATH ancestorSheetPath = aParentSheetPath;
204
205 while( !ancestorSheetPath.empty() )
206 {
207 if( ancestorSheetPath.LastScreen()->GetFileName() == fileName.GetFullPath() )
208 {
209 if( !m_error.IsEmpty() )
210 m_error += "\n";
211
212 m_error += wxString::Format( _( "Could not load sheet '%s' because it already "
213 "appears as a direct ancestor in the schematic "
214 "hierarchy." ),
215 fileName.GetFullPath() );
216
217 fileName = wxEmptyString;
218
219 break;
220 }
221
222 ancestorSheetPath.pop_back();
223 }
224
225 if( ancestorSheetPath.empty() )
226 {
227 // Existing schematics could be either in the root sheet path or the current sheet
228 // load path so we have to check both.
229 if( !m_rootSheet->SearchHierarchy( fileName.GetFullPath(), &screen ) )
230 m_currentSheetPath.at( 0 )->SearchHierarchy( fileName.GetFullPath(), &screen );
231 }
232
233 if( screen )
234 {
235 aSheet->SetScreen( screen );
236 aSheet->GetScreen()->SetParent( m_schematic );
237 // Do not need to load the sub-sheets - this has already been done.
238 }
239 else
240 {
241 aSheet->SetScreen( new SCH_SCREEN( m_schematic ) );
242 aSheet->GetScreen()->SetFileName( fileName.GetFullPath() );
243
244 try
245 {
246 loadFile( fileName.GetFullPath(), aSheet );
247 }
248 catch( const IO_ERROR& ioe )
249 {
250 // If there is a problem loading the root sheet, there is no recovery.
251 if( aSheet == m_rootSheet )
252 throw;
253
254 // For all subsheets, queue up the error message for the caller.
255 if( !m_error.IsEmpty() )
256 m_error += "\n";
257
258 m_error += ioe.What();
259 }
260
261 if( fileName.FileExists() )
262 {
263 aSheet->GetScreen()->SetFileReadOnly( !fileName.IsFileWritable() );
264 aSheet->GetScreen()->SetFileExists( true );
265 }
266 else
267 {
268 aSheet->GetScreen()->SetFileReadOnly( !fileName.IsDirWritable() );
269 aSheet->GetScreen()->SetFileExists( false );
270 }
271
272 SCH_SHEET_PATH currentSheetPath = aParentSheetPath;
273 currentSheetPath.push_back( aSheet );
274
275 // This was moved out of the try{} block so that any sheet definitions that
276 // the plugin fully parsed before the exception was raised will be loaded.
277 for( SCH_ITEM* aItem : aSheet->GetScreen()->Items().OfType( SCH_SHEET_T ) )
278 {
279 wxCHECK2( aItem->Type() == SCH_SHEET_T, /* do nothing */ );
280 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( aItem );
281
282 // Recursion starts here.
283 loadHierarchy( currentSheetPath, sheet );
284 }
285 }
286
287 m_currentPath.pop();
288 wxLogTrace( traceSchPlugin, "Restoring path \"%s\"", m_currentPath.top() );
289 }
290
292}
293
294
295void SCH_SEXPR_PLUGIN::loadFile( const wxString& aFileName, SCH_SHEET* aSheet )
296{
297 FILE_LINE_READER reader( aFileName );
298
299 size_t lineCount = 0;
300
302 {
303 m_progressReporter->Report( wxString::Format( _( "Loading %s..." ), aFileName ) );
304
306 THROW_IO_ERROR( ( "Open cancelled by user." ) );
307
308 while( reader.ReadLine() )
309 lineCount++;
310
311 reader.Rewind();
312 }
313
314 SCH_SEXPR_PARSER parser( &reader, m_progressReporter, lineCount, m_rootSheet, m_appending );
315
316 parser.ParseSchematic( aSheet );
317}
318
319
320void SCH_SEXPR_PLUGIN::LoadContent( LINE_READER& aReader, SCH_SHEET* aSheet, int aFileVersion )
321{
322 wxCHECK( aSheet, /* void */ );
323
324 LOCALE_IO toggle;
325 SCH_SEXPR_PARSER parser( &aReader );
326
327 parser.ParseSchematic( aSheet, true, aFileVersion );
328}
329
330
331void SCH_SEXPR_PLUGIN::Save( const wxString& aFileName, SCH_SHEET* aSheet, SCHEMATIC* aSchematic,
332 const STRING_UTF8_MAP* aProperties )
333{
334 wxCHECK_RET( aSheet != nullptr, "NULL SCH_SHEET object." );
335 wxCHECK_RET( !aFileName.IsEmpty(), "No schematic file name defined." );
336
337 LOCALE_IO toggle; // toggles on, then off, the C locale, to write floating point values.
338
339 init( aSchematic, aProperties );
340
341 wxFileName fn = aFileName;
342
343 // File names should be absolute. Don't assume everything relative to the project path
344 // works properly.
345 wxASSERT( fn.IsAbsolute() );
346
347 FILE_OUTPUTFORMATTER formatter( fn.GetFullPath() );
348
349 m_out = &formatter; // no ownership
350
351 Format( aSheet );
352
353 if( aSheet->GetScreen() )
354 aSheet->GetScreen()->SetFileExists( true );
355}
356
357
359{
360 wxCHECK_RET( aSheet != nullptr, "NULL SCH_SHEET* object." );
361 wxCHECK_RET( m_schematic != nullptr, "NULL SCHEMATIC* object." );
362
363 SCH_SCREEN* screen = aSheet->GetScreen();
364
365 wxCHECK( screen, /* void */ );
366
367 m_out->Print( 0, "(kicad_sch (version %d) (generator eeschema)\n\n",
369
370 m_out->Print( 1, "(uuid %s)\n\n", TO_UTF8( screen->m_uuid.AsString() ) );
371
372 screen->GetPageSettings().Format( m_out, 1, 0 );
373 m_out->Print( 0, "\n" );
374 screen->GetTitleBlock().Format( m_out, 1, 0 );
375
376 // Save cache library.
377 m_out->Print( 1, "(lib_symbols\n" );
378
379 for( std::pair<const wxString, LIB_SYMBOL*>& libSymbol : screen->GetLibSymbols() )
380 SCH_SEXPR_PLUGIN_CACHE::SaveSymbol( libSymbol.second, *m_out, 2, libSymbol.first );
381
382 m_out->Print( 1, ")\n\n" );
383
384 for( const std::shared_ptr<BUS_ALIAS>& alias : screen->GetBusAliases() )
385 saveBusAlias( alias, 1 );
386
387 // Enforce item ordering
388 auto cmp =
389 []( const SCH_ITEM* a, const SCH_ITEM* b )
390 {
391 if( a->Type() != b->Type() )
392 return a->Type() < b->Type();
393
394 return a->m_Uuid < b->m_Uuid;
395 };
396
397 std::multiset<SCH_ITEM*, decltype( cmp )> save_map( cmp );
398
399 for( SCH_ITEM* item : screen->Items() )
400 {
401 // Markers are not saved, so keep them from being considered below
402 if( item->Type() != SCH_MARKER_T )
403 save_map.insert( item );
404 }
405
406 KICAD_T itemType = TYPE_NOT_INIT;
408
409 for( SCH_ITEM* item : save_map )
410 {
411 if( itemType != item->Type() )
412 {
413 itemType = item->Type();
414
415 if( itemType != SCH_SYMBOL_T
416 && itemType != SCH_JUNCTION_T
417 && itemType != SCH_SHEET_T )
418 {
419 m_out->Print( 0, "\n" );
420 }
421 }
422
423 switch( item->Type() )
424 {
425 case SCH_SYMBOL_T:
426 m_out->Print( 0, "\n" );
427 saveSymbol( static_cast<SCH_SYMBOL*>( item ), *m_schematic, 1, false );
428 break;
429
430 case SCH_BITMAP_T:
431 saveBitmap( static_cast<SCH_BITMAP*>( item ), 1 );
432 break;
433
434 case SCH_SHEET_T:
435 m_out->Print( 0, "\n" );
436 saveSheet( static_cast<SCH_SHEET*>( item ), 1 );
437 break;
438
439 case SCH_JUNCTION_T:
440 saveJunction( static_cast<SCH_JUNCTION*>( item ), 1 );
441 break;
442
443 case SCH_NO_CONNECT_T:
444 saveNoConnect( static_cast<SCH_NO_CONNECT*>( item ), 1 );
445 break;
446
449 saveBusEntry( static_cast<SCH_BUS_ENTRY_BASE*>( item ), 1 );
450 break;
451
452 case SCH_LINE_T:
453 if( layer != item->GetLayer() )
454 {
455 if( layer == SCH_LAYER_ID_START )
456 {
457 layer = item->GetLayer();
458 }
459 else
460 {
461 layer = item->GetLayer();
462 m_out->Print( 0, "\n" );
463 }
464 }
465
466 saveLine( static_cast<SCH_LINE*>( item ), 1 );
467 break;
468
469 case SCH_SHAPE_T:
470 saveShape( static_cast<SCH_SHAPE*>( item ), 1 );
471 break;
472
473 case SCH_TEXT_T:
474 case SCH_LABEL_T:
476 case SCH_HIER_LABEL_T:
478 saveText( static_cast<SCH_TEXT*>( item ), 1 );
479 break;
480
481 case SCH_TEXTBOX_T:
482 saveTextBox( static_cast<SCH_TEXTBOX*>( item ), 1 );
483 break;
484
485 default:
486 wxASSERT( "Unexpected schematic object type in SCH_SEXPR_PLUGIN::Format()" );
487 }
488 }
489
490 if( aSheet->HasRootInstance() )
491 {
492 std::vector< SCH_SHEET_INSTANCE> instances;
493
494 instances.emplace_back( aSheet->GetRootInstance() );
495 saveInstances( instances, 1 );
496 }
497
498 m_out->Print( 0, ")\n" );
499}
500
501
502void SCH_SEXPR_PLUGIN::Format( EE_SELECTION* aSelection, SCH_SHEET_PATH* aSelectionPath,
503 SCHEMATIC& aSchematic, OUTPUTFORMATTER* aFormatter,
504 bool aForClipboard )
505{
506 wxCHECK( aSelection && aSelectionPath && aFormatter, /* void */ );
507
508 LOCALE_IO toggle;
509 SCH_SHEET_LIST fullHierarchy = aSchematic.GetSheets();
510
511 m_schematic = &aSchematic;
512 m_out = aFormatter;
513
514 size_t i;
515 SCH_ITEM* item;
516 std::map<wxString, LIB_SYMBOL*> libSymbols;
517 SCH_SCREEN* screen = aSelection->GetScreen();
518
519 for( i = 0; i < aSelection->GetSize(); ++i )
520 {
521 item = dynamic_cast<SCH_ITEM*>( aSelection->GetItem( i ) );
522
523 wxCHECK2( item, continue );
524
525 if( item->Type() != SCH_SYMBOL_T )
526 continue;
527
528 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( item );
529
530 wxCHECK2( symbol, continue );
531
532 wxString libSymbolLookup = symbol->GetLibId().Format().wx_str();
533
534 if( !symbol->UseLibIdLookup() )
535 libSymbolLookup = symbol->GetSchSymbolLibraryName();
536
537 auto it = screen->GetLibSymbols().find( libSymbolLookup );
538
539 if( it != screen->GetLibSymbols().end() )
540 libSymbols[ libSymbolLookup ] = it->second;
541 }
542
543 if( !libSymbols.empty() )
544 {
545 m_out->Print( 0, "(lib_symbols\n" );
546
547 for( const std::pair<const wxString, LIB_SYMBOL*>& libSymbol : libSymbols )
548 SCH_SEXPR_PLUGIN_CACHE::SaveSymbol( libSymbol.second, *m_out, 1, libSymbol.first );
549
550 m_out->Print( 0, ")\n\n" );
551 }
552
553 // Store the selected sheets instance information
554 SCH_SHEET_LIST selectedSheets;
555 SCH_REFERENCE_LIST selectedSymbols;
556
557 for( i = 0; i < aSelection->GetSize(); ++i )
558 {
559 item = (SCH_ITEM*) aSelection->GetItem( i );
560
561 switch( item->Type() )
562 {
563 case SCH_SYMBOL_T:
564 saveSymbol( static_cast<SCH_SYMBOL*>( item ), aSchematic, 0, aForClipboard );
565
566 aSelectionPath->AppendSymbol( selectedSymbols, static_cast<SCH_SYMBOL*>( item ),
567 true, true );
568 break;
569
570 case SCH_BITMAP_T:
571 saveBitmap( static_cast< SCH_BITMAP* >( item ), 0 );
572 break;
573
574 case SCH_SHEET_T:
575 saveSheet( static_cast< SCH_SHEET* >( item ), 0 );
576
577 {
578 SCH_SHEET_PATH subSheetPath = *aSelectionPath;
579 subSheetPath.push_back( static_cast<SCH_SHEET*>( item ) );
580
581 fullHierarchy.GetSheetsWithinPath( selectedSheets, subSheetPath );
582 fullHierarchy.GetSymbolsWithinPath( selectedSymbols, subSheetPath, true, true );
583 }
584
585 break;
586
587 case SCH_JUNCTION_T:
588 saveJunction( static_cast< SCH_JUNCTION* >( item ), 0 );
589 break;
590
591 case SCH_NO_CONNECT_T:
592 saveNoConnect( static_cast< SCH_NO_CONNECT* >( item ), 0 );
593 break;
594
597 saveBusEntry( static_cast< SCH_BUS_ENTRY_BASE* >( item ), 0 );
598 break;
599
600 case SCH_LINE_T:
601 saveLine( static_cast< SCH_LINE* >( item ), 0 );
602 break;
603
604 case SCH_SHAPE_T:
605 saveShape( static_cast<SCH_SHAPE*>( item ), 0 );
606 break;
607
608 case SCH_TEXT_T:
609 case SCH_LABEL_T:
611 case SCH_HIER_LABEL_T:
613 saveText( static_cast<SCH_TEXT*>( item ), 0 );
614 break;
615
616 case SCH_TEXTBOX_T:
617 saveTextBox( static_cast<SCH_TEXTBOX*>( item ), 0 );
618 break;
619
620 default:
621 wxASSERT( "Unexpected schematic object type in SCH_SEXPR_PLUGIN::Format()" );
622 }
623 }
624
625 // Make all instance information relative to the selection path
626 KIID_PATH selectionPath = aSelectionPath->Path();
627
628 selectedSheets.SortByPageNumbers();
629 std::vector<SCH_SHEET_INSTANCE> sheetinstances = selectedSheets.GetSheetInstances();
630
631 for( SCH_SHEET_INSTANCE& sheetInstance : sheetinstances )
632 {
633 wxASSERT_MSG( sheetInstance.m_Path.MakeRelativeTo( selectionPath ),
634 "Sheet is not inside the selection path?" );
635 }
636
637 selectionPath = aSelectionPath->Path();
638 selectedSymbols.SortByReferenceOnly();
639 std::vector<SCH_SYMBOL_INSTANCE> symbolInstances = selectedSymbols.GetSymbolInstances();
640
641 for( SCH_SYMBOL_INSTANCE& symbolInstance : symbolInstances )
642 {
643 wxASSERT_MSG( symbolInstance.m_Path.MakeRelativeTo( selectionPath ),
644 "Symbol is not inside the selection path?" );
645 }
646}
647
648
649void SCH_SEXPR_PLUGIN::saveSymbol( SCH_SYMBOL* aSymbol, const SCHEMATIC& aSchematic,
650 int aNestLevel, bool aForClipboard )
651{
652 wxCHECK_RET( aSymbol != nullptr && m_out != nullptr, "" );
653
654 // Sort symbol instance data to minimize file churn.
656
657 std::string libName;
658
659 wxString symbol_name = aSymbol->GetLibId().Format();
660
661 if( symbol_name.size() )
662 {
663 libName = toUTFTildaText( symbol_name );
664 }
665 else
666 {
667 libName = "_NONAME_";
668 }
669
670 EDA_ANGLE angle;
671 int orientation = aSymbol->GetOrientation() & ~( SYM_MIRROR_X | SYM_MIRROR_Y );
672
673 if( orientation == SYM_ORIENT_90 )
674 angle = ANGLE_90;
675 else if( orientation == SYM_ORIENT_180 )
676 angle = ANGLE_180;
677 else if( orientation == SYM_ORIENT_270 )
678 angle = ANGLE_270;
679 else
680 angle = ANGLE_0;
681
682 m_out->Print( aNestLevel, "(symbol" );
683
684 if( !aSymbol->UseLibIdLookup() )
685 {
686 m_out->Print( 0, " (lib_name %s)",
687 m_out->Quotew( aSymbol->GetSchSymbolLibraryName() ).c_str() );
688 }
689
690 m_out->Print( 0, " (lib_id %s) (at %s %s %s)",
691 m_out->Quotew( aSymbol->GetLibId().Format().wx_str() ).c_str(),
693 aSymbol->GetPosition().x ).c_str(),
695 aSymbol->GetPosition().y ).c_str(),
696 EDA_UNIT_UTILS::FormatAngle( angle ).c_str() );
697
698 bool mirrorX = aSymbol->GetOrientation() & SYM_MIRROR_X;
699 bool mirrorY = aSymbol->GetOrientation() & SYM_MIRROR_Y;
700
701 if( mirrorX || mirrorY )
702 {
703 m_out->Print( 0, " (mirror" );
704
705 if( mirrorX )
706 m_out->Print( 0, " x" );
707
708 if( mirrorY )
709 m_out->Print( 0, " y" );
710
711 m_out->Print( 0, ")" );
712 }
713
714 // The symbol unit is always set to the first instance regardless of the current sheet
715 // instance to prevent file churn.
716 int unit = ( aSymbol->GetInstanceReferences().size() == 0 ) ?
717 aSymbol->GetUnit() :
718 aSymbol->GetInstanceReferences()[0].m_Unit;
719
720 m_out->Print( 0, " (unit %d)", unit );
721
723 m_out->Print( 0, " (convert %d)", aSymbol->GetConvert() );
724
725 m_out->Print( 0, "\n" );
726
727 m_out->Print( aNestLevel + 1, "(in_bom %s)", ( aSymbol->GetIncludeInBom() ) ? "yes" : "no" );
728 m_out->Print( 0, " (on_board %s)", ( aSymbol->GetIncludeOnBoard() ) ? "yes" : "no" );
729 m_out->Print( 0, " (dnp %s)", ( aSymbol->GetDNP() ) ? "yes" : "no" );
730
731 if( aSymbol->GetFieldsAutoplaced() != FIELDS_AUTOPLACED_NO )
732 m_out->Print( 0, " (fields_autoplaced)" );
733
734 m_out->Print( 0, "\n" );
735
736 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aSymbol->m_Uuid.AsString() ) );
737
739
740 for( SCH_FIELD& field : aSymbol->GetFields() )
741 {
742 int id = field.GetId();
743 wxString value = field.GetText();
744
745 if( !aForClipboard && aSymbol->GetInstanceReferences().size() )
746 {
747 // The instance fields are always set to the default instance regardless of the
748 // sheet instance to prevent file churn.
749 if( id == REFERENCE_FIELD )
750 {
751 field.SetText( aSymbol->GetInstanceReferences()[0].m_Reference );
752 }
753 else if( id == VALUE_FIELD )
754 {
755 field.SetText( aSymbol->GetField( VALUE_FIELD )->GetText() );
756 }
757 else if( id == FOOTPRINT_FIELD )
758 {
759 field.SetText( aSymbol->GetField( FOOTPRINT_FIELD )->GetText() );
760 }
761 }
762
763 try
764 {
765 saveField( &field, aNestLevel + 1 );
766 }
767 catch( ... )
768 {
769 // Restore the changed field text on write error.
770 if( id == REFERENCE_FIELD || id == VALUE_FIELD || id == FOOTPRINT_FIELD )
771 field.SetText( value );
772
773 throw;
774 }
775
776 if( id == REFERENCE_FIELD || id == VALUE_FIELD || id == FOOTPRINT_FIELD )
777 field.SetText( value );
778 }
779
780 for( const std::unique_ptr<SCH_PIN>& pin : aSymbol->GetRawPins() )
781 {
782 if( pin->GetAlt().IsEmpty() )
783 {
784 m_out->Print( aNestLevel + 1, "(pin %s (uuid %s))\n",
785 m_out->Quotew( pin->GetNumber() ).c_str(),
786 TO_UTF8( pin->m_Uuid.AsString() ) );
787 }
788 else
789 {
790 m_out->Print( aNestLevel + 1, "(pin %s (uuid %s) (alternate %s))\n",
791 m_out->Quotew( pin->GetNumber() ).c_str(),
792 TO_UTF8( pin->m_Uuid.AsString() ),
793 m_out->Quotew( pin->GetAlt() ).c_str() );
794 }
795 }
796
797 if( !aSymbol->GetInstanceReferences().empty() )
798 {
799 m_out->Print( aNestLevel + 1, "(instances\n" );
800
801 KIID lastProjectUuid;
802 KIID rootSheetUuid = aSchematic.Root().m_Uuid;
803 SCH_SHEET_LIST fullHierarchy = aSchematic.GetSheets();
804 bool project_open = false;
805
806 for( size_t i = 0; i < aSymbol->GetInstanceReferences().size(); i++ )
807 {
808 // If the instance data is part of this design but no longer has an associated sheet
809 // path, don't save it. This prevents large amounts of orphaned instance data for the
810 // current project from accumulating in the schematic files.
811 //
812 // Keep all instance data when copying to the clipboard. It may be needed on paste.
813 if( !aForClipboard
814 && ( aSymbol->GetInstanceReferences()[i].m_Path[0] == rootSheetUuid )
815 && !fullHierarchy.GetSheetPathByKIIDPath( aSymbol->GetInstanceReferences()[i].m_Path ) )
816 {
817 if( project_open && ( ( i + 1 == aSymbol->GetInstanceReferences().size() )
818 || lastProjectUuid != aSymbol->GetInstanceReferences()[i+1].m_Path[0] ) )
819 {
820 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project`.
821 project_open = false;
822 }
823
824 continue;
825 }
826
827 if( lastProjectUuid != aSymbol->GetInstanceReferences()[i].m_Path[0] )
828 {
829 wxString projectName;
830
831 if( aSymbol->GetInstanceReferences()[i].m_Path[0] == rootSheetUuid )
832 projectName = aSchematic.Prj().GetProjectName();
833 else
834 projectName = aSymbol->GetInstanceReferences()[i].m_ProjectName;
835
836 lastProjectUuid = aSymbol->GetInstanceReferences()[i].m_Path[0];
837 m_out->Print( aNestLevel + 2, "(project %s\n",
838 m_out->Quotew( projectName ).c_str() );
839 project_open = true;
840 }
841
842 wxString path = aSymbol->GetInstanceReferences()[i].m_Path.AsString();
843
844 m_out->Print( aNestLevel + 3, "(path %s\n",
845 m_out->Quotew( path ).c_str() );
846 m_out->Print( aNestLevel + 4, "(reference %s) (unit %d)\n",
847 m_out->Quotew( aSymbol->GetInstanceReferences()[i].m_Reference ).c_str(),
848 aSymbol->GetInstanceReferences()[i].m_Unit );
849 m_out->Print( aNestLevel + 3, ")\n" );
850
851 if( project_open && ( ( i + 1 == aSymbol->GetInstanceReferences().size() )
852 || lastProjectUuid != aSymbol->GetInstanceReferences()[i+1].m_Path[0] ) )
853 {
854 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project`.
855 project_open = false;
856 }
857 }
858
859 m_out->Print( aNestLevel + 1, ")\n" ); // Closes `instances`.
860 }
861
862 m_out->Print( aNestLevel, ")\n" ); // Closes `symbol`.
863}
864
865
866void SCH_SEXPR_PLUGIN::saveField( SCH_FIELD* aField, int aNestLevel )
867{
868 wxCHECK_RET( aField != nullptr && m_out != nullptr, "" );
869
870 wxString fieldName = aField->GetCanonicalName();
871 // For some reason (bug in legacy parser?) the field ID for non-mandatory fields is -1 so
872 // check for this in order to correctly use the field name.
873
874 if( aField->GetId() == -1 /* undefined ID */ )
875 {
876 aField->SetId( m_nextFreeFieldId );
878 }
879 else if( aField->GetId() >= m_nextFreeFieldId )
880 {
881 m_nextFreeFieldId = aField->GetId() + 1;
882 }
883
884 m_out->Print( aNestLevel, "(property %s %s (at %s %s %s)",
885 m_out->Quotew( fieldName ).c_str(),
886 m_out->Quotew( aField->GetText() ).c_str(),
888 aField->GetPosition().x ).c_str(),
890 aField->GetPosition().y ).c_str(),
891 EDA_UNIT_UTILS::FormatAngle( aField->GetTextAngle() ).c_str() );
892
893 if( aField->IsNameShown() )
894 m_out->Print( 0, " (show_name)" );
895
896 if( !aField->CanAutoplace() )
897 m_out->Print( 0, " (do_not_autoplace)" );
898
899 if( !aField->IsDefaultFormatting()
900 || ( aField->GetTextHeight() != schIUScale.MilsToIU( DEFAULT_SIZE_TEXT ) ) )
901 {
902 m_out->Print( 0, "\n" );
903 aField->Format( m_out, aNestLevel, 0 );
904 m_out->Print( aNestLevel, ")\n" ); // Closes property token with font effects.
905 }
906 else
907 {
908 m_out->Print( 0, ")\n" ); // Closes property token without font effects.
909 }
910}
911
912
913void SCH_SEXPR_PLUGIN::saveBitmap( SCH_BITMAP* aBitmap, int aNestLevel )
914{
915 wxCHECK_RET( aBitmap != nullptr && m_out != nullptr, "" );
916
917 const wxImage* image = aBitmap->GetImage()->GetImageData();
918
919 wxCHECK_RET( image != nullptr, "wxImage* is NULL" );
920
921 m_out->Print( aNestLevel, "(image (at %s %s)",
923 aBitmap->GetPosition().x ).c_str(),
925 aBitmap->GetPosition().y ).c_str() );
926
927 double scale = aBitmap->GetImage()->GetScale();
928
929 // 20230121 or older file format versions assumed 300 image PPI at load/save.
930 // Let's keep compatibility by changing image scale.
931 if( SEXPR_SCHEMATIC_FILE_VERSION <= 20230121 )
932 {
933 BITMAP_BASE* bm_image = aBitmap->GetImage();
934 scale = scale * 300.0 / bm_image->GetPPI();
935 }
936
937 if( scale != 1.0 )
938 m_out->Print( 0, " (scale %g)", scale );
939
940 m_out->Print( 0, "\n" );
941
942 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aBitmap->m_Uuid.AsString() ) );
943
944 m_out->Print( aNestLevel + 1, "(data" );
945
946 wxMemoryOutputStream stream;
947
948 image->SaveFile( stream, wxBITMAP_TYPE_PNG );
949
950 // Write binary data in hexadecimal form (ASCII)
951 wxStreamBuffer* buffer = stream.GetOutputStreamBuffer();
952 wxString out = wxBase64Encode( buffer->GetBufferStart(), buffer->GetBufferSize() );
953
954 // Apparently the MIME standard character width for base64 encoding is 76 (unconfirmed)
955 // so use it in a vein attempt to be standard like.
956#define MIME_BASE64_LENGTH 76
957
958 size_t first = 0;
959
960 while( first < out.Length() )
961 {
962 m_out->Print( 0, "\n" );
963 m_out->Print( aNestLevel + 2, "%s", TO_UTF8( out( first, MIME_BASE64_LENGTH ) ) );
964 first += MIME_BASE64_LENGTH;
965 }
966
967 m_out->Print( 0, "\n" );
968 m_out->Print( aNestLevel + 1, ")\n" ); // Closes data token.
969 m_out->Print( aNestLevel, ")\n" ); // Closes image token.
970}
971
972
973void SCH_SEXPR_PLUGIN::saveSheet( SCH_SHEET* aSheet, int aNestLevel )
974{
975 wxCHECK_RET( aSheet != nullptr && m_out != nullptr, "" );
976
977 m_out->Print( aNestLevel, "(sheet (at %s %s) (size %s %s)",
979 aSheet->GetPosition().x ).c_str(),
981 aSheet->GetPosition().y ).c_str(),
983 aSheet->GetSize().x ).c_str(),
985 aSheet->GetSize().y ).c_str() );
986
988 m_out->Print( 0, " (fields_autoplaced)" );
989
990 m_out->Print( 0, "\n" );
991
992 STROKE_PARAMS stroke( aSheet->GetBorderWidth(), PLOT_DASH_TYPE::SOLID,
993 aSheet->GetBorderColor() );
994
995 stroke.SetWidth( aSheet->GetBorderWidth() );
996 stroke.Format( m_out, schIUScale, aNestLevel + 1 );
997
998 m_out->Print( 0, "\n" );
999
1000 m_out->Print( aNestLevel + 1, "(fill (color %d %d %d %0.4f))\n",
1001 KiROUND( aSheet->GetBackgroundColor().r * 255.0 ),
1002 KiROUND( aSheet->GetBackgroundColor().g * 255.0 ),
1003 KiROUND( aSheet->GetBackgroundColor().b * 255.0 ),
1004 aSheet->GetBackgroundColor().a );
1005
1006 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aSheet->m_Uuid.AsString() ) );
1007
1009
1010 for( SCH_FIELD& field : aSheet->GetFields() )
1011 {
1012 saveField( &field, aNestLevel + 1 );
1013 }
1014
1015 for( const SCH_SHEET_PIN* pin : aSheet->GetPins() )
1016 {
1017 m_out->Print( aNestLevel + 1, "(pin %s %s (at %s %s %s)\n",
1018 EscapedUTF8( pin->GetText() ).c_str(),
1019 getSheetPinShapeToken( pin->GetShape() ),
1021 pin->GetPosition().x ).c_str(),
1023 pin->GetPosition().y ).c_str(),
1024 EDA_UNIT_UTILS::FormatAngle( getSheetPinAngle( pin->GetSide() ) ).c_str() );
1025
1026 pin->Format( m_out, aNestLevel + 1, 0 );
1027
1028 m_out->Print( aNestLevel + 2, "(uuid %s)\n", TO_UTF8( pin->m_Uuid.AsString() ) );
1029
1030 m_out->Print( aNestLevel + 1, ")\n" ); // Closes pin token.
1031 }
1032
1033 // Save all sheet instances here except the root sheet instance.
1034 std::vector< SCH_SHEET_INSTANCE > sheetInstances = aSheet->GetInstances();
1035
1036 auto it = sheetInstances.begin();
1037
1038 while( it != sheetInstances.end() )
1039 {
1040 if( it->m_Path.size() == 0 )
1041 it = sheetInstances.erase( it );
1042 else
1043 it++;
1044 }
1045
1046 if( !sheetInstances.empty() )
1047 {
1048 m_out->Print( aNestLevel + 1, "(instances\n" );
1049
1050 KIID lastProjectUuid;
1051 KIID rootSheetUuid = m_schematic->Root().m_Uuid;
1052 SCH_SHEET_LIST fullHierarchy = m_schematic->GetSheets();
1053 bool project_open = false;
1054
1055 for( size_t i = 0; i < sheetInstances.size(); i++ )
1056 {
1057 // If the instance data is part of this design but no longer has an associated sheet
1058 // path, don't save it. This prevents large amounts of orphaned instance data for the
1059 // current project from accumulating in the schematic files.
1060 //
1061 // Keep all instance data when copying to the clipboard. It may be needed on paste.
1062 if( ( sheetInstances[i].m_Path[0] == rootSheetUuid )
1063 && !fullHierarchy.GetSheetPathByKIIDPath( sheetInstances[i].m_Path, false ) )
1064 {
1065 if( project_open && ( ( i + 1 == sheetInstances.size() )
1066 || lastProjectUuid != sheetInstances[i+1].m_Path[0] ) )
1067 {
1068 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project` token.
1069 project_open = false;
1070 }
1071
1072 continue;
1073 }
1074
1075 if( lastProjectUuid != sheetInstances[i].m_Path[0] )
1076 {
1077 wxString projectName;
1078
1079 if( sheetInstances[i].m_Path[0] == rootSheetUuid )
1080 projectName = m_schematic->Prj().GetProjectName();
1081 else
1082 projectName = sheetInstances[i].m_ProjectName;
1083
1084 lastProjectUuid = sheetInstances[i].m_Path[0];
1085 m_out->Print( aNestLevel + 2, "(project %s\n",
1086 m_out->Quotew( projectName ).c_str() );
1087 project_open = true;
1088 }
1089
1090 wxString path = sheetInstances[i].m_Path.AsString();
1091
1092 m_out->Print( aNestLevel + 3, "(path %s (page %s))\n",
1093 m_out->Quotew( path ).c_str(),
1094 m_out->Quotew( sheetInstances[i].m_PageNumber ).c_str() );
1095
1096 if( project_open && ( ( i + 1 == sheetInstances.size() )
1097 || lastProjectUuid != sheetInstances[i+1].m_Path[0] ) )
1098 {
1099 m_out->Print( aNestLevel + 2, ")\n" ); // Closes `project` token.
1100 project_open = false;
1101 }
1102 }
1103
1104 m_out->Print( aNestLevel + 1, ")\n" ); // Closes `instances` token.
1105 }
1106
1107 m_out->Print( aNestLevel, ")\n" ); // Closes sheet token.
1108}
1109
1110
1111void SCH_SEXPR_PLUGIN::saveJunction( SCH_JUNCTION* aJunction, int aNestLevel )
1112{
1113 wxCHECK_RET( aJunction != nullptr && m_out != nullptr, "" );
1114
1115 m_out->Print( aNestLevel, "(junction (at %s %s) (diameter %s) (color %d %d %d %s)\n",
1117 aJunction->GetPosition().x ).c_str(),
1119 aJunction->GetPosition().y ).c_str(),
1121 aJunction->GetDiameter() ).c_str(),
1122 KiROUND( aJunction->GetColor().r * 255.0 ),
1123 KiROUND( aJunction->GetColor().g * 255.0 ),
1124 KiROUND( aJunction->GetColor().b * 255.0 ),
1125 FormatDouble2Str( aJunction->GetColor().a ).c_str() );
1126
1127 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aJunction->m_Uuid.AsString() ) );
1128
1129 m_out->Print( aNestLevel, ")\n" );
1130}
1131
1132
1133void SCH_SEXPR_PLUGIN::saveNoConnect( SCH_NO_CONNECT* aNoConnect, int aNestLevel )
1134{
1135 wxCHECK_RET( aNoConnect != nullptr && m_out != nullptr, "" );
1136
1137 m_out->Print( aNestLevel, "(no_connect (at %s %s) (uuid %s))\n",
1139 aNoConnect->GetPosition().x ).c_str(),
1141 aNoConnect->GetPosition().y ).c_str(),
1142 TO_UTF8( aNoConnect->m_Uuid.AsString() ) );
1143}
1144
1145
1146void SCH_SEXPR_PLUGIN::saveBusEntry( SCH_BUS_ENTRY_BASE* aBusEntry, int aNestLevel )
1147{
1148 wxCHECK_RET( aBusEntry != nullptr && m_out != nullptr, "" );
1149
1150 // Bus to bus entries are converted to bus line segments.
1151 if( aBusEntry->GetClass() == "SCH_BUS_BUS_ENTRY" )
1152 {
1153 SCH_LINE busEntryLine( aBusEntry->GetPosition(), LAYER_BUS );
1154
1155 busEntryLine.SetEndPoint( aBusEntry->GetEnd() );
1156 saveLine( &busEntryLine, aNestLevel );
1157 }
1158 else
1159 {
1160 m_out->Print( aNestLevel, "(bus_entry (at %s %s) (size %s %s)\n",
1162 aBusEntry->GetPosition().x ).c_str(),
1164 aBusEntry->GetPosition().y ).c_str(),
1166 aBusEntry->GetSize().x ).c_str(),
1168 aBusEntry->GetSize().y ).c_str() );
1169
1170 aBusEntry->GetStroke().Format( m_out, schIUScale, aNestLevel + 1 );
1171
1172 m_out->Print( 0, "\n" );
1173
1174 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aBusEntry->m_Uuid.AsString() ) );
1175
1176 m_out->Print( aNestLevel, ")\n" );
1177 }
1178}
1179
1180
1181void SCH_SEXPR_PLUGIN::saveShape( SCH_SHAPE* aShape, int aNestLevel )
1182{
1183 wxCHECK_RET( aShape != nullptr && m_out != nullptr, "" );
1184
1185 switch( aShape->GetShape() )
1186 {
1187 case SHAPE_T::ARC:
1188 formatArc( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
1189 aShape->GetFillColor(), aShape->m_Uuid );
1190 break;
1191
1192 case SHAPE_T::CIRCLE:
1193 formatCircle( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
1194 aShape->GetFillColor(), aShape->m_Uuid );
1195 break;
1196
1197 case SHAPE_T::RECT:
1198 formatRect( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
1199 aShape->GetFillColor(), aShape->m_Uuid );
1200 break;
1201
1202 case SHAPE_T::BEZIER:
1203 formatBezier( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
1204 aShape->GetFillColor(), aShape->m_Uuid );
1205 break;
1206
1207 case SHAPE_T::POLY:
1208 formatPoly( m_out, aNestLevel, aShape, false, aShape->GetStroke(), aShape->GetFillMode(),
1209 aShape->GetFillColor(), aShape->m_Uuid );
1210 break;
1211
1212 default:
1214 }
1215}
1216
1217
1218void SCH_SEXPR_PLUGIN::saveLine( SCH_LINE* aLine, int aNestLevel )
1219{
1220 wxCHECK_RET( aLine != nullptr && m_out != nullptr, "" );
1221
1222 wxString lineType;
1223
1224 STROKE_PARAMS line_stroke = aLine->GetStroke();
1225
1226 switch( aLine->GetLayer() )
1227 {
1228 case LAYER_BUS: lineType = "bus"; break;
1229 case LAYER_WIRE: lineType = "wire"; break;
1230 case LAYER_NOTES: lineType = "polyline"; break;
1231 default:
1232 UNIMPLEMENTED_FOR( LayerName( aLine->GetLayer() ) );
1233 }
1234
1235 m_out->Print( aNestLevel, "(%s (pts (xy %s %s) (xy %s %s))\n",
1236 TO_UTF8( lineType ),
1238 aLine->GetStartPoint().x ).c_str(),
1240 aLine->GetStartPoint().y ).c_str(),
1242 aLine->GetEndPoint().x ).c_str(),
1244 aLine->GetEndPoint().y ).c_str() );
1245
1246 line_stroke.Format( m_out, schIUScale, aNestLevel + 1 );
1247 m_out->Print( 0, "\n" );
1248
1249 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aLine->m_Uuid.AsString() ) );
1250
1251 m_out->Print( aNestLevel, ")\n" );
1252}
1253
1254
1255void SCH_SEXPR_PLUGIN::saveText( SCH_TEXT* aText, int aNestLevel )
1256{
1257 wxCHECK_RET( aText != nullptr && m_out != nullptr, "" );
1258
1259 // Note: label is nullptr SCH_TEXT, but not for SCH_LABEL_XXX,
1260 SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( aText );
1261
1262 m_out->Print( aNestLevel, "(%s %s",
1263 getTextTypeToken( aText->Type() ),
1264 m_out->Quotew( aText->GetText() ).c_str() );
1265
1266 if( aText->Type() == SCH_TEXT_T )
1267 {
1268 m_out->Print( 0, " (exclude_from_sim %s)\n",
1269 aText->GetExcludeFromSim() ? "yes" : "no" );
1270 }
1271 else if( aText->Type() == SCH_DIRECTIVE_LABEL_T )
1272 {
1273 SCH_DIRECTIVE_LABEL* flag = static_cast<SCH_DIRECTIVE_LABEL*>( aText );
1274
1275 m_out->Print( 0, " (length %s)",
1277 flag->GetPinLength() ).c_str() );
1278 }
1279
1280 EDA_ANGLE angle = aText->GetTextAngle();
1281
1282 if( label )
1283 {
1284 if( aText->Type() == SCH_GLOBAL_LABEL_T
1285 || aText->Type() == SCH_HIER_LABEL_T
1286 || aText->Type() == SCH_DIRECTIVE_LABEL_T )
1287 {
1288 m_out->Print( 0, " (shape %s)", getSheetPinShapeToken( label->GetShape() ) );
1289 }
1290
1291 // The angle of the text is always 0 or 90 degrees for readibility reasons,
1292 // but the item itself can have more rotation (-90 and 180 deg)
1293 switch( aText->GetTextSpinStyle() )
1294 {
1295 default:
1296 case TEXT_SPIN_STYLE::LEFT: angle += ANGLE_180; break;
1297 case TEXT_SPIN_STYLE::UP: break;
1298 case TEXT_SPIN_STYLE::RIGHT: break;
1299 case TEXT_SPIN_STYLE::BOTTOM: angle += ANGLE_180; break;
1300 }
1301 }
1302
1303 if( aText->GetText().Length() < 50 )
1304 {
1305 m_out->Print( 0, " (at %s %s %s)",
1307 aText->GetPosition().x ).c_str(),
1309 aText->GetPosition().y ).c_str(),
1310 EDA_UNIT_UTILS::FormatAngle( angle ).c_str() );
1311 }
1312 else
1313 {
1314 m_out->Print( 0, "\n" );
1315 m_out->Print( aNestLevel + 1, "(at %s %s %s)",
1317 aText->GetPosition().x ).c_str(),
1319 aText->GetPosition().y ).c_str(),
1320 EDA_UNIT_UTILS::FormatAngle( angle ).c_str() );
1321 }
1322
1324 m_out->Print( 0, " (fields_autoplaced)" );
1325
1326 m_out->Print( 0, "\n" );
1327 aText->EDA_TEXT::Format( m_out, aNestLevel, 0 );
1328
1329 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aText->m_Uuid.AsString() ) );
1330
1331 if( label )
1332 {
1333 for( SCH_FIELD& field : label->GetFields() )
1334 saveField( &field, aNestLevel + 1 );
1335 }
1336
1337 m_out->Print( aNestLevel, ")\n" ); // Closes text token.
1338}
1339
1340
1341void SCH_SEXPR_PLUGIN::saveTextBox( SCH_TEXTBOX* aTextBox, int aNestLevel )
1342{
1343 wxCHECK_RET( aTextBox != nullptr && m_out != nullptr, "" );
1344
1345 m_out->Print( aNestLevel, "(text_box %s\n",
1346 m_out->Quotew( aTextBox->GetText() ).c_str() );
1347
1348 VECTOR2I pos = aTextBox->GetStart();
1349 VECTOR2I size = aTextBox->GetEnd() - pos;
1350
1351 m_out->Print( aNestLevel + 1, "(exclude_from_sim %s) (at %s %s %s) (size %s %s)\n",
1352 aTextBox->GetExcludeFromSim() ? "yes" : "no",
1355 EDA_UNIT_UTILS::FormatAngle( aTextBox->GetTextAngle() ).c_str(),
1358
1359 aTextBox->GetStroke().Format( m_out, schIUScale, aNestLevel + 1 );
1360 m_out->Print( 0, "\n" );
1361 formatFill( m_out, aNestLevel + 1, aTextBox->GetFillMode(), aTextBox->GetFillColor() );
1362 m_out->Print( 0, "\n" );
1363
1364 aTextBox->EDA_TEXT::Format( m_out, aNestLevel, 0 );
1365
1366 if( aTextBox->m_Uuid != niluuid )
1367 m_out->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aTextBox->m_Uuid.AsString() ) );
1368
1369 m_out->Print( aNestLevel, ")\n" );
1370}
1371
1372
1373void SCH_SEXPR_PLUGIN::saveBusAlias( std::shared_ptr<BUS_ALIAS> aAlias, int aNestLevel )
1374{
1375 wxCHECK_RET( aAlias != nullptr, "BUS_ALIAS* is NULL" );
1376
1377 wxString members;
1378
1379 for( const wxString& member : aAlias->Members() )
1380 {
1381 if( !members.IsEmpty() )
1382 members += wxS( " " );
1383
1384 members += m_out->Quotew( member );
1385 }
1386
1387 m_out->Print( aNestLevel, "(bus_alias %s (members %s))\n",
1388 m_out->Quotew( aAlias->GetName() ).c_str(),
1389 TO_UTF8( members ) );
1390}
1391
1392
1393void SCH_SEXPR_PLUGIN::saveInstances( const std::vector<SCH_SHEET_INSTANCE>& aInstances,
1394 int aNestLevel )
1395{
1396 if( aInstances.size() )
1397 {
1398 m_out->Print( 0, "\n" );
1399 m_out->Print( aNestLevel, "(sheet_instances\n" );
1400
1401 for( const SCH_SHEET_INSTANCE& instance : aInstances )
1402 {
1403 wxString path = instance.m_Path.AsString();
1404
1405 if( path.IsEmpty() )
1406 path = wxT( "/" ); // Root path
1407
1408 m_out->Print( aNestLevel + 1, "(path %s (page %s))\n",
1409 m_out->Quotew( path ).c_str(),
1410 m_out->Quotew( instance.m_PageNumber ).c_str() );
1411 }
1412
1413 m_out->Print( aNestLevel, ")\n" ); // Close sheet instances token.
1414 }
1415}
1416
1417
1418void SCH_SEXPR_PLUGIN::cacheLib( const wxString& aLibraryFileName,
1419 const STRING_UTF8_MAP* aProperties )
1420{
1421 if( !m_cache || !m_cache->IsFile( aLibraryFileName ) || m_cache->IsFileChanged() )
1422 {
1423 // a spectacular episode in memory management:
1424 delete m_cache;
1425 m_cache = new SCH_SEXPR_PLUGIN_CACHE( aLibraryFileName );
1426
1427 if( !isBuffering( aProperties ) )
1428 m_cache->Load();
1429 }
1430}
1431
1432
1434{
1435 return ( aProperties && aProperties->Exists( SCH_SEXPR_PLUGIN::PropBuffering ) );
1436}
1437
1438
1440{
1441 if( m_cache )
1442 return m_cache->GetModifyHash();
1443
1444 // If the cache hasn't been loaded, it hasn't been modified.
1445 return 0;
1446}
1447
1448
1449void SCH_SEXPR_PLUGIN::EnumerateSymbolLib( wxArrayString& aSymbolNameList,
1450 const wxString& aLibraryPath,
1451 const STRING_UTF8_MAP* aProperties )
1452{
1453 LOCALE_IO toggle; // toggles on, then off, the C locale.
1454
1455 bool powerSymbolsOnly = ( aProperties &&
1456 aProperties->find( SYMBOL_LIB_TABLE::PropPowerSymsOnly ) != aProperties->end() );
1457
1458 cacheLib( aLibraryPath, aProperties );
1459
1460 const LIB_SYMBOL_MAP& symbols = m_cache->m_symbols;
1461
1462 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
1463 {
1464 if( !powerSymbolsOnly || it->second->IsPower() )
1465 aSymbolNameList.Add( it->first );
1466 }
1467}
1468
1469
1470void SCH_SEXPR_PLUGIN::EnumerateSymbolLib( std::vector<LIB_SYMBOL*>& aSymbolList,
1471 const wxString& aLibraryPath,
1472 const STRING_UTF8_MAP* aProperties )
1473{
1474 LOCALE_IO toggle; // toggles on, then off, the C locale.
1475
1476 bool powerSymbolsOnly = ( aProperties &&
1477 aProperties->find( SYMBOL_LIB_TABLE::PropPowerSymsOnly ) != aProperties->end() );
1478
1479 cacheLib( aLibraryPath, aProperties );
1480
1481 const LIB_SYMBOL_MAP& symbols = m_cache->m_symbols;
1482
1483 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
1484 {
1485 if( !powerSymbolsOnly || it->second->IsPower() )
1486 aSymbolList.push_back( it->second );
1487 }
1488}
1489
1490
1491LIB_SYMBOL* SCH_SEXPR_PLUGIN::LoadSymbol( const wxString& aLibraryPath, const wxString& aSymbolName,
1492 const STRING_UTF8_MAP* aProperties )
1493{
1494 LOCALE_IO toggle; // toggles on, then off, the C locale.
1495
1496 cacheLib( aLibraryPath, aProperties );
1497
1498 LIB_SYMBOL_MAP::const_iterator it = m_cache->m_symbols.find( aSymbolName );
1499
1500 // We no longer escape '/' in symbol names, but we used to.
1501 if( it == m_cache->m_symbols.end() && aSymbolName.Contains( '/' ) )
1502 it = m_cache->m_symbols.find( EscapeString( aSymbolName, CTX_LEGACY_LIBID ) );
1503
1504 if( it == m_cache->m_symbols.end() )
1505 return nullptr;
1506
1507 return it->second;
1508}
1509
1510
1511void SCH_SEXPR_PLUGIN::SaveSymbol( const wxString& aLibraryPath, const LIB_SYMBOL* aSymbol,
1512 const STRING_UTF8_MAP* aProperties )
1513{
1514 LOCALE_IO toggle; // toggles on, then off, the C locale.
1515
1516 cacheLib( aLibraryPath, aProperties );
1517
1518 m_cache->AddSymbol( aSymbol );
1519
1520 if( !isBuffering( aProperties ) )
1521 m_cache->Save();
1522}
1523
1524
1525void SCH_SEXPR_PLUGIN::DeleteSymbol( const wxString& aLibraryPath, const wxString& aSymbolName,
1526 const STRING_UTF8_MAP* aProperties )
1527{
1528 LOCALE_IO toggle; // toggles on, then off, the C locale.
1529
1530 cacheLib( aLibraryPath, aProperties );
1531
1532 m_cache->DeleteSymbol( aSymbolName );
1533
1534 if( !isBuffering( aProperties ) )
1535 m_cache->Save();
1536}
1537
1538
1539void SCH_SEXPR_PLUGIN::CreateSymbolLib( const wxString& aLibraryPath,
1540 const STRING_UTF8_MAP* aProperties )
1541{
1542 if( wxFileExists( aLibraryPath ) )
1543 {
1544 THROW_IO_ERROR( wxString::Format( _( "Symbol library '%s' already exists." ),
1545 aLibraryPath.GetData() ) );
1546 }
1547
1548 LOCALE_IO toggle;
1549
1550 delete m_cache;
1551 m_cache = new SCH_SEXPR_PLUGIN_CACHE( aLibraryPath );
1553 m_cache->Save();
1554 m_cache->Load(); // update m_writable and m_mod_time
1555}
1556
1557
1558bool SCH_SEXPR_PLUGIN::DeleteSymbolLib( const wxString& aLibraryPath,
1559 const STRING_UTF8_MAP* aProperties )
1560{
1561 wxFileName fn = aLibraryPath;
1562
1563 if( !fn.FileExists() )
1564 return false;
1565
1566 // Some of the more elaborate wxRemoveFile() crap puts up its own wxLog dialog
1567 // we don't want that. we want bare metal portability with no UI here.
1568 if( wxRemove( aLibraryPath ) )
1569 {
1570 THROW_IO_ERROR( wxString::Format( _( "Symbol library '%s' cannot be deleted." ),
1571 aLibraryPath.GetData() ) );
1572 }
1573
1574 if( m_cache && m_cache->IsFile( aLibraryPath ) )
1575 {
1576 delete m_cache;
1577 m_cache = nullptr;
1578 }
1579
1580 return true;
1581}
1582
1583
1584void SCH_SEXPR_PLUGIN::SaveLibrary( const wxString& aLibraryPath, const STRING_UTF8_MAP* aProperties )
1585{
1586 if( !m_cache )
1587 m_cache = new SCH_SEXPR_PLUGIN_CACHE( aLibraryPath );
1588
1589 wxString oldFileName = m_cache->GetFileName();
1590
1591 if( !m_cache->IsFile( aLibraryPath ) )
1592 {
1593 m_cache->SetFileName( aLibraryPath );
1594 }
1595
1596 // This is a forced save.
1598 m_cache->Save();
1599 m_cache->SetFileName( oldFileName );
1600}
1601
1602
1603bool SCH_SEXPR_PLUGIN::CheckHeader( const wxString& aFileName )
1604{
1605 // Open file and check first line
1606 wxTextFile tempFile;
1607
1608 tempFile.Open( aFileName );
1609 wxString firstline;
1610 // read the first line
1611 firstline = tempFile.GetFirstLine();
1612 tempFile.Close();
1613
1614 return firstline.StartsWith( wxS( "EESchema" ) );
1615}
1616
1617
1618bool SCH_SEXPR_PLUGIN::IsSymbolLibWritable( const wxString& aLibraryPath )
1619{
1620 wxFileName fn( aLibraryPath );
1621
1622 return ( fn.FileExists() && fn.IsFileWritable() ) || fn.IsDirWritable();
1623}
1624
1625
1626void SCH_SEXPR_PLUGIN::GetAvailableSymbolFields( std::vector<wxString>& aNames )
1627{
1628 if( !m_cache )
1629 return;
1630
1631 const LIB_SYMBOL_MAP& symbols = m_cache->m_symbols;
1632
1633 std::set<wxString> fieldNames;
1634
1635 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
1636 {
1637 std::vector<LIB_FIELD*> fields;
1638 it->second->GetFields( fields );
1639
1640 for( LIB_FIELD* field : fields )
1641 {
1642 if( field->IsMandatory() )
1643 continue;
1644
1645 // TODO(JE): enable configurability of this outside database libraries?
1646 // if( field->ShowInChooser() )
1647 fieldNames.insert( field->GetName() );
1648 }
1649 }
1650
1651 std::copy( fieldNames.begin(), fieldNames.end(), std::back_inserter( aNames ) );
1652}
1653
1654
1655void SCH_SEXPR_PLUGIN::GetDefaultSymbolFields( std::vector<wxString>& aNames )
1656{
1657 GetAvailableSymbolFields( aNames );
1658}
1659
1660
1662{
1663 LOCALE_IO toggle; // toggles on, then off, the C locale.
1664 LIB_SYMBOL_MAP map;
1665 SCH_SEXPR_PARSER parser( &aReader );
1666
1667 parser.NeedLEFT();
1668 parser.NextTok();
1669
1670 return parser.ParseSymbol( map, aFileVersion );
1671}
1672
1673
1675{
1676
1677 LOCALE_IO toggle; // toggles on, then off, the C locale.
1678 SCH_SEXPR_PLUGIN_CACHE::SaveSymbol( symbol, formatter );
1679}
1680
1681
1682const char* SCH_SEXPR_PLUGIN::PropBuffering = "buffering";
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:111
This class handle bitmap images in KiCad.
Definition: bitmap_base.h:52
double GetScale() const
Definition: bitmap_base.h:78
int GetPPI() const
Definition: bitmap_base.h:123
wxImage * GetImageData()
Definition: bitmap_base.h:71
const KIID m_Uuid
Definition: eda_item.h:475
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:100
FILL_T GetFillMode() const
Definition: eda_shape.h:101
SHAPE_T GetShape() const
Definition: eda_shape.h:113
const VECTOR2I & GetEnd() const
Return the ending point of the graphic.
Definition: eda_shape.h:145
const VECTOR2I & GetStart() const
Return the starting point of the graphic.
Definition: eda_shape.h:120
COLOR4D GetFillColor() const
Definition: eda_shape.h:105
wxString SHAPE_T_asString() const
Definition: eda_shape.cpp:75
int GetTextHeight() const
Definition: eda_text.h:205
bool IsDefaultFormatting() const
Definition: eda_text.cpp:799
const EDA_ANGLE & GetTextAngle() const
Definition: eda_text.h:123
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:87
virtual void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Output the object to aFormatter in s-expression form.
Definition: eda_text.cpp:814
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:261
Used for text file output.
Definition: richio.h:469
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:76
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
double r
Red component.
Definition: color4d.h:375
double g
Green component.
Definition: color4d.h:376
double a
Alpha component.
Definition: color4d.h:378
double b
Blue component.
Definition: color4d.h:377
Definition: kiid.h:48
wxString AsString() const
Definition: kiid.cpp:257
Field object used in symbol libraries.
Definition: lib_field.h:61
UTF8 Format() const
Definition: lib_id.cpp:117
@ DEMORGAN
Definition: lib_item.h:70
Define a library symbol object.
Definition: lib_symbol.h:99
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:41
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:543
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:475
void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Output the page class to aFormatter in s-expression form.
Definition: page_info.cpp:273
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:126
virtual const wxString GetProjectName() const
Return the short name of the project.
Definition: project.cpp:132
Holds all the data relating to one schematic.
Definition: schematic.h:72
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:97
bool IsValid() const
A simple test if the schematic is loaded, not a complete one.
Definition: schematic.h:118
SCH_SHEET & Root() const
Definition: schematic.h:102
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Definition: schematic.h:87
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:139
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:71
VECTOR2I GetPosition() const override
virtual STROKE_PARAMS GetStroke() const override
Definition: sch_bus_entry.h:77
VECTOR2I GetEnd() const
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:51
VECTOR2I GetPosition() const override
Definition: sch_field.cpp:1069
bool IsNameShown() const
Definition: sch_field.h:164
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:837
int GetId() const
Definition: sch_field.h:125
bool CanAutoplace() const
Definition: sch_field.h:167
void SetId(int aId)
Definition: sch_field.cpp:138
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:147
virtual wxString GetClass() const override
Return the class name.
Definition: sch_item.h:157
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:249
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:430
COLOR4D GetColor() const
Definition: sch_junction.h:114
int GetDiameter() const
Definition: sch_junction.h:109
VECTOR2I GetPosition() const override
Definition: sch_junction.h:102
LABEL_FLAG_SHAPE GetShape() const override
Definition: sch_label.h:73
std::vector< SCH_FIELD > & GetFields()
Definition: sch_label.h:90
bool IsFile(const wxString &aFullPathAndFileName) const
wxString GetFileName() const
void SetFileName(const wxString &aFileName)
virtual void AddSymbol(const LIB_SYMBOL *aSymbol)
void SetModified(bool aModified=true)
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:177
VECTOR2I GetEndPoint() const
Definition: sch_line.h:143
VECTOR2I GetStartPoint() const
Definition: sch_line.h:138
void SetEndPoint(const VECTOR2I &aPosition)
Definition: sch_line.h:144
VECTOR2I GetPosition() const override
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
void SortByReferenceOnly()
Sort the list of references by reference.
std::vector< SCH_SYMBOL_INSTANCE > GetSymbolInstances() const
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:131
std::map< wxString, LIB_SYMBOL * > & GetLibSymbols()
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:109
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:155
KIID m_uuid
A unique identifier for each schematic file.
Definition: sch_screen.h:648
void SetFileReadOnly(bool aIsReadOnly)
Definition: sch_screen.h:146
std::set< std::shared_ptr< BUS_ALIAS > > GetBusAliases() const
Return a list of bus aliases defined in this screen.
Definition: sch_screen.h:511
void SetFileExists(bool aFileExists)
Definition: sch_screen.h:149
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)
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 Save(const std::optional< bool > &aOpt=std::nullopt) override
Save the entire library to file m_libFileName;.
void DeleteSymbol(const wxString &aName) override
wxString m_error
For throwing exceptions or errors on partial loads.
void saveBusAlias(std::shared_ptr< BUS_ALIAS > aAlias, int aNestLevel)
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...
SCH_SHEET_PATH m_currentSheetPath
void cacheLib(const wxString &aLibraryFileName, const STRING_UTF8_MAP *aProperties)
wxString m_path
Root project path for loading child sheets.
void saveField(SCH_FIELD *aField, int aNestLevel)
void saveTextBox(SCH_TEXTBOX *aText, int aNestLevel)
SCHEMATIC * m_schematic
OUTPUTFORMATTER * m_out
The formatter for saving SCH_SCREEN objects.
void Format(SCH_SHEET *aSheet)
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.
static void FormatLibSymbol(LIB_SYMBOL *aPart, OUTPUTFORMATTER &aFormatter)
void SaveLibrary(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
void GetAvailableSymbolFields(std::vector< wxString > &aNames) override
Retrieves a list of (custom) field names that are present on symbols in this library.
bool DeleteSymbolLib(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Delete an existing symbol library and returns true if successful, or if library does not exist return...
std::stack< wxString > m_currentPath
Stack to maintain nested sheet paths.
void loadFile(const wxString &aFileName, SCH_SHEET *aSheet)
void saveLine(SCH_LINE *aLine, int aNestLevel)
void saveInstances(const std::vector< SCH_SHEET_INSTANCE > &aSheets, int aNestLevel)
virtual ~SCH_SEXPR_PLUGIN()
bool m_appending
Schematic load append status.
SCH_SHEET * m_rootSheet
The root sheet of the schematic being loaded.
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 saveText(SCH_TEXT *aText, int aNestLevel)
static LIB_SYMBOL * ParseLibSymbol(LINE_READER &aReader, int aVersion=SEXPR_SCHEMATIC_FILE_VERSION)
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.
void saveSymbol(SCH_SYMBOL *aSymbol, const SCHEMATIC &aSchematic, int aNestLevel, bool aForClipboard)
void saveSheet(SCH_SHEET *aSheet, int aNestLevel)
SCH_SHEET * Load(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_PLUGIN implementation knows about,...
SCH_SEXPR_PLUGIN_CACHE * m_cache
void CreateSymbolLib(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Create a new empty symbol library at aLibraryPath.
void LoadContent(LINE_READER &aReader, SCH_SHEET *aSheet, int aVersion=SEXPR_SCHEMATIC_FILE_VERSION)
bool IsSymbolLibWritable(const wxString &aLibraryPath) override
Return true if the library at aLibraryPath is writable.
void loadHierarchy(const SCH_SHEET_PATH &aParentSheetPath, SCH_SHEET *aSheet)
bool isBuffering(const STRING_UTF8_MAP *aProperties)
PROGRESS_REPORTER * m_progressReporter
void init(SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr)
initialize PLUGIN like a constructor would.
static const char * PropBuffering
The property used internally by the plugin to enable cache buffering which prevents the library file ...
void saveShape(SCH_SHAPE *aShape, 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 saveBitmap(SCH_BITMAP *aBitmap, int aNestLevel)
bool CheckHeader(const wxString &aFileName) override
Return true if the first line in aFileName begins with the expected header.
void saveBusEntry(SCH_BUS_ENTRY_BASE *aBusEntry, int aNestLevel)
void Save(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_PLUGIN implementation knows about,...
int m_version
Version of file being loaded.
int GetModifyHash() const override
Return the modification hash from the library cache.
void saveNoConnect(SCH_NO_CONNECT *aNoConnect, int aNestLevel)
void saveJunction(SCH_JUNCTION *aJunction, int aNestLevel)
STROKE_PARAMS GetStroke() const override
Definition: sch_shape.h:64
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.
void SortByPageNumbers(bool aUpdateVirtualPageNums=true)
Sort the list of sheets by page number.
std::vector< SCH_SHEET_INSTANCE > GetSheetInstances() const
Fetch the instance information for all of the sheets in the hiearchy.
void GetSymbolsWithinPath(SCH_REFERENCE_LIST &aReferences, const SCH_SHEET_PATH &aSheetPath, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets that are contained wi...
void GetSheetsWithinPath(SCH_SHEET_PATHS &aSheets, const SCH_SHEET_PATH &aSheetPath) const
Add a SCH_SHEET_PATH object to aSheets for each sheet in the list that are contained within aSheetPat...
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 AppendSymbol(SCH_REFERENCE_LIST &aReferences, SCH_SYMBOL *aSymbol, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Append a SCH_REFERENCE object to aReferences based on aSymbol.
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:310
bool HasRootInstance() const
Check to see if this sheet has a root sheet instance.
Definition: sch_sheet.cpp:1274
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:722
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:161
const SCH_SHEET_INSTANCE & GetRootInstance() const
Return the root sheet instance data.
Definition: sch_sheet.cpp:1286
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:183
const std::vector< SCH_SHEET_INSTANCE > & GetInstances() const
Definition: sch_sheet.h:389
KIGFX::COLOR4D GetBackgroundColor() const
Definition: sch_sheet.h:121
Schematic symbol object.
Definition: sch_symbol.h:81
std::vector< std::unique_ptr< SCH_PIN > > & GetRawPins()
Definition: sch_symbol.h:561
int GetUnit() const
Definition: sch_symbol.h:231
const std::vector< SCH_SYMBOL_INSTANCE > & GetInstanceReferences()
Definition: sch_symbol.h:140
bool UseLibIdLookup() const
Definition: sch_symbol.h:193
wxString GetSchSymbolLibraryName() const
Definition: sch_symbol.cpp:294
bool GetIncludeOnBoard() const
Definition: sch_symbol.h:764
bool GetIncludeInBom() const
Definition: sch_symbol.h:761
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:891
int GetConvert() const
Definition: sch_symbol.h:273
VECTOR2I GetPosition() const override
Definition: sch_symbol.h:726
int GetOrientation() const
Get the display symbol orientation.
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:178
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
Definition: sch_symbol.cpp:939
void SortInstances(bool(*aSortFunction)(const SCH_SYMBOL_INSTANCE &aLhs, const SCH_SYMBOL_INSTANCE &aRhs))
Definition: sch_symbol.cpp:589
bool GetDNP() const
Definition: sch_symbol.h:767
bool GetExcludeFromSim() const override
Definition: sch_textbox.h:74
VECTOR2I GetPosition() const override
Definition: sch_text.h:212
TEXT_SPIN_STYLE GetTextSpinStyle() const
Definition: sch_text.h:157
bool GetExcludeFromSim() const override
Definition: sch_text.h:147
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
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:88
void SetWidth(int aWidth)
Definition: stroke_params.h:99
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:46
#define _(s)
static constexpr EDA_ANGLE & ANGLE_180
Definition: eda_angle.h:433
static constexpr EDA_ANGLE & ANGLE_90
Definition: eda_angle.h:431
static constexpr EDA_ANGLE & ANGLE_0
Definition: eda_angle.h:429
static constexpr EDA_ANGLE & ANGLE_270
Definition: eda_angle.h:434
#define DEFAULT_SIZE_TEXT
This is the "default-of-the-default" hardcoded text size; individual application define their own def...
Definition: eda_text.h:61
const wxChar *const traceSchPlugin
Flag to enable legacy schematic plugin debug output.
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38
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:345
@ LAYER_WIRE
Definition: layer_ids.h:348
@ LAYER_NOTES
Definition: layer_ids.h:362
@ LAYER_BUS
Definition: layer_ids.h:349
@ SCH_LAYER_ID_START
Definition: layer_ids.h:346
#define UNIMPLEMENTED_FOR(type)
Definition: macros.h:120
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
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:142
std::string FormatAngle(const EDA_ANGLE &aAngle)
Converts aAngle from board units to a string appropriate for writing to file.
Definition: eda_units.cpp:134
@ SYM_ORIENT_270
@ SYM_MIRROR_Y
@ SYM_ORIENT_180
@ SYM_MIRROR_X
@ SYM_ORIENT_90
#define SEXPR_SCHEMATIC_FILE_VERSION
Schematic file version.
@ FIELDS_AUTOPLACED_NO
Definition: sch_item.h:56
Schematic and symbol library s-expression file format parser definitions.
#define MIME_BASE64_LENGTH
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)
@ SHEET_MANDATORY_FIELDS
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:49
bool SortSymbolInstancesByProjectUuid(const SCH_SYMBOL_INSTANCE &aLhs, const SCH_SYMBOL_INSTANCE &aRhs)
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:55
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:...
@ CTX_LEGACY_LIBID
Definition: string_utils.h:56
constexpr int MilsToIU(int mils) const
Definition: base_units.h:94
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 4 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_LINE_T
Definition: typeinfo.h:136
@ SCH_NO_CONNECT_T
Definition: typeinfo.h:133
@ TYPE_NOT_INIT
Definition: typeinfo.h:81
@ SCH_SYMBOL_T
Definition: typeinfo.h:146
@ SCH_DIRECTIVE_LABEL_T
Definition: typeinfo.h:144
@ SCH_LABEL_T
Definition: typeinfo.h:141
@ SCH_SHEET_T
Definition: typeinfo.h:148
@ SCH_MARKER_T
Definition: typeinfo.h:131
@ SCH_SHAPE_T
Definition: typeinfo.h:137
@ SCH_HIER_LABEL_T
Definition: typeinfo.h:143
@ SCH_BUS_BUS_ENTRY_T
Definition: typeinfo.h:135
@ SCH_TEXT_T
Definition: typeinfo.h:140
@ SCH_BUS_WIRE_ENTRY_T
Definition: typeinfo.h:134
@ SCH_BITMAP_T
Definition: typeinfo.h:138
@ SCH_TEXTBOX_T
Definition: typeinfo.h:139
@ SCH_GLOBAL_LABEL_T
Definition: typeinfo.h:142
@ SCH_JUNCTION_T
Definition: typeinfo.h:132
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