squib 0.8.0 → 0.9.0

data/lib/squib/graphics/cairo_context_wrapper.rb

@@ -1,99 +1,113 @@
-require 'forwardable'
-require 'squib/graphics/gradient_regex'
-
-module Squib
-  module Graphics
-    # Wrapper class for the Cairo context. Private.
-    # @api private
-    class CairoContextWrapper
-      extend Forwardable
-
-      # :nodoc:
-      # @api private
-      attr_accessor :cairo_cxt
-
-      # :nodoc:
-      # @api private
-      def initialize(cairo_cxt)
-        @cairo_cxt = cairo_cxt
-      end
-
-      def_delegators :cairo_cxt, :save, :set_source_color, :paint, :restore,
-        :translate, :rotate, :move_to, :update_pango_layout, :width, :height,
-        :show_pango_layout, :rounded_rectangle, :set_line_width, :stroke, :fill,
-        :set_source, :scale, :render_rsvg_handle, :circle, :triangle, :line_to,
-        :operator=, :show_page, :clip, :transform, :mask, :create_pango_layout,
-        :antialias=, :curve_to, :matrix, :matrix=, :identity_matrix, :pango_layout_path,
-        :stroke_preserve, :target, :new_path, :fill_preserve, :close_path,
-        :set_line_join, :set_line_cap, :set_dash
-
-      # :nodoc:
-      # @api private
-      def set_source_squibcolor(arg)
-        raise 'nil is not a valid color' if arg.nil?
-        if match = arg.match(LINEAR_GRADIENT)
-          x1, y1, x2, y2 = match.captures
-          linear = Cairo::LinearPattern.new(x1.to_f, y1.to_f, x2.to_f, y2.to_f)
-          arg.scan(STOPS).each do |color, offset|
-            linear.add_color_stop(offset.to_f, color)
-          end
-          @cairo_cxt.set_source(linear)
-        elsif match = arg.match(RADIAL_GRADIENT)
-          x1, y1, r1, x2, y2, r2  = match.captures
-          linear = Cairo::RadialPattern.new(x1.to_f, y1.to_f, r1.to_f,
-                                            x2.to_f, y2.to_f, r2.to_f)
-          arg.scan(STOPS).each do |color, offset|
-            linear.add_color_stop(offset.to_f, color)
-          end
-          @cairo_cxt.set_source(linear)
-        else
-          @cairo_cxt.set_source_color(arg)
-        end
-      end
-
-      # Convenience method for a common task
-      # @api private
-      def fill_n_stroke(draw)
-        return stroke_n_fill(draw) if draw.stroke_strategy == :stroke_first
-        set_source_squibcolor draw.fill_color
-        fill_preserve
-        set_source_squibcolor draw.stroke_color
-        set_line_width draw.stroke_width
-        set_line_join draw.join
-        set_line_cap draw.cap
-        set_dash draw.dash
-        stroke
-      end
-
-      def stroke_n_fill(draw)
-        return fill_n_stroke(draw) if draw.stroke_strategy == :fill_first
-        set_source_squibcolor draw.stroke_color
-        set_line_width draw.stroke_width
-        set_line_join draw.join
-        set_line_cap draw.cap
-        set_dash draw.dash
-        stroke_preserve
-        set_source_squibcolor draw.fill_color
-        fill
-      end
-
-      # Convenience method for a common task
-      # @api private
-      def fancy_stroke(draw)
-        set_source_squibcolor draw.stroke_color
-        set_line_width draw.stroke_width
-        set_line_join draw.join
-        set_line_cap draw.cap
-        set_dash draw.dash
-        stroke
-      end
-
-      def rotate_about(x, y, angle)
-        translate(x, y)
-        rotate(angle)
-        translate(-x, -y)
-      end
-
-    end
-  end
-end
+require 'forwardable'
+require 'squib/graphics/gradient_regex'
+
+module Squib
+  module Graphics
+    # Wrapper class for the Cairo context. Private.
+    # @api private
+    class CairoContextWrapper
+      extend Forwardable
+
+      # :nodoc:
+      # @api private
+      attr_accessor :cairo_cxt
+
+      # :nodoc:
+      # @api private
+      def initialize(cairo_cxt)
+        @cairo_cxt = cairo_cxt
+      end
+
+      def_delegators :cairo_cxt, :save, :set_source_color, :paint, :restore,
+        :translate, :rotate, :move_to, :update_pango_layout, :width, :height,
+        :show_pango_layout, :rounded_rectangle, :set_line_width, :stroke, :fill,
+        :set_source, :scale, :render_rsvg_handle, :circle, :triangle, :line_to,
+        :operator=, :show_page, :clip, :transform, :mask, :create_pango_layout,
+        :antialias=, :curve_to, :matrix, :matrix=, :identity_matrix, :pango_layout_path,
+        :stroke_preserve, :target, :new_path, :fill_preserve, :close_path,
+        :set_line_join, :set_line_cap, :set_dash
+
+      # :nodoc:
+      # @api private
+      def set_source_squibcolor(arg)
+        raise 'nil is not a valid color' if arg.nil?
+        if match = arg.match(LINEAR_GRADIENT)
+          x1, y1, x2, y2 = match.captures
+          linear = Cairo::LinearPattern.new(x1.to_f, y1.to_f, x2.to_f, y2.to_f)
+          arg.scan(STOPS).each do |color, offset|
+            linear.add_color_stop(offset.to_f, color)
+          end
+          linear.matrix = matrix # match the coordinate systems - see bug 127
+          @cairo_cxt.set_source(linear)
+        elsif match = arg.match(RADIAL_GRADIENT)
+          x1, y1, r1, x2, y2, r2  = match.captures
+          radial = Cairo::RadialPattern.new(x1.to_f, y1.to_f, r1.to_f,
+                                            x2.to_f, y2.to_f, r2.to_f)
+          radial.matrix = matrix # match the coordinate systems - see bug 127
+          arg.scan(STOPS).each do |color, offset|
+            radial.add_color_stop(offset.to_f, color)
+          end
+          @cairo_cxt.set_source(radial)
+        else
+          @cairo_cxt.set_source_color(arg)
+        end
+      end
+
+      # Convenience method for a common task
+      # @api private
+      def fill_n_stroke(draw)
+        return stroke_n_fill(draw) if draw.stroke_strategy == :stroke_first
+        set_source_squibcolor draw.fill_color
+        fill_preserve
+        set_source_squibcolor draw.stroke_color
+        set_line_width draw.stroke_width
+        set_line_join draw.join
+        set_line_cap draw.cap
+        set_dash draw.dash
+        stroke
+      end
+
+      def stroke_n_fill(draw)
+        return fill_n_stroke(draw) if draw.stroke_strategy == :fill_first
+        set_source_squibcolor draw.stroke_color
+        set_line_width draw.stroke_width
+        set_line_join draw.join
+        set_line_cap draw.cap
+        set_dash draw.dash
+        stroke_preserve
+        set_source_squibcolor draw.fill_color
+        fill
+      end
+
+      # Convenience method for a common task
+      # @api private
+      def fancy_stroke(draw)
+        set_source_squibcolor draw.stroke_color
+        set_line_width draw.stroke_width
+        set_line_join draw.join
+        set_line_cap draw.cap
+        set_dash draw.dash
+        stroke
+      end
+
+      def rotate_about(x, y, angle)
+        translate(x, y)
+        rotate(angle)
+        translate(-x, -y)
+      end
+
+      # Flip either vertical or horizontal depending
+      # From the cairo website: http://cairographics.org/matrix_transform/
+      # cairo.Matrix(fx, 0,         0,
+      #              fy, cx*(1-fx), cy*(fy-1))
+      # fx/fy = 1 means 'no flip', fx/fy = -1 are used for horizontal/vertical flip
+      def flip(vertical, horizontal, x, y)
+        v = vertical   ? -1.0 : 1.0
+        h = horizontal ? -1.0 : 1.0
+        transform Cairo::Matrix.new(v, 0.0,     0.0,
+                                    h, x*(1-v), y*(1-h))
+      end
+
+    end
+  end
+end

