#include <panel_remote_symbol.h>

Inheritance diagram for PANEL_REMOTE_SYMBOL:

Public Member Functions
	PANEL_REMOTE_SYMBOL (SCH_EDIT_FRAME *aParent)

void	RefreshDataSources ()

bool	HasDataSources () const

void	BindWebViewLoaded ()

Private Member Functions
void	onDataSourceChanged (wxCommandEvent &aEvent)

void	onConfigure (wxCommandEvent &aEvent)

void	onWebViewLoaded (wxWebViewEvent &aEvent)

bool	loadDataSource (size_t aIndex)

bool	loadDataSource (const PCM_INSTALLATION_ENTRY &aEntry)

std::optional< wxFileName >	findDataSourceJson (const PCM_INSTALLATION_ENTRY &aEntry) const

void	showMessage (const wxString &aMessage)

std::optional< wxString >	extractUrlFromJson (const wxString &aJsonContent) const

void	onKicadMessage (const wxString &aMessage)

void	handleRpcMessage (const nlohmann::json &aMessage)

void	beginSessionHandshake ()

void	sendRpcMessage (const wxString &aCommand, nlohmann::json aParameters=nlohmann::json::object(), std::optional< int > aResponseTo=std::nullopt, const wxString &aStatus=wxS("OK"), const std::string &aData=std::string(), const wxString &aErrorCode=wxEmptyString, const wxString &aErrorMessage=wxEmptyString)

void	respondWithError (const wxString &aCommand, int aResponseTo, const wxString &aErrorCode, const wxString &aErrorMessage)

bool	ensureDestinationRoot (wxFileName &aOutDir, wxString &aError) const

bool	ensureSymbolLibraryEntry (const wxFileName &aLibraryFile, const wxString &aNickname, bool aGlobalTable, wxString &aError) const

bool	ensureFootprintLibraryEntry (const wxFileName &aLibraryDir, const wxString &aNickname, bool aGlobalTable, wxString &aError) const

wxString	sanitizedPrefix () const

bool	receiveFootprint (const nlohmann::json &aParams, const std::vector< uint8_t > &aPayload, wxString &aError)

bool	receiveSymbol (const nlohmann::json &aParams, const std::vector< uint8_t > &aPayload, wxString &aError)

bool	receive3DModel (const nlohmann::json &aParams, const std::vector< uint8_t > &aPayload, wxString &aError)

bool	receiveSPICEModel (const nlohmann::json &aParams, const std::vector< uint8_t > &aPayload, wxString &aError)

bool	placeDownloadedSymbol (const wxString &aNickname, const wxString &aLibItemName, wxString &aError)

wxString	sanitizeFileComponent (const wxString &aComponent, const wxString &aDefault) const

wxString	sanitizeForScript (const std::string &aJson) const

wxString	jsonString (const nlohmann::json &aObject, const char *aKey) const

bool	decodeBase64Payload (const std::string &aMessage, std::vector< uint8_t > &aOutPayload, wxString &aError) const

bool	decompressIfNeeded (const std::string &aCompression, const std::vector< uint8_t > &aInput, std::vector< uint8_t > &aOutput, wxString &aError) const

bool	writeBinaryFile (const wxFileName &aFile, const std::vector< uint8_t > &aData, wxString &aError) const

std::unique_ptr< LIB_SYMBOL >	loadSymbolFromPayload (const std::vector< uint8_t > &aPayload, const wxString &aLibItemName, wxString &aError) const

Private Attributes
SCH_EDIT_FRAME *	m_frame

wxChoice *	m_dataSourceChoice

BITMAP_BUTTON *	m_configButton

WEBVIEW_PANEL *	m_webView

std::shared_ptr< PLUGIN_CONTENT_MANAGER >	m_pcm

std::vector< PCM_INSTALLATION_ENTRY >	m_dataSources

KIID	m_sessionId

int	m_messageIdCounter

bool	m_pendingHandshake

Detailed Description

Definition at line 48 of file panel_remote_symbol.h.

Constructor & Destructor Documentation

◆ PANEL_REMOTE_SYMBOL()

PANEL_REMOTE_SYMBOL::PANEL_REMOTE_SYMBOL ( SCH_EDIT_FRAME * aParent )

explicit

Definition at line 293 of file panel_remote_symbol.cpp.

References m_configButton, m_dataSourceChoice, m_frame, m_pcm, and m_webView.

Member Function Documentation

◆ beginSessionHandshake()

void PANEL_REMOTE_SYMBOL::beginSessionHandshake ( )

