API_HANDLER_SCH Class Reference

#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.
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
std::optional< ApiResponseStatus >	checkForHeadless (const std::string &aCommandName) const
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 (const DocumentSpecifier &aDocument) override
std::optional< PAGE_INFO >	getPageSettings (const DocumentSpecifier &aDocument) override
bool	setPageSettings (const DocumentSpecifier &aDocument, const PAGE_INFO &aPageInfo) override
wxString	getDrawingSheetFileName () override
void	setDrawingSheetFileName (const wxString &aFileName) override
void	onModified () override
void	onNetSettingsChanged () override
	Called on all registered handlers after project net settings (netclasses or netclass assignments) have been changed via the API.
SCH_CONTEXT *	context () const
TOOL_MANAGER *	toolManager () const
PROJECT &	project () const
HANDLER_RESULT< commands::GetDocumentModifiedStateResponse >	handleGetDocumentModifiedState (const HANDLER_CONTEXT< commands::GetDocumentModifiedState > &aCtx) override
HANDLER_RESULT< std::optional< KIID > >	validateItemHeaderDocument (const kiapi::common::types::ItemHeader &aHeader)
	If the header is valid, returns the item container.
HANDLER_RESULT< bool >	validateDocument (const DocumentSpecifier &aDocument)
virtual std::optional< ApiResponseStatus >	checkForBusy ()
	Checks if the editor can accept commands.
