Dialog to select and configure Lua Scripts

gtk2_ardour/script_selector.cc

@@ -0,0 +1,230 @@
+/*
+ * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+#include "gtkmm2ext/utils.h"
+
+#include "script_selector.h"
+#include "i18n.h"
+
+using namespace std;
+using namespace Gtk;
+using namespace ARDOUR;
+
+ScriptSelector::ScriptSelector (std::string title, LuaScriptInfo::ScriptType type)
+	: ArdourDialog (title)
+	, _type ("", Gtk::ALIGN_START, Gtk::ALIGN_CENTER)
+	, _author ("", Gtk::ALIGN_START, Gtk::ALIGN_CENTER)
+	, _description ("", Gtk::ALIGN_START, Gtk::ALIGN_START)
+	, _scripts (LuaScripting::instance ().scripts (type))
+	, _script_type (type)
+{
+	Gtk::Label* l;
+
+	Table* t = manage (new Table (3, 2));
+	t->set_spacings (6);
+
+	int ty = 0;
+
+	l = manage (new Label (_("<b>Type:</b>"), Gtk::ALIGN_END, Gtk::ALIGN_CENTER, false));
+	l->set_use_markup ();
+	t->attach (*l, 0, 1, ty, ty+1);
+	t->attach (_type, 1, 2, ty, ty+1);
+	++ty;
+
+	l = manage (new Label (_("<b>Author:</b>"), Gtk::ALIGN_END, Gtk::ALIGN_CENTER, false));
+	l->set_use_markup ();
+	t->attach (*l, 0, 1, ty, ty+1);
+	t->attach (_author, 1, 2, ty, ty+1);
+	++ty;
+
+	l = manage (new Label (_("<b>Description:</b>"), Gtk::ALIGN_END, Gtk::ALIGN_CENTER, false));
+	l->set_use_markup ();
+	t->attach (*l, 0, 1, ty, ty+1);
+	t->attach (_description, 1, 2, ty, ty+1);
+	++ty;
+
+	_description.set_line_wrap();
+
+	get_vbox()->set_spacing (6);
+	get_vbox()->pack_start (_script_combo, false, false);
+	get_vbox()->pack_start (*t, true, true);
+
+	Button *r = Gtk::manage (new Gtk::Button (Stock::REFRESH));
+	r->signal_clicked().connect (sigc::mem_fun (*this, &ScriptSelector::refresh));
+	get_action_area()->pack_start(*r);
+
+	add_button (Stock::CANCEL, RESPONSE_CANCEL);
+	_add = add_button (Stock::ADD, RESPONSE_ACCEPT);
+	set_default_response (RESPONSE_ACCEPT);
+
+	_add->set_sensitive (false);
+	_combocon = _script_combo.signal_changed().connect (sigc::mem_fun (*this, &ScriptSelector::script_combo_changed));
+
+	setup_list ();
+	show_all ();
+}
+
+void
+ScriptSelector::setup_list ()
+{
+	_combocon.block();
+	vector<string> script_names;
+	for (LuaScriptList::const_iterator s = _scripts.begin(); s != _scripts.end(); ++s) {
+		script_names.push_back ((*s)->name);
+	}
+
+	Gtkmm2ext::set_popdown_strings (_script_combo, script_names);
+	if (script_names.size() > 0) {
+		_script_combo.set_active(0);
+		script_combo_changed ();
+	}
+	_combocon.unblock();
+}
+
+void
+ScriptSelector::script_combo_changed ()
+{
+	int i = _script_combo.get_active_row_number();
+	_script = _scripts[i];
+
+	_type.set_text(LuaScriptInfo::type2str (_script->type));
+	_author.set_text (_script->author);
+	_description.set_text (_script->description);
+
+	_add->set_sensitive (Glib::file_test(_script->path, Glib::FILE_TEST_EXISTS));
+}
+
+void
+ScriptSelector::refresh ()
+{
+	_scripts = LuaScripting::instance ().scripts (_script_type);
+	setup_list ();
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+SessionScriptManager::SessionScriptManager (std::string title, const std::vector<std::string> &names)
+	: ArdourDialog (title)
+{
+	assert (names.size() > 0);
+	Gtkmm2ext::set_popdown_strings (_names_combo, names);
+	_names_combo.set_active(0);
+
+	Gtk::Label* l;
+	l = manage (new Label (_("Select Script to unload")));
+
+	get_vbox()->set_spacing (6);
+	get_vbox()->pack_start (*l, false, false);
+	get_vbox()->pack_start (_names_combo, false, false);
+
+	add_button (Stock::CANCEL, RESPONSE_CANCEL);
+	add_button (Stock::REMOVE, RESPONSE_ACCEPT);
+	set_default_response (RESPONSE_CANCEL);
+
+	show_all ();
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+
+ScriptParameterDialog::ScriptParameterDialog (std::string title,
+		const LuaScriptInfoPtr& spi,
+		const std::vector<std::string> &names,
+		LuaScriptParamList& lsp)
+	: ArdourDialog (title)
+	, _existing_names (names)
+	, _lsp (lsp)
+{
+	Gtk::Label* l;
+
+	Table* t = manage (new Table (4, 3));
+	t->set_spacings (6);
+
+	_name_entry.set_text (spi->name);
+	_name_entry.signal_changed().connect (sigc::mem_fun (*this, &ScriptParameterDialog::update_sensitivity));
+
+	int ty = 0;
+
+	l = manage (new Label (_("<b>Name:</b>"), Gtk::ALIGN_END, Gtk::ALIGN_CENTER, false));
+	l->set_use_markup ();
+	t->attach (*l, 0, 1, ty, ty+1);
+	t->attach (_name_entry, 1, 2, ty, ty+1);
+	++ty;
+
+	l = manage (new Label (_("<b>Parameters:</b>"), Gtk::ALIGN_CENTER, Gtk::ALIGN_CENTER, false));
+	l->set_use_markup ();
+	t->attach (_name_entry, 0, 2, ty, ty+1);
+	++ty;
+
+	for (size_t i = 0; i < _lsp.size (); ++i) {
+		CheckButton* c = manage (new CheckButton (_lsp[i]->title));
+		Entry* e = manage (new Entry());
+		c->set_active (!_lsp[i]->optional); // also if default ??
+		c->set_sensitive (_lsp[i]->optional);
+		e->set_text (_lsp[i]->dflt);
+		e->set_sensitive (c->get_active ());
+
+		c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ScriptParameterDialog::active_changed), i, c, e));
+		e->signal_changed().connect (sigc::bind (sigc::mem_fun (*this, &ScriptParameterDialog::value_changed), i, e));
+
+		t->attach (*c, 0, 1, ty, ty+1);
+		t->attach (*e, 1, 2, ty, ty+1);
+		++ty;
+	}
+
+	add_button (Stock::CANCEL, RESPONSE_CANCEL);
+	_add = add_button (Stock::ADD, RESPONSE_ACCEPT);
+	set_default_response (RESPONSE_ACCEPT);
+
+	get_vbox()->pack_start (*t, true, true);
+	show_all ();
+	update_sensitivity ();
+}
+
+void
+ScriptParameterDialog::update_sensitivity ()
+{
+	std::string n = _name_entry.get_text ();
+	if (n.empty() || std::find (_existing_names.begin(), _existing_names.end(), n) != _existing_names.end()) {
+		_add->set_sensitive (false);
+		return;
+	}
+
+	for (size_t i = 0; i < _lsp.size(); ++i) {
+		if (!_lsp[i]->optional && _lsp[i]->value.empty()) {
+			_add->set_sensitive (false);
+			return;
+		}
+	}
+
+	_add->set_sensitive (true);
+}
+
+void
+ScriptParameterDialog::active_changed (int i, Gtk::CheckButton* c, Gtk::Entry* e)
+{
+	bool en = c->get_active ();
+	_lsp[i]->is_set = en;
+	e->set_sensitive (en);
+}
+
+void
+ScriptParameterDialog::value_changed (int i, Gtk::Entry* e)
+{
+	_lsp[i]->value = e->get_text ();
+}

gtk2_ardour/script_selector.h

@@ -0,0 +1,73 @@
+/*
+ * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+#include <gtkmm.h>
+#include "ardour/luascripting.h"
+
+#include "ardour_dialog.h"
+
+class ScriptSelector : public ArdourDialog
+{
+public:
+	ScriptSelector (std::string title, ARDOUR::LuaScriptInfo::ScriptType t);
+	ARDOUR::LuaScriptInfoPtr script() const { return _script; }
+
+private:
+	void setup_list ();
+	void refresh ();
+	void script_combo_changed ();
+
+	Gtk::Button* _add;
+	Gtk::ComboBoxText _script_combo;
+
+	Gtk::Label  _type;
+	Gtk::Label  _author;
+	Gtk::Label  _description;
+
+	ARDOUR::LuaScriptList & _scripts;
+	ARDOUR::LuaScriptInfoPtr _script;
+	ARDOUR::LuaScriptInfo::ScriptType _script_type;
+	sigc::connection _combocon;
+};
+
+class SessionScriptManager : public ArdourDialog
+{
+public:
+	SessionScriptManager (std::string title, const std::vector<std::string>&);
+	std::string name () { return _names_combo.get_active_text (); }
+
+private:
+	Gtk::ComboBoxText _names_combo;
+};
+
+class ScriptParameterDialog : public ArdourDialog
+{
+public:
+	ScriptParameterDialog (std::string title, const ARDOUR::LuaScriptInfoPtr&, const std::vector<std::string>&, ARDOUR::LuaScriptParamList&);
+	std::string name () { return _name_entry.get_text (); }
+
+private:
+	void update_sensitivity ();
+	void active_changed (int, Gtk::CheckButton*, Gtk::Entry*);
+	void value_changed (int, Gtk::Entry*);
+
+	Gtk::Entry _name_entry;
+	Gtk::Button* _add;
+	const std::vector<std::string> &_existing_names;
+	ARDOUR::LuaScriptParamList& _lsp;
+};

gtk2_ardour/wscript

@@ -207,6 +207,7 @@ gtk2_ardour_sources = [
         'ruler_dialog.cc',
         'save_as_dialog.cc',
         'search_path_option.cc',
+        'script_selector.cc',
         'selection.cc',
         'selection_memento.cc',
         'send_ui.cc',