ruby-zint 1.0.0 → 1.1.0

data/lib/zint/native.rb

@@ -0,0 +1,87 @@
+module Zint
+  module Native
+    extend FFI::Library
+
+    root_path = File.expand_path("../../..", __FILE__)
+    prefix = FFI::Platform::LIBPREFIX.empty? ? "lib" : FFI::Platform::LIBPREFIX
+    bundled_dll = File.join(root_path, "lib/#{prefix}zint.#{FFI::Platform::LIBSUFFIX}")
+    ffi_lib [bundled_dll, "libzint.so.2.10", "libzint", "zint"]
+
+    # Error codes (API return values)
+    enum :error_code, [Constants::Warnings::WARNINGS, Constants::Errors::ERRORS].map { |h| h.to_a }.flatten
+
+    # Aliases for better method signatures
+    typedef Structs::Symbol.by_ref, :zint_symbol
+    typedef :pointer, :filename
+    typedef :int32, :length
+    typedef :int32, :rotate_angle
+    typedef :int32, :symbol_id
+    typedef :uint32, :cap_flag
+    typedef :string, :source
+
+    # Create and initialize a symbol structure
+    attach_function(:ZBarcode_Create, [], :zint_symbol)
+
+    # Free any output buffers that may have been created and initialize output fields
+    attach_function(:ZBarcode_Clear, [:zint_symbol], :void)
+
+    # Free a symbol structure, including any output buffers
+    #
+    # For use with ruby's garbage collector ZBarcode_Delete must be called with a plain :pointer and not an :zint_symbol.
+    attach_function(:ZBarcode_Delete, [:pointer], :void)
+
+    # Encode a barcode. If `length` is 0, `source` must be NUL-terminated.
+    attach_function(:ZBarcode_Encode, [:zint_symbol, :source, :length], :error_code)
+
+    # Encode a barcode using input data from file `filename`
+    attach_function(:ZBarcode_Encode_File, [:zint_symbol, :filename], :error_code)
+
+    # Output a previously encoded symbol to file `symbol->outfile`
+    attach_function(:ZBarcode_Print, [:zint_symbol, :rotate_angle], :error_code)
+
+    # Encode and output a symbol to file `symbol->outfile`
+    attach_function(:ZBarcode_Encode_and_Print, [:zint_symbol, :source, :length, :rotate_angle], :error_code)
+
+    # Encode a symbol using input data from file `filename` and output to file `symbol->outfile`
+    attach_function(:ZBarcode_Encode_File_and_Print, [:zint_symbol, :filename, :rotate_angle], :error_code)
+
+    # Output a previously encoded symbol to memory as raster (`symbol->bitmap`)
+    attach_function(:ZBarcode_Buffer, [:zint_symbol, :rotate_angle], :error_code)
+
+    # Encode and output a symbol to memory as raster (`symbol->bitmap`)
+    attach_function(:ZBarcode_Encode_and_Buffer, [:zint_symbol, :source, :length, :rotate_angle], :error_code)
+
+    # Encode a symbol using input data from file `filename` and output to memory as raster (`symbol->bitmap`)
+    attach_function(:ZBarcode_Encode_File_and_Buffer, [:zint_symbol, :filename, :rotate_angle], :error_code)
+
+    # Output a previously encoded symbol to memory as vector (`symbol->vector`)
+    attach_function(:ZBarcode_Buffer_Vector, [:zint_symbol, :rotate_angle], :error_code)
+
+    # Encode and output a symbol to memory as vector (`symbol->vector`)
+    attach_function(:ZBarcode_Encode_and_Buffer_Vector, [:zint_symbol, :source, :length, :rotate_angle], :error_code)
+
+    # Encode a symbol using input data from file `filename` and output to memory as vector (`symbol->vector`)
+    attach_function(:ZBarcode_Encode_File_and_Buffer_Vector, [:zint_symbol, :filename, :rotate_angle], :error_code)
+
+    # Is `symbol_id` a recognized symbology?
+    attach_function(:ZBarcode_ValidID, [:symbol_id], :bool)
+
+    # Return the capability flags for symbology `symbol_id` that match `cap_flag`
+    attach_function(:ZBarcode_Cap, [:symbol_id, :cap_flag], :uint32)
+
+    # Return the version of Zint linked to
+    attach_function(:ZBarcode_Version, [], :int32)
+
+    # Raises specific error for API return code
+    #
+    # @param res [Symbol, Integer] API return code
+    # @param text [String] error text
+    # @raise [Error]
+    def self.raise_error(res, text)
+      klass = ERROR_CLASS_FOR_RESULT[res.is_a?(Symbol) ? Zint::ERRORS[res] : res]
+      raise klass, text
+    end
+  end
+
+  private_constant :Native
+end

