/*
 * Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.graalvm.nativeimage.c.struct;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.graalvm.word.LocationIdentity;
import org.graalvm.word.PointerBase;
import org.graalvm.word.WordBase;

Denotes Java interface that imports a C pointer type. The interface must extend PointerBase, i.e., it is a word type. There is never a Java class that implements the interface. 
 If the method has a non-void return type that is not the annotated interface, it is a read-method of the pointer. Calls of the method are replaced with a memory read. The possible signatures are ValueType read([IntType index], [LocationIdentity locationIdentity]); 
 If the method has the return type void, it is a write-method of the pointer. Calls of the method are replaced with a memory write. The possible signatures are void write([IntType index], ValueType value, [LocationIdentity locationIdentity]); 
 If the return type of the method is the annotated interface, it is an address computation for an array access. Calls of the method are replaced with address arithmetic. The possible signatures are PointerType addressOf(IntType index); 

The receiver is the pointer that is accessed, i.e., the base address of the memory access.
 The ValueType must be the Java-equivalent of the C type used in the pointer definition. 
 The optional parameter index (always the first parameter when it is present) denotes an index, i.e., the receiver is treated as an array of the pointers. The type must be a primitive integer type or a word type. Address arithmetic is used to scale the index with the size of the value type. 
 The optional parameter locationIdentity specifies the LocationIdentity to be used for the memory access. Two memory accesses with two different location identities are guaranteed to not alias. The parameter cannot be used together with the UniqueLocationIdentity annotation, which is another way of providing a location identity for the memory access. 
Since:
19.0/**
 * Denotes Java interface that imports a C pointer type. The interface must extend
 * {@link PointerBase}, i.e., it is a word type. There is never a Java class that implements the
 * interface.
 * <p>
 * If the method has a non-void return type that is not the annotated interface, it is a read-method
 * of the pointer. Calls of the method are replaced with a memory read. The possible signatures are
 * {@code ValueType read([IntType index], [LocationIdentity locationIdentity]);}
 * <p>
 * If the method has the return type void, it is a write-method of the pointer. Calls of the method
 * are replaced with a memory write. The possible signatures are
 * {@code void write([IntType index], ValueType value, [LocationIdentity locationIdentity]);}
 * <p>
 * If the return type of the method is the annotated interface, it is an address computation for an
 * array access. Calls of the method are replaced with address arithmetic. The possible signatures
 * are {@code PointerType addressOf(IntType index);}
 * <p>
 * The receiver is the pointer that is accessed, i.e., the base address of the memory access.
 * <p>
 * The {@code ValueType} must be the Java-equivalent of the C type used in the pointer definition.
 * <p>
 * The optional parameter {@code index} (always the first parameter when it is present) denotes an
 * index, i.e., the receiver is treated as an array of the pointers. The type must be a primitive
 * integer type or a {@link WordBase word type}. Address arithmetic is used to scale the index with
 * the size of the value type.
 * <p>
 * The optional parameter {@code locationIdentity} specifies the {@link LocationIdentity} to be used
 * for the memory access. Two memory accesses with two different location identities are guaranteed
 * to not alias. The parameter cannot be used together with the {@link UniqueLocationIdentity}
 * annotation, which is another way of providing a location identity for the memory access.
 *
 * @since 19.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface CPointerTo {

    
The value type, as a reference to a Java interface that is either annotated with CStruct or CPointerTo. 
 Exactly one of the properties value() and nameOfCType() must be specified. 
Since:
19.0/**
     * The value type, as a reference to a Java interface that is either annotated with
     * {@link CStruct} or {@link CPointerTo}.
     * <p>
     * Exactly one of the properties {@link #value()} and {@link CPointerTo#nameOfCType()} must be
     * specified.
     *
     * @since 19.0
     */
    Class<? extends WordBase> value() default WordBase.class;

    
The value type, as C type name.
 Exactly one of the properties value() and nameOfCType() must be specified. 
Since:
19.0/**
     * The value type, as C type name.
     * <p>
     * Exactly one of the properties {@link #value()} and {@link CPointerTo#nameOfCType()} must be
     * specified.
     *
     * @since 19.0
     */
    String nameOfCType() default "";
}