#include <api_handler_sch.h>

Inheritance diagram for API_HANDLER_SCH:

Public Member Functions
	API_HANDLER_SCH (SCH_EDIT_FRAME *aFrame)

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
std::unique_ptr< COMMIT >	createCommit () override
	Override this to create an appropriate COMMIT subclass for the frame in question.

kiapi::common::types::DocumentType	thisDocumentType () const override
	Override this to specify which document type this editor handles.

bool	validateDocumentInternal (const DocumentSpecifier &aDocument) const override

HANDLER_RESULT< std::unique_ptr< EDA_ITEM > >	createItemForType (KICAD_T aType, EDA_ITEM *aContainer)

HANDLER_RESULT< types::ItemRequestStatus >	handleCreateUpdateItemsInternal (bool aCreate, const std::string &aClientName, const types::ItemHeader &aHeader, const google::protobuf::RepeatedPtrField< google::protobuf::Any > &aItems, std::function< void(commands::ItemStatus, google::protobuf::Any)> aItemHandler) override

void	deleteItemsInternal (std::map< KIID, ItemDeletionStatus > &aItemsToDelete, const std::string &aClientName) override

std::optional< EDA_ITEM * >	getItemFromDocument (const DocumentSpecifier &aDocument, const KIID &aId) override

HANDLER_RESULT< std::optional< KIID > >	validateItemHeaderDocument (const kiapi::common::types::ItemHeader &aHeader)
	If the header is valid, returns the item container.

HANDLER_RESULT< bool >	validateDocument (const DocumentSpecifier &aDocument)

virtual std::optional< ApiResponseStatus >	checkForBusy ()
	Checks if the editor can accept commands.

HANDLER_RESULT< commands::BeginCommitResponse >	handleBeginCommit (const HANDLER_CONTEXT< commands::BeginCommit > &aCtx)

HANDLER_RESULT< commands::EndCommitResponse >	handleEndCommit (const HANDLER_CONTEXT< commands::EndCommit > &aCtx)

COMMIT *	getCurrentCommit (const std::string &aClientName)

virtual void	pushCurrentCommit (const std::string &aClientName, const wxString &aMessage)

HANDLER_RESULT< commands::CreateItemsResponse >	handleCreateItems (const HANDLER_CONTEXT< commands::CreateItems > &aCtx)

HANDLER_RESULT< commands::UpdateItemsResponse >	handleUpdateItems (const HANDLER_CONTEXT< commands::UpdateItems > &aCtx)

HANDLER_RESULT< commands::DeleteItemsResponse >	handleDeleteItems (const HANDLER_CONTEXT< commands::DeleteItems > &aCtx)

HANDLER_RESULT< commands::HitTestResponse >	handleHitTest (const HANDLER_CONTEXT< commands::HitTest > &aCtx)

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, std::pair< KIID, std::unique_ptr< COMMIT > > >	m_commits

std::set< std::string >	m_activeClients

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::GetOpenDocumentsResponse >	handleGetOpenDocuments (const HANDLER_CONTEXT< commands::GetOpenDocuments > &aCtx)

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

Private Attributes
SCH_EDIT_FRAME *	m_frame

Detailed Description

Definition at line 35 of file api_handler_sch.h.

Member Typedef Documentation

◆ 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_SCH()

API_HANDLER_SCH::API_HANDLER_SCH ( SCH_EDIT_FRAME * aFrame )

Definition at line 37 of file api_handler_sch.cpp.

References handleGetOpenDocuments().

Member Function Documentation

◆ checkForBusy()

std::optional< ApiResponseStatus > API_HANDLER_EDITOR::checkForBusy ( )

protectedvirtualinherited

Checks if the editor can accept commands.

Returns: an error status if busy, std::nullopt if not busy

Definition at line 205 of file api_handler_editor.cpp.

References EDA_BASE_FRAME::CanAcceptApiCommands(), and API_HANDLER_EDITOR::m_frame.

◆ createCommit()

std::unique_ptr< COMMIT > API_HANDLER_SCH::createCommit ( )

overrideprotectedvirtual

Override this to create an appropriate COMMIT subclass for the frame in question.

Returns: a new COMMIT, bound to the editor frame

Implements API_HANDLER_EDITOR.

Definition at line 46 of file api_handler_sch.cpp.

References m_frame.

◆ createItemForType()

HANDLER_RESULT< std::unique_ptr< EDA_ITEM > > API_HANDLER_SCH::createItemForType	(	KICAD_T	aType,
		EDA_ITEM *	aContainer
	)

protected

Definition at line 88 of file api_handler_sch.cpp.

References CreateItemForType(), EDA_ITEM::GetFriendlyName(), SCH_PIN_T, and SCH_SYMBOL_T.

Referenced by handleCreateUpdateItemsInternal().

◆ deleteItemsInternal()

void API_HANDLER_SCH::deleteItemsInternal	(	std::map< KIID, ItemDeletionStatus > &	aItemsToDelete,
		const std::string &	aClientName
	)

overrideprotectedvirtual

Implements API_HANDLER_EDITOR.

Definition at line 285 of file api_handler_sch.cpp.

