pdfrb 0.3.0 → 0.7.1

data/lib/pdfrb/model/type/cal_rgb.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # CalRGB color space dictionary (s8.6.3.3). Calibrated RGB:
+      # [/CalRGB <dict>].
+      class CalRGB < Pdfrb::Model::Cos::Dictionary
+        def white_point; self[:WhitePoint]; end
+        def black_point; self[:BlackPoint]; end
+        def gamma; self[:Gamma]; end
+        def matrix; self[:Matrix]; end
+
+        def components; 3; end
+
+        def has_matrix?
+          !!matrix
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/caret_annotation.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Caret annotation (s12.5.6.11). Text-insertion indicator.
+      class CaretAnnotation < MarkupAnnotation
+        def rd; self[:RD]; end
+        def sy; self[:Sy]; end
+
+        def paragraph_style?
+          sy&.to_sym == :P
+        end
+
+        def new_line_style?
+          sy&.to_sym == :None
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/catalog.rb

@@ -15,34 +15,117 @@ module Pdfrb
         arlington_object "Catalog"
         register_type :Catalog
 
-        # Returns the /Pages tree root, auto-resolving the reference.
-        def pages
-          self[:Pages]
+        def pages; self[:Pages]; end
+        def page_labels; self[:PageLabels]; end
+        def names; self[:Names]; end
+        def destinations; self[:Dests]; end
+        def viewer_preferences; self[:ViewerPreferences]; end
+        def page_layout; self[:PageLayout]; end
+        def page_mode; self[:PageMode]; end
+        def outlines; self[:Outlines]; end
+        def threads; self[:Threads]; end
+        def open_action; self[:OpenAction]; end
+        def additional_actions; self[:AA]; end
+        def uri; self[:URI]; end
+        def acro_form; self[:AcroForm]; end
+        def metadata; self[:Metadata]; end
+        def struct_tree_root; self[:StructTreeRoot]; end
+        def mark_info; self[:MarkInfo]; end
+        def lang; self[:Lang]; end
+        def spider_info; self[:SpiderInfo]; end
+        def output_intents; self[:OutputIntents]; end
+        def piece_info; self[:PieceInfo]; end
+        def oc_properties; self[:OCProperties]; end
+        def perms; self[:Perms]; end
+        def legal; self[:Legal]; end
+        def requirements; self[:Requirements]; end
+        def collection; self[:Collection]; end
+        def needs_rendering?; truthy?(self[:NeedsRendering]); end
+        def dss; self[:DSS]; end
+        def associated_files; self[:AF]; end
+        def dpart_root; self[:DPartRoot]; end
+        def version_override; self[:Version]; end
+        def extensions; self[:Extensions]; end
+
+        def single_page_layout?; page_layout&.to_sym == :SinglePage; end
+        def one_column_layout?; page_layout&.to_sym == :OneColumn; end
+
+        def two_column_layout?
+          [:TwoColumnLeft, :TwoColumnRight].include?(page_layout&.to_sym)
+        end
+
+        def two_page_layout?
+          [:TwoPageLeft, :TwoPageRight].include?(page_layout&.to_sym)
+        end
+
+        def use_attachments_mode?; page_mode&.to_sym == :UseAttachments; end
+        def use_thumbs_mode?; page_mode&.to_sym == :UseThumbs; end
+        def use_outlines_mode?; page_mode&.to_sym == :UseOutlines; end
+        def full_screen_mode?; page_mode&.to_sym == :FullScreen; end
+        def use_oc_mode?; page_mode&.to_sym == :UseOC; end
+
+        def tagged?
+          mark_info && !!mark_info[:Marked]
+        end
+
+        def contains_struct_tree?
+          !!struct_tree_root
+        end
+
+        def contains_form?
+          !!acro_form
         end
 
-        # Returns the /AcroForm dict (or nil).
-        def acro_form
-          self[:AcroForm]
+        def contains_outlines?
+          !!outlines
         end
 
-        def outlines
-          self[:Outlines]
+        def page_count
+          return 0 unless pages
+
+          obj = pages.is_a?(Pdfrb::Model::Reference) && document ? document.object(pages) : pages
+          obj && obj[:Count]
+        end
+
+        def resolved_pages
+          return nil unless pages && document
+
+          document.object(pages)
         end
 
-        def names
-          self[:Names]
+        def resolved_acro_form
+          return nil unless acro_form && document
+
+          document.object(acro_form)
         end
 
-        def metadata
-          self[:Metadata]
+        def resolved_outlines
+          return nil unless outlines && document
+
+          document.object(outlines)
         end
 
