#include <api_handler_sch.h>

Inheritance diagram for API_HANDLER_SCH:

Public Member Functions
	API_HANDLER_SCH (SCH_EDIT_FRAME *aFrame)

	API_HANDLER_SCH (std::shared_ptr< SCH_CONTEXT > aContext, SCH_EDIT_FRAME *aFrame=nullptr)

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.

const EDA_IU_SCALE &	getIuScale () const override
	Returns the internal-unit scale that the concrete editor uses.

tl::expected< bool, ApiResponseStatus >	validateDocumentInternal (const DocumentSpecifier &aDocument) const override

std::optional< SCH_ITEM * >	getItemById (const KIID &aId, SCH_SHEET_PATH *aPathOut=nullptr) const

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

std::optional< TITLE_BLOCK * >	getTitleBlock () override

std::optional< PAGE_INFO >	getPageSettings () override

bool	setPageSettings (const PAGE_INFO &aPageInfo) override

wxString	getDrawingSheetFileName () override

void	setDrawingSheetFileName (const wxString &aFileName) override

void	onModified () override

SCH_CONTEXT *	context () const

TOOL_MANAGER *	toolManager () const

PROJECT &	project () const

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)

HANDLER_RESULT< types::TitleBlockInfo >	handleGetTitleBlockInfo (const HANDLER_CONTEXT< commands::GetTitleBlockInfo > &aCtx)

HANDLER_RESULT< google::protobuf::Empty >	handleSetTitleBlockInfo (const HANDLER_CONTEXT< commands::SetTitleBlockInfo > &aCtx)

HANDLER_RESULT< types::PageSettings >	handleGetPageSettings (const HANDLER_CONTEXT< commands::GetPageSettings > &aCtx)

