#include <api_server.h>

Inheritance diagram for KICAD_API_SERVER:

Public Member Functions
	KICAD_API_SERVER (bool aAutoStart=true)

	~KICAD_API_SERVER ()

void	Start ()

void	Stop ()

bool	Running () const

void	RegisterHandler (API_HANDLER *aHandler)
	Adds a new request handler to the server.

void	DeregisterHandler (API_HANDLER *aHandler)

void	SetReadyToReply (bool aReady=true)

void	SetSocketPath (const wxString &aSocketPath)

std::string	SocketPath () const

const std::string &	Token () const

void	NotifyNetSettingsChanged ()
	Calls onNetSettingsChanged() on every registered handler, so that editors can update state derived from project net settings after they are changed via the API.

void	NotifyDocumentRenamed (kiapi::common::types::DocumentType aType, const wxString &aOldPath, const wxString &aNewPath)
	Notifies the host application that a document was saved to a new path.

void	SetRenameListener (std::function< void(kiapi::common::types::DocumentType, const wxString &, const wxString &)> aListener)
	Installs a callback to be invoked by NotifyDocumentRenamed.

Static Public Member Functions
static wxFileName	StandardSocketPath ()
	Return the default API socket path (without the ipc:// scheme).

static std::string	StandardSocketUrl ()
	Return the default API socket URL (including the ipc:// scheme).

Private Member Functions
void	onApiRequest (std::string *aRequest)
	Callback that executes on the server thread and generates an event that will be handled by the wxWidgets event loop to process an incoming request.

void	handleApiEvent (wxCommandEvent &aEvent)
	Event handler that receives the event on the main thread sent by onApiRequest.

void	handleApiRequestString (std::string &aRequestString)

void	log (const std::string &aOutput)

Private Attributes
std::unique_ptr< KINNG_REQUEST_SERVER >	m_server

std::set< API_HANDLER * >	m_handlers

std::string	m_token

std::atomic< bool >	m_readyToReply

std::function< void(kiapi::common::types::DocumentType, const wxString &, const wxString &)>	m_renameListener

wxString	m_socketPathOverride

wxFileName	m_logFilePath

Static Private Attributes
static wxString	s_logFileName = "api.log"

Detailed Description

Definition at line 44 of file api_server.h.

Constructor & Destructor Documentation

◆ KICAD_API_SERVER()

KICAD_API_SERVER::KICAD_API_SERVER ( bool aAutoStart = true )

Definition at line 53 of file api_server.cpp.

References m_readyToReply, m_token, Pgm(), and Start().

◆ ~KICAD_API_SERVER()

KICAD_API_SERVER::~KICAD_API_SERVER ( )

Definition at line 71 of file api_server.cpp.

References Stop().

Member Function Documentation

◆ DeregisterHandler()

void KICAD_API_SERVER::DeregisterHandler ( API_HANDLER * aHandler )

Definition at line 211 of file api_server.cpp.

References m_handlers, and API_HANDLER::setApiServer().

Referenced by PCB::IFACE::closeBoard(), PCB::IFACE::closeFootprint(), SCH::IFACE::closeSchematic(), SCH::IFACE::closeSymbol(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), PCB::IFACE::OnKifaceEnd(), SCH::IFACE::OnKifaceEnd(), FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME(), PCB_EDIT_FRAME::~PCB_EDIT_FRAME(), SCH_EDIT_FRAME::~SCH_EDIT_FRAME(), and SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME().

◆ handleApiEvent()

void KICAD_API_SERVER::handleApiEvent ( wxCommandEvent & aEvent )

private

Event handler that receives the event on the main thread sent by onApiRequest.

Parameters

aEvent will contain a pointer to an incoming API request string in the client data

Definition at line 263 of file api_server.cpp.

References handleApiRequestString().

Referenced by Start(), and Stop().

◆ handleApiRequestString()

void KICAD_API_SERVER::handleApiRequestString ( std::string & aRequestString )

private

Definition at line 270 of file api_server.cpp.

References ADVANCED_CFG::GetCfg(), log(), m_handlers, m_server, m_token, NotifyNetSettingsChanged(), and result.

Referenced by handleApiEvent().

◆ log()

void KICAD_API_SERVER::log ( const std::string & aOutput )

private

Definition at line 356 of file api_server.cpp.

References m_logFilePath, and TO_UTF8.

Referenced by handleApiRequestString(), onApiRequest(), and Start().

◆ NotifyDocumentRenamed()

void KICAD_API_SERVER::NotifyDocumentRenamed	(	kiapi::common::types::DocumentType	aType,
		const wxString &	aOldPath,
		const wxString &	aNewPath )

Notifies the host application that a document was saved to a new path.

Must be called from the main thread.

Definition at line 227 of file api_server.cpp.

References m_renameListener.

◆ NotifyNetSettingsChanged()

void KICAD_API_SERVER::NotifyNetSettingsChanged ( )

Calls onNetSettingsChanged() on every registered handler, so that editors can update state derived from project net settings after they are changed via the API.

Must be called from the main thread.

Definition at line 220 of file api_server.cpp.

References m_handlers.

Referenced by handleApiRequestString().

◆ onApiRequest()

void KICAD_API_SERVER::onApiRequest ( std::string * aRequest )

private

Callback that executes on the server thread and generates an event that will be handled by the wxWidgets event loop to process an incoming request.

Temporarily takes ownership of the request pointer so that it can be passed through the event system.

Parameters

aRequest is a pointer to a string containing bytes that came in over the wire

Definition at line 241 of file api_server.cpp.

References log(), m_readyToReply, and m_server.

Referenced by Start().

◆ RegisterHandler()

void KICAD_API_SERVER::RegisterHandler ( API_HANDLER * aHandler )

Adds a new request handler to the server.

Each handler maintains its own list of API messages that it knows how to handle, and the server will pass every incoming message to all handlers in succession until one of them handles it.

The caller is responsible for the lifetime of the handler and must call DeregisterHandler before the pointer is freed.

Parameters

aHandler is a pointer (non-owned) to API_HANDLER

Definition at line 202 of file api_server.cpp.

References m_handlers, and API_HANDLER::setApiServer().

Referenced by EVT_UPDATE_UI_RANGE(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), SCH::IFACE::HandleApiOpenDocument(), PCB::IFACE::handleCreatePcb(), SCH::IFACE::handleCreateSchematic(), PCB::IFACE::handleOpenFootprint(), PCB::IFACE::handleOpenPcb(), SCH::IFACE::handleOpenSymbol(), PCB::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), PCB::IFACE::RegisterLibraryHandlers(), SCH::IFACE::RegisterLibraryHandlers(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), and SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME().