Fix generic-midi controllable race-condition
[ardour.git] / gtk2_ardour / luainstance.cc
index 156ad11d349e4a277885944f6c1fe0bd7f490dc6..a3349165396d916ed42ce0aac6349feeaf8ede79 100644 (file)
 #include <cairomm/surface.h>
 #include <pango/pangocairo.h>
 
+#include "pbd/file_utils.h"
+#include "pbd/strsplit.h"
+
+#include "gtkmm2ext/bindings.h"
 #include "gtkmm2ext/gui_thread.h"
 
 #include "ardour/audioengine.h"
 #include "ardour/disk_reader.h"
 #include "ardour/disk_writer.h"
+#include "ardour/filesystem_paths.h"
 #include "ardour/plugin_manager.h"
 #include "ardour/route.h"
 #include "ardour/session.h"
@@ -51,6 +56,8 @@
 
 #include "pbd/i18n.h"
 
+static const char* ui_scripts_file_name = "ui_scripts";
+
 namespace LuaCairo {
 /** wrap RefPtr< Cairo::ImageSurface >
  *
@@ -360,6 +367,8 @@ const char *luasignalstr[] = {
 }; // namespace
 
 
+static std::string http_get_unlogged (const std::string& url) { return ArdourCurl::http_get (url, false); }
+
 /** special cases for Ardour's Mixer UI */
 namespace LuaMixer {
 
@@ -424,6 +433,63 @@ lua_exec (std::string cmd)
        return 0;
 }
 #endif
+
+////////////////////////////////////////////////////////////////////////////////
+
+static int
+lua_actionlist (lua_State *L)
+{
+       using namespace std;
+
+       vector<string> paths;
+       vector<string> labels;
+       vector<string> tooltips;
+       vector<string> keys;
+       vector<Glib::RefPtr<Gtk::Action> > actions;
+       ActionManager::get_all_actions (paths, labels, tooltips, keys, actions);
+
+       vector<string>::iterator p;
+       vector<string>::iterator l;
+
+       luabridge::LuaRef action_tbl (luabridge::newTable (L));
+
+       for (l = labels.begin(), p = paths.begin(); l != labels.end(); ++p, ++l) {
+               if (l->empty ()) {
+                       continue;
+               }
+
+               vector<string> parts;
+               split (*p, parts, '/');
+
+               if (parts.empty()) {
+                       continue;
+               }
+
+               //kinda kludgy way to avoid displaying menu items as mappable
+               if (parts[1] == _("Main_menu"))
+                       continue;
+               if (parts[1] == _("JACK"))
+                       continue;
+               if (parts[1] == _("redirectmenu"))
+                       continue;
+               if (parts[1] == _("RegionList"))
+                       continue;
+               if (parts[1] == _("ProcessorMenu"))
+                       continue;
+
+               if (!action_tbl[parts[1]].isTable()) {
+                       action_tbl[parts[1]] = luabridge::newTable (L);
+               }
+               assert (action_tbl[parts[1]].isTable());
+               luabridge::LuaRef tbl (action_tbl[parts[1]]);
+               assert (tbl.isTable());
+               tbl[*l] = *p;
+       }
+
+       luabridge::push (L, action_tbl);
+       return 1;
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 
 // ARDOUR_UI and instance() are not exposed.
@@ -440,6 +506,7 @@ lua_translate_order (RouteDialogs::InsertAt place)
 
 using namespace ARDOUR;
 
+PBD::Signal0<void> LuaInstance::LuaTimerS;
 PBD::Signal0<void> LuaInstance::LuaTimerDS;
 PBD::Signal0<void> LuaInstance::SetSession;
 
@@ -678,7 +745,7 @@ LuaInstance::register_classes (lua_State* L)
        luabridge::getGlobalNamespace (L)
                .beginNamespace ("ArdourUI")
 
-               .addFunction ("http_get", (std::string (*)(const std::string&))&ArdourCurl::http_get)
+               .addFunction ("http_get", &http_get_unlogged)
 
                .addFunction ("processor_selection", &LuaMixer::processor_selection)
 
@@ -768,10 +835,9 @@ LuaInstance::register_classes (lua_State* L)
                .endClass ()
 
                .beginClass <PublicEditor> ("Editor")
-               .addFunction ("snap_type", &PublicEditor::snap_type)
+               .addFunction ("grid_type", &PublicEditor::grid_type)
                .addFunction ("snap_mode", &PublicEditor::snap_mode)
                .addFunction ("set_snap_mode", &PublicEditor::set_snap_mode)
-               .addFunction ("set_snap_threshold", &PublicEditor::set_snap_threshold)
 
                .addFunction ("undo", &PublicEditor::undo)
                .addFunction ("redo", &PublicEditor::redo)
@@ -800,8 +866,7 @@ LuaInstance::register_classes (lua_State* L)
                .addFunction ("add_location_from_playhead_cursor", &PublicEditor::add_location_from_playhead_cursor)
                .addFunction ("remove_location_at_playhead_cursor", &PublicEditor::remove_location_at_playhead_cursor)
 
-               .addFunction ("set_show_measures", &PublicEditor::set_show_measures)
-               .addFunction ("show_measures", &PublicEditor::show_measures)
+               .addFunction ("update_grid", &PublicEditor::update_grid)
                .addFunction ("remove_tracks", &PublicEditor::remove_tracks)
 
                .addFunction ("set_loop_range", &PublicEditor::set_loop_range)
@@ -949,6 +1014,8 @@ LuaInstance::register_classes (lua_State* L)
                .addConst ("Add", Selection::Operation(Selection::Add))
                .endNamespace ()
 
+               .addCFunction ("actionlist", &lua_actionlist)
+
                .endNamespace () // end ArdourUI
 
                .beginNamespace ("os")
@@ -961,7 +1028,7 @@ LuaInstance::register_classes (lua_State* L)
        // Editing Symbols
 
 #undef ZOOMFOCUS
-#undef SNAPTYPE
+#undef GRIDTYPE
 #undef SNAPMODE
 #undef MOUSEMODE
 #undef DISPLAYCONTROL
@@ -970,7 +1037,7 @@ LuaInstance::register_classes (lua_State* L)
 #undef IMPORTDISPOSITION
 
 #define ZOOMFOCUS(NAME) .addConst (stringify(NAME), (Editing::ZoomFocus)Editing::NAME)
-#define SNAPTYPE(NAME) .addConst (stringify(NAME), (Editing::SnapType)Editing::NAME)
+#define GRIDTYPE(NAME) .addConst (stringify(NAME), (Editing::GridType)Editing::NAME)
 #define SNAPMODE(NAME) .addConst (stringify(NAME), (Editing::SnapMode)Editing::NAME)
 #define MOUSEMODE(NAME) .addConst (stringify(NAME), (Editing::MouseMode)Editing::NAME)
 #define DISPLAYCONTROL(NAME) .addConst (stringify(NAME), (Editing::DisplayControl)Editing::NAME)
@@ -1023,8 +1090,6 @@ LuaInstance::LuaInstance ()
 {
        lua.Print.connect (&_lua_print);
        init ();
-
-       LuaScriptParamList args;
 }
 
 LuaInstance::~LuaInstance ()
@@ -1198,6 +1263,64 @@ LuaInstance::init ()
        lua_setglobal (L, "Editor");
 }
 
+int
+LuaInstance::load_state ()
+{
+       std::string uiscripts;
+       if (!find_file (ardour_config_search_path(), ui_scripts_file_name, uiscripts)) {
+               return -1;
+       }
+       XMLTree tree;
+
+       info << string_compose (_("Loading user ui scripts file %1"), uiscripts) << endmsg;
+
+       if (!tree.read (uiscripts)) {
+               error << string_compose(_("cannot read ui scripts file \"%1\""), uiscripts) << endmsg;
+               return -1;
+       }
+
+       if (set_state (*tree.root())) {
+               error << string_compose(_("user ui scripts file \"%1\" not loaded successfully."), uiscripts) << endmsg;
+               return -1;
+       }
+
+       return 0;
+}
+
+int
+LuaInstance::save_state ()
+{
+       if (!_session) {
+               /* action scripts are un-registered with the session */
+               return -1;
+       }
+
+       std::string uiscripts = Glib::build_filename (user_config_directory(), ui_scripts_file_name);
+
+       XMLNode* node = new XMLNode (X_("UIScripts"));
+       node->add_child_nocopy (get_action_state ());
+       node->add_child_nocopy (get_hook_state ());
+
+       XMLTree tree;
+       tree.set_root (node);
+
+       if (!tree.write (uiscripts.c_str())){
+               error << string_compose (_("UI script file %1 not saved"), uiscripts) << endmsg;
+               return -1;
+       }
+       return 0;
+}
+
+void
+LuaInstance::set_dirty ()
+{
+       if (!_session || _session->deletion_in_progress()) {
+               return;
+       }
+       save_state ();
+       _session->set_dirty (); // XXX is this reasonable?
+}
+
 void LuaInstance::set_session (Session* s)
 {
        SessionHandlePtr::set_session (s);
@@ -1205,12 +1328,15 @@ void LuaInstance::set_session (Session* s)
                return;
        }
 
+       load_state ();
+
        lua_State* L = lua.getState();
        LuaBindings::set_session (L, _session);
 
        for (LuaCallbackMap::iterator i = _callbacks.begin(); i != _callbacks.end(); ++i) {
                i->second->set_session (s);
        }
+       second_connection = Timers::rapid_connect (sigc::mem_fun(*this, & LuaInstance::every_second));
        point_one_second_connection = Timers::rapid_connect (sigc::mem_fun(*this, & LuaInstance::every_point_one_seconds));
        SetSession (); /* EMIT SIGNAL */
 }
