hexapdf 0.11.9 → 0.13.0

data/lib/hexapdf/type/font_true_type.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -48,8 +48,12 @@ module HexaPDF
       private
 
       def perform_validation
-        super
-        yield("Required field FontDescriptor is not set", false) if self[:FontDescriptor].nil?
+        std_font = FontType1::StandardFonts.standard_font?(self[:BaseFont])
+        super(ignore_missing_font_fields: std_font)
+
+        if self[:FontDescriptor].nil? && !std_font
+          yield("Required field FontDescriptor is not set", false)
+        end
       end
 
     end

data/lib/hexapdf/type/font_type0.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -59,7 +59,7 @@ module HexaPDF
       # Returns the CID font of this type 0 font.
       def descendant_font
         document.cache(@data, :descendant_font) do
-          document.wrap(document.deref(self[:DescendantFonts][0]))
+          document.wrap(self[:DescendantFonts][0])
         end
       end
 

data/lib/hexapdf/type/font_type1.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -37,6 +37,7 @@
 require 'hexapdf/data_dir'
 require 'hexapdf/type/font_simple'
 require 'hexapdf/font/type1'
+require 'hexapdf/font/type1_wrapper'
 
 module HexaPDF
   module Type
@@ -105,6 +106,20 @@ module HexaPDF
       define_field :Subtype, type: Symbol, required: true, default: :Type1
       define_field :BaseFont, type: Symbol, required: true
 
+      # Overrides the default to provide a font wrapper in case none is set and the font is one of
+      # the standard fonts.
+      #
+      # See: Font#font_wrapper
+      def font_wrapper
+        if (tmp = super)
+          tmp
+        elsif StandardFonts.standard_font?(self[:BaseFont])
+          self.font_wrapper = HexaPDF::Font::Type1Wrapper.new(document,
+                                                              StandardFonts.font(self[:BaseFont]),
+                                                              pdf_object: self)
+        end
+      end
+
       # Returns the unscaled width of the given code point in glyph units, or 0 if the width for the
       # code point is missing.
       def width(code)

data/lib/hexapdf/type/font_type3.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/form.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -101,7 +101,8 @@ module HexaPDF
 
       # Returns the resource dictionary which is automatically created if it doesn't exist.
       def resources
-        self[:Resources] ||= document.wrap({}, type: :XXResources)
+        self[:Resources] ||= document.wrap({ProcSet: [:PDF, :Text, :ImageB, :ImageC, :ImageI]},
+                                           type: :XXResources)
       end
 
       # Processes the content stream of the form XObject with the given processor object.
@@ -126,13 +127,22 @@ module HexaPDF
       # The canvas object is cached once it is created so that its graphics state is correctly
       # retained without the need for parsing its contents.
       #
+      # If the bounding box of the form XObject doesn't have its origin at (0, 0), the canvas origin
+      # is translated into the bottom left corner so that this detail doesn't matter when using the
+      # canvas. This means that the canvas' origin is always at the bottom left corner of the
+      # bounding box.
+      #
       # *Note* that a canvas can only be retrieved for initially empty form XObjects!
       def canvas
         document.cache(@data, :canvas) do
           unless stream.empty?
             raise HexaPDF::Error, "Cannot create a canvas for a form XObjects with contents"
           end
+
           canvas = Content::Canvas.new(self)
+          if box.left != 0 || box.bottom != 0
+            canvas.save_graphics_state.translate(box.left, box.bottom)
+          end
           self.stream = canvas.stream_data
           set_filter(:FlateDecode)
           canvas

data/lib/hexapdf/type/graphics_state_parameter.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/icon_fit.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/image.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -150,7 +150,7 @@ module HexaPDF
         color_space, = *self[:ColorSpace]
         if color_space == :Indexed
           result.indexed = true
-          color_space, = *document.deref(self[:ColorSpace][1])
+          color_space, = *self[:ColorSpace][1]
         end
         case color_space
         when :DeviceRGB, :CalRGB
@@ -169,6 +169,8 @@ module HexaPDF
           result.writable = false if result.type == :png
         end
 
+        result.writable = false if self[:SMask]
+
         result
       end
 
@@ -238,7 +240,7 @@ module HexaPDF
         end
 
         if color_type == ImageLoader::PNG::INDEXED
-          palette_data = document.deref(self[:ColorSpace][3])
+          palette_data = self[:ColorSpace][3]
           palette_data = palette_data.stream unless palette_data.kind_of?(String)
           palette = ''.b
           if info.color_space == :rgb

data/lib/hexapdf/type/info.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/names.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/object_stream.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/page.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -304,7 +304,7 @@ module HexaPDF
       def contents
         Array(self[:Contents]).each_with_object("".b) do |content_stream, content|
           content << " " unless content.empty?
