Implements filtering in bindings editor

4 files changed, 223 insertions, 55 deletions

diff --git a/gtk2_ardour/icons/search.png b/gtk2_ardour/icons/search.png
new file mode 100644
index 0000000000..0a0db84485
--- /dev/null
+++ b/gtk2_ardour/icons/search.png
diff --git a/gtk2_ardour/icons/search.svg b/gtk2_ardour/icons/search.svg
new file mode 100644
index 0000000000..2b8856896c
--- /dev/null
+++ b/gtk2_ardour/icons/search.svg
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   version="1.1"
+   width="16"
+   height="16"
+   id="svg2"
+   inkscape:version="0.91 r13725"
+   sodipodi:docname="search.svg"
+   inkscape:export-filename="/home/buhr/projects/ardour/gtk2_ardour/icons/search.png"
+   inkscape:export-xdpi="135.31609"
+   inkscape:export-ydpi="135.31609">
+  <sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="2560"
+     inkscape:window-height="1390"
+     id="namedview4941"
+     showgrid="false"
+     inkscape:zoom="36.75"
+     inkscape:cx="20.233694"
+     inkscape:cy="2.6993399"
+     inkscape:window-x="0"
+     inkscape:window-y="25"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg2" />
+  <defs
+     id="defs4">
+    <linearGradient
+       id="linearGradient4757">
+      <stop
+         id="stop4759"
+         style="stop-color:#ffffff;stop-opacity:1"
+         offset="0" />
+      <stop
+         id="stop4761"
+         style="stop-color:#c1c1c1;stop-opacity:1"
+         offset="1" />
+    </linearGradient>
+    <radialGradient
+       cx="4.1535583"
+       cy="4.6999545"
+       r="4.5"
+       fx="4.1535583"
+       fy="4.6999545"
+       id="radialGradient4763"
+       xlink:href="#linearGradient4757"
+       gradientUnits="userSpaceOnUse"
+       gradientTransform="matrix(0.99954653,1.0095465,-0.64253295,0.64896107,3.1580713,-3.0083174)" />
+  </defs>
+  <metadata
+     id="metadata7">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <path
+     style="fill:none;stroke:#5a5a5a;stroke-width:2.5;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
+     d="M 14.7,14.7 10,10"
+     id="path4781"
+     inkscape:connector-curvature="0"
+     sodipodi:nodetypes="cc" />
+  <g
+     transform="translate(0,-1036.3622)"
+     id="layer1"
+     style="stroke:#5a5a5a;stroke-opacity:1">
+    <path
+       d="m 11,6.5 a 4.5,4.5 0 1 1 -9,0 4.5,4.5 0 1 1 9,0 z"
+       transform="matrix(1.2222222,0,0,1.2222222,-1.9444445,1034.4178)"
+       id="path3987"
+       style="fill:url(#radialGradient4763);fill-opacity:1;stroke:#5a5a5a;stroke-width:0.81818181;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" />
+  </g>
+</svg>
diff --git a/gtk2_ardour/keyeditor.cc b/gtk2_ardour/keyeditor.cc
index 28005a0401..d7a92bd630 100644
--- a/gtk2_ardour/keyeditor.cc
+++ b/gtk2_ardour/keyeditor.cc
@@ -23,6 +23,8 @@
 
 #include <map>
 
+#include <boost/algorithm/string.hpp>
+
 #include <gtkmm/stock.h>
 #include <gtkmm/label.h>
 #include <gtkmm/accelkey.h>
@@ -66,15 +68,21 @@ KeyEditor::KeyEditor ()
 	: ArdourWindow (_("Key Bindings"))
 	, unbind_button (_("Remove shortcut"))
 	, unbind_box (BUTTONBOX_END)
+	, filter_entry (_("Search..."))
+	, filter_string("")
 	, sort_column(0)
 	, sort_type(Gtk::SORT_ASCENDING)
 {
-	last_keyval = 0;
 
 	notebook.signal_switch_page ().connect (sigc::mem_fun (*this, &KeyEditor::page_change));
 
 	vpacker.pack_start (notebook, true, true);
 
+	Glib::RefPtr<Gdk::Pixbuf> icon = ARDOUR_UI_UTILS::get_icon ("search");
+	filter_entry.set_icon_from_pixbuf (icon);
+	filter_entry.signal_search_string_updated ().connect (sigc::mem_fun (*this, &KeyEditor::search_string_updated));
+	vpacker.pack_start (filter_entry, false, false);
+
 	Label* hint = manage (new Label (_("Select an action, then press the key(s) to (re)set its shortcut")));
 	hint->show ();
 	unbind_box.set_spacing (6);
@@ -124,7 +132,7 @@ KeyEditor::page_change (GtkNotebookPage*, guint)
 }
 
 bool
