mp4chaps Lua script: don't clutter global environment
[ardour.git] / gtk2_ardour / luainstance.cc
index b7963737ccc606ef4d6def4b55ec5c5d045579a9..8d7d972d04e9a218ad3a47b537d7e369c44e7cf9 100644 (file)
@@ -27,6 +27,7 @@
 #include "ardour/plugin_manager.h"
 #include "ardour/route.h"
 #include "ardour/session.h"
+#include "ardour/system_exec.h"
 
 #include "LuaBridge/LuaBridge.h"
 
@@ -34,6 +35,7 @@
 #include "ardour_ui.h"
 #include "public_editor.h"
 #include "region_selection.h"
+#include "luadialog.h"
 #include "luainstance.h"
 #include "luasignal.h"
 #include "marker.h"
@@ -369,12 +371,76 @@ namespace LuaMixer {
 
 ////////////////////////////////////////////////////////////////////////////////
 
+static PBD::ScopedConnectionList _luaexecs;
+
+static void reaper (ARDOUR::SystemExec* x)
+{
+       delete x;
+}
+
+static int
+lua_forkexec (lua_State *L)
+{
+       int argc = lua_gettop (L);
+       if (argc == 0) {
+               return luaL_argerror (L, 1, "invalid number of arguments, forkexec (command, ...)");
+       }
+       // args are free()ed in ~SystemExec
+       char** args = (char**) malloc ((argc + 1) * sizeof(char*));
+       for (int i = 0; i < argc; ++i) {
+               args[i] = strdup (luaL_checkstring (L, i + 1));
+       }
+       args[argc] = 0;
+
+       ARDOUR::SystemExec* x = new ARDOUR::SystemExec (args[0], args);
+       x->Terminated.connect (_luaexecs, MISSING_INVALIDATOR, boost::bind (&reaper, x), gui_context());
+
+       if (x->start()) {
+               reaper (x);
+               luabridge::Stack<bool>::push (L, false);
+               return -1;
+       } else {
+               luabridge::Stack<bool>::push (L, false);
+       }
+       return 1;
+}
+
+#ifndef PLATFORM_WINDOWS
+static int
+lua_exec (std::string cmd)
+{
+       // args are free()ed in ~SystemExec
+       char** args = (char**) malloc (4 * sizeof(char*));
+       args[0] = strdup ("/bin/sh");
+       args[1] = strdup ("-c");
+       args[2] = strdup (cmd.c_str());
+       args[3] = 0;
+       ARDOUR::SystemExec x ("/bin/sh", args);
+       if (x.start()) {
+               return -1;
+       }
+       x.wait ();
+       return 0;
+}
+#endif
+////////////////////////////////////////////////////////////////////////////////
+
+// ARDOUR_UI and instance() are not exposed.
+ARDOUR::PresentationInfo::order_t
+lua_translate_order (RouteDialogs::InsertAt place)
+{
+       return ARDOUR_UI::instance()->translate_order (place);
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
 #define xstr(s) stringify(s)
 #define stringify(s) #s
 
 using namespace ARDOUR;
 
 PBD::Signal0<void> LuaInstance::LuaTimerDS;
+PBD::Signal0<void> LuaInstance::SetSession;
 
 void
 LuaInstance::register_hooks (lua_State* L)
@@ -396,6 +462,10 @@ LuaInstance::register_hooks (lua_State* L)
                .beginStdBitSet <LuaSignal::LAST_SIGNAL> ("Set")
                .endClass()
                .endNamespace ();
+
+#if 0 // Dump size -> libs/ardour/luabindings.cc
+       printf ("LuaInstance: registered %d signals\n", LuaSignal::LAST_SIGNAL);
+#endif
 }
 
 void
@@ -548,6 +618,51 @@ LuaInstance::bind_cairo (lua_State* L)
 
 }
 
