#include <api_handler_footprint.h>

Inheritance diagram for API_HANDLER_FOOTPRINT:

Public Member Functions
	API_HANDLER_FOOTPRINT (FOOTPRINT_EDIT_FRAME *aFrame)

	API_HANDLER_FOOTPRINT (std::shared_ptr< FOOTPRINT_CONTEXT > aContext, FOOTPRINT_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.

virtual void	onNetSettingsChanged ()
	Called on all registered handlers after project net settings (netclasses or netclass assignments) have been changed via the API.

void	requestNetSettingsNotification ()

bool	clearNetSettingsNotification ()
	Returns true if the notification had been requested at the time of the call.

void	setApiServer (KICAD_API_SERVER *aServer)
	Set by KICAD_API_SERVER::RegisterHandler; null when the handler is not registered.

KICAD_API_SERVER *	apiServer () const

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
kiapi::common::types::DocumentType	thisDocumentType () const override
	Override this to specify which document type this editor handles.

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

BOARD_ITEM_CONTAINER *	getDefaultContainer () override

std::unique_ptr< COMMIT >	createCommit () override
	Override this to create an appropriate COMMIT subclass for the frame in question.

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

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

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

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

BOARD_CONTEXT *	context () const

BOARD *	board () const

PROJECT &	project () const

TOOL_MANAGER *	toolManager () const

std::optional< BOARD_ITEM * >	getItemById (const KIID &aId) const

std::optional< ApiResponseStatus >	checkForHeadless (const std::string &aCommandName) const

GENERATOR_TOOL *	ensureGeneratorTool () const
	Creates the generator tool if needed (e.g. in headless mode); returns it if available.

void	regenerateGenerators (GENERATOR_TOOL aTool, BOARD_COMMIT aCommit, const std::vector< PCB_GENERATOR * > &aGenerators, std::function< void(const KIID &, commands::ItemStatus)> aResultHandler) const

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

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)

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)

virtual HANDLER_RESULT< commands::GetDocumentModifiedStateResponse >	handleGetDocumentModifiedState (const HANDLER_CONTEXT< commands::GetDocumentModifiedState > &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)

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

virtual std::optional< TITLE_BLOCK * >	getTitleBlock (const DocumentSpecifier &aDocument)

virtual std::optional< PAGE_INFO >	getPageSettings (const DocumentSpecifier &aDocument)

virtual bool	setPageSettings (const DocumentSpecifier &aDocument, const PAGE_INFO &aPageInfo)

virtual wxString	getDrawingSheetFileName ()

virtual void	setDrawingSheetFileName (const wxString &aFileName)

virtual void	onModified ()

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 HANDLER_RESULT< std::unique_ptr< BOARD_ITEM > >	createItemForType (KICAD_T aType, BOARD_ITEM_CONTAINER *aContainer)

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

std::set< std::string >	m_activeClients

EDA_BASE_FRAME *	m_frame

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

bool	m_notifyNetSettings = false

KICAD_API_SERVER *	m_apiServer = nullptr

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

Private Member Functions
HANDLER_RESULT< Empty >	handleOpenLibraryItem (const HANDLER_CONTEXT< commands::OpenLibraryItem > &aCtx)

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

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

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

HANDLER_RESULT< Empty >	handleRevertDocument (const HANDLER_CONTEXT< commands::RevertDocument > &aCtx)

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

FOOTPRINT_CONTEXT *	footprintContext () const

FOOTPRINT_EDIT_FRAME *	frame () const

HANDLER_RESULT< FOOTPRINT * >	validateAndGetFootprint (const DocumentSpecifier &aDocument)

HANDLER_RESULT< commands::RunActionResponse >	handleRunAction (const HANDLER_CONTEXT< commands::RunAction > &aCtx)

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

HANDLER_RESULT< commands::SelectionResponse >	handleGetSelection (const HANDLER_CONTEXT< commands::GetSelection > &aCtx)

HANDLER_RESULT< Empty >	handleClearSelection (const HANDLER_CONTEXT< commands::ClearSelection > &aCtx)

HANDLER_RESULT< commands::SelectionResponse >	handleAddToSelection (const HANDLER_CONTEXT< commands::AddToSelection > &aCtx)

HANDLER_RESULT< commands::SelectionResponse >	handleRemoveFromSelection (const HANDLER_CONTEXT< commands::RemoveFromSelection > &aCtx)

HANDLER_RESULT< Empty >	handleFocusOnItems (const HANDLER_CONTEXT< commands::FocusOnItems > &aCtx)

HANDLER_RESULT< BoardStackupResponse >	handleGetStackup (const HANDLER_CONTEXT< GetBoardStackup > &aCtx)

HANDLER_RESULT< BoardEnabledLayersResponse >	handleGetBoardEnabledLayers (const HANDLER_CONTEXT< GetBoardEnabledLayers > &aCtx)

HANDLER_RESULT< GraphicsDefaultsResponse >	handleGetGraphicsDefaults (const HANDLER_CONTEXT< GetGraphicsDefaults > &aCtx)

HANDLER_RESULT< commands::GetBoundingBoxResponse >	handleGetBoundingBox (const HANDLER_CONTEXT< commands::GetBoundingBox > &aCtx)

HANDLER_RESULT< BoardBoundingBoxResponse >	handleGetBoardBoundingBox (const HANDLER_CONTEXT< GetBoardBoundingBox > &aCtx)

HANDLER_RESULT< PadShapeAsPolygonResponse >	handleGetPadShapeAsPolygon (const HANDLER_CONTEXT< GetPadShapeAsPolygon > &aCtx)

