redirect_box.h

/*
    Copyright (C) 2004 Paul Davis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_gtk_redirect_box__
#define __ardour_gtk_redirect_box__

#include <vector>

#include <cmath>
#include <gtkmm/box.h>
#include <gtkmm/eventbox.h>
#include <gtkmm/menu.h>
#include <gtkmm/scrolledwindow.h>
#include <gtkmm2ext/dndtreeview.h>
#include <gtkmm2ext/auto_spin.h>
#include <gtkmm2ext/click_box.h>
#include <gtkmm2ext/dndtreeview.h>

#include <pbd/stateful.h>

#include <ardour/types.h>
#include <ardour/ardour.h>
#include <ardour/io.h>
#include <ardour/insert.h>
#include <ardour/redirect.h>

#include <pbd/fastlog.h>

#include "plugin_interest.h"
#include "route_ui.h"
#include "io_selector.h"
#include "enums.h"

class MotionController;
class PluginSelector;
class PluginUIWindow;
class RouteRedirectSelection;

namespace ARDOUR {
      class Connection;
      class Insert;
      class Plugin;
      class PluginInsert;
      class PortInsert;
      class Route;
      class Send;
      class Session;
}

class RedirectBox : public Gtk::HBox, public PluginInterestedObject
{
  public:
      RedirectBox (ARDOUR::Placement, ARDOUR::Session&, 
                 PluginSelector &, RouteRedirectSelection &, bool owner_is_mixer = false);
      ~RedirectBox ();

      void set_route (boost::shared_ptr<ARDOUR::Route>);

      void set_width (Width);

      void update();

      void select_all_redirects ();
      void deselect_all_redirects ();
      void select_all_plugins ();
      void select_all_inserts ();
      void select_all_sends ();
      
      sigc::signal<void,boost::shared_ptr<ARDOUR::Redirect> > RedirectSelected;
      sigc::signal<void,boost::shared_ptr<ARDOUR::Redirect> > RedirectUnselected;
      
      static void register_actions();

  private:
      boost::shared_ptr<ARDOUR::Route>  _route;
      ARDOUR::Session &   _session;
      bool                _owner_is_mixer;
      std::vector<sigc::connection> connections;

      ARDOUR::Placement   _placement;

      PluginSelector     & _plugin_selector;
      RouteRedirectSelection  & _rr_selection;

      void route_going_away ();
      bool can_cut_redirects ();

      struct ModelColumns : public Gtk::TreeModel::ColumnRecord {
          ModelColumns () {
                add (text);
                add (redirect);
                add (color);
          }
          Gtk::TreeModelColumn<std::string>       text;
          Gtk::TreeModelColumn<boost::shared_ptr<ARDOUR::Redirect> > redirect;
          Gtk::TreeModelColumn<Gdk::Color>        color;
      };

      ModelColumns columns;
      Glib::RefPtr<Gtk::ListStore> model;
      
      void selection_changed ();

      static bool get_colors;
      static Gdk::Color* active_redirect_color;
      static Gdk::Color* inactive_redirect_color;
      
      Gtk::EventBox            redirect_eventbox;
      Gtk::HBox              redirect_hpacker;
      Gtkmm2ext::DnDTreeView<boost::shared_ptr<ARDOUR::Redirect> > redirect_display;
      Gtk::ScrolledWindow    redirect_scroller;

      void object_drop (const std::list<boost::shared_ptr<ARDOUR::Redirect> >&);

      Width _width;
      
      Gtk::Menu *send_action_menu;
      void build_send_action_menu ();

      void new_send ();
      void show_send_controls ();

      Gtk::Menu *redirect_menu;
      gint redirect_menu_map_handler (GdkEventAny *ev);
      Gtk::Menu * build_redirect_menu ();
      void build_redirect_tooltip (Gtk::EventBox&, string);
      void show_redirect_menu (gint arg);

      void choose_send ();
      void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Redirect>, IOSelectorWindow*);
      void choose_insert ();
      void choose_plugin ();
      void use_plugins (const SelectedPlugins&);

      bool no_redirect_redisplay;
      bool ignore_delete;

      bool redirect_button_press_event (GdkEventButton *);
      bool redirect_button_release_event (GdkEventButton *);
      void redisplay_redirects (void* src);
      void add_redirect_to_display (boost::shared_ptr<ARDOUR::Redirect>);
      void row_deleted (const Gtk::TreeModel::Path& path);
      void show_redirect_active_r (ARDOUR::Redirect*, void *, boost::weak_ptr<ARDOUR::Redirect>);
      void show_redirect_active (boost::weak_ptr<ARDOUR::Redirect>);
      void show_redirect_name (void* src, boost::weak_ptr<ARDOUR::Redirect>);
      string redirect_name (boost::weak_ptr<ARDOUR::Redirect>);

      void remove_redirect_gui (boost::shared_ptr<ARDOUR::Redirect>);

      void redirects_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
      void compute_redirect_sort_keys ();
      vector<sigc::connection> redirect_active_connections;
      vector<sigc::connection> redirect_name_connections;
      
      bool redirect_drag_in_progress;
      void redirect_drag_begin (GdkDragContext*);
      void redirect_drag_end (GdkDragContext*);
      void all_redirects_active(bool state);

      void cut_redirects ();
      void copy_redirects ();
      void paste_redirects ();
      void delete_redirects ();
      void clear_redirects ();
      void clone_redirects ();
      void rename_redirects ();

      void for_selected_redirects (void (RedirectBox::*pmf)(boost::shared_ptr<ARDOUR::Redirect>));
      void get_selected_redirects (vector<boost::shared_ptr<ARDOUR::Redirect> >&);

      static Glib::RefPtr<Gtk::Action> cut_action;
      static Glib::RefPtr<Gtk::Action> paste_action;
      void paste_redirect_list (const std::list<boost::shared_ptr<ARDOUR::Redirect> >& redirects);
      
      void activate_redirect (boost::shared_ptr<ARDOUR::Redirect>);
      void deactivate_redirect (boost::shared_ptr<ARDOUR::Redirect>);
      void cut_redirect (boost::shared_ptr<ARDOUR::Redirect>);
      void copy_redirect (boost::shared_ptr<ARDOUR::Redirect>);
      void edit_redirect (boost::shared_ptr<ARDOUR::Redirect>);
      void hide_redirect_editor (boost::shared_ptr<ARDOUR::Redirect>);
      void rename_redirect (boost::shared_ptr<ARDOUR::Redirect>);

      gint idle_delete_redirect (boost::weak_ptr<ARDOUR::Redirect>);

      void weird_plugin_dialog (ARDOUR::Plugin& p, uint32_t streams, boost::shared_ptr<ARDOUR::IO> io);

      static RedirectBox* _current_redirect_box;
      static bool enter_box (GdkEventCrossing*, RedirectBox*);
      static bool leave_box (GdkEventCrossing*, RedirectBox*);

      static void rb_choose_plugin ();
      static void rb_choose_insert ();
      static void rb_choose_send ();
      static void rb_clear ();
      static void rb_cut ();
      static void rb_copy ();
      static void rb_paste ();
      static void rb_delete ();
      static void rb_rename ();
      static void rb_select_all ();
      static void rb_deselect_all ();
      static void rb_activate ();
      static void rb_deactivate ();
      static void rb_activate_all ();
      static void rb_deactivate_all ();
      static void rb_edit ();
      
      void route_name_changed (void* src);
      std::string generate_redirect_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
};

#endif /* __ardour_gtk_redirect_box__ */