private

Definition at line 702 of file panel_remote_symbol.cpp.

References GetSemanticVersion(), m_messageIdCounter, m_sessionId, m_webView, REMOTE_SYMBOL_SESSION_VERSION, and sendRpcMessage().

Referenced by onWebViewLoaded().

◆ BindWebViewLoaded()

void PANEL_REMOTE_SYMBOL::BindWebViewLoaded ( )

Definition at line 346 of file panel_remote_symbol.cpp.

References m_webView, and onWebViewLoaded().

◆ decodeBase64Payload()

bool PANEL_REMOTE_SYMBOL::decodeBase64Payload	(	const std::string &	aMessage,
		std::vector< uint8_t > &	aOutPayload,
		wxString &	aError ) const

private

Definition at line 79 of file panel_remote_symbol.cpp.

References _.

Referenced by handleRpcMessage().

◆ decompressIfNeeded()

bool PANEL_REMOTE_SYMBOL::decompressIfNeeded	(	const std::string &	aCompression,
		const std::vector< uint8_t > &	aInput,
		std::vector< uint8_t > &	aOutput,
		wxString &	aError ) const

private

Definition at line 102 of file panel_remote_symbol.cpp.

References _.

Referenced by handleRpcMessage().

◆ ensureDestinationRoot()

bool PANEL_REMOTE_SYMBOL::ensureDestinationRoot	(	wxFileName &	aOutDir,
		wxString &	aError ) const

private

Definition at line 944 of file panel_remote_symbol.cpp.

References _, EESCHEMA_SETTINGS::REMOTE_SYMBOL_CONFIG::DefaultDestinationDir(), EESCHEMA_SETTINGS::REMOTE_SYMBOL_CONFIG::destination_dir, ExpandEnvVarSubstitutions(), FN_NORMALIZE_FLAGS, GetAppSettings(), GetSettingsManager(), EESCHEMA_SETTINGS::m_RemoteSymbol, Pgm(), and Prj().

Referenced by receive3DModel(), receiveFootprint(), receiveSPICEModel(), and receiveSymbol().

◆ ensureFootprintLibraryEntry()

bool PANEL_REMOTE_SYMBOL::ensureFootprintLibraryEntry	(	const wxFileName &	aLibraryDir,
		const wxString &	aNickname,
		bool	aGlobalTable,
		wxString &	aError ) const

private

Definition at line 1042 of file panel_remote_symbol.cpp.

References _, FOOTPRINT, PGM_BASE::GetLibraryManager(), GLOBAL, Pgm(), PROJECT, LIBRARY_TABLE_ROW::SetDescription(), LIBRARY_TABLE_ROW::SetNickname(), LIBRARY_TABLE_ROW::SetOk(), LIBRARY_TABLE_ROW::SetOptions(), LIBRARY_TABLE_ROW::SetType(), LIBRARY_TABLE_ROW::SetURI(), LIBRARY_MANAGER::Table(), table, and LIBRARY_TABLE_ROW::URI().

Referenced by receiveFootprint().

◆ ensureSymbolLibraryEntry()

bool PANEL_REMOTE_SYMBOL::ensureSymbolLibraryEntry	(	const wxFileName &	aLibraryFile,
		const wxString &	aNickname,
		bool	aGlobalTable,
		wxString &	aError ) const

private

Definition at line 986 of file panel_remote_symbol.cpp.

References _, PGM_BASE::GetLibraryManager(), GLOBAL, Pgm(), PROJECT, LIBRARY_TABLE_ROW::SetDescription(), LIBRARY_TABLE_ROW::SetNickname(), LIBRARY_TABLE_ROW::SetOk(), LIBRARY_TABLE_ROW::SetOptions(), LIBRARY_TABLE_ROW::SetType(), LIBRARY_TABLE_ROW::SetURI(), SYMBOL, LIBRARY_MANAGER::Table(), table, and LIBRARY_TABLE_ROW::URI().

Referenced by receiveSymbol().

◆ extractUrlFromJson()

std::optional< wxString > PANEL_REMOTE_SYMBOL::extractUrlFromJson ( const wxString & aJsonContent ) const

private

Definition at line 543 of file panel_remote_symbol.cpp.

References name, and path.

Referenced by loadDataSource().

◆ findDataSourceJson()

std::optional< wxFileName > PANEL_REMOTE_SYMBOL::findDataSourceJson ( const PCM_INSTALLATION_ENTRY & aEntry ) const

private