HANDLER_RESULT< types::PageSettings >	handleSetPageSettings (const HANDLER_CONTEXT< commands::SetPageSettings > &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.

Static Protected Member Functions
static std::vector< KICAD_T >	parseRequestedItemTypes (const google::protobuf::RepeatedField< int > &aTypes)

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< google::protobuf::Empty >	handleSaveDocument (const HANDLER_CONTEXT< commands::SaveDocument > &aCtx)

HANDLER_RESULT< google::protobuf::Empty >	handleSaveCopyOfDocument (const HANDLER_CONTEXT< commands::SaveCopyOfDocument > &aCtx)

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

HANDLER_RESULT< commands::GetItemsResponse >	handleGetItems (const HANDLER_CONTEXT< commands::GetItems > &aCtx)

HANDLER_RESULT< commands::GetItemsResponse >	handleGetItemsById (const HANDLER_CONTEXT< commands::GetItemsById > &aCtx)

HANDLER_RESULT< types::RunJobResponse >	handleRunSchematicJobExportSvg (const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportSvg > &aCtx)

HANDLER_RESULT< types::RunJobResponse >	handleRunSchematicJobExportDxf (const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportDxf > &aCtx)

HANDLER_RESULT< types::RunJobResponse >	handleRunSchematicJobExportPdf (const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportPdf > &aCtx)

HANDLER_RESULT< types::RunJobResponse >	handleRunSchematicJobExportPs (const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportPs > &aCtx)

HANDLER_RESULT< types::RunJobResponse >	handleRunSchematicJobExportNetlist (const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportNetlist > &aCtx)

HANDLER_RESULT< types::RunJobResponse >	handleRunSchematicJobExportBOM (const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportBOM > &aCtx)

HANDLER_RESULT< kiapi::schematic::types::SchematicHierarchyResponse >	handleGetSchematicHierarchy (const HANDLER_CONTEXT< kiapi::schematic::types::GetSchematicHierarchy > &aCtx)

void	packSheetInstance (kiapi::schematic::types::SheetInstance aInstance, SCH_SHEET_PATH &aPath, SCH_SHEET aSheet)

HANDLER_RESULT< kiapi::schematic::types::SchematicNetlistResponse >	handleGetSchematicNetlist (const HANDLER_CONTEXT< kiapi::schematic::types::GetSchematicNetlist > &aCtx)

SCHEMATIC *	schematic () const

void	filterValidSchTypes (std::set< KICAD_T > &aTypeList)

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

Private Attributes
SCH_EDIT_FRAME *	m_frame

std::shared_ptr< SCH_CONTEXT >	m_context

Static Private Attributes
static std::set< KICAD_T >	s_allowedTypes

Detailed Description

Definition at line 41 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() [1/2]

API_HANDLER_SCH::API_HANDLER_SCH ( SCH_EDIT_FRAME * aFrame )

Definition at line 101 of file api_handler_sch.cpp.

References API_HANDLER_SCH(), and CreateSchFrameContext().

Referenced by API_HANDLER_SCH().

◆ API_HANDLER_SCH() [2/2]

API_HANDLER_SCH::API_HANDLER_SCH	(	std::shared_ptr< SCH_CONTEXT >	aContext,
		SCH_EDIT_FRAME *	aFrame = nullptr )

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 222 of file api_handler_editor.cpp.

References m_frame.

◆ context()

SCH_CONTEXT * API_HANDLER_SCH::context ( ) const

inlineprotected

Definition at line 89 of file api_handler_sch.h.

References m_context.

Referenced by handleSaveCopyOfDocument(), handleSaveDocument(), project(), and toolManager().

◆ 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 145 of file api_handler_sch.cpp.

References m_frame, and toolManager().

◆ createItemForType()

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

protected

Definition at line 536 of file api_handler_sch.cpp.

References CreateItemForType(), EDA_ITEM::GetFriendlyName(), s_allowedTypes, SCH_PIN_T, SCH_SHEET_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 868 of file api_handler_sch.cpp.

References _, API_HANDLER_EDITOR::getCurrentCommit(), SCHEMATIC::Hierarchy(), API_HANDLER_EDITOR::m_activeClients, path, API_HANDLER_EDITOR::pushCurrentCommit(), COMMIT::Remove(), SCH_SHEET_LIST::ResolveItem(), s_allowedTypes, schematic(), and EDA_ITEM::Type().

◆ filterValidSchTypes()

void API_HANDLER_SCH::filterValidSchTypes ( std::set< KICAD_T > & aTypeList )

private

Definition at line 333 of file api_handler_sch.cpp.

References s_allowedTypes.

Referenced by handleGetItems().

◆ getCurrentCommit()

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

protectedinherited

Definition at line 152 of file api_handler_editor.cpp.

References createCommit(), and m_commits.

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

◆ getDrawingSheetFileName()

wxString API_HANDLER_SCH::getDrawingSheetFileName ( )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 933 of file api_handler_sch.cpp.

References BASE_SCREEN::m_DrawingSheetFileName.

◆ getItemById()

std::optional< SCH_ITEM * > API_HANDLER_SCH::getItemById	(	const KIID &	aId,
		SCH_SHEET_PATH *	aPathOut = nullptr ) const

protected

Definition at line 161 of file api_handler_sch.cpp.

References SCHEMATIC::RefreshHierarchy(), SCHEMATIC::ResolveItem(), and schematic().

◆ getItemFromDocument()

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

overrideprotectedvirtual

Implements API_HANDLER_EDITOR.

Definition at line 897 of file api_handler_sch.cpp.

References SCHEMATIC::Hierarchy(), SCH_SHEET_LIST::ResolveItem(), schematic(), and API_HANDLER_EDITOR::validateDocument().

◆ getIuScale()

const EDA_IU_SCALE & API_HANDLER_SCH::getIuScale ( ) const

inlineoverrideprotectedvirtual

Returns the internal-unit scale that the concrete editor uses.

API wire coordinates are always in nanometers, so this scale drives conversion to the editor's native IU. Defaults to pcbIUScale; schematic-like editors must override.

Reimplemented from API_HANDLER_EDITOR.

Definition at line 55 of file api_handler_sch.h.

References schIUScale.

◆ getPageSettings()

std::optional< PAGE_INFO > API_HANDLER_SCH::getPageSettings ( )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 918 of file api_handler_sch.cpp.

References m_context.

◆ getTitleBlock()

std::optional< TITLE_BLOCK * > API_HANDLER_SCH::getTitleBlock ( )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 911 of file api_handler_sch.cpp.

References m_context.

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

◆ handleBeginCommit()

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

protectedinherited

Definition at line 48 of file api_handler_editor.cpp.

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

Referenced by API_HANDLER_EDITOR().

◆ handleCreateItems()

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

protectedinherited

Definition at line 239 of file api_handler_editor.cpp.

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

Referenced by 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 600 of file api_handler_sch.cpp.

References _, COMMIT::Add(), SCH_SHEET::AddInstance(), createItemForType(), API_HANDLER_EDITOR::getCurrentCommit(), SCHEMATIC::GetCurrentScreen(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetInstances(), SCH_SHEET_LIST::GetNextPageNumber(), SCH_SHEET::GetScreen(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), SCHEMATIC::Hierarchy(), SCH_SHEET_PATH::LastScreen(), API_HANDLER_EDITOR::m_activeClients, m_context, SCH_SHEET_INSTANCE::m_PageNumber, SCH_SHEET_INSTANCE::m_Path, COMMIT::Modify(), PackSheet(), PackSymbol(), SCH_SHEET_PATH::Path(), path, SCH_SHEET_PATH::push_back(), API_HANDLER_EDITOR::pushCurrentCommit(), SCH_SHEET_PATH::ResolveItem(), result, SCH_SHEET_T, SCH_SYMBOL_T, schematic(), SERIALIZABLE::Serialize(), SCH_SHEET::SetScreen(), SCH_ITEM::SwapItemData(), SCH_SHEET_LIST::TestForRecursion(), EDA_ITEM::Type(), kiapi::common::TypeNameFromAny(), UnpackSheet(), kiapi::common::UnpackSheetPath(), UnpackSymbol(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

◆ handleDeleteItems()

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

protectedinherited

Definition at line 293 of file api_handler_editor.cpp.

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

Referenced by API_HANDLER_EDITOR().

◆ handleEndCommit()

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

protectedinherited

Definition at line 86 of file api_handler_editor.cpp.

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

Referenced by API_HANDLER_EDITOR().

◆ handleGetItems()

HANDLER_RESULT< GetItemsResponse > API_HANDLER_SCH::handleGetItems ( const HANDLER_CONTEXT< commands::GetItems > & aCtx )

private

◆ handleGetItemsById()

HANDLER_RESULT< GetItemsResponse > API_HANDLER_SCH::handleGetItemsById ( const HANDLER_CONTEXT< commands::GetItemsById > & aCtx )

private

Definition at line 453 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), SCHEMATIC::Hierarchy(), PackSheet(), PackSymbol(), HANDLER_CONTEXT< RequestMessageType >::Request, SCH_SHEET_LIST::ResolveItem(), s_allowedTypes, SCH_SHEET_T, SCH_SYMBOL_T, schematic(), SERIALIZABLE::Serialize(), EDA_ITEM::Type(), kiapi::common::UnpackSheetPath(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_SCH().

◆ handleGetOpenDocuments()

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

private

Definition at line 304 of file api_handler_sch.cpp.

References m_context, kiapi::common::PackProject(), kiapi::common::PackSheetPath(), path, and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_SCH().

◆ handleGetPageSettings()

HANDLER_RESULT< types::PageSettings > API_HANDLER_EDITOR::handleGetPageSettings ( const HANDLER_CONTEXT< commands::GetPageSettings > & aCtx )

protectedinherited

Definition at line 488 of file api_handler_editor.cpp.

References getDrawingSheetFileName(), getPageSettings(), PAGE_INFO::GetSizeIU(), PAGE_INFO::GetType(), PAGE_INFO::IsCustom(), PAGE_INFO::IsPortrait(), kiapi::common::PackVector2(), pcbIUScale, HANDLER_CONTEXT< RequestMessageType >::Request, ToProtoEnum(), and validateDocument().

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

◆ handleGetSchematicHierarchy()

HANDLER_RESULT< kiapi::schematic::types::SchematicHierarchyResponse > API_HANDLER_SCH::handleGetSchematicHierarchy ( const HANDLER_CONTEXT< kiapi::schematic::types::GetSchematicHierarchy > & aCtx )

private

Definition at line 1278 of file api_handler_sch.cpp.

References SCH_SHEET_PATH::ComparePageNum(), SCHEMATIC::GetTopLevelSheets(), packSheetInstance(), path, SCH_SHEET_PATH::push_back(), SCHEMATIC::RefreshHierarchy(), HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

◆ handleGetSchematicNetlist()

HANDLER_RESULT< kiapi::schematic::types::SchematicNetlistResponse > API_HANDLER_SCH::handleGetSchematicNetlist ( const HANDLER_CONTEXT< kiapi::schematic::types::GetSchematicNetlist > & aCtx )

private

Definition at line 1318 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), SCHEMATIC::ConnectionGraph(), CONNECTION_SUBGRAPH::GetDriverConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), CONNECTION_GRAPH::GetNetMap(), SCH_CONNECTION::IsBus(), kiapi::common::PackSheetPath(), API_HANDLER_EDITOR::parseRequestedItemTypes(), CONNECTION_SUBGRAPH::PIN, HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

◆ handleGetTitleBlockInfo()

HANDLER_RESULT< types::TitleBlockInfo > API_HANDLER_EDITOR::handleGetTitleBlockInfo ( const HANDLER_CONTEXT< commands::GetTitleBlockInfo > & aCtx )

protectedinherited

Definition at line 399 of file api_handler_editor.cpp.

References TITLE_BLOCK::GetComment(), TITLE_BLOCK::GetCompany(), TITLE_BLOCK::GetDate(), TITLE_BLOCK::GetRevision(), TITLE_BLOCK::GetTitle(), getTitleBlock(), HANDLER_CONTEXT< RequestMessageType >::Request, and validateDocument().

Referenced by API_HANDLER_EDITOR().

◆ handleHitTest()

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

protectedinherited

Definition at line 342 of file api_handler_editor.cpp.

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

Referenced by API_HANDLER_EDITOR().

◆ handleRunSchematicJobExportBOM()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_SCH::handleRunSchematicJobExportBOM ( const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportBOM > & aCtx )

private

Definition at line 1173 of file api_handler_sch.cpp.

Referenced by API_HANDLER_SCH().

◆ handleRunSchematicJobExportDxf()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_SCH::handleRunSchematicJobExportDxf ( const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportDxf > & aCtx )

private

Definition at line 1003 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteSchematicJob(), FromProtoEnum(), m_context, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

◆ handleRunSchematicJobExportNetlist()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_SCH::handleRunSchematicJobExportNetlist ( const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportNetlist > & aCtx )

private

Definition at line 1139 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteSchematicJob(), JOB_EXPORT_SCH_NETLIST::format, FromProtoEnum(), m_context, JOB_EXPORT_SCH_NETLIST::m_filename, JOB_EXPORT_SCH_NETLIST::m_variantNames, HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

◆ handleRunSchematicJobExportPdf()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_SCH::handleRunSchematicJobExportPdf ( const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportPdf > & aCtx )

private

Definition at line 1047 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteSchematicJob(), FromProtoEnum(), m_context, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

◆ handleRunSchematicJobExportPs()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_SCH::handleRunSchematicJobExportPs ( const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportPs > & aCtx )

private

Definition at line 1095 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteSchematicJob(), FromProtoEnum(), m_context, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

◆ handleRunSchematicJobExportSvg()

HANDLER_RESULT< types::RunJobResponse > API_HANDLER_SCH::handleRunSchematicJobExportSvg ( const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportSvg > & aCtx )

private

Definition at line 959 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), ExecuteSchematicJob(), FromProtoEnum(), m_context, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

◆ handleSaveCopyOfDocument()

HANDLER_RESULT< google::protobuf::Empty > API_HANDLER_SCH::handleSaveCopyOfDocument ( const HANDLER_CONTEXT< commands::SaveCopyOfDocument > & aCtx )

private

Definition at line 248 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), FILEEXT::KiCadSchematicFileExtension, project(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

◆ handleSaveDocument()

HANDLER_RESULT< google::protobuf::Empty > API_HANDLER_SCH::handleSaveDocument ( const HANDLER_CONTEXT< commands::SaveDocument > & aCtx )

private

Definition at line 225 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), context(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

◆ handleSetPageSettings()

HANDLER_RESULT< types::PageSettings > API_HANDLER_EDITOR::handleSetPageSettings ( const HANDLER_CONTEXT< commands::SetPageSettings > & aCtx )

protectedinherited

◆ handleSetTitleBlockInfo()

HANDLER_RESULT< google::protobuf::Empty > API_HANDLER_EDITOR::handleSetTitleBlockInfo ( const HANDLER_CONTEXT< commands::SetTitleBlockInfo > & aCtx )

protectedinherited

Definition at line 439 of file api_handler_editor.cpp.

References getTitleBlock(), onModified(), HANDLER_CONTEXT< RequestMessageType >::Request, TITLE_BLOCK::SetComment(), TITLE_BLOCK::SetCompany(), TITLE_BLOCK::SetDate(), TITLE_BLOCK::SetRevision(), TITLE_BLOCK::SetTitle(), and validateDocument().

Referenced by API_HANDLER_EDITOR().

◆ handleUpdateItems()

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

protectedinherited

Definition at line 266 of file api_handler_editor.cpp.

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

Referenced by API_HANDLER_EDITOR().

◆ onModified()

void API_HANDLER_SCH::onModified ( )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 949 of file api_handler_sch.cpp.

References m_frame.

◆ packSheetInstance()

void API_HANDLER_SCH::packSheetInstance	(	kiapi::schematic::types::SheetInstance *	aInstance,
		SCH_SHEET_PATH &	aPath,
		SCH_SHEET *	aSheet )

private

Definition at line 1230 of file api_handler_sch.cpp.

References SCH_SHEET_PATH::ComparePageNum(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), SCH_SHEET_PATH::GetPageNumber(), SCH_SHEET::GetScreen(), SCH_SCREEN::GetSheets(), SCH_SHEET::GetShownName(), packSheetInstance(), kiapi::common::PackSheetPath(), SCH_SHEET_PATH::Path(), SCH_SHEET_PATH::pop_back(), and SCH_SHEET_PATH::push_back().

Referenced by handleGetSchematicHierarchy(), and packSheetInstance().

◆ parseRequestedItemTypes()

std::vector< KICAD_T > API_HANDLER_EDITOR::parseRequestedItemTypes ( const google::protobuf::RepeatedField< int > & aTypes )

staticprotectedinherited

Definition at line 382 of file api_handler_editor.cpp.

References FromProtoEnum(), and TYPE_NOT_INIT.

Referenced by API_HANDLER_SCH::handleGetItems(), and API_HANDLER_SCH::handleGetSchematicNetlist().

◆ project()

PROJECT & API_HANDLER_SCH::project ( ) const

inlineprotected

Definition at line 93 of file api_handler_sch.h.

References context(), and SCH_CONTEXT::Prj().

Referenced by handleSaveCopyOfDocument().

◆ pushCurrentCommit()

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

protectedvirtualinherited

Reimplemented in API_HANDLER_BOARD.

Definition at line 164 of file api_handler_editor.cpp.

References m_activeClients, m_commits, and API_HANDLER::m_defaultCommitMessage.

Referenced by API_HANDLER_SCH::deleteItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), handleEndCommit(), and API_HANDLER_BOARD::pushCurrentCommit().

