optimize ArdourButton
[ardour.git] / gtk2_ardour / ardour_button.cc
index eab462f9026daa68a42b5252fa83ea564e7ab04c..bd64d067e3b12c7f7ca72b4ab317fbf2abd0d62c 100644 (file)
@@ -41,7 +41,7 @@
 
 #include "i18n.h"
 
-#define REFLECTION_HEIGHT 2
+#define BASELINESTRETCH (1.25)
 
 using namespace Gdk;
 using namespace Gtk;
@@ -85,6 +85,10 @@ ArdourButton::ArdourButton (Element e)
        , _focused (false)
        , _fixed_colors_set (false)
        , _fallthrough_to_parent (false)
+       , _layout_ellipsize_width (-1)
+       , _ellipsis (Pango::ELLIPSIZE_NONE)
+       , _update_colors (true)
+       , _pattern_height (0)
 {
        ARDOUR_UI_UTILS::ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
 }
@@ -116,8 +120,14 @@ ArdourButton::ArdourButton (const std::string& str, Element e)
        , _hovering (false)
        , _focused (false)
        , _fixed_colors_set (false)
+       , _fallthrough_to_parent (false)
+       , _layout_ellipsize_width (-1)
+       , _ellipsis (Pango::ELLIPSIZE_NONE)
+       , _update_colors (true)
+       , _pattern_height (0)
 {
        set_text (str);
+       ARDOUR_UI_UTILS::ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
 }
 
 ArdourButton::~ArdourButton()
@@ -135,36 +145,20 @@ ArdourButton::~ArdourButton()
        if (led_inset_pattern) {
                cairo_pattern_destroy (led_inset_pattern);
        }
