enough with umpteen "i18n.h" files. Consolidate on pbd/i18n.h
[ardour.git] / gtk2_ardour / option_editor.cc
index 807aee93bdcabafaba687f23e184bbabc4c266cf..f19babaae46b37ae126b58d328be77bfa15a9c83 100644 (file)
@@ -1,32 +1,42 @@
 /*
-    Copyright (C) 2001-2009 Paul Davis
+  Copyright (C) 2001-2009 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 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.
+  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.
+  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.
 
 */
+#include <algorithm>
 
 #include <gtkmm/box.h>
 #include <gtkmm/alignment.h>
 #include "gtkmm2ext/utils.h"
-#include "ardour/configuration.h"
-#include "ardour/utils.h"
+
 #include "ardour/dB.h"
-#include "option_editor.h"
+#include "ardour/rc_configuration.h"
+#include "ardour/session.h"
+#include "ardour/types.h"
+#include "ardour/utils.h"
+
+#include "pbd/configuration.h"
+#include "pbd/replace_all.h"
+#include "pbd/strsplit.h"
+
 #include "gui_thread.h"
+#include "option_editor.h"
+#include "public_editor.h"
 #include "utils.h"
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace Gtk;
@@ -37,25 +47,54 @@ void
 OptionEditorComponent::add_widget_to_page (OptionEditorPage* p, Gtk::Widget* w)
 {
        int const n = p->table.property_n_rows();
-       p->table.resize (n + 1, 3);
+       int m = n + 1;
+       if (!_note.empty ()) {
+               ++m;
+       }
+
+       p->table.resize (m, 3);
        p->table.attach (*w, 1, 3, n, n + 1, FILL | EXPAND);
+
+       maybe_add_note (p, n + 1);
 }
 
 void
 OptionEditorComponent::add_widgets_to_page (OptionEditorPage* p, Gtk::Widget* wa, Gtk::Widget* wb)
 {
        int const n = p->table.property_n_rows();
-       p->table.resize (n + 1, 3);
+       int m = n + 1;
+       if (!_note.empty ()) {
+               ++m;
+       }
+
+       p->table.resize (m, 3);
        p->table.attach (*wa, 1, 2, n, n + 1, FILL);
        p->table.attach (*wb, 2, 3, n, n + 1, FILL | EXPAND);
+
+       maybe_add_note (p, n + 1);
+}
+
+void
+OptionEditorComponent::maybe_add_note (OptionEditorPage* p, int n)
+{
+       if (!_note.empty ()) {
+               Gtk::Label* l = manage (new Gtk::Label (string_compose (X_("<i>%1</i>"), _note)));
+               l->set_use_markup (true);
+               p->table.attach (*l, 1, 3, n, n + 1, FILL | EXPAND);
+       }
+}
+
+void
+OptionEditorComponent::set_note (string const & n)
+{
+       _note = n;
 }
 
 OptionEditorHeading::OptionEditorHeading (string const & h)
 {
        std::stringstream s;
        s << "<b>" << h << "</b>";
-       _label = manage (new Label (s.str()));
-       _label->set_alignment (0, 0.5);
+       _label = manage (left_aligned_label (s.str()));
        _label->set_use_markup (true);
 }
 
@@ -75,12 +114,79 @@ OptionEditorBox::add_to_page (OptionEditorPage* p)
        add_widget_to_page (p, _box);
 }
 
