hexapdf 0.11.9 → 0.12.0

data/lib/hexapdf/type/catalog.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
@@ -97,6 +97,26 @@ module HexaPDF
         self[:Pages] ||= document.add({Type: :Pages})
       end
 
+      # Returns the main AcroForm object.
+      #
+      # * If an AcroForm object exists, the +create+ argument is not used.
+      #
+      # * If no AcroForm object exists and +create+ is +true+, a new AcroForm object with default
+      #   settings will be created and returned.
+      #
+      # * If no AcroForm object exists and +create+ is +false+, +nil+ is returned.
+      #
+      # See: AcroForm::Form
+      def acro_form(create: false)
+        if (form = self[:AcroForm])
+          form
+        elsif create
+          form = self[:AcroForm] = document.add({}, type: :XXAcroForm)
+          form.set_default_appearance_string
+          form
+        end
+      end
+
       private
 
       # Ensures that there is a valid page tree.

data/lib/hexapdf/type/cid_font.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/embedded_file.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/file_specification.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/font.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
@@ -50,6 +50,23 @@ module HexaPDF
       define_field :Type, type: Symbol, required: true, default: type
       define_field :ToUnicode, type: Stream, version: '1.2'
 
+      # Retrieves the font wrapper that is needed when this font is used for text output. Returns
+      # +nil+ if this font can't be used for text output.
+      #
+      # Note: For internal use only!
+      #
+      # See: HexaPDF::Font
+      def font_wrapper
+        @font_wrapper ||= nil
+      end
+
+      # Sets the font wrapper.
+      #
+      # See: #font_wrapper
+      def font_wrapper=(font)
+        @font_wrapper = font
+      end
+
       # Font objects must always be indirect.
       def must_be_indirect?
         true

data/lib/hexapdf/type/font_descriptor.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
@@ -84,7 +84,7 @@ module HexaPDF
 
       bit_field(:raw_flags, {fixed_pitch: 0, serif: 1, symbolic: 2, script: 3, nonsymbolic: 5,
                              italic: 6, all_cap: 16, small_cap: 17, force_bold: 18},
-                lister: "flags", getter: "flagged?", setter: "flag")
+                lister: "flags", getter: "flagged?", setter: "flag", unsetter: 'unflag')
 
       private
 

data/lib/hexapdf/type/font_simple.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/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

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

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

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
@@ -169,6 +169,8 @@ module HexaPDF
           result.writable = false if result.type == :png
         end
 
+        result.writable = false if self[:SMask]
+
         result
       end
 

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

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,20 +160,16 @@ 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 }
@@ -184,10 +181,10 @@ module HexaPDF
 
           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
 

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.

data/lib/hexapdf/type/trailer.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
@@ -54,8 +54,7 @@ module HexaPDF
     # HexaPDF::Revision object's trailer dictionary is always of this type. Only when a
     # cross-reference stream is written is the trailer integrated into the stream's dictionary.
     #
-    # See: PDF1.7 s7.5.5, s14.4
-    #      XRefStream
+    # See: PDF1.7 s7.5.5, s14.4; XRefStream
     class Trailer < Dictionary
 
       define_type :XXTrailer

data/lib/hexapdf/type/viewer_preferences.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/xref_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/utils/bit_field.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
@@ -43,45 +43,59 @@ module HexaPDF
 
       # Creates a bit field for managing the integer attribute +name+.
       #
-      # The +mapping+ argument specifies the mapping of names to bit indices which allows one to use
-      # either the bit name or its index when getting or setting. When using an unknown bit name or
-      # bit index, an error is raised.
+      # The +mapping+ argument specifies the mapping of names to zero-based bit indices which allows
+      # one to use either the bit name or its index when getting or setting. When using an unknown
+      # bit name or bit index, an error is raised.
       #
       # The calling class needs to respond to \#name and \#name= because these methods are used to
-      # get and set the raw integer value.
+      # get and set the raw integer value; or provide custom method names using the +value_getter+
+      # and +value_setter+ arguments.
       #
-      # After invoking the method the calling class has three new instance methods:
+      # After invoking the method the calling class has four new instance methods:
       #
       # * NAME_values which returns an array of bit names representing the set bits.
       # * NAME_include?(bit) which returns true if the given bit is set.
       # * set_NAME(*bits, clear_existing: false) for setting the given bits.
+      # * unset_NAME(*bits) for clearing the given bits.
       #
-      # The method names can be overridden using the arguments +lister+, +getter+ and +setter+.
+      # The method names can be overridden using the arguments +lister+, +getter+, +setter+ and
+      # +unsetter+.
       def bit_field(name, mapping, lister: "#{name}_values", getter: "#{name}_include?",
-                    setter: "set_#{name}")
-        bit_names = mapping.keys
+                    setter: "set_#{name}", unsetter: "unset_#{name}", value_getter: name,
+                    value_setter: "self.#{name}")
         mapping.default_proc = proc do |h, k|
           if h.value?(k)
-            h[k] = k
+            k
           else
             raise ArgumentError, "Invalid bit field name or index '#{k}' for #{self.name}##{name}"
           end
         end
-        value_getter = name
-        value_setter = "#{name}="
 
-        define_method(lister) do
-          bit_names.map {|n| send(getter, n) ? n : nil }.compact
-        end
-        define_method(getter) do |bit|
-          (send(value_getter) || 0)[mapping[bit]] == 1
-        end
-        define_method(setter) do |*bits, clear_existing: false|
-          send(value_setter, 0) if clear_existing || send(value_getter).nil?
-          result = send(value_getter)
-          bits.each {|bit| result |= 1 << mapping[bit] }
-          send(value_setter, result)
-        end
+        module_eval(<<-EOF, __FILE__, __LINE__ + 1)
+          #{name.upcase}_BIT_MAPPING = mapping.freeze
+
+          def #{lister}
+            self.class::#{name.upcase}_BIT_MAPPING.keys.map {|n| #{getter}(n) ? n : nil }.compact
+          end
+
+          def #{getter}(bit)
+            (#{value_getter} || 0)[self.class::#{name.upcase}_BIT_MAPPING[bit]] == 1
+          end
+
+          def #{setter}(*bits, clear_existing: false)
+            #{value_setter} = 0 if clear_existing || #{value_getter}.nil?
+            result = #{value_getter}
+            bits.each {|bit| result |= 1 << self.class::#{name.upcase}_BIT_MAPPING[bit] }
+            #{value_setter} =  result
+          end
+
+          def #{unsetter}(*bits)
+            result = #{value_getter} || 0
+            return if result == 0
+            bits.each {|bit| result &= ~(1 << self.class::#{name.upcase}_BIT_MAPPING[bit]) }
+            #{value_setter} = result
+          end
+        EOF
       end
 
     end