hexapdf 0.5.0 → 0.6.0

data/lib/hexapdf/type/annotation.rb

@@ -0,0 +1,85 @@
+# -*- encoding: utf-8 -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2017 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.
+#++
+
+require 'hexapdf/dictionary'
+require 'hexapdf/utils/bit_field'
+
+module HexaPDF
+  module Type
+
+    # Annotations are used to associate objects like notes, sounds or movies with a location on a
+    # PDF page or allow the user to interact with a PDF document using a keyboard or mouse.
+    #
+    # See: PDF1.7 s12.5
+    class Annotation < Dictionary
+
+      extend Utils::BitField
+
+      define_type :Annot
+
+      define_field :Type,         type: Symbol, default: self.type
+      define_field :Subtype,      type: Symbol, required: true
+      define_field :Rect,         type: Rectangle, required: true
+      define_field :Contents,     type: String
+      define_field :P,            type: Dictionary, version: '1.3'
+      define_field :NM,           type: String, version: '1.4'
+      define_field :M,            type: PDFDate, version: '1.1'
+      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 :StructParent, type: Integer, version: '1.3'
+      define_field :OC,           type: Dictionary, version: '1.5'
+
+      bit_field(:raw_flags, {invisible: 0, hidden: 1, print: 2, no_zoom: 3, no_rotate: 4,
+                             no_view: 5, read_only: 6, locked: 7, toggle_no_view: 8,
+                             locked_contents: 9},
+                lister: "flags", getter: "flagged?", setter: "flag")
+
+      private
+
+      # Helper method for bit field getter access.
+      def raw_flags
+        self[:F]
+      end
+
+      # Helper method for bit field setter access.
+      def raw_flags=(value)
+        self[:F] = value
+      end
+
+    end
+
+  end
+end

data/lib/hexapdf/type/annotations.rb

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2017 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.
+#++
+
+module HexaPDF
+  module Type
+
+    autoload(:Annotation, 'hexapdf/type/annotation')
+
+    # Namespace module for all PDF annotation dictionary types.
+    #
+    # See: PDF1.7 s12.5.6, Annotation
+    module Annotations
+
+      autoload(:MarkupAnnotation, 'hexapdf/type/annotations/markup_annotation')
+      autoload(:Text, 'hexapdf/type/annotations/text')
+      autoload(:Link, 'hexapdf/type/annotations/link')
+
+    end
+
+  end
+end

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

@@ -0,0 +1,70 @@
+# -*- encoding: utf-8 -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2017 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.
+#++
+
+require 'hexapdf/type/annotation'
+
+module HexaPDF
+  module Type
+    module Annotations
+
+      # Link annotations represent a link to a destination elsewhere in the PDF document or an
+      # action to be performed.
+      #
+      # See: PDF1.7 s12.5.6.5, HexaPDF::Type::Annotation
+      class Link < Annotation
+
+        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 :PA,         type: Dictionary, version: '1.3'
+        define_field :QuadPoints, type: Array, 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
+  end
+end

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

@@ -0,0 +1,70 @@
+# -*- encoding: utf-8 -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2017 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.
+#++
+
+require 'hexapdf/type/annotation'
+
+module HexaPDF
+  module Type
+    module Annotations
+
+      # Markup annotations are used to "mark up" a PDF document, most of the available PDF
+      # annotations are actually markup annotations.
+      #
+      # See: PDF1.7 s12.5.6.2, HexaPDF::Type::Annotation
+      class MarkupAnnotation < Annotation
+
+        define_field :T,            type: String, version: '1.1'
+        define_field :Popup,        type: :Annotation, version: '1.3'
+        define_field :CA,           type: Numeric, default: 1.0, version: '1.4'
+        define_field :RC,           type: [String, Stream], version: '1.5'
+        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 :IT,           type: Symbol, version: '1.6'
+        define_field :ExData,       type: Dictionary, version: '1.7'
+
+        private
+
+        def perform_validation #:nodoc:
+          super
+          if key?(:RT) && !key?(:IRT)
+            yield("/IRT required if /RT field is set")
+          end
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# -*- encoding: utf-8 -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2017 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.
+#++
+
+require 'hexapdf/type/annotations/markup_annotation'
+
+module HexaPDF
+  module Type
+    module Annotations
+
+      # Text annotations are "sticky notes" attached to a point in a PDF document. They act as if
+      # the NoZoom and NoRotate flags were always set.
+      #
+      # See: PDF1.7 s12.5.6.4, HexaPDF::Type::MarkupAnnotation
+      class Text < MarkupAnnotation
+
+        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'
+
+        private
+
+        # :nodoc:
+        STATE_TO_STATE_MODEL = {
+          "Marked" => "Marked", "Unmarked" => "Marked",
+          "Accepted" => "Review", "Rejected" => "Review", "Cancelled" => "Review",
+          "Completed" => "Review", "None" => "Review"
+        }
+
+        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?)
+            self[:StateModel] = state_model
+          elsif key?(:State) && STATE_TO_STATE_MODEL[self[:State]] != self[:StateModel]
+            yield("/State and /StateModel don't agree", false)
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/hexapdf/type/catalog.rb

