undo_manager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2022 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __UNDO_UNDO_MANAGER_H__
#define __UNDO_UNDO_MANAGER_H__
 
#include "actions/undo_stack.h"
 
#include "zix/sem.h"
 
typedef struct AudioClip AudioClip;
 
#define UNDO_MANAGER_SCHEMA_VERSION 1
 
#define UNDO_MANAGER (PROJECT->undo_manager)
 
typedef struct UndoManager
{
  int schema_version;
 
  UndoStack * undo_stack;
  UndoStack * redo_stack;
 
  bool redo_stack_locked;
 
  ZixSem action_sem;
} UndoManager;
 
static const cyaml_schema_field_t undo_manager_fields_schema[] = {
  YAML_FIELD_INT (UndoManager, schema_version),
  YAML_FIELD_MAPPING_PTR (
    UndoManager,
    undo_stack,
    undo_stack_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    UndoManager,
    redo_stack,
    undo_stack_fields_schema),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t undo_manager_schema = {
  YAML_VALUE_PTR (UndoManager, undo_manager_fields_schema),
};
 
NONNULL void
undo_manager_init_loaded (UndoManager * self);
 
WARN_UNUSED_RESULT UndoManager *
undo_manager_new (void);
 
NONNULL_ARGS (1)
int undo_manager_undo (UndoManager * self, GError ** error);
 
NONNULL_ARGS (1)
int undo_manager_redo (UndoManager * self, GError ** error);
 
NONNULL_ARGS (1, 2)
int undo_manager_perform (
  UndoManager *    self,
  UndoableAction * action,
  GError **        error);
 
#define UNDO_MANAGER_PERFORM_AND_PROPAGATE_ERR( \
  action, err, ...) \
  { \
    g_return_val_if_fail ( \
      router_is_processing_thread (ROUTER) == false, false); \
    UndoableAction * ua = action (__VA_ARGS__); \
    if (ua) \
      { \
        int ret = \
          undo_manager_perform (UNDO_MANAGER, ua, err); \
        if (ret == 0) \
          return true; \
      } \
    return false; \
  }
 
NONNULL bool
undo_manager_contains_clip (
  UndoManager * self,
  AudioClip *   clip);
 
NONNULL void
undo_manager_get_plugins (UndoManager * self, GPtrArray * arr);
 
NONNULL UndoableAction *
undo_manager_get_last_action (UndoManager * self);
 
NONNULL void
undo_manager_clear_stacks (UndoManager * self, bool free);
 
NONNULL UndoManager *
undo_manager_clone (const UndoManager * src);
 
NONNULL void
undo_manager_free (UndoManager * self);
 
#endif