HANDLER_RESULT< PadstackPresenceResponse >	handleCheckPadstackPresenceOnLayers (const HANDLER_CONTEXT< CheckPadstackPresenceOnLayers > &aCtx)

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

HANDLER_RESULT< Empty >	handleInteractiveMoveItems (const HANDLER_CONTEXT< InteractiveMoveItems > &aCtx)

HANDLER_RESULT< FlipItemsResponse >	handleFlipItems (const HANDLER_CONTEXT< FlipItems > &aCtx)

HANDLER_RESULT< commands::SavedDocumentResponse >	handleSaveDocumentToString (const HANDLER_CONTEXT< commands::SaveDocumentToString > &aCtx)

HANDLER_RESULT< commands::SavedSelectionResponse >	handleSaveSelectionToString (const HANDLER_CONTEXT< commands::SaveSelectionToString > &aCtx)

HANDLER_RESULT< commands::CreateItemsResponse >	handleParseAndCreateItemsFromString (const HANDLER_CONTEXT< commands::ParseAndCreateItemsFromString > &aCtx)

HANDLER_RESULT< BoardLayers >	handleGetVisibleLayers (const HANDLER_CONTEXT< GetVisibleLayers > &aCtx)

HANDLER_RESULT< Empty >	handleSetVisibleLayers (const HANDLER_CONTEXT< SetVisibleLayers > &aCtx)

HANDLER_RESULT< BoardLayerResponse >	handleGetActiveLayer (const HANDLER_CONTEXT< GetActiveLayer > &aCtx)

HANDLER_RESULT< Empty >	handleSetActiveLayer (const HANDLER_CONTEXT< SetActiveLayer > &aCtx)

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

Private Attributes
std::shared_ptr< BOARD_CONTEXT >	m_context

Detailed Description

Definition at line 33 of file api_handler_footprint.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 97 of file api_handler.h.

Constructor & Destructor Documentation

◆ API_HANDLER_FOOTPRINT() [1/2]

API_HANDLER_FOOTPRINT::API_HANDLER_FOOTPRINT ( FOOTPRINT_EDIT_FRAME * aFrame )

Definition at line 45 of file api_handler_footprint.cpp.

References API_HANDLER_FOOTPRINT(), and CreateFootprintFrameContext().

Referenced by API_HANDLER_FOOTPRINT().

◆ API_HANDLER_FOOTPRINT() [2/2]

API_HANDLER_FOOTPRINT::API_HANDLER_FOOTPRINT	(	std::shared_ptr< FOOTPRINT_CONTEXT >	aContext,
		FOOTPRINT_EDIT_FRAME *	aFrame = nullptr )

Definition at line 51 of file api_handler_footprint.cpp.

References API_HANDLER_BOARD::API_HANDLER_BOARD(), handleGetItems(), handleGetOpenDocuments(), handleOpenLibraryItem(), handleRevertDocument(), handleSaveCopyOfDocument(), handleSaveDocument(), move, and API_HANDLER::registerHandler().

Member Function Documentation

◆ apiServer()

KICAD_API_SERVER * API_HANDLER::apiServer ( ) const

inlineinherited

Definition at line 90 of file api_handler.h.

References m_apiServer.

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

◆ board()

BOARD * API_HANDLER_BOARD::board ( ) const

inlineprotectedinherited

Definition at line 79 of file api_handler_board.h.

References context(), and BOARD_CONTEXT::GetBoard().

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

References m_frame.

◆ checkForHeadless()

std::optional< ApiResponseStatus > API_HANDLER_BOARD::checkForHeadless ( const std::string & aCommandName ) const

protectedinherited

◆ clearNetSettingsNotification()

bool API_HANDLER::clearNetSettingsNotification ( )

inlineinherited

Returns true if the notification had been requested at the time of the call.

Definition at line 81 of file api_handler.h.

References m_notifyNetSettings.

◆ context()

BOARD_CONTEXT * API_HANDLER_BOARD::context ( ) const

inlineprotectedinherited

Definition at line 77 of file api_handler_board.h.

References m_context.

Referenced by board(), API_HANDLER_FOOTPRINT::footprintContext(), API_HANDLER_PCB::getPageSettings(), API_HANDLER_PCB::getTitleBlock(), API_HANDLER_PCB::pcbContext(), project(), API_HANDLER_PCB::setPageSettings(), and toolManager().

◆ createCommit()

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

overrideprotectedvirtualinherited

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 137 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::m_frame, API_HANDLER_EDITOR::thisDocumentType(), and toolManager().

Referenced by API_HANDLER_PCB::handleRefillZones().

◆ createItemForType()

HANDLER_RESULT< std::unique_ptr< BOARD_ITEM > > API_HANDLER_BOARD::createItemForType	(	KICAD_T	aType,
		BOARD_ITEM_CONTAINER *	aContainer )

staticprotectedinherited

Definition at line 159 of file api_handler_board.cpp.

References CreateItemForType(), EDA_ITEM::GetFriendlyName(), PCB_BARCODE_T, PCB_CONSTRAINT_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, and PCB_ZONE_T.

Referenced by handleCreateUpdateItemsInternal().

◆ deleteItemsInternal()

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

overrideprotectedvirtualinherited

Implements API_HANDLER_EDITOR.

Definition at line 221 of file api_handler_board.cpp.

References _, board(), ensureGeneratorTool(), PCB_ACTIONS::genRemove, API_HANDLER_EDITOR::getCurrentCommit(), IsGeneratedTableCell(), PCB_FIELD::IsMandatory(), API_HANDLER_EDITOR::m_activeClients, COMMIT::Modify(), PCB_FIELD_T, PCB_GENERATOR_T, PCB_TABLECELL_T, pushCurrentCommit(), COMMIT::Remove(), TOOL_MANAGER::RunSynchronousAction(), and toolManager().

