hexapdf 0.10.0 → 0.11.0

data/lib/hexapdf/type/acro_form/form.rb

@@ -0,0 +1,124 @@
+# -*- encoding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2019 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
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF 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 Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#
+# If the GNU Affero General Public License doesn't fit your need,
+# commercial licenses are available at <https://gettalong.at/hexapdf/>.
+#++
+
+require 'hexapdf/dictionary'
+require 'hexapdf/stream'
+require 'hexapdf/utils/bit_field'
+
+module HexaPDF
+  module Type
+    module AcroForm
+
+      # Represents the PDF's interactive form dictionary. It is linked from the catalog dictionary
+      # via the /AcroForm entry.
+      #
+      # See: PDF1.7 s12.7.2
+      class Form < Dictionary
+
+        extend Utils::BitField
+
+        define_type :XXAcroForm
+
+        define_field :Fields,          type: PDFArray, required: true, version: '1.2'
+        define_field :NeedAppearances, type: Boolean, default: false
+        define_field :SigFlags,        type: Integer, version: '1.3'
+        define_field :CO,              type: PDFArray, version: '1.3'
+        define_field :DR,              type: :Ressources
+        define_field :DA,              type: String
+        define_field :XFA,             type: [Stream, PDFArray], version: '1.5'
+
+        bit_field(:raw_signature_flags, {signatures_exist: 0, append_only: 1},
+                  lister: "signature_flags", getter: "signature_flag?", setter: "signature_flag")
+
+        # Returns an array with all root fields that were found in the PDF document.
+        def find_root_fields
+          result = []
+          document.pages.each do |page|
+            page[:Annots].each do |annot|
+              if !annot.key?(:Parent) && annot.key?(:FT)
+                result << document.wrap(annot, type: :XXAcroFormField)
+              elsif annot.key?(:Parent)
+                field = annot[:Parent]
+                field = field[:Parent] while field[:Parent]
+                result << document.wrap(field, type: :XXAcroFormField)
+              end
+            end
+          end
+          result
+        end
+
+        # Finds all root fields and sets /Fields appropriately.
+        #
+        # See: #find_root_fields
+        def find_root_fields!
+          self[:Fields] = find_root_fields
+        end
+
+        # :call-seq:
+        #   acroform.each_field(terminal_only: true) {|field| block}    -> acroform
+        #   acroform.each_field(terminal_only: true)                    -> Enumerator
+        #
+        # Yields all terminal fields or all fields, depending on the +terminal_only+ argument.
+        def each_field(terminal_only: true)
+          return to_enum(__method__, terminal_only: terminal_only) unless block_given?
+
+          process_field = lambda do |field|
+            field = document.wrap(field, type: :XXAcroFormField)
+            yield(field) if field.terminal_field? || !terminal_only
+            field[:Kids].each(&process_field) unless field.terminal_field?
+          end
+
+          self[:Fields]&.each(&process_field)
+          self
+        end
+
+        private
+
+        # Helper method for bit field getter access.
+        def raw_signature_flags
+          self[:SigFlags]
+        end
+
+        # Helper method for bit field setter access.
+        def raw_signature_flags=(value)
+          self[:SigFlags] = value
+        end
+
+      end
+
+    end
+  end
+end

data/lib/hexapdf/type/action.rb

@@ -51,7 +51,7 @@ module HexaPDF
 
       define_field :Type, type: Symbol, default: type
       define_field :S,    type: Symbol, required: true
-      define_field :Next, type: [Dictionary, Array], version: '1.2'
+      define_field :Next, type: [Dictionary, PDFArray], version: '1.2'
 
     end
 

data/lib/hexapdf/type/actions/go_to.rb

@@ -46,7 +46,7 @@ module HexaPDF
       class GoTo < Action
 
         define_field :S, type: Symbol, required: true, default: :GoTo
-        define_field :D, type: [Symbol, PDFByteString, Array], required: true
+        define_field :D, type: [Symbol, PDFByteString, PDFArray], required: true
 
       end
 

data/lib/hexapdf/type/actions/go_to_r.rb

@@ -47,7 +47,7 @@ module HexaPDF
 
         define_field :S,         type: Symbol, required: true, default: :GoToR
         define_field :F,         type: :Filespec, required: true
-        define_field :D,         type: [Symbol, PDFByteString, Array], required: true
+        define_field :D,         type: [Symbol, PDFByteString, PDFArray], required: true
         define_field :NewWindow, type: Boolean, version: '1.2'
 
       end

