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