@@ -1219,10 +1345,11 @@ void
 LuaInstance::session_going_away ()
 {
        ENSURE_GUI_THREAD (*this, &LuaInstance::session_going_away);
+       second_connection.disconnect ();
        point_one_second_connection.disconnect ();
 
        (*_lua_clear)();
-       for (int i = 0; i < 9; ++i) {
+       for (int i = 0; i < MAX_LUA_ACTION_SCRIPTS; ++i) {
                ActionChanged (i, ""); /* EMIT SIGNAL */
        }
        SessionHandlePtr::session_going_away ();
@@ -1233,6 +1360,12 @@ LuaInstance::session_going_away ()
        lua.do_command ("collectgarbage();");
 }
 
+void
+LuaInstance::every_second ()
+{
+       LuaTimerS (); // emit signal
+}
+
 void
 LuaInstance::every_point_one_seconds ()
 {
@@ -1254,7 +1387,7 @@ LuaInstance::set_state (const XMLNode& node)
                        } catch (luabridge::LuaException const& e) {
                                cerr << "LuaException:" << e.what () << endl;
                        } catch (...) { }
-                       for (int i = 0; i < 9; ++i) {
+                       for (int i = 0; i < MAX_LUA_ACTION_SCRIPTS; ++i) {
                                std::string name;
                                if (lua_action_name (i, name)) {
                                        ActionChanged (i, name); /* EMIT SIGNAL */
@@ -1264,6 +1397,7 @@ LuaInstance::set_state (const XMLNode& node)
                }
        }
 
+       assert (_callbacks.empty());
        if ((child = find_named_node (node, "ActionHooks"))) {
                for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
                        try {
@@ -1290,7 +1424,7 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
        switch (type) {
                case LuaScriptInfo::EditorAction:
                        reg = lua_action_names ();
-                       title = _("Add Lua Action");
+                       title = _("Add Shortcut or Lua Script");
                        break;
                case LuaScriptInfo::EditorHook:
                        reg = lua_slot_names ();
@@ -1330,11 +1464,20 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
                return false;
        }
 
-       LuaScriptParamList lsp = LuaScriptParams::script_params (spi, param_function);
+       LuaState ls;
+       register_classes (ls.getState ());
+       LuaScriptParamList lsp = LuaScriptParams::script_params (ls, spi->path, param_function);
+
+       /* allow cancel */
+       for (size_t i = 0; i < lsp.size(); ++i) {
+               if (lsp[i]->preseeded && lsp[i]->name == "x-script-abort") {
+                       return false;
+               }
+       }
 
        ScriptParameterDialog spd (_("Set Script Parameters"), spi, reg, lsp);
 
-       if (!spd.need_interation ()) {
+       if (spd.need_interation ()) {
                switch (spd.run ()) {
                        case Gtk::RESPONSE_ACCEPT:
                                break;
@@ -1343,7 +1486,7 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
                }
        }
 
-       LuaScriptParamPtr lspp (new LuaScriptParam("x-script-origin", "", spi->path, false));
+       LuaScriptParamPtr lspp (new LuaScriptParam("x-script-origin", "", spi->path, false, true));
        lsp.push_back (lspp);
 
        switch (type) {
@@ -1460,7 +1603,7 @@ LuaInstance::set_lua_action (
        } catch (...) {
                return false;
        }
-       _session->set_dirty ();
+       set_dirty ();
        return true;
 }
 
@@ -1476,7 +1619,7 @@ LuaInstance::remove_lua_action (const int id)
                return false;
        }
        ActionChanged (id, ""); /* EMIT SIGNAL */
-       _session->set_dirty ();
+       set_dirty ();
        return true;
 }
 
@@ -1503,7 +1646,7 @@ std::vector<std::string>
 LuaInstance::lua_action_names ()
 {
        std::vector<std::string> rv;
-       for (int i = 0; i < 9; ++i) {
+       for (int i = 0; i < MAX_LUA_ACTION_SCRIPTS; ++i) {
                std::string name;
                if (lua_action_name (i, name)) {
                        rv.push_back (name);
@@ -1597,11 +1740,11 @@ LuaInstance::register_lua_slot (const std::string& name, const std::string& scri
                _callbacks.insert (std::make_pair(p->id(), p));
                p->drop_callback.connect (_slotcon, MISSING_INVALIDATOR, boost::bind (&LuaInstance::unregister_lua_slot, this, p->id()), gui_context());
                SlotChanged (p->id(), p->name(), p->signals()); /* EMIT SIGNAL */
+               set_dirty ();
                return true;
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
        } catch (...) { }
-       _session->set_dirty ();
        return false;
 }
 
@@ -1612,9 +1755,9 @@ LuaInstance::unregister_lua_slot (const PBD::ID& id)
        if (i != _callbacks.end()) {
                SlotChanged (id, "", ActionHook()); /* EMIT SIGNAL */
                _callbacks.erase (i);
+               set_dirty ();
                return true;
        }
-       _session->set_dirty ();
        return false;
 }
 
@@ -2048,6 +2191,14 @@ LuaCallback::connect_2 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal2<void,
                        gui_context());
 }
 
+template <typename T, typename C1, typename C2, typename C3> void
+LuaCallback::connect_3 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal3<void, C1, C2, C3> *signal) {
+       signal->connect (
+                       _connections, invalidator (*this),
+                       boost::bind (&LuaCallback::proxy_3<T, C1, C2, C3>, this, ls, ref, _1, _2, _3),
+                       gui_context());
+}
+
 template <typename T> void
 LuaCallback::proxy_0 (enum LuaSignal::LuaSignal ls, T ref) {
        bool ok = true;
@@ -2090,3 +2241,17 @@ LuaCallback::proxy_2 (enum LuaSignal::LuaSignal ls, T ref, C1 a1, C2 a2) {
                drop_callback (); /* EMIT SIGNAL */
        }
 }
+
+template <typename T, typename C1, typename C2, typename C3> void
+LuaCallback::proxy_3 (enum LuaSignal::LuaSignal ls, T ref, C1 a1, C2 a2, C3 a3) {
+       bool ok = true;
+       {
+               const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref, a1, a2, a3));
+               if (! rv.cast<bool> ()) {
+                       ok = false;
+               }
+       }
+       if (!ok) {
+               drop_callback (); /* EMIT SIGNAL */
+       }
+}