-          content << document.deref(content_stream).stream
+          content << content_stream.stream
         end
       end
 
@@ -323,10 +323,11 @@ module HexaPDF
         end
       end
 
-      # Returns the possibly inherited resource dictionary which is automatically created if it
+      # Returns the, possibly inherited, resource dictionary which is automatically created if it
       # doesn't exist.
       def resources
-        self[:Resources] ||= document.wrap({}, type: :XXResources)
+        self[:Resources] ||= document.wrap({ProcSet: [:PDF, :Text, :ImageB, :ImageC, :ImageI]},
+                                           type: :XXResources)
       end
 
       # Processes the content streams associated with the page with the given processor object.
@@ -344,8 +345,7 @@ module HexaPDF
         node = self
         while (parent_node = node[:Parent])
           parent_node[:Kids].each do |kid|
-            kid = document.deref(kid)
-            break if kid.data == node.data
+            break if kid == node
             idx += (kid.type == :Page ? 1 : kid[:Count])
           end
           node = parent_node
@@ -353,11 +353,26 @@ module HexaPDF
         idx
       end
 
+      # Returns all parent nodes of the page up to the root of the page tree.
+      #
+      # The direct parent is the first node in the array and the root node the last.
+      def ancestor_nodes
+        parent = self[:Parent]
+        result = [parent]
+        result << parent while (parent = parent[:Parent])
+        result
+      end
+
       # Returns the requested type of canvas for the page.
       #
       # The canvas object is cached once it is created so that its graphics state is correctly
       # retained without the need for parsing its contents.
       #
+      # If the media box of the page doesn't have its origin at (0, 0), the canvas origin is
+      # translated into the bottom left corner so that this detail doesn't matter when using the
+      # canvas. This means that the canvas' origin is always at the bottom left corner of the media
+      # box.
+      #
       # type::
       #    Can either be
       #    * :page for getting the canvas for the page itself (only valid for initially empty pages)
@@ -374,16 +389,25 @@ module HexaPDF
           raise HexaPDF::Error, "Cannot get the canvas for a page with contents"
         end
 
+        create_canvas = lambda do
+          Content::Canvas.new(self).tap do |canvas|
+            media_box = box(:media)
+            if media_box.left != 0 || media_box.bottom != 0
+              canvas.translate(media_box.left, media_box.bottom)
+            end
+          end
+        end
+
         contents = self[:Contents]
         if contents.nil?
-          page_canvas = document.cache(@data, :page_canvas, Content::Canvas.new(self))
+          page_canvas = document.cache(@data, :page_canvas, create_canvas.call)
           self[:Contents] = document.add({Filter: :FlateDecode},
                                          stream: page_canvas.stream_data)
         end
 
         if type == :overlay || type == :underlay
-          underlay_canvas = document.cache(@data, :underlay_canvas, Content::Canvas.new(self))
-          overlay_canvas = document.cache(@data, :overlay_canvas, Content::Canvas.new(self))
+          underlay_canvas = document.cache(@data, :underlay_canvas, create_canvas.call)
+          overlay_canvas = document.cache(@data, :overlay_canvas, create_canvas.call)
 
           stream = HexaPDF::StreamData.new do
             Fiber.yield(" q ")
@@ -396,11 +420,12 @@ module HexaPDF
           underlay = document.add({Filter: :FlateDecode}, stream: stream)
 
           stream = HexaPDF::StreamData.new do
-            Fiber.yield(" Q ")
+            Fiber.yield(" Q q ")
             fiber = overlay_canvas.stream_data.fiber
             while fiber.alive? && (data = fiber.resume)
               Fiber.yield(data)
             end
+            " Q "
           end
           overlay = document.add({Filter: :FlateDecode}, stream: stream)
 
@@ -448,8 +473,7 @@ module HexaPDF
         REQUIRED_INHERITABLE_FIELDS.each do |name|
           next if self[name]
           yield("Inheritable page field #{name} not set", name == :Resources)
-          self[:Resources] = {}
-          self[:Resources].validate(&block)
+          resources.validate(&block) if name == :Ressources
         end
       end
 

data/lib/hexapdf/type/page_tree_node.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -35,6 +35,7 @@
 #++
 
 require 'hexapdf/dictionary'
+require 'hexapdf/error'
 
 module HexaPDF
   module Type
@@ -159,38 +160,58 @@ module HexaPDF
       end
 
       # :call-seq:
