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"))
105 set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
107 script_select.disable_scrolling ();
109 set_border_width (0);
111 outtext.set_editable (false);
112 outtext.set_wrap_mode (Gtk::WRAP_WORD);
113 outtext.set_cursor_visible (false);
115 signal_delete_event().connect (sigc::mem_fun (*this, &LuaWindow::hide_window));
116 signal_configure_event().connect (sigc::mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
118 _btn_run.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::run_script));
119 _btn_clear.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::clear_output));
120 _btn_open.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::import_script));
121 _btn_save.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::save_script));
122 _btn_delete.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::delete_script));
124 _btn_open.set_sensitive (false); // TODO
125 _btn_save.set_sensitive (false);
126 _btn_delete.set_sensitive (false);
130 Gtk::ScrolledWindow *scrollin = manage (new Gtk::ScrolledWindow);
131 scrollin->set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
132 scrollin->add (entry);
133 scrollout.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_ALWAYS);
134 scrollout.add (outtext);
136 Gtk::HBox *hbox = manage (new HBox());
138 hbox->pack_start (_btn_run, false, false, 2);
139 hbox->pack_start (_btn_clear, false, false, 2);
140 hbox->pack_start (_btn_open, false, false, 2);
141 hbox->pack_start (_btn_save, false, false, 2);
142 hbox->pack_start (_btn_delete, false, false, 2);
143 hbox->pack_start (script_select, false, false, 2);
145 Gtk::VBox *vbox = manage (new VBox());
146 vbox->pack_start (*scrollin, true, true, 0);
147 vbox->pack_start (*hbox, false, false, 2);
149 Gtk::VPaned *vpane = manage (new Gtk::VPaned ());
150 vpane->pack1 (*vbox, true, false);
151 vpane->pack2 (scrollout, false, true);
155 set_size_request (640, 480); // XXX
156 ARDOUR_UI_UTILS::set_tooltip (script_select, _("Select Editor Buffer"));
159 LuaScripting::instance().scripts_changed.connect (*this, invalidator (*this), boost::bind (&LuaWindow::refresh_scriptlist, this), gui_context());
161 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
162 _script_changed_connection = tb->signal_changed().connect (sigc::mem_fun(*this, &LuaWindow::script_changed));
165 LuaWindow::~LuaWindow ()
171 LuaWindow::show_window ()
178 LuaWindow::hide_window (GdkEventAny *ev)
180 if (!_visible) return 0;
182 return just_hide_it (ev, static_cast<Gtk::Window *>(this));
185 void LuaWindow::reinit_lua ()
188 lua = new LuaState();
189 lua->Print.connect (sigc::mem_fun (*this, &LuaWindow::append_text));
191 lua_State* L = lua->getState();
192 LuaInstance::register_classes (L);
193 luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
194 lua_setglobal (L, "Editor");
199 void LuaWindow::set_session (Session* s)
201 SessionHandlePtr::set_session (s);
207 _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&LuaWindow::update_title, this), gui_context());
209 lua_State* L = lua->getState();
210 LuaBindings::set_session (L, _session);
214 LuaWindow::session_going_away ()
216 ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
217 reinit_lua (); // drop state (all variables, session references)
219 SessionHandlePtr::session_going_away ();
223 lua_State* L = lua->getState();
224 LuaBindings::set_session (L, _session);
228 LuaWindow::update_title ()
233 if (_session->snap_name() != _session->name()) {
234 n = _session->snap_name ();
236 n = _session->name ();
239 if (_session->dirty ()) {
243 WindowTitle title (n);
244 title += S_("Window|Lua");
245 title += Glib::get_application_name ();
246 set_title (title.get_string());
249 WindowTitle title (S_("Window|Lua"));
250 title += Glib::get_application_name ();
251 set_title (title.get_string());
256 LuaWindow::scroll_to_bottom ()
258 Gtk::Adjustment *adj;
259 adj = scrollout.get_vadjustment();
260 adj->set_value (MAX(0,(adj->get_upper() - adj->get_page_size())));
264 LuaWindow::run_script ()
266 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
267 std::string script = tb->get_text();
268 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
269 if (bytecode.empty()) {
270 // plain script or faulty script -- run directly
272 lua->do_command ("function ardour () end");
273 if (0 == lua->do_command (script)) {
274 append_text ("> OK");
276 } catch (luabridge::LuaException const& e) {
277 append_text (string_compose (_("LuaException: %1"), e.what()));
280 // script with factory method
282 lua_State* L = lua->getState();
283 lua->do_command ("function ardour () end");
285 LuaScriptParamList args = LuaScriptParams::script_params (script, "action_param", false);
286 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
287 LuaScriptParams::params_to_ref (&tbl_arg, args);
288 lua->do_command (script); // register "factory"
289 luabridge::LuaRef lua_factory = luabridge::getGlobal (L, "factory");
290 if (lua_factory.isFunction()) {
291 lua_factory(tbl_arg)();
293 lua->do_command ("factory = nil;");
294 } catch (luabridge::LuaException const& e) {
295 append_text (string_compose (_("LuaException: %1"), e.what()));
301 LuaWindow::append_text (std::string s)
303 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
304 tb->insert (tb->end(), s + "\n");
309 LuaWindow::clear_output ()
311 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
316 LuaWindow::new_script ()
319 snprintf (buf, sizeof (buf), "#%d", count_scratch_buffers () + 1);
320 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer (buf)));
321 script_selection_changed (script_buffers.back ());
322 refresh_scriptlist ();
326 LuaWindow::delete_script ()
328 assert (_current_buffer->flags & Buffer_Scratch);
329 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
330 if ((*i) == _current_buffer) {
331 script_buffers.erase (i);
336 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
337 if ((*i)->flags & Buffer_Scratch) {
338 script_selection_changed (*i);
346 LuaWindow::import_script ()
348 // TODO: dialog to select file or enter URL
349 // TODO convert a few URL (eg. pastebin) to raw.
351 char *url = "http://pastebin.com/raw/3UMkZ6nV";
352 char *rv = a3_curl_http_get (url, 0);
355 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
357 _current_buffer->flags &= BufferFlags(~Buffer_Dirty);
365 LuaWindow::save_script ()
367 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
368 std::string script = tb->get_text();
369 std::string msg = "Unknown error";
372 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
373 ScriptBuffer & sb (*_current_buffer);
375 assert (sb.flags & Buffer_Dirty);
377 // 1) check if it has a valid header and factory
378 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
379 if (bytecode.empty()) {
380 msg = _("Missing script header.\nThe script requires an '{ardour}' info table and a 'factory' function.");
384 if (!LuaScripting::try_compile (script, LuaScriptParams::script_params (script, "action_param", false))) {
385 msg = _("Script fails to compile.");
389 // 2) check script name & type
390 lsi = LuaScripting::script_info (script);
392 msg = _("Invalid or missing script-name or script-type.");
396 if (lsi->type != LuaScriptInfo::Snippet && lsi->type != LuaScriptInfo::EditorAction) {
397 msg = _("Invalid script-type.\nValid types are 'EditorAction' and 'Snippet'.");
401 // 3) if there's already a writable file,...
402 if ((sb.flags & Buffer_HasFile) && !(sb.flags & Buffer_ReadOnly)) {
404 Glib::file_set_contents (sb.path, script);
405 sb.flags &= BufferFlags(~Buffer_Dirty);
406 update_gui_state (); // XXX here?
407 append_text (X_("> ") + string_compose (_("Saved as %1"), sb.path));
409 } catch (Glib::FileError e) {
410 msg = string_compose (_("Error saving file: %1"), e.what());
415 // 4) check if the name is unique for the given type; locally at least
416 if (true /*sb.flags & Buffer_HasFile*/) {
417 LuaScriptList& lsl (LuaScripting::instance ().scripts (lsi->type));
418 for (LuaScriptList::const_iterator s = lsl.begin(); s != lsl.end(); ++s) {
419 if ((*s)->name == lsi->name) {
420 msg = string_compose (_("Script with given name '%1' already exists.\nUse a different name in the descriptor."), lsi->name);
426 // 5) construct filename -- TODO ask user for name, ask to replace file.
430 struct tm * timeinfo = localtime (&t);
431 strftime (buf, sizeof(buf), "%s%d", timeinfo);
432 sprintf (buf, "%s%ld", buf, random ()); // is this valid?
434 std::string fn = md5.digestString (buf);
437 case LuaScriptInfo::EditorAction:
440 case LuaScriptInfo::Snippet:
446 path = Glib::build_filename (LuaScripting::user_script_dir (), fn.substr(0, 11) + ".lua");
447 } while (Glib::file_test (path, Glib::FILE_TEST_EXISTS));
450 Glib::file_set_contents (path, script);
452 sb.flags |= Buffer_HasFile;
453 sb.flags &= BufferFlags(~Buffer_Dirty);
454 update_gui_state (); // XXX here?
455 LuaScripting::instance().refresh (true);
456 append_text (X_("> ") + string_compose (_("Saved as %1"), path));
458 } catch (Glib::FileError e) {
459 msg = string_compose (_("Error saving file: %1"), e.what());
464 MessageDialog am (msg);
469 LuaWindow::setup_buffers ()
471 if (script_buffers.size() > 0) {
474 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer("#1")));
475 _current_buffer = script_buffers.front();
477 refresh_scriptlist ();
482 LuaWindow::count_scratch_buffers () const
485 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
486 if ((*i)->flags & Buffer_Scratch) {
494 LuaWindow::refresh_scriptlist ()
496 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end ();) {
497 if ((*i)->flags & Buffer_Scratch) {
501 i = script_buffers.erase (i);
503 LuaScriptList& lsa (LuaScripting::instance ().scripts (LuaScriptInfo::EditorAction));
504 for (LuaScriptList::const_iterator s = lsa.begin(); s != lsa.end(); ++s) {
505 script_buffers.push_back (ScriptBufferPtr ( new LuaWindow::ScriptBuffer(*s)));
508 LuaScriptList& lss (LuaScripting::instance ().scripts (LuaScriptInfo::Snippet));
509 for (LuaScriptList::const_iterator s = lss.begin(); s != lss.end(); ++s) {
510 script_buffers.push_back (ScriptBufferPtr ( new LuaWindow::ScriptBuffer(*s)));
516 LuaWindow::rebuild_menu ()
518 using namespace Menu_Helpers;
520 _menu_scratch = manage (new Menu);
521 _menu_snippet = manage (new Menu);
522 _menu_actions = manage (new Menu);
524 MenuList& items_scratch (_menu_scratch->items());
525 MenuList& items_snippet (_menu_snippet->items());
526 MenuList& items_actions (_menu_actions->items());
529 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(_("New"),
530 sigc::mem_fun(*this, &LuaWindow::new_script));
531 items_scratch.push_back(elem);
534 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
535 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem((*i)->name,
536 sigc::bind(sigc::mem_fun(*this, &LuaWindow::script_selection_changed), (*i)));
538 if ((*i)->flags & Buffer_Scratch) {
539 items_scratch.push_back(elem);
541 else if ((*i)->type == LuaScriptInfo::EditorAction) {
542 items_actions.push_back(elem);
544 else if ((*i)->type == LuaScriptInfo::Snippet) {
545 items_snippet.push_back(elem);
549 script_select.clear_items ();
550 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Scratch", *_menu_scratch));
551 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Snippets", *_menu_snippet));
552 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Actions", *_menu_actions));
556 LuaWindow::script_selection_changed (ScriptBufferPtr n)
558 if (n == _current_buffer) {
562 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
563 _current_buffer->script = tb->get_text();
565 if (!(n->flags & Buffer_Valid)) {
567 append_text ("! Failed to load buffer.");
571 if (n->flags & Buffer_Valid) {
573 _script_changed_connection.block ();
574 tb->set_text (n->script);
575 _script_changed_connection.unblock ();
577 append_text ("! Failed to switch buffer.");
583 LuaWindow::update_gui_state ()
585 const ScriptBuffer & sb (*_current_buffer);
587 if (sb.flags & Buffer_Scratch) {
588 name = string_compose (_("Scratch Buffer %1"), sb.name);
589 } else if (sb.type == LuaScriptInfo::EditorAction) {
590 name = string_compose (_("Action: '%1'"), sb.name);
591 } else if (sb.type == LuaScriptInfo::Snippet) {
592 name = string_compose (_("Snippet: %1"), sb.name);
594 cerr << "Invalid Script type\n";
598 if (sb.flags & Buffer_Dirty) {
601 script_select.set_text(name);
603 _btn_save.set_sensitive (sb.flags & Buffer_Dirty);
604 _btn_delete.set_sensitive (sb.flags & Buffer_Scratch); // TODO allow to remove user-scripts
608 LuaWindow::script_changed () {
609 if (_current_buffer->flags & Buffer_Dirty) {
612 _current_buffer->flags |= Buffer_Dirty;
616 LuaWindow::ScriptBuffer::ScriptBuffer (const std::string& n)
618 , flags (Buffer_Scratch | Buffer_Valid)
622 LuaWindow::ScriptBuffer::ScriptBuffer (LuaScriptInfoPtr p)
625 , flags (Buffer_HasFile)
628 if (!PBD::exists_and_writable (path)) {
629 flags |= Buffer_ReadOnly;
634 LuaWindow::ScriptBuffer::ScriptBuffer (const ScriptBuffer& other)
635 : script (other.script)
638 , flags (other.flags)
644 LuaWindow::ScriptBuffer::~ScriptBuffer ()
649 LuaWindow::ScriptBuffer::load ()
651 if (!(flags & Buffer_HasFile)) return false;
652 if (flags & Buffer_Valid) return true;
654 script = Glib::file_get_contents (path);
655 flags |= Buffer_Valid;
656 } catch (Glib::FileError e) {