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 (C) 2004-2024 KiCad Developers, see change_log.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
70#include <wx/crt.h>
71
72// The main sheet of the project
74
75
76namespace SCH {
77
78
79static std::unique_ptr<SCHEMATIC> readSchematicFromFile( const std::string& aFilename )
80{
81 auto pi = SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD );
82 std::unique_ptr<SCHEMATIC> schematic = std::make_unique<SCHEMATIC>( nullptr );
83
84 auto &manager = Pgm().GetSettingsManager();
85
86 manager.LoadProject( "" );
87 schematic->Reset();
88 schematic->SetProject( &manager.Prj() );
89 schematic->SetRoot( pi->LoadSchematicFile( aFilename, schematic.get() ) );
90 schematic->CurrentSheet().push_back( &schematic->Root() );
91
92 SCH_SCREENS screens( schematic->Root() );
93
94 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
95 screen->UpdateLocalLibSymbolLinks();
96
97 SCH_SHEET_LIST sheets = schematic->Hierarchy();
98
99 // Restore all of the loaded symbol instances from the root sheet screen.
100 sheets.UpdateSymbolInstanceData( schematic->RootScreen()->GetSymbolInstances() );
101
102 if( schematic->RootScreen()->GetFileFormatVersionAtLoad() < 20230221 )
103 {
104 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
105 screen->FixLegacyPowerSymbolMismatches();
106 }
107
108 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
109 screen->MigrateSimModels();
110
111 sheets.AnnotatePowerSymbols();
112
113 // NOTE: This is required for multi-unit symbols to be correct
114 for( SCH_SHEET_PATH& sheet : sheets )
115 sheet.UpdateAllScreenReferences();
116
117 // NOTE: SchematicCleanUp is not called; QA schematics must already be clean or else
118 // SchematicCleanUp must be freed from its UI dependencies.
119
120 schematic->ConnectionGraph()->Recalculate( sheets, true );
121
122 return schematic;
123}
124
125
126bool generateSchematicNetlist( const wxString& aFilename, std::string& aNetlist )
127{
128 std::unique_ptr<SCHEMATIC> schematic = readSchematicFromFile( aFilename.ToStdString() );
129 NETLIST_EXPORTER_KICAD exporter( schematic.get() );
130 STRING_FORMATTER formatter;
131
132 exporter.Format( &formatter, GNL_ALL | GNL_OPT_KICAD );
133 aNetlist = formatter.GetString();
134
135 return true;
136}
137
138
139static struct IFACE : public KIFACE_BASE, public UNITS_PROVIDER
140{
141 // Of course all are virtual overloads, implementations of the KIFACE.
142
143 IFACE( const char* aName, KIWAY::FACE_T aType ) :
144 KIFACE_BASE( aName, aType ),
146 {}
147
148 bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits, KIWAY* aKiway ) override;
149
150 void Reset() override;
151
152 void OnKifaceEnd() override;
153
154 wxWindow* CreateKiWindow( wxWindow* aParent, int aClassId, KIWAY* aKiway,
155 int aCtlBits = 0 ) override
156 {
157 switch( aClassId )
158 {
159 case FRAME_SCH:
160 {
161 SCH_EDIT_FRAME* frame = new SCH_EDIT_FRAME( aKiway, aParent );
162
164
165 if( Kiface().IsSingle() )
166 {
167 // only run this under single_top, not under a project manager.
169 }
170
171 return frame;
172 }
173
175 {
176 SYMBOL_EDIT_FRAME* frame = new SYMBOL_EDIT_FRAME( aKiway, aParent );
177 return frame;
178 }
179
180 case FRAME_SIMULATOR:
181 {
182 SIMULATOR_FRAME* frame = new SIMULATOR_FRAME( aKiway, aParent );
183 return frame;
184 }
186 case FRAME_SCH_VIEWER:
187 {
188 SYMBOL_VIEWER_FRAME* frame = new SYMBOL_VIEWER_FRAME( aKiway, aParent );
189 return frame;
190 }
191
193 {
194 SYMBOL_CHOOSER_FRAME* frame = new SYMBOL_CHOOSER_FRAME( aKiway, aParent );
195 return frame;
196 }
197
199 InvokeSchEditSymbolLibTable( aKiway, aParent );
200 // Dialog has completed; nothing to return.
201 return nullptr;
202
204 InvokeEditDesignBlockLibTable( aKiway, aParent );
205 // Dialog has completed; nothing to return.
206 return nullptr;
207
209 {
213 return new PANEL_SYM_DISPLAY_OPTIONS( aParent, cfg );
215
217 {
220 EDA_BASE_FRAME* frame = aKiway->Player( FRAME_SCH_SYMBOL_EDITOR, false );
221
222 if( !frame )
223 frame = aKiway->Player( FRAME_SCH_VIEWER, false );
224
225 if( !frame )
226 frame = aKiway->Player( FRAME_SCH, false );
227
228 if( frame )
229 SetUserUnits( frame->GetUserUnits() );
230
231 return new PANEL_GRID_SETTINGS( aParent, this, frame, cfg, FRAME_SCH_SYMBOL_EDITOR );
232 }
233
235 {
236 EDA_BASE_FRAME* frame = aKiway->Player( FRAME_SCH_SYMBOL_EDITOR, false );
237
238 if( !frame )
239 frame = aKiway->Player( FRAME_SCH_VIEWER, false );
240
241 if( !frame )
242 frame = aKiway->Player( FRAME_SCH, false );
243
244 if( frame )
245 SetUserUnits( frame->GetUserUnits() );
246
247 return new PANEL_SYM_EDITING_OPTIONS( aParent, this, frame );
248 }
249
250 case PANEL_SYM_COLORS:
251 return new PANEL_SYM_COLOR_SETTINGS( aParent );
252
254 {
257
258 return new PANEL_EESCHEMA_DISPLAY_OPTIONS( aParent, cfg );
259 }
260
261 case PANEL_SCH_GRIDS:
262 {
265 EDA_BASE_FRAME* frame = aKiway->Player( FRAME_SCH, false );
266
267 if( !frame )
268 frame = aKiway->Player( FRAME_SCH_SYMBOL_EDITOR, false );
269
270 if( !frame )
271 frame = aKiway->Player( FRAME_SCH_VIEWER, false );
272
273 if( frame )
274 SetUserUnits( frame->GetUserUnits() );
275
276 return new PANEL_GRID_SETTINGS( aParent, this, frame, cfg, FRAME_SCH );
277 }
278
280 {
281 EDA_BASE_FRAME* frame = aKiway->Player( FRAME_SCH, false );
282
283 if( !frame )
284 frame = aKiway->Player( FRAME_SCH_SYMBOL_EDITOR, false );
285
286 if( !frame )
287 frame = aKiway->Player( FRAME_SCH_VIEWER, false );
288
289 if( frame )
290 SetUserUnits( frame->GetUserUnits() );
291
292 return new PANEL_EESCHEMA_EDITING_OPTIONS( aParent, this, frame );
293 }
294
296 {
297 EDA_BASE_FRAME* schSettingsProvider = aKiway->Player( FRAME_SCH, false );
298
299 return new PANEL_EESCHEMA_ANNOTATION_OPTIONS( aParent, schSettingsProvider );
300 }
301
302 case PANEL_SCH_COLORS:
303 return new PANEL_EESCHEMA_COLOR_SETTINGS( aParent );
304
306 return new PANEL_TEMPLATE_FIELDNAMES( aParent, nullptr );
307
309 return new PANEL_SIMULATOR_PREFERENCES( aParent );
310
311 default:
312 return nullptr;
313 }
314 }
315
326 void* IfaceOrAddress( int aDataId ) override
327 {
328 switch( aDataId )
329 {
331 return (void*) generateSchematicNetlist;
332 }
333
334 return nullptr;
335 }
336
342 void SaveFileAs( const wxString& aProjectBasePath, const wxString& aProjectName,
343 const wxString& aNewProjectBasePath, const wxString& aNewProjectName,
344 const wxString& aSrcFilePath, wxString& aErrors ) override;
345
346
347 int HandleJob( JOB* aJob ) override;
348
349 bool HandleJobConfig( JOB* aJob, wxWindow* aParent ) override;
350
351private:
352 bool loadGlobalLibTable();
354
355 std::unique_ptr<EESCHEMA_JOBS_HANDLER> m_jobHandler;
356
357} kiface( "eeschema", KIWAY::FACE_SCH );
358
359} // namespace
360
361using namespace SCH;
362
363
365
366
367// KIFACE_GETTER's actual spelling is a substitution macro found in kiway.h.
368// KIFACE_GETTER will not have name mangling due to declaration in kiway.h.
369KIFACE_API KIFACE* KIFACE_GETTER( int* aKIFACEversion, int aKiwayVersion, PGM_BASE* aProgram )
370{
371 return &kiface;
372}
373
374
375bool IFACE::OnKifaceStart( PGM_BASE* aProgram, int aCtlBits, KIWAY* aKiway )
376{
377 // This is process-level-initialization, not project-level-initialization of the DSO.
378 // Do nothing in here pertinent to a project!
380
381 // Register the symbol editor settings as well because they share a KiFACE and need to be
382 // loaded prior to use to avoid threading deadlocks
384 aProgram->GetSettingsManager().RegisterSettings( symSettings ); // manager takes ownership
385
386 // We intentionally register KifaceSettings after SYMBOL_EDITOR_SETTINGS
387 // In legacy configs, many settings were in a single editor config nd the migration routine
388 // for the main editor file will try and call into the now separate settings stores
389 // to move the settings into them
391
392 start_common( aCtlBits );
393
395 {
396 // we didnt get anywhere deregister the settings
397 aProgram->GetSettingsManager().FlushAndRelease( symSettings, false );
398 aProgram->GetSettingsManager().FlushAndRelease( KifaceSettings(), false );
399 return false;
400 }
401
402 m_jobHandler = std::make_unique<EESCHEMA_JOBS_HANDLER>( aKiway );
403
405 {
406 m_jobHandler->SetReporter( &CLI_REPORTER::GetInstance() );
407 m_jobHandler->SetProgressReporter( &CLI_PROGRESS_REPORTER::GetInstance() );
408 }
409
410 return true;
411}
412
413
415{
417}
418
419
421{
423
424 if( !fn.FileExists() )
425 {
426 if( !( m_start_flags & KFCTL_CLI ) )
427 {
428 // Ensure the splash screen does not hide the dialog:
429 Pgm().HideSplash();
430
431 DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG symDialog( nullptr );
432
433 if( symDialog.ShowModal() != wxID_OK )
434 return false;
435 }
436 }
437 else
438 {
439 try
440 {
441 // The global table is not related to a specific project. All projects
442 // will use the same global table. So the KIFACE::OnKifaceStart() contract
443 // of avoiding anything project specific is not violated here.
445 return false;
446 }
447 catch( const IO_ERROR& ioe )
448 {
449 // if we are here, a incorrect global symbol library table was found.
450 // Incorrect global symbol library table is not a fatal error:
451 // the user just has to edit the (partially) loaded table.
452 wxString msg =
453 _( "An error occurred attempting to load the global symbol library table.\n"
454 "Please edit this global symbol library table in Preferences menu." );
455
456 DisplayErrorMessage( nullptr, msg, ioe.What() );
457 }
458 }
459
460 return true;
461}
462
463
465{
467
468 if( !fn.FileExists() )
469 {
470 if( !( m_start_flags & KFCTL_CLI ) )
471 {
472 // Ensure the splash screen does not hide the dialog:
473 Pgm().HideSplash();
474
476
477 if( dbDialog.ShowModal() != wxID_OK )
478 return false;
479 }
480 }
481 else
482 {
483 try
484 {
485 // The global table is not related to a specific project. All projects
486 // will use the same global table. So the KIFACE::OnKifaceStart() contract
487 // of avoiding anything project specific is not violated here.
490 return false;
491 }
492 catch( const IO_ERROR& ioe )
493 {
494 // if we are here, a incorrect global design block library table was found.
495 // Incorrect global design block library table is not a fatal error:
496 // the user just has to edit the (partially) loaded table.
497 wxString msg = _(
498 "An error occurred attempting to load the global design block library table.\n"
499 "Please edit this global design block library table in Preferences menu." );
500
501 DisplayErrorMessage( nullptr, msg, ioe.What() );
502 }
503 }
504
505 return true;
506}
507
508
510{
511 end_common();
512}
513
514
515static void traverseSEXPR( SEXPR::SEXPR* aNode,
516 const std::function<void( SEXPR::SEXPR* )>& aVisitor )
517{
518 aVisitor( aNode );
519
520 if( aNode->IsList() )
521 {
522 for( unsigned i = 0; i < aNode->GetNumberOfChildren(); i++ )
523 traverseSEXPR( aNode->GetChild( i ), aVisitor );
524 }
525}
526
527
528void IFACE::SaveFileAs( const wxString& aProjectBasePath, const wxString& aProjectName,
529 const wxString& aNewProjectBasePath, const wxString& aNewProjectName,
530 const wxString& aSrcFilePath, wxString& aErrors )
531{
532 wxFileName destFile( aSrcFilePath );
533 wxString destPath = destFile.GetPathWithSep();
534 wxUniChar pathSep = wxFileName::GetPathSeparator();
535 wxString ext = destFile.GetExt();
536
537 if( destPath.StartsWith( aProjectBasePath + pathSep ) )
538 destPath.Replace( aProjectBasePath, aNewProjectBasePath, false );
539
540 destFile.SetPath( destPath );
541
546 {
547 if( destFile.GetName() == aProjectName )
548 {
549 destFile.SetName( aNewProjectName );
550 }
551 else if( destFile.GetName() == aNewProjectName )
552 {
553 wxString msg;
554
555 if( !aErrors.empty() )
556 aErrors += wxS( "\n" );
557
558 msg.Printf( _( "Cannot copy file '%s' as it will be overwritten by the new root "
559 "sheet file." ), destFile.GetFullPath() );
560 aErrors += msg;
561 return;
562 }
563
564 // Sheet paths when auto-generated are relative to the root, so those will stay
565 // pointing to whatever they were pointing at.
566 // The author can create their own absolute and relative sheet paths. Absolute
567 // sheet paths aren't an issue, and relative ones will continue to work as long
568 // as the author didn't include any '..'s. If they did, it's still not clear
569 // whether they should be adjusted or not (as the author may be duplicating an
570 // entire tree with several projects within it), so we leave this as an exercise
571 // to the author.
572
573 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
574 }
576 {
577 // Symbols are not project-specific. Keep their source names.
578 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
579 }
583 {
584 if( destFile.GetName() == aProjectName + wxS( "-cache" ) )
585 destFile.SetName( aNewProjectName + wxS( "-cache" ) );
586
587 if( destFile.GetName() == aProjectName + wxS( "-rescue" ) )
588 destFile.SetName( aNewProjectName + wxS( "-rescue" ) );
589
590 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
591 }
592 else if( ext == FILEEXT::NetlistFileExtension )
593 {
594 bool success = false;
595
596 if( destFile.GetName() == aProjectName )
597 destFile.SetName( aNewProjectName );
598
599 try
600 {
601 SEXPR::PARSER parser;
602 std::unique_ptr<SEXPR::SEXPR> sexpr( parser.ParseFromFile( TO_UTF8( aSrcFilePath ) ) );
603
604 traverseSEXPR( sexpr.get(), [&]( SEXPR::SEXPR* node )
605 {
606 if( node->IsList() && node->GetNumberOfChildren() > 1
607 && node->GetChild( 0 )->IsSymbol()
608 && node->GetChild( 0 )->GetSymbol() == "source" )
609 {
610 auto pathNode = dynamic_cast<SEXPR::SEXPR_STRING*>( node->GetChild( 1 ) );
611 auto symNode = dynamic_cast<SEXPR::SEXPR_SYMBOL*>( node->GetChild( 1 ) );
612 wxString path;
613
614 if( pathNode )
615 path = pathNode->m_value;
616 else if( symNode )
617 path = symNode->m_value;
618
619 if( path == aProjectName + wxS( ".sch" ) )
620 path = aNewProjectName + wxS( ".sch" );
621 else if( path == aProjectBasePath + "/" + aProjectName + wxS( ".sch" ) )
622 path = aNewProjectBasePath + "/" + aNewProjectName + wxS( ".sch" );
623 else if( path.StartsWith( aProjectBasePath ) )
624 path.Replace( aProjectBasePath, aNewProjectBasePath, false );
625
626 if( pathNode )
627 pathNode->m_value = path;
628 else if( symNode )
629 symNode->m_value = path;
630 }
631 } );
632
633 wxFFile destNetList( destFile.GetFullPath(), "wb" );
634
635 if( destNetList.IsOpened() )
636 success = destNetList.Write( sexpr->AsString( 0 ) );
637
638 // wxFFile dtor will close the file
639 }
640 catch( ... )
641 {
642 success = false;
643 }
644
645 if( !success )
646 {
647 wxString msg;
648
649 if( !aErrors.empty() )
650 aErrors += wxS( "\n" );
651
652 msg.Printf( _( "Cannot copy file '%s'." ), destFile.GetFullPath() );
653 aErrors += msg;
654 }
655 }
656 else if( destFile.GetName() == wxS( "sym-lib-table" ) )
657 {
658 SYMBOL_LIB_TABLE symbolLibTable;
659 symbolLibTable.Load( aSrcFilePath );
660
661 for( unsigned i = 0; i < symbolLibTable.GetCount(); i++ )
662 {
663 LIB_TABLE_ROW& row = symbolLibTable.At( i );
664 wxString uri = row.GetFullURI();
665
666 uri.Replace( wxS( "/" ) + aProjectName + wxS( "-cache.lib" ),
667 wxS( "/" ) + aNewProjectName + wxS( "-cache.lib" ) );
668 uri.Replace( wxS( "/" ) + aProjectName + wxS( "-rescue.lib" ),
669 wxS( "/" ) + aNewProjectName + wxS( "-rescue.lib" ) );
670 uri.Replace( wxS( "/" ) + aProjectName + wxS( ".lib" ),
671 wxS( "/" ) + aNewProjectName + wxS( ".lib" ) );
672
673 row.SetFullURI( uri );
674 }
675
676 try
677 {
678 symbolLibTable.Save( destFile.GetFullPath() );
679 }
680 catch( ... )
681 {
682 wxString msg;
683
684 if( !aErrors.empty() )
685 aErrors += "\n";
686
687 msg.Printf( _( "Cannot copy file '%s'." ), destFile.GetFullPath() );
688 aErrors += msg;
689 }
690 }
691 else
692 {
693 wxFAIL_MSG( wxS( "Unexpected filetype for Eeschema::SaveFileAs()" ) );
694 }
695}
696
697
699{
700 return m_jobHandler->RunJob( aJob );
701}
702
703
704bool IFACE::HandleJobConfig( JOB* aJob, wxWindow* aParent )
705{
706 return m_jobHandler->HandleJobConfig( aJob, aParent );
707}
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:110
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
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:142
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()
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:79
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:284
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:290
@ FACE_SCH
eeschema DSO
Definition: kiway.h:291
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:102
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:142
void HideSplash()
Definition: pgm_base.cpp:446
Schematic editor (Eeschema) main window.
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:712
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:57
T * GetAppSettings()
Returns a handle to the a given settings by type If the settings have already been loaded,...
T * RegisterSettings(T *aSettings, bool aLoadNow=true)
Takes ownership of the pointer passed in.
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
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:70
bool IsList() const
Definition: sexpr.h:49
SEXPR * GetChild(size_t aIndex) const
Definition: sexpr.cpp:48
The SIMULATOR_FRAME holds the main user-interface for running simulations.
Implement an OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:436
const std::string & GetString()
Definition: richio.h:459
Symbol library viewer main window.
The symbol library editor main window.
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.
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
Scripting window listens for commands for other apps.
Definition: eda_dde.h:43
EDA_UNITS
Definition: eda_units.h:46
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:73
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
Definition: eeschema.cpp:364
static void traverseSEXPR(SEXPR::SEXPR *aNode, const std::function< void(SEXPR::SEXPR *)> &aVisitor)
Definition: eeschema.cpp:515
@ 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:82
@ FRAME_SCH_VIEWER
Definition: frame_type.h:36
@ PANEL_SCH_DISP_OPTIONS
Definition: frame_type.h:77
@ PANEL_SCH_SIMULATOR
Definition: frame_type.h:83
@ FRAME_SCH
Definition: frame_type.h:34
@ FRAME_SIMULATOR
Definition: frame_type.h:38
@ PANEL_SYM_EDIT_OPTIONS
Definition: frame_type.h:74
@ PANEL_SCH_EDIT_OPTIONS
Definition: frame_type.h:79
@ PANEL_SYM_DISP_OPTIONS
Definition: frame_type.h:72
@ DIALOG_SCH_LIBRARY_TABLE
Definition: frame_type.h:116
@ PANEL_SYM_COLORS
Definition: frame_type.h:75
@ PANEL_SCH_ANNO_OPTIONS
Definition: frame_type.h:80
@ PANEL_SCH_GRIDS
Definition: frame_type.h:78
@ PANEL_SCH_COLORS
Definition: frame_type.h:81
@ DIALOG_DESIGN_BLOCK_LIBRARY_TABLE
Definition: frame_type.h:115
@ FRAME_SYMBOL_CHOOSER
Definition: frame_type.h:37
void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
Definition: gestfich.cpp:309
static const std::string LegacySchematicFileExtension
static const std::string NetlistFileExtension
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:160
#define KIFACE_GETTER
Definition: kiway.h:110
Definition: eeschema.cpp:76
static std::unique_ptr< SCHEMATIC > readSchematicFromFile(const std::string &aFilename)
Definition: eeschema.cpp:79
SCH::IFACE KIFACE_BASE, UNITS_PROVIDER kiface("eeschema", KIWAY::FACE_SCH)
bool generateSchematicNetlist(const wxString &aFilename, std::string &aNetlist)
Definition: eeschema.cpp:126
#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:1060
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:391
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:151
bool OnKifaceStart(PGM_BASE *aProgram, int aCtlBits, KIWAY *aKiway) override
Typically start_common() is called from here.
Definition: eeschema.cpp:375
bool loadGlobalDesignBlockLibTable()
Definition: eeschema.cpp:464
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:528
wxWindow * CreateKiWindow(wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
Create a wxWindow for the current project.
Definition: eeschema.cpp:154
IFACE(const char *aName, KIWAY::FACE_T aType)
Definition: eeschema.cpp:143
void Reset() override
Reloads global state.
Definition: eeschema.cpp:414
void * IfaceOrAddress(int aDataId) override
Return a pointer to the requested object.
Definition: eeschema.cpp:326
std::unique_ptr< EESCHEMA_JOBS_HANDLER > m_jobHandler
Definition: eeschema.cpp:355
bool loadGlobalLibTable()
Definition: eeschema.cpp:420
bool HandleJobConfig(JOB *aJob, wxWindow *aParent) override
Definition: eeschema.cpp:704
void OnKifaceEnd() override
Called just once just before the DSO is to be unloaded.
Definition: eeschema.cpp:509
int HandleJob(JOB *aJob) override
Definition: eeschema.cpp:698
Definition of file extensions used in Kicad.