HANDLER_RESULT< commands::BeginCommitResponse >	handleBeginCommit (const HANDLER_CONTEXT< commands::BeginCommit > &aCtx)
HANDLER_RESULT< commands::EndCommitResponse >	handleEndCommit (const HANDLER_CONTEXT< commands::EndCommit > &aCtx)
COMMIT *	getCurrentCommit (const std::string &aClientName)
virtual void	pushCurrentCommit (const std::string &aClientName, const wxString &aMessage)
HANDLER_RESULT< commands::CreateItemsResponse >	handleCreateItems (const HANDLER_CONTEXT< commands::CreateItems > &aCtx)
HANDLER_RESULT< commands::UpdateItemsResponse >	handleUpdateItems (const HANDLER_CONTEXT< commands::UpdateItems > &aCtx)
HANDLER_RESULT< commands::DeleteItemsResponse >	handleDeleteItems (const HANDLER_CONTEXT< commands::DeleteItems > &aCtx)
HANDLER_RESULT< commands::HitTestResponse >	handleHitTest (const HANDLER_CONTEXT< commands::HitTest > &aCtx)
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
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< google::protobuf::Empty >	handleSaveDocument (const HANDLER_CONTEXT< commands::SaveDocument > &aCtx)
HANDLER_RESULT< google::protobuf::Empty >	handleSaveDocumentAs (const HANDLER_CONTEXT< commands::SaveDocumentAs > &aCtx)
HANDLER_RESULT< google::protobuf::Empty >	handleSaveCopyOfDocument (const HANDLER_CONTEXT< commands::SaveCopyOfDocument > &aCtx)
HANDLER_RESULT< google::protobuf::Empty >	handleRevertDocument (const HANDLER_CONTEXT< commands::RevertDocument > &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< 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< 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< 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 >	handleRunSchematicJobExportPng (const HANDLER_CONTEXT< kiapi::schematic::jobs::RunSchematicJobExportPng > &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::commands::SchematicHierarchyResponse >	handleGetSchematicHierarchy (const HANDLER_CONTEXT< kiapi::schematic::commands::GetSchematicHierarchy > &aCtx)
void	packSheetInstance (kiapi::schematic::types::SheetInstance *aInstance, SCH_SHEET_PATH &aPath, SCH_SHEET *aSheet)
bool	packSchItem (google::protobuf::Any &aOut, SCH_ITEM *aItem, const SCH_SHEET_PATH &aPath)
	Serializes a schematic item into aOut, using path-aware packing for symbols and sheets.
HANDLER_RESULT< kiapi::schematic::commands::SchematicNetlistResponse >	handleGetSchematicNetlist (const HANDLER_CONTEXT< kiapi::schematic::commands::GetSchematicNetlist > &aCtx)
HANDLER_RESULT< commands::CrossProbeAnnounceResponse >	handleCrossProbeAnnounce (const HANDLER_CONTEXT< commands::CrossProbeAnnounce > &aCtx)
HANDLER_RESULT< commands::SyncSelectionResponse >	handleSyncSelection (const HANDLER_CONTEXT< commands::SyncSelection > &aCtx)
HANDLER_RESULT< commands::HighlightNetsResponse >	handleHighlightNets (const HANDLER_CONTEXT< commands::HighlightNets > &aCtx)
HANDLER_RESULT< commands::VariantsResponse >	handleGetVariants (const HANDLER_CONTEXT< commands::GetVariants > &aCtx)
HANDLER_RESULT< Empty >	handleAddVariant (const HANDLER_CONTEXT< commands::AddVariant > &aCtx)
HANDLER_RESULT< Empty >	handleDeleteVariant (const HANDLER_CONTEXT< commands::DeleteVariant > &aCtx)
HANDLER_RESULT< Empty >	handleRenameVariant (const HANDLER_CONTEXT< commands::RenameVariant > &aCtx)
HANDLER_RESULT< Empty >	handleCopyVariant (const HANDLER_CONTEXT< commands::CopyVariant > &aCtx)
HANDLER_RESULT< Empty >	handleSetVariantDescription (const HANDLER_CONTEXT< commands::SetVariantDescription > &aCtx)
HANDLER_RESULT< Empty >	handleSetCurrentVariant (const HANDLER_CONTEXT< commands::SetCurrentVariant > &aCtx)
HANDLER_RESULT< commands::CurrentVariantResponse >	handleGetCurrentVariant (const HANDLER_CONTEXT< commands::GetCurrentVariant > &aCtx)
HANDLER_RESULT< commands::ExpandTextVariablesResponse >	handleExpandTextVariables (const HANDLER_CONTEXT< commands::ExpandTextVariables > &aCtx)
HANDLER_RESULT< kiapi::common::commands::PlaceFromLibraryResponse >	handlePlaceSymbolFromLibrary (const HANDLER_CONTEXT< kiapi::schematic::commands::PlaceSymbolFromLibrary > &aCtx)
SCHEMATIC *	schematic () const
SCH_EDIT_FRAME *	frame () const
void	filterValidSchTypes (std::set< KICAD_T > &aTypeList)
SCH_SCREEN *	resolveScreenFromDocument (const DocumentSpecifier &aDocument) const
	Returns the sheet path's screen when one is given and it is found, or null.
template<typename MessageType>
bool	tryUnpack (ApiRequest &aRequest, ApiResponse &aReply, MessageType &aDest)

Private Attributes
std::shared_ptr< SCH_CONTEXT >	m_context

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

Detailed Description

Definition at line 46 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 97 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 128 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 )

Definition at line 134 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::API_HANDLER_EDITOR(), handleAddToSelection(), handleAddVariant(), handleClearSelection(), handleCopyVariant(), handleCrossProbeAnnounce(), handleDeleteVariant(), handleExpandTextVariables(), handleFocusOnItems(), handleGetCurrentVariant(), handleGetItems(), handleGetItemsById(), handleGetOpenDocuments(), API_HANDLER_EDITOR::handleGetPageSettings(), handleGetSchematicHierarchy(), handleGetSchematicNetlist(), handleGetSelection(), handleGetVariants(), handleHighlightNets(), handlePlaceSymbolFromLibrary(), handleRemoveFromSelection(), handleRenameVariant(), handleRevertDocument(), handleRunSchematicJobExportBOM(), handleRunSchematicJobExportDxf(), handleRunSchematicJobExportNetlist(), handleRunSchematicJobExportPdf(), handleRunSchematicJobExportPng(), handleRunSchematicJobExportPs(), handleRunSchematicJobExportSvg(), handleSaveCopyOfDocument(), handleSaveDocument(), handleSaveDocumentAs(), handleSaveDocumentToString(), handleSaveSelectionToString(), handleSetCurrentVariant(), API_HANDLER_EDITOR::handleSetPageSettings(), handleSetVariantDescription(), handleSyncSelection(), m_context, 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().

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.

Referenced by API_HANDLER_PCB::handleAddEmbeddedFiles(), API_HANDLER_BOARD::handleAddToSelection(), API_HANDLER_SCH::handleAddToSelection(), API_HANDLER_PCB::handleAddVariant(), API_HANDLER_SCH::handleAddVariant(), handleBeginCommit(), API_HANDLER_BOARD::handleClearSelection(), API_HANDLER_SCH::handleClearSelection(), API_HANDLER_PCB::handleCopyVariant(), API_HANDLER_SCH::handleCopyVariant(), handleCreateItems(), handleDeleteItems(), API_HANDLER_PCB::handleDeleteVariant(), API_HANDLER_SCH::handleDeleteVariant(), handleEndCommit(), API_HANDLER_BOARD::handleFlipItems(), API_HANDLER_BOARD::handleFocusOnItems(), API_HANDLER_SCH::handleFocusOnItems(), API_HANDLER_BOARD::handleGetBoardBoundingBox(), 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_SCH::handleGetSchematicNetlist(), API_HANDLER_PCB::handleGetVariants(), API_HANDLER_SCH::handleGetVariants(), handleHitTest(), API_HANDLER_PCB::handleImportNetlist(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_BOARD::handleInteractiveMoveItems(), API_HANDLER_BOARD::handleParseAndCreateItemsFromString(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), API_HANDLER_SCH::handlePlaceSymbolFromLibrary(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_BOARD::handleRemoveFromSelection(), API_HANDLER_SCH::handleRemoveFromSelection(), API_HANDLER_PCB::handleRenameVariant(), API_HANDLER_SCH::handleRenameVariant(), API_HANDLER_FOOTPRINT::handleRevertDocument(), API_HANDLER_PCB::handleRevertDocument(), API_HANDLER_SCH::handleRevertDocument(), API_HANDLER_SYMBOL::handleRevertDocument(), API_HANDLER_BOARD::handleRunAction(), API_HANDLER_PCB::handleRunBoardJobExport3D(), API_HANDLER_PCB::handleRunBoardJobExportDrill(), API_HANDLER_PCB::handleRunBoardJobExportDxf(), API_HANDLER_PCB::handleRunBoardJobExportGencad(), API_HANDLER_PCB::handleRunBoardJobExportGerbers(), API_HANDLER_PCB::handleRunBoardJobExportIdf(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportIpcD356(), API_HANDLER_PCB::handleRunBoardJobExportODB(), API_HANDLER_PCB::handleRunBoardJobExportPdf(), API_HANDLER_PCB::handleRunBoardJobExportPng(), API_HANDLER_PCB::handleRunBoardJobExportPosition(), API_HANDLER_PCB::handleRunBoardJobExportPs(), API_HANDLER_PCB::handleRunBoardJobExportRender(), API_HANDLER_PCB::handleRunBoardJobExportStats(), API_HANDLER_PCB::handleRunBoardJobExportSvg(), API_HANDLER_SCH::handleRunSchematicJobExportBOM(), API_HANDLER_SCH::handleRunSchematicJobExportDxf(), API_HANDLER_SCH::handleRunSchematicJobExportNetlist(), API_HANDLER_SCH::handleRunSchematicJobExportPdf(), API_HANDLER_SCH::handleRunSchematicJobExportPng(), API_HANDLER_SCH::handleRunSchematicJobExportPs(), API_HANDLER_SCH::handleRunSchematicJobExportSvg(), API_HANDLER_PCB::handleSaveCopyOfDocument(), API_HANDLER_SCH::handleSaveCopyOfDocument(), API_HANDLER_SYMBOL::handleSaveCopyOfDocument(), API_HANDLER_PCB::handleSaveDocument(), API_HANDLER_SCH::handleSaveDocument(), API_HANDLER_SYMBOL::handleSaveDocument(), API_HANDLER_PCB::handleSaveDocumentAs(), API_HANDLER_SCH::handleSaveDocumentAs(), API_HANDLER_BOARD::handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), API_HANDLER_PCB::handleSetBoardOrigin(), API_HANDLER_PCB::handleSetBoardPlotSettings(), API_HANDLER_PCB::handleSetCurrentVariant(), API_HANDLER_SCH::handleSetCurrentVariant(), API_HANDLER_PCB::handleSetEmbeddedFiles(), API_HANDLER_PCB::handleSetVariantDescription(), API_HANDLER_SCH::handleSetVariantDescription(), API_HANDLER_BOARD::handleSetVisibleLayers(), handleUpdateItems(), and API_HANDLER_FOOTPRINT::validateAndGetFootprint().

checkForHeadless()

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

protected

Definition at line 225 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::m_frame.

Referenced by handleAddToSelection(), handleClearSelection(), handleFocusOnItems(), handleGetSelection(), handleHighlightNets(), handleRemoveFromSelection(), handleSaveSelectionToString(), and handleSyncSelection().

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

SCH_CONTEXT * API_HANDLER_SCH::context ( ) const

inlineprotected

Definition at line 98 of file api_handler_sch.h.

References m_context.

Referenced by handleRevertDocument(), handleSaveCopyOfDocument(), handleSaveDocument(), handleSaveDocumentAs(), 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 203 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::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 1042 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 1526 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 654 of file api_handler_sch.cpp.

References s_allowedTypes.

Referenced by handleGetItems().

frame()

SCH_EDIT_FRAME * API_HANDLER_SCH::frame ( ) const

private

Definition at line 219 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::m_frame.

Referenced by handleAddToSelection(), handleAddVariant(), handleClearSelection(), handleCopyVariant(), handleCreateUpdateItemsInternal(), handleDeleteVariant(), handleGetSchematicNetlist(), handleHighlightNets(), handlePlaceSymbolFromLibrary(), handleRemoveFromSelection(), handleRenameVariant(), handleSaveSelectionToString(), handleSetCurrentVariant(), handleSetVariantDescription(), handleSyncSelection(), onModified(), onNetSettingsChanged(), and setDrawingSheetFileName().

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

getDrawingSheetFileName()

wxString API_HANDLER_SCH::getDrawingSheetFileName ( )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1620 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 267 of file api_handler_sch.cpp.

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

Referenced by handleAddToSelection(), and handleRemoveFromSelection().

getItemFromDocument()

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

overrideprotectedvirtual

Implements API_HANDLER_EDITOR.

Definition at line 1555 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 62 of file api_handler_sch.h.

References schIUScale.

getPageSettings()

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

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1598 of file api_handler_sch.cpp.

References resolveScreenFromDocument().

getTitleBlock()

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

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1589 of file api_handler_sch.cpp.

References SCH_SCREEN::GetTitleBlock(), and resolveScreenFromDocument().

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_SCH::handleAddToSelection ( const HANDLER_CONTEXT< commands::AddToSelection > & aCtx )

private

Definition at line 904 of file api_handler_sch.cpp.

References SELECTION_TOOL::AddItemsToSel(), API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), frame(), getItemById(), SCH_SELECTION_TOOL::GetSelection(), m_context, packSchItem(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_SCH().

handleAddVariant()

HANDLER_RESULT< Empty > API_HANDLER_SCH::handleAddVariant ( const HANDLER_CONTEXT< commands::AddVariant > & aCtx )

private

Definition at line 2785 of file api_handler_sch.cpp.

References _, API_HANDLER_EDITOR::checkForBusy(), FindVariantNoCase(), frame(), GetDefaultVariantName(), API_HANDLER_EDITOR::m_frame, name, onModified(), EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), PICKED_ITEMS_LIST::SetDescription(), SCH_EDIT_FRAME::UpdateVariantSelectionCtrl(), API_HANDLER_EDITOR::validateDocument(), and VARIANTS.

Referenced by API_HANDLER_SCH().

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

handleClearSelection()

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

private

Definition at line 880 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), frame(), m_context, HANDLER_CONTEXT< RequestMessageType >::Request, ACTIONS::selectionClear, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_SCH().

handleCopyVariant()

HANDLER_RESULT< Empty > API_HANDLER_SCH::handleCopyVariant ( const HANDLER_CONTEXT< commands::CopyVariant > & aCtx )

private

Definition at line 2982 of file api_handler_sch.cpp.

References _, API_HANDLER_EDITOR::checkForBusy(), COMMIT::Empty(), FindVariantNoCase(), frame(), GetDefaultVariantName(), API_HANDLER_EDITOR::m_frame, onModified(), EDA_BASE_FRAME::PopCommandFromUndoList(), SCH_COMMIT::Push(), EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), PICKED_ITEMS_LIST::SetDescription(), toolManager(), SCH_EDIT_FRAME::UpdateVariantSelectionCtrl(), API_HANDLER_EDITOR::validateDocument(), and VARIANTS.

