Prefer testing the session instead of using a global variable
[ardour.git] / gtk2_ardour / luawindow.cc
index 3bc3a4741ea21c7c677d9eeae2b5f1e1ff431778..59ba451c6ddf7b5b16cecbdfce8053e3cc53b887 100644 (file)
@@ -25,6 +25,7 @@
 #include "gtk2ardour-config.h"
 #endif
 
+#include "pbd/gstdio_compat.h"
 #include <glibmm/fileutils.h>
 #include <gtkmm/messagedialog.h>
 
 #include "gtkmm2ext/utils.h"
 #include "gtkmm2ext/window_title.h"
 
+#include "widgets/pane.h"
+#include "widgets/tooltips.h"
+
+#include "ardour/filesystem_paths.h"
 #include "ardour/luabindings.h"
 #include "LuaBridge/LuaBridge.h"
 
 #include "luainstance.h"
 #include "luawindow.h"
 #include "public_editor.h"
-#include "tooltips.h"
 #include "utils.h"
+#include "ui_config.h"
 #include "utils_videotl.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
-using namespace ARDOUR_UI_UTILS;
 using namespace PBD;
 using namespace Gtk;
 using namespace Glib;
@@ -92,7 +96,7 @@ LuaWindow::LuaWindow ()
        , _menu_snippet (0)
        , _menu_actions (0)
        , _btn_run (_("Run"))
-       , _btn_clear (_("Clear Outtput"))
+       , _btn_clear (_("Clear Output"))
        , _btn_open (_("Import"))
        , _btn_save (_("Save"))
        , _btn_delete (_("Delete"))
@@ -105,6 +109,16 @@ LuaWindow::LuaWindow ()
        update_title ();
        set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
 
+#ifdef __APPLE__
+       set_type_hint (Gdk::WINDOW_TYPE_HINT_DIALOG);
+#else
+       if (UIConfiguration::instance().get_all_floating_windows_are_dialogs()) {
+               set_type_hint (Gdk::WINDOW_TYPE_HINT_DIALOG);
+       } else {
+               set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
+       }
+#endif
+
        script_select.disable_scrolling ();
 
        set_border_width (0);
@@ -153,14 +167,15 @@ LuaWindow::LuaWindow ()
        vbox->pack_start (*scrollin, true, true, 0);
        vbox->pack_start (*hbox, false, false, 2);
 
-       Gtk::VPaned *vpane = manage (new Gtk::VPaned ());
-       vpane->pack1 (*vbox, true, false);
-       vpane->pack2 (scrollout, false, true);
+       ArdourWidgets::VPane *vpane = manage (new ArdourWidgets::VPane ());
+       vpane->add (*vbox);
+       vpane->add (scrollout);
+       vpane->set_divider (0, 0.75);
 
        vpane->show_all ();
        add (*vpane);
        set_size_request (640, 480); // XXX
-       ARDOUR_UI_UTILS::set_tooltip (script_select, _("Select Editor Buffer"));
+       ArdourWidgets::set_tooltip (script_select, _("Select Editor Buffer"));
 
        setup_buffers ();
        LuaScripting::instance().scripts_changed.connect (*this, invalidator (*this), boost::bind (&LuaWindow::refresh_scriptlist, this), gui_context());
@@ -186,14 +201,16 @@ LuaWindow::hide_window (GdkEventAny *ev)
 {
        if (!_visible) return 0;
        _visible = false;
-       return just_hide_it (ev, static_cast<Gtk::Window *>(this));
+       return ARDOUR_UI_UTILS::just_hide_it (ev, static_cast<Gtk::Window *>(this));
 }
 
 void LuaWindow::reinit_lua ()
 {
+       ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
        delete lua;
        lua = new LuaState();
        lua->Print.connect (sigc::mem_fun (*this, &LuaWindow::append_text));
+       lua->sandbox (false);
 
        lua_State* L = lua->getState();
        LuaInstance::register_classes (L);
@@ -280,6 +297,12 @@ LuaWindow::run_script ()
                        }
                } catch (luabridge::LuaException const& e) {
                        append_text (string_compose (_("LuaException: %1"), e.what()));
+               } catch (Glib::Exception const& e) {
+                       append_text (string_compose (_("Glib Exception: %1"), e.what()));
+               } catch (std::exception const& e) {
+                       append_text (string_compose (_("C++ Exception: %1"), e.what()));
+               } catch (...) {
+                       append_text (string_compose (_("C++ Exception: %1"), "..."));
                }
        } else {
                // script with factory method
@@ -298,6 +321,12 @@ LuaWindow::run_script ()
                        lua->do_command ("factory = nil;");
                } catch (luabridge::LuaException const& e) {
                        append_text (string_compose (_("LuaException: %1"), e.what()));
+               } catch (Glib::Exception const& e) {
+                       append_text (string_compose (_("Glib Exception: %1"), e.what()));
+               } catch (std::exception const& e) {
+                       append_text (string_compose (_("C++ Exception: %1"), e.what()));
+               } catch (...) {
+                       append_text (string_compose (_("C++ Exception: %1"), "..."));
                }
        }
 }