data/lib/zint/structs/symbol.rb

@@ -1,6 +1,6 @@
 module Zint
   module Structs
-    class Symbol < FFI::Struct
+    class Symbol < FFI::ManagedStruct
       layout :symbology, :int,
         :height, :float,
         :whitespace_width, :int,
@@ -33,9 +33,14 @@ module Zint
         :alphamap, :pointer,
         :bitmap_byte_length, :uchar,
         :dot_size, :float,
-        :vector, :pointer,
+        :vector, Vector.by_ref,
         :debug, :int,
         :warn_level, :int
+
+      # @private
+      def self.release(ptr)
+        Native.ZBarcode_Delete(ptr)
+      end
     end
   end
 end

data/lib/zint/structs/vector.rb

@@ -1,12 +1,54 @@
 module Zint
   module Structs
     class Vector < FFI::Struct
-      layout :width, :float,
+      layout :width, :float, # Width, height of barcode image (including text, whitespace)
         :height, :float,
-        :rectangles, :pointer,
-        :hexagons, :pointer,
-        :strings, :pointer,
-        :circles, :pointer
+        :rectangles, VectorRect.by_ref, # Pointer to first rectangle
+        :hexagons, VectorHexagon.by_ref, # Pointer to first hexagon
+        :strings, VectorString.by_ref, # Pointer to first string
+        :circles, VectorCircle.by_ref # Pointer to first circle
+
+      # Height of barcode image (including text, whitespace)
+      def height
+        self[:height]
+      end
+
+      # Width of barcode image (including text, whitespace)
+      def width
+        self[:width]
+      end
+
+      # Calls the given block and passes a VectorRect object for each rectangle to be printed.
+      def each_rectangle(&block)
+        each_vector(:rectangles, &block)
+      end
+
+      # Calls the given block and passes a VectorHexagon object for each hexagon to be printed.
+      def each_hexagon(&block)
+        each_vector(:hexagons, &block)
+      end
+
+      # Calls the given block and passes a VectorString object for each text string to be printed.
+      def each_string(&block)
+        each_vector(:strings, &block)
+      end
+
+      # Calls the given block and passes a VectorCircle object for each circle to be printed.
+      def each_circle(&block)
+        each_vector(:circles, &block)
+      end
+
+      private def each_vector(attr)
+        return to_enum(:each_vector, attr) unless block_given?
+
+        o = self[attr]
+        until o.null?
+          # Avoid garbage collection of Vector (and hence Barcode) before Vector*, since all memory is freed by ZBarcode_Delete()
+          o.instance_variable_set(:@vector, self)
+          yield o
+          o = o[:next]
+        end
+      end
     end
   end
 end

data/lib/zint/structs/vector_circle.rb

@@ -0,0 +1,31 @@
+module Zint
+  module Structs
+    class VectorCircle < FFI::Struct
+      layout :x, :float,
+        :y, :float,
+        :diameter, :float,
+        :colour, :int,  #  Non-zero for draw with background colour
+        :next, VectorCircle.by_ref #  Pointer to next circle
+
+      # x position
+      def x
+        self[:x]
+      end
+
+      # y position
+      def y
+        self[:y]
+      end
+
+      # diameter
+      def diameter
+        self[:diameter]
+      end
+
+      #  Non-zero for draw with background colour
+      def colour
+        self[:colour]
+      end
+    end
+  end
+end

data/lib/zint/structs/vector_hexagon.rb

@@ -0,0 +1,31 @@
+module Zint
+  module Structs
+    class VectorHexagon < FFI::Struct
+      layout :x, :float,
+        :y, :float,
+        :diameter, :float,
+        :rotation, :int,  # 0, 90, 180, 270 degrees
+        :next, VectorHexagon.by_ref # Pointer to next hexagon
+
+      # x position
+      def x
+        self[:x]
+      end
+
+      # y position
+      def y
+        self[:y]
+      end
+
+      # diameter
+      def diameter
+        self[:diameter]
+      end
+
+      # 0, 90, 180, 270 degrees
+      def rotation
+        self[:rotation]
+      end
+    end
+  end
+end

