fix out-of-order d'tor which garbles the lua stack.
[ardour.git] / gtk2_ardour / luainstance.cc
index d33bc44c8cc5857516c9d97225cc31ae3beb8c2c..188c2c8a935370c5f0dce94434bc3ef865724320 100644 (file)
@@ -16,6 +16,8 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
+#include <cairomm/context.h>
+
 #include "gtkmm2ext/gui_thread.h"
 
 #include "ardour/audioengine.h"
@@ -95,17 +97,109 @@ LuaInstance::register_hooks (lua_State* L)
                .endNamespace ();
 }
 
+void
+LuaInstance::bind_cairo (lua_State* L)
+{
+       luabridge::getGlobalNamespace (L)
+               .beginNamespace ("Cairo")
+               .beginClass <Cairo::Context> ("Context")
+               .addFunction ("save", &Cairo::Context::save)
+               .addFunction ("restore", &Cairo::Context::restore)
+               .addFunction ("set_operator", &Cairo::Context::set_operator)
+               //.addFunction ("set_source", &Cairo::Context::set_operator) // needs RefPtr
+               .addFunction ("set_source_rgb", &Cairo::Context::set_source_rgb)
+               .addFunction ("set_source_rgba", &Cairo::Context::set_source_rgba)
+               .addFunction ("set_line_width", &Cairo::Context::set_line_width)
+               .addFunction ("set_line_cap", &Cairo::Context::set_line_cap)
+               .addFunction ("set_line_join", &Cairo::Context::set_line_join)
+               .addFunction ("set_dash", (void (Cairo::Context::*)(std::vector<double>&, double))&Cairo::Context::set_dash)
+               .addFunction ("unset_dash", &Cairo::Context::unset_dash)
+               .addFunction ("translate", &Cairo::Context::translate)
+               .addFunction ("scale", &Cairo::Context::scale)
+               .addFunction ("rotate", &Cairo::Context::rotate)
+               .addFunction ("begin_new_path", &Cairo::Context::begin_new_path)
+               .addFunction ("begin_new_sub_path", &Cairo::Context::begin_new_sub_path)
+               .addFunction ("move_to", &Cairo::Context::move_to)
+               .addFunction ("line_to", &Cairo::Context::line_to)
+               .addFunction ("curve_to", &Cairo::Context::curve_to)
+               .addFunction ("arc", &Cairo::Context::arc)
+               .addFunction ("arc_negative", &Cairo::Context::arc_negative)
+               .addFunction ("rel_move_to", &Cairo::Context::rel_move_to)
+               .addFunction ("rel_line_to", &Cairo::Context::rel_line_to)
+               .addFunction ("rel_curve_to", &Cairo::Context::rel_curve_to)
+               .addFunction ("rectangle", (void (Cairo::Context::*)(double, double, double, double))&Cairo::Context::rectangle)
+               .addFunction ("close_path", &Cairo::Context::close_path)
+               .addFunction ("paint", &Cairo::Context::paint)
+               .addFunction ("paint_with_alpha", &Cairo::Context::paint_with_alpha)
+               .addFunction ("stroke", &Cairo::Context::stroke)
+               .addFunction ("stroke_preserve", &Cairo::Context::stroke_preserve)
+               .addFunction ("fill", &Cairo::Context::fill)
+               .addFunction ("fill_preserve", &Cairo::Context::fill_preserve)
+               .addFunction ("reset_clip", &Cairo::Context::reset_clip)
+               .addFunction ("clip", &Cairo::Context::clip)
+               .addFunction ("clip_preserve", &Cairo::Context::clip_preserve)
+               .addFunction ("set_font_size", &Cairo::Context::set_font_size)
+               .addFunction ("show_text", &Cairo::Context::show_text)
+               .endClass ()
+               /* enums */
+               // LineCap, LineJoin, Operator
+               .beginNamespace ("LineCap")
+               .addConst ("Butt", CAIRO_LINE_CAP_BUTT)
+               .addConst ("Round", CAIRO_LINE_CAP_ROUND)
+               .addConst ("Square", CAIRO_LINE_CAP_SQUARE)
+               .endNamespace ()
+
+               .beginNamespace ("LineJoin")
+               .addConst ("Miter", CAIRO_LINE_JOIN_MITER)
+               .addConst ("Round", CAIRO_LINE_JOIN_ROUND)
+               .addConst ("Bevel", CAIRO_LINE_JOIN_BEVEL)
+               .endNamespace ()
+
+               .beginNamespace ("Operator")
+               .addConst ("Clear", CAIRO_OPERATOR_CLEAR)
+               .addConst ("Source", CAIRO_OPERATOR_SOURCE)
+               .addConst ("Over", CAIRO_OPERATOR_OVER)
+               .addConst ("Add", CAIRO_OPERATOR_ADD)
+               .endNamespace ()
+
+               .endNamespace ();
+
+/* Lua/cairo bindings operate on Cairo::Context, there is no Cairo::RefPtr wrapper [yet].
+  one can work around this as follows:
+
+  LuaState lua;
+  LuaInstance::register_classes (lua.getState());
+  lua.do_command (
+      "function render (ctx)"
+      "  ctx:rectangle (0, 0, 100, 100)"
+      "  ctx:set_source_rgba (0.1, 1.0, 0.1, 1.0)"
+      "  ctx:fill ()"
+      " end"
+      );
+  {
+               Cairo::RefPtr<Cairo::Context> context = get_window ()->create_cairo_context ();
+    Cairo::Context ctx (context->cobj ());
+
+    luabridge::LuaRef lua_render = luabridge::getGlobal (lua.getState(), "render");
+    lua_render ((Cairo::Context *)&ctx);
+  }
+*/
+
+}
+
 void
 LuaInstance::register_classes (lua_State* L)
 {
        LuaBindings::stddef (L);
        LuaBindings::common (L);
        LuaBindings::session (L);
+       LuaBindings::osc (L);
 
+       bind_cairo (L);
        register_hooks (L);
 
        luabridge::getGlobalNamespace (L)
-               .beginNamespace ("ARDOUR")
+               .beginNamespace ("ArdourUI")
                .beginClass <RegionSelection> ("RegionSelection")
                .addFunction ("clear_all", &RegionSelection::clear_all)
                .addFunction ("start", &RegionSelection::start)
@@ -113,24 +207,152 @@ LuaInstance::register_classes (lua_State* L)
                .addFunction ("n_midi_regions", &RegionSelection::n_midi_regions)
                .endClass ()
 
+               .beginClass <ArdourMarker> ("ArdourMarker")
+               .endClass ()
+
                .beginClass <PublicEditor> ("Editor")
+               .addFunction ("snap_type", &PublicEditor::snap_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)
+
+               .addFunction ("set_mouse_mode", &PublicEditor::set_mouse_mode)
+               .addFunction ("current_mouse_mode", &PublicEditor::current_mouse_mode)
+
+               .addFunction ("consider_auditioning", &PublicEditor::consider_auditioning)
+
+               .addFunction ("new_region_from_selection", &PublicEditor::new_region_from_selection)
+               .addFunction ("separate_region_from_selection", &PublicEditor::separate_region_from_selection)
+               .addFunction ("pixel_to_sample", &PublicEditor::pixel_to_sample)
+               .addFunction ("sample_to_pixel", &PublicEditor::sample_to_pixel)
+
+#if 0 // Selection is not yet exposed
+               .addFunction ("get_selection", &PublicEditor::get_selection)
+               .addFunction ("get_cut_buffer", &PublicEditor::get_cut_buffer)
+               .addFunction ("track_mixer_selection", &PublicEditor::track_mixer_selection)
+               .addFunction ("extend_selection_to_track", &PublicEditor::extend_selection_to_track)
+#endif
+
                .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)