-
 }
 
 void
 ArdourButton::set_text (const std::string& str)
 {
        _text = str;
-
-       if (!_layout && !_text.empty()) {
-               _layout = Pango::Layout::create (get_pango_context());
-       }
-
-       if (_layout) {
-               _layout->set_text (str);
+       if (!is_realized()) {
+               return;
        }
-
-       queue_resize ();
-}
-
-void
-ArdourButton::set_markup (const std::string& str)
-{
-       _text = str;
-
-       if (!_layout) {
-               _layout = Pango::Layout::create (get_pango_context());
+       ensure_layout ();
+       if (_layout && _layout->get_text() != _text) {
+               _layout->set_text (_text);
+               queue_resize ();
        }
-
-       _layout->set_markup (str);
-       queue_resize ();
 }
 
 void
@@ -185,6 +179,14 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
 {
        uint32_t text_color;
        uint32_t led_color;
+
+       if (_update_colors) {
+               set_colors ();
+       }
+       if (get_height() != _pattern_height) {
+               build_patterns ();
+       }
+
        if ( active_state() == Gtkmm2ext::ExplicitActive ) {
                text_color = text_active_color;
                led_color = led_active_color;
@@ -359,10 +361,28 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
                cairo_stroke(cr);
        }
 
-       const int text_margin = rint(.5 * (char_pixel_width() + _corner_radius));
-
+       const int text_margin = char_pixel_width();
        // Text, if any
        if (!_pixbuf && ((_elements & Text)==Text) && !_text.empty()) {
+               assert(_layout);
+#if 0 // DEBUG style (print on hover)
+               if (_hovering) {
+                       bool layout_font = true;
+                       Pango::FontDescription fd = _layout->get_font_description();
+                       if (fd.gobj() == NULL) {
+                               layout_font = false;
+                               fd = get_pango_context()->get_font_description();
+                       }
+                       printf("%s: f:%dx%d bh:%.0f tw:%d (%dx%d) %s\"%s\"\n",
+                                       get_name().c_str(),
+                                       char_pixel_width(), char_pixel_height(),
+                                       ceil(char_pixel_height() * BASELINESTRETCH),
+                                       _text_width,
+                                       get_width(), get_height(),
+                                       layout_font ? "L:" : "W:",
+                                       fd.to_string().c_str());
+               }
+#endif
 
                cairo_save (cr);
                cairo_rectangle (cr, 2, 1, get_width() - 4, get_height() - 2);
@@ -370,17 +390,18 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
 
                cairo_new_path (cr);
                ArdourCanvas::set_source_rgba (cr, text_color);
+               const double text_ypos = (get_height() - _text_height) * .5;
 
                if (_elements & Menu) {
                        // always left align (dropdown)
-                       cairo_move_to (cr, text_margin, rint((get_height() - _text_height) * .5));
+                       cairo_move_to (cr, text_margin, text_ypos);
                        pango_cairo_show_layout (cr, _layout->gobj());
                } else if ( (_elements & Indicator)  == Indicator) {
                        // left/right align depending on LED position
                        if (_led_left) {
-                               cairo_move_to (cr, rint(text_margin + _diameter + char_pixel_width()), rint((get_height() - _text_height) * .5));
+                               cairo_move_to (cr, text_margin + _diameter + .5 * char_pixel_width(), text_ypos);
                        } else {
-                               cairo_move_to (cr, text_margin, rint((get_height() - _text_height) * .5));
+                               cairo_move_to (cr, text_margin, text_ypos);
                        }
                        pango_cairo_show_layout (cr, _layout->gobj());
                } else {
@@ -400,9 +421,9 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
                         * TODO this should be generalized incl rotation.
                         * currently only 'user' of this API is meter_strip.cc
                         */
-                       if (_xalign < 0) xa = .5 + (ww * fabs(_xalign) + text_margin);
+                       if (_xalign < 0) xa = ceil(.5 + (ww * fabs(_xalign) + text_margin));
 
-                       cairo_move_to (cr, rint(xa), rint(ya));
+                       cairo_move_to (cr, xa, ya);
                        pango_cairo_update_layout(cr, _layout->gobj());
                        pango_cairo_show_layout (cr, _layout->gobj());
                        cairo_restore (cr);
@@ -486,23 +507,18 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
                }
        }
 
-       //user is currently pressing the button.  black outline helps to indicate this
+       //user is currently pressing the button. dark outline helps to indicate this
        if (_grabbed && !(_elements & (Inactive|Menu))) {
                rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
                cairo_set_line_width(cr, 2);
-               cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, .5); // XXX no longer 'black'
+               cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, .5);
                cairo_stroke (cr);
        }
 
        //some buttons (like processor boxes) can be selected  (so they can be deleted).  Draw a selection indicator
        if (visual_state() & Gtkmm2ext::Selected) {
-#if 0 // outline, edge + 1px outside
-               cairo_set_line_width(cr, 2);
-               cairo_set_source_rgba (cr, 1, 0, 0, 0.8);
-#else // replace edge (if any)
                cairo_set_line_width(cr, 1);
                cairo_set_source_rgba (cr, 1, 0, 0, 0.8);
-#endif
                rounded_function (cr, 0.5, 0.5, get_width() - 1, get_height() - 1, _corner_radius);
                cairo_stroke (cr);
        }
@@ -525,38 +541,45 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
 }
 
 void
-ArdourButton::set_diameter (float d)
+ArdourButton::set_corner_radius (float r)
 {
-       _diameter = (d*2) + 5.0;
-
-       build_patterns ();
-       queue_resize ();
+       _corner_radius = r;
+       CairoWidget::set_dirty ();
 }
 
 void