data/lib/zint/structs/vector_rect.rb

@@ -0,0 +1,37 @@
+module Zint
+  module Structs
+    class VectorRect < FFI::Struct
+      layout :x, :float,
+        :y, :float,
+        :height, :float,
+        :width, :float,
+        :colour, :int, # -1 for foreground, 1-8 for Cyan, Blue, Magenta, Red, Yellow, Green, Black, White
+        :next, VectorRect.by_ref # Pointer to next rectangle
+
+      # x position
+      def x
+        self[:x]
+      end
+
+      # y position
+      def y
+        self[:y]
+      end
+
+      # height
+      def height
+        self[:height]
+      end
+
+      # width
+      def width
+        self[:width]
+      end
+
+      # -1 for foreground, 1-8 for Cyan, Blue, Magenta, Red, Yellow, Green, Black, White
+      def colour
+        self[:colour]
+      end
+    end
+  end
+end

data/lib/zint/structs/vector_string.rb

@@ -1,15 +1,50 @@
 module Zint
   module Structs
     class VectorString < FFI::Struct
-      layout :x, :float,
+      layout :x, :float, # x, y position relative to halign
         :y, :float,
-        :fsize, :float,
-        :width, :float,
-        :length, :int,
-        :rotation, :int,
-        :halign, :int,
-        :text, :pointer,
-        :next, :pointer
+        :fsize, :float, # font size
+        :width, :float, # Suggested string width, may be 0 if none recommended
+        :length, :int, # Number of characters
+        :rotation, :int, # 0, 90, 180, 270 degrees
+        :halign, :int, # Horizontal alignment: 0 for centre, 1 for left, 2 for right (end)
+        :text, :pointer, # the text string to be printed
+        :next, VectorString.by_ref # Pointer to next string
+
+      # x position relative to halign
+      def x
+        self[:x]
+      end
+
+      # y position
+      def y
+        self[:y]
+      end
+
+      # font size
+      def fsize
+        self[:fsize]
+      end
+
+      # Suggested string width, may be 0 if none recommended
+      def width
+        self[:width]
+      end
+
+      # 0, 90, 180, 270 degrees
+      def rotation
+        self[:rotation]
+      end
+
+      # Horizontal alignment: 0 for centre, 1 for left, 2 for right (end)
+      def halign
+        self[:halign]
+      end
+
+      # the text string to be printed
+      def text
+        self[:text].read_bytes(self[:length])
+      end
     end
   end
 end

data/lib/zint/version.rb

@@ -1,3 +1,3 @@
 module Zint
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/zint/zint_recipe.rb

@@ -0,0 +1,27 @@
+require_relative "dependencies"
+require "rubygems"
+# Keep the version constraint in sync with libusb.gemspec
+gem "mini_portile2", Zint::MINI_PORTILE_VERSION
+require "mini_portile2"
+
+module Zint
+  class ZintRecipe < MiniPortileCMake
+    ROOT = File.expand_path("../../..", __FILE__)
+
+    def initialize
+      super("libzint", ZINT_VERSION)
+      self.target = File.join(ROOT, "ports")
+      self.files = [url: ZINT_SOURCE_URI, sha1: ZINT_SOURCE_SHA1]
+    end
+
+    def cook_and_activate
+      checkpoint = File.join(target, "#{name}-#{version}-#{host}.installed")
+      unless File.exist?(checkpoint)
+        cook
+        FileUtils.touch checkpoint
+      end
+      activate
+      self
+    end
+  end
+end

data/lib/zint.rb

@@ -1,6 +1,7 @@
 require "ffi"
 
 require "zint/version"
+require "zint/dependencies"
 
 # Zint constants
 require "zint/constants/capability_flags"
@@ -14,12 +15,13 @@ require "zint/constants/warn_levels"
 require "zint/constants/warnings"
 
 # Zint structs
-require "zint/structs/circle"
-require "zint/structs/hexagon"
-require "zint/structs/rect"
-require "zint/structs/symbol"
+require "zint/structs/vector_circle"
+require "zint/structs/vector_hexagon"
+require "zint/structs/vector_rect"
 require "zint/structs/vector_string"
 require "zint/structs/vector"
+require "zint/structs/symbol"
+require "zint/native"
 
 module Zint
   # Zint constants
@@ -137,8 +139,6 @@ module Zint
   autoload :UspsImail, "zint/uspsimail"
   autoload :Vin, "zint/vin"
 
