pdfrb 0.3.0 → 0.7.1

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Set OCG State action (s12.6.4.13). Toggle visibility of
+      # optional-content groups.
+      class ActionSetOCGState < Action
+        register_subtype :SetOCGState
+
+        def state; self[:State]; end
+        def preserve_rb?; self[:PreserveRB] == true; end
+
+        def each_state_transition
+          return enum_for(:each_state_transition) unless block_given?
+          return unless state
+
+          arr = state.is_a?(Pdfrb::Model::PdfArray) ? state.to_a : state
+          return unless arr.is_a?(Array)
+
+          current_op = :ON
+          arr.each do |entry|
+            case entry
+            when :ON, :OFF, :Toggle then current_op = entry
+            else yield current_op, entry
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Set-state action (deprecated in PDF 1.2, replaced by SetOCGState).
+      class ActionSetState < Action
+        register_subtype :SetState
+
+        def state; self[:State]; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Sound action (s12.6.4.6). Plays a Sound stream.
+      class ActionSoundAction < Action
+        register_subtype :Sound
+
+        def sound; self[:Sound]; end
+        def volume; self[:Volume]; end
+        def mix?; truthy?(self[:Mix]); end
+
+        def resolved_sound
+          ref = sound
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Submit-form action (s12.7.6.2). Submits form values to a URL.
+      class ActionSubmitForm < Action
+        register_subtype :SubmitForm
+
+        def url; self[:F]; end
+        def fields; self[:Fields]; end
+        def flags; self[:Flags] || 0; end
+
+        def include_exclude?
+          flags & 1 != 0
+        end
+
+        def include_no_value_fields?
+          flags & 2 != 0
+        end
+
+        def export_format?
+          flags & 4 != 0
+        end
+
+        def get_method?
+          flags & 8 != 0
+        end
+
+        def submit_coordinates?
+          flags & 16 != 0
+        end
+
+        def submit_as_xfdf?
+          flags & 32 != 0
+        end
+
+        def submit_as_append?
+          flags & 64 != 0
+        end
+
+        def submit_as_pdf?
+          flags & 256 != 0
+        end
+
+        def canonical_date_format?
+          flags & 512 != 0
+        end
+
+        def submit_as_xfdf_with_annotations?
+          flags & 1024 != 0
+        end
+
+        def submit_as_xdp?
+          flags & 2048 != 0
+        end
+
+        def submit_as_xfdf_charset?
+          flags & 4096 != 0
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Thread action (s12.6.4.6). Navigate within an article thread.
+      class ActionThread < Action
+        register_subtype :Thread
+
+        def thread; self[:F]; end
+        def destination_bead; self[:D]; end
+
+        def first_bead?
+          destination_bead.zero? || destination_bead.nil?
+        end
+
+        def last_bead?
+          destination_bead == -1
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Transition action (s12.4.3). Specifies page transition for slide-show.
+      class ActionTrans < Action
+        register_subtype :Trans
+
+        def transition; self[:Trans]; end
+
+        def has_transition?
+          !!transition
+        end
+
+        def transition_style
+          return nil unless transition
+
+          transition[:S]&.to_sym
+        end
+
+        def duration
+          return nil unless transition
+
+          transition[:D]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # URI action (s12.6.4.7). Opens a URL in the browser.
+      class ActionURI < Action
+        register_subtype :URI
+
+        def uri; self[:URI]; end
+        def track_mouse?; self[:IsMap] == true; end
+
+        def scheme
+          return nil unless uri
+
+          match = uri.to_s.match(%r{^([a-zA-Z][a-zA-Z0-9+.-]*):})
+          match && match[1].downcase
+        end
+
+        def http?
+          ["http", "https"].include?(scheme)
+        end
+
+        def mailto?
+          scheme == "mailto"
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,17 @@ module Pdfrb
       # PDF 2.0 Associated-File embedded stream (App Note 002).
       class AFEmbeddedFile < EmbeddedFile
         arlington_object "AFEmbeddedFileStream"
