com.bugvm.rt.bro.ptr.CharPtr Maven / Gradle / Ivy
/*
* Copyright (C) 2012 RoboVM 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 com.bugvm.rt.bro.ptr;
import java.nio.ByteOrder;
import java.nio.CharBuffer;
import java.nio.ShortBuffer;
import com.bugvm.rt.bro.Struct;
import com.bugvm.rt.bro.annotation.StructMember;
/**
* Points to a 16-bit unsigned value (unsigned short * in C).
*/
public final class CharPtr extends Struct {
/**
* Pointer to {@link CharPtr} (unsigned short ** in C)
*/
public static class CharPtrPtr extends com.bugvm.rt.bro.ptr.Ptr {}
/**
* Creates a new {@link CharPtr} with a value of 0.
*/
public CharPtr() {
}
/**
* Creates a new {@link CharPtr} and initializes it with the specified value.
*
* @param value the value.
*/
public CharPtr(char value) {
set(value);
}
/**
* Returns the current value.
*
* @return the value.
*/
@StructMember(0)
public native char get();
/**
* Sets the value.
*
* @param value the new value.
*/
@StructMember(0)
public native void set(char value);
/**
* Returns a {@link CharBuffer} which reads and writes to the same memory
* location pointed to by this {@link CharPtr}.
*
* @param n the maximum number of chars the {@link CharBuffer} can
* read/write. This will be the {@link CharBuffer}'s
* capacity.
* @return the {@link ShortBuffer}.
*/
public CharBuffer asCharBuffer(int n) {
return as(BytePtr.class).asByteBuffer(n << 1).order(ByteOrder.nativeOrder()).asCharBuffer();
}
/**
* Copies {@code n} chars from the memory pointed to by this {@link CharPtr}
* to a new {@code char[]} instance.
*
* @param n the number of chars to copy.
* @return the {@code char[]}.
*/
public char[] toCharArray(int n) {
char[] result = new char[n];
get(result);
return result;
}
/**
* Copies {@code dst.length} chars from the memory pointed to by this
* {@link CharPtr} to {@code dst}.
*
* @param dst the destination.
*/
public void get(char[] dst) {
get(dst, 0, dst.length);
}
/**
* Copies {@code count} chars from the memory pointed to by this
* {@link CharPtr} 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(char[] dst, int offset, int count) {
asCharBuffer(count).get(dst, offset, count);
}
/**
* Copies {@code src.length} chars from {@code src} to the memory pointed to by
* this {@link CharPtr}.
*
* @param src the source.
*/
public void set(char[] src) {
set(src, 0, src.length);
}
/**
* Copies {@code count} chars from {@code src} starting at offset {@code offset}
* to the memory pointed to by this {@link CharPtr}.
*
* @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(char[] src, int offset, int count) {
asCharBuffer(count).put(src, offset, count);
}
}