-        def struct_tree_root
-          self[:StructTreeRoot]
+        def resolved_metadata
+          return nil unless metadata && document
+
+          document.object(metadata)
         end
 
-        def open_action
-          self[:OpenAction]
+        def each_output_intent
+          return enum_for(:each_output_intent) unless block_given?
+          return unless output_intents && document
+
+          arr = if output_intents.is_a?(Pdfrb::Model::Reference)
+                  document.object(output_intents)
+                else
+                  output_intents
+                end
+          return unless arr.is_a?(Array) || arr.is_a?(Pdfrb::Model::PdfArray)
+
+          arr.each do |entry|
+            obj = entry.is_a?(Pdfrb::Model::Reference) ? document.object(entry) : entry
+            yield obj if obj
+          end
         end
       end
     end

data/lib/pdfrb/model/type/choice.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class Choice < Field
+        def value; self[:V]; end
+        def opt; self[:Opt]; end
+        def top_index; self[:TI]; end
+        def indices; self[:I]; end
+
+        def combo?; flags & 0x20000 != 0; end
+        def list?; !combo?; end
+        def edit?; flags & 0x40000 != 0; end
+        def multi_select?; flags & 0x200000 != 0; end
+        def sort?; flags & 0x80000 != 0; end
+        def commit_on_change?; flags & 0x4000000 != 0; end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/cid_font.rb

@@ -5,8 +5,59 @@ module Pdfrb
     module Type
       # CID-keyed font (s9.7.3). Inner font of a /Type0 composite.
       # /Subtype /CIDFontType0 or /CIDFontType2.
-      class CIDFont < Pdfrb::Model::Cos::Dictionary
+      class CIDFont < Pdfrb::Model::Type::Font
         arlington_object "FontCIDType0"
+
+        def cid_subtype; self[:Subtype]; end
+        def base_font; self[:BaseFont]; end
+        def cid_system_info; self[:CIDSystemInfo]; end
+        def font_descriptor; self[:FontDescriptor]; end
+        def dw; self[:DW]; end
+        def w; self[:W]; end
+        def dw2; self[:DW2]; end
+        def w2; self[:W2]; end
+        def cid_to_gid_map; self[:CIDToGIDMap]; end
+
+        def type0?
+          cid_subtype&.to_sym == :CIDFontType0
+        end
+
+        def type2?
+          cid_subtype&.to_sym == :CIDFontType2
+        end
+
+        def default_width
+          dw || 1000
+        end
+
+        def width_for_cid(cid)
+          return default_width unless w
+
+          entries = w.is_a?(Pdfrb::Model::PdfArray) ? w.to_a : w
+          i = 0
+          while i < entries.size
+            first = entries[i]
+            second = entries[i + 1]
+            return nil unless first && second
+
+            case second.to_s
+            when /\A[\[\]]\z/
+              array = entries[i + 2]
+              return nil unless first.is_a?(Integer) && array.is_a?(Array)
+
+              offset = cid - first
+              return array[offset] if offset >= 0 && offset < array.size
+
+            else
+              value = entries[i + 2]
+              return value if cid.between?(first, second)
+
+            end
+            i += 3
+          end
+
+          default_width
+        end
       end
     end
   end