-KeyEditor::on_key_press_event (GdkEventKey* ev)
+KeyEditor::Tab::on_key_press_event (GdkEventKey* ev)
 {
 	if (!ev->is_modifier) {
 		last_keyval = ev->keyval;
@@ -139,13 +147,13 @@ KeyEditor::on_key_press_event (GdkEventKey* ev)
 }
 
 bool
-KeyEditor::on_key_release_event (GdkEventKey* ev)
+KeyEditor::Tab::on_key_release_event (GdkEventKey* ev)
 {
 	if (last_keyval == 0) {
 		return false;
 	}
 
-	current_tab()->bind (ev, last_keyval);
+	owner.current_tab()->bind (ev, last_keyval);
 
 	last_keyval = 0;
 	return true;
@@ -155,10 +163,17 @@ KeyEditor::Tab::Tab (KeyEditor& ke, string const & str, Bindings* b)
 	: owner (ke)
 	, name (str)
 	, bindings (b)
+	, last_keyval (0)
 {
-	model = TreeStore::create(columns);
+	data_model = TreeStore::create(columns);
+	populate ();
+	
+	filter = TreeModelFilter::create(data_model);
+	filter->set_visible_func (sigc::mem_fun (*this, &Tab::visible_func));
+
+	sorted_filter = TreeModelSort::create(filter);
 
-	view.set_model (model);
+	view.set_model (sorted_filter);
 	view.append_column (_("Action"), columns.name);
 	view.append_column (_("Shortcut"), columns.binding);
 	view.set_headers_visible (true);
@@ -170,12 +185,12 @@ KeyEditor::Tab::Tab (KeyEditor& ke, string const & str, Bindings* b)
 	view.set_rules_hint (true);
 	view.set_name (X_("KeyEditorTree"));
 
-	view.get_selection()->signal_changed().connect (sigc::mem_fun (*this, &Tab::action_selected));
+	view.signal_cursor_changed().connect (sigc::mem_fun (*this, &Tab::action_selected));
 
 	view.get_column(0)->set_sort_column (columns.name);
 	view.get_column(1)->set_sort_column (columns.binding);
-	model->set_sort_column (owner.sort_column,  owner.sort_type);
-	model->signal_sort_column_changed().connect (sigc::mem_fun (*this, &Tab::sort_column_changed));
+	data_model->set_sort_column (owner.sort_column,  owner.sort_type);
+	data_model->signal_sort_column_changed().connect (sigc::mem_fun (*this, &Tab::sort_column_changed));
 
 	signal_map().connect (sigc::mem_fun (*this, &Tab::tab_mapped));
 
@@ -194,49 +209,46 @@ KeyEditor::Tab::action_selected ()
 		return;
 	}
 
-	TreeModel::iterator i = view.get_selection()->get_selected();
-
-	owner.unbind_button.set_sensitive (false);
-
-	if (i != model->children().end()) {
+	TreeModel::const_iterator it = view.get_selection()->get_selected();
 
-		string path = (*i)[columns.path];
+	if (!it) {
+		return;
+	}
 
-		if (!(*i)[columns.bindable]) {
-			return;
-		}
+	if (!(*it)[columns.bindable]) {
+		owner.unbind_button.set_sensitive (false);
+		return;
+	}
 
-		string binding = (*i)[columns.binding];
+	const string& binding = (*it)[columns.binding];
 
-		if (!binding.empty()) {
-			owner.unbind_button.set_sensitive (true);
-		}
+	if (!binding.empty()) {
+		owner.unbind_button.set_sensitive (true);
 	}
 }
 
 void
 KeyEditor::Tab::unbind ()
 {
-	TreeModel::iterator i = view.get_selection()->get_selected();
+	const std::string& action_path = (*view.get_selection()->get_selected())[columns.path];
 
-	owner.unbind_button.set_sensitive (false);
+	TreeModel::iterator it = find_action_path (data_model->children().begin(), data_model->children().end(),  action_path);
 
-	if (i != model->children().end()) {
-		if (!(*i)[columns.bindable]) {
-			return;
-		}
+	if (!it || !(*it)[columns.bindable]) {
+		return;
+	}
 
-		const std::string& action_path = (*i)[columns.path];
+	bindings->remove (Gtkmm2ext::Bindings::Press,  action_path , true);
+	(*it)[columns.binding] = string ();
 
-		bindings->remove (Gtkmm2ext::Bindings::Press,  action_path , true);
-		(*i)[columns.binding] = string ();
-	}
+	owner.unbind_button.set_sensitive (false);
 }
 
 void
 KeyEditor::Tab::bind (GdkEventKey* release_event, guint pressed_key)
 {
-	TreeModel::iterator i = view.get_selection()->get_selected();
+	const std::string& action_path = (*view.get_selection()->get_selected())[columns.path];
+	TreeModel::iterator it = find_action_path (data_model->children().begin(), data_model->children().end(),  action_path);
 
 	/* pressed key could be upper case if Shift was used. We want all
 	   single keys stored as their lower-case version, so ensure this
@@ -244,13 +256,7 @@ KeyEditor::Tab::bind (GdkEventKey* release_event, guint pressed_key)
 
 	pressed_key = gdk_keyval_to_lower (pressed_key);
 
-	if (i == model->children().end()) {
-		return;
-	}
-
-	string action_path = (*i)[columns.path];
-
-	if (!(*i)[columns.bindable]) {
+	if (!it || !(*it)[columns.bindable]) {
 		return;
 	}
 
@@ -265,7 +271,7 @@ KeyEditor::Tab::bind (GdkEventKey* release_event, guint pressed_key)
 	bool result = bindings->replace (new_binding, Gtkmm2ext::Bindings::Press, action_path);
 
 	if (result) {
-		(*i)[columns.binding] = gtk_accelerator_get_label (new_binding.key(), (GdkModifierType) new_binding.state());
+		(*it)[columns.binding] = gtk_accelerator_get_label (new_binding.key(), (GdkModifierType) new_binding.state());
 		owner.unbind_button.set_sensitive (true);
 	}
 }
@@ -290,7 +296,7 @@ KeyEditor::Tab::populate ()
 	vector<string>::iterator l;
 	vector<Glib::RefPtr<Action> >::iterator a;
 
-	model->clear ();
+	data_model->clear ();
 
 	for (a = actions.begin(), l = labels.begin(), k = keys.begin(), p = paths.begin(), t = tooltips.begin(); l != labels.end(); ++k, ++p, ++t, ++l, ++a) {
 
@@ -319,7 +325,7 @@ KeyEditor::Tab::populate ()
 
 			TreeIter rowp;
 			TreeModel::Row parent;
-			rowp = model->append();
+			rowp = data_model->append();
 			nodes[category] = rowp;
 			parent = *(rowp);
 			parent[columns.name] = category;
@@ -330,13 +336,13 @@ KeyEditor::Tab::populate ()
 			 * out with information
 			 */
 
-			row = *(model->append (parent.children()));
+			row = *(data_model->append (parent.children()));
 
 		} else {
 
 			/* category/group is present, so just add the child row */
 
-			row = *(model->append ((*r->second)->children()));
+			row = *(data_model->append ((*r->second)->children()));
 
 		}
 
@@ -367,7 +373,7 @@ KeyEditor::Tab::sort_column_changed ()
 {
 	int column;
 	SortType type;
-	if (model->get_sort_column_id (column, type)) {
+	if (data_model->get_sort_column_id (column, type)) {
 		owner.sort_column = column;
 		owner.sort_type = type;
 	}
@@ -376,7 +382,59 @@ KeyEditor::Tab::sort_column_changed ()
 void
 KeyEditor::Tab::tab_mapped ()
 {
-	model->set_sort_column (owner.sort_column,  owner.sort_type);
+	data_model->set_sort_column (owner.sort_column,  owner.sort_type);
+	filter->refilter ();
+}
+
+bool
+KeyEditor::Tab::visible_func(const Gtk::TreeModel::const_iterator& iter) const
+{
+	if (!iter) {
+		return false;
+	}
+
+	// never filter when search string is empty or item is a category
+	if (owner.filter_string.empty () || !(*iter)[columns.bindable]) {
+		return true;
+	}
+
+	// search name
+	std::string name = (*iter)[columns.name];
+	boost::to_lower (name);
+	if (name.find (owner.filter_string) != std::string::npos) {
+		return true;
+	}
+
+	// search binding
+	std::string binding = (*iter)[columns.binding];
+	boost::to_lower (binding);
+	if (binding.find (owner.filter_string) != std::string::npos) {
+		return true;
+	}
+
+	return false;
+}
+
+TreeModel::iterator
+KeyEditor::Tab::find_action_path (TreeModel::const_iterator begin, TreeModel::const_iterator end, const std::string& action_path) const
+{
+	if (!begin) {
+		return end;
+	}
+
+	for (TreeModel::iterator it = begin; it != end; ++it) {
+		if (it->children()) {
+			TreeModel::iterator jt = find_action_path (it->children().begin(), it->children().end(), action_path);
+			if (jt != it->children().end()) {
+				return jt;
+			}
+		}
+		const std::string& path = (*it)[columns.path];
+		if (action_path.compare(path) == 0) {
+			return it;
+		}
+	}
+	return end;
 }
 
 void
@@ -395,3 +453,11 @@ KeyEditor::current_tab ()
 {
 	return dynamic_cast<Tab*> (notebook.get_nth_page (notebook.get_current_page()));
 }
+
+void
+KeyEditor::search_string_updated (const std::string& filter)
+{
+	filter_string = boost::to_lower_copy(filter);
+	current_tab ()->filter->refilter ();
+}
+
diff --git a/gtk2_ardour/keyeditor.h b/gtk2_ardour/keyeditor.h
index b04b973009..1c90269875 100644
--- a/gtk2_ardour/keyeditor.h
+++ b/gtk2_ardour/keyeditor.h
@@ -27,6 +27,7 @@
 #include <gtkmm/scrolledwindow.h>
 #include <gtkmm/treeview.h>
 #include <gtkmm/treestore.h>
+#include "gtkmm2ext/searchbar.h"
 
 #include "ardour_window.h"
 
@@ -41,14 +42,10 @@ class KeyEditor : public ArdourWindow
 
 	void add_tab (std::string const &name, Gtkmm2ext::Bindings&);
 
-  protected:
-	bool on_key_press_event (GdkEventKey*);
-	bool on_key_release_event (GdkEventKey*);
-
-  private:
+	private:
 	class Tab : public Gtk::VBox
 	{
- 	   public:
+		public:
 		Tab (KeyEditor&, std::string const &name, Gtkmm2ext::Bindings*);
 
 		void populate ();
@@ -57,6 +54,7 @@ class KeyEditor : public ArdourWindow
 		void action_selected ();
 		void sort_column_changed ();
 		void tab_mapped ();
+		bool visible_func(const Gtk::TreeModel::const_iterator& iter) const;
 
 		struct KeyEditorColumns : public Gtk::TreeModel::ColumnRecord {
 			KeyEditorColumns () {
@@ -83,8 +81,16 @@ class KeyEditor : public ArdourWindow
 		Gtkmm2ext::Bindings* bindings;
 		Gtk::ScrolledWindow scroller;
 		Gtk::TreeView view;
-		Glib::RefPtr<Gtk::TreeStore> model;
+		Glib::RefPtr<Gtk::TreeStore> data_model;
+		Glib::RefPtr<Gtk::TreeModelFilter> filter;
+		Glib::RefPtr<Gtk::TreeModelSort> sorted_filter;
 		KeyEditorColumns columns;
+		guint last_keyval;
+
+		protected:
+		bool on_key_press_event (GdkEventKey*);
+		bool on_key_release_event (GdkEventKey*);
+		Gtk::TreeModel::iterator find_action_path (Gtk::TreeModel::const_iterator begin, Gtk::TreeModel::const_iterator end, const std::string& path) const;
 	};
 
 	friend class Tab;
@@ -96,7 +102,8 @@ class KeyEditor : public ArdourWindow
 	Gtk::HBox reset_box;
 	Gtk::Button reset_button;
 	Gtk::Label reset_label;
-	guint last_keyval;
+	Gtkmm2ext::SearchBar filter_entry;
+	std::string filter_string;
 
 	typedef std::vector<Tab*> Tabs;
 
@@ -110,6 +117,7 @@ class KeyEditor : public ArdourWindow
 	unsigned int sort_column;
 	Gtk::SortType sort_type;
 	void toggle_sort_type ();
+	void search_string_updated (const std::string&);
 };
 
 #endif /* __ardour_gtk_key_editor_h__ */