+void
+LuaInstance::bind_dialog (lua_State* L)
+{
+       luabridge::getGlobalNamespace (L)
+               .beginNamespace ("LuaDialog")
+
+               .beginClass <LuaDialog::Message> ("Message")
+               .addConstructor <void (*) (std::string const&, std::string const&, LuaDialog::Message::MessageType, LuaDialog::Message::ButtonType)> ()
+               .addFunction ("run", &LuaDialog::Message::run)
+               .endClass ()
+
+               .beginClass <LuaDialog::Dialog> ("Dialog")
+               .addConstructor <void (*) (std::string const&, luabridge::LuaRef)> ()
+               .addCFunction ("run", &LuaDialog::Dialog::run)
+               .endClass ()
+
+               /* enums */
+               .beginNamespace ("MessageType")
+               .addConst ("Info", LuaDialog::Message::Info)
+               .addConst ("Warning", LuaDialog::Message::Warning)
+               .addConst ("Question", LuaDialog::Message::Question)
+               .addConst ("Error", LuaDialog::Message::Error)
+               .endNamespace ()
+
+               .beginNamespace ("ButtonType")
+               .addConst ("OK", LuaDialog::Message::OK)
+               .addConst ("Close", LuaDialog::Message::Close)
+               .addConst ("Cancel", LuaDialog::Message::Cancel)
+               .addConst ("Yes_No", LuaDialog::Message::Yes_No)
+               .addConst ("OK_Cancel", LuaDialog::Message::OK_Cancel)
+               .endNamespace ()
+
+               .beginNamespace ("Response")
+               .addConst ("OK", 0)
+               .addConst ("Cancel", 1)
+               .addConst ("Close", 2)
+               .addConst ("Yes", 3)
+               .addConst ("No", 4)
+               .addConst ("None", -1)
+               .endNamespace ()
+
+               .endNamespace ();
+
+}
+
 void
 LuaInstance::register_classes (lua_State* L)
 {
@@ -557,7 +672,7 @@ LuaInstance::register_classes (lua_State* L)
        LuaBindings::osc (L);
 
        bind_cairo (L);
-       register_hooks (L);
+       bind_dialog (L);
 
        luabridge::getGlobalNamespace (L)
                .beginNamespace ("ArdourUI")
@@ -581,6 +696,9 @@ LuaInstance::register_classes (lua_State* L)
                .deriveClass <TimeAxisView, AxisView> ("TimeAxisView")
                .endClass ()
 
+               .deriveClass <StripableTimeAxisView, TimeAxisView> ("StripableTimeAxisView")
+               .endClass ()
+
                .beginClass <Selectable> ("Selectable")
                .endClass ()
 
@@ -594,7 +712,8 @@ LuaInstance::register_classes (lua_State* L)
                .endClass ()
 
                .deriveClass <RouteTimeAxisView, RouteUI> ("RouteTimeAxisView")
-               .addCast<TimeAxisView> ("to_timeaxisview")
+               .addCast<StripableTimeAxisView> ("to_stripabletimeaxisview")
+               .addCast<TimeAxisView> ("to_timeaxisview") // deprecated
                .endClass ()
 
                // std::list<Selectable*>
@@ -717,6 +836,8 @@ LuaInstance::register_classes (lua_State* L)
 #endif
                .addFunction ("hide_track_in_display", &PublicEditor::hide_track_in_display)
                .addFunction ("show_track_in_display", &PublicEditor::show_track_in_display)
+               .addFunction ("set_visible_track_count", &PublicEditor::set_visible_track_count)
+               .addFunction ("fit_selection", &PublicEditor::fit_selection)
 
                .addFunction ("regionview_from_region", &PublicEditor::regionview_from_region)
                .addFunction ("set_stationary_playhead", &PublicEditor::set_stationary_playhead)
@@ -764,7 +885,7 @@ LuaInstance::register_classes (lua_State* L)
                .addFunction ("drags", &PublicEditor::drags)
 #endif
 
-               .addFunction ("get_route_view_by_route_id", &PublicEditor::get_route_view_by_route_id)
+               .addFunction ("get_stripable_time_axis_by_id", &PublicEditor::get_stripable_time_axis_by_id)
                .addFunction ("get_track_views", &PublicEditor::get_track_views)
                .addFunction ("rtav_from_route", &PublicEditor::rtav_from_route)
                .addFunction ("axis_views_from_routes", &PublicEditor::axis_views_from_routes)
@@ -793,9 +914,19 @@ LuaInstance::register_classes (lua_State* L)
 #endif
 
                .addFunction ("access_action", &PublicEditor::access_action)
+               .addFunction ("set_toggleaction", &PublicEditor::set_toggleaction)
                .endClass ()
 
+               .addFunction ("translate_order", &lua_translate_order)
+
                /* ArdourUI enums */
+               .beginNamespace ("InsertAt")
+               .addConst ("BeforeSelection", RouteDialogs::InsertAt(RouteDialogs::BeforeSelection))
+               .addConst ("AfterSelection", RouteDialogs::InsertAt(RouteDialogs::AfterSelection))
+               .addConst ("First", RouteDialogs::InsertAt(RouteDialogs::First))
+               .addConst ("Last", RouteDialogs::InsertAt(RouteDialogs::Last))
+               .endNamespace ()
+
                .beginNamespace ("MarkerType")
                .addConst ("Mark", ArdourMarker::Type(ArdourMarker::Mark))
                .addConst ("Tempo", ArdourMarker::Type(ArdourMarker::Tempo))
@@ -817,7 +948,14 @@ LuaInstance::register_classes (lua_State* L)
                .addConst ("Add", Selection::Operation(Selection::Add))
                .endNamespace ()
 
-               .endNamespace (); // end ArdourUI
+               .endNamespace () // end ArdourUI
+
+               .beginNamespace ("os")
+#ifndef PLATFORM_WINDOWS
+               .addFunction ("execute", &lua_exec)
+#endif
+               .addCFunction ("forkexec", &lua_forkexec)
+               .endNamespace ();
 
        // Editing Symbols
 
@@ -905,6 +1043,7 @@ LuaInstance::~LuaInstance ()
 void
 LuaInstance::init ()
 {
+       lua.sandbox (false);
        lua.do_command (
                        "function ScriptManager ()"
                        "  local self = { scripts = {}, instances = {}, icons = {} }"
@@ -922,7 +1061,7 @@ LuaInstance::init ()
                        "   assert(type(f) == 'function', 'Factory is a not a function')"
                        "   assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
                        "   self.scripts[i] = { ['n'] = n, ['s'] = s, ['f'] = f, ['a'] = a, ['c'] = c }"
-                       "   local env = _ENV;  env.f = nil env.debug = nil os.exit = nil require = nil dofile = nil loadfile = nil package = nil"
+                       "   local env = _ENV; env.f = nil"
                        "   self.instances[i] = load (string.dump(f, true), nil, nil, env)(a)"
                        "   if type(c) == 'function' then"
                        "     self.icons[i] = load (string.dump(c, true), nil, nil, env)(a)"
@@ -977,7 +1116,6 @@ LuaInstance::init ()
                        ""
                        "  local function serialize (name, value)"
                        "   local rv = name .. ' = '"
-                       "   collectgarbage()"
                        "   if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
                        "    return rv .. basic_serialize(value) .. ' '"
                        "   elseif type(value) == \"table\" then"
@@ -985,7 +1123,6 @@ LuaInstance::init ()
                        "    for k,v in pairs(value) do"
                        "     local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
                        "     rv = rv .. serialize(fieldname, v) .. ' '"
-                       "     collectgarbage()" // string concatenation allocates a new string
                        "    end"
                        "    return rv;"
                        "   elseif type(value) == \"function\" then"
@@ -1025,7 +1162,6 @@ LuaInstance::init ()
                        " manager = ScriptManager ()"
                        " ScriptManager = nil"
                        );
-
        lua_State* L = lua.getState();
 
        try {
@@ -1043,6 +1179,11 @@ LuaInstance::init ()
                _lua_clear = new luabridge::LuaRef(lua_mgr["clear"]);
 
        } catch (luabridge::LuaException const& e) {
+               fatal << string_compose (_("programming error: %1"),
+                               std::string ("Failed to setup Lua action interpreter") + e.what ())
+                       << endmsg;
+               abort(); /*NOTREACHED*/
+       } catch (...) {
                fatal << string_compose (_("programming error: %1"),
                                X_("Failed to setup Lua action interpreter"))
                        << endmsg;
@@ -1050,6 +1191,7 @@ LuaInstance::init ()
        }
 
        register_classes (L);
+       register_hooks (L);
 
        luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
        lua_setglobal (L, "Editor");
@@ -1069,6 +1211,7 @@ void LuaInstance::set_session (Session* s)
                i->second->set_session (s);
        }
        point_one_second_connection = Timers::rapid_connect (sigc::mem_fun(*this, & LuaInstance::every_point_one_seconds));
+       SetSession (); /* EMIT SIGNAL */
 }
 
 void
