com.sun.jna.StringArray Maven / Gradle / Ivy
/* Copyright (c) 2007-2008 Timothy Wall, All Rights Reserved
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package com.sun.jna;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/** Handle native array of char* or wchar_t* type
* by managing allocation/disposal of native strings within an array of
* pointers. An extra NULL pointer is always added to the end of the native
* pointer array for convenience.
*/
public class StringArray extends Memory implements Function.PostCallRead {
private String encoding;
private List natives = new ArrayList();
private Object[] original;
/** Create a native array of strings. */
public StringArray(String[] strings) {
this(strings, false);
}
/** Create a native array of strings. */
public StringArray(String[] strings, boolean wide) {
this((Object[])strings, wide ? NativeString.WIDE_STRING : Native.getDefaultStringEncoding());
}
/** Create a native array of strings using the given encoding. */
public StringArray(String[] strings, String encoding) {
this((Object[])strings, encoding);
}
/** Create a native array of wide strings. */
public StringArray(WString[] strings) {
this(strings, NativeString.WIDE_STRING);
}
private StringArray(Object[] strings, String encoding) {
super((strings.length + 1) * Pointer.SIZE);
this.original = strings;
this.encoding = encoding;
for (int i=0;i < strings.length;i++) {
Pointer p = null;
if (strings[i] != null) {
NativeString ns = new NativeString(strings[i].toString(), encoding);
natives.add(ns);
p = ns.getPointer();
}
setPointer(Pointer.SIZE * i, p);
}
setPointer(Pointer.SIZE * strings.length, null);
}
/** Read back from native memory. */
public void read() {
boolean returnWide = original instanceof WString[];
boolean wide = encoding == NativeString.WIDE_STRING;
for (int si=0;si < original.length;si++) {
Pointer p = getPointer(si * Pointer.SIZE);
Object s = null;
if (p != null) {
s = wide ? p.getWideString(0) : p.getString(0, encoding);
if (returnWide) s = new WString((String)s);
}
original[si] = s;
}
}
public String toString() {
boolean wide = encoding == NativeString.WIDE_STRING;
String s = wide ? "const wchar_t*[]" : "const char*[]";
s += Arrays.asList(original);
return s;
}
}