digest-crc 0.6.4 → 0.7.0

data/lib/digest/crc.rb

@@ -17,6 +17,9 @@ module Digest
     # The bit width of the CRC checksum
     WIDTH = 0
 
+    # Define true or false whether the input direction is bit reversed or not of the CRC checksum
+    REFLECT_INPUT = nil
+
     # Default place holder CRC table
     TABLE = [].freeze
 
@@ -45,20 +48,46 @@ module Digest
     # @return [String]
     #   The packed CRC checksum.
     #
-    # @abstract
-    #
     def self.pack(crc)
-      raise(NotImplementedError,"#{self.class}##{__method__} not implemented")
+      unless (width = self::WIDTH) > 0
+        raise(NotImplementedError, "#{self} is incompleted as CRC")
+      end
+
+      bitclass   = width + (-width & 0x07)
+      byte_count = bitclass / 8
+
+      crc &= ~(-1 << width)
+
+      result = [crc].pack("Q>")
+      result[0, result.bytesize - byte_count] = ""
+      result
+    end
+
+    #
+    # Determines whether the library is using the optimized C extensions
+    # implementation, or the pure-Ruby implementation.
+    #
+    # @return [:c_ext, :pure]
+    #
+    # @since 0.7.0
+    #
+    def self.implementation
+      if instance_method(:update).source_location.nil?
+        :c_ext
+      else
+        :pure
+      end
     end
 
     #
     # Initializes the CRC checksum.
     #
     def initialize
-      @init_crc = self.class.const_get(:INIT_CRC)
-      @xor_mask = self.class.const_get(:XOR_MASK)
-      @width    = self.class.const_get(:WIDTH)
-      @table    = self.class.const_get(:TABLE)
+      @init_crc      = self.class.const_get(:INIT_CRC)
+      @xor_mask      = self.class.const_get(:XOR_MASK)
+      @width         = self.class.const_get(:WIDTH)
+      @reflect_input = self.class.const_get(:REFLECT_INPUT)
+      @table         = self.class.const_get(:TABLE)
 
       reset
     end
@@ -88,10 +117,57 @@ module Digest
     # @param [String] data
     #   The data to update the CRC checksum with.
     #
-    # @abstract
+    # @raise [NotImplementedError]
+    #   If WIDTH, TABLE, or REFLECT_INPUT constants are not set properly.
     #
     def update(data)
-      raise(NotImplementedError,"#{self.class}##{__method__} not implemented")
+      unless @width >= 1
+        raise(NotImplementedError, "incompleted #{self.class} as CRC (expected WIDTH to be 1 or more)")
+      end
+
+      if @table.empty?
+        raise(NotImplementedError, "incompleted #{self.class} as CRC (expected TABLE to be not empty)")
+      end
+
+      if @reflect_input.nil?
+        raise(NotImplementedError, "incompleted #{self.class} as CRC (expected REFLECT_INPUT to be not nil)")
+      end
+
+      table = @table
+      crc   = @crc
+
+      if @reflect_input
+        if @width > 8
+          data.each_byte do |b|
+            crc = table[b ^ (0xff & crc)] ^ (crc >> 8)
+          end
+        else
+          data.each_byte do |b|
+            # Omit (crc >> 8) since bits upper than the lower 8 bits are always 0
+            crc = table[b ^ (0xff & crc)]
+          end
+        end
+      else
+        if @width > 8
+          higher_bit_off = @width - 8
+          remain_mask    = ~(-1 << higher_bit_off)
+
+          data.each_byte do |b|
+            crc = table[b ^ (0xff & (crc >> higher_bit_off))] ^ ((remain_mask & crc) << 8)
+          end
+        else
+          padding = 8 - @width
+
+          data.each_byte do |b|
+            # Omit (crc << 8) since bits lower than the upper 8 bits are always 0
+            crc = table[b ^ (0xff & (crc << padding))]
+          end
+        end
+      end
+
+      @crc = crc
+
+      self
     end
 
     #

data/lib/digest/crc1.rb

@@ -6,6 +6,8 @@ module Digest
   #
   class CRC1 < CRC
 
+    WIDTH = 1
+
     #
     # Packs the CRC1 checksum.
     #

