Package org.lwjgl.llvm

Class CXSourceLocation

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<CXSourceLocation>

org.lwjgl.llvm.CXSourceLocation

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class CXSourceLocation
extends Struct<CXSourceLocation>
implements NativeResource

Identifies a specific source location within a translation unit.

Use getExpansionLocation or getSpellingLocation to map a source location to a particular file, line, and column.

Layout

 struct CXSourceLocation {
     void const * ptr_data[2];
     unsigned int_data;
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	INT_DATA	The struct member offsets.
static final int	PTR_DATA	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CXSourceLocation	calloc()	Returns a new CXSourceLocation instance allocated with memCalloc.
static CXSourceLocation.Buffer	calloc(int capacity)	Returns a new CXSourceLocation.Buffer instance allocated with memCalloc.
static CXSourceLocation.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new CXSourceLocation.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static CXSourceLocation	calloc(MemoryStack stack)	Returns a new CXSourceLocation instance allocated on the specified MemoryStack and initializes all its bits to zero.
static CXSourceLocation	callocStack()	Deprecated.
static CXSourceLocation.Buffer	callocStack(int capacity)	Deprecated.
static CXSourceLocation.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static CXSourceLocation	callocStack(MemoryStack stack)	Deprecated.
static CXSourceLocation	create()	Returns a new CXSourceLocation instance allocated with BufferUtils.
static CXSourceLocation.Buffer	create(int capacity)	Returns a new CXSourceLocation.Buffer instance allocated with BufferUtils.
static CXSourceLocation	create(long address)	Returns a new CXSourceLocation instance for the specified memory address.
static CXSourceLocation.Buffer	create(long address, int capacity)	Create a CXSourceLocation.Buffer instance at the specified memory.
static CXSourceLocation	createSafe(long address)	Like create, but returns null if address is NULL.
static CXSourceLocation.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	int_data()
static CXSourceLocation	malloc()	Returns a new CXSourceLocation instance allocated with memAlloc.
static CXSourceLocation.Buffer	malloc(int capacity)	Returns a new CXSourceLocation.Buffer instance allocated with memAlloc.
static CXSourceLocation.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new CXSourceLocation.Buffer instance allocated on the specified MemoryStack.
static CXSourceLocation	malloc(MemoryStack stack)	Returns a new CXSourceLocation instance allocated on the specified MemoryStack.
static CXSourceLocation	mallocStack()	Deprecated.
static CXSourceLocation.Buffer	mallocStack(int capacity)	Deprecated.
static CXSourceLocation.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static CXSourceLocation	mallocStack(MemoryStack stack)	Deprecated.
static int	nint_data(long struct)	Unsafe version of int_data().
static PointerBuffer	nptr_data(long struct)	Unsafe version of ptr_data().
static long	nptr_data(long struct, int index)	Unsafe version of ptr_data.
PointerBuffer	ptr_data()
long	ptr_data(int index)
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

PTR_DATA

public static final int PTR_DATA

The struct member offsets.

INT_DATA

public static final int INT_DATA

The struct member offsets.

Constructor Details

CXSourceLocation

public CXSourceLocation(ByteBuffer container)

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

ptr_data

public PointerBuffer ptr_data()

Returns:

a PointerBuffer view of the ptr_data field.

ptr_data

public long ptr_data(int index)

Returns:

the value at the specified index of the ptr_data field.

int_data

public int int_data()

Returns:

the value of the int_data field.

malloc

public static CXSourceLocation malloc()

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

calloc

public static CXSourceLocation calloc()

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

create

public static CXSourceLocation create()

Returns a new CXSourceLocation instance allocated with BufferUtils.

create

public static CXSourceLocation create(long address)

Returns a new CXSourceLocation instance for the specified memory address.

createSafe

@Nullable
public static CXSourceLocation createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static CXSourceLocation.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static CXSourceLocation.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static CXSourceLocation.Buffer create(int capacity)

Returns a new CXSourceLocation.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a CXSourceLocation.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static CXSourceLocation mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static CXSourceLocation callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static CXSourceLocation mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static CXSourceLocation callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static CXSourceLocation.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static CXSourceLocation.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static CXSourceLocation.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static CXSourceLocation.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static CXSourceLocation malloc(MemoryStack stack)

Returns a new CXSourceLocation instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static CXSourceLocation calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static CXSourceLocation.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static CXSourceLocation.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nptr_data

public static PointerBuffer nptr_data(long struct)

Unsafe version of ptr_data().

nptr_data

public static long nptr_data(long struct,
 int index)

Unsafe version of ptr_data.

nint_data

public static int nint_data(long struct)

Unsafe version of int_data().