gtkthemingbackground.c 14.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/* GTK - The GIMP Toolkit
 * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
 * Copyright (C) 2011 Red Hat, Inc.
 * 
 * Authors: Carlos Garnacho <carlosg@gnome.org>
 *          Cosimo Cecchi <cosimoc@gnome.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

24 25
#include "config.h"

26 27 28 29
#include "gtkcsstypesprivate.h"
#include "gtkthemingbackgroundprivate.h"
#include "gtkthemingengineprivate.h"

30 31
#include <math.h>

32 33
#include <gdk/gdk.h>

34 35 36 37 38
/* this is in case round() is not provided by the compiler, 
 * such as in the case of C89 compilers, like MSVC
 */
#include "fallback-c89.c"

39 40 41 42
static void
_gtk_theming_background_apply_window_background (GtkThemingBackground *bg,
                                                 cairo_t              *cr)
{
43
  if (gtk_style_context_has_class (bg->context, "background"))
44 45 46 47 48 49 50 51 52 53 54 55 56
    {
      cairo_set_source_rgba (cr, 1.0, 1.0, 1.0, 0.0); /* transparent */
      cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
      cairo_paint (cr);
    }
}

static void
_gtk_theming_background_apply_origin (GtkThemingBackground *bg)
{
  GtkCssArea origin;
  cairo_rectangle_t image_rect;

57 58 59
  gtk_style_context_get (bg->context, bg->flags,
                         "background-origin", &origin,
                         NULL);
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85

  /* The default size of the background image depends on the
     background-origin value as this affects the top left
     and the bottom right corners. */
  switch (origin) {
  case GTK_CSS_AREA_BORDER_BOX:
    image_rect.x = 0;
    image_rect.y = 0;
    image_rect.width = bg->paint_area.width;
    image_rect.height = bg->paint_area.height;
    break;
  case GTK_CSS_AREA_CONTENT_BOX:
    image_rect.x = bg->border.left + bg->padding.left;
    image_rect.y = bg->border.top + bg->padding.top;
    image_rect.width = bg->paint_area.width - bg->border.left - bg->border.right - bg->padding.left - bg->padding.right;
    image_rect.height = bg->paint_area.height - bg->border.top - bg->border.bottom - bg->padding.top - bg->padding.bottom;
    break;
  case GTK_CSS_AREA_PADDING_BOX:
  default:
    image_rect.x = bg->border.left;
    image_rect.y = bg->border.top;
    image_rect.width = bg->paint_area.width - bg->border.left - bg->border.right;
    image_rect.height = bg->paint_area.height - bg->border.top - bg->border.bottom;
    break;
  }

86 87
  /* XXX: image_rect might have negative width/height here.
   * Do we need to do something about it? */
88 89 90 91 92 93 94 95
  bg->image_rect = image_rect;
}

static void
_gtk_theming_background_apply_clip (GtkThemingBackground *bg)
{
  GtkCssArea clip;

96 97 98
  gtk_style_context_get (bg->context, bg->flags,
                         "background-clip", &clip,
                         NULL);
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

  if (clip == GTK_CSS_AREA_PADDING_BOX)
    {
      _gtk_rounded_box_shrink (&bg->clip_box,
			       bg->border.top, bg->border.right,
			       bg->border.bottom, bg->border.left);
    }
  else if (clip == GTK_CSS_AREA_CONTENT_BOX)
    {
      _gtk_rounded_box_shrink (&bg->clip_box,
			       bg->border.top + bg->padding.top,
			       bg->border.right + bg->padding.right,
			       bg->border.bottom + bg->padding.bottom,
			       bg->border.left + bg->padding.left);
    }
}

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
static void
_gtk_theming_background_get_cover_contain (GtkCssImage *image,
                                           gboolean     cover,
                                           double       width,
                                           double       height,
                                           double      *concrete_width,
                                           double      *concrete_height)
{
  double aspect, image_aspect;
  
  image_aspect = _gtk_css_image_get_aspect_ratio (image);
  if (image_aspect == 0.0)
    {
      *concrete_width = width;
      *concrete_height = height;
      return;
    }

  aspect = width / height;

  if ((aspect >= image_aspect && cover) ||
      (aspect < image_aspect && !cover))
    {
      *concrete_width = width;
      *concrete_height = width / image_aspect;
    }
  else
    {
      *concrete_height = height;
      *concrete_width = height * image_aspect;
    }
}

