2 Copyright (C) 2016 Robin Gareus <robin@gareus.org>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifdef PLATFORM_WINDOWS
21 #define random() rand()
25 #include "gtk2ardour-config.h"
28 #include <glibmm/fileutils.h>
29 #include <gtkmm/messagedialog.h>
31 #include "pbd/basename.h"
32 #include "pbd/file_utils.h"
35 #include "gtkmm2ext/gtk_ui.h"
36 #include "gtkmm2ext/utils.h"
37 #include "gtkmm2ext/window_title.h"
39 #include "ardour/luabindings.h"
40 #include "LuaBridge/LuaBridge.h"
42 #include "ardour_ui.h"
43 #include "gui_thread.h"
44 #include "luainstance.h"
45 #include "luawindow.h"
46 #include "public_editor.h"
49 #include "utils_videotl.h"
53 using namespace ARDOUR;
54 using namespace ARDOUR_UI_UTILS;
58 using namespace Gtkmm2ext;
62 inline LuaWindow::BufferFlags operator| (const LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
63 return static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) | static_cast<int> (b));
66 inline LuaWindow::BufferFlags operator|= (LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
67 return a = static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) | static_cast<int> (b));
70 inline LuaWindow::BufferFlags operator&= (LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
71 return a = static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) & static_cast<int> (b));
74 LuaWindow* LuaWindow::_instance = 0;
77 LuaWindow::instance ()
80 _instance = new LuaWindow;
86 LuaWindow::LuaWindow ()
87 : Window (Gtk::WINDOW_TOPLEVEL)
88 , VisibilityTracker (*((Gtk::Window*) this))
95 , _btn_clear (_("Clear Outtput"))
96 , _btn_open (_("Import"))
97 , _btn_save (_("Save"))
98 , _btn_delete (_("Delete"))
99 , _btn_revert (_("Revert"))
106 set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
108 script_select.disable_scrolling ();
110 set_border_width (0);
112 outtext.set_editable (false);
113 outtext.set_wrap_mode (Gtk::WRAP_WORD);
114 outtext.set_cursor_visible (false);
116 signal_delete_event().connect (sigc::mem_fun (*this, &LuaWindow::hide_window));
117 signal_configure_event().connect (sigc::mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
119 _btn_run.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::run_script));
120 _btn_clear.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::clear_output));
121 _btn_open.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::import_script));
122 _btn_save.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::save_script));
123 _btn_delete.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::delete_script));
124 _btn_revert.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::revert_script));
126 _btn_open.set_sensitive (false); // TODO
127 _btn_save.set_sensitive (false);
128 _btn_delete.set_sensitive (false);
129 _btn_revert.set_sensitive (false);
133 Gtk::ScrolledWindow *scrollin = manage (new Gtk::ScrolledWindow);
134 scrollin->set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
135 scrollin->add (entry);
136 scrollout.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_ALWAYS);
137 scrollout.add (outtext);
139 entry.set_name ("ArdourLuaEntry");
140 outtext.set_name ("ArdourLuaEntry");
142 Gtk::HBox *hbox = manage (new HBox());
144 hbox->pack_start (_btn_run, false, false, 2);
145 hbox->pack_start (_btn_clear, false, false, 2);
146 hbox->pack_start (_btn_open, false, false, 2);
147 hbox->pack_start (_btn_save, false, false, 2);
148 hbox->pack_start (_btn_delete, false, false, 2);
149 hbox->pack_start (_btn_revert, false, false, 2);
150 hbox->pack_start (script_select, false, false, 2);
152 Gtk::VBox *vbox = manage (new VBox());
153 vbox->pack_start (*scrollin, true, true, 0);
154 vbox->pack_start (*hbox, false, false, 2);
156 Gtk::VPaned *vpane = manage (new Gtk::VPaned ());
157 vpane->pack1 (*vbox, true, false);
158 vpane->pack2 (scrollout, false, true);
162 set_size_request (640, 480); // XXX
163 ARDOUR_UI_UTILS::set_tooltip (script_select, _("Select Editor Buffer"));
166 LuaScripting::instance().scripts_changed.connect (*this, invalidator (*this), boost::bind (&LuaWindow::refresh_scriptlist, this), gui_context());
168 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
169 _script_changed_connection = tb->signal_changed().connect (sigc::mem_fun(*this, &LuaWindow::script_changed));
172 LuaWindow::~LuaWindow ()
178 LuaWindow::show_window ()
185 LuaWindow::hide_window (GdkEventAny *ev)
187 if (!_visible) return 0;
189 return just_hide_it (ev, static_cast<Gtk::Window *>(this));
192 void LuaWindow::reinit_lua ()
194 ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
196 lua = new LuaState();
197 lua->Print.connect (sigc::mem_fun (*this, &LuaWindow::append_text));
199 lua_State* L = lua->getState();
200 LuaInstance::register_classes (L);
201 luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
202 lua_setglobal (L, "Editor");
205 void LuaWindow::set_session (Session* s)
207 SessionHandlePtr::set_session (s);
213 _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&LuaWindow::update_title, this), gui_context());
215 lua_State* L = lua->getState();
216 LuaBindings::set_session (L, _session);
220 LuaWindow::session_going_away ()
222 ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
223 reinit_lua (); // drop state (all variables, session references)
225 SessionHandlePtr::session_going_away ();
229 lua_State* L = lua->getState();
230 LuaBindings::set_session (L, _session);
234 LuaWindow::update_title ()
239 if (_session->snap_name() != _session->name()) {
240 n = _session->snap_name ();
242 n = _session->name ();
245 if (_session->dirty ()) {
249 WindowTitle title (n);
250 title += S_("Window|Lua");
251 title += Glib::get_application_name ();
252 set_title (title.get_string());
255 WindowTitle title (S_("Window|Lua"));
256 title += Glib::get_application_name ();
257 set_title (title.get_string());
262 LuaWindow::scroll_to_bottom ()
264 Gtk::Adjustment *adj;
265 adj = scrollout.get_vadjustment();
266 adj->set_value (MAX(0,(adj->get_upper() - adj->get_page_size())));
270 LuaWindow::run_script ()
272 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
273 std::string script = tb->get_text();
274 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
275 if (bytecode.empty()) {
276 // plain script or faulty script -- run directly
278 lua->do_command ("function ardour () end");
279 if (0 == lua->do_command (script)) {
280 append_text ("> OK");
282 } catch (luabridge::LuaException const& e) {
283 append_text (string_compose (_("LuaException: %1"), e.what()));
286 // script with factory method
288 lua_State* L = lua->getState();
289 lua->do_command ("function ardour () end");
291 LuaScriptParamList args = LuaScriptParams::script_params (script, "action_param", false);
292 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
293 LuaScriptParams::params_to_ref (&tbl_arg, args);
294 lua->do_command (script); // register "factory"
295 luabridge::LuaRef lua_factory = luabridge::getGlobal (L, "factory");
296 if (lua_factory.isFunction()) {
297 lua_factory(tbl_arg)();
299 lua->do_command ("factory = nil;");
300 } catch (luabridge::LuaException const& e) {
301 append_text (string_compose (_("LuaException: %1"), e.what()));
307 LuaWindow::append_text (std::string s)
309 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
310 tb->insert (tb->end(), s + "\n");
315 LuaWindow::clear_output ()
317 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
322 LuaWindow::new_script ()
325 snprintf (buf, sizeof (buf), "#%d", count_scratch_buffers () + 1);
326 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer (buf)));
327 script_selection_changed (script_buffers.back ());
328 refresh_scriptlist ();
332 LuaWindow::delete_script ()
334 assert (_current_buffer->flags & Buffer_Scratch);
335 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
336 if ((*i) == _current_buffer) {
337 script_buffers.erase (i);
342 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
343 if ((*i)->flags & Buffer_Scratch) {
344 script_selection_changed (*i);
352 LuaWindow::revert_script ()
354 _current_buffer->flags &= BufferFlags(~Buffer_Valid);
355 script_selection_changed (_current_buffer, true);
359 LuaWindow::import_script ()
361 // TODO: dialog to select file or enter URL
362 // TODO convert a few URL (eg. pastebin) to raw.
364 char *url = "http://pastebin.com/raw/3UMkZ6nV";
365 char *rv = a3_curl_http_get (url, 0);
368 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
370 _current_buffer->flags &= BufferFlags(~Buffer_Dirty);
378 LuaWindow::save_script ()
380 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
381 std::string script = tb->get_text();
382 std::string msg = "Unknown error";
385 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
386 ScriptBuffer & sb (*_current_buffer);
388 assert (sb.flags & Buffer_Dirty);
390 // 1) check if it has a valid header and factory
391 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
392 if (bytecode.empty()) {
393 msg = _("Missing script header.\nThe script requires an '{ardour}' info table and a 'factory' function.");
397 if (!LuaScripting::try_compile (script, LuaScriptParams::script_params (script, "action_param", false))) {
398 msg = _("Script fails to compile.");
402 // 2) check script name & type
403 lsi = LuaScripting::script_info (script);
405 msg = _("Invalid or missing script-name or script-type.");
409 if (lsi->type != LuaScriptInfo::Snippet && lsi->type != LuaScriptInfo::EditorAction) {
410 msg = _("Invalid script-type.\nValid types are 'EditorAction' and 'Snippet'.");
414 // 3) if there's already a writable file,...
415 if ((sb.flags & Buffer_HasFile) && !(sb.flags & Buffer_ReadOnly)) {
417 Glib::file_set_contents (sb.path, script);
418 sb.flags &= BufferFlags(~Buffer_Dirty);
419 update_gui_state (); // XXX here?
420 append_text (X_("> ") + string_compose (_("Saved as %1"), sb.path));
422 } catch (Glib::FileError e) {
423 msg = string_compose (_("Error saving file: %1"), e.what());
428 // 4) check if the name is unique for the given type; locally at least
429 if (true /*sb.flags & Buffer_HasFile*/) {
430 LuaScriptList& lsl (LuaScripting::instance ().scripts (lsi->type));
431 for (LuaScriptList::const_iterator s = lsl.begin(); s != lsl.end(); ++s) {
432 if ((*s)->name == lsi->name) {
433 msg = string_compose (_("Script with given name '%1' already exists.\nUse a different name in the descriptor."), lsi->name);
439 // 5) construct filename -- TODO ask user for name, ask to replace file.
443 struct tm * timeinfo = localtime (&t);
444 strftime (buf, sizeof(buf), "%s%d", timeinfo);
445 sprintf (buf, "%s%ld", buf, random ()); // is this valid?
447 std::string fn = md5.digestString (buf);
450 case LuaScriptInfo::EditorAction:
453 case LuaScriptInfo::Snippet:
459 path = Glib::build_filename (LuaScripting::user_script_dir (), fn.substr(0, 11) + ".lua");
460 } while (Glib::file_test (path, Glib::FILE_TEST_EXISTS));
463 Glib::file_set_contents (path, script);
465 sb.flags |= Buffer_HasFile;
466 sb.flags &= BufferFlags(~Buffer_Dirty);
467 update_gui_state (); // XXX here?
468 LuaScripting::instance().refresh (true);
469 append_text (X_("> ") + string_compose (_("Saved as %1"), path));
471 } catch (Glib::FileError e) {
472 msg = string_compose (_("Error saving file: %1"), e.what());
477 MessageDialog am (msg);
482 LuaWindow::setup_buffers ()
484 if (script_buffers.size() > 0) {
487 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer("#1")));
488 _current_buffer = script_buffers.front();
490 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
491 tb->set_text (_current_buffer->script);
493 refresh_scriptlist ();
498 LuaWindow::count_scratch_buffers () const
501 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
502 if ((*i)->flags & Buffer_Scratch) {
510 LuaWindow::refresh_scriptlist ()
512 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end ();) {
513 if ((*i)->flags & Buffer_Scratch) {
517 i = script_buffers.erase (i);
519 LuaScriptList& lsa (LuaScripting::instance ().scripts (LuaScriptInfo::EditorAction));
520 for (LuaScriptList::const_iterator s = lsa.begin(); s != lsa.end(); ++s) {
521 script_buffers.push_back (ScriptBufferPtr ( new LuaWindow::ScriptBuffer(*s)));
524 LuaScriptList& lss (LuaScripting::instance ().scripts (LuaScriptInfo::Snippet));
525 for (LuaScriptList::const_iterator s = lss.begin(); s != lss.end(); ++s) {
526 script_buffers.push_back (ScriptBufferPtr ( new LuaWindow::ScriptBuffer(*s)));
532 LuaWindow::rebuild_menu ()
534 using namespace Menu_Helpers;
536 _menu_scratch = manage (new Menu);
537 _menu_snippet = manage (new Menu);
538 _menu_actions = manage (new Menu);
540 MenuList& items_scratch (_menu_scratch->items());
541 MenuList& items_snippet (_menu_snippet->items());
542 MenuList& items_actions (_menu_actions->items());
545 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(_("New"),
546 sigc::mem_fun(*this, &LuaWindow::new_script));
547 items_scratch.push_back(elem);
550 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
551 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem((*i)->name,
552 sigc::bind(sigc::mem_fun(*this, &LuaWindow::script_selection_changed), (*i), false));
554 if ((*i)->flags & Buffer_Scratch) {
555 items_scratch.push_back(elem);
557 else if ((*i)->type == LuaScriptInfo::EditorAction) {
558 items_actions.push_back(elem);
560 else if ((*i)->type == LuaScriptInfo::Snippet) {
561 items_snippet.push_back(elem);
565 script_select.clear_items ();
566 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Scratch", *_menu_scratch));
567 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Snippets", *_menu_snippet));
568 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Actions", *_menu_actions));
572 LuaWindow::script_selection_changed (ScriptBufferPtr n, bool force)
574 if (n == _current_buffer && !force) {
578 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
580 if ((n->flags & Buffer_Valid)) {
581 _current_buffer->script = tb->get_text();
584 if (!(n->flags & Buffer_Valid)) {
586 append_text ("! Failed to load buffer.");
590 if (n->flags & Buffer_Valid) {
592 _script_changed_connection.block ();
593 tb->set_text (n->script);
594 _script_changed_connection.unblock ();
596 append_text ("! Failed to switch buffer.");
602 LuaWindow::update_gui_state ()
604 const ScriptBuffer & sb (*_current_buffer);
606 if (sb.flags & Buffer_Scratch) {
607 name = string_compose (_("Scratch Buffer %1"), sb.name);
608 } else if (sb.type == LuaScriptInfo::EditorAction) {
609 name = string_compose (_("Action: '%1'"), sb.name);
610 } else if (sb.type == LuaScriptInfo::Snippet) {
611 name = string_compose (_("Snippet: %1"), sb.name);
613 cerr << "Invalid Script type\n";
617 if (sb.flags & Buffer_Dirty) {
620 script_select.set_text(name);
622 _btn_save.set_sensitive (sb.flags & Buffer_Dirty);
623 _btn_delete.set_sensitive (sb.flags & Buffer_Scratch); // TODO allow to remove user-scripts
624 _btn_revert.set_sensitive ((sb.flags & Buffer_Dirty) && (sb.flags & Buffer_HasFile));
628 LuaWindow::script_changed () {
629 if (_current_buffer->flags & Buffer_Dirty) {
632 _current_buffer->flags |= Buffer_Dirty;
636 LuaWindow::ScriptBuffer::ScriptBuffer (const std::string& n)
638 , flags (Buffer_Scratch | Buffer_Valid)
641 "-- ardour { [\"type\"] = \"Snippet\", name = \"\" }\n"
642 "-- function factory () return function () -- -- end end\n";
645 LuaWindow::ScriptBuffer::ScriptBuffer (LuaScriptInfoPtr p)
648 , flags (Buffer_HasFile)
651 if (!PBD::exists_and_writable (path)) {
652 flags |= Buffer_ReadOnly;
657 LuaWindow::ScriptBuffer::ScriptBuffer (const ScriptBuffer& other)
658 : script (other.script)
661 , flags (other.flags)
667 LuaWindow::ScriptBuffer::~ScriptBuffer ()
672 LuaWindow::ScriptBuffer::load ()
674 if (!(flags & Buffer_HasFile)) return false;
675 if (flags & Buffer_Valid) return true;
677 script = Glib::file_get_contents (path);
678 flags |= Buffer_Valid;
679 } catch (Glib::FileError e) {