◆ getCurrentCommit()

COMMIT * API_HANDLER_EDITOR::getCurrentCommit ( const std::string & aClientName )

protectedinherited

Definition at line 129 of file api_handler_editor.cpp.

References API_HANDLER_EDITOR::createCommit(), and API_HANDLER_EDITOR::m_commits.

Referenced by API_HANDLER_PCB::deleteItemsInternal(), handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), and API_HANDLER_PCB::handleInteractiveMoveItems().

◆ getItemFromDocument()

std::optional< EDA_ITEM * > API_HANDLER_SCH::getItemFromDocument	(	const DocumentSpecifier &	aDocument,
		const KIID &	aId
	)

overrideprotectedvirtual

Implements API_HANDLER_EDITOR.

Definition at line 292 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::validateDocument().

◆ 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 API_HANDLER::m_handlers.

◆ handleBeginCommit()

HANDLER_RESULT< BeginCommitResponse > API_HANDLER_EDITOR::handleBeginCommit ( const HANDLER_CONTEXT< commands::BeginCommit > & aCtx )

protectedinherited

Definition at line 43 of file api_handler_editor.cpp.

References API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, API_HANDLER_EDITOR::createCommit(), API_HANDLER_EDITOR::m_activeClients, and API_HANDLER_EDITOR::m_commits.

Referenced by API_HANDLER_EDITOR::API_HANDLER_EDITOR().

◆ handleCreateItems()

HANDLER_RESULT< CreateItemsResponse > API_HANDLER_EDITOR::handleCreateItems ( const HANDLER_CONTEXT< commands::CreateItems > & aCtx )

protectedinherited

Definition at line 219 of file api_handler_editor.cpp.

References API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, API_HANDLER_EDITOR::handleCreateUpdateItemsInternal(), and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_EDITOR::API_HANDLER_EDITOR().

◆ handleCreateUpdateItemsInternal()

HANDLER_RESULT< ItemRequestStatus > API_HANDLER_SCH::handleCreateUpdateItemsInternal	(	bool	aCreate,
		const std::string &	aClientName,
		const types::ItemHeader &	aHeader,
		const google::protobuf::RepeatedPtrField< google::protobuf::Any > &	aItems,
		std::function< void(commands::ItemStatus, google::protobuf::Any)>	aItemHandler
	)

overrideprotectedvirtual

Implements API_HANDLER_EDITOR.

Definition at line 131 of file api_handler_sch.cpp.

