org.lwjgl.llvm.CXCursorAndRangeVisitor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.lwjgl.llvm Show documentation
Show all versions of org.lwjgl.llvm Show documentation
LWJGL OSGi bundle (LLVM bindings)
The newest version!
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.llvm;
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.*;
/**
* Layout
*
*
* struct CXCursorAndRangeVisitor {
* void * context;
* enum CXVisitorResult (*{@link CXCursorAndRangeVisitI visit}) (void *context, CXCursor cursor, CXSourceRange range);
* }
*/
public class CXCursorAndRangeVisitor extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
CONTEXT,
VISIT;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
CONTEXT = layout.offsetof(0);
VISIT = layout.offsetof(1);
}
/**
* Creates a {@code CXCursorAndRangeVisitor} instance at the current position of the specified {@link ByteBuffer} container. Changes to the buffer's content will be
* visible to the struct instance and vice versa.
*
* The created instance holds a strong reference to the container object.
*/
public CXCursorAndRangeVisitor(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** @return the value of the {@code context} field. */
@NativeType("void *")
public long context() { return ncontext(address()); }
/** @return the value of the {@code visit} field. */
@NativeType("enum CXVisitorResult (*) (void *, CXCursor, CXSourceRange)")
public CXCursorAndRangeVisit visit() { return nvisit(address()); }
/** Sets the specified value to the {@code context} field. */
public CXCursorAndRangeVisitor context(@NativeType("void *") long value) { ncontext(address(), value); return this; }
/** Sets the specified value to the {@code visit} field. */
public CXCursorAndRangeVisitor visit(@NativeType("enum CXVisitorResult (*) (void *, CXCursor, CXSourceRange)") CXCursorAndRangeVisitI value) { nvisit(address(), value); return this; }
/** Initializes this struct with the specified values. */
public CXCursorAndRangeVisitor set(
long context,
CXCursorAndRangeVisitI visit
) {
context(context);
visit(visit);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public CXCursorAndRangeVisitor set(CXCursorAndRangeVisitor src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code CXCursorAndRangeVisitor} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static CXCursorAndRangeVisitor malloc() {
return wrap(CXCursorAndRangeVisitor.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code CXCursorAndRangeVisitor} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static CXCursorAndRangeVisitor calloc() {
return wrap(CXCursorAndRangeVisitor.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code CXCursorAndRangeVisitor} instance allocated with {@link BufferUtils}. */
public static CXCursorAndRangeVisitor create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(CXCursorAndRangeVisitor.class, memAddress(container), container);
}
/** Returns a new {@code CXCursorAndRangeVisitor} instance for the specified memory address. */
public static CXCursorAndRangeVisitor create(long address) {
return wrap(CXCursorAndRangeVisitor.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static CXCursorAndRangeVisitor createSafe(long address) {
return address == NULL ? null : wrap(CXCursorAndRangeVisitor.class, address);
}
/**
* Returns a new {@link CXCursorAndRangeVisitor.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static CXCursorAndRangeVisitor.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link CXCursorAndRangeVisitor.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static CXCursorAndRangeVisitor.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link CXCursorAndRangeVisitor.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static CXCursorAndRangeVisitor.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link CXCursorAndRangeVisitor.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static CXCursorAndRangeVisitor.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static CXCursorAndRangeVisitor.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static CXCursorAndRangeVisitor mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static CXCursorAndRangeVisitor callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static CXCursorAndRangeVisitor mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static CXCursorAndRangeVisitor callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static CXCursorAndRangeVisitor.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static CXCursorAndRangeVisitor.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static CXCursorAndRangeVisitor.Buffer mallocStack(int capacity, MemoryStack stack) { return malloc(capacity, stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static CXCursorAndRangeVisitor.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code CXCursorAndRangeVisitor} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static CXCursorAndRangeVisitor malloc(MemoryStack stack) {
return wrap(CXCursorAndRangeVisitor.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code CXCursorAndRangeVisitor} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static CXCursorAndRangeVisitor calloc(MemoryStack stack) {
return wrap(CXCursorAndRangeVisitor.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link CXCursorAndRangeVisitor.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static CXCursorAndRangeVisitor.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link CXCursorAndRangeVisitor.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 CXCursorAndRangeVisitor.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #context}. */
public static long ncontext(long struct) { return memGetAddress(struct + CXCursorAndRangeVisitor.CONTEXT); }
/** Unsafe version of {@link #visit}. */
public static CXCursorAndRangeVisit nvisit(long struct) { return CXCursorAndRangeVisit.create(memGetAddress(struct + CXCursorAndRangeVisitor.VISIT)); }
/** Unsafe version of {@link #context(long) context}. */
public static void ncontext(long struct, long value) { memPutAddress(struct + CXCursorAndRangeVisitor.CONTEXT, check(value)); }
/** Unsafe version of {@link #visit(CXCursorAndRangeVisitI) visit}. */
public static void nvisit(long struct, CXCursorAndRangeVisitI value) { memPutAddress(struct + CXCursorAndRangeVisitor.VISIT, value.address()); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + CXCursorAndRangeVisitor.CONTEXT));
check(memGetAddress(struct + CXCursorAndRangeVisitor.VISIT));
}
// -----------------------------------
/** An array of {@link CXCursorAndRangeVisitor} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final CXCursorAndRangeVisitor ELEMENT_FACTORY = CXCursorAndRangeVisitor.create(-1L);
/**
* Creates a new {@code CXCursorAndRangeVisitor.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 CXCursorAndRangeVisitor#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 CXCursorAndRangeVisitor getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@code context} field. */
@NativeType("void *")
public long context() { return CXCursorAndRangeVisitor.ncontext(address()); }
/** @return the value of the {@code visit} field. */
@NativeType("enum CXVisitorResult (*) (void *, CXCursor, CXSourceRange)")
public CXCursorAndRangeVisit visit() { return CXCursorAndRangeVisitor.nvisit(address()); }
/** Sets the specified value to the {@code context} field. */
public CXCursorAndRangeVisitor.Buffer context(@NativeType("void *") long value) { CXCursorAndRangeVisitor.ncontext(address(), value); return this; }
/** Sets the specified value to the {@code visit} field. */
public CXCursorAndRangeVisitor.Buffer visit(@NativeType("enum CXVisitorResult (*) (void *, CXCursor, CXSourceRange)") CXCursorAndRangeVisitI value) { CXCursorAndRangeVisitor.nvisit(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy