/***** BEGIN LICENSE BLOCK *****
* Version: CPL 1.0/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Common Public
* License Version 1.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.eclipse.org/legal/cpl-v10.html
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* Copyright (C) 2008 JRuby project
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the CPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the CPL, the GPL or the LGPL.
***** END LICENSE BLOCK *****/
package org.jruby.ext.ffi.jna;
import org.jruby.ext.ffi.*;
import com.sun.jna.Pointer;
import com.sun.jna.ptr.PointerByReference;
import org.jruby.Ruby;
import org.jruby.RubyClass;
import org.jruby.RubyModule;
import org.jruby.RubyNumeric;
import org.jruby.RubyString;
import org.jruby.anno.JRubyClass;
import org.jruby.anno.JRubyMethod;
import org.jruby.runtime.ObjectAllocator;
import org.jruby.runtime.ThreadContext;
import org.jruby.runtime.builtin.IRubyObject;
/**
*
*/
@JRubyClass(name = FFIProvider.MODULE_NAME + "::" + JNAMemoryPointer.MEMORY_POINTER_NAME, parent = FFIProvider.MODULE_NAME + "::" + AbstractMemoryPointer.className)
public class JNAMemoryPointer extends AbstractMemoryPointer implements JNAMemory {
public static final String MEMORY_POINTER_NAME = "MemoryPointer";
public static RubyClass createMemoryPointerClass(Ruby runtime) {
RubyModule module = FFIProvider.getModule(runtime);
RubyClass result = module.defineClassUnder(MEMORY_POINTER_NAME,
module.getClass(AbstractMemoryPointer.className),
ObjectAllocator.NOT_ALLOCATABLE_ALLOCATOR);
result.defineAnnotatedMethods(JNAMemoryPointer.class);
result.defineAnnotatedConstants(JNAMemoryPointer.class);
return result;
}
public JNAMemoryPointer(Ruby runtime, RubyClass klass) {
super(runtime, klass, JNAMemoryIO.wrap(Pointer.NULL), 0, 0);
}
JNAMemoryPointer(Ruby runtime, Pointer value) {
this(runtime, JNAMemoryIO.wrap(value), 0, Long.MAX_VALUE);
}
private JNAMemoryPointer(Ruby runtime, JNAMemoryPointer ptr, long offset) {
this(runtime, ptr.io, ptr.offset + offset,
ptr.size == Long.MAX_VALUE ? Long.MAX_VALUE : ptr.size - offset);
}
JNAMemoryPointer(Ruby runtime, MemoryIO io, long offset, long size) {
super(runtime, FFIProvider.getModule(runtime).fastGetClass(MEMORY_POINTER_NAME),
io, offset, size);
}
@JRubyMethod(name = { "allocate", "allocate_direct", "allocateDirect" }, meta = true)
public static JNAMemoryPointer allocateDirect(ThreadContext context, IRubyObject recv, IRubyObject sizeArg) {
int size = Util.int32Value(sizeArg);
JNAMemoryIO io = size > 0 ? JNAMemoryIO.allocateDirect(size) : JNAMemoryIO.NULL;
return new JNAMemoryPointer(context.getRuntime(), io, 0, size);
}
@JRubyMethod(name = { "allocate", "allocate_direct", "allocateDirect" }, meta = true)
public static JNAMemoryPointer allocateDirect(ThreadContext context, IRubyObject recv, IRubyObject sizeArg, IRubyObject clearArg) {
int size = Util.int32Value(sizeArg);
JNAMemoryIO io = size > 0 ? JNAMemoryIO.allocateDirect(size) : JNAMemoryIO.NULL;
if (clearArg.isTrue()) {
io.setMemory(0, size, (byte) 0);
}
return new JNAMemoryPointer(context.getRuntime(), io, 0, size);
}
@JRubyMethod(name = "to_s", optional = 1)
public IRubyObject to_s(ThreadContext context, IRubyObject[] args) {
Pointer address = getAddress();
String hex = address != null ? address.toString() : "native@0x0";
return RubyString.newString(context.getRuntime(), MEMORY_POINTER_NAME + "[address=" + hex + "]");
}
Pointer getAddress() {
return ((JNAMemoryIO) getMemoryIO()).getAddress();
}
public Object getNativeMemory() {
return ((JNAMemoryIO) getMemoryIO()).slice(offset).getMemory();
}
private static final long ptr2long(Pointer ptr) {
return new PointerByReference(ptr).getPointer().getInt(0);
}
@JRubyMethod(name = "address")
public IRubyObject address(ThreadContext context) {
return context.getRuntime().newFixnum(ptr2long(getAddress()));
}
@JRubyMethod(name = "inspect")
public IRubyObject inspect(ThreadContext context) {
String hex = Long.toHexString(ptr2long(getAddress()) + offset);
return RubyString.newString(context.getRuntime(),
String.format("#<MemoryPointer address=0x%s>", hex));
}
@JRubyMethod(name = "+", required = 1)
public IRubyObject op_plus(ThreadContext context, IRubyObject value) {
return new JNAMemoryPointer(context.getRuntime(), this,
RubyNumeric.fix2long(value));
}
@JRubyMethod(name = "put_pointer", required = 2)
public IRubyObject put_pointer(ThreadContext context, IRubyObject offset, IRubyObject value) {
Pointer ptr;
if (value instanceof JNAMemoryPointer) {
ptr = ((JNAMemoryPointer) value).getAddress();
} else if (value.isNil()) {
ptr = Pointer.NULL;
} else {
throw context.getRuntime().newArgumentError("Cannot convert argument to pointer");
}
((JNAMemoryIO) getMemoryIO()).putPointer(getOffset(offset), ptr);
return this;
}
protected AbstractMemoryPointer getMemoryPointer(Ruby runtime, long offset) {
return new JNAMemoryPointer(runtime,
getMemoryIO().getMemoryIO(this.offset + offset), 0, Long.MAX_VALUE);
}
}