+RcActionButton::RcActionButton (std::string const & t, const Glib::SignalProxy0< void >::SlotType & slot, std::string const & l)
+       : _label (NULL)
+{
+       _button = manage (new Button (t));
+       _button->signal_clicked().connect (slot);
+       if (!l.empty ()) {
+               _label = manage (right_aligned_label (l));
+       }
+}
+
+void
+RcActionButton::add_to_page (OptionEditorPage *p)
+{
+       int const n = p->table.property_n_rows();
+       int m = n + 1;
+       p->table.resize (m, 3);
+       if (_label) {
+               p->table.attach (*_label,  1, 2, n, n + 1, FILL | EXPAND);
+               p->table.attach (*_button, 2, 3, n, n + 1, FILL | EXPAND);
+       } else {
+               p->table.attach (*_button, 1, 3, n, n + 1, FILL | EXPAND);
+       }
+}
+
+RcConfigDisplay::RcConfigDisplay (string const & i, string const & n, sigc::slot<string> g, char s)
+       : _get (g)
+       , _id (i)
+       , _sep (s)
+{
+       _label = manage (right_aligned_label (n));
+       _info = manage (new Label);
+       _info-> set_line_wrap (true);
+       set_state_from_config ();
+}
+
+void
+RcConfigDisplay::set_state_from_config ()
+{
+       string p = _get();
+       if (_sep) {
+               std::replace (p.begin(), p.end(), _sep, '\n');
+       }
+       _info->set_text (p);
+}
+
+void
+RcConfigDisplay::parameter_changed (std::string const & p)
+{
+       if (p == _id) {
+               set_state_from_config ();
+       }
+}
+
+void
+RcConfigDisplay::add_to_page (OptionEditorPage *p)
+{
+       int const n = p->table.property_n_rows();
+       int m = n + 1;
+       p->table.resize (m, 3);
+       p->table.attach (*_label, 1, 2, n, n + 1, FILL | EXPAND);
+       p->table.attach (*_info,  2, 3, n, n + 1, FILL | EXPAND);
+}
+
+
 BoolOption::BoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
        : Option (i, n),
          _get (g),
          _set (s)
 {
-       _button = manage (new CheckButton (n));
+       _button = manage (new CheckButton);
+       _label = manage (new Label);
+       _label->set_markup (n);
+       _button->add (*_label);
        _button->set_active (_get ());
        _button->signal_toggled().connect (sigc::mem_fun (*this, &BoolOption::toggled));
 }
@@ -100,7 +206,21 @@ BoolOption::set_state_from_config ()
 void
 BoolOption::toggled ()
 {
-       _set (_button->get_active ());
+       if (!_set (_button->get_active ())) {
+               _button->set_active (_get ());
+       }
+}
+
+RouteDisplayBoolOption::RouteDisplayBoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
+       : BoolOption (i, n, g, s)
+{
+}
+
+void
+RouteDisplayBoolOption::toggled ()
+{
+       DisplaySuspender ds;
+       BoolOption::toggled ();
 }
 
 EntryOption::EntryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
@@ -108,10 +228,11 @@ EntryOption::EntryOption (string const & i, string const & n, sigc::slot<string>
          _get (g),
          _set (s)
 {
-       _label = manage (new Label (n + ":"));
-       _label->set_alignment (1, 0.5);
+       _label = manage (left_aligned_label (n + ":"));
        _entry = manage (new Entry);
        _entry->signal_activate().connect (sigc::mem_fun (*this, &EntryOption::activated));
+       _entry->signal_focus_out_event().connect (sigc::mem_fun (*this, &EntryOption::focus_out));
+       _entry->signal_insert_text().connect (sigc::mem_fun (*this, &EntryOption::filter_text));
 }
 
 void
@@ -126,47 +247,123 @@ EntryOption::set_state_from_config ()
        _entry->set_text (_get ());
 }
 
+void
+EntryOption::set_sensitive (bool s)
+{
+       _entry->set_sensitive (s);
+}
+
+void
+EntryOption::filter_text (const Glib::ustring&, int*)
+{
+       std::string text = _entry->get_text ();
+       for (size_t i = 0; i < _invalid.length(); ++i) {
+               text.erase (std::remove(text.begin(), text.end(), _invalid.at(i)), text.end());
+       }
+       if (text != _entry->get_text ()) {
+               _entry->set_text (text);
+       }
+}
+
 void
 EntryOption::activated ()
 {
        _set (_entry->get_text ());
 }
 
