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/utils.h"
38 #include "gtkmm2ext/window_title.h"
40 #include "ardour/filesystem_paths.h"
41 #include "ardour/luabindings.h"
42 #include "LuaBridge/LuaBridge.h"
44 #include "ardour_ui.h"
45 #include "gui_thread.h"
46 #include "luainstance.h"
47 #include "luawindow.h"
48 #include "public_editor.h"
51 #include "utils_videotl.h"
55 using namespace ARDOUR;
56 using namespace ARDOUR_UI_UTILS;
60 using namespace Gtkmm2ext;
64 inline LuaWindow::BufferFlags operator| (const LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
65 return static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) | static_cast<int> (b));
68 inline LuaWindow::BufferFlags operator|= (LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
69 return a = static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) | static_cast<int> (b));
72 inline LuaWindow::BufferFlags operator&= (LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
73 return a = static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) & static_cast<int> (b));
76 LuaWindow* LuaWindow::_instance = 0;
79 LuaWindow::instance ()
82 _instance = new LuaWindow;
88 LuaWindow::LuaWindow ()
89 : Window (Gtk::WINDOW_TOPLEVEL)
90 , VisibilityTracker (*((Gtk::Window*) this))
97 , _btn_clear (_("Clear Output"))
98 , _btn_open (_("Import"))
99 , _btn_save (_("Save"))
100 , _btn_delete (_("Delete"))
101 , _btn_revert (_("Revert"))
108 set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
110 script_select.disable_scrolling ();
112 set_border_width (0);
114 outtext.set_editable (false);
115 outtext.set_wrap_mode (Gtk::WRAP_WORD);
116 outtext.set_cursor_visible (false);
118 signal_delete_event().connect (sigc::mem_fun (*this, &LuaWindow::hide_window));
119 signal_configure_event().connect (sigc::mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
121 _btn_run.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::run_script));
122 _btn_clear.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::clear_output));
123 _btn_open.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::import_script));
124 _btn_save.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::save_script));
125 _btn_delete.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::delete_script));
126 _btn_revert.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::revert_script));
128 _btn_open.set_sensitive (false); // TODO
129 _btn_save.set_sensitive (false);
130 _btn_delete.set_sensitive (false);
131 _btn_revert.set_sensitive (false);
135 Gtk::ScrolledWindow *scrollin = manage (new Gtk::ScrolledWindow);
136 scrollin->set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
137 scrollin->add (entry);
138 scrollout.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_ALWAYS);
139 scrollout.add (outtext);
141 entry.set_name ("ArdourLuaEntry");
142 outtext.set_name ("ArdourLuaEntry");
144 Gtk::HBox *hbox = manage (new HBox());
146 hbox->pack_start (_btn_run, false, false, 2);
147 hbox->pack_start (_btn_clear, false, false, 2);
148 hbox->pack_start (_btn_open, false, false, 2);
149 hbox->pack_start (_btn_save, false, false, 2);
150 hbox->pack_start (_btn_delete, false, false, 2);
151 hbox->pack_start (_btn_revert, false, false, 2);
152 hbox->pack_start (script_select, false, false, 2);
154 Gtk::VBox *vbox = manage (new VBox());
155 vbox->pack_start (*scrollin, true, true, 0);
156 vbox->pack_start (*hbox, false, false, 2);
158 Gtk::VPaned *vpane = manage (new Gtk::VPaned ());
159 vpane->pack1 (*vbox, true, false);
160 vpane->pack2 (scrollout, false, true);
164 set_size_request (640, 480); // XXX
165 ARDOUR_UI_UTILS::set_tooltip (script_select, _("Select Editor Buffer"));
168 LuaScripting::instance().scripts_changed.connect (*this, invalidator (*this), boost::bind (&LuaWindow::refresh_scriptlist, this), gui_context());
170 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
171 _script_changed_connection = tb->signal_changed().connect (sigc::mem_fun(*this, &LuaWindow::script_changed));
174 LuaWindow::~LuaWindow ()
180 LuaWindow::show_window ()
187 LuaWindow::hide_window (GdkEventAny *ev)
189 if (!_visible) return 0;
191 return just_hide_it (ev, static_cast<Gtk::Window *>(this));
194 void LuaWindow::reinit_lua ()
196 ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
198 lua = new LuaState();
199 lua->Print.connect (sigc::mem_fun (*this, &LuaWindow::append_text));
201 lua_State* L = lua->getState();
202 LuaInstance::register_classes (L);
203 luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
204 lua_setglobal (L, "Editor");
207 void LuaWindow::set_session (Session* s)
209 SessionHandlePtr::set_session (s);
215 _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&LuaWindow::update_title, this), gui_context());
217 lua_State* L = lua->getState();
218 LuaBindings::set_session (L, _session);
222 LuaWindow::session_going_away ()
224 ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
225 reinit_lua (); // drop state (all variables, session references)
227 SessionHandlePtr::session_going_away ();
231 lua_State* L = lua->getState();
232 LuaBindings::set_session (L, _session);
236 LuaWindow::update_title ()
241 if (_session->snap_name() != _session->name()) {
242 n = _session->snap_name ();
244 n = _session->name ();
247 if (_session->dirty ()) {
251 WindowTitle title (n);
252 title += S_("Window|Lua");
253 title += Glib::get_application_name ();
254 set_title (title.get_string());
257 WindowTitle title (S_("Window|Lua"));
258 title += Glib::get_application_name ();
259 set_title (title.get_string());
264 LuaWindow::scroll_to_bottom ()
266 Gtk::Adjustment *adj;
267 adj = scrollout.get_vadjustment();
268 adj->set_value (MAX(0,(adj->get_upper() - adj->get_page_size())));
272 LuaWindow::run_script ()
274 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
275 std::string script = tb->get_text();
276 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
277 if (bytecode.empty()) {
278 // plain script or faulty script -- run directly
280 lua->do_command ("function ardour () end");
281 if (0 == lua->do_command (script)) {
282 append_text ("> OK");
284 } catch (luabridge::LuaException const& e) {
285 append_text (string_compose (_("LuaException: %1"), e.what()));
288 // script with factory method
290 lua_State* L = lua->getState();
291 lua->do_command ("function ardour () end");
293 LuaScriptParamList args = LuaScriptParams::script_params (script, "action_param", false);
294 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
295 LuaScriptParams::params_to_ref (&tbl_arg, args);
296 lua->do_command (script); // register "factory"
297 luabridge::LuaRef lua_factory = luabridge::getGlobal (L, "factory");
298 if (lua_factory.isFunction()) {
299 lua_factory(tbl_arg)();
301 lua->do_command ("factory = nil;");
302 } catch (luabridge::LuaException const& e) {
303 append_text (string_compose (_("LuaException: %1"), e.what()));
309 LuaWindow::append_text (std::string s)
311 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
312 tb->insert (tb->end(), s + "\n");
317 LuaWindow::clear_output ()
319 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
324 LuaWindow::new_script ()
327 snprintf (buf, sizeof (buf), "#%d", count_scratch_buffers () + 1);
328 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer (buf)));
329 script_selection_changed (script_buffers.back ());
330 refresh_scriptlist ();
334 LuaWindow::delete_script ()
336 assert ((_current_buffer->flags & Buffer_Scratch) || !(_current_buffer->flags & Buffer_ReadOnly));
337 bool refresh = false;
339 if (_current_buffer->flags & Buffer_HasFile) {
340 if (0 == ::g_unlink (_current_buffer->path.c_str())) {
341 append_text (X_("> ") + string_compose (_("Deleted %1"), _current_buffer->path));
344 append_text (X_("> ") + string_compose (_("Failed to delete %1"), _current_buffer->path));
347 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
348 if ((*i) == _current_buffer) {
349 script_buffers.erase (i);
354 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
355 if ((*i)->flags & Buffer_Scratch) {
356 script_selection_changed (*i);
364 LuaScripting::instance ().refresh (true);
369 LuaWindow::revert_script ()
371 _current_buffer->flags &= BufferFlags(~Buffer_Valid);
372 script_selection_changed (_current_buffer, true);
376 LuaWindow::import_script ()
378 // TODO: dialog to select file or enter URL
379 // TODO convert a few URL (eg. pastebin) to raw.
381 char *url = "http://pastebin.com/raw/3UMkZ6nV";
382 char *rv = a3_curl_http_get (url, 0);
385 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
387 _current_buffer->flags &= BufferFlags(~Buffer_Dirty);
395 LuaWindow::save_script ()
397 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
398 std::string script = tb->get_text();
399 std::string msg = "Unknown error";
402 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
403 ScriptBuffer & sb (*_current_buffer);
405 assert (sb.flags & Buffer_Dirty);
407 // 1) check if it has a valid header and factory
408 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
409 if (bytecode.empty()) {
410 msg = _("Missing script header.\nThe script requires an '{ardour}' info table and a 'factory' function.");
414 if (!LuaScripting::try_compile (script, LuaScriptParams::script_params (script, "action_param", false))) {
415 msg = _("Script fails to compile.");
419 // 2) check script name & type
420 lsi = LuaScripting::script_info (script);
422 msg = _("Invalid or missing script-name or script-type.");
426 if (lsi->type != LuaScriptInfo::Snippet && lsi->type != LuaScriptInfo::EditorAction) {
427 msg = _("Invalid script-type.\nValid types are 'EditorAction' and 'Snippet'.");
431 // 3) if there's already a writable file,...
432 if ((sb.flags & Buffer_HasFile) && !(sb.flags & Buffer_ReadOnly)) {
434 Glib::file_set_contents (sb.path, script);
436 sb.flags &= BufferFlags(~Buffer_Dirty);
437 update_gui_state (); // XXX here?
438 append_text (X_("> ") + string_compose (_("Saved as %1"), sb.path));
440 } catch (Glib::FileError e) {
441 msg = string_compose (_("Error saving file: %1"), e.what());
446 // 4) check if the name is unique for the given type; locally at least
447 if (true /*sb.flags & Buffer_HasFile*/) {
448 LuaScriptList& lsl (LuaScripting::instance ().scripts (lsi->type));
449 for (LuaScriptList::const_iterator s = lsl.begin(); s != lsl.end(); ++s) {
450 if ((*s)->name == lsi->name) {
451 msg = string_compose (_("Script with given name '%1' already exists.\nUse a different name in the descriptor."), lsi->name);
457 // 5) construct filename -- TODO ask user for name, ask to replace file.
461 struct tm * timeinfo = localtime (&t);
462 strftime (buf, sizeof(buf), "%s%d", timeinfo);
463 sprintf (buf, "%s%ld", buf, random ()); // is this valid?
465 std::string fn = md5.digestString (buf);
468 case LuaScriptInfo::EditorAction:
471 case LuaScriptInfo::Snippet:
477 path = Glib::build_filename (LuaScripting::user_script_dir (), fn.substr(0, 11) + ".lua");
478 } while (Glib::file_test (path, Glib::FILE_TEST_EXISTS));
481 Glib::file_set_contents (path, script);
484 sb.flags |= Buffer_HasFile;
485 sb.flags &= BufferFlags(~Buffer_Dirty);
486 sb.flags &= BufferFlags(~Buffer_ReadOnly);
487 update_gui_state (); // XXX here? .refresh (true) may trigger this, too
488 LuaScripting::instance().refresh (true);
489 append_text (X_("> ") + string_compose (_("Saved as %1"), path));
491 } catch (Glib::FileError e) {
492 msg = string_compose (_("Error saving file: %1"), e.what());
497 MessageDialog am (msg);
502 LuaWindow::setup_buffers ()
504 if (script_buffers.size() > 0) {
507 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer("#1")));
508 _current_buffer = script_buffers.front();
510 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
511 tb->set_text (_current_buffer->script);
513 refresh_scriptlist ();
518 LuaWindow::count_scratch_buffers () const
521 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
522 if ((*i)->flags & Buffer_Scratch) {
530 LuaWindow::refresh_scriptlist ()
532 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end ();) {
533 if ((*i)->flags & Buffer_Scratch) {
537 i = script_buffers.erase (i);
539 LuaScriptList& lsa (LuaScripting::instance ().scripts (LuaScriptInfo::EditorAction));
540 for (LuaScriptList::const_iterator s = lsa.begin(); s != lsa.end(); ++s) {
541 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer(*s)));
544 LuaScriptList& lss (LuaScripting::instance ().scripts (LuaScriptInfo::Snippet));
545 for (LuaScriptList::const_iterator s = lss.begin(); s != lss.end(); ++s) {
546 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer(*s)));
552 LuaWindow::rebuild_menu ()
554 using namespace Menu_Helpers;
556 _menu_scratch = manage (new Menu);
557 _menu_snippet = manage (new Menu);
558 _menu_actions = manage (new Menu);
560 MenuList& items_scratch (_menu_scratch->items());
561 MenuList& items_snippet (_menu_snippet->items());
562 MenuList& items_actions (_menu_actions->items());
565 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(_("New"),
566 sigc::mem_fun(*this, &LuaWindow::new_script));
567 items_scratch.push_back(elem);
570 items_scratch.push_back(SeparatorElem());
572 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
574 if ((*i)->flags & Buffer_ReadOnly) {
575 name = "[R] " + (*i)->name;
579 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(name,
580 sigc::bind(sigc::mem_fun(*this, &LuaWindow::script_selection_changed), (*i), false));
582 if ((*i)->flags & Buffer_Scratch) {
583 items_scratch.push_back(elem);
585 else if ((*i)->type == LuaScriptInfo::EditorAction) {
586 items_actions.push_back(elem);
588 else if ((*i)->type == LuaScriptInfo::Snippet) {
589 items_snippet.push_back(elem);
593 script_select.clear_items ();
594 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Scratch", *_menu_scratch));
595 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Snippets", *_menu_snippet));
596 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Actions", *_menu_actions));
600 LuaWindow::script_selection_changed (ScriptBufferPtr n, bool force)
602 if (n == _current_buffer && !force) {
606 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
608 if (_current_buffer->flags & Buffer_Valid) {
609 _current_buffer->script = tb->get_text();
612 if (!(n->flags & Buffer_Valid)) {
614 append_text ("! Failed to load buffer.");
618 if (n->flags & Buffer_Valid) {
620 _script_changed_connection.block ();
621 tb->set_text (n->script);
622 _script_changed_connection.unblock ();
624 append_text ("! Failed to switch buffer.");
630 LuaWindow::update_gui_state ()
632 const ScriptBuffer & sb (*_current_buffer);
634 if (sb.flags & Buffer_Scratch) {
635 name = string_compose (_("Scratch Buffer %1"), sb.name);
636 } else if (sb.type == LuaScriptInfo::EditorAction) {
637 name = string_compose (_("Action: '%1'"), sb.name);
638 } else if (sb.type == LuaScriptInfo::Snippet) {
639 name = string_compose (_("Snippet: %1"), sb.name);
641 cerr << "Invalid Script type\n";
645 if (sb.flags & Buffer_Dirty) {
648 script_select.set_text(name);
650 if (sb.flags & Buffer_ReadOnly) {
651 _btn_save.set_text (_("Save as"));
653 _btn_save.set_text (_("Save"));
655 _btn_save.set_sensitive (sb.flags & Buffer_Dirty);
656 _btn_delete.set_sensitive (sb.flags & Buffer_Scratch || ((sb.flags & (Buffer_ReadOnly | Buffer_HasFile)) == Buffer_HasFile));
657 _btn_revert.set_sensitive ((sb.flags & Buffer_Dirty) && (sb.flags & Buffer_HasFile));
661 LuaWindow::script_changed () {
662 if (_current_buffer->flags & Buffer_Dirty) {
665 _current_buffer->flags |= Buffer_Dirty;
669 LuaWindow::ScriptBuffer::ScriptBuffer (const std::string& n)
671 , flags (Buffer_Scratch | Buffer_Valid)
674 "---- this header is (only) required to save the script\n"
675 "-- ardour { [\"type\"] = \"Snippet\", name = \"\" }\n"
676 "-- function factory () return function () -- -- end end\n";
679 LuaWindow::ScriptBuffer::ScriptBuffer (LuaScriptInfoPtr p)
682 , flags (Buffer_HasFile)
685 if (!PBD::exists_and_writable (path)) {
686 flags |= Buffer_ReadOnly;
688 if (path.find (user_config_directory ()) != 0) {
689 // mark non-user scripts as read-only
690 flags |= Buffer_ReadOnly;
695 LuaWindow::ScriptBuffer::ScriptBuffer (const ScriptBuffer& other)
696 : script (other.script)
699 , flags (other.flags)
705 LuaWindow::ScriptBuffer::~ScriptBuffer ()
710 LuaWindow::ScriptBuffer::load ()
712 assert (!(flags & Buffer_Valid));
713 if (!(flags & Buffer_HasFile)) return false;
715 script = Glib::file_get_contents (path);
716 flags |= Buffer_Valid;
717 flags &= BufferFlags(~Buffer_Dirty);
718 } catch (Glib::FileError e) {