-  extend FFI::Library
-
   class Error < StandardError; end
 
   ERROR_CLASS_FOR_RESULT = {}
@@ -152,85 +152,10 @@ module Zint
     ERROR_CLASS_FOR_RESULT[v] = klass
   end
 
-  # Raises specific error for API return code
-  #
-  # @param res [Symbol, Integer] API return code
-  # @param text [String] error text
-  # @raise [Error]
-  def self.raise_error(res, text)
-    klass = ERROR_CLASS_FOR_RESULT[res.is_a?(Symbol) ? Zint::ERRORS[res] : res]
-    raise klass, text
-  end
-
-  ffi_lib %w[libzint.so.2.10 libzint zint]
-
-  # Error codes (API return values)
-  enum :error_code, [Zint::WARNINGS, Zint::ERRORS].map { |h| h.to_a }.flatten
-
-  # Aliases for better method signatures
-  typedef :pointer, :zint_symbol
-  typedef :pointer, :filename
-  typedef :int32, :length
-  typedef :int32, :rotate_angle
-  typedef :int32, :symbol_id
-  typedef :uint32, :cap_flag
-  typedef :string, :source
-
-  # Create and initialize a symbol structure
-  attach_function(:ZBarcode_Create, :ZBarcode_Create, [], :zint_symbol)
-
-  # Free any output buffers that may have been created and initialize output fields
-  attach_function(:ZBarcode_Clear, :ZBarcode_Clear, [:zint_symbol], :void)
-
-  # Free a symbol structure, including any output buffers
-  attach_function(:ZBarcode_Delete, :ZBarcode_Delete, [:zint_symbol], :void)
-
-  # Encode a barcode. If `length` is 0, `source` must be NUL-terminated.
-  attach_function(:ZBarcode_Encode, :ZBarcode_Encode, [:zint_symbol, :source, :length], :error_code)
-
-  # Encode a barcode using input data from file `filename`
-  attach_function(:ZBarcode_Encode_File, :ZBarcode_Encode_File, [:zint_symbol, :filename], :error_code)
-
-  # Output a previously encoded symbol to file `symbol->outfile`
-  attach_function(:ZBarcode_Print, :ZBarcode_Print, [:zint_symbol, :rotate_angle], :error_code)
-
-  # Encode and output a symbol to file `symbol->outfile`
-  attach_function(:ZBarcode_Encode_and_Print, :ZBarcode_Encode_and_Print, [:zint_symbol, :source, :length, :rotate_angle], :error_code)
-
-  # Encode a symbol using input data from file `filename` and output to file `symbol->outfile`
-  attach_function(:ZBarcode_Encode_File_and_Print, :ZBarcode_Encode_File_and_Print, [:zint_symbol, :filename, :rotate_angle], :error_code)
-
-  # Output a previously encoded symbol to memory as raster (`symbol->bitmap`)
-  attach_function(:ZBarcode_Buffer, :ZBarcode_Buffer, [:zint_symbol, :rotate_angle], :error_code)
-
-  # Encode and output a symbol to memory as raster (`symbol->bitmap`)
-  attach_function(:ZBarcode_Encode_and_Buffer, :ZBarcode_Encode_and_Buffer, [:zint_symbol, :source, :length, :rotate_angle], :error_code)
-
-  # Encode a symbol using input data from file `filename` and output to memory as raster (`symbol->bitmap`)
-  attach_function(:ZBarcode_Encode_File_and_Buffer, :ZBarcode_Encode_File_and_Buffer, [:zint_symbol, :filename, :rotate_angle], :error_code)
-
-  # Output a previously encoded symbol to memory as vector (`symbol->vector`)
-  attach_function(:ZBarcode_Buffer_Vector, :ZBarcode_Buffer_Vector, [:zint_symbol, :rotate_angle], :error_code)
-
-  # Encode and output a symbol to memory as vector (`symbol->vector`)
-  attach_function(:ZBarcode_Encode_and_Buffer_Vector, :ZBarcode_Encode_and_Buffer_Vector, [:zint_symbol, :source, :length, :rotate_angle], :error_code)
-
-  # Encode a symbol using input data from file `filename` and output to memory as vector (`symbol->vector`)
-  attach_function(:ZBarcode_Encode_File_and_Buffer_Vector, :ZBarcode_Encode_File_and_Buffer_Vector, [:zint_symbol, :filename, :rotate_angle], :error_code)
-
-  # Is `symbol_id` a recognized symbology?
-  attach_function(:ZBarcode_ValidID, :ZBarcode_ValidID, [:symbol_id], :bool)
-
-  # Return the capability flags for symbology `symbol_id` that match `cap_flag`
-  attach_function(:ZBarcode_Cap, :ZBarcode_Cap, [:symbol_id, :cap_flag], :uint32)
-
-  # Return the version of Zint linked to
-  attach_function(:ZBarcode_Version, :ZBarcode_Version, [], :int32)
-
   # Returns library version of the current zint
   #
   # @return [Integer] library version
   def self.library_version
