Class CXIdxEntityRefInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<CXIdxEntityRefInfo>

org.lwjgl.llvm.CXIdxEntityRefInfo

All Implemented Interfaces:

Pointer

public class CXIdxEntityRefInfo
extends Struct<CXIdxEntityRefInfo>

struct CXIdxEntityRefInfo {
    CXIdxEntityRefKind kind;
    CXCursor cursor;
    CXIdxLoc loc;
    CXIdxEntityInfo const * referencedEntity;
    CXIdxEntityInfo const * parentEntity;
    CXIdxContainerInfo const * container;
    CXSymbolRole role;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CXIdxEntityRefInfo.Buffer	An array of CXIdxEntityRefInfo structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CONTAINER	The struct member offsets.
static final int	CURSOR	The struct member offsets.
static final int	KIND	The struct member offsets.
static final int	LOC	The struct member offsets.
static final int	PARENTENTITY	The struct member offsets.
static final int	REFERENCEDENTITY	The struct member offsets.
static final int	ROLE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
CXIdxEntityRefInfo(ByteBuffer container)	Creates a CXIdxEntityRefInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
CXIdxContainerInfo	container()
static CXIdxEntityRefInfo	create(long address)	Returns a new CXIdxEntityRefInfo instance for the specified memory address.
static CXIdxEntityRefInfo.Buffer	create(long address, int capacity)	Create a CXIdxEntityRefInfo.Buffer instance at the specified memory.
static @Nullable CXIdxEntityRefInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable CXIdxEntityRefInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
CXCursor	cursor()
int	kind()
CXIdxLoc	loc()
static CXIdxContainerInfo	ncontainer(long struct)	Unsafe version of container().
static CXCursor	ncursor(long struct)	Unsafe version of cursor().
static int	nkind(long struct)	Unsafe version of kind().
static CXIdxLoc	nloc(long struct)	Unsafe version of loc().
static CXIdxEntityInfo	nparentEntity(long struct)	Unsafe version of parentEntity().
static CXIdxEntityInfo	nreferencedEntity(long struct)	Unsafe version of referencedEntity().
static int	nrole(long struct)	Unsafe version of role().
CXIdxEntityInfo	parentEntity()
CXIdxEntityInfo	referencedEntity()
int	role()
int	sizeof()	Returns sizeof(struct).

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

KIND

public static final int KIND

The struct member offsets.

CURSOR

public static final int CURSOR

The struct member offsets.

LOC

public static final int LOC

The struct member offsets.

REFERENCEDENTITY

public static final int REFERENCEDENTITY

The struct member offsets.

PARENTENTITY

public static final int PARENTENTITY

The struct member offsets.

CONTAINER

public static final int CONTAINER

The struct member offsets.

ROLE

public static final int ROLE

The struct member offsets.

Constructor Details

CXIdxEntityRefInfo

public CXIdxEntityRefInfo(ByteBuffer container)

Creates a CXIdxEntityRefInfo 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<CXIdxEntityRefInfo>

kind

@NativeType("CXIdxEntityRefKind")
public int kind()

Returns:

the value of the kind field.

cursor

public CXCursor cursor()

Returns:

a CXCursor view of the cursor field.

loc

public CXIdxLoc loc()

Returns:

a CXIdxLoc view of the loc field.

referencedEntity

@NativeType("CXIdxEntityInfo const *")
public CXIdxEntityInfo referencedEntity()

Returns:

a CXIdxEntityInfo view of the struct pointed to by the referencedEntity field.

parentEntity

@NativeType("CXIdxEntityInfo const *")
public CXIdxEntityInfo parentEntity()

Returns:

a CXIdxEntityInfo view of the struct pointed to by the parentEntity field.

container

@NativeType("CXIdxContainerInfo const *")
public CXIdxContainerInfo container()

Returns:

a CXIdxContainerInfo view of the struct pointed to by the container field.

role

@NativeType("CXSymbolRole")
public int role()

Returns:

the value of the role field.

create

public static CXIdxEntityRefInfo create(long address)

Returns a new CXIdxEntityRefInfo instance for the specified memory address.

createSafe

public static @Nullable CXIdxEntityRefInfo createSafe(long address)

Like create, but returns null if address is NULL.

create

public static CXIdxEntityRefInfo.Buffer create(long address,
 int capacity)

Create a CXIdxEntityRefInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable CXIdxEntityRefInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

nkind

public static int nkind(long struct)

Unsafe version of kind().

ncursor

public static CXCursor ncursor(long struct)

Unsafe version of cursor().

nloc

public static CXIdxLoc nloc(long struct)

Unsafe version of loc().

nreferencedEntity

public static CXIdxEntityInfo nreferencedEntity(long struct)

Unsafe version of referencedEntity().

nparentEntity

public static CXIdxEntityInfo nparentEntity(long struct)

Unsafe version of parentEntity().

ncontainer

public static CXIdxContainerInfo ncontainer(long struct)

Unsafe version of container().

nrole

public static int nrole(long struct)

Unsafe version of role().