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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.lwjgl.llvm Show documentation
LWJGL OSGi bundle (LLVM bindings)
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 javax.annotation.*;

import org.lwjgl.system.*;

import static org.lwjgl.system.MemoryUtil.*;

/**
 * Instances of this class may be passed to the {@link ClangIndex#clang_getInclusions getInclusions} method.
 * 
 * Type
 * 
 * 
 * void (*{@link #invoke}) (
 *     CXFile included_file,
 *     CXSourceLocation *inclusion_stack,
 *     unsigned include_len,
 *     CXClientData client_data
 * )
 */
public abstract class CXInclusionVisitor extends Callback implements CXInclusionVisitorI {

    /**
     * Creates a {@code CXInclusionVisitor} instance from the specified function pointer.
     *
     * @return the new {@code CXInclusionVisitor}
     */
    public static CXInclusionVisitor create(long functionPointer) {
        CXInclusionVisitorI instance = Callback.get(functionPointer);
        return instance instanceof CXInclusionVisitor
            ? (CXInclusionVisitor)instance
            : new Container(functionPointer, instance);
    }

    /** Like {@link #create(long) create}, but returns {@code null} if {@code functionPointer} is {@code NULL}. */
    @Nullable
    public static CXInclusionVisitor createSafe(long functionPointer) {
        return functionPointer == NULL ? null : create(functionPointer);
    }

    /** Creates a {@code CXInclusionVisitor} instance that delegates to the specified {@code CXInclusionVisitorI} instance. */
    public static CXInclusionVisitor create(CXInclusionVisitorI instance) {
        return instance instanceof CXInclusionVisitor
            ? (CXInclusionVisitor)instance
            : new Container(instance.address(), instance);
    }

    protected CXInclusionVisitor() {
        super(CIF);
    }

    CXInclusionVisitor(long functionPointer) {
        super(functionPointer);
    }

    private static final class Container extends CXInclusionVisitor {

        private final CXInclusionVisitorI delegate;

        Container(long functionPointer, CXInclusionVisitorI delegate) {
            super(functionPointer);
            this.delegate = delegate;
        }

        @Override
        public void invoke(long included_file, long inclusion_stack, int include_len, long client_data) {
            delegate.invoke(included_file, inclusion_stack, include_len, client_data);
        }

    }

}