ruby-zint 1.0.0 → 1.2.0

data/lib/zint/pdf417trunc.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Legacy
   class Pdf417trunc < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_PDF417TRUNC, options: options)

data/lib/zint/pharma.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Pharmacode One-Track
   class Pharma < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_PHARMA, options: options)

data/lib/zint/pharmatwo.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Pharmacode Two-Track
   class PharmaTwo < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_PHARMA_TWO, options: options)

data/lib/zint/planet.rb

@@ -1,4 +1,5 @@
 module Zint
+  # USPS PLANET
   class Planet < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_PLANET, options: options)

data/lib/zint/plessey.rb

@@ -1,4 +1,5 @@
 module Zint
+  # UK Plessey
   class Plessey < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_PLESSEY, options: options)

data/lib/zint/postnet.rb

@@ -1,4 +1,5 @@
 module Zint
+  # USPS (U.S. Postal Service) POSTNET
   class Postnet < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_POSTNET, options: options)

data/lib/zint/pzn.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Pharmazentralnummer
   class Pzn < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_PZN, options: options)

data/lib/zint/qr.rb

@@ -1,4 +1,5 @@
 module Zint
+  # QR Code
   class Qr < Barcode
     # ECC Levels
     ECC_LEVEL_L = 1

data/lib/zint/rmqr.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Rectangular Micro QR Code (rMQR)
   class Rmqr < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_RMQR, options: options)

data/lib/zint/rss14.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Legacy
   class Rss14 < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_RSS14, options: options)

data/lib/zint/rss14stack.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Legacy
   class Rss14stack < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_RSS14STACK, options: options)

data/lib/zint/rss14stackomni.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Legacy
   class Rss14stackOmni < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_RSS14STACK_OMNI, options: options)

data/lib/zint/rssexp.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Legacy
   class RssExp < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_RSS_EXP, options: options)

data/lib/zint/rssexpstack.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Legacy
   class RssExpstack < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_RSS_EXPSTACK, options: options)

data/lib/zint/rssltd.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Legacy
   class RssLtd < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_RSS_LTD, options: options)

data/lib/zint/structs/structapp.rb

@@ -0,0 +1,25 @@
+module Zint
+  module Structs
+    #  Structured Append info - ignored unless `zint_structapp.count` is set to non-zero value
+    class Structapp < FFI::Struct
+      layout :index, :int, # Position in Structured Append sequence, 1-based. Must be <= `count`
+        :count, :int, # Number of symbols in Structured Append sequence. Set >= 2 to add SA Info
+        :id, [:char, 32] # Optional ID to distinguish sequence, ASCII, NUL-terminated unless max 32 long
+
+      # Position in Structured Append sequence, 1-based. Must be <= `count`
+      def index
+        self[:index]
+      end
+
+      # Number of symbols in Structured Append sequence. Set >= 2 to add SA Info
+      def count
+        self[:count]
+      end
+
+      # Optional ID to distinguish sequence, ASCII, NUL-terminated unless max 32 long
+      def id
+        self[:id]
+      end
+    end
+  end
+end

data/lib/zint/structs/symbol.rb

@@ -1,41 +1,49 @@
 module Zint
   module Structs