-FaderOption::FaderOption (string const & i, string const & n, sigc::slot<gain_t> g, sigc::slot<bool, gain_t> s)
+bool
+EntryOption::focus_out (GdkEventFocus*)
+{
+       _set (_entry->get_text ());
+       return true;
+}
+
+/** Construct a BoolComboOption.
+ *  @param i id
+ *  @param n User-visible name.
+ *  @param t Text to give for the variable being true.
+ *  @param f Text to give for the variable being false.
+ *  @param g Slot to get the variable's value.
+ *  @param s Slot to set the variable's value.
+ */
+BoolComboOption::BoolComboOption (
+       string const & i, string const & n, string const & t, string const & f,
+       sigc::slot<bool> g, sigc::slot<bool, bool> s
+       )
        : Option (i, n)
-       // 0.781787 is the value needed for gain to be set to 0.
-       , _db_adjustment (0.781787, 0, 1, 0.01, 0.1)
        , _get (g)
        , _set (s)
 {
-       _pix = ::get_icon (X_("fader_belt_h"));
-       if (_pix == 0) {
-               throw failed_constructor ();
-       }
+       _label = manage (new Label (n + ":"));
+       _label->set_alignment (0, 0.5);
+       _combo = manage (new ComboBoxText);
 
-       _db_slider = manage (new HSliderController (_pix,
-                                                   &_db_adjustment,
-                                                   115,
-                                                   false));
+       /* option 0 is the false option */
+       _combo->append_text (f);
+       /* and option 1 is the true */
+       _combo->append_text (t);
+
+       _combo->signal_changed().connect (sigc::mem_fun (*this, &BoolComboOption::changed));
+}
+
+void
+BoolComboOption::set_state_from_config ()
+{
+       _combo->set_active (_get() ? 1 : 0);
+}
+
+void
+BoolComboOption::add_to_page (OptionEditorPage* p)
+{
+       add_widgets_to_page (p, _label, _combo);
+}
+
+void
+BoolComboOption::changed ()
+{
+       _set (_combo->get_active_row_number () == 0 ? false : true);
+}
+
+void
+BoolComboOption::set_sensitive (bool yn)
+{
+       _combo->set_sensitive (yn);
+}
+
+
+
+FaderOption::FaderOption (string const & i, string const & n, sigc::slot<gain_t> g, sigc::slot<bool, gain_t> s)
+       : Option (i, n)
+       , _db_adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
+       , _get (g)
+       , _set (s)
+{
+       _db_slider = manage (new HSliderController (&_db_adjustment, boost::shared_ptr<PBD::Controllable>(), 115, 18));
 
        _label.set_text (n + ":");
+       _label.set_alignment (0, 0.5);
        _label.set_name (X_("OptionsLabel"));
 
+       _fader_centering_box.pack_start (*_db_slider, true, false);
+
        _box.set_spacing (4);
-       _box.pack_start (*_db_slider, false, false);
+       _box.set_homogeneous (false);
+       _box.pack_start (_fader_centering_box, false, false);
        _box.pack_start (_db_display, false, false);
        _box.show_all ();
-       
-       set_size_request_to_display_given_text (_db_display, "-99.0", 12, 12);
+
+       set_size_request_to_display_given_text (_db_display, "-99.00", 12, 12);
 
        _db_adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &FaderOption::db_changed));
+       _db_display.signal_activate().connect (sigc::mem_fun (*this, &FaderOption::on_activate));
+       _db_display.signal_key_press_event().connect (sigc::mem_fun (*this, &FaderOption::on_key_press), false);
 }
 
 void
 FaderOption::set_state_from_config ()
 {
        gain_t const val = _get ();
-       _db_adjustment.set_value (gain_to_slider_position (val));
+       _db_adjustment.set_value (gain_to_slider_position_with_max (val, Config->get_max_gain ()));
 
        char buf[16];
 
@@ -175,14 +372,34 @@ FaderOption::set_state_from_config ()
        } else {
                snprintf (buf, sizeof (buf), "%.2f", accurate_coefficient_to_dB (val));
        }