@@ -46,7 +46,9 @@ module HexaPDF
     # See: PDF1.7 s7.7.2, Trailer
     class Catalog < Dictionary
 
-      define_field :Type,              type: Symbol,     required: true, default: :Catalog
+      define_type :Catalog
+
+      define_field :Type,              type: Symbol,     required: true, default: self.type
       define_field :Version,           type: Symbol,     version: '1.4'
       define_field :Extensions,        type: Dictionary, version: '1.7'
       # Pages field is required but this is handled in #perform_validation

data/lib/hexapdf/type/embedded_file.rb

@@ -49,35 +49,30 @@ module HexaPDF
       # The type used for the /Mac field of an EmbeddedFile::Parameters dictionary.
       class MacInfo < Dictionary
 
+        define_type :XXEmbeddedFileParametersMacInfo
+
         define_field :Subtype, type: Integer
         define_field :Creator, type: Integer
         define_field :ResFork, type: Stream
 
-        # Returns +:XXEmbeddedFileParametersMacInfo+
-        def type
-          :XXEmbeddedFileParametersMacInfo
-        end
-
       end
 
       # The type used for the /Params field of an EmbeddedFileStream.
       class Parameters < Dictionary
 
+        define_type :XXEmbeddedFileParameters
+
         define_field :Size,         type: Integer
         define_field :CreationDate, type: PDFDate
         define_field :ModDate,      type: PDFDate
         define_field :Mac,          type: :XXEmbeddedFileParametersMacInfo
         define_field :CheckSum,     type: PDFByteString
 
-        # Returns +:XXEmbeddedFileParameters+
-        def type
-          :XXEmbeddedFileParameters
-        end
-
       end
 
+      define_type :EmbeddedFile
 
-      define_field :Type,    type: Symbol, default: :EmbeddedFile, version: '1.3'
+      define_field :Type,    type: Symbol, default: self.type, version: '1.3'
       define_field :Subtype, type: Symbol
       define_field :Params,  type: :XXEmbeddedFileParameters
 

data/lib/hexapdf/type/file_specification.rb

@@ -63,21 +63,19 @@ module HexaPDF
       # The type used for the /EF field of a FileSpecification
       class EFDictionary < Dictionary
 
+        define_type :XXFilespecEFDictionary
+
         define_field :F,    type: :EmbeddedFile
         define_field :UF,   type: :EmbeddedFile
         define_field :DOS,  type: :EmbeddedFile
         define_field :Mac,  type: :EmbeddedFile
         define_field :Unix, type: :EmbeddedFile
 
-        # Returns +:XXFilespecEFDictionary+
-        def type
-          :XXFilespecEFDictionary
-        end
-
       end
 
+      define_type :Filespec
 
-      define_field :Type, type: Symbol, default: :Filespec, required: true
+      define_field :Type, type: Symbol, default: self.type, required: true
       define_field :FS,   type: Symbol
       define_field :F,    type: PDFByteString
       define_field :UF,   type: String, version: '1.7'

data/lib/hexapdf/type/font.rb

@@ -42,7 +42,9 @@ module HexaPDF
     # This class is the base class for all font objects, be it simple fonts or composite fonts.
     class Font < Dictionary
 
-      define_field :Type, type: Symbol, required: true, default: :Font
+      define_type :Font
+
+      define_field :Type, type: Symbol, required: true, default: self.type
       define_field :BaseFont, type: Symbol, required: true
       define_field :ToUnicode, type: Stream, version: '1.2'