149 150 151 152
static void
_gtk_theming_background_paint (GtkThemingBackground *bg,
                               cairo_t              *cr)
{
153 154
  cairo_save (cr);

155
  _gtk_rounded_box_path (&bg->clip_box, cr);
156 157
  cairo_clip (cr);

158
  gdk_cairo_set_source_rgba (cr, &bg->bg_color);
159
  cairo_paint (cr);
160

161 162 163
  if (bg->image
      && bg->image_rect.width > 0
      && bg->image_rect.height > 0)
164
    {
165
      GtkCssBackgroundRepeat hrepeat, vrepeat;
166
      GtkCssBackgroundSize *size;
167
      double image_width, image_height;
168
      double width, height;
169

170 171 172 173
      size = g_value_get_boxed (_gtk_style_context_peek_property (bg->context, "background-size"));
      gtk_style_context_get (bg->context, bg->flags,
                             "background-repeat", &hrepeat,
                             NULL);
174 175 176 177
      vrepeat = GTK_CSS_BACKGROUND_VERTICAL (hrepeat);
      hrepeat = GTK_CSS_BACKGROUND_HORIZONTAL (hrepeat);
      width = bg->image_rect.width;
      height = bg->image_rect.height;
178

179 180 181 182 183 184 185 186 187 188 189 190 191 192
      if (size->contain || size->cover)
        _gtk_theming_background_get_cover_contain (bg->image,
                                                   size->cover,
                                                   width,
                                                   height,
                                                   &image_width,
                                                   &image_height);
      else
        _gtk_css_image_get_concrete_size (bg->image,
                                          /* note: 0 does the right thing here for 'auto' */
                                          _gtk_css_number_get (&size->width, width),
                                          _gtk_css_number_get (&size->height, height),
                                          width, height,
                                          &image_width, &image_height);
193

194 195 196 197 198 199
      /* optimization */
      if (image_width == width)
        hrepeat = GTK_CSS_BACKGROUND_NO_REPEAT;
      if (image_height == height)
        vrepeat = GTK_CSS_BACKGROUND_NO_REPEAT;

200
      cairo_translate (cr, bg->image_rect.x, bg->image_rect.y);
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291

      if (hrepeat == GTK_CSS_BACKGROUND_NO_REPEAT && vrepeat == GTK_CSS_BACKGROUND_NO_REPEAT)
        {
          /* shortcut for normal case */
          _gtk_css_image_draw (bg->image, cr, image_width, image_height);
        }
      else
        {
          int surface_width, surface_height;
          cairo_surface_t *surface;
          cairo_t *cr2;

          /* If ‘background-repeat’ is ‘round’ for one (or both) dimensions,
           * there is a second step. The UA must scale the image in that
           * dimension (or both dimensions) so that it fits a whole number of
           * times in the background positioning area. In the case of the width
           * (height is analogous):
           *
           * If X ≠ 0 is the width of the image after step one and W is the width
           * of the background positioning area, then the rounded width
           * X' = W / round(W / X) where round() is a function that returns the
           * nearest natural number (integer greater than zero). 
           *
           * If ‘background-repeat’ is ‘round’ for one dimension only and if
           * ‘background-size’ is ‘auto’ for the other dimension, then there is
           * a third step: that other dimension is scaled so that the original
           * aspect ratio is restored. 
           */
          if (hrepeat == GTK_CSS_BACKGROUND_ROUND)
            {
              double n = round (width / image_width);

              n = MAX (1, n);

              if (vrepeat != GTK_CSS_BACKGROUND_ROUND
                  /* && vsize == auto (it is by default) */)
                image_height *= width / (image_width * n);
              image_width = width / n;
            }
          if (vrepeat == GTK_CSS_BACKGROUND_ROUND)
            {
              double n = round (height / image_height);

              n = MAX (1, n);

              if (hrepeat != GTK_CSS_BACKGROUND_ROUND
                  /* && hsize == auto (it is by default) */)
                image_width *= height / (image_height * n);
              image_height = height / n;
            }

          /* if hrepeat or vrepeat is 'space', we create a somewhat larger surface
           * to store the extra space. */
          if (hrepeat == GTK_CSS_BACKGROUND_SPACE)
            {
              double n = floor (width / image_width);
              surface_width = n ? round (width / n) : 0;
            }
          else
            surface_width = round (image_width);

          if (vrepeat == GTK_CSS_BACKGROUND_SPACE)
            {
              double n = floor (height / image_height);
              surface_height = n ? round (height / n) : 0;
            }
          else
            surface_height = round (image_height);

          surface = cairo_surface_create_similar (cairo_get_target (cr),
                                                  CAIRO_CONTENT_COLOR_ALPHA,
                                                  surface_width, surface_height);
          cr2 = cairo_create (surface);
          cairo_translate (cr2,
                           0.5 * (surface_width - image_width),
                           0.5 * (surface_height - image_height));
          _gtk_css_image_draw (bg->image, cr2, image_width, image_height);
          cairo_destroy (cr2);

          cairo_set_source_surface (cr, surface,
                                    /* background-position goes here */
                                    0, 0);
          cairo_pattern_set_extend (cairo_get_source (cr), CAIRO_EXTEND_REPEAT);
          cairo_surface_destroy (surface);

          cairo_rectangle (cr,
                           0, 0,
                           hrepeat == GTK_CSS_BACKGROUND_NO_REPEAT ? image_width : width,
                           vrepeat == GTK_CSS_BACKGROUND_NO_REPEAT ? image_height : height);
          cairo_fill (cr);
        }
292 293
    }

294
  cairo_restore (cr);
295 296 297 298 299 300 301 302
}