data/lib/digest/crc15.rb

@@ -10,6 +10,8 @@ module Digest
 
     WIDTH = 15
 
+    REFLECT_INPUT = false
+
     # Generated by `./pycrc.py --algorithm=table-driven --model=crc-16 --generate=c`
     TABLE = [
       0x0000, 0x4599, 0x4eab, 0x0b32, 0x58cf, 0x1d56, 0x1664, 0x53fd, 0x7407, 0x319e, 0x3aac, 0x7f35, 0x2cc8, 0x6951, 0x6263, 0x27fa,
@@ -30,38 +32,6 @@ module Digest
       0x276f, 0x62f6, 0x69c4, 0x2c5d, 0x7fa0, 0x3a39, 0x310b, 0x7492, 0x5368, 0x16f1, 0x1dc3, 0x585a, 0x0ba7, 0x4e3e, 0x450c, 0x0095
     ].freeze
 
-    #
-    # Packs the CRC15 checksum.
-    #
-    # @param [Integer] crc
-    #   The CRC15 checksum to pack.
-    #
-    # @return [String]
-    #   The packed CRC15 checksum.
-    #
-    def self.pack(crc)
-      buffer = ''
-
-      buffer << ((crc & 0x7f00) >> 8).chr
-      buffer << (crc & 0xff).chr
-
-      buffer
-    end
-
-    #
-    # Updates the CRC15 checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = (@table[((@crc >> 7) ^ b) & 0xff] ^ (@crc << 8)) & 0x7fff
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc16.rb

@@ -8,6 +8,8 @@ module Digest
 
     WIDTH = 16
 
+    REFLECT_INPUT = true
+
     INIT_CRC = 0x0000
 
     # Generated by `./pycrc.py --algorithm=table-driven --model=crc-16`
@@ -46,38 +48,6 @@ module Digest
       0x8201, 0x42c0, 0x4380, 0x8341, 0x4100, 0x81c1, 0x8081, 0x4040
     ].freeze
 
-    #
-    # Packs the CRC16 checksum.
-    #
-    # @param [Integer] crc
-    #   The CRC16 checksum to pack.
-    #
-    # @return [String]
-    #   The packed CRC16 checksum.
-    #
-    def self.pack(crc)
-      buffer = ''
-
-      buffer << ((crc & 0xff00) >> 8).chr
-      buffer << (crc & 0xff).chr
-
-      buffer
-    end
-
-    #
-    # Updates the CRC16 checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = ((@table[(@crc ^ b) & 0xff] ^ (@crc >> 8)) & 0xffff)
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc16_ccitt.rb

@@ -6,6 +6,8 @@ module Digest
   #
   class CRC16CCITT < CRC16
 
+    REFLECT_INPUT = false
+
     INIT_CRC = 0xffff
 
     # Generated by `./pycrc.py --algorithm=table-driven --model=crc-16-ccitt --generate=c`
@@ -44,20 +46,6 @@ module Digest
       0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
     ].freeze
 
-    #
-    # Updates the CRC16 CCITT checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = ((@table[((@crc >> 8) ^ b) & 0xff] ^ (@crc << 8)) & 0xffff)
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc16_dnp.rb

@@ -6,6 +6,8 @@ module Digest
   #
   class CRC16DNP < CRC16
 
+    REFLECT_INPUT = true
+
     INIT_CRC = 0
 
     TABLE = [
@@ -43,20 +45,6 @@ module Digest
       0x91af,  0xa7f1,  0xfd13,  0xcb4d,  0x48d7,  0x7e89,  0x246b,  0x1235
     ].freeze
 
-    #
-    # Updates the CRC16 DNP checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = ((@crc >> 8) ^ @table[(@crc ^ b) & 0xff])
-      end
-
-      return self
-    end
-
     def finish
       self.class.pack(~@crc)
     end

data/lib/digest/crc16_genibus.rb

@@ -8,6 +8,8 @@ module Digest
   #
   class CRC16Genibus < CRC16
 
+    REFLECT_INPUT = false
+
     INIT_XOR = 0xffff
 
     INIT_CRC = 0x0000 ^ INIT_XOR
@@ -50,20 +52,6 @@ module Digest
       0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
     ].freeze
 