-    Zint.ZBarcode_Version
+    Native.ZBarcode_Version
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-zint
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Elias Fröhner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -24,20 +24,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: mini_portile2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: 
 email:
 - apiwalker96@gmail.com
 executables: []
-extensions: []
+extensions:
+- ext/ruby-zint/extconf.rb
 extra_rdoc_files: []
 files:
 - ".rspec"
 - ".standard.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- ext/ruby-zint/extconf.rb
 - lib/ruby-zint.rb
 - lib/zint.rb
 - lib/zint/aus_post.rb
@@ -86,6 +101,7 @@ files:
 - lib/zint/dbaromn.rb
 - lib/zint/dbaromnstk.rb
 - lib/zint/dbarstk.rb
+- lib/zint/dependencies.rb
 - lib/zint/dot_code.rb
 - lib/zint/dotty_mode.rb
 - lib/zint/dpd.rb
@@ -120,6 +136,7 @@ files:
 - lib/zint/micro_pdf417.rb
 - lib/zint/micro_qr.rb
 - lib/zint/msiplessey.rb
+- lib/zint/native.rb
 - lib/zint/noascii.rb
 - lib/zint/nve18.rb
 - lib/zint/one_code.rb
@@ -141,11 +158,11 @@ files:
 - lib/zint/rssexpstack.rb
 - lib/zint/rssltd.rb
 - lib/zint/stdout.rb
-- lib/zint/structs/circle.rb
-- lib/zint/structs/hexagon.rb
-- lib/zint/structs/rect.rb
 - lib/zint/structs/symbol.rb
 - lib/zint/structs/vector.rb
+- lib/zint/structs/vector_circle.rb
+- lib/zint/structs/vector_hexagon.rb
+- lib/zint/structs/vector_rect.rb
 - lib/zint/structs/vector_string.rb
 - lib/zint/telepen.rb
 - lib/zint/telepennum.rb
@@ -158,12 +175,15 @@ files:
 - lib/zint/uspsimail.rb
 - lib/zint/version.rb
 - lib/zint/vin.rb
+- lib/zint/zint_recipe.rb
+- ports/archives/zint-2.10.0-src.tar.gz
 homepage: https://github.com/api-walker/ruby-zint
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/api-walker/ruby-zint
   source_code_uri: https://github.com/api-walker/ruby-zint
+  msys2_mingw_dependencies: cmake libpng
 post_install_message: 
 rdoc_options: []
 require_paths:

data/Gemfile.lock

@@ -1,79 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ruby-zint (1.0.0)
-      ffi (~> 1.15)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    byebug (11.1.3)
-    chunky_png (1.4.0)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    ffi (1.15.5)
-    json (2.6.3)
-    language_server-protocol (3.17.0.3)
-    parallel (1.22.1)
-    parser (3.2.1.1)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.48.1)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.16.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.13.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    standard (1.25.3)
-      language_server-protocol (~> 3.17.0.2)
-      rubocop (~> 1.48.1)
-      rubocop-performance (~> 1.16.0)
-    unicode-display_width (2.4.2)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  byebug
-  chunky_png
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  ruby-zint!
-  simplecov
-  standard (~> 1.3)
-
-BUNDLED WITH
-   2.4.8

data/lib/zint/structs/circle.rb

@@ -1,11 +0,0 @@
-module Zint
-  module Structs
-    class Circle < FFI::Struct
-      layout :x, :float,
-        :y, :float,
-        :diameter, :float,
-        :colour, :int,
-        :next, :pointer
-    end
-  end
-end

data/lib/zint/structs/hexagon.rb

@@ -1,11 +0,0 @@
-module Zint
-  module Structs
-    class Hexagon < FFI::Struct
-      layout :x, :float,
-        :y, :float,
-        :diameter, :float,
-        :rotation, :int,
-        :next, :pointer
-    end
-  end
-end