Referenced by API_HANDLER_SCH().

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_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 1106 of file api_handler_sch.cpp.

References _, COMMIT::Add(), SCH_SYMBOL::AddHierarchicalReference(), SCH_SHEET::AddInstance(), ApplySheetInstance(), ApplySymbolInstance(), COMMIT::Checkpoint(), createItemForType(), ExpandTextVars(), EDA_GROUP::FinalizeGroupDeserialization(), FN_NORMALIZE_FLAGS, frame(), API_HANDLER_EDITOR::getCurrentCommit(), SCHEMATIC::GetCurrentScreen(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), SCH_SYMBOL::GetLibId(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SHEET_LIST::GetNextPageNumber(), SCH_SHEET::GetPins(), SCH_SYMBOL::GetRawPins(), SCH_SYMBOL::GetSchSymbolLibraryName(), SCH_SHEET::GetScreen(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), group, SCHEMATIC::Hierarchy(), INTERNAL, SCH_ITEM::IsConnectable(), SCH_SHEET_PATH::LastScreen(), LOCAL_CLEANUP, API_HANDLER_EDITOR::m_activeClients, m_context, API_HANDLER_EDITOR::m_frame, COMMIT::Modify(), PackSheet(), PackSymbol(), path, pin, API_HANDLER_EDITOR::pushCurrentCommit(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_SHEET_LIST::ResolveItem(), SCH_SHEET_PATH::ResolveItem(), result, SCH_COMMIT::RevertToCheckpoint(), SCH_GROUP_T, SCH_SHEET_T, SCH_SYMBOL_T, schematic(), SERIALIZABLE::Serialize(), SCH_ITEM::SetConnectivityDirty(), BASE_SCREEN::SetContentModified(), SCH_SCREEN::SetFileName(), SCH_SYMBOL::SetLibId(), SCH_SYMBOL::SetLibSymbol(), SCH_SYMBOL::SetSchSymbolLibraryName(), SCH_SHEET::SetScreen(), SCH_ITEM::SwapItemData(), SCH_SHEET_LIST::TestForRecursion(), EDA_ITEM::Type(), kiapi::common::TypeNameFromAny(), UnpackSheet(), kiapi::common::UnpackSheetPath(), UnpackSymbol(), SCH_SYMBOL::UseLibIdLookup(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

handleCrossProbeAnnounce()

HANDLER_RESULT< CrossProbeAnnounceResponse > API_HANDLER_SCH::handleCrossProbeAnnounce ( const HANDLER_CONTEXT< commands::CrossProbeAnnounce > & aCtx )

private

Definition at line 2223 of file api_handler_sch.cpp.

References CROSS_PROBE_CLIENT::RegisterPeer(), HANDLER_CONTEXT< RequestMessageType >::Request, and traceApi.

Referenced by API_HANDLER_SCH().

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

handleDeleteVariant()

HANDLER_RESULT< Empty > API_HANDLER_SCH::handleDeleteVariant ( const HANDLER_CONTEXT< commands::DeleteVariant > & aCtx )

private

Definition at line 2831 of file api_handler_sch.cpp.

References _, API_HANDLER_EDITOR::checkForBusy(), COMMIT::Empty(), FindVariantNoCase(), frame(), SCH_BASE_FRAME::GetCanvas(), GetDefaultVariantName(), API_HANDLER_EDITOR::m_frame, name, onModified(), EDA_BASE_FRAME::PopCommandFromUndoList(), SCH_COMMIT::Push(), EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), EDA_DRAW_PANEL_GAL::Refresh(), HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), SCH_EDIT_FRAME::SetCurrentVariant(), PICKED_ITEMS_LIST::SetDescription(), toolManager(), SCH_EDIT_FRAME::UpdateVariantSelectionCtrl(), API_HANDLER_EDITOR::validateDocument(), and VARIANTS.

Referenced by API_HANDLER_SCH().

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_SCH::handleExpandTextVariables ( const HANDLER_CONTEXT< commands::ExpandTextVariables > & aCtx )

private

Definition at line 2719 of file api_handler_sch.cpp.

References ExpandEnvVarSubstitutions(), ExpandTextVars(), INTERNAL, m_context, path, project(), HANDLER_CONTEXT< RequestMessageType >::Request, SCHEMATIC::ResolveTextVar(), schematic(), text, kiapi::common::UnpackSheetPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

handleFocusOnItems()

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

private

Definition at line 1002 of file api_handler_sch.cpp.

References SCH_ACTIONS::changeSheet, API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), m_context, HANDLER_CONTEXT< RequestMessageType >::Request, ResolveFocusItems(), schematic(), schIUScale, kiapi::common::UnpackDistance(), kiapi::common::UnpackSheetPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