◆ ensureGeneratorTool()

GENERATOR_TOOL * API_HANDLER_BOARD::ensureGeneratorTool ( ) const

protectedinherited

Creates the generator tool if needed (e.g. in headless mode); returns it if available.

Definition at line 286 of file api_handler_board.cpp.

References TOOL_MANAGER::FindTool(), GENERATOR_TOOL_NAME, TOOL_MANAGER::GetTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::ResetTools(), TOOL_BASE::RUN, and toolManager().

Referenced by deleteItemsInternal(), and handleCreateUpdateItemsInternal().

◆ footprintContext()

FOOTPRINT_CONTEXT * API_HANDLER_FOOTPRINT::footprintContext ( ) const

inlineprivate

Definition at line 68 of file api_handler_footprint.h.

References API_HANDLER_BOARD::context().

Referenced by handleGetOpenDocuments(), handleSaveCopyOfDocument(), handleSaveDocument(), and validateDocumentInternal().

◆ frame()

FOOTPRINT_EDIT_FRAME * API_HANDLER_FOOTPRINT::frame ( ) const

private

Definition at line 68 of file api_handler_footprint.cpp.

References API_HANDLER_EDITOR::m_frame.

Referenced by handleOpenLibraryItem(), and handleRevertDocument().

◆ getCurrentCommit()

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

protectedinherited

Definition at line 154 of file api_handler_editor.cpp.

References createCommit(), and m_commits.

Referenced by API_HANDLER_BOARD::deleteItemsInternal(), API_HANDLER_SCH::deleteItemsInternal(), API_HANDLER_SYMBOL::deleteItemsInternal(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SYMBOL::handleCreateUpdateItemsInternal(), API_HANDLER_BOARD::handleFlipItems(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_BOARD::handleInteractiveMoveItems(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), and API_HANDLER_SCH::handlePlaceSymbolFromLibrary().

◆ getDefaultContainer()

BOARD_ITEM_CONTAINER * API_HANDLER_FOOTPRINT::getDefaultContainer ( )

overrideprotectedvirtual

Reimplemented from API_HANDLER_BOARD.

Definition at line 530 of file api_handler_footprint.cpp.

References API_HANDLER_BOARD::board(), and BOARD::GetFirstFootprint().

◆ getDrawingSheetFileName()

virtual wxString API_HANDLER_EDITOR::getDrawingSheetFileName ( )

inlineprotectedvirtualinherited

Reimplemented in API_HANDLER_PCB, and API_HANDLER_SCH.

Definition at line 141 of file api_handler_editor.h.

Referenced by handleGetPageSettings(), and handleSetPageSettings().

◆ getItemById()

std::optional< BOARD_ITEM * > API_HANDLER_BOARD::getItemById ( const KIID & aId ) const

protectedinherited

Definition at line 148 of file api_handler_board.cpp.

References board(), and BOARD::ResolveItem().

Referenced by getItemFromDocument(), handleAddToSelection(), handleCheckPadstackPresenceOnLayers(), handleCreateUpdateItemsInternal(), handleFlipItems(), handleFocusOnItems(), handleGetBoundingBox(), API_HANDLER_PCB::handleGetConnectedItems(), handleGetItemsById(), handleGetPadShapeAsPolygon(), handleInteractiveMoveItems(), API_HANDLER_PCB::handleRefillZones(), and handleRemoveFromSelection().

◆ getItemFromDocument()

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

overrideprotectedvirtualinherited

Implements API_HANDLER_EDITOR.

Definition at line 333 of file api_handler_board.cpp.

References getItemById(), and API_HANDLER_EDITOR::validateDocument().

◆ getIuScale()

virtual const EDA_IU_SCALE & API_HANDLER_EDITOR::getIuScale ( ) const

inlineprotectedvirtualinherited

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 in API_HANDLER_SCH, and API_HANDLER_SYMBOL.

Definition at line 119 of file api_handler_editor.h.

References pcbIUScale.

Referenced by handleHitTest().

◆ getPageSettings()

virtual std::optional< PAGE_INFO > API_HANDLER_EDITOR::getPageSettings ( const DocumentSpecifier & aDocument )

inlineprotectedvirtualinherited

Reimplemented in API_HANDLER_PCB, and API_HANDLER_SCH.

Definition at line 137 of file api_handler_editor.h.

Referenced by handleGetPageSettings(), and handleSetPageSettings().

◆ getTitleBlock()

virtual std::optional< TITLE_BLOCK * > API_HANDLER_EDITOR::getTitleBlock ( const DocumentSpecifier & aDocument )

inlineprotectedvirtualinherited

Reimplemented in API_HANDLER_PCB, and API_HANDLER_SCH.

Definition at line 135 of file api_handler_editor.h.

Referenced by handleGetTitleBlockInfo(), and handleSetTitleBlockInfo().

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

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ handleAddToSelection()

HANDLER_RESULT< SelectionResponse > API_HANDLER_BOARD::handleAddToSelection ( const HANDLER_CONTEXT< commands::AddToSelection > & aCtx )

privateinherited

Definition at line 839 of file api_handler_board.cpp.

References SELECTION_TOOL::AddItemsToSel(), API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), getItemById(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), API_HANDLER_EDITOR::m_frame, HANDLER_CONTEXT< RequestMessageType >::Request, toolManager(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

◆ handleBeginCommit()

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

protectedinherited

Definition at line 50 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().

◆ handleCheckPadstackPresenceOnLayers()

HANDLER_RESULT< PadstackPresenceResponse > API_HANDLER_BOARD::handleCheckPadstackPresenceOnLayers ( const HANDLER_CONTEXT< CheckPadstackPresenceOnLayers > & aCtx )

privateinherited

Definition at line 1156 of file api_handler_board.cpp.

References FromProtoEnum(), getItemById(), pad, PCB_LAYER_ID_COUNT, PCB_PAD_T, PCB_VIA_T, HANDLER_CONTEXT< RequestMessageType >::Request, BASE_SET::set(), ToProtoEnum(), API_HANDLER_EDITOR::validateDocument(), and via.

Referenced by API_HANDLER_BOARD().

◆ handleClearSelection()

HANDLER_RESULT< Empty > API_HANDLER_BOARD::handleClearSelection ( const HANDLER_CONTEXT< commands::ClearSelection > & aCtx )

privateinherited

Definition at line 814 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), API_HANDLER_EDITOR::m_frame, HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), ACTIONS::selectionClear, toolManager(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

◆ handleCreateItems()

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

protectedinherited

Definition at line 235 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_BOARD::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 )

overrideprotectedvirtualinherited

Implements API_HANDLER_EDITOR.

Definition at line 343 of file api_handler_board.cpp.

References _, COMMIT::Add(), EDA_GROUP::AddItem(), KIID::AsStdString(), board(), COMMIT::Checkpoint(), BOARD_ITEM::CopyFrom(), CreateGeneratorForType(), createItemForType(), SERIALIZABLE::Deserialize(), ensureGeneratorTool(), EDA_GROUP::FinalizeGroupDeserialization(), kiapi::common::GeneratorTypeFromAny(), API_HANDLER_EDITOR::getCurrentCommit(), getDefaultContainer(), getItemById(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParentGroup(), group, API_HANDLER_EDITOR::m_activeClients, COMMIT::Modify(), PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_DIMENSION_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TABLECELL_T, pushCurrentCommit(), RECURSE, regenerateGenerators(), COMMIT::Remove(), BOARD_ITEM::ResetUuid(), BOARD_COMMIT::RevertToCheckpoint(), PCB_TABLECELL::Serialize(), SERIALIZABLE::Serialize(), EDA_ITEM::SetParent(), EDA_ITEM::SetParentGroup(), table, EDA_ITEM::Type(), 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 296 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 88 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().

◆ handleExpandTextVariables()

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

privateinherited

Definition at line 1230 of file api_handler_board.cpp.

References board(), ExpandEnvVarSubstitutions(), ExpandTextVars(), INTERNAL, HANDLER_CONTEXT< RequestMessageType >::Request, text, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleFlipItems()

HANDLER_RESULT< FlipItemsResponse > API_HANDLER_BOARD::handleFlipItems ( const HANDLER_CONTEXT< FlipItems > & aCtx )

privateinherited

Definition at line 1307 of file api_handler_board.cpp.

References _, API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, BOARD_ITEM::Flip(), FromProtoEnum(), API_HANDLER_EDITOR::getCurrentCommit(), getItemById(), EDA_ITEM::GetPosition(), API_HANDLER_EDITOR::m_activeClients, COMMIT::Modify(), BOARD_ITEM::Normalize(), PCB_ARC_T, PCB_BARCODE_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GRID_ITEM_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, pushCurrentCommit(), RECURSE, HANDLER_CONTEXT< RequestMessageType >::Request, result, SERIALIZABLE::Serialize(), EDA_ITEM::Type(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

◆ handleFocusOnItems()

HANDLER_RESULT< Empty > API_HANDLER_BOARD::handleFocusOnItems ( const HANDLER_CONTEXT< commands::FocusOnItems > & aCtx )

privateinherited

Definition at line 879 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), getItemById(), TOOL_MANAGER::GetTool(), kiapi::common::MakeResponseStatus(), HANDLER_CONTEXT< RequestMessageType >::Request, toolManager(), kiapi::common::UnpackDistance(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleGetActiveLayer()

HANDLER_RESULT< BoardLayerResponse > API_HANDLER_BOARD::handleGetActiveLayer ( const HANDLER_CONTEXT< GetActiveLayer > & aCtx )

privateinherited

Definition at line 1539 of file api_handler_board.cpp.

References checkForHeadless(), PCB_BASE_FRAME::GetActiveLayer(), API_HANDLER_EDITOR::m_frame, HANDLER_CONTEXT< RequestMessageType >::Request, ToProtoEnum(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleGetBoardBoundingBox()

HANDLER_RESULT< BoardBoundingBoxResponse > API_HANDLER_BOARD::handleGetBoardBoundingBox ( const HANDLER_CONTEXT< GetBoardBoundingBox > & aCtx )

privateinherited

Definition at line 1095 of file api_handler_board.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), BOARD::ComputeBoundingBox(), BOARD::GetBoardEdgesBoundingBox(), kiapi::common::MakeResponseStatus(), kiapi::common::PackBox2(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleGetBoardEnabledLayers()

HANDLER_RESULT< BoardEnabledLayersResponse > API_HANDLER_BOARD::handleGetBoardEnabledLayers ( const HANDLER_CONTEXT< GetBoardEnabledLayers > & aCtx )

privateinherited

Definition at line 984 of file api_handler_board.cpp.

References LSET::AllCuMask(), board(), kiapi::board::PackLayerSet(), HANDLER_CONTEXT< RequestMessageType >::Request, Rescue, BASE_SET::reset(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleGetBoundingBox()

HANDLER_RESULT< GetBoundingBoxResponse > API_HANDLER_BOARD::handleGetBoundingBox ( const HANDLER_CONTEXT< commands::GetBoundingBox > & aCtx )

privateinherited

Definition at line 1053 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), EDA_ITEM::GetBoundingBox(), getItemById(), kiapi::common::PackBox2(), PCB_FOOTPRINT_T, HANDLER_CONTEXT< RequestMessageType >::Request, EDA_ITEM::Type(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

◆ handleGetDocumentModifiedState()

HANDLER_RESULT< GetDocumentModifiedStateResponse > API_HANDLER_EDITOR::handleGetDocumentModifiedState ( const HANDLER_CONTEXT< commands::GetDocumentModifiedState > & aCtx )

protectedvirtualinherited

Reimplemented in API_HANDLER_PCB, API_HANDLER_SCH, and API_HANDLER_SYMBOL.

Definition at line 386 of file api_handler_editor.cpp.

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

Referenced by API_HANDLER_EDITOR().

◆ handleGetGraphicsDefaults()

HANDLER_RESULT< GraphicsDefaultsResponse > API_HANDLER_BOARD::handleGetGraphicsDefaults ( const HANDLER_CONTEXT< GetGraphicsDefaults > & aCtx )

privateinherited

Definition at line 1013 of file api_handler_board.cpp.

References board(), BOARD::GetDesignSettings(), LAYER_CLASS_COUNT, BOARD_DESIGN_SETTINGS::m_LineThickness, BOARD_DESIGN_SETTINGS::m_TextItalic, BOARD_DESIGN_SETTINGS::m_TextSize, BOARD_DESIGN_SETTINGS::m_TextThickness, BOARD_DESIGN_SETTINGS::m_TextUpright, HANDLER_CONTEXT< RequestMessageType >::Request, text, API_HANDLER_EDITOR::validateDocument(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by API_HANDLER_BOARD().

◆ handleGetItems()

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

private

◆ handleGetItemsById()

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

privateinherited

Definition at line 726 of file api_handler_board.cpp.

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

Referenced by API_HANDLER_BOARD().

◆ handleGetOpenDocuments()

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

private

Definition at line 204 of file api_handler_footprint.cpp.

References API_HANDLER_BOARD::board(), footprintContext(), FOOTPRINT_CONTEXT::GetLoadedFPID(), LIB_ID::GetUniStringLibItemName(), LIB_ID::GetUniStringLibNickname(), API_HANDLER_BOARD::project(), HANDLER_CONTEXT< RequestMessageType >::Request, and ToStdString().

Referenced by API_HANDLER_FOOTPRINT().

◆ handleGetPadShapeAsPolygon()

HANDLER_RESULT< PadShapeAsPolygonResponse > API_HANDLER_BOARD::handleGetPadShapeAsPolygon ( const HANDLER_CONTEXT< GetPadShapeAsPolygon > & aCtx )

privateinherited

Definition at line 1121 of file api_handler_board.cpp.

References SHAPE_POLY_SET::COutline(), ERROR_INSIDE, FromProtoEnum(), getItemById(), kiapi::common::PackPolyLine(), pad, PCB_PAD_T, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleGetPageSettings()

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

protectedinherited

Definition at line 506 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().

◆ handleGetSelection()

HANDLER_RESULT< SelectionResponse > API_HANDLER_BOARD::handleGetSelection ( const HANDLER_CONTEXT< commands::GetSelection > & aCtx )

privateinherited

Definition at line 769 of file api_handler_board.cpp.

References checkForHeadless(), filter, PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), parseRequestedItemTypes(), PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_DIMENSION_T, HANDLER_CONTEXT< RequestMessageType >::Request, toolManager(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

◆ handleGetStackup()

HANDLER_RESULT< BoardStackupResponse > API_HANDLER_BOARD::handleGetStackup ( const HANDLER_CONTEXT< GetBoardStackup > & aCtx )

privateinherited

Definition at line 968 of file api_handler_board.cpp.

References board(), kiapi::board::PackBoardStackup(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleGetTitleBlockInfo()

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

protectedinherited

Definition at line 417 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().

◆ handleGetVisibleLayers()

HANDLER_RESULT< BoardLayers > API_HANDLER_BOARD::handleGetVisibleLayers ( const HANDLER_CONTEXT< GetVisibleLayers > & aCtx )

privateinherited

Definition at line 1483 of file api_handler_board.cpp.

References board(), checkForHeadless(), HANDLER_CONTEXT< RequestMessageType >::Request, ToProtoEnum(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleHitTest()

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

protectedinherited

Definition at line 345 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().

◆ handleInteractiveMoveItems()

HANDLER_RESULT< Empty > API_HANDLER_BOARD::handleInteractiveMoveItems ( const HANDLER_CONTEXT< InteractiveMoveItems > & aCtx )

privateinherited

Definition at line 1262 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), HANDLER_CONTEXT< RequestMessageType >::ClientName, API_HANDLER_EDITOR::getCurrentCommit(), getItemById(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), PCB_ACTIONS::move, TOOL_MANAGER::PostAPIAction(), HANDLER_CONTEXT< RequestMessageType >::Request, TOOL_MANAGER::RunAction(), ACTIONS::selectionClear, ACTIONS::selectItems, SELECTION::SetReferencePoint(), toolManager(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleOpenLibraryItem()

HANDLER_RESULT< Empty > API_HANDLER_FOOTPRINT::handleOpenLibraryItem ( const HANDLER_CONTEXT< commands::OpenLibraryItem > & aCtx )

private

Definition at line 157 of file api_handler_footprint.cpp.

References API_HANDLER_BOARD::checkForHeadless(), PROJECT_PCB::FootprintLibAdapter(), frame(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_LIBRARY_ADAPTER::LoadFootprintWithOptionalNickname(), Prj(), IO_ERROR::Problem(), and HANDLER_CONTEXT< RequestMessageType >::Request.

Referenced by API_HANDLER_FOOTPRINT().

◆ handleParseAndCreateItemsFromString()

HANDLER_RESULT< CreateItemsResponse > API_HANDLER_BOARD::handleParseAndCreateItemsFromString ( const HANDLER_CONTEXT< commands::ParseAndCreateItemsFromString > & aCtx )

privateinherited

Definition at line 1467 of file api_handler_board.cpp.

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

Referenced by API_HANDLER_BOARD().

◆ handleRemoveFromSelection()

HANDLER_RESULT< SelectionResponse > API_HANDLER_BOARD::handleRemoveFromSelection ( const HANDLER_CONTEXT< commands::RemoveFromSelection > & aCtx )

privateinherited

Definition at line 928 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), getItemById(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), API_HANDLER_EDITOR::m_frame, SELECTION_TOOL::RemoveItemsFromSel(), HANDLER_CONTEXT< RequestMessageType >::Request, toolManager(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_BOARD().

◆ handleRevertDocument()

HANDLER_RESULT< Empty > API_HANDLER_FOOTPRINT::handleRevertDocument ( const HANDLER_CONTEXT< commands::RevertDocument > & aCtx )

private

Definition at line 305 of file api_handler_footprint.cpp.

References API_HANDLER_EDITOR::checkForBusy(), API_HANDLER_BOARD::checkForHeadless(), frame(), HANDLER_CONTEXT< RequestMessageType >::Request, FOOTPRINT_EDIT_FRAME::RevertFootprint(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_FOOTPRINT().

◆ handleRunAction()

HANDLER_RESULT< RunActionResponse > API_HANDLER_BOARD::handleRunAction ( const HANDLER_CONTEXT< commands::RunAction > & aCtx )

privateinherited

Definition at line 706 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), HANDLER_CONTEXT< RequestMessageType >::Request, and toolManager().

Referenced by API_HANDLER_BOARD().

◆ handleSaveCopyOfDocument()

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

private

Definition at line 257 of file api_handler_footprint.cpp.

References copy, footprintContext(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), FOOTPRINT_CONTEXT::GetLoadedFPID(), LIB_ID::GetUniStringLibNickname(), LIB_ID::Parse(), HANDLER_CONTEXT< RequestMessageType >::Request, and validateAndGetFootprint().

Referenced by API_HANDLER_FOOTPRINT().

◆ handleSaveDocument()

HANDLER_RESULT< Empty > API_HANDLER_FOOTPRINT::handleSaveDocument ( const HANDLER_CONTEXT< commands::SaveDocument > & aCtx )

private

Definition at line 237 of file api_handler_footprint.cpp.

References footprintContext(), HANDLER_CONTEXT< RequestMessageType >::Request, and validateAndGetFootprint().

Referenced by API_HANDLER_FOOTPRINT().

◆ handleSaveDocumentToString()

HANDLER_RESULT< SavedDocumentResponse > API_HANDLER_BOARD::handleSaveDocumentToString ( const HANDLER_CONTEXT< commands::SaveDocumentToString > & aCtx )

privateinherited

Definition at line 1417 of file api_handler_board.cpp.

References board(), HANDLER_CONTEXT< RequestMessageType >::Request, CLIPBOARD_IO::SaveBoard(), CLIPBOARD_IO::SetWriter(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleSaveSelectionToString()

HANDLER_RESULT< SavedSelectionResponse > API_HANDLER_BOARD::handleSaveSelectionToString ( const HANDLER_CONTEXT< commands::SaveSelectionToString > & aCtx )

privateinherited

Definition at line 1441 of file api_handler_board.cpp.

References board(), checkForHeadless(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), CLIPBOARD_IO::SaveSelection(), CLIPBOARD_IO::SetBoard(), CLIPBOARD_IO::SetWriter(), API_HANDLER_EDITOR::thisDocumentType(), and toolManager().

Referenced by API_HANDLER_BOARD().

◆ handleSetActiveLayer()

HANDLER_RESULT< Empty > API_HANDLER_BOARD::handleSetActiveLayer ( const HANDLER_CONTEXT< SetActiveLayer > & aCtx )

privateinherited

Definition at line 1560 of file api_handler_board.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), FromProtoEnum(), API_HANDLER_EDITOR::m_frame, HANDLER_CONTEXT< RequestMessageType >::Request, PCB_BASE_FRAME::SetActiveLayer(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

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

◆ handleSetVisibleLayers()

HANDLER_RESULT< Empty > API_HANDLER_BOARD::handleSetVisibleLayers ( const HANDLER_CONTEXT< SetVisibleLayers > & aCtx )

privateinherited

Definition at line 1503 of file api_handler_board.cpp.

References board(), API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), LSET::Contains(), FromProtoEnum(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetEnabledLayers(), API_HANDLER_EDITOR::m_frame, APPEARANCE_CONTROLS::OnBoardChanged(), HANDLER_CONTEXT< RequestMessageType >::Request, BASE_SET::set(), BOARD::SetVisibleLayers(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_BOARD().

◆ handleUpdateItems()

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

protectedinherited

Definition at line 269 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()

virtual void API_HANDLER_EDITOR::onModified ( )

inlineprotectedvirtualinherited

Reimplemented in API_HANDLER_PCB, API_HANDLER_SCH, and API_HANDLER_SYMBOL.

Definition at line 145 of file api_handler_editor.h.

Referenced by handleSetPageSettings(), handleSetTitleBlockInfo(), and API_HANDLER_BOARD::pushCurrentCommit().

◆ onNetSettingsChanged()

virtual void API_HANDLER::onNetSettingsChanged ( )

inlinevirtualinherited

Called on all registered handlers after project net settings (netclasses or netclass assignments) have been changed via the API.

Reimplemented in API_HANDLER_PCB, and API_HANDLER_SCH.

Definition at line 76 of file api_handler.h.

◆ parseRequestedItemTypes()

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

protectedinherited

Definition at line 688 of file api_handler_board.cpp.

References FromProtoEnum(), and TYPE_NOT_INIT.

Referenced by API_HANDLER_PCB::handleGetConnectedItems(), API_HANDLER_FOOTPRINT::handleGetItems(), API_HANDLER_PCB::handleGetItems(), API_HANDLER_PCB::handleGetItemsByNet(), API_HANDLER_PCB::handleGetItemsByNetClass(), and handleGetSelection().

◆ project()

PROJECT & API_HANDLER_BOARD::project ( ) const

inlineprotectedinherited

Definition at line 81 of file api_handler_board.h.

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

Referenced by API_HANDLER_FOOTPRINT::handleGetOpenDocuments(), API_HANDLER_PCB::handleGetOpenDocuments(), API_HANDLER_PCB::handleImportNetlist(), and API_HANDLER_PCB::handleSaveCopyOfDocument().

◆ pushCurrentCommit()

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

overrideprotectedvirtualinherited

Reimplemented from API_HANDLER_EDITOR.

Definition at line 129 of file api_handler_board.cpp.

References API_HANDLER_EDITOR::onModified(), and API_HANDLER_EDITOR::pushCurrentCommit().

Referenced by deleteItemsInternal(), handleCreateUpdateItemsInternal(), handleFlipItems(), API_HANDLER_PCB::handleInjectDrcError(), and API_HANDLER_PCB::handlePlaceFootprintFromLibrary().

◆ regenerateGenerators()

void API_HANDLER_BOARD::regenerateGenerators	(	GENERATOR_TOOL *	aTool,
		BOARD_COMMIT *	aCommit,
		const std::vector< PCB_GENERATOR * > &	aGenerators,
		std::function< void(const KIID &, commands::ItemStatus)>	aResultHandler ) const

protectedinherited

Definition at line 300 of file api_handler_board.cpp.

References board().

Referenced by handleCreateUpdateItemsInternal().

◆ 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 114 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_LIBRARIES::API_HANDLER_LIBRARIES(), API_HANDLER_PCB::API_HANDLER_PCB(), API_HANDLER_SCH::API_HANDLER_SCH(), and API_HANDLER_SYMBOL::API_HANDLER_SYMBOL().

◆ requestNetSettingsNotification()

void API_HANDLER::requestNetSettingsNotification ( )

inlineinherited

Definition at line 78 of file api_handler.h.

References m_notifyNetSettings.

Referenced by API_HANDLER_COMMON::handleSetNetClassAssignments(), and API_HANDLER_COMMON::handleSetNetClasses().

◆ setApiServer()

void API_HANDLER::setApiServer ( KICAD_API_SERVER * aServer )

inlineinherited

Set by KICAD_API_SERVER::RegisterHandler; null when the handler is not registered.

Definition at line 89 of file api_handler.h.

References m_apiServer.

Referenced by KICAD_API_SERVER::DeregisterHandler(), and KICAD_API_SERVER::RegisterHandler().

◆ setDrawingSheetFileName()

virtual void API_HANDLER_EDITOR::setDrawingSheetFileName ( const wxString & aFileName )

inlineprotectedvirtualinherited

Reimplemented in API_HANDLER_PCB, and API_HANDLER_SCH.

Definition at line 143 of file api_handler_editor.h.

Referenced by handleSetPageSettings().

◆ setPageSettings()

virtual bool API_HANDLER_EDITOR::setPageSettings	(	const DocumentSpecifier &	aDocument,
		const PAGE_INFO &	aPageInfo )

inlineprotectedvirtualinherited

Reimplemented in API_HANDLER_PCB, and API_HANDLER_SCH.

Definition at line 139 of file api_handler_editor.h.

Referenced by handleSetPageSettings().

◆ thisDocumentType()

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

inlineoverrideprotectedvirtual

Override this to specify which document type this editor handles.

Implements API_HANDLER_EDITOR.

Definition at line 58 of file api_handler_footprint.h.

◆ toolManager()

TOOL_MANAGER * API_HANDLER_BOARD::toolManager ( ) const

inlineprotectedinherited

Definition at line 83 of file api_handler_board.h.

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

Referenced by createCommit(), deleteItemsInternal(), ensureGeneratorTool(), handleAddToSelection(), handleClearSelection(), handleFocusOnItems(), handleGetSelection(), handleInteractiveMoveItems(), API_HANDLER_PCB::handleRefillZones(), handleRemoveFromSelection(), handleRunAction(), handleSaveSelectionToString(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), and API_HANDLER_PCB::onNetSettingsChanged().

◆ tryUnpack()

template<typename MessageType>

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

inlineprivateinherited

Definition at line 161 of file api_handler.h.

Referenced by registerHandler().

◆ validateAndGetFootprint()

HANDLER_RESULT< FOOTPRINT * > API_HANDLER_FOOTPRINT::validateAndGetFootprint ( const DocumentSpecifier & aDocument )

private

Definition at line 134 of file api_handler_footprint.cpp.

References API_HANDLER_BOARD::board(), API_HANDLER_EDITOR::checkForBusy(), BOARD::GetFirstFootprint(), and API_HANDLER_EDITOR::validateDocument().

Referenced by handleSaveCopyOfDocument(), and handleSaveDocument().

◆ validateDocument()

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

protectedinherited

Definition at line 180 of file api_handler_editor.cpp.

References validateDocumentInternal().

◆ validateDocumentInternal()

tl::expected< bool, ApiResponseStatus > API_HANDLER_FOOTPRINT::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 74 of file api_handler_footprint.cpp.

References API_HANDLER_BOARD::board(), footprintContext(), FOOTPRINT_CONTEXT::GetLoadedFPID(), LIB_ID::GetUniStringLibItemName(), LIB_ID::GetUniStringLibNickname(), and LIB_ID::IsValid().

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

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

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

Member Data Documentation

◆ m_activeClients

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

protectedinherited

Definition at line 150 of file api_handler_editor.h.

Referenced by API_HANDLER_BOARD::deleteItemsInternal(), API_HANDLER_SCH::deleteItemsInternal(), API_HANDLER_SYMBOL::deleteItemsInternal(), handleBeginCommit(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SYMBOL::handleCreateUpdateItemsInternal(), handleEndCommit(), API_HANDLER_BOARD::handleFlipItems(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), API_HANDLER_SCH::handlePlaceSymbolFromLibrary(), and pushCurrentCommit().

◆ m_apiServer

KICAD_API_SERVER* API_HANDLER::m_apiServer = nullptr

protectedinherited

Definition at line 154 of file api_handler.h.

Referenced by apiServer(), and setApiServer().

◆ m_commits

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

protectedinherited

Definition at line 148 of file api_handler_editor.h.

Referenced by getCurrentCommit(), handleBeginCommit(), handleEndCommit(), API_HANDLER_PCB::handleRevertDocument(), API_HANDLER_SCH::handleRevertDocument(), and pushCurrentCommit().

◆ m_context

std::shared_ptr<BOARD_CONTEXT> API_HANDLER_BOARD::m_context

privateinherited

Definition at line 176 of file api_handler_board.h.

Referenced by API_HANDLER_BOARD(), and context().

◆ m_defaultCommitMessage

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

staticprotectedinherited

Definition at line 156 of file api_handler.h.

Referenced by API_HANDLER_EDITOR::pushCurrentCommit().

◆ m_frame

EDA_BASE_FRAME* API_HANDLER_EDITOR::m_frame

protectedinherited

Definition at line 152 of file api_handler_editor.h.

◆ 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 150 of file api_handler.h.

Referenced by Handle(), and registerHandler().

◆ m_notifyNetSettings

bool API_HANDLER::m_notifyNetSettings = false

protectedinherited

Definition at line 152 of file api_handler.h.

Referenced by clearNetSettingsNotification(), and requestNetSettingsNotification().

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

Detailed Description

Member Typedef Documentation

◆ REQUEST_HANDLER

Constructor & Destructor Documentation

◆ API_HANDLER_FOOTPRINT() [1/2]

◆ API_HANDLER_FOOTPRINT() [2/2]

Member Function Documentation

◆ apiServer()

◆ board()

◆ checkForBusy()

◆ checkForHeadless()

◆ clearNetSettingsNotification()

◆ context()

◆ createCommit()

◆ createItemForType()

◆ deleteItemsInternal()

◆ ensureGeneratorTool()

◆ footprintContext()

◆ frame()

◆ getCurrentCommit()

◆ getDefaultContainer()

◆ getDrawingSheetFileName()

◆ getItemById()

◆ getItemFromDocument()

◆ getIuScale()

◆ getPageSettings()

◆ getTitleBlock()

◆ Handle()

◆ handleAddToSelection()

◆ handleBeginCommit()

◆ handleCheckPadstackPresenceOnLayers()

◆ handleClearSelection()

◆ handleCreateItems()

◆ handleCreateUpdateItemsInternal()

◆ handleDeleteItems()

◆ handleEndCommit()

◆ handleExpandTextVariables()

◆ handleFlipItems()

◆ handleFocusOnItems()

◆ handleGetActiveLayer()

◆ handleGetBoardBoundingBox()

◆ handleGetBoardEnabledLayers()

◆ handleGetBoundingBox()

◆ handleGetDocumentModifiedState()

◆ handleGetGraphicsDefaults()

◆ handleGetItems()

◆ handleGetItemsById()

◆ handleGetOpenDocuments()

◆ handleGetPadShapeAsPolygon()

◆ handleGetPageSettings()

◆ handleGetSelection()

◆ handleGetStackup()

◆ handleGetTitleBlockInfo()

◆ handleGetVisibleLayers()

◆ handleHitTest()

◆ handleInteractiveMoveItems()

◆ handleOpenLibraryItem()

◆ handleParseAndCreateItemsFromString()

◆ handleRemoveFromSelection()

◆ handleRevertDocument()

◆ handleRunAction()

◆ handleSaveCopyOfDocument()

◆ handleSaveDocument()

◆ handleSaveDocumentToString()

◆ handleSaveSelectionToString()

◆ handleSetActiveLayer()

◆ handleSetPageSettings()

◆ handleSetTitleBlockInfo()

◆ handleSetVisibleLayers()

◆ handleUpdateItems()

◆ onModified()

◆ onNetSettingsChanged()