-ArdourButton::set_corner_radius (float r)
+ArdourButton::on_realize()
 {
-       _corner_radius = r;
-       set_dirty ();
+       CairoWidget::on_realize ();
+       ensure_layout ();
+       if (_layout && _layout->get_text() != _text) {
+               _layout->set_text (_text);
+               queue_resize ();
+       }
 }
 
 void
 ArdourButton::on_size_request (Gtk::Requisition* req)
 {
-       req->height = req->height = 0;
+       req->width = req->height = 0;
        CairoWidget::on_size_request (req);
 
        if (_diameter == 0) {
-               _diameter = rint (ARDOUR::Config->get_font_scale () / 1024. / 7.5); // 11px with 80% font-scaling
+               const float newdia = rint (ARDOUR::Config->get_font_scale () / 1024. / 7.5); // 11px with 80% font-scaling
+               if (_diameter != newdia) {
+                       _pattern_height = 0;
+                       _diameter = newdia;
+               }
        }
 
        if ((_elements & Text) && !_text.empty()) {
                int ignored;
-               _layout->get_pixel_size (_text_width, ignored);
                _text_height = char_pixel_height ();
-               req->width += char_pixel_width();
+               // if _layout does not exist, char_pixel_height() creates it,
+               _layout->get_pixel_size (_text_width, ignored);
+               req->width += rint(1.75 * char_pixel_width()); // padding
                req->width += _text_width;
-               req->height = std::max(req->height, (int) ceil(_text_height * 1.25));
+               req->height = std::max(req->height, (int) ceil(_text_height * BASELINESTRETCH + 1.0));
        } else {
                _text_width = 0;
                _text_height = 0;
@@ -568,8 +591,8 @@ ArdourButton::on_size_request (Gtk::Requisition* req)
        }
 
        if (_elements & Indicator) {
-               req->width += lrint (_diameter) + 2 * char_pixel_width();
-               req->height = std::max (req->height, (int) lrint (_diameter) + 2);
+               req->width += lrint (_diameter) + char_pixel_width();
+               req->height = std::max (req->height, (int) lrint (_diameter) + 4);
        }
 
        if ((_elements & Menu)) {
@@ -578,14 +601,11 @@ ArdourButton::on_size_request (Gtk::Requisition* req)
 
        if (_elements & (RecButton | CloseCross)) {
                assert(!(_elements & Text));
-               const int wh = std::max(char_pixel_width(), char_pixel_height()) * 1.25;
+               const int wh = std::max(3.5 * char_pixel_width(), ceil(char_pixel_height() * BASELINESTRETCH + 1));
                req->width += wh;
-               req->height = std::max(req->height, (int) wh);
+               req->height = std::max(req->height, wh);
        }
 
-       req->width += ceil(_corner_radius);
-       req->height += ceil(_corner_radius);
-
        if (_tweaks & Square) {
                // squared buttons are also grouped, we cannot align all texts
                // -> skip proper center adjustment
@@ -593,7 +613,7 @@ ArdourButton::on_size_request (Gtk::Requisition* req)
                        req->width = req->height;
                if (req->height < req->width)
                        req->height = req->width;
-       } else if ((_elements & (Menu | Indicator))) {
+       } else if (_text_width > 0 && !(_elements & (Menu | Indicator))) {
                // properly centered text for those elements that are centered
                if ((req->width - _text_width) & 1) { ++req->width; }
                if ((req->height - _text_height) & 1) { ++req->height; }
@@ -607,6 +627,7 @@ ArdourButton::on_size_request (Gtk::Requisition* req)
 void
 ArdourButton::set_colors ()
 {
+       _update_colors = false;
        if (_fixed_colors_set) {
                return;
        }
@@ -621,6 +642,7 @@ ArdourButton::set_colors ()
        led_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led active", name));
        led_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led", name));
 }
+
 /**
  * This sets the colors used for rendering based on two fixed values, rather
  * than basing them on the button name, and thus information in the GUI config
@@ -664,9 +686,7 @@ void ArdourButton::set_fixed_colors (const uint32_t color_active, const uint32_t
                RGBA_TO_UINT(  0,   0,   0,   255);  /* use black */
 
        /* XXX what about led colors ? */
-
-       build_patterns ();
-       set_name (""); /* this will trigger a "style-changed" message and then set_colors() */
+       CairoWidget::set_dirty ();
 }
 
 void
@@ -684,6 +704,7 @@ ArdourButton::build_patterns ()
 
        if (led_inset_pattern) {
                cairo_pattern_destroy (led_inset_pattern);
+               led_inset_pattern = 0;
        }
 
        //convex gradient
@@ -696,13 +717,11 @@ ArdourButton::build_patterns ()
        cairo_pattern_add_color_stop_rgba (concave_pattern, 0.0, 0,0,0, 0.5);
        cairo_pattern_add_color_stop_rgba (concave_pattern, 0.7, 0,0,0, 0.0);
 
-       if (_elements & Indicator) {
-               led_inset_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter);
-               cairo_pattern_add_color_stop_rgba (led_inset_pattern, 0, 0,0,0, 0.4);
-               cairo_pattern_add_color_stop_rgba (led_inset_pattern, 1, 1,1,1, 0.7);
-       }
+       led_inset_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter);
+       cairo_pattern_add_color_stop_rgba (led_inset_pattern, 0, 0,0,0, 0.4);
+       cairo_pattern_add_color_stop_rgba (led_inset_pattern, 1, 1,1,1, 0.7);
 