@@ -308,6 +337,7 @@ LuaWindow::append_text (std::string s)
        Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
        tb->insert (tb->end(), s + "\n");
        scroll_to_bottom ();
+       Gtkmm2ext::UI::instance()->flush_pending (0.05);
 }
 
 void
@@ -317,6 +347,17 @@ LuaWindow::clear_output ()
        tb->set_text ("");
 }
 
+void
+LuaWindow::edit_script (const std::string& name, const std::string& script)
+{
+       ScriptBuffer* sb = new LuaWindow::ScriptBuffer (name);
+       sb->script = script;
+       script_buffers.push_back (ScriptBufferPtr (sb));
+       script_selection_changed (script_buffers.back ());
+       refresh_scriptlist ();
+       show_window ();
+}
+
 void
 LuaWindow::new_script ()
 {
@@ -330,7 +371,17 @@ LuaWindow::new_script ()
 void
 LuaWindow::delete_script ()
 {
-       assert (_current_buffer->flags & Buffer_Scratch);
+       assert ((_current_buffer->flags & Buffer_Scratch) || !(_current_buffer->flags & Buffer_ReadOnly));
+       bool refresh = false;
+       bool neednew = true;
+       if (_current_buffer->flags & Buffer_HasFile) {
+               if (0 == ::g_unlink (_current_buffer->path.c_str())) {
+                       append_text (X_("> ") + string_compose (_("Deleted %1"), _current_buffer->path));
+                       refresh = true;
+               } else {
+                       append_text (X_("> ") + string_compose (_("Failed to delete %1"), _current_buffer->path));
+               }
+       }
        for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
                if ((*i) == _current_buffer) {
                        script_buffers.erase (i);
@@ -341,10 +392,15 @@ LuaWindow::delete_script ()
        for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
                if ((*i)->flags & Buffer_Scratch) {
                        script_selection_changed (*i);
-                       return;
+                       neednew = false;
                }
        }
-       new_script ();
+       if (neednew) {
+               new_script ();
+       }
+       if (refresh) {
+               LuaScripting::instance ().refresh (true);
+       }
 }
 
 void
@@ -361,7 +417,7 @@ LuaWindow::import_script ()
        // TODO convert a few URL (eg. pastebin) to raw.
 #if 0
        char *url = "http://pastebin.com/raw/3UMkZ6nV";
-       char *rv = a3_curl_http_get (url, 0);
+       char *rv = ArdourCurl::http_get (url, 0. true);
        if (rv) {
                new_script ();
                Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
@@ -414,11 +470,12 @@ LuaWindow::save_script ()
        if ((sb.flags & Buffer_HasFile) && !(sb.flags & Buffer_ReadOnly)) {
                try {
                        Glib::file_set_contents (sb.path, script);
+                       sb.name = lsi->name;
                        sb.flags &= BufferFlags(~Buffer_Dirty);
                        update_gui_state (); // XXX here?
                        append_text (X_("> ") + string_compose (_("Saved as %1"), sb.path));
                        return; // OK
-               } catch (Glib::FileError e) {
+               } catch (Glib::FileError const& e) {
                        msg = string_compose (_("Error saving file: %1"), e.what());
                        goto errorout;
                }
@@ -437,11 +494,12 @@ LuaWindow::save_script ()
 
        // 5) construct filename -- TODO ask user for name, ask to replace file.
        do {
+               char tme[80];
                char buf[80];
                time_t t = time(0);
                struct tm * timeinfo = localtime (&t);
-               strftime (buf, sizeof(buf), "%s%d", timeinfo);
-               sprintf (buf, "%s%ld", buf, random ()); // is this valid?
+               strftime (tme, sizeof(tme), "%s", timeinfo);
+               snprintf (buf, sizeof(buf), "%s%ld", tme, random ());
                MD5 md5;
                std::string fn = md5.digestString (buf);
 
@@ -461,13 +519,15 @@ LuaWindow::save_script ()
        try {
                Glib::file_set_contents (path, script);
                sb.path = path;
+               sb.name = lsi->name;
                sb.flags |= Buffer_HasFile;
                sb.flags &= BufferFlags(~Buffer_Dirty);
-               update_gui_state (); // XXX here?
+               sb.flags &= BufferFlags(~Buffer_ReadOnly);
+               update_gui_state (); // XXX here? .refresh (true) may trigger this, too
                LuaScripting::instance().refresh (true);
                append_text (X_("> ") + string_compose (_("Saved as %1"), path));
                return; // OK
-       } catch (Glib::FileError e) {
+       } catch (Glib::FileError const& e) {
                msg = string_compose (_("Error saving file: %1"), e.what());
                goto errorout;
        }
@@ -517,12 +577,12 @@ LuaWindow::refresh_scriptlist ()
        }
        LuaScriptList& lsa (LuaScripting::instance ().scripts (LuaScriptInfo::EditorAction));
        for (LuaScriptList::const_iterator s = lsa.begin(); s != lsa.end(); ++s) {
-               script_buffers.push_back (ScriptBufferPtr ( new LuaWindow::ScriptBuffer(*s)));
+               script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer(*s)));
        }
 
        LuaScriptList& lss (LuaScripting::instance ().scripts (LuaScriptInfo::Snippet));
        for (LuaScriptList::const_iterator s = lss.begin(); s != lss.end(); ++s) {
-               script_buffers.push_back (ScriptBufferPtr ( new LuaWindow::ScriptBuffer(*s)));
+               script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer(*s)));
        }
        rebuild_menu ();
 }
