event.h

// SPDX-FileCopyrightText: © 2019-2022, 2024 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __GUI_BACKEND_EVENT_H__
#define __GUI_BACKEND_EVENT_H__
 
#include "common/utils/format.h"
#include "common/utils/logger.h"
#include "common/utils/types.h"

 
enum class EventType
{
  /* arranger objects */
  ET_ARRANGER_OBJECT_CREATED,
  ET_ARRANGER_OBJECT_REMOVED,
  ET_ARRANGER_OBJECT_CHANGED,
 
  /* arranger_selections */
  ET_ARRANGER_SELECTIONS_CREATED,
  ET_ARRANGER_SELECTIONS_CHANGED,
  ET_ARRANGER_SELECTIONS_REMOVED,
  ET_ARRANGER_SELECTIONS_MOVED,
  ET_ARRANGER_SELECTIONS_QUANTIZED,

  ET_ARRANGER_SELECTIONS_CHANGED_REDRAW_EVERYTHING,

  ET_ARRANGER_SELECTIONS_ACTION_FINISHED,

  ET_TRACK_STATE_CHANGED,
  ET_RULER_STATE_CHANGED,
  ET_AUTOMATION_TRACK_ADDED,
  ET_AUTOMATION_TRACK_REMOVED,
  ET_TIME_SIGNATURE_CHANGED,
  ET_TRACK_ADDED,
  ET_TRACK_CHANGED,
  ET_TRACK_COLOR_CHANGED,
  ET_TRACK_NAME_CHANGED,
  ET_CHANNEL_SEND_CHANGED,
 
  ET_RULER_DISPLAY_TYPE_CHANGED,
 
  ET_TRANSPORT_TOTAL_BARS_CHANGED,
 
  ET_TRACK_AUTOMATION_VISIBILITY_CHANGED,
  ET_AUTOMATION_TRACK_CHANGED,

  ET_CLIP_EDITOR_REGION_CHANGED,

  ET_CLIP_MARKER_POS_CHANGED,
 
  ET_UNDO_REDO_ACTION_DONE,
  ET_RANGE_SELECTION_CHANGED,
  ET_TIMELINE_LOOP_MARKER_POS_CHANGED,
  ET_TIMELINE_PUNCH_MARKER_POS_CHANGED,
  ET_TIMELINE_SONG_MARKER_POS_CHANGED,
  ET_RULER_SIZE_CHANGED,
 
  ET_LOOP_TOGGLED,

  ET_TOOL_CHANGED,

  ET_RULER_VIEWPORT_CHANGED,
 
  ET_PLUGIN_ADDED,
  ET_PLUGINS_ADDED,
  ET_PLUGINS_REMOVED,
  ET_PLUGIN_DELETED,
  ET_PLUGIN_CRASHED,
  ET_PLAYHEAD_POS_CHANGED,
  ET_PLAYHEAD_POS_CHANGED_MANUALLY,
  ET_AUTOMATION_VALUE_CHANGED,
 
  ET_TRACKLIST_SELECTIONS_CHANGED,

  ET_PLUGIN_VISIBILITY_CHANGED,

  ET_PLUGIN_WINDOW_VISIBILITY_CHANGED,

  ET_PLUGIN_STATE_CHANGED,
 
  ET_TRACKS_ADDED,
  ET_TRACKS_REMOVED,
  ET_TRACKS_MOVED,
  ET_CHANNEL_REMOVED,
  ET_REFRESH_ARRANGER,
  ET_MIXER_SELECTIONS_CHANGED,
  ET_CHANNEL_OUTPUT_CHANGED,
  ET_CHANNEL_SLOTS_CHANGED,
 
  ET_MODULATOR_ADDED,
  ET_RT_SELECTIONS_CHANGED,
  ET_PINNED_TRACKLIST_SIZE_CHANGED,

  ET_DRUM_MODE_CHANGED,

  ET_TRACK_LANES_VISIBILITY_CHANGED,

  ET_TRACK_LANE_ADDED,

  ET_TRACK_LANE_REMOVED,
 
  ET_PIANO_ROLL_HIGHLIGHTING_CHANGED,
  ET_PIANO_ROLL_MIDI_MODIFIER_CHANGED,
  ET_AUTOMATION_TRACKLIST_AT_REMOVED,
  ET_ARRANGER_SELECTIONS_IN_TRANSIT,
  ET_JACK_TRANSPORT_TYPE_CHANGED,
  ET_TRACK_VISIBILITY_CHANGED,
  ET_SELECTING_IN_ARRANGER,
  ET_TRACKS_RESIZED,
  ET_CLIP_EDITOR_FIRST_TIME_REGION_SELECTED,
  ET_BPM_CHANGED,
  ET_CHANNEL_FADER_VAL_CHANGED,
 
