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