org.lwjgl.system.macosx.ObjCPropertyAttribute Maven / Gradle / Ivy
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.system.macosx;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Defines a property attribute.
*
* Member documentation
*
*
* - {@code name} – the name of the attribute
* - {@code value} – the value of the attribute (usually empty)
*
*
* Layout
*
*
* struct objc_property_attribute_t {
* char * name;
* char * value;
* }The created instance holds a strong reference to the container object.
*/
public ObjCPropertyAttribute(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code name} field. */
@NativeType("char *")
public ByteBuffer name() { return nname(address()); }
/** Decodes the null-terminated string pointed to by the {@code name} field. */
@NativeType("char *")
public String nameString() { return nnameString(address()); }
/** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code value} field. */
@NativeType("char *")
public ByteBuffer value() { return nvalue(address()); }
/** Decodes the null-terminated string pointed to by the {@code value} field. */
@NativeType("char *")
public String valueString() { return nvalueString(address()); }
/** Sets the address of the specified encoded string to the {@code name} field. */
public ObjCPropertyAttribute name(@NativeType("char *") ByteBuffer value) { nname(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code value} field. */
public ObjCPropertyAttribute value(@NativeType("char *") ByteBuffer value) { nvalue(address(), value); return this; }
/** Initializes this struct with the specified values. */
public ObjCPropertyAttribute set(
ByteBuffer name,
ByteBuffer value
) {
name(name);
value(value);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public ObjCPropertyAttribute set(ObjCPropertyAttribute src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link ObjCPropertyAttribute} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static ObjCPropertyAttribute malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link ObjCPropertyAttribute} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static ObjCPropertyAttribute calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link ObjCPropertyAttribute} instance allocated with {@link BufferUtils}. */
public static ObjCPropertyAttribute create() {
return new ObjCPropertyAttribute(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link ObjCPropertyAttribute} instance for the specified memory address. */
public static ObjCPropertyAttribute create(long address) {
return new ObjCPropertyAttribute(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static ObjCPropertyAttribute createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link ObjCPropertyAttribute.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static ObjCPropertyAttribute.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link ObjCPropertyAttribute.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static ObjCPropertyAttribute.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link ObjCPropertyAttribute.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static ObjCPropertyAttribute.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link ObjCPropertyAttribute.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static ObjCPropertyAttribute.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static ObjCPropertyAttribute.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link ObjCPropertyAttribute} instance allocated on the thread-local {@link MemoryStack}. */
public static ObjCPropertyAttribute mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link ObjCPropertyAttribute} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static ObjCPropertyAttribute callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link ObjCPropertyAttribute} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static ObjCPropertyAttribute mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link ObjCPropertyAttribute} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static ObjCPropertyAttribute callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link ObjCPropertyAttribute.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static ObjCPropertyAttribute.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link ObjCPropertyAttribute.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static ObjCPropertyAttribute.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link ObjCPropertyAttribute.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static ObjCPropertyAttribute.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link ObjCPropertyAttribute.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static ObjCPropertyAttribute.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #name}. */
public static ByteBuffer nname(long struct) { return memByteBufferNT1(memGetAddress(struct + ObjCPropertyAttribute.NAME)); }
/** Unsafe version of {@link #nameString}. */
public static String nnameString(long struct) { return memUTF8(memGetAddress(struct + ObjCPropertyAttribute.NAME)); }
/** Unsafe version of {@link #value}. */
public static ByteBuffer nvalue(long struct) { return memByteBufferNT1(memGetAddress(struct + ObjCPropertyAttribute.VALUE)); }
/** Unsafe version of {@link #valueString}. */
public static String nvalueString(long struct) { return memUTF8(memGetAddress(struct + ObjCPropertyAttribute.VALUE)); }
/** Unsafe version of {@link #name(ByteBuffer) name}. */
public static void nname(long struct, ByteBuffer value) {
if (CHECKS) { checkNT1(value); }
memPutAddress(struct + ObjCPropertyAttribute.NAME, memAddress(value));
}
/** Unsafe version of {@link #value(ByteBuffer) value}. */
public static void nvalue(long struct, ByteBuffer value) {
if (CHECKS) { checkNT1(value); }
memPutAddress(struct + ObjCPropertyAttribute.VALUE, memAddress(value));
}
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + ObjCPropertyAttribute.NAME));
check(memGetAddress(struct + ObjCPropertyAttribute.VALUE));
}
/**
* Calls {@link #validate(long)} for each struct contained in the specified struct array.
*
* @param array the struct array to validate
* @param count the number of structs in {@code array}
*/
public static void validate(long array, int count) {
for (int i = 0; i < count; i++) {
validate(array + i * SIZEOF);
}
}
// -----------------------------------
/** An array of {@link ObjCPropertyAttribute} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link ObjCPropertyAttribute.Buffer} instance backed by the specified container.
*
* Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values
* will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided
* by {@link ObjCPropertyAttribute#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected ObjCPropertyAttribute newInstance(long address) {
return new ObjCPropertyAttribute(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code name} field. */
@NativeType("char *")
public ByteBuffer name() { return ObjCPropertyAttribute.nname(address()); }
/** Decodes the null-terminated string pointed to by the {@code name} field. */
@NativeType("char *")
public String nameString() { return ObjCPropertyAttribute.nnameString(address()); }
/** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code value} field. */
@NativeType("char *")
public ByteBuffer value() { return ObjCPropertyAttribute.nvalue(address()); }
/** Decodes the null-terminated string pointed to by the {@code value} field. */
@NativeType("char *")
public String valueString() { return ObjCPropertyAttribute.nvalueString(address()); }
/** Sets the address of the specified encoded string to the {@code name} field. */
public ObjCPropertyAttribute.Buffer name(@NativeType("char *") ByteBuffer value) { ObjCPropertyAttribute.nname(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code value} field. */
public ObjCPropertyAttribute.Buffer value(@NativeType("char *") ByteBuffer value) { ObjCPropertyAttribute.nvalue(address(), value); return this; }
}
}