handleGetCurrentVariant()

HANDLER_RESULT< CurrentVariantResponse > API_HANDLER_SCH::handleGetCurrentVariant ( const HANDLER_CONTEXT< commands::GetCurrentVariant > & aCtx )

private

Definition at line 3137 of file api_handler_sch.cpp.

References EMBEDDED_FILES::IsEmpty(), HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

handleGetDocumentModifiedState()

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

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 615 of file api_handler_sch.cpp.

References SCH_SHEET_LIST::GetSheetPathByKIIDPath(), SCHEMATIC::Hierarchy(), path, SCHEMATIC::RefreshHierarchy(), HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), kiapi::common::UnpackSheetPath(), and API_HANDLER_EDITOR::validateDocument().

handleGetItems()

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

private

Definition at line 664 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), filterValidSchTypes(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), SCHEMATIC::Hierarchy(), SCH_SCREEN::Items(), NO_RECURSE, packSchItem(), API_HANDLER_EDITOR::parseRequestedItemTypes(), path, HANDLER_CONTEXT< RequestMessageType >::Request, s_allowedTypes, SCH_GROUP_T, schematic(), EDA_ITEM::Type(), kiapi::common::UnpackSheetPath(), and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_SCH().

handleGetItemsById()

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

private

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

handleGetSchematicHierarchy()

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

private

Definition at line 2021 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::commands::SchematicNetlistResponse > API_HANDLER_SCH::handleGetSchematicNetlist ( const HANDLER_CONTEXT< kiapi::schematic::commands::GetSchematicNetlist > & aCtx )

private

Definition at line 2061 of file api_handler_sch.cpp.

References _, API_HANDLER_EDITOR::checkForBusy(), SCHEMATIC::ConnectionGraph(), frame(), ADVANCED_CFG::GetCfg(), CONNECTION_SUBGRAPH::GetDriverConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), CONNECTION_GRAPH::GetNetMap(), group, SCH_CONNECTION::IsBus(), ADVANCED_CFG::m_ConnectivityEngine, API_HANDLER_EDITOR::m_frame, kiapi::common::PackSheetPath(), API_HANDLER_EDITOR::parseRequestedItemTypes(), CONNECTION_SUBGRAPH::PIN, SCHEMATIC::RebuildConnectivity(), SCH_EDIT_FRAME::RefreshConnectivity(), HANDLER_CONTEXT< RequestMessageType >::Request, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_PIN_T, SCH_SHEET_PIN_T, SCH_SYMBOL_T, schematic(), traceApi, and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

handleGetSelection()

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

private

Definition at line 842 of file api_handler_sch.cpp.

References checkForHeadless(), filter, SCH_SELECTION_TOOL::GetSelection(), m_context, packSchItem(), API_HANDLER_EDITOR::parseRequestedItemTypes(), path, HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_SCH().

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

handleGetVariants()

HANDLER_RESULT< VariantsResponse > API_HANDLER_SCH::handleGetVariants ( const HANDLER_CONTEXT< commands::GetVariants > & aCtx )

private