◆ 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_BOARD::API_HANDLER_BOARD(), API_HANDLER_COMMON::API_HANDLER_COMMON(), API_HANDLER_EDITOR::API_HANDLER_EDITOR(), API_HANDLER_FOOTPRINT::API_HANDLER_FOOTPRINT(), API_HANDLER_PCB::API_HANDLER_PCB(), and API_HANDLER_SCH::API_HANDLER_SCH().

◆ schematic()

SCHEMATIC * API_HANDLER_SCH::schematic ( ) const

private

Definition at line 154 of file api_handler_sch.cpp.

References m_context.

Referenced by deleteItemsInternal(), getItemById(), getItemFromDocument(), handleCreateUpdateItemsInternal(), handleGetItems(), handleGetItemsById(), handleGetSchematicHierarchy(), handleGetSchematicNetlist(), setDrawingSheetFileName(), and validateDocumentInternal().

◆ setDrawingSheetFileName()

void API_HANDLER_SCH::setDrawingSheetFileName ( const wxString & aFileName )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 939 of file api_handler_sch.cpp.

References BASE_SCREEN::m_DrawingSheetFileName, m_frame, SCHEMATIC_SETTINGS::m_SchDrawingSheetFileName, schematic(), and SCHEMATIC::Settings().

◆ setPageSettings()