@@ -1098,7 +1241,6 @@ LuaInstance::every_point_one_seconds ()
 int
 LuaInstance::set_state (const XMLNode& node)
 {
-       LocaleGuard lg;
        XMLNode* child;
 
        if ((child = find_named_node (node, "ActionScript"))) {
@@ -1110,7 +1252,7 @@ LuaInstance::set_state (const XMLNode& node)
                                (*_lua_load)(std::string ((const char*)buf, size));
                        } catch (luabridge::LuaException const& e) {
                                cerr << "LuaException:" << e.what () << endl;
-                       }
+                       } catch (...) { }
                        for (int i = 0; i < 9; ++i) {
                                std::string name;
                                if (lua_action_name (i, name)) {
@@ -1130,7 +1272,7 @@ LuaInstance::set_state (const XMLNode& node)
                                SlotChanged (p->id(), p->name(), p->signals()); /* EMIT SIGNAL */
                        } catch (luabridge::LuaException const& e) {
                                cerr << "LuaException:" << e.what () << endl;
-                       }
+                       } catch (...) { }
                }
        }
 
@@ -1190,11 +1332,14 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
        LuaScriptParamList lsp = LuaScriptParams::script_params (spi, param_function);
 
        ScriptParameterDialog spd (_("Set Script Parameters"), spi, reg, lsp);