Definition at line 2762 of file api_handler_sch.cpp.

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

Referenced by API_HANDLER_SCH().

handleHighlightNets()

HANDLER_RESULT< HighlightNetsResponse > API_HANDLER_SCH::handleHighlightNets ( const HANDLER_CONTEXT< commands::HighlightNets > & aCtx )

private

Definition at line 2686 of file api_handler_sch.cpp.

References CROSS_PROBING_SETTINGS::auto_highlight, checkForHeadless(), HANDLER_CONTEXT< RequestMessageType >::ClientName, SCH_BASE_FRAME::eeconfig(), frame(), SCH_EDIT_FRAME::HandleRemoteNetHighlight(), kiapi::common::KiwayClientName, APP_SETTINGS_BASE::m_CrossProbing, HANDLER_CONTEXT< RequestMessageType >::Request, and kiapi::common::StandaloneCrossProbeClientName.

Referenced by API_HANDLER_SCH().

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

handleParseAndCreateItemsFromString()

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

private

handlePlaceSymbolFromLibrary()

HANDLER_RESULT< PlaceFromLibraryResponse > API_HANDLER_SCH::handlePlaceSymbolFromLibrary ( const HANDLER_CONTEXT< kiapi::schematic::commands::PlaceSymbolFromLibrary > & aCtx )

private

Definition at line 3151 of file api_handler_sch.cpp.

References _, COMMIT::Add(), SCH_REFERENCE_LIST::AddItem(), SCH_REFERENCE::AlwaysAnnotate(), annotate, KIID_PATH::AsString(), AUTOPLACE_AUTO, API_HANDLER_EDITOR::checkForBusy(), HANDLER_CONTEXT< RequestMessageType >::ClientName, LIB_ID::Format(), frame(), FromProtoEnum(), API_HANDLER_EDITOR::getCurrentCommit(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), SCH_SHEET_LIST::GetSymbols(), LIB_SYMBOL::GetUnitCount(), SCHEMATIC::Hierarchy(), LIB_ID::IsValid(), SCH_SHEET_PATH::LastScreen(), SYMBOL_LIBRARY_ADAPTER::LoadSymbol(), API_HANDLER_EDITOR::m_activeClients, m_context, PackSymbol(), path, project(), API_HANDLER_EDITOR::pushCurrentCommit(), SCH_REFERENCE_LIST::ReannotateByOptions(), HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), schIUScale, SCH_REFERENCE_LIST::SetRefDesTracker(), SCH_REFERENCE_LIST::SortByReferenceOnly(), SYMBOL_FILTER_NON_POWER, PROJECT_SCH::SymbolLibAdapter(), kiapi::common::UnpackLibId(), kiapi::common::UnpackSheetPath(), kiapi::common::UnpackVector2(), SCH_REFERENCE_LIST::UpdateAnnotation(), API_HANDLER_EDITOR::validateItemHeaderDocument(), and UTF8::wx_str().

Referenced by API_HANDLER_SCH().

handleRemoveFromSelection()

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

private

Definition at line 954 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), checkForHeadless(), frame(), getItemById(), SCH_SELECTION_TOOL::GetSelection(), m_context, packSchItem(), SELECTION_TOOL::RemoveItemsFromSel(), HANDLER_CONTEXT< RequestMessageType >::Request, and API_HANDLER_EDITOR::validateItemHeaderDocument().

Referenced by API_HANDLER_SCH().

handleRenameVariant()

HANDLER_RESULT< Empty > API_HANDLER_SCH::handleRenameVariant ( const HANDLER_CONTEXT< commands::RenameVariant > & aCtx )

private

Definition at line 2895 of file api_handler_sch.cpp.

References _, API_HANDLER_EDITOR::checkForBusy(), COMMIT::Empty(), FindVariantNoCase(), frame(), SCHEMATIC::GetCurrentVariant(), GetDefaultVariantName(), API_HANDLER_EDITOR::m_frame, onModified(), EDA_BASE_FRAME::PopCommandFromUndoList(), SCH_COMMIT::Push(), EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), HANDLER_CONTEXT< RequestMessageType >::Request, SCH_EDIT_FRAME::Schematic(), schematic(), SCH_EDIT_FRAME::SetCurrentVariant(), PICKED_ITEMS_LIST::SetDescription(), toolManager(), SCH_EDIT_FRAME::UpdateVariantSelectionCtrl(), API_HANDLER_EDITOR::validateDocument(), and VARIANTS.

Referenced by API_HANDLER_SCH().

handleRevertDocument()

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

private

Definition at line 470 of file api_handler_sch.cpp.

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

Referenced by API_HANDLER_SCH().

handleRunSchematicJobExportBOM()

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

private

Definition at line 1891 of file api_handler_sch.cpp.

References ALL, API_HANDLER_EDITOR::checkForBusy(), ExecuteSchematicJob(), JOB_EXPORT_BOM::m_bomFmtPresetName, JOB_EXPORT_BOM::m_bomPresetName, m_context, JOB_EXPORT_BOM::m_excludeDNP, JOB_EXPORT_BOM::m_fieldDelimiter, JOB_EXPORT_BOM::m_fieldsGroupBy, JOB_EXPORT_BOM::m_fieldsLabels, JOB_EXPORT_BOM::m_fieldsOrdered, JOB_EXPORT_BOM::m_filename, JOB_EXPORT_BOM::m_filterScope, JOB_EXPORT_BOM::m_filterString, JOB_EXPORT_BOM::m_groupSymbols, JOB_EXPORT_BOM::m_includeByteOrderMark, JOB_EXPORT_BOM::m_keepLineBreaks, JOB_EXPORT_BOM::m_keepTabs, JOB_EXPORT_BOM::m_refDelimiter, JOB_EXPORT_BOM::m_refRangeDelimiter, JOB_EXPORT_BOM::m_sortAsc, JOB_EXPORT_BOM::m_sortField, JOB_EXPORT_BOM::m_stringDelimiter, JOB_EXPORT_BOM::m_variantNames, REFERENCE, HANDLER_CONTEXT< RequestMessageType >::Request, JOB::SetConfiguredOutputPath(), API_HANDLER_EDITOR::validateDocument(), and VISIBLE.

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

References applySchematicPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), ExecuteSchematicJob(), m_context, plotJob(), 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 1857 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 1752 of file api_handler_sch.cpp.

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

Referenced by API_HANDLER_SCH().

handleRunSchematicJobExportPng()

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

private

Definition at line 1811 of file api_handler_sch.cpp.

References applySchematicPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), ExecuteSchematicJob(), m_context, MAX_PNG_DPI, MIN_PNG_DPI, plotJob(), 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 1783 of file api_handler_sch.cpp.

References applySchematicPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), ExecuteSchematicJob(), m_context, plotJob(), 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 1695 of file api_handler_sch.cpp.

References applySchematicPlotSettings(), API_HANDLER_EDITOR::checkForBusy(), ExecuteSchematicJob(), m_context, plotJob(), 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 413 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 330 of file api_handler_sch.cpp.

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

Referenced by API_HANDLER_SCH().

handleSaveDocumentAs()

HANDLER_RESULT< google::protobuf::Empty > API_HANDLER_SCH::handleSaveDocumentAs ( const HANDLER_CONTEXT< commands::SaveDocumentAs > & aCtx )

private

Definition at line 359 of file api_handler_sch.cpp.

References API_HANDLER::apiServer(), API_HANDLER_EDITOR::checkForBusy(), context(), FILEEXT::KiCadSchematicFileExtension, m_context, Pgm(), HANDLER_CONTEXT< RequestMessageType >::Request, thisDocumentType(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

handleSaveDocumentToString()

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

private

Definition at line 508 of file api_handler_sch.cpp.

References SCH_IO_KICAD_SEXPR::FormatSchematicToFormatter(), SCH_SHEET::GetScreen(), STRING_FORMATTER::GetString(), SCHEMATIC::GetTopLevelSheet(), KICAD_FORMAT::Prettify(), HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), kiapi::common::UnpackSheetPath(), and API_HANDLER_EDITOR::validateDocument().

Referenced by API_HANDLER_SCH().

handleSaveSelectionToString()

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

private

Definition at line 549 of file api_handler_sch.cpp.

References checkForHeadless(), SCH_IO_KICAD_SEXPR::Format(), frame(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SELECTION_TOOL::GetSelection(), STRING_FORMATTER::GetString(), TOOL_MANAGER::GetTool(), KICAD_FORMAT::Prettify(), schematic(), and toolManager().

Referenced by API_HANDLER_SCH().

handleSetCurrentVariant()

HANDLER_RESULT< Empty > API_HANDLER_SCH::handleSetCurrentVariant ( const HANDLER_CONTEXT< commands::SetCurrentVariant > & aCtx )

private

Definition at line 3101 of file api_handler_sch.cpp.

References API_HANDLER_EDITOR::checkForBusy(), FindVariantNoCase(), frame(), API_HANDLER_EDITOR::m_frame, name, HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), SCH_EDIT_FRAME::SetCurrentVariant(), 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

Definition at line 540 of file api_handler_editor.cpp.

References FromProtoEnum(), getDrawingSheetFileName(), getPageSettings(), PAGE_INFO::GetSizeIU(), PAGE_INFO::GetType(), PAGE_INFO::IsCustom(), PAGE_INFO::IsPortrait(), onModified(), kiapi::common::PackVector2(), pcbIUScale, HANDLER_CONTEXT< RequestMessageType >::Request, PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), setDrawingSheetFileName(), setPageSettings(), PAGE_INFO::SetType(), ToProtoEnum(), kiapi::common::UnpackVector2(), User, validateDocument(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

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

handleSetVariantDescription()

HANDLER_RESULT< Empty > API_HANDLER_SCH::handleSetVariantDescription ( const HANDLER_CONTEXT< commands::SetVariantDescription > & aCtx )

private

Definition at line 3062 of file api_handler_sch.cpp.

References _, API_HANDLER_EDITOR::checkForBusy(), FindVariantNoCase(), frame(), GetDefaultVariantName(), API_HANDLER_EDITOR::m_frame, name, EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), PICKED_ITEMS_LIST::SetDescription(), API_HANDLER_EDITOR::validateDocument(), and VARIANTS.

Referenced by API_HANDLER_SCH().

handleSyncSelection()

HANDLER_RESULT< SyncSelectionResponse > API_HANDLER_SCH::handleSyncSelection ( const HANDLER_CONTEXT< commands::SyncSelection > & aCtx )

private

Definition at line 2615 of file api_handler_sch.cpp.

References checkForHeadless(), SCH_BASE_FRAME::eeconfig(), findItemsFromSyncSelection(), frame(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), APP_SETTINGS_BASE::m_CrossProbing, CROSS_PROBING_SETTINGS::on_selection, HANDLER_CONTEXT< RequestMessageType >::Request, schematic(), SCH_EDIT_FRAME::SetSyncingSelection(), SCH_EDIT_FRAME::StartCrossProbeFlash(), and traceCrossProbeFlash.

Referenced by API_HANDLER_SCH().

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

void API_HANDLER_SCH::onModified ( )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1636 of file api_handler_sch.cpp.

References frame(), SCHEMATIC::GetCurrentScreen(), API_HANDLER_EDITOR::m_frame, SCH_EDIT_FRAME::OnModify(), schematic(), and BASE_SCREEN::SetContentModified().

Referenced by handleAddVariant(), handleCopyVariant(), handleDeleteVariant(), and handleRenameVariant().

onNetSettingsChanged()

void API_HANDLER_SCH::onNetSettingsChanged ( )

overrideprotectedvirtual

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

Reimplemented from API_HANDLER.

Definition at line 1650 of file api_handler_sch.cpp.

References frame(), and API_HANDLER_EDITOR::m_frame.

packSchItem()

bool API_HANDLER_SCH::packSchItem ( google::protobuf::Any & aOut, SCH_ITEM * aItem, const SCH_SHEET_PATH & aPath )

private

Serializes a schematic item into aOut, using path-aware packing for symbols and sheets.

Returns false if the item could not be packed (e.g. a symbol/sheet missing instance data).

Definition at line 237 of file api_handler_sch.cpp.

References PackSheet(), PackSymbol(), SCH_SHEET_T, SCH_SYMBOL_T, SERIALIZABLE::Serialize(), and EDA_ITEM::Type().