data/lib/hexapdf/type/actions/launch.rb

@@ -52,7 +52,7 @@ module HexaPDF
 
           define_field :F, type: PDFByteString, required: true
           define_field :D, type: PDFByteString
-          define_field :O, type: String
+          define_field :O, type: String, default: 'open', allowed_values: ['open', 'print']
           define_field :P, type: PDFByteString
 
         end

data/lib/hexapdf/type/annotation.rb

@@ -60,8 +60,8 @@ module HexaPDF
       define_field :F,            type: Integer, default: 0, version: '1.1'
       define_field :AP,           type: Dictionary, version: '1.2'
       define_field :AS,           type: Symbol, version: '1.2'
-      define_field :Border,       type: Array, default: [0, 0, 1]
-      define_field :C,            type: Array, version: '1.1'
+      define_field :Border,       type: PDFArray, default: [0, 0, 1]
+      define_field :C,            type: PDFArray, version: '1.1'
       define_field :StructParent, type: Integer, version: '1.3'
       define_field :OC,           type: Dictionary, version: '1.5'
 

data/lib/hexapdf/type/annotations.rb

@@ -47,6 +47,7 @@ module HexaPDF
       autoload(:MarkupAnnotation, 'hexapdf/type/annotations/markup_annotation')
       autoload(:Text, 'hexapdf/type/annotations/text')
       autoload(:Link, 'hexapdf/type/annotations/link')
+      autoload(:Widget, 'hexapdf/type/annotations/widget')
 
     end
 

data/lib/hexapdf/type/annotations/link.rb

@@ -48,24 +48,13 @@ module HexaPDF
 
         define_field :Subtype,    type: Symbol, required: true, default: :Link
         define_field :A,          type: Dictionary, version: '1.1'
-        define_field :Dest,       type: [Symbol, PDFByteString, Array]
-        define_field :H,          type: Symbol, default: :I, version: '1.2'
+        define_field :Dest,       type: [Symbol, PDFByteString, PDFArray]
+        define_field :H,          type: Symbol, default: :I, allowed_values: [:N, :I, :O, :P],
+                                  version: '1.2'
         define_field :PA,         type: Dictionary, version: '1.3'
-        define_field :QuadPoints, type: Array, version: '1.6'
+        define_field :QuadPoints, type: PDFArray, version: '1.6'
         define_field :BS,         type: Dictionary, version: '1.6'
 
-        private
-
-        HIGHLIGHTING_MODES = [:N, :I, :O, :P].freeze # :nodoc:
-
-        def perform_validation #:nodoc:
-          super
-
-          if key?(:H) && !HIGHLIGHTING_MODES.include?(self[:H])
-            yield("/H contains invalid value #{self[:H]}")
-          end
-        end
-
       end
 
     end

data/lib/hexapdf/type/annotations/markup_annotation.rb

@@ -53,7 +53,8 @@ module HexaPDF
         define_field :CreationDate, type: PDFDate, version: '1.5'
         define_field :IRT,          type: Dictionary, version: '1.5'
         define_field :Subj,         type: String, version: '1.5'
-        define_field :RT,           type: Symbol, default: :R, version: '1.6'
+        define_field :RT,           type: Symbol, default: :R, allowed_values: [:R, :Group],
+                                    version: '1.6'
         define_field :IT,           type: Symbol, version: '1.6'
         define_field :ExData,       type: Dictionary, version: '1.7'
 

data/lib/hexapdf/type/annotations/text.rb

@@ -49,8 +49,9 @@ module HexaPDF
         define_field :Subtype,    type: Symbol, required: true, default: :Text
         define_field :Open,       type: Boolean, default: false
         define_field :Name,       type: Symbol, default: :Note
-        define_field :State,      type: String, version: '1.5'
-        define_field :StateModel, type: String, version: '1.5'
+        define_field :State,      type: String, version: '1.5',
+          allowed_values: %w[Marked Unmarked Accepted Rejected Cancelled Completed None]
+        define_field :StateModel, type: String, allowed_values: ['Review', 'Marked'], version: '1.5'
 
         private
 
@@ -64,10 +65,6 @@ module HexaPDF
         def perform_validation #:nodoc:
           super
 
