Module: RustPdf::Native

Defined in:
lib/rustpdf/native.rb

Overview

Internal: dlopen's libpdf_ffi and builds memoized Fiddle::Function objects from a signature table. Not part of the public API.

Constant Summary collapse

VP = 
Fiddle::TYPE_VOIDP
I = 
Fiddle::TYPE_INT
D = 
Fiddle::TYPE_DOUBLE
SZ = 
Fiddle::TYPE_SIZE_T
VOID = 
Fiddle::TYPE_VOID
SIZEOF_SZ =

size_t / uintptr_t and int widths (for out-parameter buffers).

Fiddle::SIZEOF_VOIDP
SIZEOF_INT = 
Fiddle::SIZEOF_INT
SIGS = 
{
  "pdf_version"                  => [[], VP],
  "pdf_last_error_message"       => [[], VP],
  "pdf_activate_license"         => [[VP], I],
  "pdf_buffer_free"              => [[VP, SZ], VOID],

  "pdf_document_new"             => [[], VP],
  "pdf_document_free"            => [[VP], VOID],
  "pdf_document_add_page"        => [[VP], I],
  "pdf_document_add_page_sized"  => [[VP, D, D], I],
  "pdf_document_page_count"      => [[VP], I],
  "pdf_page_set_fill_rgb"        => [[VP, D, D, D], I],
  "pdf_page_set_stroke_rgb"      => [[VP, D, D, D], I],
  "pdf_page_set_line_width"      => [[VP, D], I],
  "pdf_page_rect"                => [[VP, D, D, D, D], I],
  "pdf_page_fill"                => [[VP], I],
  "pdf_page_stroke"              => [[VP], I],
  "pdf_document_save"            => [[VP, VP], I],
  "pdf_document_write"           => [[VP, VP, VP], I],
  "pdf_document_pdfa"            => [[VP], I],
  "pdf_document_pdfa_level"      => [[VP, I], I],
  "pdf_document_tagged"          => [[VP], I],
  "pdf_document_set_version"     => [[VP, I], I],
  "pdf_document_set_default_size" => [[VP, D, D], I],
  "pdf_document_set_info"        => [[VP, VP, VP, VP, VP, VP], I],
  "pdf_document_add_font_file"   => [[VP, VP, VP], I],
  "pdf_document_add_font"        => [[VP, VP, SZ, VP], I],
  "pdf_page_show_text"           => [[VP, I, D, D, D, VP, I], I],
  "pdf_page_paragraph"           => [[VP, I, D, D, D, D, I, VP], I],
  "pdf_document_add_image_file"  => [[VP, VP, VP], I],
  "pdf_document_add_image_png"   => [[VP, VP, SZ, VP], I],
  "pdf_document_add_image_jpeg"  => [[VP, VP, SZ, VP], I],
  "pdf_page_draw_image"          => [[VP, I, D, D, D, D], I],
  "pdf_page_figure"              => [[VP, I, D, D, D, D, VP], I],
  "pdf_document_attach_file"     => [[VP, VP, VP, VP, SZ, I, VP], I],
  "pdf_document_text_field"      => [[VP, VP, SZ, D, D, D, D, VP, D], I],
  "pdf_document_checkbox"        => [[VP, VP, SZ, D, D, D, D, I], I],
  "pdf_document_dropdown"        => [[VP, VP, SZ, D, D, D, D, VP, I, D], I],
  "pdf_document_radio_group"     => [[VP, VP, SZ, SZ, VP, VP, I], I],

  "pdf_editable_load"            => [[VP, SZ], VP],
  "pdf_editable_load_password"   => [[VP, SZ, VP], VP],
  "pdf_editable_free"            => [[VP], VOID],
  "pdf_editable_page_count"      => [[VP], I],
  "pdf_editable_merge"           => [[VP, VP], I],
  "pdf_editable_rotate_page"     => [[VP, SZ, I], I],
  "pdf_editable_delete_page"     => [[VP, SZ], I],
  "pdf_editable_reorder_pages"   => [[VP, VP, SZ], I],
  "pdf_editable_extract_pages"   => [[VP, VP, SZ, VP], I],
  "pdf_editable_set_info"        => [[VP, VP, VP], I],
  "pdf_editable_get_info"        => [[VP, VP, VP, VP], I],
  "pdf_editable_set_xmp"         => [[VP, VP, SZ], I],
  "pdf_editable_overlay_page"    => [[VP, SZ, VP, SZ], I],
  "pdf_editable_fill_text_field" => [[VP, VP, VP, VP], I],
  "pdf_editable_optimize"        => [[VP], I],
  "pdf_editable_compact"         => [[VP, I], I],
  "pdf_editable_encrypt"         => [[VP, I, VP, VP, I], I],
  "pdf_editable_to_bytes"        => [[VP, VP, VP], I],
  "pdf_editable_to_bytes_incremental" => [[VP, VP, SZ, VP, VP], I],
  "pdf_editable_save"            => [[VP, VP], I],

  "pdf_extract_text"             => [[VP, SZ, VP, VP], I],
  "pdf_extract_page_text"        => [[VP, SZ, SZ, VP, VP], I],
  "pdf_extract_images_to_dir"    => [[VP, SZ, VP, VP], I],
  "pdf_render_page_to_png"       => [[VP, SZ, SZ, D, VP, VP], I],
  "pdf_page_count"               => [[VP, SZ, VP], I],
  "pdf_sign"                     => [[VP, SZ, VP, SZ, VP, SZ, VP, VP, VP, I, VP, VP], I],
  "pdf_timestamp"                => [[VP, SZ, VP, SZ, VP, SZ, VP, VP, VP], I],
  "pdf_add_dss"                  => [[VP, SZ, VP, VP, SZ, VP, VP, SZ, VP, VP], I],

  # Tier 1: hyperlinks + bookmarks (Document)
  "pdf_page_link_uri"            => [[VP, D, D, D, D, VP], I],
  "pdf_page_link_to_page"        => [[VP, D, D, D, D, SZ, D, I], I],
  "pdf_document_add_bookmarks"   => [[VP, SZ, VP, VP, VP, VP, VP], I],
  # Tier 2: ZUGFeRD / Factur-X (Document)
  "pdf_document_facturx"         => [[VP, VP, SZ, I], I],
  # Tier 1: form fill + flatten + watermark (EditableDoc)
  "pdf_editable_set_checkbox"    => [[VP, VP, I, VP], I],
  "pdf_editable_set_radio"       => [[VP, VP, VP, VP], I],
  "pdf_editable_set_choice"      => [[VP, VP, VP, VP], I],
  "pdf_editable_flatten_forms"   => [[VP], I],
  "pdf_editable_field_names"     => [[VP, VP, VP], I],
  # watermark_text gained a trailing int opaque_background; watermark_image
  # gained a trailing double rotation_deg (issue #41 P1).
  "pdf_editable_watermark_text"  => [[VP, VP, D, D, D, D, D, D, I], I],
  "pdf_editable_watermark_image_file" => [[VP, VP, D, D, D, D], I],
  # Tier 2: redaction + PDF/A conversion (EditableDoc)
  "pdf_editable_redact"          => [[VP, SZ, VP, SZ, VP], I],
  "pdf_editable_convert_to_pdfa" => [[VP, I], I],
  # Tier 2: signature validation (module-level)
  "pdf_verify_signatures_json"   => [[VP, SZ, VP, VP], I],

  # Deferred / external (HSM) signing — issue #41 P0. The PdfSigningOptions
  # struct crosses as an opaque pointer (VP); the Model-A callback is a
  # Fiddle::Closure passed as a function pointer (VP).
  "pdf_sign_begin"               => [[VP, SZ, VP, VP, VP, VP, VP], I],
  "pdf_sign_complete"            => [[VP, SZ, VP, SZ, VP, VP], I],
  "pdf_sign_with"                => [[VP, SZ, VP, SZ, VP, VP, SZ, VP, VP, VP, VP, VP], I],
  "pdf_list_signatures"          => [[VP, SZ, VP, VP], I],

  # Issue #41 P1: positional text search, version normalization, network TSA.
  "pdf_find_text_json"           => [[VP, SZ, VP, I, VP, VP], I],
  "pdf_editable_set_version"     => [[VP, I], I],
  "pdf_editable_strip_pdfa"      => [[VP], I],
  "pdf_editable_normalize"       => [[VP, I], I],
  "pdf_timestamp_begin"          => [[VP, SZ, VP, VP, VP, VP], I],
  "pdf_timestamp_request"        => [[VP, SZ, VP, SZ, I, VP, VP], I],
  "pdf_timestamp_token_from_response" => [[VP, SZ, VP, VP], I],

  # Issue #45 P1: page geometry, document inspection, positioned drawing.
  "pdf_measure_pages_json"       => [[VP, SZ, VP, VP], I],
  "pdf_inspect_json"             => [[VP, SZ, VP, VP], I],
  "pdf_editable_fill_rect"       => [[VP, I, D, D, D, D, D, D, D, D, VP], I],
  "pdf_editable_place_text"      => [[VP, I, D, D, VP, D, D, D, D, D, VP], I],
  "pdf_editable_place_text_aligned" => [[VP, I, D, D, VP, D, D, D, D, D, I, VP], I],
  "pdf_editable_masked_text"     => [[VP, I, D, D, D, D, VP, D, D, D, D, D, D, D, I, VP], I],
  # Issue #50: stamp a PNG/JPEG image onto an existing page. The image bytes
  # cross as the (uint8_t* data, uintptr_t len) pair, like pdf_editable_load.
  "pdf_editable_draw_image"      => [[VP, I, VP, SZ, D, D, D, D, D, VP], I],

  # Stamping fonts + anchored stamping primitives. font_id -1 = built-in
  # Helvetica; anchors/valign/space/image-anchor cross as small ints.
  "pdf_editable_add_font_file"   => [[VP, VP, VP], I],
  "pdf_editable_add_font"        => [[VP, VP, SZ, VP], I],
  "pdf_editable_place_text_anchored" => [[VP, I, D, D, VP, D, D, D, D, D, I, I, I, VP], I],
  "pdf_editable_masked_text_pad" => [[VP, I, D, D, D, D, VP, D, D, D, D, D, D, D, I, I, D, I, VP], I],
  "pdf_editable_place_paragraph_anchored" =>
    [[VP, I, D, D, D, VP, D, D, D, D, I, I, I, D, D, D, VP, VP, VP], I],
  "pdf_editable_set_stamp_space" => [[VP, I], I],
  "pdf_editable_draw_image_anchored" => [[VP, I, VP, SZ, D, D, D, D, D, I, VP], I],
}.freeze

