#include <api_handler_common.h>

Inheritance diagram for API_HANDLER_COMMON:

Public Types
using	OPEN_DOCUMENT_HANDLER

using	CLOSE_DOCUMENT_HANDLER

Public Member Functions
	API_HANDLER_COMMON ()

	~API_HANDLER_COMMON () override

void	SetOpenDocumentHandler (OPEN_DOCUMENT_HANDLER aHandler)

void	SetCloseDocumentHandler (CLOSE_DOCUMENT_HANDLER aHandler)

API_RESULT	Handle (ApiRequest &aMsg)
	Attempt to handle the given API request, if a handler exists in this class for the message.

Protected Types
typedef std::function< HANDLER_RESULT< ApiResponse >(ApiRequest &)>	REQUEST_HANDLER
	A handler for outer messages (envelopes) that will unpack to inner messages and call a specific handler function.

Protected Member Functions
template<class RequestType, class ResponseType, class HandlerType>
void	registerHandler (HANDLER_RESULT< ResponseType >(HandlerType::*aHandler)(const HANDLER_CONTEXT< RequestType > &))
	Registers an API command handler for the given message types.

Protected Attributes
std::map< std::string, REQUEST_HANDLER >	m_handlers
	Maps type name (without the URL prefix) to a handler method.

Static Protected Attributes
static const wxString	m_defaultCommitMessage = _( "Modification from API" )

Private Member Functions
HANDLER_RESULT< commands::GetVersionResponse >	handleGetVersion (const HANDLER_CONTEXT< commands::GetVersion > &aCtx)

HANDLER_RESULT< commands::PathResponse >	handleGetKiCadBinaryPath (const HANDLER_CONTEXT< commands::GetKiCadBinaryPath > &aCtx)

HANDLER_RESULT< commands::NetClassesResponse >	handleGetNetClasses (const HANDLER_CONTEXT< commands::GetNetClasses > &aCtx)

HANDLER_RESULT< Empty >	handleSetNetClasses (const HANDLER_CONTEXT< commands::SetNetClasses > &aCtx)

HANDLER_RESULT< Empty >	handlePing (const HANDLER_CONTEXT< commands::Ping > &aCtx)

HANDLER_RESULT< types::Box2 >	handleGetTextExtents (const HANDLER_CONTEXT< commands::GetTextExtents > &aCtx)

HANDLER_RESULT< commands::GetTextAsShapesResponse >	handleGetTextAsShapes (const HANDLER_CONTEXT< commands::GetTextAsShapes > &aCtx)

HANDLER_RESULT< commands::ExpandTextVariablesResponse >	handleExpandTextVariables (const HANDLER_CONTEXT< commands::ExpandTextVariables > &aCtx)

HANDLER_RESULT< commands::StringResponse >	handleGetPluginSettingsPath (const HANDLER_CONTEXT< commands::GetPluginSettingsPath > &aCtx)

HANDLER_RESULT< project::TextVariables >	handleGetTextVariables (const HANDLER_CONTEXT< commands::GetTextVariables > &aCtx)

HANDLER_RESULT< Empty >	handleSetTextVariables (const HANDLER_CONTEXT< commands::SetTextVariables > &aCtx)

HANDLER_RESULT< commands::OpenDocumentResponse >	handleOpenDocument (const HANDLER_CONTEXT< commands::OpenDocument > &aCtx)

HANDLER_RESULT< Empty >	handleCloseDocument (const HANDLER_CONTEXT< commands::CloseDocument > &aCtx)

template<typename MessageType>
bool	tryUnpack (ApiRequest &aRequest, ApiResponse &aReply, MessageType &aDest)

Private Attributes
OPEN_DOCUMENT_HANDLER	m_openDocumentHandler

CLOSE_DOCUMENT_HANDLER	m_closeDocumentHandler

Detailed Description

Definition at line 35 of file api_handler_common.h.

Member Typedef Documentation

◆ CLOSE_DOCUMENT_HANDLER

using API_HANDLER_COMMON::CLOSE_DOCUMENT_HANDLER

Initial value:

std::function<HANDLER_RESULT<Empty>(

const commands::CloseDocument& )>