-    #
-    # Updates the CRC16 Genibus checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = (@table[((@crc >> 8) ^ b) & 0xff] ^ (@crc << 8)) & 0xffff
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc16_kermit.rb

@@ -8,6 +8,8 @@ module Digest
   #
   class CRC16Kermit < CRC16
 
+    REFLECT_INPUT = true
+
     # Generated by `./pycrc.py --algorithm=table-driven --model=kermit --generate=c`
     TABLE = [
       0x0000, 0x1189, 0x2312, 0x329b, 0x4624, 0x57ad, 0x6536, 0x74bf,
@@ -44,20 +46,6 @@ module Digest
       0x7bc7, 0x6a4e, 0x58d5, 0x495c, 0x3de3, 0x2c6a, 0x1ef1, 0x0f78
     ].freeze
 
-    #
-    # Updates the CRC16 Kermit checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = (@table[(@crc ^ b) & 0xff] ^ (@crc >> 8)) & 0xffff
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc16_x_25.rb

@@ -6,6 +6,8 @@ module Digest
   #
   class CRC16X25 < CRC16
 
+    REFLECT_INPUT = true
+
     INIT_XOR = 0xffff
 
     INIT_CRC = 0x0 ^ INIT_XOR
@@ -47,7 +49,7 @@ module Digest
       0xf78f, 0xe606, 0xd49d, 0xc514, 0xb1ab, 0xa022, 0x92b9, 0x8330,
       0x7bc7, 0x6a4e, 0x58d5, 0x495c, 0x3de3, 0x2c6a, 0x1ef1, 0x0f78
     ].freeze
-    
+
   end
 end
 

data/lib/digest/crc16_xmodem.rb

@@ -6,6 +6,8 @@ module Digest
   #
   class CRC16XModem < CRC16
 
+    REFLECT_INPUT = false
+
     # Generated by `./pycrc.py --algorithm=table-driven --model=xmodem --generate=c`
     TABLE = [
       0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
@@ -42,20 +44,6 @@ module Digest
       0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
     ].freeze
 
-    #
-    # Updates the CRC16 XModem checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = ((@table[((@crc >> 8) ^ b) & 0xff] ^ (@crc << 8)) & 0xffff)
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc16_zmodem.rb

@@ -6,6 +6,8 @@ module Digest
   #
   class CRC16ZModem < CRC16
 
+    REFLECT_INPUT = false
+
     # Generated by `./pycrc.py --algorithm=table-driven --model=zmodem --generate=c`
     TABLE = [
       0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
@@ -42,20 +44,6 @@ module Digest
       0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
     ].freeze
 
-    #
-    # Updates the CRC16 checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = ((@table[((@crc >> 8) ^ b) & 0xff] ^ (@crc << 8)) & 0xffff)
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc24.rb

@@ -8,6 +8,8 @@ module Digest
 
     WIDTH = 24
 
+    REFLECT_INPUT = false
+
     INIT_CRC = 0xb704ce
 
     # Generated by `./pycrc.py --algorithm=table-drive --model=crc24 --generate=c`
@@ -46,39 +48,6 @@ module Digest
       0x42fa2f, 0xc4b6d4, 0xc82f22, 0x4e63d9, 0xd11cce, 0x575035, 0x5bc9c3, 0xdd8538
     ].freeze
 
-    #
-    # Packs the CRC24 checksum.
-    #
-    # @param [Integer] crc
-    #   The checksum to pack.
-    #
-    # @return [String]
-    #   The packed checksum.
-    #
-    def self.pack(crc)
-      buffer = ''
-
-      buffer << ((crc & 0xff0000) >> 16).chr
-      buffer << ((crc & 0x00ff00) >> 8).chr
-      buffer << (crc & 0x0000ff).chr
-
-      buffer
-    end
-
-    #
-    # Updates the CRC24 checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = ((@table[((@crc >> 16) ^ b) & 0xff] ^ (@crc << 8)) & 0xffffff)
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc32.rb

@@ -8,6 +8,8 @@ module Digest
 
     WIDTH = 32
 
+    REFLECT_INPUT = true
+
     INIT_CRC = 0xffffffff
 
     XOR_MASK = 0xffffffff
