Skip to content

Commit

Permalink
make the delta forward compatible as a requirement
Browse files Browse the repository at this point in the history
  • Loading branch information
abique committed Apr 18, 2024
1 parent 546ed7d commit e4c7447
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions include/clap/ext/draft/undo.h
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,12 @@ typedef struct clap_host_undo {
// name: mandatory null terminated string describing the change, this is displayed to the user
// detlas: optional, they are binary blobs used to perform the undo and redo. When not available
// the host will save of the plugin and use state->load() instead.
//
// Note: the provided delta **must** be serialized in a forward compatible way, because they may be used
// for incremental state saving and crash recovery. If the plugin is updated after the host crash,
// then we must be able to use delta created with an older version of the plugin.
// Worst case plugin->apply_delta() will fail but this is a scenario we prefer to avoid.
//
// [main-thread]
void(CLAP_ABI *complete_change)(const clap_host_t *host,
const char *name,
Expand Down

0 comments on commit e4c7447

Please sign in to comment.