-    class Symbol < FFI::Struct
-      layout :symbology, :int,
-        :height, :float,
-        :whitespace_width, :int,
-        :whitespace_height, :int,
-        :border_width, :int,
-        :output_options, :int,
-        :fgcolour, [:char, 10],
-        :bgcolour, [:char, 10],
-        :fgcolor, :pointer,
-        :bgcolor, :pointer,
-        :outfile, [:char, 256],
-        :scale, :float,
-        :option_1, :int,
-        :option_2, :int,
-        :option_3, :int,
-        :show_hrt, :int,
-        :fontsize, :int,
-        :input_mode, :int,
-        :eci, :int,
-        :text, [:uchar, 128],
-        :rows, :int,
-        :width, :int,
-        :primary, [:char, 128],
-        :encoded_data, [:uchar, 200 * 143],
-        :row_height, [:float, 200],
-        :errtxt, [:char, 100],
-        :bitmap, :pointer,
-        :bitmap_width, :int,
-        :bitmap_height, :int,
-        :alphamap, :pointer,
-        :bitmap_byte_length, :uchar,
-        :dot_size, :float,
-        :vector, :pointer,
-        :debug, :int,
-        :warn_level, :int
+    class Symbol < FFI::ManagedStruct
+      layout :symbology, :int, # Symbol to use (see BARCODE_XXX below)
+        :height, :float, # Barcode height in X-dimensions (ignored for fixed-width barcodes)
+        :scale, :float, # Scale factor when printing barcode, i.e. adjusts X-dimension. Default 1
+        :whitespace_width, :int, # Width in X-dimensions of whitespace to left & right of barcode
+        :whitespace_height, :int, # Height in X-dimensions of whitespace above & below the barcode
+        :border_width, :int, # Size of border in X-dimensions
+        :output_options, :int, # Various output parameters (bind, box etc, see below)
+        :fgcolour, [:char, 10], # Foreground as RGB/RGBA hexadecimal string, 6 or 8 characters, NUL-terminated
+        :bgcolour, [:char, 10], # Background as RGB/RGBA hexadecimal string, 6 or 8 characters, NUL-terminated
+        :fgcolor, :pointer, # Pointer to fgcolour (alternate spelling)
+        :bgcolor, :pointer, # Pointer to bgcolour (alternate spelling)
+        :outfile, [:char, 256], # Name of file to output to, NUL-terminated. Default "out.png" ("out.gif" if NO_PNG)
+        :primary, [:char, 128], # Primary message data (MaxiCode, Composite), NUL-terminated
+        :option_1, :int, # Symbol-specific options (see "../docs/manual.txt")
+        :option_2, :int, # Symbol-specific options
+        :option_3, :int, # Symbol-specific options
+        :show_hrt, :int, # Show (1) or hide (0) Human Readable Text (HRT). Default 1
+        :fontsize, :int, # Unused
+        :input_mode, :int, # Encoding of input data (see DATA_MODE etc below). Default DATA_MODE
+        :eci, :int, # Extended Channel Interpretation. Default 0 (none)
+        :dpmm, :float, # Resolution of output in dots per mm (BMP/EMF/PCX/PNG/TIF only). Default 0 (none)
+        :dot_size, :float, # Size of dots used in BARCODE_DOTTY_MODE. Default 0.8
+        :guard_descent, :float, # Height in X-dimensions that EAN/UPC guard bars descend. Default 5
+        :structapp, Structapp, # Structured Append info. Default structapp.count 0 (none)
+        :warn_level, :int, # Affects error/warning value returned by Zint API (see WARN_XXX below)
+        :debug, :int, # Debugging flags
+        :text, [:uchar, 128], # Human Readable Text (if any), UTF-8, NUL-terminated (output only)
+        :rows, :int, # Number of rows used by the symbol (output only)
+        :width, :int, # Width of the generated symbol (output only)
+        :encoded_data, [:uchar, 200 * 144], # Encoded data (output only). Allows for rows of 1152 modules
+        :row_height, [:float, 200], # Heights of rows (output only). Allows for 200 row DotCode
+        :errtxt, [:char, 100], # Error message if an error or warning occurs, NUL-terminated (output only)
+        :bitmap, :pointer, # Stored bitmap image (raster output only)
+        :bitmap_width, :int, # Width of bitmap image (raster output only)
+        :bitmap_height, :int, # Height of bitmap image (raster output only)
+        :alphamap, :pointer, # Array of alpha values used (raster output only)
+        :bitmap_byte_length, :uchar, # Size of BMP bitmap data (raster output only)
+        :vector, Vector.by_ref # Pointer to vector header (vector output only)
+
+      # @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,32 @@
+module Zint
+  module Structs
+    class VectorCircle < FFI::Struct
+      layout :x, :float,
+        :y, :float,
+        :diameter, :float, # Circle diameter. Does not include width (if any)
+        :width, :float, # Width of circle perimeter (circumference). 0 for fill (disc)
+        :colour, :int,  # Non-zero for draw with background colour (else draw with foreground 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/telepen.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Telepen Alpha
   class Telepen < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_TELEPEN, options: options)

data/lib/zint/telepennum.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Telepen Numeric
   class TelepenNum < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_TELEPEN_NUM, options: options)

data/lib/zint/ultra.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Ultracode
   class Ultra < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_ULTRA, options: options)

data/lib/zint/upc_a.rb

@@ -1,4 +1,5 @@
 module Zint
+  # UPC-A
   class UpcA < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_UPCA, options: options)

data/lib/zint/upc_a_chk.rb

@@ -1,4 +1,5 @@
 module Zint
+  # UPC-A + Check Digit
   class UpcAChk < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_UPCA_CHK, options: options)

data/lib/zint/upc_e.rb

@@ -1,4 +1,5 @@
 module Zint
+  # UPC-E
   class UpcE < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_UPCE, options: options)

data/lib/zint/upc_e_chk.rb

@@ -1,4 +1,5 @@
 module Zint
+  # UPC-E + Check Digit
   class UpcEChk < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_UPCE_CHK, options: options)

data/lib/zint/upnqr.rb

@@ -1,4 +1,5 @@
 module Zint
+  # UPNQR (Univerzalnega Plačilnega Naloga QR)
   class Upnqr < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_UPNQR, options: options)

data/lib/zint/{bind.rb → upu_s10.rb}

@@ -1,7 +1,8 @@
 module Zint
-  class Bind < Barcode
+  # Universal Postal Union S10
+  class UpuS10 < Barcode
     def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_BIND, options: options)
+      super(value: value, input_file: input_file, type: Zint::BARCODE_UPU_S10, options: options)
     end
   end
 end

data/lib/zint/uspsimail.rb

@@ -1,4 +1,5 @@
 module Zint
+  # USPS Intelligent Mail (OneCode)
   class UspsImail < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_USPS_IMAIL, options: options)

data/lib/zint/version.rb

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

data/lib/zint/vin.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Vehicle Identification Number
   class Vin < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_VIN, options: options)

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