bool API_HANDLER_SCH::setPageSettings ( const PAGE_INFO & aPageInfo )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 925 of file api_handler_sch.cpp.

References m_context.

◆ 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 50 of file api_handler_sch.h.

◆ toolManager()

TOOL_MANAGER * API_HANDLER_SCH::toolManager ( ) const

inlineprotected

Definition at line 91 of file api_handler_sch.h.

References context(), and SCH_CONTEXT::GetToolManager().

Referenced by createCommit().

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

◆ validateDocument()

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

protectedinherited

Definition at line 178 of file api_handler_editor.cpp.

References validateDocumentInternal().

◆ validateDocumentInternal()

tl::expected< bool, ApiResponseStatus > 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 176 of file api_handler_sch.cpp.

References PROJECT::GetProjectName(), PROJECT::GetProjectPath(), m_context, path, schematic(), and kiapi::common::UnpackSheetPath().

◆ 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 193 of file api_handler_editor.cpp.

References result, thisDocumentType(), validateDocument(), and validateDocumentInternal().

Referenced by API_HANDLER_BOARD::handleAddToSelection(), handleBeginCommit(), API_HANDLER_BOARD::handleClearSelection(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), handleDeleteItems(), handleEndCommit(), API_HANDLER_BOARD::handleGetBoundingBox(), API_HANDLER_PCB::handleGetConnectedItems(), API_HANDLER_FOOTPRINT::handleGetItems(), API_HANDLER_PCB::handleGetItems(), API_HANDLER_SCH::handleGetItems(), API_HANDLER_BOARD::handleGetItemsById(), API_HANDLER_SCH::handleGetItemsById(), API_HANDLER_PCB::handleGetItemsByNet(), API_HANDLER_PCB::handleGetItemsByNetClass(), API_HANDLER_BOARD::handleGetSelection(), handleHitTest(), and API_HANDLER_BOARD::handleRemoveFromSelection().

