Class: BitStruct::TextField

Inherits:
Field
  • Object
show all
Defined in:
lib/bit-struct/text-field.rb

Overview

Class for null-terminated printable text strings. Declared with BitStruct.text.

Instance Attribute Summary

Attributes inherited from Field

#default, #display_name, #format, #length, #name, #offset, #options

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Field

#class_name, default, #describe, #initialize, #inspect_in_object, #inspectable?

Constructor Details

This class inherits a constructor from BitStruct::Field

Class Method Details

.class_name ⇒ Object

Used in describe.



6
7
8
 
# File 'lib/bit-struct/text-field.rb', line 6

def self.class_name
  @class_name ||= "text"
end

Instance Method Details

#add_accessors_to(cl, attr = name) ⇒ Object

:nodoc:



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/bit-struct/text-field.rb', line 10

def add_accessors_to(cl, attr = name) # :nodoc:
  unless offset % 8 == 0
    raise ArgumentError,
      "Bad offset, #{offset}, for #{self.class} #{name}." +
      " Must be multiple of 8."
  end
  
  unless length % 8 == 0
    raise ArgumentError,
      "Bad length, #{length}, for #{self.class} #{name}." +
      " Must be multiple of 8."
  end
  
  offset_byte = offset / 8
  length_byte = length / 8
  last_byte = offset_byte + length_byte - 1
  byte_range = offset_byte..last_byte
  val_byte_range = 0..length_byte-1

  cl.class_eval do
    define_method attr do ||
      self[byte_range].sub(/\0*$/, "").to_s
    end

    define_method "#{attr}=" do |val|
      val = val.to_s
      if val.length < length_byte
        val += "\0" * (length_byte - val.length)
      end
      self[byte_range] = val[val_byte_range]
    end
  end
end