org.lwjgl.llvm.LLVMOrcMaterializationUnitMaterializeFunctionI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lwjgl-llvm Show documentation

A collection of modular and reusable compiler and toolchain technologies.

The newest version!

/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.llvm;

import org.lwjgl.system.*;
import org.lwjgl.system.libffi.*;

import static org.lwjgl.system.APIUtil.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.libffi.LibFFI.*;

/**
 * Instances of this interface may be passed to the {@link LLVMOrc#LLVMOrcCreateCustomMaterializationUnit OrcCreateCustomMaterializationUnit} method.
 * 
 * Type
 * 
 * 
 * void (*{@link #invoke}) (
 *     void *Ctx,
 *     LLVMOrcMaterializationResponsibilityRef MR
 * )
 */
@FunctionalInterface
@NativeType("LLVMOrcMaterializationUnitMaterializeFunction")
public interface LLVMOrcMaterializationUnitMaterializeFunctionI extends CallbackI {

    FFICIF CIF = apiCreateCIF(
        FFI_DEFAULT_ABI,
        ffi_type_void,
        ffi_type_pointer, ffi_type_pointer
    );

    @Override
    default FFICIF getCallInterface() { return CIF; }

    @Override
    default void callback(long ret, long args) {
        invoke(
            memGetAddress(memGetAddress(args)),
            memGetAddress(memGetAddress(args + POINTER_SIZE))
        );
    }

    /**
     * A {@code MaterializationUnit} materialize callback.
     * 
     * Ownership of the {@code Ctx} and {@code MR} arguments passes to the callback which must adhere to the {@code LLVMOrcMaterializationResponsibilityRef}
     * contract (see comment for that type).
     * 
     * If this callback is called then the {@link LLVMOrcMaterializationUnitDestroyFunction} callback will NOT be called.
     */
    void invoke(@NativeType("void *") long Ctx, @NativeType("LLVMOrcMaterializationResponsibilityRef") long MR);

}