Top Description Inners Fields Constructors Methods
org.lwjgl.llvm

public Class CXCursor

extends Struct<CXCursor>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
A cursor representing some element in the abstract syntax tree for a translation unit.

The cursor abstraction unifies the different kinds of entities in a program --declaration, statements, expressions, references to declarations, etc.-- under a single "cursor" abstraction with a common set of operations. Common operation for a cursor include: getting the physical location in a source file where the cursor points, getting the name associated with a cursor, and retrieving cursors for any child nodes of a particular cursor.

Cursors can be produced in two specific ways. getTranslationUnitCursor produces a cursor for a translation unit, from which one can use visitChildren to explore the rest of the translation unit. getCursor maps from a physical source location to the entity that resides at that location, allowing one to map from the source code into the AST.

Layout


struct CXCursor {
    enum CXCursorKind kind;
    int xdata;
    void const * data[3];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CXCursor.Buffer

An array of CXCursor structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DATA

The struct member offsets.

public static final int
KIND

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
XDATA

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
CXCursor(long address, ByteBuffer container)

public
CXCursor(ByteBuffer container)

Creates a CXCursor instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static CXCursor
calloc()

Returns a new CXCursor instance allocated with memCalloc.

public static CXCursor.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new CXCursor.Buffer instance allocated with memCalloc.

public static CXCursor
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new CXCursor instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static CXCursor.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new CXCursor.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static CXCursor
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static CXCursor
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static CXCursor.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static CXCursor.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected CXCursor
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static CXCursor
create()

Returns a new CXCursor instance allocated with BufferUtils.

public static CXCursor
create(long address)

Returns a new CXCursor instance for the specified memory address.

public static CXCursor.Buffer
create(int
the buffer capacity
capacity)

Returns a new CXCursor.Buffer instance allocated with BufferUtils.

public static CXCursor.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a CXCursor.Buffer instance at the specified memory.

public static CXCursor
createSafe(long address)

Like create, but returns null if address is NULL.

public static CXCursor.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public PointerBuffer

Returns:

a PointerBuffer view of the data field.
data()

public long

Returns:

the value at the specified index of the data field.
data(int index)

public int

Returns:

the value of the kind field.
kind()

public static CXCursor
malloc()

Returns a new CXCursor instance allocated with memAlloc.

public static CXCursor.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new CXCursor.Buffer instance allocated with memAlloc.

public static CXCursor
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new CXCursor instance allocated on the specified MemoryStack.

public static CXCursor.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new CXCursor.Buffer instance allocated on the specified MemoryStack.

public static CXCursor
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static CXCursor
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static CXCursor.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static CXCursor.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static PointerBuffer
ndata(long struct)

Unsafe version of data.

public static long
ndata(long struct, int index)

Unsafe version of data.

public static int
nkind(long struct)

Unsafe version of kind.

public static int
nxdata(long struct)

Unsafe version of xdata.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int

Returns:

the value of the xdata field.
xdata()

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DATAback to summary
public static final int DATA

The struct member offsets.

KINDback to summary
public static final int KIND

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

XDATAback to summary
public static final int XDATA

The struct member offsets.

Constructor Detail

CXCursorback to summary
protected CXCursor(long address, ByteBuffer container)
CXCursorback to summary
public CXCursor(ByteBuffer container)

Creates a CXCursor instance at the current position of the specified 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.

Method Detail

callocback to summary
public static CXCursor calloc()

Returns a new CXCursor instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static CXCursor.Buffer calloc(int capacity)

Returns a new CXCursor.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CXCursor calloc(MemoryStack stack)

Returns a new CXCursor instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static CXCursor.Buffer calloc(int capacity, MemoryStack stack)

Returns a new CXCursor.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static CXCursor callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static CXCursor callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static CXCursor.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static CXCursor.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected CXCursor create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static CXCursor create()

Returns a new CXCursor instance allocated with BufferUtils.

createback to summary
public static CXCursor create(long address)

Returns a new CXCursor instance for the specified memory address.

createback to summary
public static CXCursor.Buffer create(int capacity)

Returns a new CXCursor.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static CXCursor.Buffer create(long address, int capacity)

Create a CXCursor.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CXCursor createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static CXCursor.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
databack to summary
public PointerBuffer data()
Returns:PointerBuffer

a PointerBuffer view of the data field.

Annotations
@NativeType:void const *[3]
databack to summary
public long data(int index)
Returns:long

the value at the specified index of the data field.

Annotations
@NativeType:void const *
kindback to summary
public int kind()
Returns:int

the value of the kind field.

Annotations
@NativeType:enum CXCursorKind
mallocback to summary
public static CXCursor malloc()

Returns a new CXCursor instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static CXCursor.Buffer malloc(int capacity)

Returns a new CXCursor.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CXCursor malloc(MemoryStack stack)

Returns a new CXCursor instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static CXCursor.Buffer malloc(int capacity, MemoryStack stack)

Returns a new CXCursor.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static CXCursor mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static CXCursor mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static CXCursor.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static CXCursor.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
ndataback to summary
public static PointerBuffer ndata(long struct)

Unsafe version of data.

ndataback to summary
public static long ndata(long struct, int index)

Unsafe version of data.

nkindback to summary
public static int nkind(long struct)

Unsafe version of kind.

nxdataback to summary
public static int nxdata(long struct)

Unsafe version of xdata.

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
xdataback to summary
public int xdata()
Returns:int

the value of the xdata field.

org.lwjgl.llvm back to summary

public Class CXCursor.Buffer

extends StructBuffer<CXCursor, CXCursor.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of CXCursor structs.

Field Summary

Modifier and TypeField and Description
private static final CXCursor
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CXCursor.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public PointerBuffer

Returns:

a PointerBuffer view of the data field.
data()

public long

Returns:

the value at the specified index of the data field.
data(int index)

protected CXCursor
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public int

Returns:

the value of the kind field.
kind()

protected CXCursor.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the xdata field.
xdata()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CXCursor ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new CXCursor.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 CXCursor#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

databack to summary
public PointerBuffer data()
Returns:PointerBuffer

a PointerBuffer view of the data field.

Annotations
@NativeType:void const *[3]
databack to summary
public long data(int index)
Returns:long

the value at the specified index of the data field.

Annotations
@NativeType:void const *
getElementFactoryback to summary
protected CXCursor getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
kindback to summary
public int kind()
Returns:int

the value of the kind field.

Annotations
@NativeType:enum CXCursorKind
selfback to summary
protected CXCursor.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
xdataback to summary
public int xdata()
Returns:int

the value of the xdata field.