Class Method Summary collapse

Class Method Details

.[](name) ⇒ Object 



155
156
157
158
159
160
161
 
# File 'lib/rustpdf/native.rb', line 155

def [](name)
  @fns ||= {}
  @fns[name] ||= begin
    args, ret = SIGS.fetch(name)
    Fiddle::Function.new(lib[name], args, ret)
  end
end

.call(name, *args) ⇒ Object 



163
164
165
 
# File 'lib/rustpdf/native.rb', line 163

def call(name, *args)
  self[name].call(*args)
end

.gem_root ⇒ Object

Repo/gem root = two levels up from lib/rustpdf/.



196
197
198
 
# File 'lib/rustpdf/native.rb', line 196

def gem_root
  File.expand_path("../..", __dir__)
end

.lib ⇒ Object 



151
152
153
 
# File 'lib/rustpdf/native.rb', line 151

def lib
  @lib ||= Fiddle.dlopen(lib_path)
end

.lib_file_name ⇒ Object 



200
201
202
203
204
205
206
 
# File 'lib/rustpdf/native.rb', line 200

def lib_file_name
  case RbConfig::CONFIG["host_os"]
  when /mswin|mingw|cygwin/ then "pdf_ffi.dll"
  when /darwin/ then "libpdf_ffi.dylib"
  else "libpdf_ffi.so"
  end
end

.lib_path ⇒ Object

Raises:



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/rustpdf/native.rb', line 167

def lib_path
  env = ENV["RUSTPDF_LIB"]
  return env if env && !env.empty? && File.file?(env)

  file = lib_file_name

  # Packaged gem: the platform-specific cdylib is vendored under
  # vendor/<gem-platform>/ (staged by CI, see release-ruby.yml). Matches the
  # per-platform wheel/npm-package layout used by the Python/Node bindings.
  # A platform gem ships exactly one vendor/<plat>/ dir, so the first match
  # for this OS's lib file name is the right one — no platform-string parsing.
  vendored = Dir[File.join(gem_root, "vendor", "*", file)].find { |p| File.file?(p) }
  return vendored if vendored

  # Monorepo dev: walk up from lib/ to the Cargo build tree.
  dir = __dir__
  10.times do
    %w[debug release].each do |profile|
      candidate = File.join(dir, "target", profile, file)
      return candidate if File.file?(candidate)
    end
    parent = File.dirname(dir)
    break if parent == dir
    dir = parent
  end
  raise Error, "could not locate #{file}; build it with `cargo build -p pdf-ffi` or set RUSTPDF_LIB"
end