+
+        def af_relationship
+          return nil unless params
+
+          obj = params.is_a?(Pdfrb::Model::Reference) && document ? document.object(params) : params
+          obj && obj[:AFRelationship]
+        end
+
+        def associated_file_relationship?
+          !!af_relationship
+        end
       end
     end
   end

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

@@ -7,6 +7,40 @@ module Pdfrb
       # /AFRelationship to the base FileSpec.
       class AFFileSpecification < FileSpecification
         arlington_object "AFFileSpecification"
+
+        def af_relationship; self[:AFRelationship]; end
+
+        def source?
+          af_relationship&.to_sym == :Source
+        end
+
+        def data?
+          af_relationship&.to_sym == :Data
+        end
+
+        def alternative?
+          af_relationship&.to_sym == :Alternative
+        end
+
+        def supplement?
+          af_relationship&.to_sym == :Supplement
+        end
+
+        def encrypted?
+          af_relationship&.to_sym == :EncryptedPayload
+        end
+
+        def form_fillin?
+          af_relationship&.to_sym == :FormData
+        end
+
+        def schema?
+          af_relationship&.to_sym == :Schema
+        end
+
+        def unspecified?
+          af_relationship.nil? || af_relationship&.to_sym == :Unspecified
+        end
       end
     end
   end

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

@@ -3,14 +3,7 @@
 module Pdfrb
   module Model
     module Type
-      # Annotation base class (s12.5). The base dict shape is encoded
-      # across the per-subtype TSVs (AnnotLink, AnnotText, ...), not
-      # a single Annot.tsv — so the base class registers in the
-      # type_map and dispatches to a specific subtype class via
-      # /Subtype lookup.
       class Annotation < Pdfrb::Model::Cos::Dictionary
-        # Common annotation fields per s12.5.2 (hand-coded; base dict
-        # is shared across all subtypes before subtype-specific keys).
         define_field :Type, type: Symbol, default: :Annot
         define_field :Subtype, type: Symbol, required: true
         define_field :Rect, type: Pdfrb::Model::Rectangle
@@ -25,12 +18,59 @@ module Pdfrb
         define_field :C, type: Pdfrb::Model::PdfArray
         define_field :A, type: Pdfrb::Model::Cos::Dictionary
         define_field :AA, type: Pdfrb::Model::Cos::Dictionary
+        define_field :StructParent, type: Integer
+        define_field :OC, type: Pdfrb::Model::Cos::Dictionary
 
         register_type :Annot
 
+        # ---- Accessors ----
+        def subtype; self[:Subtype]; end
+        def rect; self[:Rect]; end
+        def contents; self[:Contents]; end
+        def name; self[:NM]; end
+        def modified_date; self[:M]; end
+        def flags; self[:F] || 0; end
+        def color; self[:C]; end
+        def border; self[:Border]; end
+        def appearance; self[:AP]; end
+        def appearance_state; self[:AS]; end
+        def action; self[:A]; end
+        def additional_actions; self[:AA]; end
+
+        # ---- Page reference ----
+        def page
+          ref = self[:P]
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+
+        # ---- Flag predicates ----
+        def hidden?; flags & 1 != 0; end
+        def print?; flags & 2 != 0; end
+        def no_zoom?; flags & 4 != 0; end
+        def no_rotate?; flags & 8 != 0; end
+        def no_view?; flags & 16 != 0; end
+        def read_only?; flags & 32 != 0; end
+        def locked?; flags & 128 != 0; end
+        def toggle_no_view?; flags & 256 != 0; end
+        def locked_contents?; flags & 512 != 0; end
+
+        # ---- Appearance management ----
+        def normal_appearance
+          ap = appearance
+          return nil unless ap
+
+          ap = document.object(ap) if ap.is_a?(Pdfrb::Model::Reference) && document
+          ap && ap[:N]
+        end
+
+        def create_appearance_stream
+          AppearanceGenerator.for(self, document: document)&.create_appearance
+        end
+
+        # ---- Subtype dispatch ----
         class << self
-          # Dispatch by /Subtype. Subclasses register via
-          # `register_subtype :Link`.
           def subtype_map
             @subtype_map ||= {}
           end