-      #   pages.delete_page(page)        -> page or nil
-      #   pages.delete_page(index)       -> page or nil
+      #   pages.delete_page(page)
+      #   pages.delete_page(index)
       #
       # Deletes the given page or the page at the position specified by the zero-based index from
-      # the page tree and returns the deleted page object. If the page was not deleted, +nil+ is
-      # returned.
-      #
-      # Note that the page is *not* deleted from the document itself, only from the page tree! This
-      # also means that the /Parent entry of the page is set to +nil+ if deleted.
+      # the page tree and the document.
       #
       # Negative indices count backwards from the end, i.e. -1 is the last page.
       def delete_page(page)
         page = self.page(page) if page.kind_of?(Integer)
-        return nil unless page && page[:Parent]
+        return unless page && !page.null? && page[:Parent]
 
         parent = page[:Parent]
-        index = parent[:Kids].index {|kid| kid.data == page.data }
+        index = parent[:Kids].index(page)
 
         if index
-          ancestors = [parent]
-          ancestors << parent while (parent = parent[:Parent])
+          ancestors = page.ancestor_nodes
           return nil unless ancestors.include?(self)
 
           page[:Parent][:Kids].delete_at(index)
           page.delete(:Parent)
+          document.delete(page)
           ancestors.each {|node| node[:Count] -= 1 }
-          page
         else
-          nil
+          raise HexaPDF::Error, "Given page not found in page tree"
         end
       end
 
+      # :call-seq:
+      #   pages.move_page(page, to_index)
+      #   pages.move_page(index, to_index)
+      #
+      # Moves the given page or the page at the position specified by the zero-based index to the
+      # +to_index+ position.
+      #
+      # If the page that should be moved, doesn't exist or is invalid, an error is raised.
+      #
+      # Negative indices count backwards from the end, i.e. -1 is the last page. When using a
+      # negative index, the page will be moved after that element. So using an index of -1 will
+      # move the page after the last page.
+      def move_page(page, to_index)
+        page = self.page(page) if page.kind_of?(Integer)
+        if page.nil? || page.null? || !page[:Parent] ||
+            !(ancestors = page.ancestor_nodes).include?(self)
+          raise HexaPDF::Error, "The page to be moved doesn't exist in this page tree"
+        end
+
+        parent = page[:Parent]
+        insert_page(to_index, page)
+        ancestors.each {|node| node[:Count] -= 1 }
+        parent[:Kids].delete(page)
+      end
+
       # :call-seq:
       #   pages.each_page {|page| block }   -> pages
       #   pages.each_page                   -> Enumerator
@@ -225,7 +246,7 @@ module HexaPDF
       # Ensures that the /Count and /Parent fields of the whole page tree are set up correctly and
       # that there is at least one page node. This is therefore only done for the root node of the
       # page tree!
-      def perform_validation
+      def perform_validation(&block)
         super
         return if key?(:Parent)
 
@@ -258,7 +279,7 @@ module HexaPDF
 
         if self[:Count] == 0
           yield("A PDF document needs at least one page", true)
-          add_page.validate {|msg, correctable| yield(msg, correctable) }
+          add_page.validate(&block)
         end
       end
 

data/lib/hexapdf/type/resources.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -69,11 +69,10 @@ module HexaPDF
         when :DeviceRGB, :DeviceGray, :DeviceCMYK
           GlobalConfiguration.constantize('color_space.map', name).new
         else
-          space_definition = self[:ColorSpace] && self[:ColorSpace][name]
+          space_definition = (name == :Pattern ? name : self[:ColorSpace]&.[](name))
           if space_definition.nil?
             raise HexaPDF::Error, "Color space '#{name}' not found in the resources"
           elsif space_definition.kind_of?(Array)
-            space_definition.map! {|item| document.deref(item) }
             space_family = space_definition[0]
           else
             space_family = space_definition
@@ -168,6 +167,20 @@ module HexaPDF
         object_setter(:Properties, 'P', dict)
       end
 
+      # Returns the pattern dictionary stored under the given name.
+      #
+      # If the dictionary is not found, an error is raised.
+      def pattern(name)
+        object_getter(:Pattern, name)
+      end
+
+      # Adds the pattern dictionary to the resources and returns the name under which it is stored.
+      #
+      # If there already exists a name for the given dictionary, it is just returned.
+      def add_pattern(object)
+        object_setter(:Pattern, 'P', object)
+      end
+
       private
 
       # Helper method for returning an entry of a subdictionary.
@@ -206,6 +219,7 @@ module HexaPDF
         super
         val = self[:ProcSet]
         if !val
+          yield("No procedure set specified", true)
           self[:ProcSet] = [:PDF, :Text, :ImageB, :ImageC, :ImageI]
         else
           val.reject! do |name|