-       switch (spd.run ()) {
-               case Gtk::RESPONSE_ACCEPT:
-                       break;
-               default:
-                       return false;
+
+       if (!spd.need_interation ()) {
+               switch (spd.run ()) {
+                       case Gtk::RESPONSE_ACCEPT:
+                               break;
+                       default:
+                               return false;
+               }
        }
 
        LuaScriptParamPtr lspp (new LuaScriptParam("x-script-origin", "", spi->path, false));
@@ -1218,6 +1363,10 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
                                string msg = string_compose (_("Loading Session script '%1' failed: %2"), spd.name(), e.what ());
                                Gtk::MessageDialog am (msg);
                                am.run ();
+                       } catch (...) {
+                               string msg = string_compose (_("Loading Session script '%1' failed: %2"), spd.name(), "Unknown Exception");
+                               Gtk::MessageDialog am (msg);
+                               am.run ();
                        }
                default:
                        break;
@@ -1228,7 +1377,6 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
 XMLNode&
 LuaInstance::get_action_state ()
 {
-       LocaleGuard lg;
        std::string saved;
        {
                luabridge::LuaRef savedstate ((*_lua_save)());
@@ -1241,7 +1389,7 @@ LuaInstance::get_action_state ()
        g_free (b64);
 
        XMLNode* script_node = new XMLNode (X_("ActionScript"));
-       script_node->add_property (X_("lua"), LUA_VERSION);
+       script_node->set_property (X_("lua"), LUA_VERSION);
        script_node->add_content (b64s);
 
        return *script_node;
@@ -1265,7 +1413,7 @@ LuaInstance::call_action (const int id)
                lua.collect_garbage_step ();
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
-       }
+       } catch (...) { }
 }
 
 void
@@ -1282,7 +1430,7 @@ LuaInstance::render_icon (int i, cairo_t* cr, int w, int h, uint32_t clr)
                 (*_lua_render_icon)(i + 1, (Cairo::Context *)&ctx, w, h, clr);
         } catch (luabridge::LuaException const& e) {
                 cerr << "LuaException:" << e.what () << endl;
-        }
+        } catch (...) { }
 }
 
 bool
@@ -1308,6 +1456,8 @@ LuaInstance::set_lua_action (
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
                return false;
+       } catch (...) {
+               return false;
        }
        _session->set_dirty ();
        return true;
@@ -1321,6 +1471,8 @@ LuaInstance::remove_lua_action (const int id)
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
                return false;
+       } catch (...) {
+               return false;
        }
        ActionChanged (id, ""); /* EMIT SIGNAL */
        _session->set_dirty ();
@@ -1342,8 +1494,7 @@ LuaInstance::lua_action_name (const int id, std::string& rv)
                return true;
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
-               return false;
-       }
+       } catch (...) { }
        return false;
 }
 
@@ -1373,7 +1524,7 @@ LuaInstance::lua_action_has_icon (const int id)
                }
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
-       }
+       } catch (...) { }
        return false;
 }
 
@@ -1408,8 +1559,7 @@ LuaInstance::lua_action (const int id, std::string& name, std::string& script, L
                return true;
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
-               return false;
-       }
+       } catch (...) { }
        return false;
 }
 
@@ -1421,6 +1571,7 @@ LuaInstance::register_lua_slot (const std::string& name, const std::string& scri
        try {
                LuaState l;
                l.Print.connect (&_lua_print);
+               l.sandbox (true);
                lua_State* L = l.getState();
                register_hooks (L);
                l.do_command ("function ardour () end");
@@ -1431,7 +1582,7 @@ LuaInstance::register_lua_slot (const std::string& name, const std::string& scri
                }
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
-       }
+       } catch (...) { }
 
        if (ah.none ()) {
                cerr << "Script registered no hooks." << endl;
@@ -1448,7 +1599,7 @@ LuaInstance::register_lua_slot (const std::string& name, const std::string& scri
                return true;
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
-       }
+       } catch (...) { }
        _session->set_dirty ();
        return false;
 }
