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 "widgets/pane.h"
41 #include "widgets/tooltips.h"
43 #include "ardour/filesystem_paths.h"
44 #include "ardour/luabindings.h"
45 #include "LuaBridge/LuaBridge.h"
47 #include "ardour_ui.h"
48 #include "gui_thread.h"
49 #include "luainstance.h"
50 #include "luawindow.h"
51 #include "public_editor.h"
53 #include "utils_videotl.h"
57 using namespace ARDOUR;
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 ArdourWidgets::VPane *vpane = manage (new ArdourWidgets::VPane ());
161 vpane->add (scrollout);
162 vpane->set_divider (0, 0.75);
166 set_size_request (640, 480); // XXX
167 ArdourWidgets::set_tooltip (script_select, _("Select Editor Buffer"));
170 LuaScripting::instance().scripts_changed.connect (*this, invalidator (*this), boost::bind (&LuaWindow::refresh_scriptlist, this), gui_context());
172 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
173 _script_changed_connection = tb->signal_changed().connect (sigc::mem_fun(*this, &LuaWindow::script_changed));
176 LuaWindow::~LuaWindow ()
182 LuaWindow::show_window ()
189 LuaWindow::hide_window (GdkEventAny *ev)
191 if (!_visible) return 0;
193 return ARDOUR_UI_UTILS::just_hide_it (ev, static_cast<Gtk::Window *>(this));
196 void LuaWindow::reinit_lua ()
198 ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
200 lua = new LuaState();
201 lua->Print.connect (sigc::mem_fun (*this, &LuaWindow::append_text));
203 lua_State* L = lua->getState();
204 LuaInstance::register_classes (L);
205 luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
206 lua_setglobal (L, "Editor");
209 void LuaWindow::set_session (Session* s)
211 SessionHandlePtr::set_session (s);
217 _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&LuaWindow::update_title, this), gui_context());
219 lua_State* L = lua->getState();
220 LuaBindings::set_session (L, _session);
224 LuaWindow::session_going_away ()
226 ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
227 reinit_lua (); // drop state (all variables, session references)
229 SessionHandlePtr::session_going_away ();
233 lua_State* L = lua->getState();
234 LuaBindings::set_session (L, _session);
238 LuaWindow::update_title ()
243 if (_session->snap_name() != _session->name()) {
244 n = _session->snap_name ();
246 n = _session->name ();
249 if (_session->dirty ()) {
253 WindowTitle title (n);
254 title += S_("Window|Lua");
255 title += Glib::get_application_name ();
256 set_title (title.get_string());
259 WindowTitle title (S_("Window|Lua"));
260 title += Glib::get_application_name ();
261 set_title (title.get_string());
266 LuaWindow::scroll_to_bottom ()
268 Gtk::Adjustment *adj;
269 adj = scrollout.get_vadjustment();
270 adj->set_value (MAX(0,(adj->get_upper() - adj->get_page_size())));
274 LuaWindow::run_script ()
276 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
277 std::string script = tb->get_text();
278 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
279 if (bytecode.empty()) {
280 // plain script or faulty script -- run directly
282 lua->do_command ("function ardour () end");
283 if (0 == lua->do_command (script)) {
284 append_text ("> OK");
286 } catch (luabridge::LuaException const& e) {
287 append_text (string_compose (_("LuaException: %1"), e.what()));
290 // script with factory method
292 lua_State* L = lua->getState();
293 lua->do_command ("function ardour () end");
295 LuaScriptParamList args = LuaScriptParams::script_params (script, "action_param", false);
296 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
297 LuaScriptParams::params_to_ref (&tbl_arg, args);
298 lua->do_command (script); // register "factory"
299 luabridge::LuaRef lua_factory = luabridge::getGlobal (L, "factory");
300 if (lua_factory.isFunction()) {
301 lua_factory(tbl_arg)();
303 lua->do_command ("factory = nil;");
304 } catch (luabridge::LuaException const& e) {
305 append_text (string_compose (_("LuaException: %1"), e.what()));
311 LuaWindow::append_text (std::string s)
313 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
314 tb->insert (tb->end(), s + "\n");
316 Gtkmm2ext::UI::instance()->flush_pending (0.05);
320 LuaWindow::clear_output ()
322 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
327 LuaWindow::edit_script (const std::string& name, const std::string& script)
329 ScriptBuffer* sb = new LuaWindow::ScriptBuffer (name);
331 script_buffers.push_back (ScriptBufferPtr (sb));
332 script_selection_changed (script_buffers.back ());
333 refresh_scriptlist ();
338 LuaWindow::new_script ()
341 snprintf (buf, sizeof (buf), "#%d", count_scratch_buffers () + 1);
342 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer (buf)));
343 script_selection_changed (script_buffers.back ());
344 refresh_scriptlist ();
348 LuaWindow::delete_script ()
350 assert ((_current_buffer->flags & Buffer_Scratch) || !(_current_buffer->flags & Buffer_ReadOnly));
351 bool refresh = false;
353 if (_current_buffer->flags & Buffer_HasFile) {
354 if (0 == ::g_unlink (_current_buffer->path.c_str())) {
355 append_text (X_("> ") + string_compose (_("Deleted %1"), _current_buffer->path));
358 append_text (X_("> ") + string_compose (_("Failed to delete %1"), _current_buffer->path));
361 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
362 if ((*i) == _current_buffer) {
363 script_buffers.erase (i);
368 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
369 if ((*i)->flags & Buffer_Scratch) {
370 script_selection_changed (*i);
378 LuaScripting::instance ().refresh (true);
383 LuaWindow::revert_script ()
385 _current_buffer->flags &= BufferFlags(~Buffer_Valid);
386 script_selection_changed (_current_buffer, true);
390 LuaWindow::import_script ()
392 // TODO: dialog to select file or enter URL
393 // TODO convert a few URL (eg. pastebin) to raw.
395 char *url = "http://pastebin.com/raw/3UMkZ6nV";
396 char *rv = ArdourCurl::http_get (url, 0);
399 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
401 _current_buffer->flags &= BufferFlags(~Buffer_Dirty);
409 LuaWindow::save_script ()
411 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
412 std::string script = tb->get_text();
413 std::string msg = "Unknown error";
416 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
417 ScriptBuffer & sb (*_current_buffer);
419 assert (sb.flags & Buffer_Dirty);
421 // 1) check if it has a valid header and factory
422 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
423 if (bytecode.empty()) {
424 msg = _("Missing script header.\nThe script requires an '{ardour}' info table and a 'factory' function.");
428 if (!LuaScripting::try_compile (script, LuaScriptParams::script_params (script, "action_param", false))) {
429 msg = _("Script fails to compile.");
433 // 2) check script name & type
434 lsi = LuaScripting::script_info (script);
436 msg = _("Invalid or missing script-name or script-type.");
440 if (lsi->type != LuaScriptInfo::Snippet && lsi->type != LuaScriptInfo::EditorAction) {
441 msg = _("Invalid script-type.\nValid types are 'EditorAction' and 'Snippet'.");
445 // 3) if there's already a writable file,...
446 if ((sb.flags & Buffer_HasFile) && !(sb.flags & Buffer_ReadOnly)) {
448 Glib::file_set_contents (sb.path, script);
450 sb.flags &= BufferFlags(~Buffer_Dirty);
451 update_gui_state (); // XXX here?
452 append_text (X_("> ") + string_compose (_("Saved as %1"), sb.path));
454 } catch (Glib::FileError e) {
455 msg = string_compose (_("Error saving file: %1"), e.what());
460 // 4) check if the name is unique for the given type; locally at least
461 if (true /*sb.flags & Buffer_HasFile*/) {
462 LuaScriptList& lsl (LuaScripting::instance ().scripts (lsi->type));
463 for (LuaScriptList::const_iterator s = lsl.begin(); s != lsl.end(); ++s) {
464 if ((*s)->name == lsi->name) {
465 msg = string_compose (_("Script with given name '%1' already exists.\nUse a different name in the descriptor."), lsi->name);
471 // 5) construct filename -- TODO ask user for name, ask to replace file.
475 struct tm * timeinfo = localtime (&t);
476 strftime (buf, sizeof(buf), "%s%d", timeinfo);
477 sprintf (buf, "%s%ld", buf, random ()); // is this valid?
479 std::string fn = md5.digestString (buf);
482 case LuaScriptInfo::EditorAction:
485 case LuaScriptInfo::Snippet:
491 path = Glib::build_filename (LuaScripting::user_script_dir (), fn.substr(0, 11) + ".lua");
492 } while (Glib::file_test (path, Glib::FILE_TEST_EXISTS));
495 Glib::file_set_contents (path, script);
498 sb.flags |= Buffer_HasFile;
499 sb.flags &= BufferFlags(~Buffer_Dirty);
500 sb.flags &= BufferFlags(~Buffer_ReadOnly);
501 update_gui_state (); // XXX here? .refresh (true) may trigger this, too
502 LuaScripting::instance().refresh (true);
503 append_text (X_("> ") + string_compose (_("Saved as %1"), path));
505 } catch (Glib::FileError e) {
506 msg = string_compose (_("Error saving file: %1"), e.what());
511 MessageDialog am (msg);
516 LuaWindow::setup_buffers ()
518 if (script_buffers.size() > 0) {
521 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer("#1")));
522 _current_buffer = script_buffers.front();
524 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
525 tb->set_text (_current_buffer->script);
527 refresh_scriptlist ();
532 LuaWindow::count_scratch_buffers () const
535 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
536 if ((*i)->flags & Buffer_Scratch) {
544 LuaWindow::refresh_scriptlist ()
546 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end ();) {
547 if ((*i)->flags & Buffer_Scratch) {
551 i = script_buffers.erase (i);
553 LuaScriptList& lsa (LuaScripting::instance ().scripts (LuaScriptInfo::EditorAction));
554 for (LuaScriptList::const_iterator s = lsa.begin(); s != lsa.end(); ++s) {
555 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer(*s)));
558 LuaScriptList& lss (LuaScripting::instance ().scripts (LuaScriptInfo::Snippet));
559 for (LuaScriptList::const_iterator s = lss.begin(); s != lss.end(); ++s) {
560 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer(*s)));
566 LuaWindow::rebuild_menu ()
568 using namespace Menu_Helpers;
570 _menu_scratch = manage (new Menu);
571 _menu_snippet = manage (new Menu);
572 _menu_actions = manage (new Menu);
574 MenuList& items_scratch (_menu_scratch->items());
575 MenuList& items_snippet (_menu_snippet->items());
576 MenuList& items_actions (_menu_actions->items());
579 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(_("New"),
580 sigc::mem_fun(*this, &LuaWindow::new_script));
581 items_scratch.push_back(elem);
584 items_scratch.push_back(SeparatorElem());
586 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
588 if ((*i)->flags & Buffer_ReadOnly) {
589 name = "[R] " + (*i)->name;
593 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(name,
594 sigc::bind(sigc::mem_fun(*this, &LuaWindow::script_selection_changed), (*i), false));
596 if ((*i)->flags & Buffer_Scratch) {
597 items_scratch.push_back(elem);
599 else if ((*i)->type == LuaScriptInfo::EditorAction) {
600 items_actions.push_back(elem);
602 else if ((*i)->type == LuaScriptInfo::Snippet) {
603 items_snippet.push_back(elem);
607 script_select.clear_items ();
608 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Scratch", *_menu_scratch));
609 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Snippets", *_menu_snippet));
610 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Actions", *_menu_actions));
614 LuaWindow::script_selection_changed (ScriptBufferPtr n, bool force)
616 if (n == _current_buffer && !force) {
620 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
622 if (_current_buffer->flags & Buffer_Valid) {
623 _current_buffer->script = tb->get_text();
626 if (!(n->flags & Buffer_Valid)) {
628 append_text ("! Failed to load buffer.");
632 if (n->flags & Buffer_Valid) {
634 _script_changed_connection.block ();
635 tb->set_text (n->script);
636 _script_changed_connection.unblock ();
638 append_text ("! Failed to switch buffer.");
644 LuaWindow::update_gui_state ()
646 const ScriptBuffer & sb (*_current_buffer);
648 if (sb.flags & Buffer_Scratch) {
649 name = string_compose (_("Scratch Buffer %1"), sb.name);
650 } else if (sb.type == LuaScriptInfo::EditorAction) {
651 name = string_compose (_("Action: '%1'"), sb.name);
652 } else if (sb.type == LuaScriptInfo::Snippet) {
653 name = string_compose (_("Snippet: %1"), sb.name);
655 cerr << "Invalid Script type\n";
659 if (sb.flags & Buffer_Dirty) {
662 script_select.set_text(name);
664 if (sb.flags & Buffer_ReadOnly) {
665 _btn_save.set_text (_("Save as"));
667 _btn_save.set_text (_("Save"));
669 _btn_save.set_sensitive (sb.flags & Buffer_Dirty);
670 _btn_delete.set_sensitive (sb.flags & Buffer_Scratch || ((sb.flags & (Buffer_ReadOnly | Buffer_HasFile)) == Buffer_HasFile));
671 _btn_revert.set_sensitive ((sb.flags & Buffer_Dirty) && (sb.flags & Buffer_HasFile));
675 LuaWindow::script_changed () {
676 if (_current_buffer->flags & Buffer_Dirty) {
679 _current_buffer->flags |= Buffer_Dirty;
683 LuaWindow::ScriptBuffer::ScriptBuffer (const std::string& n)
685 , flags (Buffer_Scratch | Buffer_Valid)
688 "---- this header is (only) required to save the script\n"
689 "-- ardour { [\"type\"] = \"Snippet\", name = \"\" }\n"
690 "-- function factory () return function () -- -- end end\n";
693 LuaWindow::ScriptBuffer::ScriptBuffer (LuaScriptInfoPtr p)
696 , flags (Buffer_HasFile)
699 if (!PBD::exists_and_writable (path)) {
700 flags |= Buffer_ReadOnly;
702 if (path.find (user_config_directory ()) != 0) {
703 // mark non-user scripts as read-only
704 flags |= Buffer_ReadOnly;
709 LuaWindow::ScriptBuffer::ScriptBuffer (const ScriptBuffer& other)
710 : script (other.script)
713 , flags (other.flags)
719 LuaWindow::ScriptBuffer::~ScriptBuffer ()
724 LuaWindow::ScriptBuffer::load ()
726 assert (!(flags & Buffer_Valid));
727 if (!(flags & Buffer_HasFile)) return false;
729 script = Glib::file_get_contents (path);
730 flags |= Buffer_Valid;
731 flags &= BufferFlags(~Buffer_Dirty);
732 } catch (Glib::FileError e) {