  ET_CHORD_KEY_CHANGED,

  ET_CHORD_PRESET_ADDED,

  ET_CHORD_PRESET_EDITED,

  ET_CHORD_PRESET_REMOVED,

  ET_CHORD_PRESET_PACK_ADDED,

  ET_CHORD_PRESET_PACK_EDITED,

  ET_CHORD_PRESET_PACK_REMOVED,

  ET_CHORDS_UPDATED,

  ET_PIANO_ROLL_KEY_ZOOM_CHANGED,

  ET_PIANO_ROLL_KEY_HEIGHT_CHANGED,

  ET_MAIN_WINDOW_LOADED,

  ET_PROJECT_LOADED,

  ET_PROJECT_SAVED,

  ET_PLUGIN_LATENCY_CHANGED,

  ET_ARRANGER_HIGHLIGHT_CHANGED,
 
  ET_ENGINE_ACTIVATE_CHANGED,
  ET_ENGINE_BUFFER_SIZE_CHANGED,
  ET_ENGINE_SAMPLE_RATE_CHANGED,
  ET_MIDI_BINDINGS_CHANGED,
  ET_PORT_CONNECTION_CHANGED,
  ET_EDITOR_FUNCTION_APPLIED,
 
  ET_SPLASH_CLOSED,
 
  ET_AUTOMATION_VALUE_VISIBILITY_CHANGED,
  ET_PROJECT_SELECTION_TYPE_CHANGED,

  ET_AUDIO_SELECTIONS_RANGE_CHANGED,
 
  ET_PLUGIN_COLLECTIONS_CHANGED,
 
  ET_SNAP_GRID_OPTIONS_CHANGED,
 
  ET_TRANSPORT_RECORDING_ON_OFF_CHANGED,

  ET_TRANSPORT_ROLL_REQUIRED,

  ET_TRANSPORT_PAUSE_REQUIRED,

  ET_TRANSPORT_MOVE_BACKWARD_REQUIRED,

  ET_TRANSPORT_MOVE_FORWARD_REQUIRED,

  ET_TRANSPORT_TOGGLE_LOOP_REQUIRED,

  ET_TRANSPORT_TOGGLE_RECORDING_REQUIRED,

  ET_TRACK_FREEZE_CHANGED,

  ET_LOG_WARNING_STATE_CHANGED,

  ET_PLAYHEAD_SCROLL_MODE_CHANGED,

  ET_TRACK_FADER_BUTTON_CHANGED,

  ET_PLUGIN_PRESET_SAVED,

  ET_PLUGIN_PRESET_LOADED,

  ET_TRACK_FOLD_CHANGED,

  ET_MIXER_CHANNEL_MIDI_FX_EXPANDED_CHANGED,

  ET_MIXER_CHANNEL_INSERTS_EXPANDED_CHANGED,

  ET_MIXER_CHANNEL_SENDS_EXPANDED_CHANGED,

  ET_REGION_ACTIVATED,

  ET_PIANO_ROLL_KEY_ON_OFF,

  ET_VELOCITIES_RAMPED,

  ET_AUDIO_REGION_FADE_IN_CHANGED,
  ET_AUDIO_REGION_FADE_OUT_CHANGED,

  ET_AUDIO_REGION_GAIN_CHANGED,

  ET_FILE_BROWSER_BOOKMARK_ADDED,

  ET_FILE_BROWSER_BOOKMARK_DELETED,

  ET_ARRANGER_SCROLLED,

  ET_FILE_BROWSER_INSTRUMENT_CHANGED,
};

class ZEvent
{
public:
  // Rule of 0
 
public:
  EventType type_{};

  void * arg_ = nullptr;

  const char * file_ = nullptr;

  const char * func_ = nullptr;

  int lineno_ = 0;

  std::string backtrace_;
};
 
DEFINE_OBJECT_FORMATTER (ZEvent, [] (const ZEvent &ev) {
  return fmt::format (
    "UI Event from {}:{}:{}:\ntype: {}\narg: {}", ev.file_, ev.func_,
    ev.lineno_, ENUM_NAME (ev.type_), fmt::ptr (ev.arg_));
});

 
#endif