-       
+
        _db_display.set_text (buf);
 }
 
 void
 FaderOption::db_changed ()
 {
-       _set (slider_position_to_gain (_db_adjustment.get_value ()));
+       _set (slider_position_to_gain_with_max (_db_adjustment.get_value (), Config->get_max_gain()));
+}
+
+void
+FaderOption::on_activate ()
+{
+       float db_val = atof (_db_display.get_text ().c_str ());
+       gain_t coeff_val = dB_to_coefficient (db_val);
+
+       _db_adjustment.set_value (gain_to_slider_position_with_max (coeff_val, Config->get_max_gain ()));
+}
+
+bool
+FaderOption::on_key_press (GdkEventKey* ev)
+{
+       if (ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (ev->keyval)) {
+               /* drop through to normal handling */
+               return false;
+       }
+       /* illegal key for gain entry */
+       return true;
 }
 
 void
@@ -191,6 +408,54 @@ FaderOption::add_to_page (OptionEditorPage* p)
        add_widgets_to_page (p, &_label, &_box);
 }
 
+ClockOption::ClockOption (string const & i, string const & n, sigc::slot<std::string> g, sigc::slot<bool, std::string> s)
+       : Option (i, n)
+       , _clock (X_("timecode-offset"), true, X_(""), true, false, true, false)
+       , _get (g)
+       , _set (s)
+{
+       _label.set_text (n + ":");
+       _label.set_alignment (0, 0.5);
+       _label.set_name (X_("OptionsLabel"));
+       _clock.ValueChanged.connect (sigc::mem_fun (*this, &ClockOption::save_clock_time));
+}
+
+void
+ClockOption::set_state_from_config ()
+{
+       Timecode::Time TC;
+       framepos_t when;
+       if (!Timecode::parse_timecode_format(_get(), TC)) {
+               _clock.set (0, true);
+       }
+       TC.rate = _session->frames_per_timecode_frame();
+       TC.drop = _session->timecode_drop_frames();
+       _session->timecode_to_sample(TC, when, false, false);
+       if (TC.negative) { when=-when; }
+       _clock.set (when, true);
+}
+
+void
+ClockOption::save_clock_time ()
+{
+       Timecode::Time TC;
+       _session->sample_to_timecode(_clock.current_time(), TC, false, false);
+       _set (Timecode::timecode_format_time(TC));
+}
+
+void
+ClockOption::add_to_page (OptionEditorPage* p)
+{
+       add_widgets_to_page (p, &_label, &_clock);
+}
+
+void
+ClockOption::set_session (Session* s)
+{
+       _session = s;
+       _clock.set_session (s);
+}
+
 OptionEditorPage::OptionEditorPage (Gtk::Notebook& n, std::string const & t)
        : table (1, 3)
 {
@@ -205,30 +470,28 @@ OptionEditorPage::OptionEditorPage (Gtk::Notebook& n, std::string const & t)
  *  @param o Configuration to edit.
  *  @param t Title for the dialog.
  */
-OptionEditor::OptionEditor (Configuration* c, std::string const & t)
-       : ArdourDialog (t, false), _config (c)
+OptionEditor::OptionEditor (PBD::Configuration* c)
+       : _config (c)
+       , option_tree (TreeStore::create (option_columns))
+       , option_treeview (option_tree)
 {
        using namespace Notebook_Helpers;
 
-       set_default_size (300, 300);
-       set_wmclass (X_("ardour_preferences"), "Ardour");
-
-       set_name ("Preferences");
-       add_events (Gdk::KEY_PRESS_MASK | Gdk::KEY_RELEASE_MASK);
-
-       set_border_width (4);
-
-       get_vbox()->set_spacing (4);
-       get_vbox()->pack_start (_notebook);
-
-       _notebook.set_show_tabs (true);
+       _notebook.set_show_tabs (false);
        _notebook.set_show_border (true);
        _notebook.set_name ("OptionsNotebook");
 
-       show_all_children();
+       option_treeview.append_column ("", option_columns.name);
+       option_treeview.set_enable_search(true);
+       option_treeview.set_search_column(0);
+       option_treeview.set_name ("OptionsTreeView");
+       option_treeview.set_headers_visible (false);
+
+       option_treeview.get_selection()->set_mode (Gtk::SELECTION_SINGLE);
+       option_treeview.get_selection()->signal_changed().connect (sigc::mem_fun (*this, &OptionEditor::treeview_row_selected));
 
        /* Watch out for changes to parameters */
-       _config->ParameterChanged.connect (config_connection, invalidator (*this), ui_bind (&OptionEditor::parameter_changed, this, _1), gui_context());
+       _config->ParameterChanged.connect (config_connection, invalidator (*this), boost::bind (&OptionEditor::parameter_changed, this, _1), gui_context());
 }
 
 OptionEditor::~OptionEditor ()
@@ -256,6 +519,118 @@ OptionEditor::parameter_changed (std::string const & p)
        }
 }
 
