org.robovm.rt.bro.ptr.IntPtr Maven / Gradle / Ivy

/*
 * Copyright (C) 2012 Trillian Mobile AB
 *
 * Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.robovm.rt.bro.ptr;

import java.nio.ByteOrder;
import java.nio.IntBuffer;

import org.robovm.rt.bro.Struct;
import org.robovm.rt.bro.annotation.StructMember;

/**
 * Points to a 32-bit signed value (int32_t * in C).
 */
public final class IntPtr extends Struct {

    /**
     * Pointer to {@link IntPtr} (int32_t ** in C)
     */
    public static class IntPtrPtr extends org.robovm.rt.bro.ptr.Ptr {}

    /**
     * Creates a new {@link IntPtr} with a value of 0.
     */
    public IntPtr() {
    }
    
    /**
     * Creates a new {@link IntPtr} and initializes it with the specified value.
     * 
     * @param value the value.
     */
    public IntPtr(int value) {
        set(value);
    }

    /**
     * Returns the current value.
     * 
     * @return the value.
     */
    @StructMember(0)
    public native int get();
    
    /**
     * Sets the value.
     * 
     * @param value the new value.
     */
    @StructMember(0)
    public native void set(int value);
    
    /**
     * Returns a {@link IntBuffer} which reads and writes to the same memory
     * location pointed to by this {@link IntPtr}.
     * 
     * @param n the maximum number of ints the {@link IntBuffer} can 
     *        read/write. This will be the {@link IntBuffer}'s 
     *        capacity.
     * @return the {@link IntBuffer}.
     */
    public IntBuffer asIntBuffer(int n) {
        return as(BytePtr.class).asByteBuffer(n << 2).order(ByteOrder.nativeOrder()).asIntBuffer();
    }
    
    /**
     * Copies {@code n} ints from the memory pointed to by this {@link IntPtr}
     * to a new {@code int[]} instance.
     * 
     * @param n the number of ints to copy.
     * @return the {@code int[]}.
     */
    public int[] toIntArray(int n) {
        int[] result = new int[n];
        get(result);
        return result;
    }

    /**
     * Copies {@code dst.length} ints from the memory pointed to by this 
     * {@link IntPtr} to {@code dst}.
     * 
     * @param dst the destination.
     */
    public void get(int[] dst) {
        get(dst, 0, dst.length);
    }

    /**
     * Copies {@code count} ints from the memory pointed to by this 
     * {@link IntPtr} to {@code dst} starting at offset {@code offset}.
     * 
     * @param dst the destination.
     * @param offset the offset within the destination array to start copying to.
     * @param count the number of elements to copy.
     */
    public void get(int[] dst, int offset, int count) {
        asIntBuffer(count).get(dst, offset, count);
    }

    /**
     * Copies {@code src.length} ints from {@code src} to the memory pointed to by
     * this {@link IntPtr}.
     * 
     * @param src the source.
     */
    public void set(int[] src) {
        set(src, 0, src.length);
    }
    
    /**
     * Copies {@code count} ints from {@code src} starting at offset {@code offset}
     * to the memory pointed to by this {@link IntPtr}.
     * 
     * @param src the source.
     * @param offset the offset within the source array to start copying from.
     * @param count the number of elements to copy.
     */
    public void set(int[] src, int offset, int count) {
        asIntBuffer(count).put(src, offset, count);
    }
}