Definition at line 472 of file panel_remote_symbol.cpp.

References PCM_PACKAGE::identifier, m_pcm, and PCM_INSTALLATION_ENTRY::package.

Referenced by loadDataSource().

◆ handleRpcMessage()

void PANEL_REMOTE_SYMBOL::handleRpcMessage ( const nlohmann::json & aMessage )

private

Definition at line 772 of file panel_remote_symbol.cpp.

References _, decodeBase64Payload(), decompressIfNeeded(), GetSemanticVersion(), jsonString(), m_sessionId, receive3DModel(), receiveFootprint(), receiveSPICEModel(), receiveSymbol(), REMOTE_SYMBOL_SESSION_VERSION, respondWithError(), and sendRpcMessage().

Referenced by onKicadMessage().

◆ HasDataSources()

bool PANEL_REMOTE_SYMBOL::HasDataSources ( ) const

inline

Definition at line 54 of file panel_remote_symbol.h.

References m_dataSources.

◆ jsonString()

wxString PANEL_REMOTE_SYMBOL::jsonString	(	const nlohmann::json &	aObject,
		const char *	aKey ) const

private

Definition at line 69 of file panel_remote_symbol.cpp.

Referenced by handleRpcMessage(), receive3DModel(), receiveFootprint(), receiveSPICEModel(), and receiveSymbol().

◆ loadDataSource() [1/2]

bool PANEL_REMOTE_SYMBOL::loadDataSource ( const PCM_INSTALLATION_ENTRY & aEntry )

private

Definition at line 422 of file panel_remote_symbol.cpp.

References _, extractUrlFromJson(), findDataSourceJson(), PCM_PACKAGE::identifier, m_pendingHandshake, m_webView, PCM_PACKAGE::name, PCM_INSTALLATION_ENTRY::package, and showMessage().

◆ loadDataSource() [2/2]

bool PANEL_REMOTE_SYMBOL::loadDataSource ( size_t aIndex )

private

Definition at line 413 of file panel_remote_symbol.cpp.

References loadDataSource(), and m_dataSources.

Referenced by loadDataSource(), onDataSourceChanged(), and RefreshDataSources().

◆ loadSymbolFromPayload()

std::unique_ptr< LIB_SYMBOL > PANEL_REMOTE_SYMBOL::loadSymbolFromPayload	(	const std::vector< uint8_t > &	aPayload,
		const wxString &	aLibItemName,
		wxString &	aError ) const

private

Definition at line 217 of file panel_remote_symbol.cpp.

References _, and IO_ERROR::What().

Referenced by receiveSymbol().

◆ onConfigure()

void PANEL_REMOTE_SYMBOL::onConfigure ( wxCommandEvent & aEvent )

private

Definition at line 403 of file panel_remote_symbol.cpp.

References RefreshDataSources(), and DIALOG_SHIM::ShowModal().

◆ onDataSourceChanged()

void PANEL_REMOTE_SYMBOL::onDataSourceChanged ( wxCommandEvent & aEvent )

private

Definition at line 392 of file panel_remote_symbol.cpp.

References loadDataSource().

◆ onKicadMessage()

void PANEL_REMOTE_SYMBOL::onKicadMessage ( const wxString & aMessage )

private

Definition at line 658 of file panel_remote_symbol.cpp.

References handleRpcMessage().

◆ onWebViewLoaded()

void PANEL_REMOTE_SYMBOL::onWebViewLoaded ( wxWebViewEvent & aEvent )

private

Definition at line 682 of file panel_remote_symbol.cpp.

References beginSessionHandshake(), and m_pendingHandshake.

Referenced by BindWebViewLoaded().

◆ placeDownloadedSymbol()

bool PANEL_REMOTE_SYMBOL::placeDownloadedSymbol	(	const wxString &	aNickname,
		const wxString &	aLibItemName,
		wxString &	aError )

private

Definition at line 1125 of file panel_remote_symbol.cpp.

References _, AUTOPLACE_AUTO, SCH_SYMBOL::AutoplaceFields(), m_frame, SCH_ACTIONS::placeSymbol, TOOL_MANAGER::PostAction(), LIB_ID::SetLibItemName(), LIB_ID::SetLibNickname(), and EDA_ITEM::SetParent().

Referenced by receiveSymbol().

◆ receive3DModel()

bool PANEL_REMOTE_SYMBOL::receive3DModel	(	const nlohmann::json &	aParams,
		const std::vector< uint8_t > &	aPayload,
		wxString &	aError )

private

