KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eeschema.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) 2004 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <pgm_base.h>
27#include <kiface_base.h>
29#include <confirm.h>
30#include <gestfich.h>
31#include <eda_dde.h>
33#include "eeschema_helpers.h"
34#include <eeschema_settings.h>
35#include <sch_edit_frame.h>
37#include <symbol_edit_frame.h>
38#include <symbol_viewer_frame.h>
40#include <symbol_lib_table.h>
47#include <kiway.h>
50#include <sexpr/sexpr.h>
51#include <sexpr/sexpr_parser.h>
52#include <kiface_ids.h>
54#include <wx/ffile.h>
56
57#include <schematic.h>
58#include <connection_graph.h>
68#include <sim/simulator_frame.h>
69
71#include <toolbars_sch_editor.h>
73
74#include <wx/crt.h>
75
76// The main sheet of the project
78
79
80namespace SCH {
81
82
83// TODO: This should move out of this file
84static std::unique_ptr<SCHEMATIC> readSchematicFromFile( const std::string& aFilename )
85{
86 SCH_IO* pi = SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD );
87 std::unique_ptr<SCHEMATIC> schematic = std::make_unique<SCHEMATIC>( nullptr );
88
90
91 // TODO: this must load the schematic's project, not a default project. At the very minimum
92 // variable resolution won't work without the project, but there might also be issues with
93 // netclasses, etc.
94 manager.LoadProject( "" );
95 schematic->Reset();
96 schematic->SetProject( &manager.Prj() );
97 schematic->SetRoot( pi->LoadSchematicFile( aFilename, schematic.get() ) );
98 schematic->CurrentSheet().push_back( &schematic->Root() );
99
100 SCH_SCREENS screens( schematic->Root() );
101
102 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
103 screen->UpdateLocalLibSymbolLinks();
104
105 SCH_SHEET_LIST sheets = schematic->Hierarchy();
106
107 // Restore all of the loaded symbol instances from the root sheet screen.
108 sheets.UpdateSymbolInstanceData( schematic->RootScreen()->GetSymbolInstances() );
109
110 if( schematic->RootScreen()->GetFileFormatVersionAtLoad() < 20230221 )
111 {
112 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
113 screen->FixLegacyPowerSymbolMismatches();
114 }
115
116 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
117 screen->MigrateSimModels();
118
119 sheets.AnnotatePowerSymbols();
120
121 // NOTE: This is required for multi-unit symbols to be correct
122 for( SCH_SHEET_PATH& sheet : sheets )
123 sheet.UpdateAllScreenReferences();
124
125 // TODO: this must handle SchematicCleanup somehow. The original version didn't because
126 // it knew that QA test cases were saved in a clean state.
127
128 // TODO: does this need to handle PruneOrphanedSymbolInstances() and
129 // PruneOrphanedSheetInstances()?
130
131 schematic->ConnectionGraph()->Recalculate( sheets, true );
132
133 return schematic;
134}
135
136
137// TODO: This should move out of this file
138bool generateSchematicNetlist( const wxString& aFilename, std::string& aNetlist )
139{
140 std::unique_ptr<SCHEMATIC> schematic = readSchematicFromFile( aFilename.ToStdString() );
141 NETLIST_EXPORTER_KICAD exporter( schematic.get() );
142 STRING_FORMATTER formatter;
143
144 exporter.Format( &formatter, GNL_ALL | GNL_OPT_KICAD );
145 aNetlist = formatter.GetString();
146
147 return true;
148}
149
150
151static struct IFACE : public KIFACE_BASE, public UNITS_PROVIDER
152{
153 // Of course all are virtual overloads, implementations of the KIFACE.
154
155 IFACE( const char* aName, KIWAY::FACE_T aType ) :
156 KIFACE_BASE( aName, aType ),
158 {}
159
160 bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits, KIWAY* aKiway ) override;
161
162 void Reset() override;
163
164 void OnKifaceEnd() override;
165
166 wxWindow* CreateKiWindow( wxWindow* aParent, int aClassId, KIWAY* aKiway,
167 int aCtlBits = 0 ) override
168 {
169 switch( aClassId )
170 {
171 case FRAME_SCH:
172 {
173 SCH_EDIT_FRAME* frame = new SCH_EDIT_FRAME( aKiway, aParent );
174
176
177 if( Kiface().IsSingle() )
178 {
179 // only run this under single_top, not under a project manager.
181 }
182
183 return frame;
184 }
185
187 {
188 SYMBOL_EDIT_FRAME* frame = new SYMBOL_EDIT_FRAME( aKiway, aParent );
189 return frame;
190 }
191
192 case FRAME_SIMULATOR:
193 {
194 SIMULATOR_FRAME* frame = new SIMULATOR_FRAME( aKiway, aParent );
195 return frame;
196 }
197
198 case FRAME_SCH_VIEWER:
199 {
200 SYMBOL_VIEWER_FRAME* frame = new SYMBOL_VIEWER_FRAME( aKiway, aParent );
201 return frame;
202 }
203
205 {
206 SYMBOL_CHOOSER_FRAME* frame = new SYMBOL_CHOOSER_FRAME( aKiway, aParent );
207 return frame;
208 }
209
211 InvokeSchEditSymbolLibTable( aKiway, aParent );
212 // Dialog has completed; nothing to return.
213 return nullptr;
214
216 InvokeEditDesignBlockLibTable( aKiway, aParent );
217 // Dialog has completed; nothing to return.
218 return nullptr;
219
223 APP_SETTINGS_BASE* cfg = mgr.GetAppSettings<SYMBOL_EDITOR_SETTINGS>( "symbol_editor" );
224
225 return new PANEL_SYM_DISPLAY_OPTIONS( aParent, cfg );
226 }
227
229 {
231 APP_SETTINGS_BASE* cfg = mgr.GetAppSettings<SYMBOL_EDITOR_SETTINGS>( "symbol_editor" );
232 EDA_BASE_FRAME* frame = aKiway->Player( FRAME_SCH_SYMBOL_EDITOR, false );
233
234 if( !frame )
235 frame = aKiway->Player( FRAME_SCH_VIEWER, false );
236
237 if( !frame )
238 frame = aKiway->Player( FRAME_SCH, false );
239
240 if( frame )
241 SetUserUnits( frame->GetUserUnits() );
243 return new PANEL_GRID_SETTINGS( aParent, this, frame, cfg, FRAME_SCH_SYMBOL_EDITOR );
245
249
250 if( !frame )
251 frame = aKiway->Player( FRAME_SCH_VIEWER, false );
252
253 if( !frame )
254 frame = aKiway->Player( FRAME_SCH, false );
255
256 if( frame )
257 SetUserUnits( frame->GetUserUnits() );
258
259 return new PANEL_SYM_EDITING_OPTIONS( aParent, this, frame );
260 }
261
263 {
265 APP_SETTINGS_BASE* cfg = mgr.GetAppSettings<SYMBOL_EDITOR_SETTINGS>( "symbol_editor" );
266 TOOLBAR_SETTINGS* tb = mgr.GetToolbarSettings<SYMBOL_EDIT_TOOLBAR_SETTINGS>( "symbol_editor-toolbars" );
267
268 std::vector<TOOL_ACTION*> actions;
269 std::vector<ACTION_TOOLBAR_CONTROL*> controls;
270
272 actions.push_back( action );
273
275 controls.push_back( control );
276
277 return new PANEL_TOOLBAR_CUSTOMIZATION( aParent, cfg, tb, actions, controls );
278 }
279
280 case PANEL_SYM_COLORS:
281 return new PANEL_SYM_COLOR_SETTINGS( aParent );
282
284 {
286 EESCHEMA_SETTINGS* cfg = mgr.GetAppSettings<EESCHEMA_SETTINGS>( "eeschema" );
287
288 return new PANEL_EESCHEMA_DISPLAY_OPTIONS( aParent, cfg );
289 }
290
291 case PANEL_SCH_GRIDS:
292 {
294 EESCHEMA_SETTINGS* cfg = mgr.GetAppSettings<EESCHEMA_SETTINGS>( "eeschema" );
295 EDA_BASE_FRAME* frame = aKiway->Player( FRAME_SCH, false );
296
297 if( !frame )
298 frame = aKiway->Player( FRAME_SCH_SYMBOL_EDITOR, false );
299
300 if( !frame )
301 frame = aKiway->Player( FRAME_SCH_VIEWER, false );
302
303 if( frame )
304 SetUserUnits( frame->GetUserUnits() );
305
306 return new PANEL_GRID_SETTINGS( aParent, this, frame, cfg, FRAME_SCH );
307 }
308
310 {
311 EDA_BASE_FRAME* frame = aKiway->Player( FRAME_SCH, false );
312
313 if( !frame )
314 frame = aKiway->Player( FRAME_SCH_SYMBOL_EDITOR, false );
315
316 if( !frame )
317 frame = aKiway->Player( FRAME_SCH_VIEWER, false );
318
319 if( frame )
320 SetUserUnits( frame->GetUserUnits() );
321
322 return new PANEL_EESCHEMA_EDITING_OPTIONS( aParent, this, frame );
323 }
324
326 {
327 EDA_BASE_FRAME* schSettingsProvider = aKiway->Player( FRAME_SCH, false );
328
329 return new PANEL_EESCHEMA_ANNOTATION_OPTIONS( aParent, schSettingsProvider );
330 }
331
333 {
335 APP_SETTINGS_BASE* cfg = mgr.GetAppSettings<EESCHEMA_SETTINGS>( "eeschema" );
336 TOOLBAR_SETTINGS* tb = mgr.GetToolbarSettings<SCH_EDIT_TOOLBAR_SETTINGS>( "eeschema-toolbars" );
337
338 std::vector<TOOL_ACTION*> actions;
339 std::vector<ACTION_TOOLBAR_CONTROL*> controls;
340
342 actions.push_back( action );
343
345 controls.push_back( control );
346
347 return new PANEL_TOOLBAR_CUSTOMIZATION( aParent, cfg, tb, actions, controls );
348 }
349
350 case PANEL_SCH_COLORS:
351 return new PANEL_EESCHEMA_COLOR_SETTINGS( aParent );
352
354 return new PANEL_TEMPLATE_FIELDNAMES( aParent, nullptr );
355
357 return new PANEL_SIMULATOR_PREFERENCES( aParent );
358
359 default:
360 return nullptr;
361 }
362 }
363
374 void* IfaceOrAddress( int aDataId ) override
375 {
376 switch( aDataId )
377 {
379 return (void*) generateSchematicNetlist;
380 }
381
382 return nullptr;
383 }
384
390 void SaveFileAs( const wxString& aProjectBasePath, const wxString& aProjectName,
391 const wxString& aNewProjectBasePath, const wxString& aNewProjectName,
392 const wxString& aSrcFilePath, wxString& aErrors ) override;
393
394
395 int HandleJob( JOB* aJob, REPORTER* aReporter ) override;
396
397 bool HandleJobConfig( JOB* aJob, wxWindow* aParent ) override;
398
399private:
400 bool loadGlobalLibTable();
402
403 std::unique_ptr<EESCHEMA_JOBS_HANDLER> m_jobHandler;
404
405} kiface( "eeschema", KIWAY::FACE_SCH );
406
407} // namespace
408
409using namespace SCH;
410
411
413
414
415// KIFACE_GETTER's actual spelling is a substitution macro found in kiway.h.
416// KIFACE_GETTER will not have name mangling due to declaration in kiway.h.
417KIFACE_API KIFACE* KIFACE_GETTER( int* aKIFACEversion, int aKiwayVersion, PGM_BASE* aProgram )
418{
419 return &kiface;
420}
421
422
423bool IFACE::OnKifaceStart( PGM_BASE* aProgram, int aCtlBits, KIWAY* aKiway )
424{
425 // This is process-level-initialization, not project-level-initialization of the DSO.
426 // Do nothing in here pertinent to a project!
428
429 // Register the symbol editor settings as well because they share a KiFACE and need to be
430 // loaded prior to use to avoid threading deadlocks
432 aProgram->GetSettingsManager().RegisterSettings( symSettings ); // manager takes ownership
433
434 // We intentionally register KifaceSettings after SYMBOL_EDITOR_SETTINGS
435 // In legacy configs, many settings were in a single editor config nd the migration routine
436 // for the main editor file will try and call into the now separate settings stores
437 // to move the settings into them
439
440 start_common( aCtlBits );
441
443 {
444 // we didnt get anywhere deregister the settings
445 aProgram->GetSettingsManager().FlushAndRelease( symSettings, false );
446 aProgram->GetSettingsManager().FlushAndRelease( KifaceSettings(), false );
447 return false;
448 }
449
450 m_jobHandler = std::make_unique<EESCHEMA_JOBS_HANDLER>( aKiway );
451
453 {
454 m_jobHandler->SetReporter( &CLI_REPORTER::GetInstance() );
455 m_jobHandler->SetProgressReporter( &CLI_PROGRESS_REPORTER::GetInstance() );
456 }
457
458 return true;
459}
460
461
463{
465}
466
467
469{
471
472 if( !fn.FileExists() )
473 {
474 if( !( m_start_flags & KFCTL_CLI ) )
475 {
476 // Ensure the splash screen does not hide the dialog:
477 Pgm().HideSplash();
478
479 DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG symDialog( nullptr );
480
481 if( symDialog.ShowModal() != wxID_OK )
482 return false;
483 }
484 }
485 else
486 {
487 try
488 {
489 // The global table is not related to a specific project. All projects
490 // will use the same global table. So the KIFACE::OnKifaceStart() contract
491 // of avoiding anything project specific is not violated here.
493 return false;
494 }
495 catch( const IO_ERROR& ioe )
496 {
497 // if we are here, a incorrect global symbol library table was found.
498 // Incorrect global symbol library table is not a fatal error:
499 // the user just has to edit the (partially) loaded table.
500 wxString msg =
501 _( "An error occurred attempting to load the global symbol library table.\n"
502 "Please edit this global symbol library table in Preferences menu." );
503
504 DisplayErrorMessage( nullptr, msg, ioe.What() );
505 }
506 }
507
508 return true;
509}
510
511
513{
514 try
515 {
517
518 if( !fn.FileExists() )
519 {
520 DESIGN_BLOCK_LIB_TABLE emptyTable;
521 emptyTable.Save( fn.GetFullPath() );
522 }
523
524 // The global table is not related to a specific project. All projects
525 // will use the same global table. So the KIFACE::OnKifaceStart() contract
526 // of avoiding anything project specific is not violated here.
529 return false;
530 }
531 catch( const IO_ERROR& ioe )
532 {
533 // if we are here, a incorrect global design block library table was found.
534 // Incorrect global design block library table is not a fatal error:
535 // the user just has to edit the (partially) loaded table.
536 wxString msg =
537 _( "An error occurred attempting to load the global design block library table.\n"
538 "Please edit this global design block library table in Preferences menu." );
539
540 DisplayErrorMessage( nullptr, msg, ioe.What() );
541 }
542
543 return true;
544}
545
546
548{
549 end_common();
550}
551
552
553static void traverseSEXPR( SEXPR::SEXPR* aNode,
554 const std::function<void( SEXPR::SEXPR* )>& aVisitor )
555{
556 aVisitor( aNode );
557
558 if( aNode->IsList() )
559 {
560 for( unsigned i = 0; i < aNode->GetNumberOfChildren(); i++ )
561 traverseSEXPR( aNode->GetChild( i ), aVisitor );
562 }
563}
564
565
566void IFACE::SaveFileAs( const wxString& aProjectBasePath, const wxString& aProjectName,
567 const wxString& aNewProjectBasePath, const wxString& aNewProjectName,
568 const wxString& aSrcFilePath, wxString& aErrors )
569{
570 wxFileName destFile( aSrcFilePath );
571 wxString destPath = destFile.GetPathWithSep();
572 wxUniChar pathSep = wxFileName::GetPathSeparator();
573 wxString ext = destFile.GetExt();
574
575 if( destPath.StartsWith( aProjectBasePath + pathSep ) )
576 destPath.Replace( aProjectBasePath, aNewProjectBasePath, false );
577
578 destFile.SetPath( destPath );
579
584 {
585 if( destFile.GetName() == aProjectName )
586 {
587 destFile.SetName( aNewProjectName );
588 }
589 else if( destFile.GetName() == aNewProjectName )
590 {
591 wxString msg;
592
593 if( !aErrors.empty() )
594 aErrors += wxS( "\n" );
595
596 msg.Printf( _( "Cannot copy file '%s' as it will be overwritten by the new root "
597 "sheet file." ), destFile.GetFullPath() );
598 aErrors += msg;
599 return;
600 }
601
602 // Sheet paths when auto-generated are relative to the root, so those will stay
603 // pointing to whatever they were pointing at.
604 // The author can create their own absolute and relative sheet paths. Absolute
605 // sheet paths aren't an issue, and relative ones will continue to work as long
606 // as the author didn't include any '..'s. If they did, it's still not clear
607 // whether they should be adjusted or not (as the author may be duplicating an
608 // entire tree with several projects within it), so we leave this as an exercise
609 // to the author.
610
611 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
612 }
614 {
615 // Symbols are not project-specific. Keep their source names.
616 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
617 }
621 {
622 if( destFile.GetName() == aProjectName + wxS( "-cache" ) )
623 destFile.SetName( aNewProjectName + wxS( "-cache" ) );
624
625 if( destFile.GetName() == aProjectName + wxS( "-rescue" ) )
626 destFile.SetName( aNewProjectName + wxS( "-rescue" ) );
627
628 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
629 }
630 else if( ext == FILEEXT::NetlistFileExtension )
631 {
632 bool success = false;
633
634 if( destFile.GetName() == aProjectName )
635 destFile.SetName( aNewProjectName );
636
637 try
638 {
639 SEXPR::PARSER parser;
640 std::unique_ptr<SEXPR::SEXPR> sexpr( parser.ParseFromFile( TO_UTF8( aSrcFilePath ) ) );
641
642 traverseSEXPR( sexpr.get(), [&]( SEXPR::SEXPR* node )
643 {
644 if( node->IsList() && node->GetNumberOfChildren() > 1
645 && node->GetChild( 0 )->IsSymbol()
646 && node->GetChild( 0 )->GetSymbol() == "source" )
647 {
648 auto pathNode = dynamic_cast<SEXPR::SEXPR_STRING*>( node->GetChild( 1 ) );
649 auto symNode = dynamic_cast<SEXPR::SEXPR_SYMBOL*>( node->GetChild( 1 ) );
650 wxString path;
651
652 if( pathNode )
653 path = pathNode->m_value;
654 else if( symNode )
655 path = symNode->m_value;
656
657 if( path == aProjectName + wxS( ".sch" ) )
658 path = aNewProjectName + wxS( ".sch" );
659 else if( path == aProjectBasePath + "/" + aProjectName + wxS( ".sch" ) )
660 path = aNewProjectBasePath + "/" + aNewProjectName + wxS( ".sch" );
661 else if( path.StartsWith( aProjectBasePath ) )
662 path.Replace( aProjectBasePath, aNewProjectBasePath, false );
663
664 if( pathNode )
665 pathNode->m_value = path;
666 else if( symNode )
667 symNode->m_value = path;
668 }
669 } );
670
671 wxFFile destNetList( destFile.GetFullPath(), "wb" );
672
673 if( destNetList.IsOpened() )
674 success = destNetList.Write( sexpr->AsString( 0 ) );
675
676 // wxFFile dtor will close the file
677 }
678 catch( ... )
679 {
680 success = false;
681 }
682
683 if( !success )
684 {
685 wxString msg;
686
687 if( !aErrors.empty() )
688 aErrors += wxS( "\n" );
689
690 msg.Printf( _( "Cannot copy file '%s'." ), destFile.GetFullPath() );
691 aErrors += msg;
692 }
693 }
694 else if( destFile.GetName() == FILEEXT::SymbolLibraryTableFileName )
695 {
696 SYMBOL_LIB_TABLE symbolLibTable;
697 symbolLibTable.Load( aSrcFilePath );
698
699 for( unsigned i = 0; i < symbolLibTable.GetCount(); i++ )
700 {
701 LIB_TABLE_ROW& row = symbolLibTable.At( i );
702 wxString uri = row.GetFullURI();
703
704 uri.Replace( wxS( "/" ) + aProjectName + wxS( "-cache.lib" ),
705 wxS( "/" ) + aNewProjectName + wxS( "-cache.lib" ) );
706 uri.Replace( wxS( "/" ) + aProjectName + wxS( "-rescue.lib" ),
707 wxS( "/" ) + aNewProjectName + wxS( "-rescue.lib" ) );
708 uri.Replace( wxS( "/" ) + aProjectName + wxS( ".lib" ),
709 wxS( "/" ) + aNewProjectName + wxS( ".lib" ) );
710
711 row.SetFullURI( uri );
712 }
713
714 try
715 {
716 symbolLibTable.Save( destFile.GetFullPath() );
717 }
718 catch( ... )
719 {
720 wxString msg;
721
722 if( !aErrors.empty() )
723 aErrors += "\n";
724
725 msg.Printf( _( "Cannot copy file '%s'." ), destFile.GetFullPath() );
726 aErrors += msg;
727 }
728 }
729 else
730 {
731 wxFAIL_MSG( wxS( "Unexpected filetype for Eeschema::SaveFileAs()" ) );
732 }
733}
734
735
736int IFACE::HandleJob( JOB* aJob, REPORTER* aReporter )
737{
738 return m_jobHandler->RunJob( aJob, aReporter );
739}
740
741
742bool IFACE::HandleJobConfig( JOB* aJob, wxWindow* aParent )
743{
744 return m_jobHandler->HandleJobConfig( aJob, aParent );
745}
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:110
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static std::list< TOOL_ACTION * > & GetActionList()
Return list of TOOL_ACTIONs.
Class to hold basic information about controls that can be added to the toolbars.
static std::list< ACTION_TOOLBAR_CONTROL * > & GetCustomControlList()
Get the list of custom controls that could be used on toolbars.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
static PROGRESS_REPORTER & GetInstance()
static REPORTER & GetInstance()
Definition: reporter.cpp:159
static wxString GetGlobalTableFileName()
static bool LoadGlobalTable(DESIGN_BLOCK_LIB_TABLE &aTable)
Load the global design block library table into aTable.
static DESIGN_BLOCK_LIB_TABLE & GetGlobalLibTable()
int ShowModal() override
The base frame for deriving all KiCad main window classes.
static void SetSchEditFrame(SCH_EDIT_FRAME *aSchEditFrame)
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
An simple container class that lets us dispatch output jobs to kifaces.
Definition: job.h:182
A KIFACE implementation.
Definition: kiface_base.h:39
void InitSettings(APP_SETTINGS_BASE *aSettings)
Definition: kiface_base.h:97
void end_common()
Common things to do for a top program module, during OnKifaceEnd();.
Definition: kiface_base.cpp:42
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:95
bool start_common(int aCtlBits)
Common things to do for a top program module, during OnKifaceStart().
Definition: kiface_base.cpp:32
int m_start_flags
flags provided in OnKifaceStart()
Definition: kiface_base.h:125
bool IsSingle() const
Is this KIFACE running under single_top?
Definition: kiface_base.h:107
void CreateServer(int service, bool local=true)
Definition: eda_dde.cpp:43
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:285
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:406
FACE_T
Known KIFACE implementations.
Definition: kiway.h:291
@ FACE_SCH
eeschema DSO
Definition: kiway.h:292
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
void SetFullURI(const wxString &aFullURI)
Change the full URI for the library.
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
LIB_TABLE_ROW & At(unsigned aIndex)
Get the 'n'th LIB_TABLE_ROW object.
void Load(const wxString &aFileName)
Load the library table using the path defined by aFileName aFallBackTable.
unsigned GetCount() const
Get the number of rows contained in the table.
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
Generate the KiCad netlist format supported by Pcbnew.
void Format(OUTPUTFORMATTER *aOutputFormatter, int aCtl)
Output this s-expression netlist into aOutputFormatter.
Container for data for KiCad programs.
Definition: pgm_base.h:103
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:125
void HideSplash()
Definition: pgm_base.cpp:446
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:73
Schematic editor (Eeschema) main window.
Toolbar configuration for the schematic editor frame.
Base class that schematic file and library loading and saving plugins should derive from.
Definition: sch_io.h:57
virtual SCH_SHEET * LoadSchematicFile(const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const std::map< std::string, UTF8 > *aProperties=nullptr)
Load information from some input file format that this SCH_IO implementation knows about,...
Definition: sch_io.cpp:67
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:710
SCH_SCREEN * GetNext()
SCH_SCREEN * GetFirst()
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
void AnnotatePowerSymbols()
Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list.
void UpdateSymbolInstanceData(const std::vector< SCH_SYMBOL_INSTANCE > &aSymbolInstances)
Update all of the symbol instance information using aSymbolInstances.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:47
T * RegisterSettings(T *aSettings, bool aLoadNow=true)
Take ownership of the pointer passed in.
T * GetToolbarSettings(const wxString &aFilename)
Return a handle to the given toolbar settings.
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Load a project or sets up a new project with a specified path.
T * GetAppSettings(const wxString &aFilename)
Return a handle to the a given settings by type.
PROJECT & Prj() const
A helper while we are not MDI-capable – return the one and only project.
void FlushAndRelease(JSON_SETTINGS *aSettings, bool aSave=true)
If the given settings object is registered, save it to disk and unregister it.
std::unique_ptr< SEXPR > ParseFromFile(const std::string &aFilename)
size_t GetNumberOfChildren() const
Definition: sexpr.cpp:71
bool IsList() const
Definition: sexpr.h:49
SEXPR * GetChild(size_t aIndex) const
Definition: sexpr.cpp:49
The SIMULATOR_FRAME holds the main user-interface for running simulations.
Implement an OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:449
const std::string & GetString()
Definition: richio.h:472
Symbol library viewer main window.
The symbol library editor main window.
Toolbar configuration for the symbol editor frame.
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
static wxString GetGlobalTableFileName()
Fetch the global symbol library table file name.
static bool LoadGlobalTable(SYMBOL_LIB_TABLE &aTable)
Load the global symbol library table into aTable.
Symbol library viewer main window.
Represent a single user action.
Definition: tool_action.h:304
EDA_UNITS GetUserUnits() const
void SetUserUnits(EDA_UNITS aUnits)
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:195
This file is part of the common library.
#define _(s)
DDE server & client.
#define KICAD_SCH_PORT_SERVICE_NUMBER
Eeschema listens on this port for commands from Pcbnew.
Definition: eda_dde.h:43
EDA_UNITS
Definition: eda_units.h:46
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:77
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
Definition: eeschema.cpp:412
static void traverseSEXPR(SEXPR::SEXPR *aNode, const std::function< void(SEXPR::SEXPR *)> &aVisitor)
Definition: eeschema.cpp:553
@ PANEL_SYM_EDIT_GRIDS
Definition: frame_type.h:73
@ FRAME_SCH_SYMBOL_EDITOR
Definition: frame_type.h:35
@ PANEL_SCH_FIELD_NAME_TEMPLATES
Definition: frame_type.h:84
@ PANEL_SCH_TOOLBARS
Definition: frame_type.h:83
@ FRAME_SCH_VIEWER
Definition: frame_type.h:36
@ PANEL_SCH_DISP_OPTIONS
Definition: frame_type.h:78
@ PANEL_SCH_SIMULATOR
Definition: frame_type.h:85
@ FRAME_SCH
Definition: frame_type.h:34
@ PANEL_SYM_TOOLBARS
Definition: frame_type.h:76
@ FRAME_SIMULATOR
Definition: frame_type.h:38
@ PANEL_SYM_EDIT_OPTIONS
Definition: frame_type.h:74
@ PANEL_SCH_EDIT_OPTIONS
Definition: frame_type.h:80
@ PANEL_SYM_DISP_OPTIONS
Definition: frame_type.h:72
@ DIALOG_SCH_LIBRARY_TABLE
Definition: frame_type.h:124
@ PANEL_SYM_COLORS
Definition: frame_type.h:75
@ PANEL_SCH_ANNO_OPTIONS
Definition: frame_type.h:81
@ PANEL_SCH_GRIDS
Definition: frame_type.h:79
@ PANEL_SCH_COLORS
Definition: frame_type.h:82
@ DIALOG_DESIGN_BLOCK_LIBRARY_TABLE
Definition: frame_type.h:123
@ FRAME_SYMBOL_CHOOSER
Definition: frame_type.h:37
void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
Definition: gestfich.cpp:290
static const std::string LegacySchematicFileExtension
static const std::string NetlistFileExtension
static const std::string SymbolLibraryTableFileName
static const std::string SchematicSymbolFileExtension
static const std::string KiCadSchematicFileExtension
static const std::string LegacySymbolLibFileExtension
static const std::string KiCadSymbolLibFileExtension
static const std::string BackupFileSuffix
static const std::string LegacySymbolDocumentFileExtension
#define KIFACE_API
Definition: import_export.h:61
@ KIFACE_NETLIST_SCHEMATIC
Definition: kiface_ids.h:56
#define KFCTL_CLI
Running as CLI app.
Definition: kiway.h:161
#define KIFACE_GETTER
Definition: kiway.h:110
Definition: eeschema.cpp:80
static std::unique_ptr< SCHEMATIC > readSchematicFromFile(const std::string &aFilename)
Definition: eeschema.cpp:84
SCH::IFACE KIFACE_BASE, UNITS_PROVIDER kiface("eeschema", KIWAY::FACE_SCH)
bool generateSchematicNetlist(const wxString &aFilename, std::string &aNetlist)
Definition: eeschema.cpp:138
#define GNL_ALL
@ GNL_OPT_KICAD
void InvokeEditDesignBlockLibTable(KIWAY *aKiway, wxWindow *aParent)
void InvokeSchEditSymbolLibTable(KIWAY *aKiway, wxWindow *aParent)
PGM_BASE & Pgm()
The global program "get" accessor.
Definition: pgm_base.cpp:1073
see class PGM_BASE
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:403
bool OnKifaceStart(PGM_BASE *aProgram, int aCtlBits, KIWAY *aKiway) override
Typically start_common() is called from here.
Implement a participant in the KIWAY alchemy.
Definition: kiway.h:152
int HandleJob(JOB *aJob, REPORTER *aReporter) override
Definition: eeschema.cpp:736
bool OnKifaceStart(PGM_BASE *aProgram, int aCtlBits, KIWAY *aKiway) override
Typically start_common() is called from here.
Definition: eeschema.cpp:423
bool loadGlobalDesignBlockLibTable()
Definition: eeschema.cpp:512
void SaveFileAs(const wxString &aProjectBasePath, const wxString &aProjectName, const wxString &aNewProjectBasePath, const wxString &aNewProjectName, const wxString &aSrcFilePath, wxString &aErrors) override
Saving a file under a different name is delegated to the various KIFACEs because the project doesn't ...
Definition: eeschema.cpp:566
wxWindow * CreateKiWindow(wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
Create a wxWindow for the current project.
Definition: eeschema.cpp:166
IFACE(const char *aName, KIWAY::FACE_T aType)
Definition: eeschema.cpp:155
void Reset() override
Reloads global state.
Definition: eeschema.cpp:462
void * IfaceOrAddress(int aDataId) override
Return a pointer to the requested object.
Definition: eeschema.cpp:374
std::unique_ptr< EESCHEMA_JOBS_HANDLER > m_jobHandler
Definition: eeschema.cpp:403
bool loadGlobalLibTable()
Definition: eeschema.cpp:468
bool HandleJobConfig(JOB *aJob, wxWindow *aParent) override
Definition: eeschema.cpp:742
void OnKifaceEnd() override
Called just once just before the DSO is to be unloaded.
Definition: eeschema.cpp:547
Definition of file extensions used in Kicad.