@@ -47,4 +87,3 @@ module Pdfrb
     end
   end
 end
-

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Appearance stream dictionary (s12.5.5). The /AP dict on an
+      # annotation holds three sub-dicts: /N (normal), /R (rollover),
+      # /D (down).
+      class Appearance < Pdfrb::Model::Cos::Dictionary
+        def normal; self[:N]; end
+        def rollover; self[:R]; end
+        def down; self[:D]; end
+
+        def has_normal?
+          !!normal
+        end
+
+        def has_rollover?
+          !!rollover
+        end
+
+        def has_down?
+          !!down
+        end
+
+        def normal_for_state(state_name)
+          return nil unless normal
+
+          n = if normal.is_a?(Pdfrb::Model::Reference) && document
+                document.object(normal)
+              else
+                normal
+              end
+          return nil unless n.is_a?(Hash)
+
+          n[state_name]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Appearance Characteristics dictionary (s12.5.5). Defines the
+      # visual characteristics of a widget annotation: background/caption
+      # colors, normal/rollover/down captions, etc. Often stored under
+      # the widget's /MK key.
+      class AppearanceCharacteristics < Pdfrb::Model::Cos::Dictionary
+        def background_color; self[:BG]; end
+        def caption; self[:CA]; end
+        def rollover_caption; self[:RC]; end
+        def down_caption; self[:AC]; end
+        def rotation; self[:R] || 0; end
+        def border_color; self[:BC]; end
+        def normal_icon; self[:IF]; end
+        def alternate_icon; self[:IX]; end
+        def icon_fit; self[:IF]; end
+        def tp; self[:TP]; end
+
+        def text_position
+          tp || 0
+        end
+
+        def has_background?
+          !!background_color
+        end
+
+        def has_caption?
+          !!caption
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class AppearanceGenerator
+        def self.for(annotation, document:)
+          case annotation[:Subtype]
+          when :Widget
+            WidgetAppearance.new(annotation, document)
+          when :Text
+            TextAppearance.new(annotation, document)
+          when :Link
+            LinkAppearance.new(annotation, document)
+          else
+            GenericAppearance.new(annotation, document)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # AppearanceTrapNet sub-dictionary (s7.7.3.3, Table 327). Per-
+      # appearance-stream trap-net (ink-flattening) parameters.
+      class AppearanceTrapNetSubDict < Pdfrb::Model::Cos::Dictionary
+        def pos_h; self[:PosH]; end
+        def pos_l; self[:PosL]; end
+        def span_h_min; self[:SpanH]; end
+        def span_l_min; self[:SpanL]; end
+        def font_info; self[:FontInfo]; end
+
+        def has_darkness_corrected?
+          !!font_info
+        end
+      end
+
+      # AppearanceTrapNet (s7.7.3.3). The trap-net dictionary that wraps
+      # appearance sub-dicts.
+      class AppearanceTrapNet < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def version; self[:Version]; end
+        def font_state_appearance; self[:FontStateAppearance]; end
+        def gray_min; self[:GrayMin]; end
+        def gray_max; self[:GrayMax]; end
+        def monochrome_min; self[:MonoMin]; end
+        def monochrome_max; self[:MonoMax]; end
+        def colorant_min; self[:ColorantMin]; end
+        def colorant_max; self[:ColorantMax]; end
+        def step_function; self[:StepFunction]; end
+        def trap_net_app_form_name; self[:AppForm]; end
+
+        def has_step_function?
+          !!step_function
+        end
+      end
+
+      # AppearanceSubDict (s12.5.4). Sub-dictionary inside Appearance
+      # entries /N, /R, /D that maps each appearance state to a stream.
+      class AppearanceSubDict < Pdfrb::Model::Cos::Dictionary
+        def each_state(&block)
+          return enum_for(:each_state) unless block
+
+          value.each(&block)
+        end
+
+        def state_count
+          value.size
+        end
+
+        def states
+          value.keys
+        end
+      end
+
+      # Signature Build Data Dict (s12.8.4). PPKLite build data.
+      class SignatureBuildPropDict < Pdfrb::Model::Cos::Dictionary
+        def app_build; self[:App]; end
+
+        def has_app_build?
+          !!app_build
+        end
+      end
+
+      # Annotation Projection dict (s12.5.6.21). Projection annotation
+      # for spatial content.
+      class AnnotationProjectionDict < Pdfrb::Model::Cos::Dictionary
+        def ex_data; self[:ExData]; end
+      end
+
+      # ExData Projection dict (s12.5.6.21, Table 198). Holds the
+      # geospatial projection details used by Projection annotations.
+      class ExDataProjection < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+
+        def project?
+          type == :ProjectedPDL
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # BorderEffect (s12.5.4.2). Cloudy / inset border effects for
+      # annotations.
+      class BorderEffect < Cos::Dictionary
+        register_type :BorderEffect
+
+        def type; self[:Type]; end
+        def style; self[:S]&.to_sym; end
+        def intensity; self[:I] || 0; end
+
+        def cloudy?
+          style == :C
+        end
+
+        def inset?
+          style == :I
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # BorderStyling (s12.5.4.1, PDF 2.0). Replaces the deprecated
+      # /Border array on annotations. Specifies width, dash, style.
+      class BorderStyling < Cos::Dictionary
+        register_type :BorderStyling
+
+        def type; self[:Type]; end
+        def style; self[:S]&.to_sym; end
+        def width; self[:W] || 1.0; end
+        def dash; self[:D]; end
+
+        def solid?; style.nil? || style == :S; end
+        def dashed?; style == :D; end
+        def beveled?; style == :B; end
+        def inset?; style == :I; end
+        def underline?; style == :U; end
+
+        def dash_array
+          return nil unless dash
+
+          arr = dash.is_a?(Pdfrb::Model::PdfArray) ? dash.to_a : dash
+          arr.is_a?(Array) && arr.size >= 1 ? arr[0] : nil
+        end
+
+        def dash_phase
+          return nil unless dash
+
+          arr = dash.is_a?(Pdfrb::Model::PdfArray) ? dash.to_a : dash
+          arr.is_a?(Array) && arr.size >= 2 ? arr[1] : 0
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Box Color Info dictionary (s7.7.3.3, Table 30). Defines the
+      # visual guide lines for page boxes (crop, bleed, trim, art) in
+      # the viewer. Lives on Page /BoxColorInfo.
+      class BoxColorInfo < Pdfrb::Model::Cos::Dictionary
+        def crop_box_style; self[:CropBox]; end
+        def bleed_box_style; self[:BleedBox]; end
+        def trim_box_style; self[:TrimBox]; end
+        def art_box_style; self[:ArtBox]; end
+
+        def empty?
+          !crop_box_style && !bleed_box_style && !trim_box_style && !art_box_style
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Box Style dictionary (s7.7.3.3, Table 396). Describes one box
+      # guide: color, dash pattern, visibility.
+      class BoxStyle < Pdfrb::Model::Cos::Dictionary
+        def color; self[:C]; end
+        def dash_pattern; self[:W]; end
+        def dash_style; self[:S]&.to_sym; end
+        def dash_count; self[:D]; end
+
+        def solid?; dash_style.nil? || dash_style == :S; end
+        def dashed?; dash_style == :D; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class Button < Field
+        def value; self[:V]; end
+        def opt; self[:Opt]; end
+
+        def push_button?; flags & 0x10000 != 0; end
+        def radio?; flags & 0x8000 != 0; end
+        def no_toggle_to_off?; flags & 0x4000 != 0; end
+        def radios_in_unison?; flags & 0x2000000 != 0; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # CalGray color space dictionary (s8.6.3.2). Single-component
+      # calibrated grayscale: [/CalGray <dict>].
+      class CalGray < Pdfrb::Model::Cos::Dictionary
+        def white_point; self[:WhitePoint]; end
+        def black_point; self[:BlackPoint]; end
+        def gamma; self[:Gamma] || 1.0; end
+
+        def components; 1; end
+      end
+    end
+  end
+end