Top Description Inners Fields Constructors Methods
org.lwjgl.llvm

public Class CXComment

extends Struct<CXComment>
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 parsed comment.

Layout


struct CXComment {
    void const * ASTNode;
    CXTranslationUnit TranslationUnit;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CXComment.Buffer

An array of CXComment structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ASTNODE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TRANSLATIONUNIT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
CXComment(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the ASTNode field.
ASTNode
()

public static CXComment
calloc()

Returns a new CXComment instance allocated with memCalloc.

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

Returns a new CXComment.Buffer instance allocated with memCalloc.

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

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

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

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

public static CXComment
callocStack()

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

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

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

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

Returns a new CXComment instance allocated with BufferUtils.

public static CXComment
create(long address)

Returns a new CXComment instance for the specified memory address.

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

Returns a new CXComment.Buffer instance allocated with BufferUtils.

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

Create a CXComment.Buffer instance at the specified memory.

public static CXComment
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static CXComment
malloc()

Returns a new CXComment instance allocated with memAlloc.

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

Returns a new CXComment.Buffer instance allocated with memAlloc.

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

Returns a new CXComment instance allocated on the specified MemoryStack.

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

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

public static CXComment
mallocStack()

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

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

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

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

Unsafe version of ASTNode.

public static long
nTranslationUnit(long struct)

Unsafe version of TranslationUnit.

public int
sizeof()

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

Returns sizeof(struct).
public long

Returns:

the value of the TranslationUnit field.
TranslationUnit
()

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.

ASTNODEback to summary
public static final int ASTNODE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TRANSLATIONUNITback to summary
public static final int TRANSLATIONUNIT

The struct member offsets.

Constructor Detail

CXCommentback to summary
protected CXComment(long address, ByteBuffer container)
CXCommentback to summary
public CXComment(ByteBuffer container)

Creates a CXComment 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

ASTNodeback to summary
public long ASTNode()
Returns:long

the value of the ASTNode field.

Annotations
@NativeType:void const *
callocback to summary
public static CXComment calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CXComment calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new CXComment instance allocated with BufferUtils.

createback to summary
public static CXComment create(long address)

Returns a new CXComment instance for the specified memory address.

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

Returns a new CXComment.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CXComment.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CXComment createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CXComment malloc(MemoryStack stack)

Returns a new CXComment instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nASTNodeback to summary
public static long nASTNode(long struct)

Unsafe version of ASTNode.

nTranslationUnitback to summary
public static long nTranslationUnit(long struct)

Unsafe version of TranslationUnit.

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
TranslationUnitback to summary
public long TranslationUnit()
Returns:long

the value of the TranslationUnit field.

Annotations
@NativeType:CXTranslationUnit
org.lwjgl.llvm back to summary

public Class CXComment.Buffer

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

An array of CXComment structs.

Field Summary

Modifier and TypeField and Description
private static final CXComment

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CXComment.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 ASTNode field.
ASTNode
()

protected CXComment
protected CXComment.Buffer
public long

Returns:

the value of the TranslationUnit field.
TranslationUnit
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CXComment ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

ASTNodeback to summary
public long ASTNode()
Returns:long

the value of the ASTNode field.

Annotations
@NativeType:void const *
getElementFactoryback to summary
protected CXComment getElementFactory()

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

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

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

Annotations
@Override
TranslationUnitback to summary
public long TranslationUnit()
Returns:long

the value of the TranslationUnit field.

Annotations
@NativeType:CXTranslationUnit