Top Description Inners Fields Constructors Methods
org.lwjgl.llvm

public Class CXIdxEntityRefInfo

extends Struct<CXIdxEntityRefInfo>
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Data for IndexerCallbacks#indexEntityReference.

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CONTAINER

The struct member offsets.

public static final int
CURSOR

The struct member offsets.

public static final int
KIND

The struct member offsets.

public static final int
LOC

The struct member offsets.

public static final int
PARENTENTITY

The struct member offsets.

public static final int
REFERENCEDENTITY

The struct member offsets.

public static final int
ROLE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
CXIdxEntityRefInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public CXIdxContainerInfo
container()

lexical container context of the reference

protected CXIdxEntityRefInfo
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 CXIdxEntityRefInfo
create(long address)

Returns a new CXIdxEntityRefInfo instance for the specified memory address.

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

Create a CXIdxEntityRefInfo.Buffer instance at the specified memory.

public static CXIdxEntityRefInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public CXCursor
cursor()

reference cursor

public int

Returns:

the value of the kind field.
kind
()

public CXIdxLoc

Returns:

a CXIdxLoc view of the loc field.
loc
()

public static CXIdxContainerInfo
ncontainer(long struct)

Unsafe version of container.

public static CXCursor
ncursor(long struct)

Unsafe version of cursor.

public static int
nkind(long struct)

Unsafe version of kind.

public static CXIdxLoc
nloc(long struct)

Unsafe version of loc.

public static CXIdxEntityInfo
nparentEntity(long struct)

Unsafe version of parentEntity.

public static CXIdxEntityInfo
nreferencedEntity(long struct)

Unsafe version of referencedEntity.

public static int
nrole(long struct)

Unsafe version of role.

public CXIdxEntityInfo
parentEntity()

Immediate "parent" of the reference.

public CXIdxEntityInfo
referencedEntity()

the entity that gets referenced

public int
role()

sets of symbol roles of the reference

public int
sizeof()

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

Returns sizeof(struct).
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.

CONTAINERback to summary
public static final int CONTAINER

The struct member offsets.

CURSORback to summary
public static final int CURSOR

The struct member offsets.

KINDback to summary
public static final int KIND

The struct member offsets.

LOCback to summary
public static final int LOC

The struct member offsets.

PARENTENTITYback to summary
public static final int PARENTENTITY

The struct member offsets.

REFERENCEDENTITYback to summary
public static final int REFERENCEDENTITY

The struct member offsets.

ROLEback to summary
public static final int ROLE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CXIdxEntityRefInfoback to summary
protected CXIdxEntityRefInfo(long address, ByteBuffer container)
CXIdxEntityRefInfoback to summary
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 Detail

containerback to summary
public CXIdxContainerInfo container()

lexical container context of the reference

Annotations
@NativeType:CXIdxContainerInfo const *
createback to summary
protected CXIdxEntityRefInfo 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 CXIdxEntityRefInfo create(long address)

Returns a new CXIdxEntityRefInfo instance for the specified memory address.

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

Create a CXIdxEntityRefInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CXIdxEntityRefInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
cursorback to summary
public CXCursor cursor()

reference cursor

kindback to summary
public int kind()
Returns:int

the value of the kind field.

Annotations
@NativeType:CXIdxEntityRefKind
locback to summary
public CXIdxLoc loc()
Returns:CXIdxLoc

a CXIdxLoc view of the loc field.

ncontainerback to summary
public static CXIdxContainerInfo ncontainer(long struct)

Unsafe version of container.

ncursorback to summary
public static CXCursor ncursor(long struct)

Unsafe version of cursor.

nkindback to summary
public static int nkind(long struct)

Unsafe version of kind.

nlocback to summary
public static CXIdxLoc nloc(long struct)

Unsafe version of loc.

nparentEntityback to summary
public static CXIdxEntityInfo nparentEntity(long struct)

Unsafe version of parentEntity.

nreferencedEntityback to summary
public static CXIdxEntityInfo nreferencedEntity(long struct)

Unsafe version of referencedEntity.

nroleback to summary
public static int nrole(long struct)

Unsafe version of role.

parentEntityback to summary
public CXIdxEntityInfo parentEntity()

Immediate "parent" of the reference. For example:


Foo *var;

The parent of reference of type Foo is the variable var. For references inside statement bodies of functions/methods, the parentEntity will be the function/method.

Annotations
@NativeType:CXIdxEntityInfo const *
referencedEntityback to summary
public CXIdxEntityInfo referencedEntity()

the entity that gets referenced

Annotations
@NativeType:CXIdxEntityInfo const *
roleback to summary
public int role()

sets of symbol roles of the reference

Annotations
@NativeType:CXSymbolRole
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
org.lwjgl.llvm back to summary

public Class CXIdxEntityRefInfo.Buffer

extends StructBuffer<CXIdxEntityRefInfo, CXIdxEntityRefInfo.Buffer>
Class Inheritance

An array of CXIdxEntityRefInfo structs.

Field Summary

Modifier and TypeField and Description
private static final CXIdxEntityRefInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CXIdxEntityRefInfo.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 CXIdxContainerInfo

Returns:

a CXIdxContainerInfo view of the struct pointed to by the CXIdxEntityRefInfo#container field.
container
()

public CXCursor

Returns:

a CXCursor view of the CXIdxEntityRefInfo#cursor field.
cursor
()

protected CXIdxEntityRefInfo
public int

Returns:

the value of the kind field.
kind
()

public CXIdxLoc

Returns:

a CXIdxLoc view of the loc field.
loc
()

public CXIdxEntityInfo

Returns:

a CXIdxEntityInfo view of the struct pointed to by the CXIdxEntityRefInfo#parentEntity field.
parentEntity
()

public CXIdxEntityInfo

Returns:

a CXIdxEntityInfo view of the struct pointed to by the CXIdxEntityRefInfo#referencedEntity field.
referencedEntity
()

public int

Returns:

the value of the CXIdxEntityRefInfo#role field.
role
()

protected CXIdxEntityRefInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CXIdxEntityRefInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new CXIdxEntityRefInfo.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 CXIdxEntityRefInfo#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

containerback to summary
public CXIdxContainerInfo container()
Returns:CXIdxContainerInfo

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

Annotations
@NativeType:CXIdxContainerInfo const *
cursorback to summary
public CXCursor cursor()
Returns:CXCursor

a CXCursor view of the CXIdxEntityRefInfo#cursor field.

getElementFactoryback to summary
protected CXIdxEntityRefInfo 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:CXIdxEntityRefKind
locback to summary
public CXIdxLoc loc()
Returns:CXIdxLoc

a CXIdxLoc view of the loc field.

parentEntityback to summary
public CXIdxEntityInfo parentEntity()
Returns:CXIdxEntityInfo

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

Annotations
@NativeType:CXIdxEntityInfo const *
referencedEntityback to summary
public CXIdxEntityInfo referencedEntity()
Returns:CXIdxEntityInfo

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

Annotations
@NativeType:CXIdxEntityInfo const *
roleback to summary
public int role()
Returns:int

the value of the CXIdxEntityRefInfo#role field.

Annotations
@NativeType:CXSymbolRole
selfback to summary
protected CXIdxEntityRefInfo.Buffer self()

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

Annotations
@Override