Top Description Inners Fields Constructors Methods
org.lwjgl.llvm

public Class CXCodeCompleteResults

extends Struct<CXCodeCompleteResults>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Contains the results of code-completion.

This data structure contains the results of code completion, as produced by codeCompleteAt. Its contents must be freed by disposeCodeCompleteResults.

Layout


struct CXCodeCompleteResults {
    CXCompletionResult * Results;
    unsigned NumResults;
}

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
NUMRESULTS

The struct member offsets.

public static final int
RESULTS

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
CXCodeCompleteResults(long address, ByteBuffer container)

public
CXCodeCompleteResults(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CXCodeCompleteResults
calloc()

Returns a new CXCodeCompleteResults instance allocated with memCalloc.

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

Returns a new CXCodeCompleteResults.Buffer instance allocated with memCalloc.

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

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

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

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

public static CXCodeCompleteResults
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected CXCodeCompleteResults
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 CXCodeCompleteResults
create()

Returns a new CXCodeCompleteResults instance allocated with BufferUtils.

public static CXCodeCompleteResults
create(long address)

Returns a new CXCodeCompleteResults instance for the specified memory address.

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

Returns a new CXCodeCompleteResults.Buffer instance allocated with BufferUtils.

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

Create a CXCodeCompleteResults.Buffer instance at the specified memory.

public static CXCodeCompleteResults
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static CXCodeCompleteResults
malloc()

Returns a new CXCodeCompleteResults instance allocated with memAlloc.

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

Returns a new CXCodeCompleteResults.Buffer instance allocated with memAlloc.

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

Returns a new CXCodeCompleteResults instance allocated on the specified MemoryStack.

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

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

public static CXCodeCompleteResults
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static int
nNumResults(long struct)

Unsafe version of NumResults.

public static CXCompletionResult.Buffer
nResults(long struct)

Unsafe version of Results.

public int
NumResults()

the number of code-completion results stored in the Results array

public CXCompletionResult.Buffer
Results()

the code-completion results

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.

NUMRESULTSback to summary
public static final int NUMRESULTS

The struct member offsets.

RESULTSback to summary
public static final int RESULTS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CXCodeCompleteResultsback to summary
protected CXCodeCompleteResults(long address, ByteBuffer container)
CXCodeCompleteResultsback to summary
public CXCodeCompleteResults(ByteBuffer container)

Creates a CXCodeCompleteResults 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 CXCodeCompleteResults calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CXCodeCompleteResults calloc(MemoryStack stack)

Returns a new CXCodeCompleteResults 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 CXCodeCompleteResults.Buffer calloc(int capacity, MemoryStack stack)

Returns a new CXCodeCompleteResults.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 CXCodeCompleteResults callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static CXCodeCompleteResults.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 CXCodeCompleteResults 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 CXCodeCompleteResults create()

Returns a new CXCodeCompleteResults instance allocated with BufferUtils.

createback to summary
public static CXCodeCompleteResults create(long address)

Returns a new CXCodeCompleteResults instance for the specified memory address.

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

Returns a new CXCodeCompleteResults.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CXCodeCompleteResults.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CXCodeCompleteResults createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static CXCodeCompleteResults malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CXCodeCompleteResults malloc(MemoryStack stack)

Returns a new CXCodeCompleteResults instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new CXCodeCompleteResults.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 CXCodeCompleteResults mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nNumResultsback to summary
public static int nNumResults(long struct)

Unsafe version of NumResults.

nResultsback to summary
public static CXCompletionResult.Buffer nResults(long struct)

Unsafe version of Results.

NumResultsback to summary
public int NumResults()

the number of code-completion results stored in the Results array

Annotations
@NativeType:unsigned
Resultsback to summary
public CXCompletionResult.Buffer Results()

the code-completion results

Annotations
@NativeType:CXCompletionResult *
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 CXCodeCompleteResults.Buffer

extends StructBuffer<CXCodeCompleteResults, CXCodeCompleteResults.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of CXCodeCompleteResults structs.

Field Summary

Modifier and TypeField and Description
private static final CXCodeCompleteResults

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CXCodeCompleteResults.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
protected CXCodeCompleteResults
public int

Returns:

the value of the CXCodeCompleteResults#NumResults field.
NumResults
()

public CXCompletionResult.Buffer

Returns:

a CXCompletionResult.Buffer view of the struct array pointed to by the CXCodeCompleteResults#Results field.
Results
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final CXCodeCompleteResults ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected CXCodeCompleteResults getElementFactory()

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

Annotations
@Override
NumResultsback to summary
public int NumResults()
Returns:int

the value of the CXCodeCompleteResults#NumResults field.

Annotations
@NativeType:unsigned
Resultsback to summary
public CXCompletionResult.Buffer Results()
Returns:CXCompletionResult.Buffer

a CXCompletionResult.Buffer view of the struct array pointed to by the CXCodeCompleteResults#Results field.

Annotations
@NativeType:CXCompletionResult *
selfback to summary
protected CXCodeCompleteResults.Buffer self()

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

Annotations
@Override