Definition at line 1412 of file panel_remote_symbol.cpp.

References _, ensureDestinationRoot(), jsonString(), sanitizedPrefix(), sanitizeFileComponent(), and writeBinaryFile().

Referenced by handleRpcMessage().

◆ receiveFootprint()

bool PANEL_REMOTE_SYMBOL::receiveFootprint	(	const nlohmann::json &	aParams,
		const std::vector< uint8_t > &	aPayload,
		wxString &	aError )

private

Definition at line 1316 of file panel_remote_symbol.cpp.

References _, EESCHEMA_SETTINGS::REMOTE_SYMBOL_CONFIG::add_to_global_table, ensureDestinationRoot(), ensureFootprintLibraryEntry(), FOOTPRINT, GetAppSettings(), PGM_BASE::GetLibraryManager(), GLOBAL, jsonString(), EESCHEMA_SETTINGS::m_RemoteSymbol, Pgm(), PROJECT, LIBRARY_MANAGER::ReloadLibraryEntry(), sanitizedPrefix(), sanitizeFileComponent(), and writeBinaryFile().

Referenced by handleRpcMessage().

◆ receiveSPICEModel()

bool PANEL_REMOTE_SYMBOL::receiveSPICEModel	(	const nlohmann::json &	aParams,
		const std::vector< uint8_t > &	aPayload,
		wxString &	aError )

private

Definition at line 1477 of file panel_remote_symbol.cpp.

References _, ensureDestinationRoot(), jsonString(), sanitizedPrefix(), sanitizeFileComponent(), and writeBinaryFile().

Referenced by handleRpcMessage().

◆ receiveSymbol()

bool PANEL_REMOTE_SYMBOL::receiveSymbol	(	const nlohmann::json &	aParams,
		const std::vector< uint8_t > &	aPayload,
		wxString &	aError )

private

◆ RefreshDataSources()

void PANEL_REMOTE_SYMBOL::RefreshDataSources ( )

Definition at line 355 of file panel_remote_symbol.cpp.

References _, GetAppSettings(), loadDataSource(), m_dataSourceChoice, m_dataSources, m_pcm, PT_DATASOURCE, and showMessage().

Referenced by onConfigure().

◆ respondWithError()

void PANEL_REMOTE_SYMBOL::respondWithError	(	const wxString &	aCommand,
		int	aResponseTo,
		const wxString &	aErrorCode,
		const wxString &	aErrorMessage )

private

Definition at line 763 of file panel_remote_symbol.cpp.

References sendRpcMessage().

Referenced by handleRpcMessage().

◆ sanitizedPrefix()

wxString PANEL_REMOTE_SYMBOL::sanitizedPrefix ( ) const

private

Definition at line 1098 of file panel_remote_symbol.cpp.

References EESCHEMA_SETTINGS::REMOTE_SYMBOL_CONFIG::DefaultLibraryPrefix(), and GetAppSettings().

Referenced by receive3DModel(), receiveFootprint(), receiveSPICEModel(), and receiveSymbol().

◆ sanitizeFileComponent()

wxString PANEL_REMOTE_SYMBOL::sanitizeFileComponent	(	const wxString &	aComponent,
		const wxString &	aDefault ) const

private

Definition at line 156 of file panel_remote_symbol.cpp.

References result.

Referenced by receive3DModel(), receiveFootprint(), receiveSPICEModel(), and receiveSymbol().

◆ sanitizeForScript()

wxString PANEL_REMOTE_SYMBOL::sanitizeForScript ( const std::string & aJson ) const

private

Definition at line 148 of file panel_remote_symbol.cpp.

Referenced by sendRpcMessage().

◆ sendRpcMessage()

void PANEL_REMOTE_SYMBOL::sendRpcMessage	(	const wxString &	aCommand,
		nlohmann::json	aParameters = nlohmann::json::object(),
		std::optional< int >	aResponseTo = std::nullopt,
		const wxString &	aStatus = wxS( "OK" ),
		const std::string &	aData = std::string(),
		const wxString &	aErrorCode = wxEmptyString,
		const wxString &	aErrorMessage = wxEmptyString )

private

Definition at line 720 of file panel_remote_symbol.cpp.

References m_messageIdCounter, m_sessionId, m_webView, REMOTE_SYMBOL_SESSION_VERSION, and sanitizeForScript().

Referenced by beginSessionHandshake(), handleRpcMessage(), and respondWithError().

◆ showMessage()

void PANEL_REMOTE_SYMBOL::showMessage ( const wxString & aMessage )

