Responsible for loading plugin definitions for API-based plugins (ones that do not run inside KiCad itself, but instead are launched as external processes by KiCad) More...

#include <api_plugin_manager.h>

Inheritance diagram for API_PLUGIN_MANAGER:

Classes
struct	JOB

Public Member Functions
	API_PLUGIN_MANAGER (wxEvtHandler *aParent)

void	ReloadPlugins (std::optional< wxString > aDirectoryToScan=std::nullopt)
	Clears the loaded plugins and actions and re-scans the filesystem to register new ones.

void	RecreatePluginEnvironment (const wxString &aIdentifier)

void	InvokeAction (const wxString &aIdentifier)

int	InvokeActionSync (const wxString &aIdentifier, std::vector< wxString > aExtraArgs, wxString aStdout=nullptr, wxString aStderr=nullptr)
	Invokes an action synchronously, capturing its output.

bool	Busy () const

std::optional< const PLUGIN_ACTION * >	GetAction (const wxString &aIdentifier)

std::vector< const PLUGIN_ACTION * >	GetActionsForScope (PLUGIN_ACTION_SCOPE aScope)

std::map< int, wxString > &	ButtonBindings ()

std::map< int, wxString > &	MenuBindings ()

Private Types
enum class	JOB_TYPE { CREATE_ENV , SETUP_ENV , INSTALL_REQUIREMENTS }

Private Member Functions
void	processPluginDependencies ()

void	processNextJob (wxCommandEvent &aEvent)

int	doInvokeAction (const wxString &aIdentifier, std::vector< wxString > aExtraArgs, bool aSync=false, wxString aStdout=nullptr, wxString aStderr=nullptr)

Private Attributes
wxEvtHandler *	m_parent

std::set< std::unique_ptr< API_PLUGIN >, CompareApiPluginIdentifiers >	m_plugins

std::map< wxString, const API_PLUGIN * >	m_pluginsCache

std::map< wxString, const PLUGIN_ACTION * >	m_actionsCache

std::map< wxString, wxString >	m_environmentCache
	Map of plugin identifier to a path for the plugin's virtual environment, if it has one.

std::map< int, wxString >	m_buttonBindings
	Map of button wx item id to action identifier.

std::map< int, wxString >	m_menuBindings
	Map of menu wx item id to action identifier.

std::set< wxString >	m_readyPlugins

std::set< wxString >	m_busyPlugins

std::deque< JOB >	m_jobs

std::unique_ptr< JSON_SCHEMA_VALIDATOR >	m_schema_validator

long	m_lastPid

wxTimer *	m_raiseTimer

Detailed Description

Responsible for loading plugin definitions for API-based plugins (ones that do not run inside KiCad itself, but instead are launched as external processes by KiCad)

Definition at line 43 of file api_plugin_manager.h.

Member Enumeration Documentation

◆ JOB_TYPE

enum class API_PLUGIN_MANAGER::JOB_TYPE

strongprivate

Enumerator
CREATE_ENV
SETUP_ENV
INSTALL_REQUIREMENTS

Definition at line 112 of file api_plugin_manager.h.

Constructor & Destructor Documentation

◆ API_PLUGIN_MANAGER()

API_PLUGIN_MANAGER::API_PLUGIN_MANAGER ( wxEvtHandler * aParent )

Definition at line 45 of file api_plugin_manager.cpp.

References FN_NORMALIZE_FLAGS, PATHS::GetStockDataPath(), m_lastPid, m_parent, m_raiseTimer, m_schema_validator, and processNextJob().

Member Function Documentation

◆ Busy()

bool API_PLUGIN_MANAGER::Busy ( ) const

Definition at line 752 of file api_plugin_manager.cpp.

References m_busyPlugins, and m_jobs.

◆ ButtonBindings()

std::map< int, wxString > & API_PLUGIN_MANAGER::ButtonBindings ( )

inline

Definition at line 78 of file api_plugin_manager.h.

References m_buttonBindings.

Referenced by EDA_DRAW_FRAME::AddApiPluginTools(), and EDA_DRAW_FRAME::OnApiPluginInvoke().

◆ doInvokeAction()

int API_PLUGIN_MANAGER::doInvokeAction	(	const wxString &	aIdentifier,
		std::vector< wxString >	aExtraArgs,
		bool	aSync = false,
		wxString *	aStdout = nullptr,
		wxString *	aStderr = nullptr )

private

◆ GetAction()

std::optional< const PLUGIN_ACTION * > API_PLUGIN_MANAGER::GetAction ( const wxString & aIdentifier )

Definition at line 218 of file api_plugin_manager.cpp.

References m_actionsCache.

Referenced by PLUGINS_GRID_TRICKS::doPopupSelection(), PLUGINS_GRID_TRICKS::showPopupMenu(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataFromWindow().

◆ GetActionsForScope()

std::vector< const PLUGIN_ACTION * > API_PLUGIN_MANAGER::GetActionsForScope ( PLUGIN_ACTION_SCOPE aScope )

Definition at line 448 of file api_plugin_manager.cpp.

References m_actionsCache, and m_readyPlugins.

Referenced by EDA_DRAW_FRAME::GetOrderedPluginActions(), and FOOTPRINT_WIZARD_MANAGER::ReloadWizards().

◆ InvokeAction()

void API_PLUGIN_MANAGER::InvokeAction ( const wxString & aIdentifier )

Definition at line 435 of file api_plugin_manager.cpp.

References doInvokeAction().

Referenced by EDA_DRAW_FRAME::OnApiPluginInvoke().

◆ InvokeActionSync()

int API_PLUGIN_MANAGER::InvokeActionSync	(	const wxString &	aIdentifier,
		std::vector< wxString >	aExtraArgs,
		wxString *	aStdout = nullptr,
		wxString *	aStderr = nullptr )

Invokes an action synchronously, capturing its output.

Mainly used for things like wizards that have actions that return quickly and pass data to KiCad via stdout.

Parameters

aIdentifier	is the plugin action to invoke
aExtraArgs	are extra arguments to pass to the action beyond the ones specified in the plugin configuration file
aStdout	is a pointer to a string to fill with the stdout output of the action
aStderr	is a pointer to a string to fill with the stderr output of the action