Member Data Documentation

◆ m_activeClients

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

protectedinherited

Definition at line 147 of file api_handler_editor.h.

Referenced by API_HANDLER_BOARD::deleteItemsInternal(), API_HANDLER_SCH::deleteItemsInternal(), handleBeginCommit(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), handleEndCommit(), and pushCurrentCommit().

◆ m_commits

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

protectedinherited

Definition at line 145 of file api_handler_editor.h.

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

◆ m_context

std::shared_ptr<SCH_CONTEXT> API_HANDLER_SCH::m_context

private

Definition at line 142 of file api_handler_sch.h.

Referenced by API_HANDLER_SCH(), context(), getPageSettings(), getTitleBlock(), handleCreateUpdateItemsInternal(), handleGetOpenDocuments(), handleRunSchematicJobExportBOM(), handleRunSchematicJobExportDxf(), handleRunSchematicJobExportNetlist(), handleRunSchematicJobExportPdf(), handleRunSchematicJobExportPs(), handleRunSchematicJobExportSvg(), schematic(), setPageSettings(), and validateDocumentInternal().

◆ 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 141 of file api_handler_sch.h.

Referenced by API_HANDLER_SCH(), createCommit(), onModified(), and setDrawingSheetFileName().

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

◆ s_allowedTypes