-          if key?(:StateModel) && self[:StateModel] != "Review" && self[:StateModel] != "Marked"
-            yield("/StateModel contains invalid value #{self[:StateModel]}")
-          end
-
           if key?(:State) && !key?(:StateModel)
             state_model = STATE_TO_STATE_MODEL[self[:State]]
             yield("/StateModel required if /State set", !state_model.nil?)

data/lib/hexapdf/type/annotations/widget.rb

@@ -0,0 +1,90 @@
+# -*- encoding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2019 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
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF 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 Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#
+# If the GNU Affero General Public License doesn't fit your need,
+# commercial licenses are available at <https://gettalong.at/hexapdf/>.
+#++
+
+require 'hexapdf/type/annotation'
+
+module HexaPDF
+  module Type
+    module Annotations
+
+      # Widget annotations are used by interactive forms to represent the appearance of fields and
+      # to manage user interactions.
+      #
+      # See: PDF1.7 s12.5.6.19, HexaPDF::Type::Annotation
+      class Widget < Annotation
+
+        # The dictionary used by the /MK key of the widget annotation.
+        class AppearanceCharacteristics < Dictionary
+
+          define_type :XXAppearanceCharacteristics
+
+          define_field :R,  type: Integer, default: 0
+          define_field :BC, type: PDFArray
+          define_field :BG, type: PDFArray
+          define_field :CA, type: String
+          define_field :RC, type: String
+          define_field :AC, type: String
+          define_field :I,  type: Stream
+          define_field :RI, type: Stream
+          define_field :IX, type: Stream
+          define_field :IF, type: :XXIconFit
+          define_field :TP, type: Integer, default: 0, allowed_values: [0, 1, 2, 3, 4, 5, 6]
+
+          private
+
+          def perform_validation #:nodoc:
+            super
+
+            if key?(:R) && self[:R] % 90 != 0
+              yield("Value of field R needs to be a multiple of 90")
+            end
+          end
+
+        end
+
+        define_field :Subtype, type: Symbol, required: true, default: :Widget
+        define_field :H,       type: Symbol, allowed_values: [:N, :I, :O, :P, :T]
+        define_field :MK,      type: :XXAppearanceCharacteristics
+        define_field :A,       type: Dictionary, version: '1.1'
+        define_field :AA,      type: Dictionary, version: '1.2'
+        define_field :BS,      type: Dictionary, version: '1.2'
+        define_field :Parent,  type: Dictionary
+
+      end
+
+    end
+  end
+end

data/lib/hexapdf/type/catalog.rb

@@ -60,25 +60,28 @@ module HexaPDF
       define_field :Names,             type: :XXNames, version: '1.2'
       define_field :Dests,             type: Dictionary, version: '1.1'
       define_field :ViewerPreferences, type: :XXViewerPreferences, version: '1.2'
-      define_field :PageLayout,        type: Symbol,     default: :SinglePage
-      define_field :PageMode,          type: Symbol,     default: :UseNone
+      define_field :PageLayout,        type: Symbol,     default: :SinglePage,
+        allowed_values: [:SinglePage, :OneColumn, :TwoColumnLeft, :TwoColumnRight,
+                         :TwoPageLeft, :TwoPageRight]
+      define_field :PageMode,          type: Symbol,     default: :UseNone,
+        allowed_values: [:UseNone, :UseOutlines, :UseThumbs, :FullScreen, :UseOC, :UseAttachments]
       define_field :Outlines,          type: Dictionary, indirect: true
-      define_field :Threads,           type: Array,      version: '1.1'
-      define_field :OpenAction,        type: [Dictionary, Array], version: '1.1'
+      define_field :Threads,           type: PDFArray,   version: '1.1'
+      define_field :OpenAction,        type: [Dictionary, PDFArray], version: '1.1'
       define_field :AA,                type: Dictionary, version: '1.4'
       define_field :URI,               type: Dictionary, version: '1.1'
-      define_field :AcroForm,          type: Dictionary, version: '1.2'
+      define_field :AcroForm,          type: :XXAcroForm, version: '1.2'
       define_field :Metadata,          type: Stream,     indirect: true, version: '1.4'
       define_field :StructTreeRoot,    type: Dictionary, version: '1.3'
       define_field :MarkInfo,          type: Dictionary, version: '1.4'
       define_field :Lang,              type: String,     version: '1.4'
       define_field :SpiderInfo,        type: Dictionary, version: '1.3'