data/lib/squib/graphics/gradient_regex.rb

@@ -1,47 +1,47 @@
-module Squib
-  # @api private
-  module Graphics
-    STOPS = /   # used to capture the stops
-      \s*         # leading whitespace is ok
-      (\#?[\w]+)  # color
-      @           # no spaces here
-      (\d+\.?\d*) # offset number
-    /x
-
-    LINEAR_GRADIENT = /
-      \( \s*      # coordinate 1
-         (\d+\.?\d*) \s* # x1 number
-         ,\s*            # whitespace after comma is ok
-         (\d+\.?\d*) \s* # y1 number
-      \)
-      \s*        # space between coordinates is ok
-      \( \s*      # coordinate 2
-         (\d+\.?\d*) \s* # x2 number
-         ,\s*            # whitespace after comma is ok
-         (\d+\.?\d*) \s* # y2 number
-      \)
-      (#{STOPS})+ # stops
-      \s*         # trailing whitespace is ok
-    /x
-
-    RADIAL_GRADIENT = /
-      \( \s*      # coordinate 1
-        (\d+\.?\d*) \s* # x1 number
-        ,\s*            # whitespace after comma is ok
-        (\d+\.?\d*) \s* # y1 number
-        ,\s*            # whitespace after comma is ok
-        (\d+\.?\d*) \s* # r1 number
-      \)
-      \s*         # space between coordinates is ok
-      \( \s*      # coordinate 2
-        (\d+\.?\d*) \s* # x2 number
-        ,\s*            # whitespace after comma is ok
-        (\d+\.?\d*) \s* # y2 number
-        ,\s*            # whitespace after comma is ok
-        (\d+\.?\d*) \s* # r2 number
-      \)
-      (#{STOPS})+ # stops
-      \s*         # trailing whitespace is ok
-    /x
-  end
+module Squib
+  # @api private
+  module Graphics
+    STOPS = /   # used to capture the stops
+      \s*         # leading whitespace is ok
+      (\#?[\w]+)  # color
+      @           # no spaces here
+      (\d+\.?\d*) # offset number
+    /x
+
+    LINEAR_GRADIENT = /
+      \( \s*      # coordinate 1
+         (\d+\.?\d*) \s* # x1 number
+         ,\s*            # whitespace after comma is ok
+         (\d+\.?\d*) \s* # y1 number
+      \)
+      \s*        # space between coordinates is ok
+      \( \s*      # coordinate 2
+         (\d+\.?\d*) \s* # x2 number
+         ,\s*            # whitespace after comma is ok
+         (\d+\.?\d*) \s* # y2 number
+      \)
+      (#{STOPS})+ # stops
+      \s*         # trailing whitespace is ok
+    /x
+
+    RADIAL_GRADIENT = /
+      \( \s*      # coordinate 1
+        (\d+\.?\d*) \s* # x1 number
+        ,\s*            # whitespace after comma is ok
+        (\d+\.?\d*) \s* # y1 number
+        ,\s*            # whitespace after comma is ok
+        (\d+\.?\d*) \s* # r1 number
+      \)
+      \s*         # space between coordinates is ok
+      \( \s*      # coordinate 2
+        (\d+\.?\d*) \s* # x2 number
+        ,\s*            # whitespace after comma is ok
+        (\d+\.?\d*) \s* # y2 number
+        ,\s*            # whitespace after comma is ok
+        (\d+\.?\d*) \s* # r2 number
+      \)
+      (#{STOPS})+ # stops
+      \s*         # trailing whitespace is ok
+    /x
+  end
 end

data/lib/squib/graphics/hand.rb

@@ -1,42 +1,42 @@
-require 'squib/graphics/cairo_context_wrapper'
-
-module Squib
-  class Deck
-
-    # Draw cards in a fan.
-    # @api private
-    def render_hand(range, sheet, hand)
-      cards       = range.collect { |i| @cards[i] }
-      center_x    = width / 2.0
-      center_y    = hand.radius + height
-      out_size    = 3.0 * center_y
-      angle_delta = (hand.angle_range.last - hand.angle_range.first) / cards.size
-      cxt = Cairo::Context.new(Cairo::RecordingSurface.new(0, 0, out_size, out_size))
-      cxt.translate(out_size / 2.0, out_size / 2.0)
-      cxt.rotate(hand.angle_range.first)
-      cxt.translate(-width, -width)
-      cards.each_with_index do |card, i|
-        cxt.translate(center_x, center_y)
-        cxt.rotate(angle_delta)
-        cxt.translate(-center_x, -center_y)
-        card.use_cairo do |card_cxt|
-          cxt.rounded_rectangle(sheet.trim, sheet.trim,
-                                width - (2 * sheet.trim), height - (2 * sheet.trim),
-                                sheet.trim_radius, sheet.trim_radius)
-          cxt.clip
-          cxt.set_source(card_cxt.target)
-          cxt.paint
-          cxt.reset_clip
-        end
-      end
-      x, y, w, h = cxt.target.ink_extents # I love Ruby assignment ;)
-      png_cxt = Squib::Graphics::CairoContextWrapper.new(Cairo::Context.new(Cairo::ImageSurface.new(w + 2*sheet.margin, h + 2*sheet.margin)))
-      png_cxt.set_source_squibcolor(sheet.fill_color)
-      png_cxt.paint
-      png_cxt.translate(-x + sheet.margin, -y + sheet.margin)
-      png_cxt.set_source(cxt.target)
-      png_cxt.paint
-      png_cxt.target.write_to_png sheet.full_filename
-    end
-  end
-end
+require 'squib/graphics/cairo_context_wrapper'
+
+module Squib
+  class Deck
+
+    # Draw cards in a fan.
+    # @api private
+    def render_hand(range, sheet, hand)
+      cards       = range.collect { |i| @cards[i] }
+      center_x    = width / 2.0
+      center_y    = hand.radius + height
+      out_size    = 3.0 * center_y
+      angle_delta = (hand.angle_range.last - hand.angle_range.first) / cards.size
+      cxt = Cairo::Context.new(Cairo::RecordingSurface.new(0, 0, out_size, out_size))
+      cxt.translate(out_size / 2.0, out_size / 2.0)
+      cxt.rotate(hand.angle_range.first)
+      cxt.translate(-width, -width)
+      cards.each_with_index do |card, i|
+        cxt.translate(center_x, center_y)
+        cxt.rotate(angle_delta)
+        cxt.translate(-center_x, -center_y)
+        card.use_cairo do |card_cxt|
+          cxt.rounded_rectangle(sheet.trim, sheet.trim,
+                                width - (2 * sheet.trim), height - (2 * sheet.trim),
+                                sheet.trim_radius, sheet.trim_radius)
+          cxt.clip
+          cxt.set_source(card_cxt.target)
+          cxt.paint
+          cxt.reset_clip
+        end
+      end
+      x, y, w, h = cxt.target.ink_extents # I love Ruby assignment ;)
+      png_cxt = Squib::Graphics::CairoContextWrapper.new(Cairo::Context.new(Cairo::ImageSurface.new(w + 2*sheet.margin, h + 2*sheet.margin)))
+      png_cxt.set_source_squibcolor(sheet.fill_color)
+      png_cxt.paint
+      png_cxt.translate(-x + sheet.margin, -y + sheet.margin)
+      png_cxt.set_source(cxt.target)
+      png_cxt.paint
+      png_cxt.target.write_to_png sheet.full_filename
+    end
+  end
+end

data/lib/squib/graphics/image.rb

@@ -1,76 +1,103 @@
-module Squib
-
-  # Cache all pngs we've already loaded
-  #
-  # :nodoc:
-  # @api private
-  def cache_load_image(file)
-    @img_cache ||= {}
-    @img_cache[file] || @img_cache[file] = Cairo::ImageSurface.from_png(file)
-  end
-  module_function :cache_load_image
-
-  class Card
-
-    # :nodoc:
-    # @api private
-    def png(file, box, paint, trans)
-      Squib.logger.debug {"RENDERING PNG: \n  file: #{file}\n  box: #{box}\n  paint: #{paint}\n  trans: #{trans}"}
-      return if file.nil? or file.eql? ''
-      png = Squib.cache_load_image(file)
-      use_cairo do |cc|
-        cc.translate(box.x, box.y)
-        if box.width != :native || box.height != :native
-          box.width  = png.width.to_f  if box.width  == :native
-          box.height = png.height.to_f if box.height == :native
-          box.width  = png.width.to_f * box.height.to_f / png.height.to_f if box.width == :scale
-          box.height = png.height.to_f * box.width.to_f / png.width.to_f  if box.height == :scale
-          Squib.logger.warn "PNG scaling results in aliasing."
-          cc.scale(box.width.to_f / png.width.to_f, box.height.to_f / png.height.to_f)
-        end
-        cc.rotate(trans.angle)
-        cc.translate(-box.x, -box.y)
-        cc.set_source(png, box.x, box.y)
-        cc.operator = paint.blend unless paint.blend == :none
-        if paint.mask.empty?
-          cc.paint(paint.alpha)
-        else
-          cc.set_source_squibcolor(paint.mask)
-          cc.mask(png, box.x, box.y)
-        end
-      end
-    end
-
-    # :nodoc:
-    # @api private
-    def svg(file, svg_args, box, paint, trans)
-      Squib.logger.debug {"Rendering: #{file}, id: #{id} @#{x},#{y} #{width}x#{height}, alpha: #{alpha}, blend: #{blend}, angle: #{angle}, mask: #{mask}"}
-      Squib.logger.warn 'Both an SVG file and SVG data were specified' unless file.to_s.empty? || svg_args.data.to_s.empty?
-      return if (file.nil? or file.eql? '') and svg_args.data.nil? # nothing specified TODO Move this out to arg validator
-      svg_args.data = File.read(file) if svg_args.data.to_s.empty?
-      svg          = RSVG::Handle.new_from_data(svg_args.data)
-      box.width    = svg.width  if box.width == :native
-      box.height   = svg.height if box.height == :native
-      box.width  = svg.width.to_f * box.height.to_f / svg.height.to_f if box.width == :scale
-      box.height = svg.height.to_f * box.width.to_f / svg.width.to_f  if box.height == :scale
-      scale_width  = box.width.to_f / svg.width.to_f
-      scale_height = box.height.to_f / svg.height.to_f
-      use_cairo do |cc|
-        cc.translate(box.x, box.y)
-        cc.rotate(trans.angle)
-        cc.scale(scale_width, scale_height)
-        cc.operator = paint.blend unless paint.blend == :none
-        if paint.mask.to_s.empty?
-          cc.render_rsvg_handle(svg, svg_args.id)
-        else
-          tmp = Cairo::ImageSurface.new(box.width / scale_width, box.height / scale_height)
-          tmp_cc = Cairo::Context.new(tmp)
-          tmp_cc.render_rsvg_handle(svg, svg_args.id)
-          cc.set_source_squibcolor(paint.mask)
-          cc.mask(tmp, 0, 0)
-        end
-      end
-    end
-
-  end
-end
+module Squib
+
+  # Cache all pngs we've already loaded
+  #
+  # :nodoc:
+  # @api private
+  def cache_load_image(file)
+    @img_cache ||= {}
+    @img_cache[file] || @img_cache[file] = Cairo::ImageSurface.from_png(file)
+  end
+  module_function :cache_load_image
+
+  class Card
+
+    # :nodoc:
+    # @api private
+    def png(file, box, paint, trans)
+      Squib.logger.debug {"RENDERING PNG: \n  file: #{file}\n  box: #{box}\n  paint: #{paint}\n  trans: #{trans}"}
+      return if file.nil? or file.eql? ''
+      png = Squib.cache_load_image(file)
+      use_cairo do |cc|
+        cc.translate(box.x, box.y)
+        box.width    = png.width.to_f  if box.width  == :native
+        box.height   = png.height.to_f if box.height == :native
+        box.width    = png.width.to_f * box.height.to_f / png.height.to_f if box.width == :scale
+        box.height   = png.height.to_f * box.width.to_f / png.width.to_f  if box.height == :scale
+
+        scale_width  = box.width.to_f / png.width.to_f
+        scale_height = box.height.to_f / png.height.to_f
+        warn_png_scale(file, scale_width, scale_height)
+        cc.scale(scale_width, scale_height)
+
+        cc.rotate(trans.angle)
+        cc.flip(trans.flip_vertical, trans.flip_horizontal, box.width / 2, box.height / 2)
+        cc.translate(-box.x, -box.y)
+
+        trans.crop_width  = png.width.to_f  if trans.crop_width  == :native
+        trans.crop_height = png.height.to_f if trans.crop_height == :native
+        cc.rounded_rectangle(box.x, box.y, trans.crop_width, trans.crop_height, trans.crop_corner_x_radius, trans.crop_corner_y_radius)
+        cc.clip
+        cc.translate(-trans.crop_x, -trans.crop_y)
+
+
+        cc.set_source(png, box.x, box.y)
+        cc.operator = paint.blend unless paint.blend == :none
+        if paint.mask.empty?
+          cc.paint(paint.alpha)
+        else
+          cc.set_source_squibcolor(paint.mask)
+          cc.mask(png, box.x, box.y)
+        end
+      end
+    end
+
+    # :nodoc:
+    # @api private
+    def warn_png_scale(file, scale_width, scale_height)
+      if @deck.conf.warn_png_scale? && (scale_width > 1.0 || scale_height > 1.0)
+        Squib.logger.warn "PNG is being upscaled - antialiasing could result: #{file}"
+      end
+    end
+
+    # :nodoc:
+    # @api private
+    def svg(file, svg_args, box, paint, trans)
+      Squib.logger.debug {"Rendering: #{file}, id: #{id} @#{x},#{y} #{width}x#{height}, alpha: #{alpha}, blend: #{blend}, angle: #{angle}, mask: #{mask}"}
+      Squib.logger.warn 'Both an SVG file and SVG data were specified' unless file.to_s.empty? || svg_args.data.to_s.empty?
+      return if (file.nil? or file.eql? '') and svg_args.data.nil? # nothing specified TODO Move this out to arg validator
+      svg_args.data = File.read(file) if svg_args.data.to_s.empty?
+      svg          = RSVG::Handle.new_from_data(svg_args.data)
+      box.width    = svg.width  if box.width == :native
+      box.height   = svg.height if box.height == :native
+      box.width  = svg.width.to_f * box.height.to_f / svg.height.to_f if box.width == :scale
+      box.height = svg.height.to_f * box.width.to_f / svg.width.to_f  if box.height == :scale
+      scale_width  = box.width.to_f / svg.width.to_f
+      scale_height = box.height.to_f / svg.height.to_f
+      use_cairo do |cc|
+        cc.translate(box.x, box.y)
+        cc.flip(trans.flip_vertical, trans.flip_horizontal, box.width / 2, box.height / 2)
+        cc.rotate(trans.angle)
+        cc.scale(scale_width, scale_height)
+
+        trans.crop_width  = box.width  if trans.crop_width  == :native
+        trans.crop_height = box.height if trans.crop_height == :native
+        cc.rounded_rectangle(0, 0, trans.crop_width / scale_width, trans.crop_height / scale_height, trans.crop_corner_x_radius, trans.crop_corner_y_radius)
+        cc.clip
+        cc.translate(-trans.crop_x, -trans.crop_y)
+
+        cc.operator = paint.blend unless paint.blend == :none
+        if paint.mask.to_s.empty?
+          cc.render_rsvg_handle(svg, svg_args.id)
+        else
+          tmp = Cairo::ImageSurface.new(box.width / scale_width, box.height / scale_height)
+          tmp_cc = Cairo::Context.new(tmp)
+          tmp_cc.render_rsvg_handle(svg, svg_args.id)
+          cc.set_source_squibcolor(paint.mask)
+          cc.mask(tmp, 0, 0)
+        end
+      end
+    end
+
+  end
+end