Referenced by handleAddToSelection(), handleGetItems(), handleGetSelection(), and handleRemoveFromSelection().

packSheetInstance()

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

private

Definition at line 1973 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(), INTERNAL, packSheetInstance(), kiapi::common::PackSheetPath(), 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 400 of file api_handler_editor.cpp.

References FromProtoEnum(), and TYPE_NOT_INIT.

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

project()

PROJECT & API_HANDLER_SCH::project ( ) const

inlineprotected

Definition at line 102 of file api_handler_sch.h.

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

Referenced by handleExpandTextVariables(), handlePlaceSymbolFromLibrary(), handleSaveCopyOfDocument(), and handleSaveDocument().

pushCurrentCommit()

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

protectedvirtualinherited

Reimplemented in API_HANDLER_BOARD, and API_HANDLER_SYMBOL.

Definition at line 166 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(), API_HANDLER_SCH::handlePlaceSymbolFromLibrary(), API_HANDLER_BOARD::pushCurrentCommit(), and API_HANDLER_SYMBOL::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 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().

resolveScreenFromDocument()

SCH_SCREEN * API_HANDLER_SCH::resolveScreenFromDocument ( const DocumentSpecifier & aDocument ) const

private

Returns the sheet path's screen when one is given and it is found, or null.

Otherwise, returns the editor's current sheet (or root sheet in headless mode).

Definition at line 1569 of file api_handler_sch.cpp.

References m_context, path, SCHEMATIC::RootScreen(), schematic(), and kiapi::common::UnpackSheetPath().

Referenced by getPageSettings(), getTitleBlock(), and setPageSettings().

schematic()

SCHEMATIC * API_HANDLER_SCH::schematic ( ) const

private

Definition at line 212 of file api_handler_sch.cpp.

References m_context.

Referenced by deleteItemsInternal(), getItemById(), getItemFromDocument(), handleAddVariant(), handleCopyVariant(), handleCreateUpdateItemsInternal(), handleDeleteVariant(), handleExpandTextVariables(), handleFocusOnItems(), handleGetCurrentVariant(), handleGetDocumentModifiedState(), handleGetItems(), handleGetItemsById(), handleGetSchematicHierarchy(), handleGetSchematicNetlist(), handleGetVariants(), handlePlaceSymbolFromLibrary(), handleRenameVariant(), handleSaveDocument(), handleSaveDocumentToString(), handleSaveSelectionToString(), handleSetCurrentVariant(), handleSetVariantDescription(), handleSyncSelection(), onModified(), resolveScreenFromDocument(), setDrawingSheetFileName(), and validateDocumentInternal().

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

void API_HANDLER_SCH::setDrawingSheetFileName ( const wxString & aFileName )

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1626 of file api_handler_sch.cpp.

References frame(), SCH_EDIT_FRAME::LoadDrawingSheet(), BASE_SCREEN::m_DrawingSheetFileName, API_HANDLER_EDITOR::m_frame, SCHEMATIC_SETTINGS::m_SchDrawingSheetFileName, schematic(), and SCHEMATIC::Settings().

setPageSettings()

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

overrideprotectedvirtual

Reimplemented from API_HANDLER_EDITOR.

Definition at line 1607 of file api_handler_sch.cpp.

References resolveScreenFromDocument().

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

Referenced by handleSaveDocumentAs().

toolManager()

TOOL_MANAGER * API_HANDLER_SCH::toolManager ( ) const

inlineprotected

Definition at line 100 of file api_handler_sch.h.

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

Referenced by createCommit(), handleCopyVariant(), handleDeleteVariant(), handleRenameVariant(), and handleSaveSelectionToString().

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

validateDocument()

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

protectedinherited

Definition at line 180 of file api_handler_editor.cpp.

References validateDocumentInternal().

