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 "pbd/gstdio_compat.h"
29 #include <glibmm/fileutils.h>
30 #include <gtkmm/messagedialog.h>
32 #include "pbd/basename.h"
33 #include "pbd/file_utils.h"
36 #include "gtkmm2ext/gtk_ui.h"
37 #include "gtkmm2ext/pane.h"
38 #include "gtkmm2ext/utils.h"
39 #include "gtkmm2ext/window_title.h"
41 #include "ardour/filesystem_paths.h"
42 #include "ardour/luabindings.h"
43 #include "LuaBridge/LuaBridge.h"
45 #include "ardour_ui.h"
46 #include "gui_thread.h"
47 #include "luainstance.h"
48 #include "luawindow.h"
49 #include "public_editor.h"
52 #include "utils_videotl.h"
56 using namespace ARDOUR;
57 using namespace ARDOUR_UI_UTILS;
61 using namespace Gtkmm2ext;
65 inline LuaWindow::BufferFlags operator| (const LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
66 return static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) | static_cast<int> (b));
69 inline LuaWindow::BufferFlags operator|= (LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
70 return a = static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) | static_cast<int> (b));
73 inline LuaWindow::BufferFlags operator&= (LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
74 return a = static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) & static_cast<int> (b));
77 LuaWindow* LuaWindow::_instance = 0;
80 LuaWindow::instance ()
83 _instance = new LuaWindow;
89 LuaWindow::LuaWindow ()
90 : Window (Gtk::WINDOW_TOPLEVEL)
91 , VisibilityTracker (*((Gtk::Window*) this))
98 , _btn_clear (_("Clear Output"))
99 , _btn_open (_("Import"))
100 , _btn_save (_("Save"))
101 , _btn_delete (_("Delete"))
102 , _btn_revert (_("Revert"))
109 set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
111 script_select.disable_scrolling ();
113 set_border_width (0);
115 outtext.set_editable (false);
116 outtext.set_wrap_mode (Gtk::WRAP_WORD);
117 outtext.set_cursor_visible (false);
119 signal_delete_event().connect (sigc::mem_fun (*this, &LuaWindow::hide_window));
120 signal_configure_event().connect (sigc::mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
122 _btn_run.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::run_script));
123 _btn_clear.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::clear_output));
124 _btn_open.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::import_script));
125 _btn_save.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::save_script));
126 _btn_delete.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::delete_script));
127 _btn_revert.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::revert_script));
129 _btn_open.set_sensitive (false); // TODO
130 _btn_save.set_sensitive (false);
131 _btn_delete.set_sensitive (false);
132 _btn_revert.set_sensitive (false);
136 Gtk::ScrolledWindow *scrollin = manage (new Gtk::ScrolledWindow);
137 scrollin->set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
138 scrollin->add (entry);
139 scrollout.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_ALWAYS);
140 scrollout.add (outtext);
142 entry.set_name ("ArdourLuaEntry");
143 outtext.set_name ("ArdourLuaEntry");
145 Gtk::HBox *hbox = manage (new HBox());
147 hbox->pack_start (_btn_run, false, false, 2);
148 hbox->pack_start (_btn_clear, false, false, 2);
149 hbox->pack_start (_btn_open, false, false, 2);
150 hbox->pack_start (_btn_save, false, false, 2);
151 hbox->pack_start (_btn_delete, false, false, 2);
152 hbox->pack_start (_btn_revert, false, false, 2);
153 hbox->pack_start (script_select, false, false, 2);
155 Gtk::VBox *vbox = manage (new VBox());
156 vbox->pack_start (*scrollin, true, true, 0);
157 vbox->pack_start (*hbox, false, false, 2);
159 Gtkmm2ext::VPane *vpane = manage (new Gtkmm2ext::VPane ());
161 vpane->add (scrollout);
165 set_size_request (640, 480); // XXX
166 ARDOUR_UI_UTILS::set_tooltip (script_select, _("Select Editor Buffer"));
169 LuaScripting::instance().scripts_changed.connect (*this, invalidator (*this), boost::bind (&LuaWindow::refresh_scriptlist, this), gui_context());
171 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
172 _script_changed_connection = tb->signal_changed().connect (sigc::mem_fun(*this, &LuaWindow::script_changed));
175 LuaWindow::~LuaWindow ()
181 LuaWindow::show_window ()
188 LuaWindow::hide_window (GdkEventAny *ev)
190 if (!_visible) return 0;
192 return just_hide_it (ev, static_cast<Gtk::Window *>(this));
195 void LuaWindow::reinit_lua ()
197 ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
199 lua = new LuaState();
200 lua->Print.connect (sigc::mem_fun (*this, &LuaWindow::append_text));
202 lua_State* L = lua->getState();
203 LuaInstance::register_classes (L);
204 luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
205 lua_setglobal (L, "Editor");
208 void LuaWindow::set_session (Session* s)
210 SessionHandlePtr::set_session (s);
216 _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&LuaWindow::update_title, this), gui_context());
218 lua_State* L = lua->getState();
219 LuaBindings::set_session (L, _session);
223 LuaWindow::session_going_away ()
225 ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
226 reinit_lua (); // drop state (all variables, session references)
228 SessionHandlePtr::session_going_away ();
232 lua_State* L = lua->getState();
233 LuaBindings::set_session (L, _session);
237 LuaWindow::update_title ()
242 if (_session->snap_name() != _session->name()) {
243 n = _session->snap_name ();
245 n = _session->name ();
248 if (_session->dirty ()) {
252 WindowTitle title (n);
253 title += S_("Window|Lua");
254 title += Glib::get_application_name ();
255 set_title (title.get_string());
258 WindowTitle title (S_("Window|Lua"));
259 title += Glib::get_application_name ();
260 set_title (title.get_string());
265 LuaWindow::scroll_to_bottom ()
267 Gtk::Adjustment *adj;
268 adj = scrollout.get_vadjustment();
269 adj->set_value (MAX(0,(adj->get_upper() - adj->get_page_size())));
273 LuaWindow::run_script ()
275 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
276 std::string script = tb->get_text();
277 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
278 if (bytecode.empty()) {
279 // plain script or faulty script -- run directly
281 lua->do_command ("function ardour () end");
282 if (0 == lua->do_command (script)) {
283 append_text ("> OK");
285 } catch (luabridge::LuaException const& e) {
286 append_text (string_compose (_("LuaException: %1"), e.what()));
289 // script with factory method
291 lua_State* L = lua->getState();
292 lua->do_command ("function ardour () end");
294 LuaScriptParamList args = LuaScriptParams::script_params (script, "action_param", false);
295 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
296 LuaScriptParams::params_to_ref (&tbl_arg, args);
297 lua->do_command (script); // register "factory"
298 luabridge::LuaRef lua_factory = luabridge::getGlobal (L, "factory");
299 if (lua_factory.isFunction()) {
300 lua_factory(tbl_arg)();
302 lua->do_command ("factory = nil;");
303 } catch (luabridge::LuaException const& e) {
304 append_text (string_compose (_("LuaException: %1"), e.what()));
310 LuaWindow::append_text (std::string s)
312 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
313 tb->insert (tb->end(), s + "\n");
315 Gtkmm2ext::UI::instance()->flush_pending (0.05);
319 LuaWindow::clear_output ()
321 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
326 LuaWindow::new_script ()
329 snprintf (buf, sizeof (buf), "#%d", count_scratch_buffers () + 1);
330 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer (buf)));
331 script_selection_changed (script_buffers.back ());
332 refresh_scriptlist ();
336 LuaWindow::delete_script ()
338 assert ((_current_buffer->flags & Buffer_Scratch) || !(_current_buffer->flags & Buffer_ReadOnly));
339 bool refresh = false;
341 if (_current_buffer->flags & Buffer_HasFile) {
342 if (0 == ::g_unlink (_current_buffer->path.c_str())) {
343 append_text (X_("> ") + string_compose (_("Deleted %1"), _current_buffer->path));
346 append_text (X_("> ") + string_compose (_("Failed to delete %1"), _current_buffer->path));
349 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
350 if ((*i) == _current_buffer) {
351 script_buffers.erase (i);
356 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
357 if ((*i)->flags & Buffer_Scratch) {
358 script_selection_changed (*i);
366 LuaScripting::instance ().refresh (true);
371 LuaWindow::revert_script ()
373 _current_buffer->flags &= BufferFlags(~Buffer_Valid);
374 script_selection_changed (_current_buffer, true);
378 LuaWindow::import_script ()
380 // TODO: dialog to select file or enter URL
381 // TODO convert a few URL (eg. pastebin) to raw.
383 char *url = "http://pastebin.com/raw/3UMkZ6nV";
384 char *rv = ArdourCurl::http_get (url, 0);
387 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
389 _current_buffer->flags &= BufferFlags(~Buffer_Dirty);
397 LuaWindow::save_script ()
399 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
400 std::string script = tb->get_text();
401 std::string msg = "Unknown error";
404 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
405 ScriptBuffer & sb (*_current_buffer);
407 assert (sb.flags & Buffer_Dirty);
409 // 1) check if it has a valid header and factory
410 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
411 if (bytecode.empty()) {
412 msg = _("Missing script header.\nThe script requires an '{ardour}' info table and a 'factory' function.");
416 if (!LuaScripting::try_compile (script, LuaScriptParams::script_params (script, "action_param", false))) {
417 msg = _("Script fails to compile.");
421 // 2) check script name & type
422 lsi = LuaScripting::script_info (script);
424 msg = _("Invalid or missing script-name or script-type.");
428 if (lsi->type != LuaScriptInfo::Snippet && lsi->type != LuaScriptInfo::EditorAction) {
429 msg = _("Invalid script-type.\nValid types are 'EditorAction' and 'Snippet'.");
433 // 3) if there's already a writable file,...
434 if ((sb.flags & Buffer_HasFile) && !(sb.flags & Buffer_ReadOnly)) {
436 Glib::file_set_contents (sb.path, script);
438 sb.flags &= BufferFlags(~Buffer_Dirty);
439 update_gui_state (); // XXX here?
440 append_text (X_("> ") + string_compose (_("Saved as %1"), sb.path));
442 } catch (Glib::FileError e) {
443 msg = string_compose (_("Error saving file: %1"), e.what());
448 // 4) check if the name is unique for the given type; locally at least
449 if (true /*sb.flags & Buffer_HasFile*/) {
450 LuaScriptList& lsl (LuaScripting::instance ().scripts (lsi->type));
451 for (LuaScriptList::const_iterator s = lsl.begin(); s != lsl.end(); ++s) {
452 if ((*s)->name == lsi->name) {
453 msg = string_compose (_("Script with given name '%1' already exists.\nUse a different name in the descriptor."), lsi->name);
459 // 5) construct filename -- TODO ask user for name, ask to replace file.
463 struct tm * timeinfo = localtime (&t);
464 strftime (buf, sizeof(buf), "%s%d", timeinfo);
465 sprintf (buf, "%s%ld", buf, random ()); // is this valid?
467 std::string fn = md5.digestString (buf);
470 case LuaScriptInfo::EditorAction:
473 case LuaScriptInfo::Snippet:
479 path = Glib::build_filename (LuaScripting::user_script_dir (), fn.substr(0, 11) + ".lua");
480 } while (Glib::file_test (path, Glib::FILE_TEST_EXISTS));
483 Glib::file_set_contents (path, script);
486 sb.flags |= Buffer_HasFile;
487 sb.flags &= BufferFlags(~Buffer_Dirty);
488 sb.flags &= BufferFlags(~Buffer_ReadOnly);
489 update_gui_state (); // XXX here? .refresh (true) may trigger this, too
490 LuaScripting::instance().refresh (true);
491 append_text (X_("> ") + string_compose (_("Saved as %1"), path));
493 } catch (Glib::FileError e) {
494 msg = string_compose (_("Error saving file: %1"), e.what());
499 MessageDialog am (msg);
504 LuaWindow::setup_buffers ()
506 if (script_buffers.size() > 0) {
509 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer("#1")));
510 _current_buffer = script_buffers.front();
512 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
513 tb->set_text (_current_buffer->script);
515 refresh_scriptlist ();
520 LuaWindow::count_scratch_buffers () const
523 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
524 if ((*i)->flags & Buffer_Scratch) {
532 LuaWindow::refresh_scriptlist ()
534 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end ();) {
535 if ((*i)->flags & Buffer_Scratch) {
539 i = script_buffers.erase (i);
541 LuaScriptList& lsa (LuaScripting::instance ().scripts (LuaScriptInfo::EditorAction));
542 for (LuaScriptList::const_iterator s = lsa.begin(); s != lsa.end(); ++s) {
543 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer(*s)));
546 LuaScriptList& lss (LuaScripting::instance ().scripts (LuaScriptInfo::Snippet));
547 for (LuaScriptList::const_iterator s = lss.begin(); s != lss.end(); ++s) {
548 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer(*s)));
554 LuaWindow::rebuild_menu ()
556 using namespace Menu_Helpers;
558 _menu_scratch = manage (new Menu);
559 _menu_snippet = manage (new Menu);
560 _menu_actions = manage (new Menu);
562 MenuList& items_scratch (_menu_scratch->items());
563 MenuList& items_snippet (_menu_snippet->items());
564 MenuList& items_actions (_menu_actions->items());
567 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(_("New"),
568 sigc::mem_fun(*this, &LuaWindow::new_script));
569 items_scratch.push_back(elem);
572 items_scratch.push_back(SeparatorElem());
574 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
576 if ((*i)->flags & Buffer_ReadOnly) {
577 name = "[R] " + (*i)->name;
581 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(name,
582 sigc::bind(sigc::mem_fun(*this, &LuaWindow::script_selection_changed), (*i), false));
584 if ((*i)->flags & Buffer_Scratch) {
585 items_scratch.push_back(elem);
587 else if ((*i)->type == LuaScriptInfo::EditorAction) {
588 items_actions.push_back(elem);
590 else if ((*i)->type == LuaScriptInfo::Snippet) {
591 items_snippet.push_back(elem);
595 script_select.clear_items ();
596 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Scratch", *_menu_scratch));
597 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Snippets", *_menu_snippet));
598 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Actions", *_menu_actions));
602 LuaWindow::script_selection_changed (ScriptBufferPtr n, bool force)
604 if (n == _current_buffer && !force) {
608 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
610 if (_current_buffer->flags & Buffer_Valid) {
611 _current_buffer->script = tb->get_text();
614 if (!(n->flags & Buffer_Valid)) {
616 append_text ("! Failed to load buffer.");
620 if (n->flags & Buffer_Valid) {
622 _script_changed_connection.block ();
623 tb->set_text (n->script);
624 _script_changed_connection.unblock ();
626 append_text ("! Failed to switch buffer.");
632 LuaWindow::update_gui_state ()
634 const ScriptBuffer & sb (*_current_buffer);
636 if (sb.flags & Buffer_Scratch) {
637 name = string_compose (_("Scratch Buffer %1"), sb.name);
638 } else if (sb.type == LuaScriptInfo::EditorAction) {
639 name = string_compose (_("Action: '%1'"), sb.name);
640 } else if (sb.type == LuaScriptInfo::Snippet) {
641 name = string_compose (_("Snippet: %1"), sb.name);
643 cerr << "Invalid Script type\n";
647 if (sb.flags & Buffer_Dirty) {
650 script_select.set_text(name);
652 if (sb.flags & Buffer_ReadOnly) {
653 _btn_save.set_text (_("Save as"));
655 _btn_save.set_text (_("Save"));
657 _btn_save.set_sensitive (sb.flags & Buffer_Dirty);
658 _btn_delete.set_sensitive (sb.flags & Buffer_Scratch || ((sb.flags & (Buffer_ReadOnly | Buffer_HasFile)) == Buffer_HasFile));
659 _btn_revert.set_sensitive ((sb.flags & Buffer_Dirty) && (sb.flags & Buffer_HasFile));
663 LuaWindow::script_changed () {
664 if (_current_buffer->flags & Buffer_Dirty) {
667 _current_buffer->flags |= Buffer_Dirty;
671 LuaWindow::ScriptBuffer::ScriptBuffer (const std::string& n)
673 , flags (Buffer_Scratch | Buffer_Valid)
676 "---- this header is (only) required to save the script\n"
677 "-- ardour { [\"type\"] = \"Snippet\", name = \"\" }\n"
678 "-- function factory () return function () -- -- end end\n";
681 LuaWindow::ScriptBuffer::ScriptBuffer (LuaScriptInfoPtr p)
684 , flags (Buffer_HasFile)
687 if (!PBD::exists_and_writable (path)) {
688 flags |= Buffer_ReadOnly;
690 if (path.find (user_config_directory ()) != 0) {
691 // mark non-user scripts as read-only
692 flags |= Buffer_ReadOnly;
697 LuaWindow::ScriptBuffer::ScriptBuffer (const ScriptBuffer& other)
698 : script (other.script)
701 , flags (other.flags)
707 LuaWindow::ScriptBuffer::~ScriptBuffer ()
712 LuaWindow::ScriptBuffer::load ()
714 assert (!(flags & Buffer_Valid));
715 if (!(flags & Buffer_HasFile)) return false;
717 script = Glib::file_get_contents (path);
718 flags |= Buffer_Valid;
719 flags &= BufferFlags(~Buffer_Dirty);
720 } catch (Glib::FileError e) {