pdfrb 0.2.1 → 0.6.0

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class SignatureField < Field
+        def value; self[:V]; end
+        def lock; self[:Lock]; end
+        def seed_value; self[:SV]; end
+
+        def signed?
+          value && value[:Contents]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Software Identifier (s13.3.5.5). Identifies a player for
+      # media rendering.
+      class SoftwareIdentifier < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def u; self[:U]; end
+        def l; self[:L]; end
+
+        def has_version?
+          !!u && !!l
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Sound stream (s13.3). Sound effect annotation payload.
+      # /R = sampling rate, /C = channels, /B = bits/sample, /E =
+      # encoding (Raw, Signed, MuLaw, ALaw).
+      class Sound < Pdfrb::Model::Cos::Stream
+        def type; self[:Type]; end
+        def sampling_rate; self[:R]; end
+        def channels; self[:C] || 1; end
+        def bits_per_sample; self[:B] || 8; end
+        def encoding; self[:E]&.to_sym || :Raw; end
+
+        def raw_encoding?; encoding == :Raw; end
+        def signed_encoding?; encoding == :Signed; end
+        def mu_law_encoding?; encoding == :MuLaw; end
+        def a_law_encoding?; encoding == :ALaw; end
+
+        def sample_bytes
+          (channels * bits_per_sample) / 8.0
+        end
+
+        def duration_seconds
+          return nil unless sampling_rate&.positive?
+
+          bytes = stream ? stream.bytesize : 0
+          bytes.to_f / (sample_bytes * sampling_rate)
+        end
+
+        def audio_data
+          decoded_stream&.force_encoding(Encoding::BINARY)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Sound annotation (s12.5.6.18). Sound clip embedded in the page.
+      class SoundAnnotation < MarkupAnnotation
+        def sound; self[:Sound]; end
+        def name; self[:Name]; end
+
+        def icon_name
+          (name || :Speaker).to_sym
+        end
+
+        def has_sound?
+          !!sound
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Square / rectangle annotation (s12.5.6.8).
+      class SquareAnnotation < 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
+
+        def dashed?
+          bs && bs[:D]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class SquareCircle < Annotation
+        def interior_color; self[:IC]; end
+        def border_effect; self[:BE]; end
+        def rect_difference; self[:RD]; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Squiggly annotation. /Subtype /Squiggly.
+      class SquigglyAnnotation < TextMarkupAnnotation
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Rubber-stamp annotation (s12.5.6.14).
+      class StampAnnotation < MarkupAnnotation
+        def name; self[:Name]; end
+        def interior_color; self[:IC]; end
+        def rotation; self[:Rotate] || 0; end
+        def intent; self[:IT]; end
+
+        def rubber_stamp?
+          intent.nil? || intent&.to_sym == :Stamp
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # StrikeOut annotation. /Subtype /StrikeOut.
+      class StrikeOutAnnotation < TextMarkupAnnotation
+      end
+    end
+  end
+end

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

@@ -9,6 +9,81 @@ module Pdfrb
       # for /Figure elements.
       class StructElem < Pdfrb::Model::Cos::Dictionary
         arlington_object "StructElem"
+        register_type :StructElem
+
+        def type; self[:Type]; end
+        def structure_type; self[:S]; end
+        def parent; self[:P]; end
+        def kids; self[:K]; end
+        def page; self[:Pg]; end
+        def attributes; self[:A]; end
+        def classes; self[:C]; end
+        def actual_text; self[:ActualText]; end
+        def alt_text; self[:Alt]; end
+        def title; self[:T]; end
+        def lang; self[:Lang]; end
+        def expanded_abbreviation; self[:E]; end
+
+        def block_level?
+          %i[Document Part Art Sect Div BlockQuote Caption TOC TOCI
+             Index NonStruct H H1 H2 H3 H4 H5 H6 P L LI Lbl LBody
+             Table TR TH TD THead TBody TFoot].include?(structure_type&.to_sym)
+        end
+
+        def inline_level?
+          %i[Span Quote Note Reference BibEntry Code Figure Formula Form].include?(structure_type&.to_sym)
+        end
+
+        def has_alt_text?
+          !!alt_text
+        end
+
+        def has_actual_text?
+          !!actual_text
+        end
+
+        def figure?
+          structure_type&.to_sym == :Figure
+        end
+
+        def link?
+          structure_type&.to_sym == :Link
+        end
+
+        def heading?
+          %i[H H1 H2 H3 H4 H5 H6].include?(structure_type&.to_sym)
+        end
+
+        def table?
+          structure_type&.to_sym == :Table
+        end
+
+        def resolved_parent
+          ref = parent
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+
+        def resolved_page
+          ref = page
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+
+        def each_child
+          return enum_for(:each_child) unless block_given?
+          return unless kids && document
+
+          arr = kids.is_a?(Pdfrb::Model::Reference) ? document.object(kids) : kids
+          return unless arr.is_a?(Array) || arr.is_a?(Pdfrb::Model::PdfArray)
+
+          arr.each do |kid|
+            obj = kid.is_a?(Pdfrb::Model::Reference) ? document.object(kid) : kid
+            yield obj if obj
+          end
+        end
       end
     end
   end

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

