plugin_browser.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2023 Alexandros Theodotou <alex@zrythm.org>
// SPDX-FileCopyrightText: © 2024 Miró Allard <miro.allard@pm.me>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense

 
#ifndef __GUI_WIDGETS_PLUGIN_BROWSER_H__
#define __GUI_WIDGETS_PLUGIN_BROWSER_H__
 
#include "common/plugins/collections.h"
#include "common/plugins/plugin.h"
#include "common/utils/symap.h"
#include "gui/backend/gtk_widgets/gtk_wrapper.h"
#include "gui/backend/gtk_widgets/item_factory.h"
 
#define PLUGIN_BROWSER_WIDGET_TYPE (plugin_browser_widget_get_type ())
G_DECLARE_FINAL_TYPE (
  PluginBrowserWidget,
  plugin_browser_widget,
  Z,
  PLUGIN_BROWSER_WIDGET,
  GtkWidget);
 
TYPEDEF_STRUCT_UNDERSCORED (ExpanderBoxWidget);
class ItemFactory;

 
#define MW_PLUGIN_BROWSER MW_RIGHT_DOCK_EDGE->plugin_browser
 
enum class PluginBrowserTab
{
  PLUGIN_BROWSER_TAB_COLLECTION,
  PLUGIN_BROWSER_TAB_AUTHOR,
  PLUGIN_BROWSER_TAB_CATEGORY,
  PLUGIN_BROWSER_TAB_PROTOCOL,
};
 
enum class PluginBrowserFilter
{
  PLUGIN_BROWSER_FILTER_NONE,
  PLUGIN_BROWSER_FILTER_INSTRUMENT,
  PLUGIN_BROWSER_FILTER_EFFECT,
  PLUGIN_BROWSER_FILTER_MODULATOR,
  PLUGIN_BROWSER_FILTER_MIDI_EFFECT,
};
 
enum class PluginBrowserSortStyle
{
  PLUGIN_BROWSER_SORT_ALPHA,
  PLUGIN_BROWSER_SORT_LAST_USED,
  PLUGIN_BROWSER_SORT_MOST_USED,
};

using PluginBrowserWidget = struct _PluginBrowserWidget
{
  GtkWidget parent_instance;
 
  GtkPaned * paned;

  AdwViewSwitcher * stack_switcher;
  GtkBox *          stack_switcher_box;

  AdwViewStack * stack;
 
  /* The stack pages for each list view */
  GtkBox *            collection_box;
  GtkBox *            author_box;
  GtkBox *            category_box;
  GtkBox *            protocol_box;
  GtkScrolledWindow * plugin_scroll;
 
  /* The tree views */
  GtkListView * collection_list_view;
  GtkListView * author_list_view;
  GtkListView * category_list_view;
  GtkListView * protocol_list_view;
 
  GtkSearchEntry * plugin_search_entry;
  GtkListView *    plugin_list_view;

  GtkBox * browser_bot;
 
  /* The toolbar to toggle visibility of
   * modulators/effects/instruments/midi modifiers */
  GtkBox * plugin_toolbar;
 
  GtkToggleButton * toggle_instruments;
  GtkToggleButton * toggle_effects;
  GtkToggleButton * toggle_modulators;
  GtkToggleButton * toggle_midi_modifiers;
 
  GtkToggleButton * alpha_sort_btn;
  GtkToggleButton * last_used_sort_btn;
  GtkToggleButton * most_used_sort_btn;

  GtkLabel * plugin_author_label;
  GtkLabel * plugin_type_label;
  GtkLabel * plugin_audio_label;
  GtkLabel * plugin_midi_label;
  GtkLabel * plugin_ctrl_label;
  GtkLabel * plugin_cv_label;

  std::vector<uint32_t> selected_authors;

  std::vector<zrythm::plugins::ZPluginCategory> selected_categories;

  std::vector<zrythm::plugins::PluginProtocol> selected_protocols;

  std::vector<zrythm::plugins::PluginCollection *> selected_collections;

  GtkCustomFilter *    plugin_filter;
  GtkFilterListModel * plugin_filter_model;
  GtkCustomSorter *    plugin_sorter;
  GtkSortListModel *   plugin_sort_model;

  ItemFactoryPtrVector item_factories;

  int    start_saving_pos;
  int    first_time_position_set;
  gint64 first_time_position_set_time;

  char * current_search;

  Symap * symap;

  GtkPopoverMenu * popover_menu;
};

PluginBrowserWidget *
plugin_browser_widget_new (void);
 
void
plugin_browser_widget_refresh_collections (PluginBrowserWidget * self);

 
#endif