Definition at line 41 of file api_handler_common.h.

◆ OPEN_DOCUMENT_HANDLER

using API_HANDLER_COMMON::OPEN_DOCUMENT_HANDLER

Initial value:

std::function<HANDLER_RESULT<commands::OpenDocumentResponse>(

const commands::OpenDocument& )>

Definition at line 38 of file api_handler_common.h.

◆ REQUEST_HANDLER

typedef std::function<HANDLER_RESULT<ApiResponse>( ApiRequest& )> API_HANDLER::REQUEST_HANDLER

protectedinherited

A handler for outer messages (envelopes) that will unpack to inner messages and call a specific handler function.

See also: registerHandler.

Definition at line 76 of file api_handler.h.

Constructor & Destructor Documentation

◆ API_HANDLER_COMMON()

API_HANDLER_COMMON::API_HANDLER_COMMON ( )

Definition at line 45 of file api_handler_common.cpp.

References API_HANDLER::API_HANDLER(), handleCloseDocument(), handleExpandTextVariables(), handleGetKiCadBinaryPath(), handleGetNetClasses(), handleGetPluginSettingsPath(), handleGetTextAsShapes(), handleGetTextExtents(), handleGetTextVariables(), handleGetVersion(), handleOpenDocument(), handlePing(), handleSetNetClasses(), handleSetTextVariables(), and API_HANDLER::registerHandler().

◆ ~API_HANDLER_COMMON()

API_HANDLER_COMMON::~API_HANDLER_COMMON ( )

inlineoverride

Definition at line 46 of file api_handler_common.h.

Member Function Documentation

◆ Handle()

API_RESULT API_HANDLER::Handle ( ApiRequest & aMsg )

inherited

Attempt to handle the given API request, if a handler exists in this class for the message.

Parameters

aMsg	is a request to attempt to handle

Returns: a response to send to the client, or an appropriate error

Definition at line 30 of file api_handler.cpp.

References m_handlers.

◆ handleCloseDocument()

HANDLER_RESULT< Empty > API_HANDLER_COMMON::handleCloseDocument ( const HANDLER_CONTEXT< commands::CloseDocument > & aCtx )

private

Definition at line 422 of file api_handler_common.cpp.

References m_closeDocumentHandler, and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_COMMON().

◆ handleExpandTextVariables()

HANDLER_RESULT< ExpandTextVariablesResponse > API_HANDLER_COMMON::handleExpandTextVariables ( const HANDLER_CONTEXT< commands::ExpandTextVariables > & aCtx )

private

Definition at line 279 of file api_handler_common.cpp.

References ExpandTextVars(), PGM_BASE::GetSettingsManager(), Pgm(), SETTINGS_MANAGER::Prj(), project, HANDLER_CONTEXT< RequestMessageType >::Request, and result.

Referenced by API_HANDLER_COMMON().

◆ handleGetKiCadBinaryPath()

HANDLER_RESULT< PathResponse > API_HANDLER_COMMON::handleGetKiCadBinaryPath ( const HANDLER_CONTEXT< commands::GetKiCadBinaryPath > & aCtx )

private

Definition at line 89 of file api_handler_common.cpp.

References FindKicadFile(), path, and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_COMMON().

◆ handleGetNetClasses()

HANDLER_RESULT< NetClassesResponse > API_HANDLER_COMMON::handleGetNetClasses ( const HANDLER_CONTEXT< commands::GetNetClasses > & aCtx )

private

Definition at line 104 of file api_handler_common.cpp.

References PROJECT::GetProjectFile(), PGM_BASE::GetSettingsManager(), PROJECT_FILE::m_NetSettings, Pgm(), and SETTINGS_MANAGER::Prj().

Referenced by API_HANDLER_COMMON().

◆ handleGetPluginSettingsPath()

HANDLER_RESULT< StringResponse > API_HANDLER_COMMON::handleGetPluginSettingsPath ( const HANDLER_CONTEXT< commands::GetPluginSettingsPath > & aCtx )

private

Definition at line 303 of file api_handler_common.cpp.