std::set< KICAD_T > API_HANDLER_SCH::s_allowedTypes

staticprivate

Initial value:

= {
    
    SCH_JUNCTION_T,
    SCH_NO_CONNECT_T,
    SCH_BUS_WIRE_ENTRY_T,
    SCH_BUS_BUS_ENTRY_T,
    SCH_LINE_T,
    SCH_SHAPE_T,
    SCH_BITMAP_T,
    SCH_TEXTBOX_T,
    SCH_TEXT_T,
    
    SCH_LABEL_T,
    SCH_GLOBAL_LABEL_T,
    SCH_GROUP_T,
    SCH_HIER_LABEL_T,
    SCH_DIRECTIVE_LABEL_T,
    SCH_SYMBOL_T,
    SCH_SHEET_T,
}

Definition at line 56 of file api_handler_sch.h.

Referenced by createItemForType(), deleteItemsInternal(), filterValidSchTypes(), handleGetItems(), and handleGetItemsById().

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

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ REQUEST_HANDLER

Constructor & Destructor Documentation

◆ API_HANDLER_SCH() [1/2]

◆ API_HANDLER_SCH() [2/2]

Member Function Documentation

◆ checkForBusy()

◆ context()

◆ createCommit()

◆ createItemForType()

◆ deleteItemsInternal()

◆ filterValidSchTypes()

◆ getCurrentCommit()

◆ getDrawingSheetFileName()

◆ getItemById()

◆ getItemFromDocument()

◆ getIuScale()

◆ getPageSettings()

◆ getTitleBlock()

◆ Handle()

◆ handleBeginCommit()

◆ handleCreateItems()

◆ handleCreateUpdateItemsInternal()

◆ handleDeleteItems()

◆ handleEndCommit()

◆ handleGetItems()

◆ handleGetItemsById()

◆ handleGetOpenDocuments()

◆ handleGetPageSettings()

◆ handleGetSchematicHierarchy()

◆ handleGetSchematicNetlist()

◆ handleGetTitleBlockInfo()

◆ handleHitTest()

◆ handleRunSchematicJobExportBOM()

◆ handleRunSchematicJobExportDxf()

◆ handleRunSchematicJobExportNetlist()

◆ handleRunSchematicJobExportPdf()

◆ handleRunSchematicJobExportPs()

◆ handleRunSchematicJobExportSvg()

◆ handleSaveCopyOfDocument()

◆ handleSaveDocument()

◆ handleSetPageSettings()

◆ handleSetTitleBlockInfo()

◆ handleUpdateItems()

◆ onModified()

◆ packSheetInstance()

◆ parseRequestedItemTypes()

◆ project()

◆ pushCurrentCommit()

◆ registerHandler()

◆ schematic()

◆ setDrawingSheetFileName()

◆ setPageSettings()

◆ thisDocumentType()

◆ toolManager()

◆ tryUnpack()

◆ validateDocument()

◆ validateDocumentInternal()

◆ validateItemHeaderDocument()

Member Data Documentation

◆ m_activeClients

◆ m_commits

◆ m_context

◆ m_defaultCommitMessage

◆ m_frame

◆ m_handlers

◆ s_allowedTypes