private

Definition at line 518 of file panel_remote_symbol.cpp.

References m_webView.

Referenced by loadDataSource(), and RefreshDataSources().

◆ writeBinaryFile()

bool PANEL_REMOTE_SYMBOL::writeBinaryFile	(	const wxFileName &	aFile,
		const std::vector< uint8_t > &	aData,
		wxString &	aError ) const

private

Definition at line 176 of file panel_remote_symbol.cpp.

References _.

Referenced by receive3DModel(), receiveFootprint(), and receiveSPICEModel().

Member Data Documentation

◆ m_configButton

BITMAP_BUTTON* PANEL_REMOTE_SYMBOL::m_configButton

private

Definition at line 125 of file panel_remote_symbol.h.

Referenced by PANEL_REMOTE_SYMBOL().

◆ m_dataSourceChoice

wxChoice* PANEL_REMOTE_SYMBOL::m_dataSourceChoice

private

Definition at line 124 of file panel_remote_symbol.h.

Referenced by PANEL_REMOTE_SYMBOL(), and RefreshDataSources().

◆ m_dataSources

std::vector<PCM_INSTALLATION_ENTRY> PANEL_REMOTE_SYMBOL::m_dataSources

private

Definition at line 128 of file panel_remote_symbol.h.

Referenced by HasDataSources(), loadDataSource(), and RefreshDataSources().

◆ m_frame

SCH_EDIT_FRAME* PANEL_REMOTE_SYMBOL::m_frame

private

Definition at line 123 of file panel_remote_symbol.h.

Referenced by PANEL_REMOTE_SYMBOL(), placeDownloadedSymbol(), and receiveSymbol().

◆ m_messageIdCounter

int PANEL_REMOTE_SYMBOL::m_messageIdCounter

private

Definition at line 130 of file panel_remote_symbol.h.

Referenced by beginSessionHandshake(), and sendRpcMessage().

◆ m_pcm

std::shared_ptr<PLUGIN_CONTENT_MANAGER> PANEL_REMOTE_SYMBOL::m_pcm

private

Definition at line 127 of file panel_remote_symbol.h.

Referenced by findDataSourceJson(), PANEL_REMOTE_SYMBOL(), and RefreshDataSources().

◆ m_pendingHandshake

bool PANEL_REMOTE_SYMBOL::m_pendingHandshake

private

Definition at line 131 of file panel_remote_symbol.h.

Referenced by loadDataSource(), and onWebViewLoaded().

◆ m_sessionId

KIID PANEL_REMOTE_SYMBOL::m_sessionId

private

Definition at line 129 of file panel_remote_symbol.h.

Referenced by beginSessionHandshake(), handleRpcMessage(), and sendRpcMessage().

◆ m_webView

WEBVIEW_PANEL* PANEL_REMOTE_SYMBOL::m_webView

private

Definition at line 126 of file panel_remote_symbol.h.

Referenced by beginSessionHandshake(), BindWebViewLoaded(), loadDataSource(), PANEL_REMOTE_SYMBOL(), sendRpcMessage(), and showMessage().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PANEL_REMOTE_SYMBOL()

Member Function Documentation

◆ beginSessionHandshake()

◆ BindWebViewLoaded()

◆ decodeBase64Payload()

◆ decompressIfNeeded()

◆ ensureDestinationRoot()

◆ ensureFootprintLibraryEntry()

◆ ensureSymbolLibraryEntry()

◆ extractUrlFromJson()

◆ findDataSourceJson()

◆ handleRpcMessage()

◆ HasDataSources()

◆ jsonString()

◆ loadDataSource() [1/2]

◆ loadDataSource() [2/2]

◆ loadSymbolFromPayload()

◆ onConfigure()

◆ onDataSourceChanged()

◆ onKicadMessage()

◆ onWebViewLoaded()

◆ placeDownloadedSymbol()

◆ receive3DModel()

◆ receiveFootprint()

◆ receiveSPICEModel()

◆ receiveSymbol()

◆ RefreshDataSources()

◆ respondWithError()

◆ sanitizedPrefix()

◆ sanitizeFileComponent()

◆ sanitizeForScript()

◆ sendRpcMessage()

◆ showMessage()

◆ writeBinaryFile()

Member Data Documentation

◆ m_configButton

◆ m_dataSourceChoice

◆ m_dataSources

◆ m_frame

◆ m_messageIdCounter

◆ m_pcm

◆ m_pendingHandshake

◆ m_sessionId

◆ m_webView