References PATHS::EnsurePathExists(), PATHS::GetUserSettingsPath(), API_PLUGIN::IsValidIdentifier(), path, and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_COMMON().

◆ handleGetTextAsShapes()

HANDLER_RESULT< GetTextAsShapesResponse > API_HANDLER_COMMON::handleGetTextAsShapes ( const HANDLER_CONTEXT< commands::GetTextAsShapes > & aCtx )

private

Definition at line 201 of file api_handler_common.cpp.

References kiapi::common::PackVector2(), pcbIUScale, HANDLER_CONTEXT< RequestMessageType >::Request, EDA_SHAPE::Serialize(), text, kiapi::common::UnpackVector2(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by API_HANDLER_COMMON().

◆ handleGetTextExtents()

HANDLER_RESULT< types::Box2 > API_HANDLER_COMMON::handleGetTextExtents ( const HANDLER_CONTEXT< commands::GetTextExtents > & aCtx )

private

Definition at line 169 of file api_handler_common.cpp.

References BOX2< Vec >::GetBoundingBoxRotated(), BOX2< Vec >::GetPosition(), BOX2< Vec >::GetSize(), EDA_ANGLE::IsZero(), pcbIUScale, HANDLER_CONTEXT< RequestMessageType >::Request, text, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by API_HANDLER_COMMON().

◆ handleGetTextVariables()

HANDLER_RESULT< project::TextVariables > API_HANDLER_COMMON::handleGetTextVariables ( const HANDLER_CONTEXT< commands::GetTextVariables > & aCtx )

private

Definition at line 338 of file api_handler_common.cpp.

References PGM_BASE::GetSettingsManager(), Pgm(), SETTINGS_MANAGER::Prj(), project, and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_COMMON().

◆ handleGetVersion()

HANDLER_RESULT< GetVersionResponse > API_HANDLER_COMMON::handleGetVersion ( const HANDLER_CONTEXT< commands::GetVersion > & aCtx )

private

Definition at line 73 of file api_handler_common.cpp.

References GetBuildVersion(), and GetMajorMinorPatchTuple().

Referenced by API_HANDLER_COMMON().

◆ handleOpenDocument()

HANDLER_RESULT< OpenDocumentResponse > API_HANDLER_COMMON::handleOpenDocument ( const HANDLER_CONTEXT< commands::OpenDocument > & aCtx )

private

Definition at line 407 of file api_handler_common.cpp.

References m_openDocumentHandler, and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_COMMON().

◆ handlePing()

HANDLER_RESULT< Empty > API_HANDLER_COMMON::handlePing ( const HANDLER_CONTEXT< commands::Ping > & aCtx )

private

Definition at line 163 of file api_handler_common.cpp.

Referenced by API_HANDLER_COMMON().

◆ handleSetNetClasses()

HANDLER_RESULT< Empty > API_HANDLER_COMMON::handleSetNetClasses ( const HANDLER_CONTEXT< commands::SetNetClasses > & aCtx )

private

Definition at line 127 of file api_handler_common.cpp.

References PROJECT::GetProjectFile(), PGM_BASE::GetSettingsManager(), PROJECT_FILE::m_NetSettings, name, Pgm(), SETTINGS_MANAGER::Prj(), and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_COMMON().

◆ handleSetTextVariables()

HANDLER_RESULT< Empty > API_HANDLER_COMMON::handleSetTextVariables ( const HANDLER_CONTEXT< commands::SetTextVariables > & aCtx )

private

Definition at line 371 of file api_handler_common.cpp.

References PGM_BASE::GetSettingsManager(), Pgm(), SETTINGS_MANAGER::Prj(), project, HANDLER_CONTEXT< RequestMessageType >::Request, and SETTINGS_MANAGER::SaveProject().

Referenced by API_HANDLER_COMMON().

◆ registerHandler()

template<class RequestType, class ResponseType, class HandlerType>

void API_HANDLER::registerHandler ( HANDLER_RESULT< ResponseType >(HandlerType::* aHandler )(const HANDLER_CONTEXT< RequestType > &) )

inlineprotectedinherited

Registers an API command handler for the given message types.

When an API request matching the given type comes in, the handler will be called and its response will be packed into an envelope for sending back to the API client.

If the given message does not unpack into the request type, an envelope is returned with status AS_BAD_REQUEST, which probably indicates corruption in the message.

Template Parameters

RequestType	is a protobuf message type containing a command
ResponseType	is a protobuf message type containing a command response
HandlerType	is the implied type of the API_HANDLER subclass

Parameters

aHandler is the handler function for the given request and response types

Definition at line 93 of file api_handler.h.

References HANDLER_CONTEXT< RequestMessageType >::ClientName, m_handlers, HANDLER_CONTEXT< RequestMessageType >::Request, and tryUnpack().

Referenced by API_HANDLER_COMMON::API_HANDLER_COMMON(), API_HANDLER_EDITOR::API_HANDLER_EDITOR(), API_HANDLER_PCB::API_HANDLER_PCB(), and API_HANDLER_SCH::API_HANDLER_SCH().

◆ SetCloseDocumentHandler()

void API_HANDLER_COMMON::SetCloseDocumentHandler ( CLOSE_DOCUMENT_HANDLER aHandler )

inline

Definition at line 53 of file api_handler_common.h.

References m_closeDocumentHandler.

Referenced by CLI::API_SERVER_COMMAND::doPerform().

◆ SetOpenDocumentHandler()

void API_HANDLER_COMMON::SetOpenDocumentHandler ( OPEN_DOCUMENT_HANDLER aHandler )

inline

Definition at line 48 of file api_handler_common.h.

References m_openDocumentHandler.

Referenced by CLI::API_SERVER_COMMAND::doPerform().

◆ tryUnpack()

template<typename MessageType>

bool API_HANDLER::tryUnpack	(	ApiRequest &	aRequest,
		ApiResponse &	aReply,
		MessageType &	aDest )

inlineprivateinherited

Definition at line 136 of file api_handler.h.

Referenced by registerHandler().

Member Data Documentation

◆ m_closeDocumentHandler

CLOSE_DOCUMENT_HANDLER API_HANDLER_COMMON::m_closeDocumentHandler

private

Definition at line 99 of file api_handler_common.h.

Referenced by handleCloseDocument(), and SetCloseDocumentHandler().

◆ m_defaultCommitMessage

const wxString API_HANDLER::m_defaultCommitMessage = _( "Modification from API" )

staticprotectedinherited

Definition at line 131 of file api_handler.h.

Referenced by API_HANDLER_EDITOR::pushCurrentCommit().

◆ m_handlers

std::map<std::string, REQUEST_HANDLER> API_HANDLER::m_handlers

protectedinherited

Maps type name (without the URL prefix) to a handler method.

Definition at line 129 of file api_handler.h.

Referenced by Handle(), and registerHandler().

◆ m_openDocumentHandler

OPEN_DOCUMENT_HANDLER API_HANDLER_COMMON::m_openDocumentHandler

private

Definition at line 98 of file api_handler_common.h.

Referenced by handleOpenDocument(), and SetOpenDocumentHandler().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CLOSE_DOCUMENT_HANDLER

◆ OPEN_DOCUMENT_HANDLER

◆ REQUEST_HANDLER

Constructor & Destructor Documentation

◆ API_HANDLER_COMMON()

◆ ~API_HANDLER_COMMON()

Member Function Documentation

◆ Handle()

◆ handleCloseDocument()

◆ handleExpandTextVariables()

◆ handleGetKiCadBinaryPath()

◆ handleGetNetClasses()

◆ handleGetPluginSettingsPath()

◆ handleGetTextAsShapes()

◆ handleGetTextExtents()

◆ handleGetTextVariables()

◆ handleGetVersion()

◆ handleOpenDocument()

◆ handlePing()

◆ handleSetNetClasses()

◆ handleSetTextVariables()

◆ registerHandler()

◆ SetCloseDocumentHandler()

◆ SetOpenDocumentHandler()

◆ tryUnpack()

Member Data Documentation

◆ m_closeDocumentHandler

◆ m_defaultCommitMessage

◆ m_handlers

◆ m_openDocumentHandler