libs/canvas/text.cc

   1 /*
   2     Copyright (C) 2011-2013 Paul Davis
   3     Author: Carl Hetherington <cth@carlh.net>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #include <gdk/gdk.h>
  21
  22 #include <cairomm/cairomm.h>
  23 #include <gtkmm/window.h>
  24 #include <gtkmm/label.h>
  25
  26 #include "pbd/stacktrace.h"
  27
  28 #include "canvas/text.h"
  29 #include "canvas/canvas.h"
  30 #include "canvas/utils.h"
  31 #include "canvas/colors.h"
  32
  33 using namespace std;
  34 using namespace ArdourCanvas;
  35
  36
  37 Text::Text (Canvas* c)
  38         : Item (c)
  39         , _color (0x000000ff)
  40         , _font_description (0)
  41         , _alignment (Pango::ALIGN_LEFT)
  42         , _width (0)
  43         , _height (0)
  44         , _need_redraw (false)
  45         , _width_correction (-1)
  46         , _clamped_width (COORD_MAX)
  47 {
  48         _outline = false;
  49 }
  50
  51 Text::Text (Item* parent)
  52         : Item (parent)
  53         , _color (0x000000ff)
  54         , _font_description (0)
  55         , _alignment (Pango::ALIGN_LEFT)
  56         , _width (0)
  57         , _height (0)
  58         , _need_redraw (false)
  59         , _width_correction (-1)
  60         , _clamped_width (COORD_MAX)
  61 {
  62         _outline = false;
  63 }
  64
  65 Text::~Text ()
  66 {
  67         delete _font_description;
  68 }
  69
  70 void
  71 Text::set (string const & text)
  72 {
  73         begin_change ();
  74
  75         _text = text;
  76
  77         _need_redraw = true;
  78         _bounding_box_dirty = true;
  79
  80         end_change ();
  81 }
  82
  83 void
  84 Text::_redraw (Cairo::RefPtr<Cairo::Context> context) const
  85 {
  86         if (_text.empty()) {
  87                 return;
  88         }
  89
  90         Glib::RefPtr<Pango::Layout> layout = Pango::Layout::create (context);
  91
  92         __redraw (layout);
  93 }
  94
  95 void
  96 Text::_redraw (Glib::RefPtr<Pango::Context> context) const
  97 {
  98         if (_text.empty()) {
  99                 return;
 100         }
 101
 102         Glib::RefPtr<Pango::Layout> layout = Pango::Layout::create (context);
 103         __redraw (layout);
 104 }
 105
 106 void
 107 Text::__redraw (Glib::RefPtr<Pango::Layout> layout) const
 108 {
 109 #ifdef __APPLE__
 110         if (_width_correction < 0.0) {
 111                 // Pango returns incorrect text width on some OS X
 112                 // So we have to make a correction
 113                 // To determine the correct indent take the largest symbol for which the width is correct
 114                 // and make the calculation
 115                 Gtk::Window win;
 116                 Gtk::Label foo;
 117                 win.add (foo);
 118
 119                 int width = 0;
 120                 int height = 0;
 121                 Glib::RefPtr<Pango::Layout> test_layout = foo.create_pango_layout ("H");
 122                 if (_font_description) {
 123                         test_layout->set_font_description (*_font_description);
 124                 }
 125                 test_layout->get_pixel_size (width, height);
 126
 127                 _width_correction = width*1.5;
 128         }
 129 #else
 130         /* don't bother with a conditional here */
 131         _width_correction = 0.0;
 132 #endif
 133
 134         layout->set_text (_text);
 135
 136         if (_font_description) {
 137                 layout->set_font_description (*_font_description);
 138         }
 139
 140         layout->set_alignment (_alignment);
 141
 142         int w;
 143         int h;
 144
 145         layout->get_pixel_size (w, h);
 146
 147         _width = w + _width_correction;
 148         _height = h;
 149
 150 #ifdef __APPLE__
 151         _image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, _width * 2, _height * 2);
 152 #else
 153         _image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, _width, _height);
 154 #endif
 155
 156         Cairo::RefPtr<Cairo::Context> img_context = Cairo::Context::create (_image);
 157
 158 #ifdef __APPLE__
 159         /* Below, the rendering scaling is set to support retina display
 160          */
 161         img_context->scale (2, 2);
 162 #endif
 163
 164         /* and draw, in the appropriate color of course */
 165
 166         if (_outline) {
 167                 set_source_rgba (img_context, _outline_color);
 168                 layout->update_from_cairo_context (img_context);
 169                 pango_cairo_layout_path (img_context->cobj(), layout->gobj());
 170                 img_context->stroke_preserve ();
 171                 set_source_rgba (img_context, _color);
 172                 img_context->fill ();
 173         } else {
 174                 set_source_rgba (img_context, _color);
 175                 layout->show_in_cairo_context (img_context);
 176         }
 177
 178         /* text has now been rendered in _image and is ready for blit in
 179          * ::render
 180          */
 181
 182         _need_redraw = false;
 183 }
 184
 185 void
 186 Text::render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const
 187 {
 188         if (_text.empty()) {
 189                 return;
 190         }
 191
 192         Rect self = item_to_window (Rect (0, 0, min (_clamped_width, (double)_image->get_width ()), _image->get_height ()));
 193         boost::optional<Rect> i = self.intersection (area);
 194
 195         if (!i) {
 196                 return;
 197         }
 198
 199         if (_need_redraw) {
 200                 _redraw (context);
 201         }
 202
 203         Rect intersection (i.get());
 204
 205         context->rectangle (intersection.x0, intersection.y0, intersection.width(), intersection.height());
 206 #ifdef __APPLE__
 207         /* Below, the rendering scaling is set to support retina display
 208          */
 209         Cairo::Matrix original_matrix = context->get_matrix();
 210         context->scale (0.5, 0.5);
 211         context->set_source (_image, self.x0 * 2, self.y0 * 2);
 212         context->fill ();
 213         context->set_matrix (original_matrix);
 214 #else
 215         context->set_source (_image, self.x0, self.y0);
 216         context->fill ();
 217 #endif
 218 }
 219
 220 void
 221 Text::clamp_width (double w)
 222 {
 223         begin_change ();
 224         _clamped_width = w;
 225         _bounding_box_dirty = true;
 226         end_change ();
 227 }
 228
 229 void
 230 Text::compute_bounding_box () const
 231 {
 232         if (!_canvas || _text.empty()) {
 233                 _bounding_box = boost::optional<Rect> ();
 234                 _bounding_box_dirty = false;
 235                 return;
 236         }
 237
 238         if (_bounding_box_dirty) {
 239                 if (_need_redraw || !_image) {
 240                         Glib::RefPtr<Pango::Context> context = Glib::wrap (gdk_pango_context_get()); // context now owns C object and will free it
 241                         _redraw (context);
 242                 }
 243                 _bounding_box = Rect (0, 0, min (_clamped_width, (double) _image->get_width()), _image->get_height());
 244                 _bounding_box_dirty = false;
 245         }
 246 }
 247
 248 void
 249 Text::set_alignment (Pango::Alignment alignment)
 250 {
 251         begin_change ();
 252
 253         _alignment = alignment;
 254         _need_redraw = true;
 255         _bounding_box_dirty = true;
 256         end_change ();
 257 }
 258
 259 void
 260 Text::set_font_description (Pango::FontDescription font_description)
 261 {
 262         begin_change ();
 263
 264         _font_description = new Pango::FontDescription (font_description);
 265         _need_redraw = true;
 266         _width_correction = -1.0;
 267
 268         _bounding_box_dirty = true;
 269         end_change ();
 270 }
 271
 272 void
 273 Text::set_color (Color color)
 274 {
 275         begin_change ();
 276
 277         _color = color;
 278         if (_outline) {
 279                 set_outline_color (contrasting_text_color (_color));
 280         }
 281         _need_redraw = true;
 282
 283         end_change ();
 284 }
 285
 286
 287 void
 288 Text::dump (ostream& o) const
 289 {
 290         Item::dump (o);
 291
 292         o << _canvas->indent() << '\t' << " text = " << _text << endl
 293           << _canvas->indent() << " color = " << _color;
 294
 295         o << endl;
 296 }
 297
 298
 299 double
 300 Text::text_width() const
 301 {
 302     if (_need_redraw) {
 303         redraw ();
 304     }
 305
 306     return _width;
 307 }