data/lib/pdfrb/model/type/cid_font_descriptor_metrics.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # CID Font Descriptor Metrics (s9.8.1, Table 117). Per-CIDFont
+      # metrics used for embedded CIDFontType0/CIDFontType2.
+      class CIDFontDescriptorMetrics < Pdfrb::Model::Cos::Dictionary
+        def style; self[:Style]&.to_sym; end
+        def cid_set; self[:CIDSet]; end
+
+        def monospaced?; style == :Monospaced; end
+        def proportional?; style == :Proportional; end
+
+        def has_cid_set?
+          !!cid_set
+        end
+
+        def resolved_cid_set
+          ref = cid_set
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/cid_system_info.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # CIDSystemInfo dictionary (s9.7.3). Each CIDFont must declare
+      # its Character ID system: registry, ordering, supplement.
+      # Required for proper glyph interpretation.
+      class CIDSystemInfo < Pdfrb::Model::Cos::Dictionary
+        def registry; self[:Registry]; end
+        def ordering; self[:Ordering]; end
+        def supplement; self[:Supplement]; end
+
+        def identity?
+          registry == "Adobe" && ordering == "Identity"
+        end
+
+        def complete?
+          !registry.nil? && !ordering.nil? && !supplement.nil?
+        end
+
+        def to_s
+          "#{registry}-#{ordering}-#{supplement}"
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/circle_annotation.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Circle / ellipse annotation (s12.5.6.8).
+      class CircleAnnotation < MarkupAnnotation
+        def border_effect; self[:BE]; end
+        def interior_color; self[:IC]; end
+        def border_style; self[:BS]; end
+        def border; self[:Border]; end
+        def rd; self[:RD]; end
+
+        def has_border_effect?
+          !!border_effect
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/collection.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Collection dictionary (s7.11.5). Describes a PDF Portfolio — a
+      # collection of embedded files with a presentation schema. Lives
+      # on Catalog /Collection.
+      class Collection < Pdfrb::Model::Cos::Dictionary
+        def schema; self[:Schema]; end
+        def default_view; self[:View]; end
+        def sort; self[:Sort]; end
+        def split; self[:Split]; end
+        def colors; self[:Colors]; end
+        def folders; self[:Folders]; end
+
+        def has_schema?
+          !!schema
+        end
+
+        def has_default_view?
+          !!default_view
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/collection_field.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Collection field (s7.11.5). One column definition.
+      class CollectionField < Pdfrb::Model::Cos::Dictionary
+        def name; self[:N]; end
+        def field_type; self[:Subtype]; end
+        def order; self[:O]; end
+        def visibility; self[:V]; end
+
+        def text_field?; field_type == :Text; end
+        def number_field?; field_type == :Number; end
+        def date_field?; field_type == :Date; end
+        def file_name_field?; field_type == :FileName; end
+        def file_size_field?; field_type == :FileSize; end
+        def description_field?; field_type == :Desc; end
+        def modification_date_field?; field_type == :ModDate; end
+        def creation_date_field?; field_type == :CreationDate; end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/collection_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Collection item (s7.11.5). Per-embedded-file values for the
+      # schema fields.
+      class CollectionItem < Pdfrb::Model::Cos::Dictionary
+        def value_for(field_name)
+          self[field_name.to_sym] || self[field_name.to_s]
+        end
+
+        def keys
+          value.keys
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/collection_schema.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Collection schema (s7.11.5). Defines the columns/fields shown
+      # in the portfolio view.
+      class CollectionSchema < Pdfrb::Model::Cos::Dictionary
+        def fields
+          value.keys
+        end
+
+        def field_count
+          value.size
+        end
+
+        def each_field(&)
+          return enum_for(:each_field) unless block_given?
+
+          value.each(&)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/collection_sort.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Collection sort (s7.11.5). Defines default sort order.
+      class CollectionSort < Pdfrb::Model::Cos::Dictionary
+        def field_name; self[:S]; end
+        def descending?; truthy?(self[:A]); end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/crypt_filter.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Crypt Filter (s7.6.5). Per-stream cipher filter spec — names
+      # the cipher and authentication event.
+      class CryptFilter < Pdfrb::Model::Cos::Dictionary
+        def cipher_method; self[:CFM]&.to_sym; end
+        def auth_event; self[:AuthEvent]&.to_sym; end
+        def length; self[:Length]; end
+
+        def none?; cipher_method == :None; end
+        def v2?; cipher_method == :V2; end
+        def aes_v2?; cipher_method == :AESV2; end
+        def aes_v3?; cipher_method == :AESV3; end
+        def aes_v4?; cipher_method == :AESV4; end
+
+        def open_event?; auth_event == :EFOpen; end
+        def doc_open_event?; auth_event == :DocOpen; end
+
+        def has_length?
+          length&.positive?
+        end
+      end
+
+      # Crypt Filter Map (s7.6.5, Table 26). Maps per-page crypt filter
+      # names to the default CryptFilter used.
+      class CryptFilterMap < Pdfrb::Model::Cos::Dictionary
+        def filter_for(stream_name)
+          value[stream_name.to_sym] || value[stream_name.to_s]
+        end
+
+        def each_filter(&)
+          return enum_for(:each_filter) unless block_given?
+
+          value.each(&)
+        end
+      end
+
+      # Crypt Filter Public Key (s7.6.5, Table 26). Public-key analog
+      # of CryptFilter.
+      class CryptFilterPublicKey < Pdfrb::Model::Cos::Dictionary
+        def cipher_method; self[:CFM]&.to_sym; end
+        def auth_event; self[:AuthEvent]&.to_sym; end
+        def recipients; self[:Recipients]; end
+      end
+
+      # Crypt Filter Public Key Map (s7.6.5, Table 26). Maps per-page
+      # public-key crypt filters.
+      class CryptFilterPublicKeyMap < Pdfrb::Model::Cos::Dictionary
+        def filter_for(stream_name)
+          value[stream_name.to_sym] || value[stream_name.to_s]
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/device_n.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # DeviceN color space (s8.6.6.4). Multiple custom colorants mapped
+      # through a single tint-transform function. Generalises Separation.
+      class DeviceN < Pdfrb::Model::Cos::Dictionary
+        def colorants; self[:Names]; end
+        def alternate_space; self[:AlternateSpace]; end
+        def tint_transform; self[:TintTransform]; end
+        def attributes; self[:Attributes]; end
+
+        def colorant_count
+          return 0 unless colorants
+
+          arr = colorants.is_a?(Pdfrb::Model::PdfArray) ? colorants.to_a : colorants
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def components
+          colorant_count
+        end
+
+        def each_colorant(&)
+          return enum_for(:each_colorant) unless block_given?
+          return unless colorants
+
+          arr = colorants.is_a?(Pdfrb::Model::PdfArray) ? colorants.to_a : colorants
+          return unless arr.is_a?(Array)
+
+          arr.each(&)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/device_n_mixing_hints.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # DeviceN Mixing Hints (s8.6.6.5). Per-colorant device hints.
+      class DeviceNMixingHints < Pdfrb::Model::Cos::Dictionary
+        def solidities; self[:Solidities]; end
+        def dot_gain; self[:DotGain]; end
+
+        def has_solidities?
+          !!solidities
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/device_n_process.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # DeviceN Process (s8.6.6.4). Process colorant list.
+      class DeviceNProcess < Pdfrb::Model::Cos::Dictionary
+        def color_space; self[:ColorSpace]; end
+        def components; self[:Components]; end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/doc_mdp_transform_parameters.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Document Modification Detection and Prevention (DocMDP) —
+      # s12.8.2.2. Restricts what edits are allowed after signing.
+      class DocMDPTransformParameters < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def p; self[:P]; end
+        def v; self[:V]; end
+
+        # P=1: no changes allowed; P=2: minimal changes (form fill);
+        # P=3: annotations + form fill.
+        def no_changes_allowed?; p == 1; end
+        def minimal_changes_allowed?; p == 2; end
+        def annotations_allowed?; p == 3; end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/document_security_store.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Document Security Store (s12.8.4.3, PDF 2.0). Holds certs, CRLs,
+      # and OCSP responses used by signature verification.
+      class DocumentSecurityStore < Cos::Dictionary
+        register_type :DSS
+
+        def type; self[:Type]; end
+        def certs; self[:Certs]; end
+        def ocsp; self[:OCSPs]; end
+        def crl; self[:CRLs]; end
+        def vri; self[:VRI]; end
+
+        def cert_count
+          return 0 unless certs
+
+          arr = certs.is_a?(Pdfrb::Model::PdfArray) ? certs.to_a : certs
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def ocsp_count
+          return 0 unless ocsp
+
+          arr = ocsp.is_a?(Pdfrb::Model::PdfArray) ? ocsp.to_a : ocsp
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def crl_count
+          return 0 unless crl
+
+          arr = crl.is_a?(Pdfrb::Model::PdfArray) ? crl.to_a : crl
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def has_vri?
+          !!vri
+        end
+
+        def each_cert
+          return enum_for(:each_cert) unless block_given?
+          return unless certs && document
+
+          arr = certs.is_a?(Pdfrb::Model::PdfArray) ? certs.to_a : certs
+          arr.each do |ref|
+            obj = ref.is_a?(Pdfrb::Model::Reference) ? document.object(ref) : ref
+            yield obj if obj
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/embedded_file.rb

@@ -7,6 +7,25 @@ module Pdfrb
       # /Filespec /EF entry.
       class EmbeddedFile < Pdfrb::Model::Cos::Stream
         arlington_object "EmbeddedFileStream"
+        register_type :EmbeddedFile
+
+        def subtype; self[:Subtype]; end
+        def length; self[:Length]; end
+        def filter; self[:Filter]; end
+        def params; self[:Params]; end
+        def checksum; self[:Params] && self[:Params][:CheckSum]; end
+        def creation_date; self[:Params] && self[:Params][:CreationDate]; end
+        def modification_date; self[:Params] && self[:Params][:ModDate]; end
+        def size; self[:Params] && self[:Params][:Size]; end
+        def mac_creator; self[:Params] && self[:Params][:Mac]; end
+
+        def compressed?
+          filter && !filter.to_s.empty?
+        end
+
+        def mime_type
+          subtype&.to_s
+        end
       end
     end
   end