Class: DL::CStructEntity

Inherits:
Object
  • Object
show all
Includes:
PackInfo, ValueUtil
Defined in:
lib/dl/struct.rb

Overview

A C struct wrapper

Direct Known Subclasses

CUnionEntity

Constant Summary

Constants included from PackInfo

PackInfo::ALIGN_MAP, PackInfo::PACK_MAP, PackInfo::SIZE_MAP

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ValueUtil

#signed_value, #unsigned_value, #wrap_arg, #wrap_args

Methods included from PackInfo

align

Constructor Details

#initialize(addr, types, func = nil) ⇒ CStructEntity

Wraps the C pointer addr as a C struct with the given types. The C function func is called when the instance is garbage collected.

See also DL::CPtr.new



115
116
117
118
 
# File 'lib/dl/struct.rb', line 115

def initialize(addr, types, func = nil)
  set_ctypes(types)
  super(addr, @size, func)
end

Class Method Details

.malloc(types, func = nil) ⇒ Object

Allocates a C struct the types provided. The C function func is called when the instance is garbage collected.



85
86
87
88
 
# File 'lib/dl/struct.rb', line 85

def CStructEntity.malloc(types, func = nil)
  addr = DL.malloc(CStructEntity.size(types))
  CStructEntity.new(addr, types, func)
end

.size(types) ⇒ Object

Given types, returns the offset for the packed sizes of those types

DL::CStructEntity.size([DL::TYPE_DOUBLE, DL::TYPE_INT, DL::TYPE_CHAR,
                        DL::TYPE_VOIDP])
=> 24



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/dl/struct.rb', line 95

def CStructEntity.size(types)
  offset = 0

  max_align = types.map { |type, count = 1|
    last_offset = offset

    align = PackInfo::ALIGN_MAP[type]
    offset = PackInfo.align(last_offset, align) +
             (PackInfo::SIZE_MAP[type] * count)

    align
  }.max

  PackInfo.align(offset, max_align)
end

Instance Method Details

#[](name) ⇒ Object

Fetch struct member name



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/dl/struct.rb', line 148

def [](name)
  idx = @members.index(name)
  if( idx.nil? )
    raise(ArgumentError, "no such member: #{name}")
  end
  ty = @ctypes[idx]
  if( ty.is_a?(Array) )
    r = super(@offset[idx], SIZE_MAP[ty[0]] * ty[1])
  else
    r = super(@offset[idx], SIZE_MAP[ty.abs])
  end
  packer = Packer.new([ty])
  val = packer.unpack([r])
  case ty
  when Array
    case ty[0]
    when TYPE_VOIDP
      val = val.collect{|v| CPtr.new(v)}
    end
  when TYPE_VOIDP
    val = CPtr.new(val[0])
  else
    val = val[0]
  end
  if( ty.is_a?(Integer) && (ty < 0) )
    return unsigned_value(val, ty)
  elsif( ty.is_a?(Array) && (ty[0] < 0) )
    return val.collect{|v| unsigned_value(v,ty[0])}
  else
    return val
  end
end

#[]=(name, val) ⇒ Object

Set struct member name, to value val



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/dl/struct.rb', line 182

def []=(name, val)
  idx = @members.index(name)
  if( idx.nil? )
    raise(ArgumentError, "no such member: #{name}")
  end
  ty  = @ctypes[idx]
  packer = Packer.new([ty])
  val = wrap_arg(val, ty, [])
  buff = packer.pack([val].flatten())
  super(@offset[idx], buff.size, buff)
  if( ty.is_a?(Integer) && (ty < 0) )
    return unsigned_value(val, ty)
  elsif( ty.is_a?(Array) && (ty[0] < 0) )
    return val.collect{|v| unsigned_value(v,ty[0])}
  else
    return val
  end
end

#assign_names(members) ⇒ Object

Set the names of the members in this C struct



121
122
123
 
# File 'lib/dl/struct.rb', line 121

def assign_names(members)
  @members = members
end

#set_ctypes(types) ⇒ Object

Given types, calculate the offsets and sizes for the types in the struct.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/dl/struct.rb', line 127

def set_ctypes(types)
  @ctypes = types
  @offset = []
  offset = 0

  max_align = types.map { |type, count = 1|
    orig_offset = offset
    align = ALIGN_MAP[type]
    offset = PackInfo.align(orig_offset, align)

    @offset << offset

    offset += (SIZE_MAP[type] * count)

    align
  }.max

  @size = PackInfo.align(offset, max_align)
end

#to_s ⇒ Object

:nodoc:



201
202
203
 
# File 'lib/dl/struct.rb', line 201

def to_s() # :nodoc:
  super(@size)
end