@@ -9,6 +9,40 @@ module Pdfrb
       class StructTreeRoot < Pdfrb::Model::Cos::Dictionary
         arlington_object "StructTreeRoot"
         register_type :StructTreeRoot
+
+        def type; self[:Type]; end
+        def children; self[:K]; end
+        def parent_tree; self[:ParentTree]; end
+        def parent_tree_next_key; self[:ParentTreeNextKey]; end
+        def role_map; self[:RoleMap]; end
+        def class_map; self[:ClassMap]; end
+
+        def each_child
+          return enum_for(:each_child) unless block_given?
+          return unless children && document
+
+          arr = children.is_a?(Pdfrb::Model::Reference) ? document.object(children) : children
+          return unless arr.is_a?(Array) || arr.is_a?(Pdfrb::Model::PdfArray)
+
+          arr.each do |kid_ref|
+            obj = kid_ref.is_a?(Pdfrb::Model::Reference) ? document.object(kid_ref) : kid_ref
+            yield obj if obj
+          end
+        end
+
+        def mapped_role(custom_name)
+          return nil unless role_map.is_a?(::Hash)
+
+          role_map[custom_name.to_sym] || role_map[custom_name.to_s]
+        end
+
+        def has_role_map?
+          !!role_map
+        end
+
+        def has_class_map?
+          !!class_map
+        end
       end
     end
   end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Structure Attributes Dictionary (s14.7.5). Per-structure-element
