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))
94 , _btn_clear (_("Clear Outtput"))
95 , _btn_open (_("Import"))
96 , _btn_save (_("Save"))
97 , _btn_delete (_("Delete"))
103 set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
105 script_select.disable_scrolling ();
107 set_border_width (0);
109 outtext.set_editable (false);
110 outtext.set_wrap_mode (Gtk::WRAP_WORD);
111 outtext.set_cursor_visible (false);
113 signal_delete_event().connect (sigc::mem_fun (*this, &LuaWindow::hide_window));
114 signal_configure_event().connect (sigc::mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
116 _btn_run.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::run_script));
117 _btn_clear.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::clear_output));
118 _btn_open.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::import_script));
119 _btn_save.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::save_script));
120 _btn_delete.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::delete_script));
122 _btn_open.set_sensitive (false); // TODO
123 _btn_save.set_sensitive (false);
124 _btn_delete.set_sensitive (false);
128 Gtk::ScrolledWindow *scrollin = manage (new Gtk::ScrolledWindow);
129 scrollin->set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
130 scrollin->add (entry);
131 scrollout.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_ALWAYS);
132 scrollout.add (outtext);
134 Gtk::HBox *hbox = manage (new HBox());
136 hbox->pack_start (_btn_run, false, false, 2);
137 hbox->pack_start (_btn_clear, false, false, 2);
138 hbox->pack_start (_btn_open, false, false, 2);
139 hbox->pack_start (_btn_save, false, false, 2);
140 hbox->pack_start (_btn_delete, false, false, 2);
141 hbox->pack_start (script_select, false, false, 2);
143 Gtk::VBox *vbox = manage (new VBox());
144 vbox->pack_start (*scrollin, true, true, 0);
145 vbox->pack_start (*hbox, false, false, 2);
147 Gtk::VPaned *vpane = manage (new Gtk::VPaned ());
148 vpane->pack1 (*vbox, true, false);
149 vpane->pack2 (scrollout, false, true);
153 set_size_request (640, 480); // XXX
155 lua.Print.connect (sigc::mem_fun (*this, &LuaWindow::append_text));
157 lua_State* L = lua.getState();
158 LuaInstance::register_classes (L);
159 luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
160 lua_setglobal (L, "Editor");
162 ARDOUR_UI_UTILS::set_tooltip (script_select, _("Select Editor Buffer"));
165 LuaScripting::instance().scripts_changed.connect (*this, invalidator (*this), boost::bind (&LuaWindow::refresh_scriptlist, this), gui_context());
167 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
168 _script_changed_connection = tb->signal_changed().connect (sigc::mem_fun(*this, &LuaWindow::script_changed));
171 LuaWindow::~LuaWindow ()
176 LuaWindow::show_window ()
183 LuaWindow::hide_window (GdkEventAny *ev)
185 if (!_visible) return 0;
187 return just_hide_it (ev, static_cast<Gtk::Window *>(this));
190 void LuaWindow::set_session (Session* s)
192 SessionHandlePtr::set_session (s);
198 _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&LuaWindow::update_title, this), gui_context());
200 lua_State* L = lua.getState();
201 LuaBindings::set_session (L, _session);
205 LuaWindow::session_going_away ()
207 ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
208 lua.do_command ("collectgarbage();");
209 //TODO: re-init lua-engine (drop all references)
211 SessionHandlePtr::session_going_away ();
215 lua_State* L = lua.getState();
216 LuaBindings::set_session (L, _session);
220 LuaWindow::update_title ()
225 if (_session->snap_name() != _session->name()) {
226 n = _session->snap_name ();
228 n = _session->name ();
231 if (_session->dirty ()) {
235 WindowTitle title (n);
236 title += S_("Window|Lua");
237 title += Glib::get_application_name ();
238 set_title (title.get_string());
241 WindowTitle title (S_("Window|Lua"));
242 title += Glib::get_application_name ();
243 set_title (title.get_string());
248 LuaWindow::scroll_to_bottom ()
250 Gtk::Adjustment *adj;
251 adj = scrollout.get_vadjustment();
252 adj->set_value (MAX(0,(adj->get_upper() - adj->get_page_size())));
256 LuaWindow::run_script ()
258 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
259 std::string script = tb->get_text();
260 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
261 if (bytecode.empty()) {
262 // plain script or faulty script -- run directly
264 lua.do_command ("function ardour () end");
265 if (0 == lua.do_command (script)) {
266 append_text ("> OK");
268 } catch (luabridge::LuaException const& e) {
269 append_text (string_compose (_("LuaException: %1"), e.what()));
272 // script with factory method
274 lua_State* L = lua.getState();
275 lua.do_command ("function ardour () end");
277 LuaScriptParamList args = LuaScriptParams::script_params (script, "action_param", false);
278 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
279 LuaScriptParams::params_to_ref (&tbl_arg, args);
280 lua.do_command (script); // register "factory"
281 luabridge::LuaRef lua_factory = luabridge::getGlobal (L, "factory");
282 if (lua_factory.isFunction()) {
283 lua_factory(tbl_arg)();
285 lua.do_command ("factory = nil;");
286 } catch (luabridge::LuaException const& e) {
287 append_text (string_compose (_("LuaException: %1"), e.what()));
293 LuaWindow::append_text (std::string s)
295 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
296 tb->insert (tb->end(), s + "\n");
301 LuaWindow::clear_output ()
303 Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
308 LuaWindow::new_script ()
311 snprintf (buf, sizeof (buf), "#%d", count_scratch_buffers () + 1);
312 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer (buf)));
313 script_selection_changed (script_buffers.back ());
314 refresh_scriptlist ();
318 LuaWindow::delete_script ()
320 assert (_current_buffer->flags & Buffer_Scratch);
321 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
322 if ((*i) == _current_buffer) {
323 script_buffers.erase (i);
328 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
329 if ((*i)->flags & Buffer_Scratch) {
330 script_selection_changed (*i);
338 LuaWindow::import_script ()
340 // TODO: dialog to select file or enter URL
341 // TODO convert a few URL (eg. pastebin) to raw.
343 char *url = "http://pastebin.com/raw/3UMkZ6nV";
344 char *rv = a3_curl_http_get (url, 0);
347 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
349 _current_buffer->flags &= BufferFlags(~Buffer_Dirty);
357 LuaWindow::save_script ()
359 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
360 std::string script = tb->get_text();
361 std::string msg = "Unknown error";
364 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
365 ScriptBuffer & sb (*_current_buffer);
367 assert (sb.flags & Buffer_Dirty);
369 // 1) check if it has a valid header and factory
370 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
371 if (bytecode.empty()) {
372 msg = _("Missing script header.\nThe script requires an '{ardour}' info table and a 'factory' function.");
376 if (!LuaScripting::try_compile (script, LuaScriptParams::script_params (script, "action_param", false))) {
377 msg = _("Script fails to compile.");
381 // 2) check script name & type
382 lsi = LuaScripting::script_info (script);
384 msg = _("Invalid or missing script-name or script-type.");
388 if (lsi->type != LuaScriptInfo::Snippet && lsi->type != LuaScriptInfo::EditorAction) {
389 msg = _("Invalid script-type.\nValid types are 'EditorAction' and 'Snippet'.");
393 // 3) if there's already a writable file,...
394 if ((sb.flags & Buffer_HasFile) && !(sb.flags & Buffer_ReadOnly)) {
396 Glib::file_set_contents (sb.path, script);
397 sb.flags &= BufferFlags(~Buffer_Dirty);
398 update_gui_state (); // XXX here?
399 append_text (X_("> ") + string_compose (_("Saved as %1"), sb.path));
401 } catch (Glib::FileError e) {
402 msg = string_compose (_("Error saving file: %1"), e.what());
407 // 4) check if the name is unique for the given type; locally at least
408 if (true /*sb.flags & Buffer_HasFile*/) {
409 LuaScriptList& lsl (LuaScripting::instance ().scripts (lsi->type));
410 for (LuaScriptList::const_iterator s = lsl.begin(); s != lsl.end(); ++s) {
411 if ((*s)->name == lsi->name) {
412 msg = string_compose (_("Script with given name '%1' already exists.\nUse a different name in the descriptor."), lsi->name);
418 // 5) construct filename -- TODO ask user for name, ask to replace file.
422 struct tm * timeinfo = localtime (&t);
423 strftime (buf, sizeof(buf), "%s%d", timeinfo);
424 sprintf (buf, "%s%ld", buf, random ()); // is this valid?
426 std::string fn = md5.digestString (buf);
429 case LuaScriptInfo::EditorAction:
432 case LuaScriptInfo::Snippet:
438 path = Glib::build_filename (LuaScripting::user_script_dir (), fn.substr(0, 11) + ".lua");
439 } while (Glib::file_test (path, Glib::FILE_TEST_EXISTS));
442 Glib::file_set_contents (path, script);
444 sb.flags |= Buffer_HasFile;
445 sb.flags &= BufferFlags(~Buffer_Dirty);
446 update_gui_state (); // XXX here?
447 LuaScripting::instance().refresh (true);
448 append_text (X_("> ") + string_compose (_("Saved as %1"), path));
450 } catch (Glib::FileError e) {
451 msg = string_compose (_("Error saving file: %1"), e.what());
456 MessageDialog am (msg);
461 LuaWindow::setup_buffers ()
463 if (script_buffers.size() > 0) {
466 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer("#1")));
467 _current_buffer = script_buffers.front();
469 refresh_scriptlist ();
474 LuaWindow::count_scratch_buffers () const
477 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
478 if ((*i)->flags & Buffer_Scratch) {
486 LuaWindow::refresh_scriptlist ()
488 for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end ();) {
489 if ((*i)->flags & Buffer_Scratch) {
493 i = script_buffers.erase (i);
495 LuaScriptList& lsa (LuaScripting::instance ().scripts (LuaScriptInfo::EditorAction));
496 for (LuaScriptList::const_iterator s = lsa.begin(); s != lsa.end(); ++s) {
497 script_buffers.push_back (ScriptBufferPtr ( new LuaWindow::ScriptBuffer(*s)));
500 LuaScriptList& lss (LuaScripting::instance ().scripts (LuaScriptInfo::Snippet));
501 for (LuaScriptList::const_iterator s = lss.begin(); s != lss.end(); ++s) {
502 script_buffers.push_back (ScriptBufferPtr ( new LuaWindow::ScriptBuffer(*s)));
508 LuaWindow::rebuild_menu ()
510 using namespace Menu_Helpers;
512 _menu_scratch = manage (new Menu);
513 _menu_snippet = manage (new Menu);
514 _menu_actions = manage (new Menu);
516 MenuList& items_scratch (_menu_scratch->items());
517 MenuList& items_snippet (_menu_snippet->items());
518 MenuList& items_actions (_menu_actions->items());
521 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(_("New"),
522 sigc::mem_fun(*this, &LuaWindow::new_script));
523 items_scratch.push_back(elem);
526 for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
527 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem((*i)->name,
528 sigc::bind(sigc::mem_fun(*this, &LuaWindow::script_selection_changed), (*i)));
530 if ((*i)->flags & Buffer_Scratch) {
531 items_scratch.push_back(elem);
533 else if ((*i)->type == LuaScriptInfo::EditorAction) {
534 items_actions.push_back(elem);
536 else if ((*i)->type == LuaScriptInfo::Snippet) {
537 items_snippet.push_back(elem);
541 script_select.clear_items ();
542 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Scratch", *_menu_scratch));
543 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Snippets", *_menu_snippet));
544 script_select.AddMenuElem (Menu_Helpers::MenuElem ("Actions", *_menu_actions));
548 LuaWindow::script_selection_changed (ScriptBufferPtr n)
550 if (n == _current_buffer) {
554 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
555 _current_buffer->script = tb->get_text();
557 if (!(n->flags & Buffer_Valid)) {
559 append_text ("! Failed to load buffer.");
563 if (n->flags & Buffer_Valid) {
565 _script_changed_connection.block ();
566 tb->set_text (n->script);
567 _script_changed_connection.unblock ();
569 append_text ("! Failed to switch buffer.");
575 LuaWindow::update_gui_state ()
577 const ScriptBuffer & sb (*_current_buffer);
579 if (sb.flags & Buffer_Scratch) {
580 name = string_compose (_("Scratch Buffer %1"), sb.name);
581 } else if (sb.type == LuaScriptInfo::EditorAction) {
582 name = string_compose (_("Action: '%1'"), sb.name);
583 } else if (sb.type == LuaScriptInfo::Snippet) {
584 name = string_compose (_("Snippet: %1"), sb.name);
586 cerr << "Invalid Script type\n";
590 if (sb.flags & Buffer_Dirty) {
593 script_select.set_text(name);
595 _btn_save.set_sensitive (sb.flags & Buffer_Dirty);
596 _btn_delete.set_sensitive (sb.flags & Buffer_Scratch); // TODO allow to remove user-scripts
600 LuaWindow::script_changed () {
601 if (_current_buffer->flags & Buffer_Dirty) {
604 _current_buffer->flags |= Buffer_Dirty;
608 LuaWindow::ScriptBuffer::ScriptBuffer (const std::string& n)
610 , flags (Buffer_Scratch | Buffer_Valid)
614 LuaWindow::ScriptBuffer::ScriptBuffer (LuaScriptInfoPtr p)
617 , flags (Buffer_HasFile)
620 if (!PBD::exists_and_writable (path)) {
621 flags |= Buffer_ReadOnly;
626 LuaWindow::ScriptBuffer::ScriptBuffer (const ScriptBuffer& other)
627 : script (other.script)
630 , flags (other.flags)
636 LuaWindow::ScriptBuffer::~ScriptBuffer ()
641 LuaWindow::ScriptBuffer::load ()
643 if (!(flags & Buffer_HasFile)) return false;
644 if (flags & Buffer_Valid) return true;
646 script = Glib::file_get_contents (path);
647 flags |= Buffer_Valid;
648 } catch (Glib::FileError e) {