35#include <wx/snglinst.h>
63#include <python_scripting.h>
93 void Reset()
override;
98 int aCtlBits = 0 )
override
243 std::vector<TOOL_ACTION*> actions;
244 std::vector<ACTION_TOOLBAR_CONTROL*> controls;
247 actions.push_back( action );
250 controls.push_back( control );
310 BOARD* board =
nullptr;
325 std::vector<TOOL_ACTION*> actions;
326 std::vector<ACTION_TOOLBAR_CONTROL*> controls;
329 actions.push_back( action );
332 controls.push_back( control );
355 std::vector<TOOL_ACTION*> actions;
356 std::vector<ACTION_TOOLBAR_CONTROL*> controls;
359 actions.push_back( action );
362 controls.push_back( control );
411 void SaveFileAs(
const wxString& aProjectBasePath,
const wxString& aSrcProjectName,
412 const wxString& aNewProjectBasePath,
const wxString& aNewProjectName,
413 const wxString& aSrcFilePath, wxString& aErrors )
override;
488 m_jobHandler = std::make_unique<PCBNEW_JOBS_HANDLER>( aKiway );
510 if( !fn.FileExists() )
538 wxString msg =
_(
"An error occurred attempting to load the global footprint library "
540 "Please edit this global footprint library table in Preferences "
558 const wxString& aNewProjectBasePath,
const wxString& aNewProjectName,
559 const wxString& aSrcFilePath, wxString& aErrors )
561 wxFileName destFile( aSrcFilePath );
562 wxString destPath = destFile.GetPathWithSep();
563 wxUniChar pathSep = wxFileName::GetPathSeparator();
564 wxString ext = destFile.GetExt();
566 if( destPath.StartsWith( aProjectBasePath + pathSep ) )
567 destPath.Replace( aProjectBasePath, aNewProjectBasePath,
false );
569 wxString srcProjectFootprintLib = pathSep + aSrcProjectName + wxT(
".pretty" ) + pathSep;
570 wxString newProjectFootprintLib = pathSep + aNewProjectName + wxT(
".pretty" ) + pathSep;
572 destPath.Replace( srcProjectFootprintLib, newProjectFootprintLib,
true );
574 destFile.SetPath( destPath );
579 if( destFile.GetName() == aSrcProjectName )
580 destFile.SetName( aNewProjectName );
582 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
586 if( destFile.GetName() == aSrcProjectName )
587 destFile.SetName( aNewProjectName );
589 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
595 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
601 else if( ext == wxT(
"rpt" ) )
607 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
614 fpLibTable.
Load( aSrcFilePath );
616 for(
unsigned i = 0; i < fpLibTable.
GetCount(); i++ )
621 uri.Replace( wxT(
"/" ) + aSrcProjectName + wxT(
".pretty" ),
622 wxT(
"/" ) + aNewProjectName + wxT(
".pretty" ) );
627 fpLibTable.
Save( destFile.GetFullPath() );
633 if( !aErrors.empty() )
634 aErrors += wxT(
"\n" );
636 msg.Printf(
_(
"Cannot copy file '%s'." ), destFile.GetFullPath() );
642 wxFAIL_MSG( wxT(
"Unexpected filetype for Pcbnew::SaveFileAs()" ) );
constexpr EDA_IU_SCALE pcbIUScale
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static std::list< TOOL_ACTION * > & GetActionList()
Return list of TOOL_ACTIONs.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Information pertinent to a Pcbnew printed circuit board.
static PROGRESS_REPORTER & GetInstance()
static REPORTER & GetInstance()
The base frame for deriving all KiCad main window classes.
static bool LoadGlobalTable(FP_LIB_TABLE &aTable)
Load the global footprint library table into aTable.
static wxString GetGlobalTableFileName()
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
An simple container class that lets us dispatch output jobs to kifaces.
void InitSettings(APP_SETTINGS_BASE *aSettings)
void end_common()
Common things to do for a top program module, during OnKifaceEnd();.
APP_SETTINGS_BASE * KifaceSettings() const
bool start_common(int aCtlBits)
Common things to do for a top program module, during OnKifaceStart().
int m_start_flags
flags provided in OnKifaceStart()
bool IsSingle() const
Is this KIFACE running under single_top?
void SetKiway(wxWindow *aDest, KIWAY *aKiway)
It is only used for debugging, since "this" is not a wxWindow*.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
FACE_T
Known KIFACE implementations.
virtual void CommonSettingsChanged(int aFlags=0)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
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.
The main frame for Pcbnew.
Container for data for KiCad programs.
virtual SETTINGS_MANAGER & GetSettingsManager() const
A pure virtual class used to derive REPORTER objects from.
T * GetAppSettings(const char *aFilename)
Return a handle to the a given settings by type.
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.
void FlushAndRelease(JSON_SETTINGS *aSettings, bool aSave=true)
If the given settings object is registered, save it to disk and unregister it.
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.
This file is part of the common library.
FP_LIB_TABLE GFootprintTable
The global footprint library table.
#define KICAD_PCB_PORT_SERVICE_NUMBER
Pcbnew listens on this port for commands from Eeschema.
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
@ PANEL_FP_DEFAULT_GRAPHICS_VALUES
@ PANEL_FP_DISPLAY_OPTIONS
@ DIALOG_PCB_LIBRARY_TABLE
@ FRAME_FOOTPRINT_PREVIEW
@ FRAME_FOOTPRINT_CHOOSER
@ PANEL_FP_DEFAULT_FIELDS
@ PANEL_PCB_ACTION_PLUGINS
@ PANEL_3DV_DISPLAY_OPTIONS
void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
static const std::string LegacyPcbFileExtension
static const std::string FootprintLibraryTableFileName
static const std::string BackupFileSuffix
static const std::string LegacyFootprintLibPathExtension
static const std::string FootprintAssignmentFileExtension
static const std::string KiCadFootprintFileExtension
static const std::string KiCadPcbFileExtension
@ KIFACE_SCRIPTING_LEGACY
@ KIFACE_FOOTPRINT_LIST
Return a pointer to the global instance of FOOTPRINT_LIST from pcbnew.
@ KIFACE_GLOBAL_FOOTPRINT_TABLE
Return the global FP_LIB_TABLE.
@ KIFACE_NEW_FOOTPRINT_TABLE
Return a new FP_LIB_TABLE with the global table installed as a fallback.
#define KFCTL_CLI
Running as CLI app.
This file contains miscellaneous commonly used macros and functions.
PCB::IFACE KIFACE_BASE, UNITS_PROVIDER kiface("pcbnew", KIWAY::FACE_PCB)
void InvokePcbLibTableEditor(KIWAY *aKiway, wxWindow *aCaller)
Function InvokePcbLibTableEditor shows the modal DIALOG_FP_LIB_TABLE for purposes of editing the glob...
PyObject * PyInit__pcbnew(void)
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
FP_LIB_TABLE GFootprintTable
The global footprint library table.
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
void ScriptingSetPcbEditFrame(PCB_EDIT_FRAME *aPcbEditFrame)
PGM_BASE & Pgm()
The global program "get" accessor.
bool OnKifaceStart(PGM_BASE *aProgram, int aCtlBits, KIWAY *aKiway) override
Typically start_common() is called from here.
Implement a participant in the KIWAY alchemy.
int HandleJob(JOB *aJob, REPORTER *aReporter) override
bool OnKifaceStart(PGM_BASE *aProgram, int aCtlBits, KIWAY *aKiway) override
Typically start_common() is called from here.
void SaveFileAs(const wxString &aProjectBasePath, const wxString &aSrcProjectName, 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 ...
void * IfaceOrAddress(int aDataId) override
Return a pointer to the requested object.
void Reset() override
Reloads global state.
wxWindow * CreateKiWindow(wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
Create a wxWindow for the current project.
IFACE(const char *aName, KIWAY::FACE_T aType)
bool loadGlobalLibTable()
std::unique_ptr< PCBNEW_JOBS_HANDLER > m_jobHandler
bool HandleJobConfig(JOB *aJob, wxWindow *aParent) override
void OnKifaceEnd() override
Called just once just before the DSO is to be unloaded.
Definition of file extensions used in Kicad.