pdfrb 0.3.0 → 0.6.0

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

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

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Perpendicular Distance measure (PD3, s13.6.4).
+      class ThreeDMeasurePD3 < ThreeDMeasure
+        def annotation1; self[:A1]; end
+        def annotation2; self[:A2]; end
+        def distance; self[:D]; end
+        def leader_line_extension; self[:LE]; end
+        def leader_line_length; self[:LL]; end
+
+        def has_both_anchors?
+          !!annotation1 && !!annotation2
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Node (s13.6.4). A node in a 3D model's scene graph.
+      class ThreeDNode < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def name; self[:N]; end
+        def opacity; self[:O]; end
+        def visible?; truthy?(self[:V]); end
+        def matrix; self[:M]; end
+        def instance; self[:Instance]; end
+        def data; self[:Data]; end
+        def render_mode; self[:RM]; end
+
+        def has_render_mode?
+          !!render_mode
+        end
+
+        def resolved_instance
+          ref = instance
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+
+        def resolved_render_mode
+          ref = render_mode
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Reference (s13.6.5). Indirect reference to a 3D stream
+      # elsewhere in the document.
+      class ThreeDReference < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def target_stream; self[:Target]; end
+
+        def resolved_target
+          ref = target_stream
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Render Mode (s13.6.4, Table 318-319). Rendering style for
+      # 3D objects (solid, wireframe, transparent, etc.).
+      class ThreeDRenderMode < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def subtype; self[:Subtype]&.to_sym; end
+        def auxiliary_color; self[:AC]; end
+        def face_color; self[:FC]; end
+        def opacity; self[:O] || 0.5; end
+        def crease_value; self[:CV] || 45; end
+
+        def solid?; subtype == :Solid; end
+        def solid_wireframe?; subtype == :SolidWireframe; end
+        def transparent?; subtype == :Transparent; end
+        def transparent_wireframe?; subtype == :TransparentWireframe; end
+        def bounding_box?; subtype == :BoundingBox; end
+        def wireframe?; subtype == :Wireframe; end
+        def shaded_wireframe?; subtype == :ShadedWireframe; end
+        def hidden_wireframe?; subtype == :HiddenWireframe; end
+        def vertices?; subtype == :Vertices; end
+        def illustration?; subtype == :Illustration; end
+        def solid_outline?; subtype == :SolidOutline; end
+
+        def has_opacity?
+          opacity.between?(0, 1)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Stream (s13.6.3). Carries a U3D or PRC binary 3D model.
+      class ThreeDStream < Pdfrb::Model::Cos::Stream
+        def type; self[:Type]; end
+        def subtype; self[:Subtype]&.to_sym; end
+        def views; self[:VA]; end
+        def default_view; self[:DV]; end
+        def animation; self[:AN]; end
+        def on_instantiate; self[:OnInstantiate]; end
+        def color_space; self[:ColorSpace]; end
+
+        def u3d?
+          subtype == :U3D
+        end
+
+        def prc?
+          subtype == :PRC
+        end
+
+        def step?
+          subtype == :STEP
+        end
+
+        def view_count
+          return 0 unless views
+
+          arr = views.is_a?(Pdfrb::Model::PdfArray) ? views.to_a : views
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def each_view
+          return enum_for(:each_view) unless block_given?
+          return unless views && document
+
+          arr = views.is_a?(Pdfrb::Model::PdfArray) ? views.to_a : views
+          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/three_d_units.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D Units (s13.6.4). Scaling factor and unit name for 3D measures.
+      class ThreeDUnits < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def unit_name; self[:U]; end
+        def scale_factor; self[:SF]; end
+
+        def has_scale_factor?
+          !!scale_factor
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D View (s13.6.4). A single camera/lighting/material configuration
+      # for a 3D stream.
+      class ThreeDView < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def external_name; self[:XN]; end
+        def internal_name; self[:IN]; end
+        def measure_space; self[:MS]&.to_sym; end
+        def camera_to_world; self[:C2W]; end
+        def u3d_path; self[:U3DPath]; end
+        def camera_offset; self[:CO]; end
+        def projection; self[:P]; end
+        def measures; self[:MA]; end
+
+        def matrix_space?
+          measure_space == :M
+        end
+
+        def u3d_space?
+          measure_space == :U3D
+        end
+
+        def has_measures?
+          !!measures && (!measures.is_a?(Array) || !measures.empty?)
+        end
+
+        def resolved_projection
+          ref = projection
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # ToUnicode CMap stream (s9.10.3). Maps glyph codes to Unicode
+      # strings for text extraction.
+      class ToUnicodeCMapStream < Pdfrb::Model::Cos::Stream
+        def type; self[:Type]; end
+
+        def cmap_source
+          decoded_stream&.force_encoding(Encoding::BINARY)
+        end
+
+        def has_codespace?
+          return false unless cmap_source
+
+          cmap_source.include?("begincodespacerange")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Page Transition dict (s12.4.3). Animation for moving between
+      # pages in FullScreen mode. Lives on Page /Trans or on an
+      # ActionTrans.
+      class Transition < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def style; self[:S]&.to_sym; end
+        def duration; self[:D]; end
+        def dimension; self[:Dm]&.to_sym; end
+        def motion_direction; self[:M]&.to_sym; end
+        def direction; self[:Di] || 0; end
+        def scale; self[:SS] || 1.0; end
+        def bidirectional?; truthy?(self[:B]); end
+
+        def split?; style == :Split; end
+        def blinds?; style == :Blinds; end
+        def box?; style == :Box; end
+        def wipe?; style == :Wipe; end
+        def dissolve?; style == :Dissolve; end
+        def glitter?; style == :Glitter; end
+        def fly?; style == :Fly; end
+        def push?; style == :Push; end
+        def cover?; style == :Cover; end
+        def uncover?; style == :Uncover; end
+        def fade?; style == :Fade; end
+
+        def horizontal?; dimension == :H; end
+        def vertical?; dimension == :V; end
+
+        def inward?; motion_direction == :I; end
+        def outward?; motion_direction == :O; end
+      end
+
+      # Printer Mark sub-dictionary (s12.5.6.18). Per-printer-mark
+      # sub-parameters.
+      class PrinterMarkSubDict < Pdfrb::Model::Cos::Dictionary
+        def printer; self[:PRINTER]; end
+        def credentials; self[:CREDS]; end
+      end
+
+      # ExData 3D Markup (s13.6.1). 3D scene metadata for Projection
+      # annotations / 3D models.
+      class ExData3DMarkup < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def v3d; self[:V3D]; end
+
+        def has_3d?
+          !!v3d
+        end
+      end
+
+      # ExData Markup Geo (s12.5.6.21). Geo-spatial markup attached to
+      # a Projection annotation.
+      class ExDataMarkupGeo < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def coordinate_path; self[:CoordinatePath]; end
+
+        def has_coordinate_path?
+          !!coordinate_path
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # UR Transform Parameters (s12.8.2.3). Adobe Reader-enabled
+      # usage rights — annotations, form fill-in, signatures allowed.
+      class URTransformParameters < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def annotations; self[:Annots]; end
+        def form; self[:Form]; end
+        def signature; self[:Signature]; end
+        def ef; self[:EF]; end
+
+        def has_annotation_rights?
+          !!annotations
+        end
+
+        def has_form_rights?
+          !!form
+        end
+
+        def has_signature_rights?
+          !!signature
+        end
+
+        def has_embedded_file_rights?
+          !!ef
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # URI dict (s12.5.6.5). Catalog /URI dict for base URI and
+      # retriever map.
+      class URIDict < Pdfrb::Model::Cos::Dictionary
+        def base; self[:Base]; end
+        def retriever_map; self[:Map]; end
+
+        def has_base?
+          !!base
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # URL Alias (s7.9.6). Names dictionary entry mapping friendly
+      # URLs to actual URLs for collection sub-items.
+      class URLAlias < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def alias_value; self[:U]; end
+        def url; self[:URL]; end
+
+        def has_alias?
+          !!alias_value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Variable Text Field (s12.7.4.3). Base for text fields with
+      # dynamic appearance generation. Adds /DA, /Q, /RV.
+      class VariableTextField < Field
+        def default_appearance; self[:DA]; end
+        def da; self[:DA]; end
+        def q; self[:Q]; end
+        def rv; self[:RV]; end
+
+        def text_alignment
+          case q
+          when 1 then :center
+          when 2 then :right
+          when 3 then :justify
+          else :left
+          end
+        end
+
+        def has_rich_text?
+          !!rv
+        end
+
+        def default_appearance_font
+          return nil unless default_appearance
+
+          match = default_appearance.to_s.match(/\/(\w+)\s+([\d.]+)\s+Tf/)
+          return nil unless match
+
+          [match[1].to_sym, match[2].to_f]
+        end
+
+        def default_appearance_color
+          return nil unless default_appearance
+
+          match = default_appearance.to_s.match(/([\d.]+)\s+([\d.]+)\s+([\d.]+)\s+rg/)
+          return nil unless match
+
+          [match[1].to_f, match[2].to_f, match[3].to_f]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # ViewerPreferences (s12.2, ISO 32000-2 7.7.2). Catalog /ViewerPreferences.
+      class ViewerPreferences < Cos::Dictionary
+        register_type :ViewerPreferences
+
+        def type; self[:Type]; end
+        def hide_toolbar?; truthy?(self[:HideToolbar]); end
+        def hide_menubar?; truthy?(self[:HideMenubar]); end
+        def hide_window_ui?; truthy?(self[:HideWindowUI]); end
+        def fit_window?; truthy?(self[:FitWindow]); end
+        def center_window?; truthy?(self[:CenterWindow]); end
+        def display_doc_title?; truthy?(self[:DisplayDocTitle]); end
+        def non_fullscreen_page_mode; self[:NonFullScreenPageMode]; end
+        def direction; self[:Direction]; end
+        def view_area; self[:ViewArea]; end
+        def view_clip; self[:ViewClip]; end
+        def print_area; self[:PrintArea]; end
+        def print_clip; self[:PrintClip]; end
+        def print_scaling; self[:PrintScaling]; end
+        def duplex; self[:Duplex]; end
+        def pick_tray_by_pdf_size?; truthy?(self[:PickTrayByPDFSize]); end
+        def print_pagerange; self[:PrintPageRange]; end
+        def num_copies; self[:NumCopies]; end
+
+        def left_to_right?; direction&.to_sym == :L2R; end
+        def right_to_left?; direction&.to_sym == :R2L; end
+
+        def simplex?; duplex&.to_sym == :Simplex; end
+        def duplex_flip_short_edge?; duplex&.to_sym == :DuplexFlipShortEdge; end
+        def duplex_flip_long_edge?; duplex&.to_sym == :DuplexFlipLongEdge; end
+
+        def enforce_print_scaling?
+          print_scaling&.to_sym == :AppDefault
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Watermark annotation (s12.5.6.23). PDF 2.0. Non-printing,
+      # non-interactive visual watermark behind/over page content.
+      class WatermarkAnnotation < Annotation
+        def fixed_print?; !!value[:FixedPrint]; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class WidgetAnnotation < Annotation
+        def field; self[:Parent]; end
+        def appearance_stream; self[:AP]; end
+        def highlight_mode; self[:H]; end
+        def mk; self[:MK]; end
+        def action; self[:A]; end
+        def additional_actions; self[:AA]; end
+
+        def resolved_field
+          ref = field
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+
+        def button_background_color
+          return nil unless mk
+
+          obj = mk.is_a?(Pdfrb::Model::Reference) && document ? document.object(mk) : mk
+          obj && obj[:BG]
+        end
+
+        def button_caption
+          return nil unless mk
+
+          obj = mk.is_a?(Pdfrb::Model::Reference) && document ? document.object(mk) : mk
+          obj && obj[:CA]
+        end
+
+        def normal_caption
+          return nil unless mk
+
+          obj = mk.is_a?(Pdfrb::Model::Reference) && document ? document.object(mk) : mk
+          obj && obj[:CA]
+        end
+
+        def has_action?
+          !!action
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -7,6 +7,47 @@ module Pdfrb
       # /BBox, /Matrix, /Resources, /Group, /Filter, etc.
       class XObjectForm < Pdfrb::Model::Cos::Stream
         arlington_object "XObjectFormType1"