-               .addFunction ("add_location_from_playhead_cursor", &PublicEditor::add_location_from_playhead_cursor)
                .addFunction ("goto_nth_marker", &PublicEditor::goto_nth_marker)
+
+               .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 ("mouse_add_new_marker", &PublicEditor::mouse_add_new_marker)
-               .addFunction ("split_regions_at", &PublicEditor::split_regions_at)
+               .addFunction ("show_measures", &PublicEditor::show_measures)
+               .addFunction ("remove_tracks", &PublicEditor::remove_tracks)
+
+               .addFunction ("effective_mouse_mode", &PublicEditor::effective_mouse_mode)
+
+               .addRefFunction ("do_import", &PublicEditor::do_import)
+               .addRefFunction ("do_embed", &PublicEditor::do_embed)
+
+               .addFunction ("export_audio", &PublicEditor::export_audio)
+               .addFunction ("stem_export", &PublicEditor::stem_export)
+               .addFunction ("export_selection", &PublicEditor::export_selection)
+               .addFunction ("export_range", &PublicEditor::export_range)
+
+               .addFunction ("set_zoom_focus", &PublicEditor::set_zoom_focus)
+               .addFunction ("get_zoom_focus", &PublicEditor::get_zoom_focus)
+               .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
+               .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)
+#endif
+               .addFunction ("set_stationary_playhead", &PublicEditor::set_stationary_playhead)
+               .addFunction ("stationary_playhead", &PublicEditor::stationary_playhead)
+               .addFunction ("set_follow_playhead", &PublicEditor::set_follow_playhead)
+               .addFunction ("follow_playhead", &PublicEditor::follow_playhead)
+
+               .addFunction ("dragging_playhead", &PublicEditor::dragging_playhead)
+               .addFunction ("leftmost_sample", &PublicEditor::leftmost_sample)
+               .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)
+               .addFunction ("scroll_tracks_up_line", &PublicEditor::scroll_tracks_up_line)
+               .addFunction ("scroll_down_one_track", &PublicEditor::scroll_down_one_track)
+               .addFunction ("scroll_up_one_track", &PublicEditor::scroll_up_one_track)
+
+               .addFunction ("reset_x_origin", &PublicEditor::reset_x_origin)
+               .addFunction ("get_y_origin", &PublicEditor::get_y_origin)
+               .addFunction ("reset_y_origin", &PublicEditor::reset_y_origin)
+
+               .addFunction ("remove_last_capture", &PublicEditor::remove_last_capture)
+
                .addFunction ("maximise_editing_space", &PublicEditor::maximise_editing_space)
                .addFunction ("restore_editing_space", &PublicEditor::restore_editing_space)