@@ -546,8 +606,16 @@ LuaWindow::rebuild_menu ()
                items_scratch.push_back(elem);
        }
 
+       items_scratch.push_back(SeparatorElem());
+
        for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
-               Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem((*i)->name,
+               std::string name;
+               if ((*i)->flags & Buffer_ReadOnly) {
+                       name = "[R] " + (*i)->name;
+               } else {
+                       name = (*i)->name;
+               }
+               Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(name,
                                sigc::bind(sigc::mem_fun(*this, &LuaWindow::script_selection_changed), (*i), false));
 
                if ((*i)->flags & Buffer_Scratch) {
@@ -576,7 +644,7 @@ LuaWindow::script_selection_changed (ScriptBufferPtr n, bool force)
 
        Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
 
-       if ((n->flags & Buffer_Valid)) {
+       if (_current_buffer->flags & Buffer_Valid) {
                _current_buffer->script = tb->get_text();
        }
 
@@ -618,8 +686,13 @@ LuaWindow::update_gui_state ()
        }
        script_select.set_text(name);
 
+       if (sb.flags & Buffer_ReadOnly) {
+               _btn_save.set_text (_("Save as"));
+       } else {
+               _btn_save.set_text (_("Save"));
+       }
        _btn_save.set_sensitive (sb.flags & Buffer_Dirty);
-       _btn_delete.set_sensitive (sb.flags & Buffer_Scratch); // TODO allow to remove user-scripts
+       _btn_delete.set_sensitive (sb.flags & Buffer_Scratch || ((sb.flags & (Buffer_ReadOnly | Buffer_HasFile)) == Buffer_HasFile));
        _btn_revert.set_sensitive ((sb.flags & Buffer_Dirty) && (sb.flags & Buffer_HasFile));
 }
 
@@ -637,6 +710,7 @@ LuaWindow::ScriptBuffer::ScriptBuffer (const std::string& n)
        , flags (Buffer_Scratch | Buffer_Valid)
 {
        script =
+               "---- this header is (only) required to save the script\n"
                "-- ardour { [\"type\"] = \"Snippet\", name = \"\" }\n"
                "-- function factory () return function () -- -- end end\n";
 }
@@ -650,6 +724,10 @@ LuaWindow::ScriptBuffer::ScriptBuffer (LuaScriptInfoPtr p)
        if (!PBD::exists_and_writable (path)) {
                flags |= Buffer_ReadOnly;
        }
+       if (path.find (user_config_directory ()) != 0) {
+               // mark non-user scripts as read-only
+               flags |= Buffer_ReadOnly;
+       }
 }
 
 #if 0
@@ -670,12 +748,13 @@ LuaWindow::ScriptBuffer::~ScriptBuffer ()
 bool
 LuaWindow::ScriptBuffer::load ()
 {
+       assert (!(flags & Buffer_Valid));
        if (!(flags & Buffer_HasFile)) return false;
-       if (flags & Buffer_Valid) return true;
        try {
                script = Glib::file_get_contents (path);
                flags |= Buffer_Valid;
-       } catch (Glib::FileError e) {
+               flags &= BufferFlags(~Buffer_Dirty);
+       } catch (Glib::FileError const& e) {
                return false;
        }
        return true;