@@ -1534,11 +1685,13 @@ LuaCallback::LuaCallback (Session *s,
        }
 
        try {
-       const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
-       (*_lua_add)(name, script, bytecode, tbl_arg);
+               const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
+               (*_lua_add)(name, script, bytecode, tbl_arg);
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
                throw failed_constructor ();
+       } catch (...) {
+               throw failed_constructor ();
        }
 
        _id.reset ();
@@ -1577,7 +1730,7 @@ LuaCallback::LuaCallback (Session *s, XMLNode & node)
                (*_lua_load)(std::string ((const char*)buf, size));
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
-       }
+       } catch (...) { }
        g_free (buf);
 
        set_session (s);
@@ -1600,17 +1753,25 @@ LuaCallback::get_state (void)
                luabridge::LuaRef savedstate ((*_lua_save)());
                saved = savedstate.cast<std::string>();
        }
-       lua.collect_garbage ();
+
+       lua.collect_garbage (); // this may be expensive:
+       /* Editor::instant_save() calls Editor::get_state() which
+        * calls LuaInstance::get_hook_state() which in turn calls
+        * this LuaCallback::get_state() for every registered hook.
+        *
+        * serialize in _lua_save() allocates many small strings
+        * on the lua-stack, collecting them all may take a ms.
+        */
 
        gchar* b64 = g_base64_encode ((const guchar*)saved.c_str (), saved.size ());
        std::string b64s (b64);
        g_free (b64);
 
        XMLNode* script_node = new XMLNode (X_("LuaCallback"));
-       script_node->add_property (X_("lua"), LUA_VERSION);
-       script_node->add_property (X_("id"), _id.to_s ());
-       script_node->add_property (X_("name"), _name);
-       script_node->add_property (X_("signals"), _signals.to_string ());
+       script_node->set_property (X_("lua"), LUA_VERSION);
+       script_node->set_property (X_("id"), _id.to_s ());
+       script_node->set_property (X_("name"), _name);
+       script_node->set_property (X_("signals"), _signals.to_string ());
        script_node->add_content (b64s);
        return *script_node;
 }
@@ -1619,6 +1780,7 @@ void
 LuaCallback::init (void)
 {
        lua.Print.connect (&_lua_print);
+       lua.sandbox (false);
 
        lua.do_command (
                        "function ScriptManager ()"
@@ -1630,7 +1792,7 @@ LuaCallback::init (void)
                        "   assert(type(f) == 'function', 'Factory is a not a function')"
                        "   assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
                        "   self.script = { ['n'] = n, ['s'] = s, ['f'] = f, ['a'] = a }"
-                       "   local env = _ENV;  env.f = nil env.debug = nil os.exit = nil require = nil dofile = nil loadfile = nil package = nil"
+                       "   local env = _ENV; env.f = nil"
                        "   self.instance = load (string.dump(f, true), nil, nil, env)(a)"
                        "  end"
                        ""
@@ -1676,7 +1838,6 @@ LuaCallback::init (void)
                        ""
                        "  local function serialize (name, value)"
                        "   local rv = name .. ' = '"
-                       "   collectgarbage()"
                        "   if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
                        "    return rv .. basic_serialize(value) .. ' '"
                        "   elseif type(value) == \"table\" then"
@@ -1684,7 +1845,6 @@ LuaCallback::init (void)
                        "    for k,v in pairs(value) do"
                        "     local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
                        "     rv = rv .. serialize(fieldname, v) .. ' '"
-                       "     collectgarbage()" // string concatenation allocates a new string
                        "    end"
                        "    return rv;"
                        "   elseif type(value) == \"function\" then"
@@ -1730,6 +1890,11 @@ LuaCallback::init (void)
                _lua_load = new luabridge::LuaRef(lua_mgr["restore"]);
 
        } catch (luabridge::LuaException const& e) {
+               fatal << string_compose (_("programming error: %1"),
+                               std::string ("Failed to setup Lua callback interpreter: ") + e.what ())
+                       << endmsg;
+               abort(); /*NOTREACHED*/
+       } catch (...) {
                fatal << string_compose (_("programming error: %1"),
                                X_("Failed to setup Lua callback interpreter"))
                        << endmsg;
@@ -1737,6 +1902,7 @@ LuaCallback::init (void)
        }
 
        LuaInstance::register_classes (L);
+       LuaInstance::register_hooks (L);
 
        luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
        lua_setglobal (L, "Editor");
@@ -1777,7 +1943,7 @@ LuaCallback::lua_slot (std::string& name, std::string& script, ActionHook& ah, A
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
                return false;
-       }
+       } catch (...) { }
        return false;
 }