Class: BinData::Struct

Inherits:
Base
  • Object
show all
Defined in:
lib/bindata/struct.rb

Overview

A Struct is an ordered collection of named data objects.

require 'bindata'

class Tuple < BinData::Record
  int8  :x
  int8  :y
  int8  :z
end

obj = BinData::Struct.new(:hide => :a,
                          :fields => [ [:int32le, :a],
                                       [:int16le, :b],
                                       [:tuple, :s] ])
obj.field_names   =># ["b", "s"]

Parameters

Parameters may be provided at initialisation to control the behaviour of an object. These params are:

:fields

An array specifying the fields for this struct. Each element of the array is of the form [type, name, params]. Type is a symbol representing a registered type. Name is the name of this field. Params is an optional hash of parameters to pass to this field when instantiating it. If name is “” or nil, then that field is anonymous and behaves as a hidden field.

:hide

A list of the names of fields that are to be hidden from the outside world. Hidden fields don’t appear in #snapshot or #field_names but are still accessible by name.

:endian

Either :little or :big. This specifies the default endian of any numerics in this struct, or in any nested data objects.

Field Parameters

Fields may have have extra parameters as listed below:

:onlyif

Used to indicate a data object is optional. if false, this object will not be included in any calls to #read, #write, #num_bytes or #snapshot.

Direct Known Subclasses

Record

Defined Under Namespace

Classes: Snapshot

Constant Summary collapse

RESERVED =

These reserved words may not be used as field names

Hash[*
                 (::Hash.instance_methods.collect { |meth| meth.to_s } + 
%w{alias and begin break case class def defined do else elsif
   end ensure false for if in module next nil not or redo
   rescue retry return self super then true undef unless until
   when while yield} +
%w{array element index value} ).
uniq.collect { |key| [key, true]

Instance Attribute Summary

Attributes inherited from Base

#parent

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#==, #assign, #debug_name, #eval_parameter, #get_parameter, #has_parameter?, #inspect, #num_bytes, #offset, #pretty_print, #read, read, register, register_class, register_self, register_subclasses, #rel_offset, #snapshot, #to_binary_s, #to_s, #write

Methods included from AcceptedParametersMixin

included

Constructor Details

#initialize(parameters = {}, parent = nil) ⇒ Struct

Returns a new instance of Struct.



145
146
147
148
149
150
 
# File 'lib/bindata/struct.rb', line 145

def initialize(parameters = {}, parent = nil)
  super

  @field_names = get_parameter(:fields).field_names
  @field_objs  = []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(symbol, *args, &block) ⇒ Object

:nodoc:



176
177
178
179
180
181
182
183
 
# File 'lib/bindata/struct.rb', line 176

def method_missing(symbol, *args, &block) #:nodoc:
  obj = find_obj_for_name(symbol)
  if obj
    invoke_field(obj, symbol, args)
  else
    super
  end
end

Class Method Details

.sanitize_parameters!(params, sanitizer) ⇒ Object

:nodoc:



79
80
81
82
83
 
# File 'lib/bindata/struct.rb', line 79

def sanitize_parameters!(params, sanitizer) #:nodoc:
  sanitize_endian(params, sanitizer)
  sanitize_fields(params, sanitizer)
  sanitize_hide(params, sanitizer)
end

Instance Method Details

#clear ⇒ Object

:nodoc:



152
153
154
 
# File 'lib/bindata/struct.rb', line 152

def clear #:nodoc:
  @field_objs.each { |f| f.clear unless f.nil? }
end

#clear? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


156
157
158
 
# File 'lib/bindata/struct.rb', line 156

def clear? #:nodoc:
  @field_objs.all? { |f| f.nil? or f.clear? }
end

#debug_name_of(child) ⇒ Object

:nodoc:



185
186
187
188
 
# File 'lib/bindata/struct.rb', line 185

def debug_name_of(child) #:nodoc:
  field_name = @field_names[find_index_of(child)]
  "#{debug_name}.#{field_name}"
end

#field_names(include_hidden = false) ⇒ Object

Returns a list of the names of all fields accessible through this object. include_hidden specifies whether to include hidden names in the listing.



163
164
165
166
167
168
169
170
 
# File 'lib/bindata/struct.rb', line 163

def field_names(include_hidden = false)
  if include_hidden
    @field_names.compact
  else
    hidden = get_parameter(:hide) || []
    @field_names.compact - hidden
  end
end

#offset_of(child) ⇒ Object

:nodoc:



190
191
192
193
194
 
# File 'lib/bindata/struct.rb', line 190

def offset_of(child) #:nodoc:
  instantiate_all_objs
  sum = sum_num_bytes_below_index(find_index_of(child))
  child.do_num_bytes.is_a?(Integer) ? sum.ceil : sum.floor
end

#respond_to?(symbol, include_private = false) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/bindata/struct.rb', line 172

def respond_to?(symbol, include_private = false) #:nodoc:
  field_names(true).include?(symbol.to_s.chomp("=")) || super
end