@@ -80,40 +82,6 @@ module Digest
       0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
     ].freeze
 
-    #
-    # Packs the CRC32 checksum.
-    #
-    # @param [Integer] crc
-    #   The checksum to pack.
-    #
-    # @return [String]
-    #   The packed checksum.
-    #
-    def self.pack(crc)
-      buffer = ''
-
-      buffer << ((crc & 0xff000000) >> 24).chr
-      buffer << ((crc & 0xff0000) >> 16).chr
-      buffer << ((crc & 0xff00) >> 8).chr
-      buffer << (crc & 0xff).chr
-
-      buffer
-    end
-
-    #
-    # Updates the CRC32 checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = @table[(@crc ^ b) & 0xff] ^ ((@crc >> 8) & 0xffffffff)
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc32_bzip2.rb

@@ -6,6 +6,8 @@ module Digest
   #
   class CRC32BZip2 < CRC32
 
+    REFLECT_INPUT = false
+
     # Generated by `./pycrc.py --algorithm=table-driven --model=crc-32-bzip2 --generate=c`
     TABLE = [
       0x00000000, 0x04c11db7, 0x09823b6e, 0x0d4326d9, 0x130476dc, 0x17c56b6b, 0x1a864db2, 0x1e475005,
@@ -42,20 +44,6 @@ module Digest
       0xafb010b1, 0xab710d06, 0xa6322bdf, 0xa2f33668, 0xbcb4666d, 0xb8757bda, 0xb5365d03, 0xb1f740b4
     ].freeze
 
-    #
-    # Updates the CRC32 BZip2 checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = (@table[((@crc >> 24) ^ b) & 0xff] ^ (@crc << 8)) & 0xffffffff
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc32_mpeg.rb

@@ -6,6 +6,8 @@ module Digest
   #
   class CRC32MPEG < CRC32
 
+    REFLECT_INPUT = false
+
     XOR_MASK = 0x00000000
 
     # Generated by `./pycrc.py --algorithm=table-driven --model=crc-32-mpeg --generate=c`
@@ -76,20 +78,6 @@ module Digest
       0xbcb4666d, 0xb8757bda, 0xb5365d03, 0xb1f740b4
     ].freeze
 
-    #
-    # Updates the CRC32 Mpeg checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = ((@table[((@crc >> 24) ^ b) & 0xff] ^ (@crc << 8)) & 0xffffffff)
-      end
-
-      return self
-    end
-
   end
 
   # @deprecated Please use {CRC32MPEG}.

data/lib/digest/crc32_posix.rb

@@ -6,6 +6,8 @@ module Digest
   #
   class CRC32POSIX < CRC32
 
+    REFLECT_INPUT = false
+
     INIT_CRC = 0x00000000
 
     TABLE = [
@@ -43,20 +45,6 @@ module Digest
     0xafb010b1, 0xab710d06, 0xa6322bdf, 0xa2f33668, 0xbcb4666d, 0xb8757bda, 0xb5365d03, 0xb1f740b4
     ].freeze
 
-    #
-    # Updates the CRC32 POSIX checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = (@table[((@crc >> 24) ^ b) & 0xff] ^ (@crc << 8)) & 0xffffffff
-      end
-
-      return self
-    end
-
   end
 end
 

data/lib/digest/crc32_xfer.rb

@@ -6,6 +6,8 @@ module Digest
   #
   class CRC32XFER < CRC32
 
+    REFLECT_INPUT = false
+
     INIT_CRC = 0x00000000
 
     XOR_MASK = 0x00000000
@@ -46,20 +48,6 @@ module Digest
       0x00006628, 0x00006687, 0x00006776, 0x000067d9, 0x00006494, 0x0000643b, 0x000065ca, 0x00006565
     ].freeze
 
-    #
-    # Updates the CRC32 XFER checksum.
-    #
-    # @param [String] data
-    #   The data to update the checksum with.
-    #
-    def update(data)
-      data.each_byte do |b|
-        @crc = (@table[((@crc >> 24) ^ b) & 0xff] ^ (@crc << 8)) & 0xffffffff
-      end
-
-      return self
-    end
-
   end
 end