-       set_dirty ();
+       _pattern_height = get_height() ;
 }
 
 void
@@ -726,7 +745,7 @@ ArdourButton::on_button_press_event (GdkEventButton *ev)
        }
 
        _grabbed = true;
-       queue_draw ();
+       CairoWidget::set_dirty ();
 
        if (!_act_on_release) {
                if (_action) {
@@ -753,7 +772,7 @@ ArdourButton::on_button_release_event (GdkEventButton *ev)
        }
 
        _grabbed = false;
-       queue_draw ();
+       CairoWidget::set_dirty ();
 
        if (_hovering) {
                signal_clicked ();
@@ -781,9 +800,8 @@ ArdourButton::set_distinct_led_click (bool yn)
 void
 ArdourButton::color_handler ()
 {
-       set_colors ();
-       build_patterns ();
-       set_dirty ();
+       _update_colors = true;
+       CairoWidget::set_dirty ();
 }
 
 void
@@ -791,39 +809,38 @@ ArdourButton::on_size_allocate (Allocation& alloc)
 {
        CairoWidget::on_size_allocate (alloc);
        setup_led_rect ();
-       build_patterns ();
 }
 
 void
 ArdourButton::set_controllable (boost::shared_ptr<Controllable> c)
 {
-        watch_connection.disconnect ();
-        binding_proxy.set_controllable (c);
+       watch_connection.disconnect ();
+       binding_proxy.set_controllable (c);
 }
 
 void
 ArdourButton::watch ()
 {
-        boost::shared_ptr<Controllable> c (binding_proxy.get_controllable ());
-
-        if (!c) {
-                warning << _("button cannot watch state of non-existing Controllable\n") << endmsg;
-                return;
-        }
+       boost::shared_ptr<Controllable> c (binding_proxy.get_controllable ());
 
-        c->Changed.connect (watch_connection, invalidator(*this), boost::bind (&ArdourButton::controllable_changed, this), gui_context());
+       if (!c) {
+               warning << _("button cannot watch state of non-existing Controllable\n") << endmsg;
+               return;
+       }
+       c->Changed.connect (watch_connection, invalidator(*this), boost::bind (&ArdourButton::controllable_changed, this), gui_context());
 }
 
 void
 ArdourButton::controllable_changed ()
 {
-        float val = binding_proxy.get_controllable()->get_value();
+       float val = binding_proxy.get_controllable()->get_value();
 
        if (fabs (val) >= 0.5f) {
                set_active_state (Gtkmm2ext::ExplicitActive);
        } else {
                unset_active_state ();
        }
+       CairoWidget::set_dirty ();
 }
 
 void
@@ -864,7 +881,8 @@ ArdourButton::action_toggled ()
 void
 ArdourButton::on_style_changed (const RefPtr<Gtk::Style>&)
 {
-       on_name_changed();
+       _update_colors = true;
+       CairoWidget::set_dirty ();
 }
 
 void
@@ -873,9 +891,10 @@ ArdourButton::on_name_changed ()
        _char_pixel_width = 0;
        _char_pixel_height = 0;
        _diameter = 0;
-       set_colors ();
-       build_patterns ();
-       queue_resize ();
+       _update_colors = true;
+       if (is_realized()) {
+               queue_resize ();
+       }
 }
 
 void
@@ -909,7 +928,9 @@ void
 ArdourButton::set_image (const RefPtr<Gdk::Pixbuf>& img)
 {
        _pixbuf = img;
-       queue_draw ();
+       if (is_realized()) {
+               queue_resize ();
+       }
 }
 
 void
@@ -918,8 +939,8 @@ ArdourButton::set_active_state (Gtkmm2ext::ActiveState s)
        bool changed = (_active_state != s);
        CairoWidget::set_active_state (s);
        if (changed) {
-               set_colors ();
-               build_patterns ();
+               _update_colors = true;
+               CairoWidget::set_dirty ();
        }
 }
 
@@ -929,17 +950,16 @@ ArdourButton::set_visual_state (Gtkmm2ext::VisualState s)
        bool changed = (_visual_state != s);
        CairoWidget::set_visual_state (s);
        if (changed) {
-               set_colors ();
-               build_patterns ();
+               _update_colors = true;
+               CairoWidget::set_dirty ();
        }
 }
 
