eeschema.cpp File Reference

#include <pgm_base.h>
#include <kiface_base.h>
#include <confirm.h>
#include <gestfich.h>
#include <eda_dde.h>
#include "eeschema_jobs_handler.h"
#include "eeschema_helpers.h"
#include <eeschema_settings.h>
#include <sch_edit_frame.h>
#include <symbol_edit_frame.h>
#include <symbol_viewer_frame.h>
#include <transform.h>
#include <symbol_lib_table.h>
#include <dialogs/dialog_global_sym_lib_table_config.h>
#include <dialogs/panel_sym_lib_table.h>
#include <kiway.h>
#include <settings/settings_manager.h>
#include <symbol_editor_settings.h>
#include <sexpr/sexpr.h>
#include <sexpr/sexpr_parser.h>
#include <kiface_ids.h>
#include <netlist_exporters/netlist_exporter_kicad.h>
#include <wx/ffile.h>
#include <wildcards_and_files_ext.h>
#include <schematic.h>
#include <connection_graph.h>
#include <panel_template_fieldnames.h>
#include <panel_eeschema_color_settings.h>
#include <panel_sym_color_settings.h>
#include <panel_eeschema_editing_options.h>
#include <panel_eeschema_annotation_options.h>
#include <panel_sym_editing_options.h>
#include <dialogs/panel_gal_display_options.h>
#include <panel_eeschema_display_options.h>
#include <panel_sym_display_options.h>
#include <sim/sim_plot_frame.h>
#include <wx/crt.h>

Go to the source code of this file.

Classes
struct	SCH::IFACE

Namespaces
namespace	SCH

Functions
static std::unique_ptr< SCHEMATIC >	SCH::readSchematicFromFile (const std::string &aFilename)
bool	SCH::generateSchematicNetlist (const wxString &aFilename, wxString &aNetlist)
SCH::IFACE KIFACE_BASE, UNITS_PROVIDER	SCH::kiface ("eeschema", KIWAY::FACE_SCH)
	IFACE (const char *aName, KIWAY::FACE_T aType)
bool	OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override
void	OnKifaceEnd () override
wxWindow *	CreateKiWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
void *	IfaceOrAddress (int aDataId) override
	Return a pointer to the requested object. More...
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 know the internal format of the various files (which may have paths in them that need updating). More...
int	HandleJob (JOB *aJob) override
KIFACE_BASE &	Kiface ()
	Global KIFACE_BASE "get" accessor. More...
	MY_API (KIFACE *) KIFACE_GETTER(int *aKIFACEversion
PGM_BASE &	Pgm ()
	The global Program "get" accessor. More...
PGM_BASE *	PgmOrNull ()
	similar to PGM_BASE& Pgm(), but return a reference that can be nullptr when running a shared lib from a script, not from a kicad appl More...
static void	traverseSEXPR (SEXPR::SEXPR *aNode, const std::function< void(SEXPR::SEXPR *)> &aVisitor)

Variables
SCH_SHEET *	g_RootSheet = nullptr
std::unique_ptr< EESCHEMA_JOBS_HANDLER >	m_jobHandler
static PGM_BASE *	process
int	aKiwayVersion
int PGM_BASE *	aProgram
return &	kiface

Function Documentation

CreateKiWindow()

wxWindow * kiface::CreateKiWindow ( wxWindow *  aParent, int  aClassId, KIWAY *  aKiway, int  aCtlBits = 0  )

override

Definition at line 11 of file eeschema.cpp.

 :
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#include <pgm_base.h>
#include <kiface_base.h>
#include <confirm.h>
#include <gestfich.h>
#include <eda_dde.h>
#include "eeschema_jobs_handler.h"
#include "eeschema_helpers.h"
#include <eeschema_settings.h>
#include <sch_edit_frame.h>
#include <symbol_edit_frame.h>
#include <symbol_viewer_frame.h>
#include <transform.h>
#include <symbol_lib_table.h>
#include <dialogs/dialog_global_sym_lib_table_config.h>
#include <dialogs/panel_sym_lib_table.h>
#include <kiway.h>
#include <settings/settings_manager.h>
#include <symbol_editor_settings.h>
#include <sexpr/sexpr.h>
#include <sexpr/sexpr_parser.h>
#include <kiface_ids.h>
#include <netlist_exporters/netlist_exporter_kicad.h>
#include <wx/ffile.h>
#include <wildcards_and_files_ext.h>
 
#include <schematic.h>
#include <connection_graph.h>
#include <panel_template_fieldnames.h>
#include <panel_eeschema_color_settings.h>
#include <panel_sym_color_settings.h>
#include <panel_eeschema_editing_options.h>
#include <panel_eeschema_annotation_options.h>
#include <panel_sym_editing_options.h>
#include <dialogs/panel_gal_display_options.h>
#include <panel_eeschema_display_options.h>
#include <panel_sym_display_options.h>
#include <sim/sim_plot_frame.h>
 
#include <wx/crt.h>
 
// The main sheet of the project
SCH_SHEET* g_RootSheet = nullptr;
 
 
namespace SCH {
 
 
static std::unique_ptr<SCHEMATIC> readSchematicFromFile( const std::string& aFilename )
{
 auto pi = SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD );
 std::unique_ptr<SCHEMATIC> schematic = std::make_unique<SCHEMATIC>( nullptr );
 
 auto &manager = Pgm().GetSettingsManager();
 
 manager.LoadProject( "" );
 schematic->Reset();
 schematic->SetProject( &manager.Prj() );
 schematic->SetRoot( pi->Load( aFilename, schematic.get() ) );
 schematic->CurrentSheet().push_back( &schematic->Root() );
 
 SCH_SCREENS screens( schematic->Root() );
 
 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
 screen->UpdateLocalLibSymbolLinks();
 
 SCH_SHEET_LIST sheets = schematic->GetSheets();
 
 // Restore all of the loaded symbol instances from the root sheet screen.
 sheets.UpdateSymbolInstanceData( schematic->RootScreen()->GetSymbolInstances() );
 
 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
 screen->MigrateSimModels();
 
 sheets.AnnotatePowerSymbols();
 
 // NOTE: This is required for multi-unit symbols to be correct
 for( SCH_SHEET_PATH& sheet : sheets )
 sheet.UpdateAllScreenReferences();
 
 // NOTE: SchematicCleanUp is not called; QA schematics must already be clean or else
 // SchematicCleanUp must be freed from its UI dependencies.
 
 schematic->ConnectionGraph()->Recalculate( sheets, true );
 
 return schematic;
}
 
 
bool generateSchematicNetlist( const wxString& aFilename, wxString& aNetlist )
{
 std::unique_ptr<SCHEMATIC> schematic = readSchematicFromFile( aFilename.ToStdString() );
 NETLIST_EXPORTER_KICAD exporter( schematic.get() );
 STRING_FORMATTER formatter;
 
 exporter.Format( &formatter, GNL_ALL | GNL_OPT_KICAD );
 aNetlist = formatter.GetString();
 
 return true;
}

HandleJob()

int kiface::HandleJob ( JOB *  aJob )

override

IFACE()

kiface::IFACE	(	const char *	aName,
		KIWAY::FACE_T	aType
	)

Definition at line 2 of file eeschema.cpp.

 :
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html

IfaceOrAddress()

void * kiface::IfaceOrAddress ( int  aDataId )

override

Return a pointer to the requested object.

The safest way to use this is to retrieve a pointer to a static instance of an interface, similar to how the KIFACE interface is exported. But if you know what you are doing use it to retrieve anything you want.

Parameters

aDataId

identifies which object you want the address of.

Returns

the object requested and must be cast into the know type.

Definition at line 136 of file eeschema.cpp.

 {
 switch( aClassId )
 {
 case FRAME_SCH:

Kiface()

KIFACE_BASE & Kiface

(

)

Global KIFACE_BASE "get" accessor.

Definition at line 300 of file eeschema.cpp.

{ return kiface; }

References kiface.

Referenced by SCH::IFACE::CreateKiWindow().

MY_API()

MY_API

(

KIFACE *

)

OnKifaceEnd()

void kiface::OnKifaceEnd ( )

override

Definition at line 11 of file test_app_main.cpp.

:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html

OnKifaceStart()

bool kiface::OnKifaceStart ( PGM_BASE *  aProgram, int  aCtlBits  )

override

Definition at line 6 of file test_app_main.cpp.

 :
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html

Pgm()

PGM_BASE & Pgm

(

)

The global Program "get" accessor.

Implemented in: 1) common/single_top.cpp, 2) kicad/kicad.cpp, and 3) scripting/kiway.i

