In Files
- fiddle/lib/fiddle/struct.rb
Parent
Methods
Class/Module Index
![[+]](../images/find.png "show/hide quicksearch")
- Fiddle
- Fiddle::BasicTypes
- Fiddle::CParser
- Fiddle::CStruct
- Fiddle::CStructBuilder
- Fiddle::CStructEntity
- Fiddle::CUnion
- Fiddle::CUnionEntity
- Fiddle::Closure
- Fiddle::Closure::BlockCaller
- Fiddle::CompositeHandler
- Fiddle::DLError
- Fiddle::Function
- Fiddle::Handle
- Fiddle::Importer
- Fiddle::Pointer
- Fiddle::Win32Types
- Win32
- Win32::Registry
- Win32::Registry::API
- Win32::Registry::Constants
- Win32::Registry::Error
- Win32::Registry::Error::Kernel32
- Win32::Registry::PredefinedKey
- Win32::Resolv
- Win32::Resolv::Kernel32
Fiddle::CStructEntity
A C struct wrapper
Public Class Methods
Allocates a C struct with the types provided.
When the instance is garbage collected, the C function func is
called.
# File fiddle/lib/fiddle/struct.rb, line 86
def CStructEntity.malloc(types, func = nil)
addr = Fiddle.malloc(CStructEntity.size(types))
CStructEntity.new(addr, types, func)
end
Wraps the C pointer addr as a C struct with the given
types.
When the instance is garbage collected, the C function func is
called.
See also Fiddle::Pointer.new
# File fiddle/lib/fiddle/struct.rb, line 119
def initialize(addr, types, func = nil)
set_ctypes(types)
super(addr, @size, func)
end
Returns the offset for the packed sizes for the given types.
Fiddle::CStructEntity.size( [ Fiddle::TYPE_DOUBLE, Fiddle::TYPE_INT, Fiddle::TYPE_CHAR, Fiddle::TYPE_VOIDP ]) #=> 24
# File fiddle/lib/fiddle/struct.rb, line 98
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
Public Instance Methods
Fetch struct member name
# File fiddle/lib/fiddle/struct.rb, line 151
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| Pointer.new(v)}
end
when TYPE_VOIDP
val = Pointer.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
Set struct member name, to value val
# File fiddle/lib/fiddle/struct.rb, line 185
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
Set the names of the members in this C struct
# File fiddle/lib/fiddle/struct.rb, line 125
def assign_names(members)
@members = members
end
Calculates the offsets and sizes for the given types in the
struct.
# File fiddle/lib/fiddle/struct.rb, line 130
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
Commenting is here to help enhance the documentation. For example, sample code, or clarification of the documentation.
If you are posting code samples in your comments, please wrap them in "<pre><code class="ruby" > ... </code></pre>" markup in order to get syntax highlighting.
If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.
If you wish to post a correction of the docs, please do so, but also file a bug report so that it can be corrected for the next release. Thank you.