+               .addFunction ("toggle_meter_updating", &PublicEditor::toggle_meter_updating)
+
+               //.addFunction ("get_preferred_edit_position", &PublicEditor::get_preferred_edit_position)
+               //.addFunction ("split_regions_at", &PublicEditor::split_regions_at)
+
+               .addRefFunction ("get_nudge_distance", &PublicEditor::get_nudge_distance)
+               .addFunction ("get_paste_offset", &PublicEditor::get_paste_offset)
+               .addFunction ("get_grid_beat_divisions", &PublicEditor::get_grid_beat_divisions)
+               .addRefFunction ("get_grid_type_as_beats", &PublicEditor::get_grid_type_as_beats)
+
+               .addFunction ("toggle_ruler_video", &PublicEditor::toggle_ruler_video)
+               .addFunction ("toggle_xjadeo_proc", &PublicEditor::toggle_xjadeo_proc)
+               .addFunction ("get_videotl_bar_height", &PublicEditor::get_videotl_bar_height)
+               .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 ("center_screen", &PublicEditor::center_screen)
+
+               .addFunction ("get_smart_mode", &PublicEditor::get_smart_mode)
+               .addRefFunction ("get_pointer_position", &PublicEditor::get_pointer_position)
+
+               .addRefFunction ("find_location_from_marker", &PublicEditor::find_location_from_marker)
+               .addFunction ("find_marker_from_location_id", &PublicEditor::find_marker_from_location_id)
+               .addFunction ("mouse_add_new_marker", &PublicEditor::mouse_add_new_marker)
+#if 0
+               .addFunction ("get_regions_at", &PublicEditor::get_regions_at)
+               .addFunction ("get_regions_after", &PublicEditor::get_regions_after)
                .addFunction ("get_regions_from_selection_and_mouse", &PublicEditor::get_regions_from_selection_and_mouse)
-               .addFunction ("show_measures", &PublicEditor::show_measures)
-               .addFunction ("set_zoom_focus", &PublicEditor::set_zoom_focus)
-               .addFunction ("do_import", &PublicEditor::do_import)
-               .addFunction ("do_embed", &PublicEditor::do_embed)
+               .addFunction ("get_regionviews_by_id", &PublicEditor::get_regionviews_by_id)
+               .addFunction ("get_per_region_note_selection", &PublicEditor::get_per_region_note_selection)
+#endif
+
+#if 0
+               .addFunction ("mouse_add_new_tempo_event", &PublicEditor::mouse_add_new_tempo_event)
+               .addFunction ("mouse_add_new_meter_event", &PublicEditor::mouse_add_new_meter_event)
+               .addFunction ("edit_tempo_section", &PublicEditor::edit_tempo_section)
+               .addFunction ("edit_meter_section", &PublicEditor::edit_meter_section)
+#endif
+
+               .addFunction ("access_action", &PublicEditor::access_action)
                .endClass ()
                .endNamespace ();
 