References _, COMMIT::Add(), KIID::AsStdString(), EE_RTREE::begin(), createItemForType(), EE_RTREE::end(), API_HANDLER_EDITOR::getCurrentCommit(), SCH_EDIT_FRAME::GetScreen(), SCH_SCREEN::Items(), API_HANDLER_EDITOR::m_activeClients, m_frame, COMMIT::Modify(), API_HANDLER_EDITOR::pushCurrentCommit(), SERIALIZABLE::Serialize(), kiapi::common::TypeNameFromAny(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

◆ handleDeleteItems()

HANDLER_RESULT< DeleteItemsResponse > API_HANDLER_EDITOR::handleDeleteItems ( const HANDLER_CONTEXT< commands::DeleteItems > & aCtx )

protectedinherited

Definition at line 273 of file api_handler_editor.cpp.

References API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, API_HANDLER_EDITOR::deleteItemsInternal(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_EDITOR::API_HANDLER_EDITOR().

◆ handleEndCommit()

HANDLER_RESULT< EndCommitResponse > API_HANDLER_EDITOR::handleEndCommit ( const HANDLER_CONTEXT< commands::EndCommit > & aCtx )

protectedinherited

Definition at line 72 of file api_handler_editor.cpp.

References API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, API_HANDLER_EDITOR::m_activeClients, API_HANDLER_EDITOR::m_commits, API_HANDLER_EDITOR::pushCurrentCommit(), and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_EDITOR::API_HANDLER_EDITOR().

◆ handleGetOpenDocuments()

HANDLER_RESULT< GetOpenDocumentsResponse > API_HANDLER_SCH::handleGetOpenDocuments ( const HANDLER_CONTEXT< commands::GetOpenDocuments > & aCtx )

private

Definition at line 64 of file api_handler_sch.cpp.

References SCH_EDIT_FRAME::GetCurrentFileName(), m_frame, and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_SCH().

◆ handleHitTest()

HANDLER_RESULT< HitTestResponse > API_HANDLER_EDITOR::handleHitTest ( const HANDLER_CONTEXT< commands::HitTest > & aCtx )

protectedinherited

Definition at line 322 of file api_handler_editor.cpp.

References API_HANDLER_EDITOR::checkForBusy(), API_HANDLER_EDITOR::getItemFromDocument(), HANDLER_CONTEXT< RequestMessageType >::Request, kiapi::common::UnpackVector2(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_EDITOR::API_HANDLER_EDITOR().

◆ handleUpdateItems()

HANDLER_RESULT< UpdateItemsResponse > API_HANDLER_EDITOR::handleUpdateItems ( const HANDLER_CONTEXT< commands::UpdateItems > & aCtx )

protectedinherited

Definition at line 246 of file api_handler_editor.cpp.

References API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, API_HANDLER_EDITOR::handleCreateUpdateItemsInternal(), and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_EDITOR::API_HANDLER_EDITOR().

◆ pushCurrentCommit()

void API_HANDLER_EDITOR::pushCurrentCommit	(	const std::string &	aClientName,
		const wxString &	aMessage
	)

protectedvirtualinherited

Reimplemented in API_HANDLER_PCB.

Definition at line 141 of file api_handler_editor.cpp.

References API_HANDLER_EDITOR::m_activeClients, API_HANDLER_EDITOR::m_commits, and API_HANDLER::m_defaultCommitMessage.

Referenced by handleCreateUpdateItemsInternal(), API_HANDLER_EDITOR::handleEndCommit(), and API_HANDLER_PCB::pushCurrentCommit().

◆ registerHandler()

template<class RequestType , class ResponseType , class HandlerType >

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

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, and HANDLER_CONTEXT< RequestMessageType >::Request.

◆ thisDocumentType()

kiapi::common::types::DocumentType API_HANDLER_SCH::thisDocumentType ( ) const

inlineoverrideprotectedvirtual

Override this to specify which document type this editor handles.

Implements API_HANDLER_EDITOR.

Definition at line 43 of file api_handler_sch.h.

◆ tryUnpack()

template<typename MessageType >

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

inlineprivateinherited

Definition at line 136 of file api_handler.h.

◆ validateDocument()

HANDLER_RESULT< bool > API_HANDLER_EDITOR::validateDocument ( const DocumentSpecifier & aDocument )

protectedinherited

Definition at line 155 of file api_handler_editor.cpp.

References API_HANDLER_EDITOR::validateDocumentInternal().

◆ validateDocumentInternal()

bool API_HANDLER_SCH::validateDocumentInternal ( const DocumentSpecifier & aDocument ) const

overrideprotectedvirtual

Returns: true if the given document is valid for this editor and is currently open

Implements API_HANDLER_EDITOR.

Definition at line 52 of file api_handler_sch.cpp.

◆ validateItemHeaderDocument()

HANDLER_RESULT< std::optional< KIID > > API_HANDLER_EDITOR::validateItemHeaderDocument ( const kiapi::common::types::ItemHeader & aHeader )

protectedinherited

If the header is valid, returns the item container.

Definition at line 170 of file api_handler_editor.cpp.

References API_HANDLER_EDITOR::thisDocumentType(), API_HANDLER_EDITOR::validateDocument(), and API_HANDLER_EDITOR::validateDocumentInternal().

Referenced by handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), API_HANDLER_EDITOR::handleDeleteItems(), API_HANDLER_PCB::handleGetBoundingBox(), API_HANDLER_PCB::handleGetItems(), and API_HANDLER_EDITOR::handleHitTest().

Member Data Documentation

◆ m_activeClients

std::set<std::string> API_HANDLER_EDITOR::m_activeClients

protectedinherited

Definition at line 110 of file api_handler_editor.h.

Referenced by API_HANDLER_PCB::deleteItemsInternal(), API_HANDLER_EDITOR::handleBeginCommit(), handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), API_HANDLER_EDITOR::handleEndCommit(), and API_HANDLER_EDITOR::pushCurrentCommit().

◆ m_commits

std::map<std::string, std::pair<KIID, std::unique_ptr<COMMIT> > > API_HANDLER_EDITOR::m_commits

protectedinherited

Definition at line 108 of file api_handler_editor.h.

Referenced by API_HANDLER_EDITOR::getCurrentCommit(), API_HANDLER_EDITOR::handleBeginCommit(), API_HANDLER_EDITOR::handleEndCommit(), and API_HANDLER_EDITOR::pushCurrentCommit().

◆ 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_frame

SCH_EDIT_FRAME* API_HANDLER_SCH::m_frame

private

Definition at line 70 of file api_handler_sch.h.

Referenced by createCommit(), handleCreateUpdateItemsInternal(), and handleGetOpenDocuments().

◆ 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 API_HANDLER::Handle().

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ REQUEST_HANDLER

Constructor & Destructor Documentation

◆ API_HANDLER_SCH()

Member Function Documentation

◆ checkForBusy()

◆ createCommit()

◆ createItemForType()

◆ deleteItemsInternal()

◆ getCurrentCommit()

◆ getItemFromDocument()

◆ Handle()

◆ handleBeginCommit()

◆ handleCreateItems()

◆ handleCreateUpdateItemsInternal()

◆ handleDeleteItems()

◆ handleEndCommit()

◆ handleGetOpenDocuments()

◆ handleHitTest()

◆ handleUpdateItems()

◆ pushCurrentCommit()

◆ registerHandler()

◆ thisDocumentType()

◆ tryUnpack()

◆ validateDocument()

◆ validateDocumentInternal()

◆ validateItemHeaderDocument()

Member Data Documentation

◆ m_activeClients

◆ m_commits

◆ m_defaultCommitMessage

◆ m_frame

◆ m_handlers