Class CXCursor
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.llvm.CXCursor
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class CXCursor extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceA 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.
getTranslationUnitCursorproduces a cursor for a translation unit, from which one can usevisitChildrento explore the rest of the translation unit.getCursormaps 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 Class Summary
Nested Classes Modifier and Type Class Description static classCXCursor.BufferAn array ofCXCursorstructs.
-
Constructor Summary
Constructors Constructor Description CXCursor(java.nio.ByteBuffer container)Creates aCXCursorinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static CXCursorcalloc()Returns a newCXCursorinstance allocated withmemCalloc.static CXCursor.Buffercalloc(int capacity)Returns a newCXCursor.Bufferinstance allocated withmemCalloc.static CXCursor.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newCXCursor.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static CXCursorcalloc(org.lwjgl.system.MemoryStack stack)Returns a newCXCursorinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static CXCursorcallocStack()Deprecated.static CXCursor.BuffercallocStack(int capacity)Deprecated.static CXCursor.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static CXCursorcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static CXCursorcreate()Returns a newCXCursorinstance allocated withBufferUtils.static CXCursor.Buffercreate(int capacity)Returns a newCXCursor.Bufferinstance allocated withBufferUtils.static CXCursorcreate(long address)Returns a newCXCursorinstance for the specified memory address.static CXCursor.Buffercreate(long address, int capacity)Create aCXCursor.Bufferinstance at the specified memory.static CXCursorcreateSafe(long address)static CXCursor.BuffercreateSafe(long address, int capacity)org.lwjgl.PointerBufferdata()longdata(int index)intkind()static CXCursormalloc()Returns a newCXCursorinstance allocated withmemAlloc.static CXCursor.Buffermalloc(int capacity)Returns a newCXCursor.Bufferinstance allocated withmemAlloc.static CXCursor.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newCXCursor.Bufferinstance allocated on the specifiedMemoryStack.static CXCursormalloc(org.lwjgl.system.MemoryStack stack)Returns a newCXCursorinstance allocated on the specifiedMemoryStack.static CXCursormallocStack()Deprecated.static CXCursor.BuffermallocStack(int capacity)Deprecated.static CXCursor.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static CXCursormallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static org.lwjgl.PointerBufferndata(long struct)Unsafe version ofdata().static longndata(long struct, int index)Unsafe version ofdata.static intnkind(long struct)Unsafe version ofkind().static intnxdata(long struct)Unsafe version ofxdata().intsizeof()intxdata()
-
-
-
Constructor Detail
-
CXCursor
public CXCursor(java.nio.ByteBuffer container)
Creates aCXCursorinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
kind
public int kind()
- Returns:
- the value of the
kindfield.
-
xdata
public int xdata()
- Returns:
- the value of the
xdatafield.
-
data
public org.lwjgl.PointerBuffer data()
- Returns:
- a
PointerBufferview of thedatafield.
-
data
public long data(int index)
- Returns:
- the value at the specified index of the
datafield.
-
malloc
public static CXCursor malloc()
Returns a newCXCursorinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static CXCursor calloc()
Returns a newCXCursorinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static CXCursor create()
Returns a newCXCursorinstance allocated withBufferUtils.
-
create
public static CXCursor create(long address)
Returns a newCXCursorinstance for the specified memory address.
-
createSafe
@Nullable public static CXCursor createSafe(long address)
-
malloc
public static CXCursor.Buffer malloc(int capacity)
Returns a newCXCursor.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static CXCursor.Buffer calloc(int capacity)
Returns a newCXCursor.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static CXCursor.Buffer create(int capacity)
Returns a newCXCursor.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static CXCursor.Buffer create(long address, int capacity)
Create aCXCursor.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static CXCursor.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static CXCursor mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static CXCursor callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static CXCursor mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static CXCursor callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static CXCursor.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static CXCursor.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static CXCursor.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static CXCursor.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static CXCursor malloc(org.lwjgl.system.MemoryStack stack)
Returns a newCXCursorinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static CXCursor calloc(org.lwjgl.system.MemoryStack stack)
Returns a newCXCursorinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static CXCursor.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newCXCursor.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static CXCursor.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newCXCursor.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nkind
public static int nkind(long struct)
Unsafe version ofkind().
-
nxdata
public static int nxdata(long struct)
Unsafe version ofxdata().
-
ndata
public static org.lwjgl.PointerBuffer ndata(long struct)
Unsafe version ofdata().
-
ndata
public static long ndata(long struct, int index)Unsafe version ofdata.
-
-