/*
 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.graal.api.code;

/**
 * Wraps the raw function pointer value.
 * <p>
 * Use the {@code NativeFunctionInterface} to resolve a {@code NativeFunctionHandle} of this pointer
 * to invoke the native target function.
 */
public interface NativeFunctionPointer {

    /**
     * Returns whether the pointer is valid.
     * 
     * @return true if the pointer is valid
     */
    boolean isValid();

    /**
     * Returns function pointer as raw value.
     * 
     * @return raw value of function pointer
     */
    long asRawValue();

    /**
     * Returns the name of the function.
     * 
     * @return name of the function
     */
    String getFunctionName();

}