static void
_gtk_theming_background_apply_shadow (GtkThemingBackground *bg,
                                      cairo_t              *cr)
{
  GtkShadow *box_shadow;

303 304 305
  gtk_style_context_get (bg->context, bg->flags,
                         "box-shadow", &box_shadow,
                         NULL);
306 307 308 309 310 311 312 313 314

  if (box_shadow != NULL)
    {
      _gtk_box_shadow_render (box_shadow, cr, &bg->padding_box);
      _gtk_shadow_unref (box_shadow);
    }
}

static void
315
_gtk_theming_background_init_context (GtkThemingBackground *bg)
316
{
317
  bg->flags = gtk_style_context_get_state (bg->context);
318

319 320 321
  gtk_style_context_get_border (bg->context, bg->flags, &bg->border);
  gtk_style_context_get_padding (bg->context, bg->flags, &bg->padding);
  gtk_style_context_get_background_color (bg->context, bg->flags, &bg->bg_color);
322 323 324 325 326 327 328 329 330 331

  /* In the CSS box model, by default the background positioning area is
   * the padding-box, i.e. all the border-box minus the borders themselves,
   * which determines also its default size, see
   * http://dev.w3.org/csswg/css3-background/#background-origin
   *
   * In the future we might want to support different origins or clips, but
   * right now we just shrink to the default.
   */
  _gtk_rounded_box_init_rect (&bg->padding_box, 0, 0, bg->paint_area.width, bg->paint_area.height);
332 333

  _gtk_rounded_box_apply_border_radius_for_context (&bg->padding_box, bg->context, bg->flags, bg->junction);
334 335 336 337 338 339 340 341 342

  bg->clip_box = bg->padding_box;
  _gtk_rounded_box_shrink (&bg->padding_box,
			   bg->border.top, bg->border.right,
			   bg->border.bottom, bg->border.left);

  _gtk_theming_background_apply_clip (bg);
  _gtk_theming_background_apply_origin (bg);

343
  bg->image = g_value_get_object (_gtk_style_context_peek_property (bg->context, "background-image"));
344 345 346 347 348 349 350 351 352 353
}

void
_gtk_theming_background_init (GtkThemingBackground *bg,
                              GtkThemingEngine     *engine,
                              gdouble               x,
                              gdouble               y,
                              gdouble               width,
                              gdouble               height,
                              GtkJunctionSides      junction)
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
{
  GtkStyleContext *context;

  g_assert (bg != NULL);

  context = _gtk_theming_engine_get_context (engine);
  _gtk_theming_background_init_from_context (bg, context,
                                             x, y, width, height,
                                             junction);
}

void
_gtk_theming_background_init_from_context (GtkThemingBackground *bg,
                                           GtkStyleContext      *context,
                                           gdouble               x,
                                           gdouble               y,
                                           gdouble               width,
                                           gdouble               height,
                                           GtkJunctionSides      junction)
373 374 375
{
  g_assert (bg != NULL);

376
  bg->context = context;
377 378 379 380 381 382

  bg->paint_area.x = x;
  bg->paint_area.y = y;
  bg->paint_area.width = width;
  bg->paint_area.height = height;

383
  bg->image = NULL;
384 385
  bg->junction = junction;

386
  _gtk_theming_background_init_context (bg);
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
}

void
_gtk_theming_background_render (GtkThemingBackground *bg,
                                cairo_t              *cr)
{
  cairo_save (cr);
  cairo_translate (cr, bg->paint_area.x, bg->paint_area.y);

  _gtk_theming_background_apply_window_background (bg, cr);
  _gtk_theming_background_paint (bg, cr);
  _gtk_theming_background_apply_shadow (bg, cr);

  cairo_restore (cr);
}

gboolean
_gtk_theming_background_has_background_image (GtkThemingBackground *bg)
{
406
  return (bg->image != NULL) ? TRUE : FALSE;
407
}