org.graalvm.nativeimage.c.struct.CStruct Maven / Gradle / Ivy
/*
* Copyright (c) 2013, 2017, 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. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* 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 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.nativeimage.c.CContext;
import org.graalvm.word.PointerBase;
/**
* Denotes Java interface that imports a C struct. The interface must extend {@link PointerBase},
* i.e., it is a word type. There is never a Java class that implements the interface.
*
* Field accesses are done via interface methods that are annotated with {@link CField},
* {@link CFieldAddress}, or {@link CFieldOffset}. All calls of the interface methods are replaced
* with the appropriate memory or address arithmetic operations.
*
* The annotated interface, or an outer class that contains the interface, must be annotated with
* {@link CContext}.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface CStruct {
/**
* Specifies the name of the imported C struct type. If no name is provided, the type name is
* used as the struct name.
*/
String value() default "";
/**
* If marked as incomplete, we will not try to determine the size of the struct.
*/
boolean isIncomplete() default false;
/**
* Add the C "struct" keyword to the name specified in {@link #value()}.
*/
boolean addStructKeyword() default false;
}