-
 bool
 ArdourButton::on_focus_in_event (GdkEventFocus* ev)
 {
        _focused = true;
-       queue_draw ();
+       CairoWidget::set_dirty ();
        return CairoWidget::on_focus_in_event (ev);
 }
 
@@ -947,7 +967,7 @@ bool
 ArdourButton::on_focus_out_event (GdkEventFocus* ev)
 {
        _focused = false;
-       queue_draw ();
+       CairoWidget::set_dirty ();
        return CairoWidget::on_focus_out_event (ev);
 }
 
@@ -971,7 +991,7 @@ ArdourButton::on_enter_notify_event (GdkEventCrossing* ev)
        _hovering = (_elements & Inactive) ? false : true;
 
        if (ARDOUR::Config->get_widget_prelight()) {
-               queue_draw ();
+               CairoWidget::set_dirty ();
        }
 
        return CairoWidget::on_enter_notify_event (ev);
@@ -983,7 +1003,7 @@ ArdourButton::on_leave_notify_event (GdkEventCrossing* ev)
        _hovering = false;
 
        if (ARDOUR::Config->get_widget_prelight()) {
-               queue_draw ();
+               CairoWidget::set_dirty ();
        }
 
        return CairoWidget::on_leave_notify_event (ev);
@@ -994,7 +1014,9 @@ ArdourButton::set_tweaks (Tweaks t)
 {
        if (_tweaks != t) {
                _tweaks = t;
-               queue_draw ();
+               if (is_realized()) {
+                       queue_resize ();
+               }
        }
 }
 
@@ -1009,27 +1031,71 @@ ArdourButton::action_sensitivity_changed ()
 }
 
 void
-ArdourButton::recalc_char_pixel_geometry ()
+ArdourButton::set_layout_ellisize_width (int w)
 {
-       if (_char_pixel_height > 0 && _char_pixel_width > 0) {
+       if (_layout_ellipsize_width == w) {
                return;
        }
+       _layout_ellipsize_width = w;
        if (!_layout) {
+               return;
+       }
+       if (_layout_ellipsize_width > 0) {
+       _layout->set_width (_layout_ellipsize_width);
+       }
+}
+
+void
+ArdourButton::set_text_ellipsize (Pango::EllipsizeMode e)
+{
+       if (_ellipsis == e) {
+               return;
+       }
+       _ellipsis = e;
+       if (!_layout) {
+               return;
+       }
+       _layout->set_ellipsize(_ellipsis);
+       if (_layout_ellipsize_width > 0) {
+               _layout->set_width (_layout_ellipsize_width);
+       }
+       if (is_realized ()) {
+               queue_resize ();
+       }
+}
+
+void
+ArdourButton::ensure_layout ()
+{
+       if (!_layout) {
+               ensure_style ();
                _layout = Pango::Layout::create (get_pango_context());
+               _layout->set_ellipsize(_ellipsis);
+               if (_layout_ellipsize_width > 0) {
+                       _layout->set_width (_layout_ellipsize_width);
+               }
+       }
+}
+
+void
+ArdourButton::recalc_char_pixel_geometry ()
+{
+       if (_char_pixel_height > 0 && _char_pixel_width > 0) {
+               return;
        }
+       ensure_layout();
        // NB. this is not static, since the geometry is different
        // depending on the font used.
        int w, h;
-       std::string t = _layout->get_text();
        std::string x = _("ABCDEFGHIJLKMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789");
        _layout->set_text (x);
        _layout->get_pixel_size (w, h);
-       _layout->set_text (t);
        _char_pixel_height = std::max(4, h);
        // number of actual chars in the string (not bytes)
        // Glib to the rescue.
        Glib::ustring gx(x);
        _char_pixel_width = std::max(4, w / (int)gx.size());
+       _layout->set_text (_text);
 }
 
 void
@@ -1053,10 +1119,12 @@ void
 ArdourButton::set_elements (Element e)
 {
        _elements = e;
+       CairoWidget::set_dirty ();
 }
 
 void
 ArdourButton::add_elements (Element e)
 {
        _elements = (ArdourButton::Element) (_elements | e);
+       CairoWidget::set_dirty ();
 }