gtk2/gtk/gtkrenderbackground.c

/* 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, see <http://www.gnu.org/licenses/>.
 */

#include "config.h"

#include "gtkrenderbackgroundprivate.h"

#include "gtkcssarrayvalueprivate.h"
#include "gtkcssbgsizevalueprivate.h"
#include "gtkcsscornervalueprivate.h"
#include "gtkcssenumvalueprivate.h"
#include "gtkcssimagevalueprivate.h"
#include "gtkcssnumbervalueprivate.h"
#include "gtkcssshadowsvalueprivate.h"
#include "gtkcsspositionvalueprivate.h"
#include "gtkcssrepeatvalueprivate.h"
#include "gtkcssrgbavalueprivate.h"
#include "gtkcssstyleprivate.h"
#include "gtkcsstypesprivate.h"

#include <math.h>

#include <gdk/gdk.h>

#include "gsk/gskroundedrectprivate.h"

/* 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"

typedef struct _GtkThemingBackground GtkThemingBackground;

#define N_BOXES (3)

struct _GtkThemingBackground {
  GtkCssStyle *style;

  GskRoundedRect boxes[N_BOXES];
};

static void
gtk_theming_background_snapshot_color (const GtkThemingBackground *bg,
                                       GtkSnapshot                *snapshot,
                                       const GdkRGBA              *bg_color,
                                       const GtkCssValue          *background_image)
{
  gint n_values = _gtk_css_array_value_get_n_values (background_image);
  GtkCssArea clip = _gtk_css_area_value_get 
    (_gtk_css_array_value_get_nth 
     (gtk_css_style_get_value (bg->style, GTK_CSS_PROPERTY_BACKGROUND_CLIP), 
      n_values - 1));

  if (gsk_rounded_rect_is_rectilinear (&bg->boxes[clip]))
    {
      gtk_snapshot_append_color (snapshot,
                                 bg_color,
                                 &bg->boxes[clip].bounds);
    }
  else
    {
      gtk_snapshot_push_rounded_clip (snapshot,
                                      &bg->boxes[clip]);
      gtk_snapshot_append_color (snapshot,
                                 bg_color,
                                 &bg->boxes[clip].bounds);
      gtk_snapshot_pop (snapshot);
    }
}

static void
gtk_theming_background_snapshot_layer (const GtkThemingBackground *bg,
                                       guint                       idx,
                                       GtkSnapshot                *snapshot)
{
  GtkCssRepeatStyle hrepeat, vrepeat;
  const GtkCssValue *pos, *repeat;
  GtkCssImage *image;
  const GskRoundedRect *origin, *clip;
  double image_width, image_height;
  double width, height;

  image = _gtk_css_image_value_get_image (
              _gtk_css_array_value_get_nth (
                  gtk_css_style_get_value (bg->style, GTK_CSS_PROPERTY_BACKGROUND_IMAGE),
                  idx));

  if (image == NULL)
    return;

  pos = _gtk_css_array_value_get_nth (gtk_css_style_get_value (bg->style, GTK_CSS_PROPERTY_BACKGROUND_POSITION), idx);
  repeat = _gtk_css_array_value_get_nth (gtk_css_style_get_value (bg->style, GTK_CSS_PROPERTY_BACKGROUND_REPEAT), idx);
  hrepeat = _gtk_css_background_repeat_value_get_x (repeat);
  vrepeat = _gtk_css_background_repeat_value_get_y (repeat);


  origin = &bg->boxes[
               _gtk_css_area_value_get (
                   _gtk_css_array_value_get_nth (
                       gtk_css_style_get_value (bg->style, GTK_CSS_PROPERTY_BACKGROUND_ORIGIN),
                       idx))];

  width = origin->bounds.size.width;
  height = origin->bounds.size.height;

  if (width <= 0 || height <= 0)
    return;

  clip = &bg->boxes[
              _gtk_css_area_value_get (
                                _gtk_css_array_value_get_nth (
                                                    gtk_css_style_get_value (bg->style, GTK_CSS_PROPERTY_BACKGROUND_CLIP),
                                                                      idx))];

  _gtk_css_bg_size_value_compute_size (_gtk_css_array_value_get_nth (gtk_css_style_get_value (bg->style, GTK_CSS_PROPERTY_BACKGROUND_SIZE), idx),
                                       image,
                                       width,
                                       height,
                                       &image_width,
                                       &image_height);

  if (image_width <= 0 || image_height <= 0)
    return;

  /* optimization */
  if (image_width == width)
    hrepeat = GTK_CSS_REPEAT_STYLE_NO_REPEAT;
  if (image_height == height)
    vrepeat = GTK_CSS_REPEAT_STYLE_NO_REPEAT;

  gtk_snapshot_push_debug (snapshot, "Layer %u", idx);
  gtk_snapshot_push_rounded_clip (snapshot, clip);

  gtk_snapshot_offset (snapshot, origin->bounds.origin.x, origin->bounds.origin.y);

  if (hrepeat == GTK_CSS_REPEAT_STYLE_NO_REPEAT && vrepeat == GTK_CSS_REPEAT_STYLE_NO_REPEAT)
    {
      /* shortcut for normal case */
      double x, y;

      x = _gtk_css_position_value_get_x (pos, width - image_width);
      y = _gtk_css_position_value_get_y (pos, height - image_height);

      gtk_snapshot_offset (snapshot, x, y);

      gtk_css_image_snapshot (image, snapshot, image_width, image_height);

      gtk_snapshot_offset (snapshot, -x, -y);
    }
  else
    {
      float repeat_width, repeat_height;
      float position_x, position_y;
      graphene_rect_t fill_rect;

      /* 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_REPEAT_STYLE_ROUND)
        {
          double n = round (width / image_width);

          n = MAX (1, n);

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

          n = MAX (1, n);

          if (hrepeat != GTK_CSS_REPEAT_STYLE_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_REPEAT_STYLE_SPACE)
        {
          double n = floor (width / image_width);
          repeat_width = n ? round (width / n) : 0;
        }
      else
        repeat_width = round (image_width);

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

      if (hrepeat == GTK_CSS_REPEAT_STYLE_NO_REPEAT)
        {
          fill_rect.origin.x = _gtk_css_position_value_get_x (pos, width - image_width);
          fill_rect.size.width = image_width;
        }
      else
        {
          fill_rect.origin.x = 0;
          fill_rect.size.width = width;
        }

      if (vrepeat == GTK_CSS_REPEAT_STYLE_NO_REPEAT)
        {
          fill_rect.origin.y = _gtk_css_position_value_get_y (pos, height - image_height);
          fill_rect.size.height = image_height;
        }
      else
        {
          fill_rect.origin.y = 0;
          fill_rect.size.height = height;
        }

      position_x = _gtk_css_position_value_get_x (pos, width - image_width);
      position_y = _gtk_css_position_value_get_y (pos, height - image_height);

      gtk_snapshot_push_repeat (snapshot,
                                &fill_rect,
                                &GRAPHENE_RECT_INIT (
                                    position_x, position_y,
                                    repeat_width, repeat_height
                                ));
                                
      gtk_snapshot_offset (snapshot,
                           position_x + 0.5 * (repeat_width - image_width),
                           position_y + 0.5 * (repeat_height - image_height));
      gtk_css_image_snapshot (image, snapshot, image_width, image_height);

      gtk_snapshot_pop (snapshot);
    }

  gtk_snapshot_offset (snapshot, - origin->bounds.origin.x, - origin->bounds.origin.y);

  gtk_snapshot_pop (snapshot);
  gtk_snapshot_pop (snapshot);
}

static void
gtk_theming_background_init (GtkThemingBackground *bg,
                             GtkCssStyle          *style,
                             double                width,
                             double                height)
{
  bg->style = style;

  gtk_rounded_boxes_init_for_style (&bg->boxes[GTK_CSS_AREA_BORDER_BOX],
                                    &bg->boxes[GTK_CSS_AREA_PADDING_BOX],
                                    &bg->boxes[GTK_CSS_AREA_CONTENT_BOX],
                                    style,
                                    0, 0, width, height);
}

void
gtk_css_style_snapshot_background (GtkCssStyle      *style,
                                   GtkSnapshot      *snapshot,
                                   gdouble           width,
                                   gdouble           height)
{
  GtkThemingBackground bg;
  gint idx;
  GtkCssValue *background_image;
  GtkCssValue *box_shadow;
  GtkCssValue *blend_modes;
  const GdkRGBA *bg_color;
  gint number_of_layers;
  GskBlendMode *blend_mode_values;

  background_image = gtk_css_style_get_value (style, GTK_CSS_PROPERTY_BACKGROUND_IMAGE);
  bg_color = _gtk_css_rgba_value_get_rgba (gtk_css_style_get_value (style, GTK_CSS_PROPERTY_BACKGROUND_COLOR));
  box_shadow = gtk_css_style_get_value (style, GTK_CSS_PROPERTY_BOX_SHADOW);

  /* This is the common default case of no background */
  if (gdk_rgba_is_clear (bg_color) &&
      _gtk_css_array_value_get_n_values (background_image) == 1 &&
      _gtk_css_image_value_get_image (_gtk_css_array_value_get_nth (background_image, 0)) == NULL &&
      _gtk_css_shadows_value_is_none (box_shadow))
    return;

  gtk_theming_background_init (&bg, style, width, height);

  gtk_snapshot_push_debug (snapshot, "CSS background");

  gtk_css_shadows_value_snapshot_outset (box_shadow,
                                         snapshot,
                                         &bg.boxes[GTK_CSS_AREA_BORDER_BOX]);

  blend_modes = gtk_css_style_get_value (style, GTK_CSS_PROPERTY_BACKGROUND_BLEND_MODE);
  number_of_layers = _gtk_css_array_value_get_n_values (background_image);
  blend_mode_values = g_alloca (sizeof (GskBlendMode) * number_of_layers);

  for (idx = number_of_layers - 1; idx >= 0; idx--)
    {
      blend_mode_values[idx] = _gtk_css_blend_mode_value_get (_gtk_css_array_value_get_nth (blend_modes, idx));

      if (blend_mode_values[idx] != GSK_BLEND_MODE_DEFAULT)
        gtk_snapshot_push_blend (snapshot, blend_mode_values[idx]);
    }

  if (!gdk_rgba_is_clear (bg_color))
    gtk_theming_background_snapshot_color (&bg, snapshot, bg_color, background_image);

  for (idx = number_of_layers - 1; idx >= 0; idx--)
    {
      if (blend_mode_values[idx] == GSK_BLEND_MODE_DEFAULT)
        {
          gtk_theming_background_snapshot_layer (&bg, idx, snapshot);
        }
      else
        {
          gtk_snapshot_pop (snapshot);
          gtk_theming_background_snapshot_layer (&bg, idx, snapshot);
          gtk_snapshot_pop (snapshot);
        }
    }

  gtk_css_shadows_value_snapshot_inset (box_shadow,
                                        snapshot,
                                        &bg.boxes[GTK_CSS_AREA_PADDING_BOX]);

  gtk_snapshot_pop (snapshot);
}