-      define_field :OutputIntents,     type: Array,      version: '1.4'
+      define_field :OutputIntents,     type: PDFArray,   version: '1.4'
       define_field :PieceInfo,         type: Dictionary, version: '1.4'
       define_field :OCProperties,      type: Dictionary, version: '1.5'
       define_field :Perms,             type: Dictionary, version: '1.5'
       define_field :Legal,             type: Dictionary, version: '1.5'
-      define_field :Requirements,      type: Array,      version: '1.7'
+      define_field :Requirements,      type: PDFArray,   version: '1.7'
       define_field :Collection,        type: Dictionary, version: '1.7'
       define_field :NeedsRendering,    type: Boolean,    version: '1.7'
 
@@ -91,7 +94,7 @@ module HexaPDF
       #
       # See: PageTreeNode
       def pages
-        self[:Pages] ||= document.add(Type: :Pages)
+        self[:Pages] ||= document.add({Type: :Pages})
       end
 
       private
@@ -101,7 +104,7 @@ module HexaPDF
         super
         unless key?(:Pages)
           yield("A PDF document needs a page tree", true)
-          value[:Pages] = document.add(Type: :Pages)
+          value[:Pages] = document.add({Type: :Pages})
           value[:Pages].validate {|msg, correctable| yield(msg, correctable) }
         end
       end

data/lib/hexapdf/type/cid_font.rb

@@ -51,9 +51,9 @@ module HexaPDF
       define_field :CIDSystemInfo,   type: Dictionary, required: true
       define_field :FontDescriptor,  type: :FontDescriptor, indirect: true, required: true
       define_field :DW,              type: Integer, default: DEFAULT_WIDTH
-      define_field :W,               type: Array
-      define_field :DW2,             type: Array, default: [880, -1100]
-      define_field :W2,              type: Array
+      define_field :W,               type: PDFArray
+      define_field :DW2,             type: PDFArray, default: [880, -1100]
+      define_field :W2,              type: PDFArray
 
       # Returns the unscaled width of the given CID in glyph units, or 0 if the width for the CID is
       # missing.

data/lib/hexapdf/type/file_specification.rb

@@ -85,7 +85,7 @@ module HexaPDF
       define_field :DOS,  type: PDFByteString
       define_field :Mac,  type: PDFByteString
       define_field :Unix, type: PDFByteString
-      define_field :ID,   type: Array
+      define_field :ID,   type: PDFArray
       define_field :V,    type: Boolean, version: '1.2'
       define_field :EF,   type: :XXFilespecEFDictionary, version: '1.7'
       define_field :RF,   type: Dictionary, version: '1.3'
@@ -192,7 +192,7 @@ module HexaPDF
         self.path = name
 
         self[:EF] ||= {}
-        ef_stream = self[:EF][:UF] = self[:EF][:F] = document.add(Type: :EmbeddedFile)
+        ef_stream = self[:EF][:UF] = self[:EF][:F] = document.add({Type: :EmbeddedFile})
         stat = if file_or_io.kind_of?(String)
                  File.stat(file_or_io)
                elsif file_or_io.respond_to?(:stat)

data/lib/hexapdf/type/font_descriptor.rb

@@ -54,8 +54,11 @@ module HexaPDF
       define_field :Type,         type: Symbol, required: true, default: type
       define_field :FontName,     type: Symbol, required: true
       define_field :FontFamily,   type: PDFByteString, version: '1.5'
-      define_field :FontStretch,  type: Symbol, version: '1.5'
-      define_field :FontWeight,   type: Numeric, version: '1.5'
+      define_field :FontStretch,  type: Symbol, version: '1.5',
+        allowed_values: [:UltraCondensed, :ExtraCondensed, :Condensed, :SemiCondensed,
+                         :Normal, :SemiExpanded, :Expanded, :ExtraExpanded, :UltraExpanded]
+      define_field :FontWeight,   type: Numeric, version: '1.5',
+        allowed_values: [100, 200, 300, 400, 500, 600, 700, 800, 900]
       define_field :Flags,        type: Integer, required: true
       define_field :FontBBox,     type: Rectangle
       define_field :ItalicAngle,  type: Numeric, required: true

data/lib/hexapdf/type/font_simple.rb

@@ -49,7 +49,7 @@ module HexaPDF
 
       define_field :FirstChar, type: Integer
       define_field :LastChar, type: Integer
-      define_field :Widths, type: Array
+      define_field :Widths, type: PDFArray
       define_field :FontDescriptor, type: :FontDescriptor, indirect: true
       define_field :Encoding, type: [Dictionary, Symbol]