Top Description Inners Fields Constructors Methods
org.lwjgl.llvm

public Class CXCompletionResult

extends Struct<CXCompletionResult>
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 single result of code completion.

Layout


struct CXCompletionResult {
    enum CXCursorKind CursorKind;
    CXCompletionString CompletionString;
}

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
COMPLETIONSTRING

The struct member offsets.

public static final int
CURSORKIND

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

public
CXCompletionResult(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CXCompletionResult
calloc()

Returns a new CXCompletionResult instance allocated with memCalloc.

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

Returns a new CXCompletionResult.Buffer instance allocated with memCalloc.

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

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

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

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

public static CXCompletionResult
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public long
CompletionString()

the code-completion string that describes how to insert this code-completion result into the editing buffer

protected CXCompletionResult
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 CXCompletionResult
create()

Returns a new CXCompletionResult instance allocated with BufferUtils.

public static CXCompletionResult
create(long address)

Returns a new CXCompletionResult instance for the specified memory address.

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

Returns a new CXCompletionResult.Buffer instance allocated with BufferUtils.

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

Create a CXCompletionResult.Buffer instance at the specified memory.

public static CXCompletionResult
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
CursorKind()

the kind of entity that this completion refers to.

public static CXCompletionResult
malloc()

Returns a new CXCompletionResult instance allocated with memAlloc.

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

Returns a new CXCompletionResult.Buffer instance allocated with memAlloc.

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

Returns a new CXCompletionResult instance allocated on the specified MemoryStack.

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

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

public static CXCompletionResult
mallocStack()

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

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

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

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

Unsafe version of CompletionString.

public static int
nCursorKind(long struct)

Unsafe version of CursorKind.

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.

COMPLETIONSTRINGback to summary
public static final int COMPLETIONSTRING

The struct member offsets.

CURSORKINDback to summary
public static final int CURSORKIND

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CXCompletionResultback to summary
protected CXCompletionResult(long address, ByteBuffer container)
CXCompletionResultback to summary
public CXCompletionResult(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CXCompletionResult calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
CompletionStringback to summary
public long CompletionString()

the code-completion string that describes how to insert this code-completion result into the editing buffer

Annotations
@NativeType:CXCompletionString
createback to summary
protected CXCompletionResult 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 CXCompletionResult create()

Returns a new CXCompletionResult instance allocated with BufferUtils.

createback to summary
public static CXCompletionResult create(long address)

Returns a new CXCompletionResult instance for the specified memory address.

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

Returns a new CXCompletionResult.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CXCompletionResult.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CXCompletionResult createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
CursorKindback to summary
public int CursorKind()

the kind of entity that this completion refers to.

The cursor kind will be a macro, keyword, or a declaration (one of the *Decl cursor kinds), describing the entity that the completion is referring to.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CXCompletionResult malloc(MemoryStack stack)

Returns a new CXCompletionResult instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nCompletionStringback to summary
public static long nCompletionString(long struct)

Unsafe version of CompletionString.

nCursorKindback to summary
public static int nCursorKind(long struct)

Unsafe version of CursorKind.

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 CXCompletionResult.Buffer

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

An array of CXCompletionResult structs.

Field Summary

Modifier and TypeField and Description
private static final CXCompletionResult

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CXCompletionResult.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 long

Returns:

the value of the CXCompletionResult#CompletionString field.
CompletionString
()

public int

Returns:

the value of the CXCompletionResult#CursorKind field.
CursorKind
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final CXCompletionResult ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

CompletionStringback to summary
public long CompletionString()
Returns:long

the value of the CXCompletionResult#CompletionString field.

Annotations
@NativeType:CXCompletionString
CursorKindback to summary
public int CursorKind()
Returns:int

the value of the CXCompletionResult#CursorKind field.

Annotations
@NativeType:enum CXCursorKind
getElementFactoryback to summary
protected CXCompletionResult getElementFactory()

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

Annotations
@Override
selfback to summary
protected CXCompletionResult.Buffer self()

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

Annotations
@Override