Referenced by API_HANDLER_BOARD::getItemFromDocument(), API_HANDLER_SCH::getItemFromDocument(), API_HANDLER_SYMBOL::getItemFromDocument(), API_HANDLER_PCB::handleAddEmbeddedFiles(), API_HANDLER_PCB::handleAddVariant(), API_HANDLER_SCH::handleAddVariant(), API_HANDLER_BOARD::handleCheckPadstackPresenceOnLayers(), API_HANDLER_PCB::handleCopyVariant(), API_HANDLER_SCH::handleCopyVariant(), API_HANDLER_PCB::handleDeleteVariant(), API_HANDLER_SCH::handleDeleteVariant(), API_HANDLER_BOARD::handleExpandTextVariables(), API_HANDLER_SCH::handleExpandTextVariables(), API_HANDLER_BOARD::handleFocusOnItems(), API_HANDLER_SCH::handleFocusOnItems(), API_HANDLER_BOARD::handleGetActiveLayer(), API_HANDLER_BOARD::handleGetBoardBoundingBox(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_BOARD::handleGetBoardEnabledLayers(), API_HANDLER_PCB::handleGetBoardLayerByName(), API_HANDLER_PCB::handleGetBoardLayerName(), API_HANDLER_PCB::handleGetBoardOrigin(), API_HANDLER_PCB::handleGetBoardPlotSettings(), API_HANDLER_PCB::handleGetCurrentVariant(), API_HANDLER_SCH::handleGetCurrentVariant(), API_HANDLER_PCB::handleGetCustomDesignRules(), handleGetDocumentModifiedState(), API_HANDLER_PCB::handleGetDocumentModifiedState(), API_HANDLER_SCH::handleGetDocumentModifiedState(), API_HANDLER_SYMBOL::handleGetDocumentModifiedState(), API_HANDLER_PCB::handleGetEmbeddedFiles(), API_HANDLER_BOARD::handleGetGraphicsDefaults(), API_HANDLER_PCB::handleGetNets(), API_HANDLER_BOARD::handleGetPadShapeAsPolygon(), handleGetPageSettings(), API_HANDLER_SCH::handleGetSchematicHierarchy(), API_HANDLER_SCH::handleGetSchematicNetlist(), API_HANDLER_BOARD::handleGetStackup(), handleGetTitleBlockInfo(), API_HANDLER_PCB::handleGetVariants(), API_HANDLER_SCH::handleGetVariants(), API_HANDLER_BOARD::handleGetVisibleLayers(), API_HANDLER_PCB::handleImportNetlist(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_BOARD::handleInteractiveMoveItems(), API_HANDLER_BOARD::handleParseAndCreateItemsFromString(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_PCB::handleRenameVariant(), API_HANDLER_SCH::handleRenameVariant(), API_HANDLER_FOOTPRINT::handleRevertDocument(), API_HANDLER_PCB::handleRevertDocument(), API_HANDLER_SCH::handleRevertDocument(), API_HANDLER_SYMBOL::handleRevertDocument(), API_HANDLER_PCB::handleRunBoardJobExport3D(), API_HANDLER_PCB::handleRunBoardJobExportDrill(), API_HANDLER_PCB::handleRunBoardJobExportDxf(), API_HANDLER_PCB::handleRunBoardJobExportGencad(), API_HANDLER_PCB::handleRunBoardJobExportGerbers(), API_HANDLER_PCB::handleRunBoardJobExportIdf(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportIpcD356(), API_HANDLER_PCB::handleRunBoardJobExportODB(), API_HANDLER_PCB::handleRunBoardJobExportPdf(), API_HANDLER_PCB::handleRunBoardJobExportPng(), API_HANDLER_PCB::handleRunBoardJobExportPosition(), API_HANDLER_PCB::handleRunBoardJobExportPs(), API_HANDLER_PCB::handleRunBoardJobExportRender(), API_HANDLER_PCB::handleRunBoardJobExportStats(), API_HANDLER_PCB::handleRunBoardJobExportSvg(), API_HANDLER_SCH::handleRunSchematicJobExportBOM(), API_HANDLER_SCH::handleRunSchematicJobExportDxf(), API_HANDLER_SCH::handleRunSchematicJobExportNetlist(), API_HANDLER_SCH::handleRunSchematicJobExportPdf(), API_HANDLER_SCH::handleRunSchematicJobExportPng(), API_HANDLER_SCH::handleRunSchematicJobExportPs(), API_HANDLER_SCH::handleRunSchematicJobExportSvg(), API_HANDLER_PCB::handleSaveCopyOfDocument(), API_HANDLER_SCH::handleSaveCopyOfDocument(), API_HANDLER_SYMBOL::handleSaveCopyOfDocument(), API_HANDLER_PCB::handleSaveDocument(), API_HANDLER_SCH::handleSaveDocument(), API_HANDLER_SYMBOL::handleSaveDocument(), API_HANDLER_PCB::handleSaveDocumentAs(), API_HANDLER_SCH::handleSaveDocumentAs(), API_HANDLER_BOARD::handleSaveDocumentToString(), API_HANDLER_SCH::handleSaveDocumentToString(), API_HANDLER_BOARD::handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), API_HANDLER_PCB::handleSetBoardOrigin(), API_HANDLER_PCB::handleSetBoardPlotSettings(), API_HANDLER_PCB::handleSetCurrentVariant(), API_HANDLER_SCH::handleSetCurrentVariant(), API_HANDLER_PCB::handleSetCustomDesignRules(), API_HANDLER_PCB::handleSetEmbeddedFiles(), handleSetPageSettings(), handleSetTitleBlockInfo(), API_HANDLER_PCB::handleSetVariantDescription(), API_HANDLER_SCH::handleSetVariantDescription(), API_HANDLER_BOARD::handleSetVisibleLayers(), API_HANDLER_FOOTPRINT::validateAndGetFootprint(), and validateItemHeaderDocument().

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 282 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 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<SCH_CONTEXT> API_HANDLER_SCH::m_context

private

Definition at line 222 of file api_handler_sch.h.

Referenced by API_HANDLER_SCH(), context(), handleAddToSelection(), handleClearSelection(), handleCreateUpdateItemsInternal(), handleExpandTextVariables(), handleFocusOnItems(), handleGetOpenDocuments(), handleGetSelection(), handlePlaceSymbolFromLibrary(), handleRemoveFromSelection(), handleRunSchematicJobExportBOM(), handleRunSchematicJobExportDxf(), handleRunSchematicJobExportNetlist(), handleRunSchematicJobExportPdf(), handleRunSchematicJobExportPng(), handleRunSchematicJobExportPs(), handleRunSchematicJobExportSvg(), handleSaveDocumentAs(), resolveScreenFromDocument(), schematic(), and validateDocumentInternal().

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.

Referenced by API_HANDLER_EDITOR(), checkForBusy(), API_HANDLER_BOARD::checkForHeadless(), API_HANDLER_SCH::checkForHeadless(), API_HANDLER_BOARD::createCommit(), API_HANDLER_SCH::createCommit(), API_HANDLER_SYMBOL::createCommit(), API_HANDLER_SYMBOL::deleteItemsInternal(), API_HANDLER_FOOTPRINT::frame(), API_HANDLER_PCB::frame(), API_HANDLER_SCH::frame(), API_HANDLER_SYMBOL::frame(), API_HANDLER_BOARD::handleAddToSelection(), API_HANDLER_SCH::handleAddVariant(), API_HANDLER_BOARD::handleClearSelection(), API_HANDLER_SCH::handleCopyVariant(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_SYMBOL::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleDeleteVariant(), API_HANDLER_BOARD::handleGetActiveLayer(), handleGetDocumentModifiedState(), API_HANDLER_SCH::handleGetSchematicNetlist(), API_HANDLER_BOARD::handleRemoveFromSelection(), API_HANDLER_SCH::handleRenameVariant(), API_HANDLER_BOARD::handleSetActiveLayer(), API_HANDLER_SCH::handleSetCurrentVariant(), API_HANDLER_SCH::handleSetVariantDescription(), API_HANDLER_BOARD::handleSetVisibleLayers(), API_HANDLER_SCH::onModified(), API_HANDLER_SCH::onNetSettingsChanged(), and API_HANDLER_SCH::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 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().

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_RULE_AREA_T,
    SCH_BITMAP_T,
    SCH_TEXTBOX_T,
    SCH_TEXT_T,
    SCH_TABLE_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 83 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:

• api_handler_sch.h
• api_handler_sch.cpp