X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=gtk2_ardour%2Fluainstance.cc;h=0756d803be498092eac59fc7ca695dd929022455;hb=69194df4d9a2f985423eca7d44c3d3292cc8baad;hp=0dd4731f277033b3f6db6434096d3ad6e4704b9a;hpb=ddc4e61b57803ae99b472e97f2000a9e04b55aff;p=ardour.git diff --git a/gtk2_ardour/luainstance.cc b/gtk2_ardour/luainstance.cc index 0dd4731f27..0756d803be 100644 --- a/gtk2_ardour/luainstance.cc +++ b/gtk2_ardour/luainstance.cc @@ -20,13 +20,20 @@ #include #include +#include "pbd/file_utils.h" +#include "pbd/strsplit.h" + +#include "gtkmm2ext/bindings.h" #include "gtkmm2ext/gui_thread.h" #include "ardour/audioengine.h" -#include "ardour/diskstream.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" +#include "ardour/system_exec.h" #include "LuaBridge/LuaBridge.h" @@ -34,11 +41,14 @@ #include "ardour_ui.h" #include "public_editor.h" #include "region_selection.h" +#include "luadialog.h" #include "luainstance.h" #include "luasignal.h" #include "marker.h" +#include "region_view.h" #include "processor_box.h" #include "time_axis_view.h" +#include "time_axis_view_item.h" #include "selection.h" #include "script_selector.h" #include "timers.h" @@ -46,6 +56,8 @@ #include "pbd/i18n.h" +static const char* ui_scripts_file_name = "ui_scripts"; + namespace LuaCairo { /** wrap RefPtr< Cairo::ImageSurface > * @@ -61,9 +73,9 @@ class ImageSurface { * color or alpha channel belonging to format will be 0. The contents of bits * within a pixel, but not belonging to the given format are undefined). * - * @param format format of pixels in the surface to create - * @param width width of the surface, in pixels - * @param height height of the surface, in pixels + * @param format format of pixels in the surface to create + * @param width width of the surface, in pixels + * @param height height of the surface, in pixels */ ImageSurface (Cairo::Format format, int width, int height) : _surface (Cairo::ImageSurface::create (format, width, height)) @@ -135,10 +147,10 @@ class ImageSurface { /** Marks a rectangular area of the given surface dirty. * - * @param x X coordinate of dirty rectangle - * @param y Y coordinate of dirty rectangle - * @param width width of dirty rectangle - * @param height height of dirty rectangle + * @param x X coordinate of dirty rectangle + * @param y Y coordinate of dirty rectangle + * @param width width of dirty rectangle + * @param height height of dirty rectangle */ void mark_dirty (int x, int y, int width, int height) { _surface->mark_dirty (x, y, width, height); @@ -308,6 +320,11 @@ class PangoLayout { pango_cairo_show_layout (c->cobj (), _layout->gobj()); } + void layout_cairo_path (Cairo::Context* c) { + pango_cairo_update_layout (c->cobj (), _layout->gobj()); + pango_cairo_layout_path (c->cobj (), _layout->gobj()); + } + private: Glib::RefPtr _layout; }; @@ -350,11 +367,13 @@ 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 { ProcessorBox::ProcSelection - processor_selection (lua_State* L) { + processor_selection () { return ProcessorBox::current_processor_selection (); } @@ -362,12 +381,134 @@ 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::push (L, false); + return -1; + } else { + luabridge::Stack::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 + +//////////////////////////////////////////////////////////////////////////////// + +static int +lua_actionlist (lua_State *L) +{ + using namespace std; + + vector paths; + vector labels; + vector tooltips; + vector keys; + vector > actions; + ActionManager::get_all_actions (paths, labels, tooltips, keys, actions); + + vector::iterator p; + vector::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 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. +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 LuaInstance::LuaTimerS; PBD::Signal0 LuaInstance::LuaTimerDS; +PBD::Signal0 LuaInstance::SetSession; void LuaInstance::register_hooks (lua_State* L) @@ -389,6 +530,10 @@ LuaInstance::register_hooks (lua_State* L) .beginStdBitSet ("Set") .endClass() .endNamespace (); + +#if 0 // Dump size -> libs/ardour/luabindings.cc + printf ("LuaInstance: registered %d signals\n", LuaSignal::LAST_SIGNAL); +#endif } void @@ -491,6 +636,7 @@ LuaInstance::bind_cairo (lua_State* L) .addFunction ("get_text", &LuaCairo::PangoLayout::get_text) .addFunction ("set_text", &LuaCairo::PangoLayout::set_text) .addFunction ("show_in_cairo_context", &LuaCairo::PangoLayout::show_in_cairo_context) + .addFunction ("layout_cairo_path", &LuaCairo::PangoLayout::layout_cairo_path) .addFunction ("set_markup", &LuaCairo::PangoLayout::set_markup) .addFunction ("set_width", &LuaCairo::PangoLayout::set_width) .addFunction ("set_ellipsize", &LuaCairo::PangoLayout::set_ellipsize) @@ -540,6 +686,51 @@ LuaInstance::bind_cairo (lua_State* L) } +void +LuaInstance::bind_dialog (lua_State* L) +{ + luabridge::getGlobalNamespace (L) + .beginNamespace ("LuaDialog") + + .beginClass ("Message") + .addConstructor () + .addFunction ("run", &LuaDialog::Message::run) + .endClass () + + .beginClass ("Dialog") + .addConstructor () + .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) { @@ -549,16 +740,16 @@ LuaInstance::register_classes (lua_State* L) LuaBindings::osc (L); bind_cairo (L); - register_hooks (L); + bind_dialog (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) - .beginStdList ("ArdourMarkerList") + .beginStdCPtrList ("ArdourMarkerList") .endClass () .beginClass ("ArdourMarker") @@ -567,34 +758,60 @@ LuaInstance::register_classes (lua_State* L) .addFunction ("_type", &ArdourMarker::type) .endClass () -#if 0 .beginClass ("AxisView") .endClass () + .deriveClass ("TimeAxisView") .endClass () - .deriveClass ("RouteTimeAxisView") + + .deriveClass ("StripableTimeAxisView") + .endClass () + + .beginClass ("Selectable") .endClass () -#endif + + .deriveClass ("TimeAxisViewItem") + .endClass () + + .deriveClass ("RegionView") + .endClass () + + .deriveClass ("RouteUI") + .endClass () + + .deriveClass ("RouteTimeAxisView") + .addCast ("to_stripabletimeaxisview") + .addCast ("to_timeaxisview") // deprecated + .endClass () + + // std::list + .beginStdCPtrList ("SelectionList") + .endClass () + + // std::list + .beginStdCPtrList ("TrackViewStdList") + .endClass () + .beginClass ("RegionSelection") - .addFunction ("clear_all", &RegionSelection::clear_all) .addFunction ("start", &RegionSelection::start) - .addFunction ("end_frame", &RegionSelection::end_frame) + .addFunction ("end_sample", &RegionSelection::end_sample) .addFunction ("n_midi_regions", &RegionSelection::n_midi_regions) .addFunction ("regionlist", &RegionSelection::regionlist) // XXX check windows binding (libardour) .endClass () .deriveClass > ("TimeSelection") .addFunction ("start", &TimeSelection::start) - .addFunction ("end_frame", &TimeSelection::end_frame) + .addFunction ("end_sample", &TimeSelection::end_sample) .addFunction ("length", &TimeSelection::length) .endClass () .deriveClass > ("MarkerSelection") .endClass () - .beginClass ("TrackViewList") - .addFunction ("routelist", &TrackViewList::routelist) // XXX check windows binding (libardour) + .deriveClass > ("TrackViewList") + .addFunction ("contains", &TrackViewList::contains) + .addFunction ("routelist", &TrackViewList::routelist) .endClass () .deriveClass ("TrackSelection") @@ -618,10 +835,9 @@ LuaInstance::register_classes (lua_State* L) .endClass () .beginClass ("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) @@ -640,6 +856,8 @@ LuaInstance::register_classes (lua_State* L) .addFunction ("get_cut_buffer", &PublicEditor::get_cut_buffer) .addRefFunction ("get_selection_extents", &PublicEditor::get_selection_extents) + .addFunction ("set_selection", &PublicEditor::set_selection) + .addFunction ("play_selection", &PublicEditor::play_selection) .addFunction ("play_with_preroll", &PublicEditor::play_with_preroll) .addFunction ("maybe_locate_with_edit_preroll", &PublicEditor::maybe_locate_with_edit_preroll) @@ -648,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) @@ -670,21 +887,25 @@ LuaInstance::register_classes (lua_State* L) .addFunction ("get_current_zoom", &PublicEditor::get_current_zoom) .addFunction ("reset_zoom", &PublicEditor::reset_zoom) -#if 0 // These need TimeAxisView* which isn't exposed, yet - .addFunction ("playlist_selector", &PublicEditor::playlist_selector) .addFunction ("clear_playlist", &PublicEditor::clear_playlist) .addFunction ("new_playlists", &PublicEditor::new_playlists) .addFunction ("copy_playlists", &PublicEditor::copy_playlists) .addFunction ("clear_playlists", &PublicEditor::clear_playlists) -#endif .addFunction ("select_all_tracks", &PublicEditor::select_all_tracks) .addFunction ("deselect_all", &PublicEditor::deselect_all) -#if 0 + +#if 0 // TimeAxisView& can't be bound (pure virtual fn) .addFunction ("set_selected_track", &PublicEditor::set_selected_track) .addFunction ("set_selected_mixer_strip", &PublicEditor::set_selected_mixer_strip) - .addFunction ("hide_track_in_display", &PublicEditor::hide_track_in_display) + .addFunction ("ensure_time_axis_view_is_visible", &PublicEditor::ensure_time_axis_view_is_visible) #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) .addFunction ("stationary_playhead", &PublicEditor::stationary_playhead) .addFunction ("set_follow_playhead", &PublicEditor::set_follow_playhead) @@ -695,7 +916,6 @@ LuaInstance::register_classes (lua_State* L) .addFunction ("current_page_samples", &PublicEditor::current_page_samples) .addFunction ("visible_canvas_height", &PublicEditor::visible_canvas_height) .addFunction ("temporal_zoom_step", &PublicEditor::temporal_zoom_step) - //.addFunction ("ensure_time_axis_view_is_visible", &PublicEditor::ensure_time_axis_view_is_visible) .addFunction ("override_visible_track_count", &PublicEditor::override_visible_track_count) .addFunction ("scroll_tracks_down_line", &PublicEditor::scroll_tracks_down_line) @@ -727,15 +947,15 @@ LuaInstance::register_classes (lua_State* L) .addFunction ("set_video_timeline_height", &PublicEditor::set_video_timeline_height) #if 0 - .addFunction ("get_route_view_by_route_id", &PublicEditor::get_route_view_by_route_id) .addFunction ("get_equivalent_regions", &PublicEditor::get_equivalent_regions) - - .addFunction ("axis_view_from_route", &PublicEditor::axis_view_from_route) - .addFunction ("axis_views_from_routes", &PublicEditor::axis_views_from_routes) - .addFunction ("get_track_views", &PublicEditor::get_track_views) .addFunction ("drags", &PublicEditor::drags) #endif + .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) + .addFunction ("center_screen", &PublicEditor::center_screen) .addFunction ("get_smart_mode", &PublicEditor::get_smart_mode) @@ -760,9 +980,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)) @@ -777,12 +1007,28 @@ LuaInstance::register_classes (lua_State* L) .addConst ("PunchOut", ArdourMarker::Type(ArdourMarker::PunchOut)) .endNamespace () - .endNamespace (); // end ArdourUI + .beginNamespace ("SelectionOp") + .addConst ("Toggle", Selection::Operation(Selection::Toggle)) + .addConst ("Set", Selection::Operation(Selection::Set)) + .addConst ("Extend", Selection::Operation(Selection::Extend)) + .addConst ("Add", Selection::Operation(Selection::Add)) + .endNamespace () + + .addCFunction ("actionlist", &lua_actionlist) + + .endNamespace () // end ArdourUI + + .beginNamespace ("os") +#ifndef PLATFORM_WINDOWS + .addFunction ("execute", &lua_exec) +#endif + .addCFunction ("forkexec", &lua_forkexec) + .endNamespace (); // Editing Symbols #undef ZOOMFOCUS -#undef SNAPTYPE +#undef GRIDTYPE #undef SNAPMODE #undef MOUSEMODE #undef DISPLAYCONTROL @@ -791,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) @@ -833,17 +1079,23 @@ LuaInstance::instance () return _instance; } +void +LuaInstance::destroy_instance () +{ + delete _instance; + _instance = 0; +} + LuaInstance::LuaInstance () { lua.Print.connect (&_lua_print); init (); - - LuaScriptParamList args; } LuaInstance::~LuaInstance () { delete _lua_call_action; + delete _lua_render_icon; delete _lua_add_action; delete _lua_del_action; delete _lua_get_action; @@ -857,24 +1109,31 @@ LuaInstance::~LuaInstance () void LuaInstance::init () { + lua.sandbox (false); lua.do_command ( "function ScriptManager ()" - " local self = { scripts = {}, instances = {} }" + " local self = { scripts = {}, instances = {}, icons = {} }" "" " local remove = function (id)" " self.scripts[id] = nil" " self.instances[id] = nil" + " self.icons[id] = nil" " end" "" - " local addinternal = function (i, n, s, f, a)" + " local addinternal = function (i, n, s, f, c, a)" " assert(type(i) == 'number', 'id must be numeric')" " assert(type(n) == 'string', 'Name must be string')" " assert(type(s) == 'string', 'Script must be string')" " 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 }" - " local env = _ENV; env.f = nil env.debug = nil os.exit = nil require = nil dofile = nil loadfile = nil package = nil" + " self.scripts[i] = { ['n'] = n, ['s'] = s, ['f'] = f, ['a'] = a, ['c'] = c }" + " 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)" + " else" + " self.icons[i] = nil" + " end" " end" "" " local call = function (id)" @@ -888,17 +1147,26 @@ LuaInstance::init () " collectgarbage()" " end" "" - " local add = function (i, n, s, b, a)" + " local icon = function (id, ...)" + " if type(self.icons[id]) == 'function' then" + " pcall (self.icons[id], ...)" + " end" + " collectgarbage()" + " end" + "" + " local add = function (i, n, s, b, c, a)" " assert(type(b) == 'string', 'ByteCode must be string')" - " load (b)()" // assigns f + " f = nil load (b)()" // assigns f + " icn = nil load (c)()" // may assign "icn" " assert(type(f) == 'string', 'Assigned ByteCode must be string')" - " addinternal (i, n, s, load(f), a)" + " addinternal (i, n, s, load(f), type(icn) ~= \"string\" or icn == '' or load(icn), a)" " end" "" " local get = function (id)" " if type(self.scripts[id]) == 'table' then" " return { ['name'] = self.scripts[id]['n']," " ['script'] = self.scripts[id]['s']," + " ['icon'] = type(self.scripts[id]['c']) == 'function'," " ['args'] = self.scripts[id]['a'] }" " end" " return nil" @@ -914,7 +1182,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" @@ -922,11 +1189,12 @@ 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" " return rv .. string.format(\"%q\", string.dump(value, true))" + " elseif type(value) == \"boolean\" then" + " return rv .. tostring (value)" " else" " error('cannot save a ' .. type(value))" " end" @@ -940,6 +1208,7 @@ LuaInstance::init () " local clear = function ()" " self.scripts = {}" " self.instances = {}" + " self.icons = {}" " collectgarbage()" " end" "" @@ -947,19 +1216,18 @@ LuaInstance::init () " clear()" " load (state)()" " for i, s in pairs (scripts) do" - " addinternal (i, s['n'], s['s'], load(s['f']), s['a'])" + " addinternal (i, s['n'], s['s'], load(s['f']), type (s['c']) ~= \"string\" or s['c'] == '' or load (s['c']), s['a'])" " end" " collectgarbage()" " end" "" " return { call = call, add = add, remove = remove, get = get," - " restore = restore, save = save, clear = clear}" + " restore = restore, save = save, clear = clear, icon = icon}" " end" " " " manager = ScriptManager ()" " ScriptManager = nil" ); - lua_State* L = lua.getState(); try { @@ -971,11 +1239,17 @@ LuaInstance::init () _lua_del_action = new luabridge::LuaRef(lua_mgr["remove"]); _lua_get_action = new luabridge::LuaRef(lua_mgr["get"]); _lua_call_action = new luabridge::LuaRef(lua_mgr["call"]); + _lua_render_icon = new luabridge::LuaRef(lua_mgr["icon"]); _lua_save = new luabridge::LuaRef(lua_mgr["save"]); _lua_load = new luabridge::LuaRef(lua_mgr["restore"]); _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; @@ -983,11 +1257,70 @@ LuaInstance::init () } register_classes (L); + register_hooks (L); luabridge::push (L, &PublicEditor::instance()); 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); @@ -995,23 +1328,28 @@ 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 */ } 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 (); @@ -1022,6 +1360,12 @@ LuaInstance::session_going_away () lua.do_command ("collectgarbage();"); } +void +LuaInstance::every_second () +{ + LuaTimerS (); // emit signal +} + void LuaInstance::every_point_one_seconds () { @@ -1031,7 +1375,6 @@ LuaInstance::every_point_one_seconds () int LuaInstance::set_state (const XMLNode& node) { - LocaleGuard lg; XMLNode* child; if ((child = find_named_node (node, "ActionScript"))) { @@ -1043,8 +1386,8 @@ LuaInstance::set_state (const XMLNode& node) (*_lua_load)(std::string ((const char*)buf, size)); } catch (luabridge::LuaException const& e) { cerr << "LuaException:" << e.what () << endl; - } - for (int i = 0; i < 9; ++i) { + } catch (...) { } + for (int i = 0; i < MAX_LUA_ACTION_SCRIPTS; ++i) { std::string name; if (lua_action_name (i, name)) { ActionChanged (i, name); /* EMIT SIGNAL */ @@ -1054,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 { @@ -1063,7 +1407,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 (...) { } } } @@ -1074,16 +1418,25 @@ bool LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id) { std::string title; + std::string param_function = "action_params"; std::vector reg; 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 (); - title = "Add Lua Callback Hook"; + title = _("Add Lua Callback Hook"); + break; + case LuaScriptInfo::Session: + if (!_session) { + return false; + } + reg = _session->registered_lua_functions (); + title = _("Add Lua Session Script"); + param_function = "sess_params"; break; default: return false; @@ -1104,23 +1457,38 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id) try { script = Glib::file_get_contents (spi->path); - } catch (Glib::FileError e) { + } catch (Glib::FileError const& e) { string msg = string_compose (_("Cannot read script '%1': %2"), spi->path, e.what()); Gtk::MessageDialog am (msg); am.run (); return false; } - LuaScriptParamList lsp = LuaScriptParams::script_params (spi, "action_params"); + LuaState ls; + register_classes (ls.getState ()); + LuaScriptParamList lsp = LuaScriptParams::script_params (ls, spi->path, param_function); - ScriptParameterDialog spd (_("Set Script Parameters"), spi, reg, lsp); - switch (spd.run ()) { - case Gtk::RESPONSE_ACCEPT: - break; - default: + /* 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 ()) { + switch (spd.run ()) { + case Gtk::RESPONSE_ACCEPT: + break; + default: + return false; + } + } + + LuaScriptParamPtr lspp (new LuaScriptParam("x-script-origin", "", spi->path, false, true)); + lsp.push_back (lspp); + switch (type) { case LuaScriptInfo::EditorAction: return set_lua_action (id, spd.name(), script, lsp); @@ -1128,6 +1496,22 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id) case LuaScriptInfo::EditorHook: return register_lua_slot (spd.name(), script, lsp); break; + case LuaScriptInfo::Session: + try { + _session->register_lua_function (spd.name(), script, lsp); + } catch (luabridge::LuaException const& e) { + string msg = string_compose (_("Session script '%1' instantiation failed: %2"), spd.name(), e.what ()); + Gtk::MessageDialog am (msg); + am.run (); + } catch (SessionException const& e) { + 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; } @@ -1137,7 +1521,6 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id) XMLNode& LuaInstance::get_action_state () { - LocaleGuard lg; std::string saved; { luabridge::LuaRef savedstate ((*_lua_save)()); @@ -1150,7 +1533,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; @@ -1174,7 +1557,24 @@ LuaInstance::call_action (const int id) lua.collect_garbage_step (); } catch (luabridge::LuaException const& e) { cerr << "LuaException:" << e.what () << endl; - } + } catch (...) { } +} + +void +LuaInstance::render_action_icon (cairo_t* cr, int w, int h, uint32_t c, void* i) { + int ii = reinterpret_cast (i); + instance()->render_icon (ii, cr, w, h, c); +} + +void +LuaInstance::render_icon (int i, cairo_t* cr, int w, int h, uint32_t clr) +{ + Cairo::Context ctx (cr); + try { + (*_lua_render_icon)(i + 1, (Cairo::Context *)&ctx, w, h, clr); + } catch (luabridge::LuaException const& e) { + cerr << "LuaException:" << e.what () << endl; + } catch (...) { } } bool @@ -1189,17 +1589,21 @@ LuaInstance::set_lua_action ( // get bytcode of factory-function in a sandbox // (don't allow scripts to interfere) const std::string& bytecode = LuaScripting::get_factory_bytecode (script); + const std::string& iconfunc = LuaScripting::get_factory_bytecode (script, "icon", "icn"); luabridge::LuaRef tbl_arg (luabridge::newTable(L)); for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) { if ((*i)->optional && !(*i)->is_set) { continue; } tbl_arg[(*i)->name] = (*i)->value; } - (*_lua_add_action)(id + 1, name, script, bytecode, tbl_arg); + (*_lua_add_action)(id + 1, name, script, bytecode, iconfunc, tbl_arg); ActionChanged (id, name); /* EMIT SIGNAL */ } catch (luabridge::LuaException const& e) { cerr << "LuaException:" << e.what () << endl; return false; + } catch (...) { + return false; } + set_dirty (); return true; } @@ -1211,8 +1615,11 @@ 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 */ + set_dirty (); return true; } @@ -1231,8 +1638,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; } @@ -1240,7 +1646,7 @@ std::vector LuaInstance::lua_action_names () { std::vector 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); @@ -1249,6 +1655,23 @@ LuaInstance::lua_action_names () return rv; } +bool +LuaInstance::lua_action_has_icon (const int id) +{ + try { + luabridge::LuaRef ref ((*_lua_get_action)(id + 1)); + if (ref.isNil()) { + return false; + } + if (ref["icon"].isBoolean()) { + return ref["icon"].cast(); + } + } catch (luabridge::LuaException const& e) { + cerr << "LuaException:" << e.what () << endl; + } catch (...) { } + return false; +} + bool LuaInstance::lua_action (const int id, std::string& name, std::string& script, LuaScriptParamList& args) { @@ -1280,8 +1703,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; } @@ -1293,6 +1715,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"); @@ -1303,7 +1726,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; @@ -1317,10 +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 (...) { } return false; } @@ -1331,6 +1755,7 @@ LuaInstance::unregister_lua_slot (const PBD::ID& id) if (i != _callbacks.end()) { SlotChanged (id, "", ActionHook()); /* EMIT SIGNAL */ _callbacks.erase (i); + set_dirty (); return true; } return false; @@ -1404,11 +1829,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 (); @@ -1447,7 +1874,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); @@ -1470,17 +1897,25 @@ LuaCallback::get_state (void) luabridge::LuaRef savedstate ((*_lua_save)()); saved = savedstate.cast(); } - 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; } @@ -1489,6 +1924,7 @@ void LuaCallback::init (void) { lua.Print.connect (&_lua_print); + lua.sandbox (false); lua.do_command ( "function ScriptManager ()" @@ -1500,7 +1936,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" "" @@ -1546,7 +1982,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" @@ -1554,11 +1989,12 @@ 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" " return rv .. string.format(\"%q\", string.dump(value, true))" + " elseif type(value) == \"boolean\" then" + " return rv .. tostring (value)" " else" " error('cannot save a ' .. type(value))" " end" @@ -1598,6 +2034,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; @@ -1605,6 +2046,7 @@ LuaCallback::init (void) } LuaInstance::register_classes (L); + LuaInstance::register_hooks (L); luabridge::push (L, &PublicEditor::instance()); lua_setglobal (L, "Editor"); @@ -1645,7 +2087,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; } @@ -1674,10 +2116,6 @@ LuaCallback::session_going_away () _session = 0; drop_callback (); /* EMIT SIGNAL */ - - lua_State* L = lua.getState(); - LuaBindings::set_session (L, 0); - lua.do_command ("collectgarbage();"); } void @@ -1753,6 +2191,14 @@ LuaCallback::connect_2 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal2 void +LuaCallback::connect_3 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal3 *signal) { + signal->connect ( + _connections, invalidator (*this), + boost::bind (&LuaCallback::proxy_3, this, ls, ref, _1, _2, _3), + gui_context()); +} + template void LuaCallback::proxy_0 (enum LuaSignal::LuaSignal ls, T ref) { bool ok = true; @@ -1795,3 +2241,17 @@ LuaCallback::proxy_2 (enum LuaSignal::LuaSignal ls, T ref, C1 a1, C2 a2) { drop_callback (); /* EMIT SIGNAL */ } } + +template 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 ()) { + ok = false; + } + } + if (!ok) { + drop_callback (); /* EMIT SIGNAL */ + } +}