+void
+OptionEditor::treeview_row_selected ()
+{
+       Glib::RefPtr<Gtk::TreeSelection> selection = option_treeview.get_selection();
+       TreeModel::iterator iter = selection->get_selected();
+       if(iter) {
+               TreeModel::Row row = *iter;
+               Gtk::Widget* w = row[option_columns.widget];
+               if (w) {
+                       _notebook.set_current_page (_notebook.page_num (*w));
+               }
+       }
+}
+
+void
+OptionEditor::add_path_to_treeview (std::string const & pn, Gtk::Widget& widget)
+{
+       option_treeview.set_model (Glib::RefPtr<TreeStore>());
+
+       if (pn.find ('/') == std::string::npos) {
+               /* new top level item in tree */
+
+               TreeModel::iterator new_row = option_tree->append ();
+               TreeModel::Row row = *new_row;
+               row[option_columns.name] = pn;
+               row[option_columns.widget] = &widget;
+
+       } else {
+
+               /* find parent */
+
+               /* split page name, which is actually a path, into each
+                * component
+                */
+
+               std::vector<std::string> components;
+               split (pn, components, '/');
+
+               /* start with top level children */
+
+               typedef Gtk::TreeModel::Children type_children; //minimise code length.
+               type_children children = option_tree->children();
+
+               /* foreach path component ... */
+
+               for (std::vector<std::string>::const_iterator s = components.begin(); s != components.end(); ) {
+
+                       bool component_found = false;
+
+                       type_children::iterator iter;
+
+                       /* look through the children at this level */
+
+                       for (iter = children.begin(); iter != children.end(); ++iter) {
+                               Gtk::TreeModel::Row row = *iter;
+
+                               std::string row_name = row[option_columns.name];
+                               if (row_name == (*s)) {
+
+                                       /* found it */
+
+                                       component_found = true;
+
+                                       /* reset children to point to
+                                        * the children of this row
+                                        */
+
+                                       children = row.children();
+                                       break;
+                               }
+                       }
+
+                       if (!component_found) {
+
+                               /* missing component. If it is the last
+                                * one, append a real page. Otherwise
+                                * just put an entry in the tree model
+                                * since it is a navigational/sorting
+                                * component.
+                                */
+
+                               TreeModel::iterator new_row = option_tree->append (children);
+                               TreeModel::Row row = *new_row;
+                               row[option_columns.name] = *s;
+
+                               ++s;
+
+                               if (s == components.end()) {
+                                       row[option_columns.widget] = &widget;
+                               } else {
+                                       row[option_columns.widget] = 0;
+                               }
+
+                               children = row.children ();
+
+                       } else {
+
+                               /* component found, just move on to the
+                                * next one. children has already been
+                                * reset appropriately.
+                                */
+
+                               ++s;
+                       }
+               }
+
+       }
+
+       option_treeview.set_model (option_tree);
+       option_treeview.expand_all ();
+}
+
 /** Add a component to a given page.
  *  @param pn Page name (will be created if it doesn't already exist)
  *  @param o Component.
@@ -264,10 +639,11 @@ void
 OptionEditor::add_option (std::string const & pn, OptionEditorComponent* o)
 {
        if (_pages.find (pn) == _pages.end()) {
-               _pages[pn] = new OptionEditorPage (_notebook, pn);
-       }
+               OptionEditorPage* oep = new OptionEditorPage (_notebook, pn);
+               _pages[pn] = oep;
 
-       cout << "add thing to " << pn << "\n";
+               add_path_to_treeview (pn, oep->box);
+       }
 
        OptionEditorPage* p = _pages[pn];
        p->components.push_back (o);
@@ -275,3 +651,96 @@ OptionEditor::add_option (std::string const & pn, OptionEditorComponent* o)
        o->add_to_page (p);
        o->set_state_from_config ();
 }
+
+/** Add a new page
+ *  @param pn Page name (will be created if it doesn't already exist)
+ *  @param w widget that fills the page
+ */
+void
+OptionEditor::add_page (std::string const & pn, Gtk::Widget& w)
+{
+       if (_pages.find (pn) == _pages.end()) {
+               OptionEditorPage* oep = new OptionEditorPage (_notebook, pn);
+               _pages[pn] = oep;
+               add_path_to_treeview (pn, oep->box);
+       }
+
+       OptionEditorPage* p = _pages[pn];
+       p->box.pack_start (w, true, true);
+}
+
+void
+OptionEditor::set_current_page (string const & p)
+{
+       int i = 0;
+       while (i < _notebook.get_n_pages ()) {
+               if (_notebook.get_tab_label_text (*_notebook.get_nth_page (i)) == p) {
+                       _notebook.set_current_page (i);
+                       return;
+               }
+
+               ++i;
+       }
+}
+
+
+DirectoryOption::DirectoryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
+       : Option (i, n)
+       , _get (g)
+       , _set (s)
+{
+       _file_chooser.set_action (Gtk::FILE_CHOOSER_ACTION_SELECT_FOLDER);
+       _file_chooser.signal_selection_changed().connect (sigc::mem_fun (*this, &DirectoryOption::selection_changed));
+}
+
+
+void
+DirectoryOption::set_state_from_config ()
+{
+       _file_chooser.set_current_folder (poor_mans_glob(_get ()));
+}
+
+void
+DirectoryOption::add_to_page (OptionEditorPage* p)
+{
+       Gtk::Label *label = manage (new Label (_name));
+       label->set_alignment (0, 0.5);
+       label->set_name (X_("OptionsLabel"));
+       add_widgets_to_page (p, label, &_file_chooser);
+}
+
+void
+DirectoryOption::selection_changed ()
+{
+       _set (poor_mans_glob(_file_chooser.get_filename ()));
+}
+
+/*--------------------------*/
+
+OptionEditorContainer::OptionEditorContainer (PBD::Configuration* c, string const& str)
+       : OptionEditor (c)
+{
+       set_border_width (4);
+       hpacker.pack_start (treeview(), false, false);
+       hpacker.pack_start (notebook(), true, true);
+       pack_start (hpacker, true, true);
+
+       hpacker.show_all ();
+       show ();
+}
+
+OptionEditorWindow::OptionEditorWindow (PBD::Configuration* c, string const& str)
+       : OptionEditor (c)
+       , ArdourWindow (str)
+{
+       container.set_border_width (4);
+       hpacker.pack_start (treeview(), false, false);
+       hpacker.pack_start (notebook(), true, true);
+
+       container.pack_start (hpacker, true, true);
+
+       hpacker.show_all ();
+       container.show ();
+
+       add (container);
+}