@@ -443,6 +665,7 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
                default:
                        return false;
        }
+       ss.hide ();
 
        std::string script = "";
 
@@ -455,7 +678,7 @@ LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
                return false;
        }
 
-       LuaScriptParamList lsp = LuaScripting::script_params (spi, "action_params");
+       LuaScriptParamList lsp = LuaScriptParams::script_params (spi, "action_params");
 
        ScriptParameterDialog spd (_("Set Script Parameters"), spi, reg, lsp);
        switch (spd.run ()) {
@@ -617,18 +840,9 @@ LuaInstance::lua_action (const int id, std::string& name, std::string& script, L
                if (!lsi) {
                        return false;
                }
-               args = LuaScripting::script_params (lsi, "action_params");
-               for (luabridge::Iterator i (static_cast<luabridge::LuaRef>(ref["args"])); !i.isNil (); ++i) {
-                       if (!i.key ().isString ()) { assert(0); continue; }
-                       std::string name = i.key ().cast<std::string> ();
-                       std::string value = i.value ().cast<std::string> ();
-                       for (LuaScriptParamList::const_iterator ii = args.begin(); ii != args.end(); ++ii) {
-                               if ((*ii)->name == name) {
-                                       (*ii)->value = value;
-                                       break;
-                               }
-                       }
-               }
+               args = LuaScriptParams::script_params (lsi, "action_params");
+               luabridge::LuaRef rargs (ref["args"]);
+               LuaScriptParams::ref_to_params (args, &rargs);
                return true;
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
@@ -994,18 +1208,9 @@ LuaCallback::lua_slot (std::string& name, std::string& script, ActionHook& ah, A
                if (!lsi) {
                        return false;
                }
-               args = LuaScripting::script_params (lsi, "action_params");
-               for (luabridge::Iterator i (static_cast<luabridge::LuaRef>(ref["args"])); !i.isNil (); ++i) {
-                       if (!i.key ().isString ()) { assert(0); continue; }
-                       std::string name = i.key ().cast<std::string> ();
-                       std::string value = i.value ().cast<std::string> ();
-                       for (LuaScriptParamList::const_iterator ii = args.begin(); ii != args.end(); ++ii) {
-                               if ((*ii)->name == name) {
-                                       (*ii)->value = value;
-                                       break;
-                               }
-                       }
-               }
+               args = LuaScriptParams::script_params (lsi, "action_params");
+               luabridge::LuaRef rargs (ref["args"]);
+               LuaScriptParams::ref_to_params (args, &rargs);
                return true;
        } catch (luabridge::LuaException const& e) {
                cerr << "LuaException:" << e.what () << endl;
@@ -1114,15 +1319,43 @@ LuaCallback::connect_2 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal2<void,
 
 template <typename T> void
 LuaCallback::proxy_0 (enum LuaSignal::LuaSignal ls, T ref) {
-       if (!(*_lua_call)((int)ls, ref)) { drop_callback (); /* EMIT SIGNAL */}
+       bool ok = true;
+       {
+               const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref));
+               if (! rv.cast<bool> ()) {
+                       ok = false;
+               }
+       }
+       /* destroy LuaRef ^^ first before calling drop_callback() */
+       if (!ok) {
+               drop_callback (); /* EMIT SIGNAL */
+       }
 }
 
 template <typename T, typename C1> void
 LuaCallback::proxy_1 (enum LuaSignal::LuaSignal ls, T ref, C1 a1) {
-       if (!(*_lua_call)((int)ls, ref, a1)) { drop_callback (); /* EMIT SIGNAL */}
+       bool ok = true;
+       {
+               const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref, a1));
+               if (! rv.cast<bool> ()) {
+                       ok = false;
+               }
+       }
+       if (!ok) {
+               drop_callback (); /* EMIT SIGNAL */
+       }
 }
 
 template <typename T, typename C1, typename C2> void
 LuaCallback::proxy_2 (enum LuaSignal::LuaSignal ls, T ref, C1 a1, C2 a2) {
-       if (!(*_lua_call)((int)ls, ref, a1, a2)) { drop_callback (); /* EMIT SIGNAL */}
+       bool ok = true;
+       {
+               const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref, a1, a2));
+               if (! rv.cast<bool> ()) {
+                       ok = false;
+               }
+       }
+       if (!ok) {
+               drop_callback (); /* EMIT SIGNAL */
+       }
 }