Definition at line 312 of file eeschema.cpp.

{
 wxASSERT( process ); // KIFACE_GETTER has already been called.
 return *process;
}

References process.

Referenced by SCH::readSchematicFromFile().

PgmOrNull()

PGM_BASE * PgmOrNull

(

)

similar to PGM_BASE& Pgm(), but return a reference that can be nullptr when running a shared lib from a script, not from a kicad appl

Definition at line 320 of file eeschema.cpp.

{
 return process;
}

References process.

SaveFileAs()

void kiface::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 know the internal format of the various files (which may have paths in them that need updating).

References KIWAY_PLAYER::CreateServer(), and KICAD_SCH_PORT_SERVICE_NUMBER.

traverseSEXPR()

static void traverseSEXPR ( SEXPR::SEXPR *  aNode, const std::function< void(SEXPR::SEXPR *)> &  aVisitor  )

static

Definition at line 381 of file eeschema.cpp.

{
 aVisitor( aNode );
 
 if( aNode->IsList() )
 {
 for( unsigned i = 0; i < aNode->GetNumberOfChildren(); i++ )
 traverseSEXPR( aNode->GetChild( i ), aVisitor );
 }
}

References SEXPR::SEXPR::GetChild(), SEXPR::SEXPR::GetNumberOfChildren(), SEXPR::SEXPR::IsList(), and traverseSEXPR().

Referenced by SCH::IFACE::SaveFileAs(), and traverseSEXPR().

Variable Documentation

aKiwayVersion

int aKiwayVersion

Definition at line 305 of file eeschema.cpp.

aProgram

int PGM_BASE* aProgram

Initial value:

{
 process = aProgram

Definition at line 305 of file eeschema.cpp.

Referenced by SCH::IFACE::OnKifaceStart().

g_RootSheet

SCH_SHEET* g_RootSheet = nullptr

Definition at line 67 of file eeschema.cpp.

kiface

return& kiface

Definition at line 308 of file eeschema.cpp.

Referenced by Kiface().

m_jobHandler

std::unique_ptr<EESCHEMA_JOBS_HANDLER> m_jobHandler

private

Definition at line 160 of file eeschema.cpp.

process

PGM_BASE* process

static

Definition at line 297 of file eeschema.cpp.

Referenced by Pgm(), and PgmOrNull().