+
+        def subtype; self[:Subtype]; end
+        def bbox; self[:BBox]; end
+        def matrix; self[:Matrix]; end
+        def resources; self[:Resources]; end
+        def group; self[:Group]; end
+        def filter; self[:Filter]; end
+        def decode_parms; self[:DecodeParms]; end
+        def form_type; self[:FormType] || 1; end
+        def oc; self[:OC]; end
+        def name; self[:Name]; end
+        def last_modified; self[:LastModified]; end
+        def piece_info; self[:PieceInfo]; end
+        def struct_parent; self[:StructParent]; end
+        def associated_files; self[:AF]; end
+        def mark_stream_data?; truthy?(self[:MS]); end
+
+        def transparency_group?
+          !!group
+        end
+
+        def isolated?
+          group && !!group[:I]
+        end
+
+        def knockout?
+          group && !!group[:K]
+        end
+
+        def default_color_space
+          group && group[:CS]
+        end
+
+        def identity_matrix?
+          return true unless matrix
+
+          arr = matrix.is_a?(Pdfrb::Model::PdfArray) ? matrix.to_a : matrix
+          return true unless arr.is_a?(Array) && arr.size == 6
+
+          arr[0] == 1 && arr[1].zero? && arr[2].zero? && arr[3] == 1 && arr[4].zero? && arr[5].zero?
+        end
       end
     end
   end