- kicadLibsInvalidate: a peer's edit only drops the lib's plugin entry + pcbnew's PreloadedFootprints (the cache the old reload never cleared — tree/preview/ LoadFootprint/update-from-library kept serving the old body); the fat re-load now runs lazily or from Update-from-library (kicadLibsReload, which also clears the preloaded cache) - usage bridges count the Footprint/Symbol Editor's open copy; update re-opens an unmodified copy, reports a modified one - embind TU gets eeschema/symbol_editor on its include path; smoke probes - kicad → 27051b46e2 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012Wd1r3ewftpV1DBSEArpRa
177 lines
7.2 KiB
C++
177 lines
7.2 KiB
C++
/*
|
|
* JS → editor library reload (r2-idb-sync realtime): drop a PCBJAM lib's
|
|
* in-plugin cache and re-sync the open editor's library tree after a remote
|
|
* (peer) edit landed in the page's SyncStack/IDB.
|
|
*
|
|
* The lib plugins (SCH_IO_PCBJAM_LIB / PCB_IO_PCBJAM_FP) cache parsed items for
|
|
* the plugin instance's lifetime and pin GetModifyHash()/GetLibraryTimestamp()
|
|
* to a constant, so nothing upstream ever re-reads the provider. The one full
|
|
* invalidation is LIBRARY_MANAGER::ReloadLibraryEntry — it erases the LIB_DATA
|
|
* entry INCLUDING the plugin instance (and with it the fat-load cache), the
|
|
* exact pattern the remote-symbol import flows already use
|
|
* (eeschema/widgets/panel_remote_symbol.cpp). LoadLibraryEntry then refetches
|
|
* synchronously (the fat "bodies" crossing — served from the now-fresh IDB, no
|
|
* network), and MAIL_RELOAD_LIB makes an open editor frame rebuild its tree.
|
|
*
|
|
* Header-only (the collab_common.h pattern); common-code includes only, so the
|
|
* merged kicad_editor TU (deliberately eeschema/pcbnew-header-free) can use it.
|
|
* Runs on the apply coroutine: LoadLibraryEntry suspends in the JS bridge, so
|
|
* the reload must serialize with the collab applies and local edits.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#ifdef __EMSCRIPTEN__
|
|
|
|
#include <string>
|
|
#include <wx/app.h>
|
|
#include <wx/string.h>
|
|
#include <kiway.h>
|
|
#include <kiway_player.h>
|
|
#include <libraries/library_manager.h>
|
|
#include <libraries/library_table.h>
|
|
#include <mail_type.h>
|
|
#include <pgm_base.h>
|
|
|
|
#include "collab_common.h"
|
|
|
|
namespace pcbjam_libs {
|
|
|
|
/**
|
|
* Reload one library from its provider and refresh any open editor tree.
|
|
* @param aKind "symbol" | "footprint" — which lib table the nickname lives in.
|
|
* @param aNickname the lib-table row name (LibInfo.name on the JS side).
|
|
*/
|
|
inline void reloadLibrary( std::string aKind, std::string aNickname )
|
|
{
|
|
KIWAY_PLAYER* top =
|
|
wxTheApp ? dynamic_cast<KIWAY_PLAYER*>( wxTheApp->GetTopWindow() ) : nullptr;
|
|
|
|
if( !top )
|
|
return;
|
|
|
|
const bool fp = aKind == "footprint";
|
|
const wxString nick = wxString::FromUTF8( aNickname.c_str() );
|
|
|
|
pcbjam_collab::runOnCoroutine( top, [top, fp, nick]()
|
|
{
|
|
LIBRARY_MANAGER& mgr = Pgm().GetLibraryManager();
|
|
const LIBRARY_TABLE_TYPE type =
|
|
fp ? LIBRARY_TABLE_TYPE::FOOTPRINT : LIBRARY_TABLE_TYPE::SYMBOL;
|
|
|
|
// Drop the LIB_DATA entry (plugin instance + its fat-load cache)…
|
|
mgr.ReloadLibraryEntry( type, nick );
|
|
// …and bring the lib back to LOADED synchronously, so the tree sync
|
|
// below reads fresh items instead of re-listing a LOADING stub.
|
|
mgr.LoadLibraryEntry( type, nick );
|
|
|
|
// An open editor frame re-syncs its tree from the (now fresh) adapter.
|
|
// The payload names the lib to FORCE-refresh: the symbol tree gates
|
|
// re-enumeration on a modify hash that is a pinned constant for PCBJAM
|
|
// plugins (and its mtime component never moves for a remote edit), so a
|
|
// plain sync would skip the lib; the named node is rebuilt instead.
|
|
// ExpressMail only delivers to frames that exist — no frame is created.
|
|
std::string payload( nick.utf8_str() );
|
|
top->Kiway().ExpressMail( fp ? FRAME_FOOTPRINT_EDITOR : FRAME_SCH_SYMBOL_EDITOR,
|
|
MAIL_RELOAD_LIB, payload );
|
|
} );
|
|
}
|
|
|
|
/**
|
|
* Cheap counterpart of reloadLibrary (libs 0019): drop the lib's LIB_DATA
|
|
* entry (plugin instance + parsed cache) so the NEXT access re-reads the
|
|
* provider — no eager LoadLibraryEntry fat-load, no tree mail. A remote edit
|
|
* calls this; the fat-load happens lazily when the user looks at the lib,
|
|
* or explicitly through reloadLibrary from "Update from library".
|
|
* (pcbnew's FOOTPRINT_LIBRARY_ADAPTER::PreloadedFootprints is invalidated by
|
|
* the pcbnew-side caller — this header stays common-code only.)
|
|
*/
|
|
inline void invalidateLibrary( std::string aKind, std::string aNickname )
|
|
{
|
|
KIWAY_PLAYER* top =
|
|
wxTheApp ? dynamic_cast<KIWAY_PLAYER*>( wxTheApp->GetTopWindow() ) : nullptr;
|
|
|
|
if( !top )
|
|
return;
|
|
|
|
const bool fp = aKind == "footprint";
|
|
const wxString nick = wxString::FromUTF8( aNickname.c_str() );
|
|
|
|
pcbjam_collab::runOnCoroutine( top, [fp, nick]()
|
|
{
|
|
Pgm().GetLibraryManager().ReloadLibraryEntry(
|
|
fp ? LIBRARY_TABLE_TYPE::FOOTPRINT : LIBRARY_TABLE_TYPE::SYMBOL, nick );
|
|
} );
|
|
}
|
|
|
|
/**
|
|
* Add one PCBJAM lib-table row at RUNTIME and load it — the lib SET is
|
|
* otherwise frozen at boot (sym/fp-lib-table are written once in preRun).
|
|
* Used by the "a new team library appeared" flow: the JS side has already
|
|
* created the `/mnt/pcbjam/<id>` MEMFS placeholder; this inserts the row into
|
|
* the LIVE in-memory global table (the table FILE is only re-read by
|
|
* LoadGlobalTables, which would drop every adapter cache — deliberately not
|
|
* used), loads the entry through the provider bridge, and re-syncs any open
|
|
* editor tree. Idempotent: an existing nickname is a no-op.
|
|
*
|
|
* @param aKind "symbol" | "footprint" — which lib table gets the row.
|
|
* @param aNickname the lib-table row name (LibInfo.name on the JS side).
|
|
* @param aUri the virtual mount uri ("/mnt/pcbjam/<libId>").
|
|
*/
|
|
inline void addLibraryEntry( std::string aKind, std::string aNickname, std::string aUri )
|
|
{
|
|
KIWAY_PLAYER* top =
|
|
wxTheApp ? dynamic_cast<KIWAY_PLAYER*>( wxTheApp->GetTopWindow() ) : nullptr;
|
|
|
|
if( !top )
|
|
return;
|
|
|
|
const bool fp = aKind == "footprint";
|
|
const wxString nick = wxString::FromUTF8( aNickname.c_str() );
|
|
const wxString uri = wxString::FromUTF8( aUri.c_str() );
|
|
|
|
pcbjam_collab::runOnCoroutine( top, [top, fp, nick, uri]()
|
|
{
|
|
LIBRARY_MANAGER& mgr = Pgm().GetLibraryManager();
|
|
const LIBRARY_TABLE_TYPE type =
|
|
fp ? LIBRARY_TABLE_TYPE::FOOTPRINT : LIBRARY_TABLE_TYPE::SYMBOL;
|
|
|
|
if( std::optional<LIBRARY_MANAGER_ADAPTER*> adapter = mgr.Adapter( type ); adapter )
|
|
{
|
|
LIBRARY_TABLE* table = ( *adapter )->GlobalTable();
|
|
|
|
if( !table )
|
|
return;
|
|
|
|
// Idempotent-cheap: a nickname that already has a row is done —
|
|
// content refresh is kicadLibsReload's job, and doing it here
|
|
// would let a re-announce trigger a pointless re-fat-load.
|
|
if( table->HasRow( nick ) )
|
|
return;
|
|
|
|
LIBRARY_TABLE_ROW& row = table->InsertRow();
|
|
row.SetNickname( nick );
|
|
row.SetURI( uri );
|
|
row.SetType( fp ? wxS( "PCBJAM_FP" ) : wxS( "PCBJAM" ) );
|
|
}
|
|
else
|
|
{
|
|
return;
|
|
}
|
|
|
|
// Bring the new row to LOADED through the JS provider bridge (GetRow
|
|
// walks the table on a cache miss, so the inserted row is found).
|
|
mgr.LoadLibraryEntry( type, nick );
|
|
|
|
// Open editor frames re-sync their tree; the nickname payload forces
|
|
// the named node's rebuild past the pinned-modify-hash gate (same
|
|
// reasoning as reloadLibrary above).
|
|
std::string payload( nick.utf8_str() );
|
|
top->Kiway().ExpressMail( fp ? FRAME_FOOTPRINT_EDITOR : FRAME_SCH_SYMBOL_EDITOR,
|
|
MAIL_RELOAD_LIB, payload );
|
|
} );
|
|
}
|
|
|
|
} // namespace pcbjam_libs
|
|
|
|
#endif // __EMSCRIPTEN__
|