+      # attributes — owner + per-owner attribute fields (Layout, Table,
+      # List, PrintField, etc.).
+      class StructureAttributes < Pdfrb::Model::Cos::Dictionary
+        def owner; self[:O]; end
+        def namespace; self[:NS]; end
+        def placement; self[:Placement]&.to_sym; end
+        def writing_mode; (self[:WritingMode] || :LrTb).to_sym; end
+        def background_color; self[:BackgroundColor]; end
+        def border_color; self[:BorderColor]; end
+        def border_style; self[:BorderStyle]; end
+        def border_thickness; self[:BorderThickness]; end
+        def padding; self[:Padding]; end
+        def color; self[:Color]; end
+        def text_align; self[:TextAlign]&.to_sym; end
+        def width; self[:Width]; end
+        def height; self[:Height]; end
+        def space_before; self[:SpaceBefore]; end
+        def space_after; self[:SpaceAfter]; end
+        def start_indent; self[:StartIndent]; end
+        def end_indent; self[:EndIndent]; end
+        def text_indent; self[:TextIndent]; end
+        def line_height; self[:LineHeight]; end
+
+        def layout_owner?; owner == :Layout; end
+        def list_owner?; owner == :List; end
+        def table_owner?; owner == :Table; end
+        def print_field_owner?; owner == :PrintField; end
+        def artifact_owner?; owner == :Artifact; end
+        def xml_owner?; owner.to_s.start_with?("XML", "HTML"); end
+        def user_properties_owner?; owner == :UserProperties; end
+
+        def has_namespace?
+          !!namespace
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Structure Element Kid Reference. When a struct element's kid
+      # is a content-stream marker (MCID), the kid is represented as
+      # an integer; when it's a sub-element, it's a dict reference.
+      class StructureElementKid < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def page; self[:Pg]; end
+        def mcid; self[:MCID]; end
+        def object; self[:Obj]; end
+        def structure_type; self[:S]; end
+
+        def content_item?
+          !mcid.nil?
+        end
+
+        def object_reference?
+          !!object
+        end
+
+        def resolved_page
+          ref = page
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Sticky note annotation (s12.5.6.10).
+      class TextAnnotation < MarkupAnnotation
+        def state; self[:State]; end
+        def state_model; self[:StateModel]; end
+
+        def open?
+          !!value[:Open]
+        end
+
+        def marked_state?
+          state_model&.to_sym == :Marked
+        end
+
+        def review_state?
+          state_model&.to_sym == :Review
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class TextAppearance < GenericAppearance; end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class TextField < Field
+        def max_len; self[:MaxLen]; end
+        def value; self[:V]; end
+        def rich_text_value; self[:RV]; end
+
+        def multiline?; flags & 0x1000 != 0; end
+        def password?; flags & 0x2000 != 0; end
+        def file_select?; flags & 0x100000 != 0; end
+        def do_not_spell_check?; flags & 0x400000 != 0; end
+        def do_not_scroll?; flags & 0x800000 != 0; end
+        def comb?; flags & 0x1000000 != 0; end
+        def rich_text?; flags & 0x2000000 != 0; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Text-markup annotations (s12.5.6.10). Common base for Highlight,
+      # Underline, Squiggly, StrikeOut — all share /QuadPoints.
+      class TextMarkupAnnotation < MarkupAnnotation
+        def quad_points; self[:QuadPoints]; end
+
+        def quad_point_count
+          return 0 unless quad_points
+
+          arr = quad_points.is_a?(Pdfrb::Model::PdfArray) ? quad_points.to_a : quad_points
+          arr.is_a?(Array) ? arr.size / 8 : 0
+        end
+
+        def each_quad(&block)
+          return enum_for(:each_quad) unless block
+          return unless quad_points
+
+          arr = quad_points.is_a?(Pdfrb::Model::PdfArray) ? quad_points.to_a : quad_points
+          return unless arr.is_a?(Array)
+
+          arr.each_slice(8, &block)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Activation (s13.6.2). Controls when a 3D stream becomes
+      # active and how it's deactivated.
+      class ThreeDActivation < Pdfrb::Model::Cos::Dictionary
+        def activation_mode; self[:A]&.to_sym; end
+        def activation_instance; self[:AIS]&.to_sym; end
+        def deactivation_mode; self[:D]&.to_sym; end
+        def deactivation_instance; self[:DIS]&.to_sym; end
+        def toolbar?; truthy?(self[:TB]); end
+        def new_page?; truthy?(self[:NP]); end
+        def style; self[:Style]&.to_sym; end
+        def transparent?; truthy?(self[:Transparent]); end
+        def window; self[:Window]; end
+
+        def activation_on_click?; activation_mode == :PO; end
+        def activation_on_page_open?; activation_mode == :PV; end
+        def activation_on_page_visible?; activation_mode == :XA; end
+
+        def deactivation_on_page_close?; deactivation_mode == :PC; end
+        def deactivation_on_page_hidden?; deactivation_mode == :PI; end
+        def deactivation_on_external_deactivation?; deactivation_mode == :XD; end
+
+        def embedded_style?; style == :Embedded; end
+        def windowed_style?; style == :Windowed; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Animation Style (s13.6.3, Table 312-313). Animation control
+      # for a 3D stream.
+      class ThreeDAnimationStyle < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def subtype; self[:Subtype]&.to_sym; end
+        def play_count; self[:PC] || 0; end
+        def time_multiplier; self[:TM] || 1; end
+
+        def no_animation?; subtype == :None; end
+        def linear?; subtype == :Linear; end
+        def oscillating?; subtype == :Oscillating; end
+
+        def loop_forever?
+          play_count.zero?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Background (s13.6.4). Background fill for a 3D view.
+      class ThreeDBackground < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def subtype; self[:Subtype]&.to_sym; end
+        def color_space; self[:CS]; end
+        def color; self[:C]; end
+        def enable_alpha?; truthy?(self[:EA]); end
+
+        def solid_color?
+          subtype == :SC
+        end
+
+        def image_background?
+          subtype == :I
+        end
+
+        def default_white?
+          color == [1, 1, 1]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Cross Section (s13.6.4). Plane cutaway view of a 3D model.
+      class ThreeDCrossSection < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def center; self[:C]; end
+        def orientation; self[:O]; end
+        def plane_opacity; self[:PO] || 0.5; end
+        def plane_color; self[:PC]; end
+        def intersection_visible?; truthy?(self[:IV]); end
+        def plane_visible?; truthy?(self[:PV]); end
+        def show_transparent?; truthy?(self[:ST]); end
+        def show_cut?; truthy?(self[:SC]); end
+        def intersection_color; self[:IC]; end
+
+        def has_plane_color?
+          !!plane_color
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Lighting Scheme (s13.6.4, Table 320-321). Lighting preset.
+      class ThreeDLightingScheme < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def subtype; self[:Subtype]&.to_sym; end
+
+        def artwork?; subtype == :Artwork; end
+        def none?; subtype == :None; end
+        def white?; subtype == :White; end
+        def day?; subtype == :Day; end
+        def night?; subtype == :Night; end
+        def hard?; subtype == :Hard; end
+        def primary?; subtype == :Primary; end
+        def blue?; subtype == :Blue; end
+        def red?; subtype == :Red; end
+        def cube?; subtype == :Cube; end
+        def cad?; subtype == :CAD; end
+        def headlamp?; subtype == :Headlamp; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Measure base (s13.6.4). Common base for the 3D measure
+      # subtypes: 3DC, AD3, LD3, PD3, RD3.
+      class ThreeDMeasure < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def subtype; self[:Subtype]&.to_sym; end
+
+        def perpendicular_distance?; subtype == :PD3; end
+        def linear_distance?; subtype == :LD3; end
+        def radial_distance?; subtype == :RD3; end
+        def angle?; subtype == :AD3; end
+        def comment?; subtype == :"3DC"; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Comment (3DC) measure (s13.6.4). A 3D measurement note.
+      class ThreeDMeasure3DC < ThreeDMeasure
+        def text; self[:TRL]; end
+        def anchor; self[:A1]; end
+        def name; self[:N1]; end
+        def text_position; self[:TP]; end
+        def text_box; self[:TB]; end
+        def text_size; self[:TS] || 12; end
+        def color; self[:C]; end
+        def unit_text; self[:UT]; end
+
+        def default_color?
+          color == [1, 1, 1]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Angle Distance measure (AD3, s13.6.4).
+      class ThreeDMeasureAD3 < ThreeDMeasure
+        def annotation1; self[:A1]; end
+        def annotation2; self[:A2]; end
+        def angle; self[:A]; end
+      end
+    end
+  end
+end