Top Description Inners Methods
org.graalvm.nativeimage.c

public @Interface CContext

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE
@Platforms:HOSTED_ONLY
Imports
java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target, java.util.Collections, .List, org.graalvm.nativeimage.Platform, .Platforms, org.graalvm.nativeimage.c.function.CLibrary
Defines the context for most other annotations of the C interface: the C header files that need to be imported, the C macros that need to be defined to properly configure these headers, and additional flags that should be passed to the C compiler when analyzing the definitions.
Since
19.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
CContext.Directives

Describes a C context.

Method Summary

Modifier and TypeMethod and Description
public Class<? extends CContext.Directives>
value()

Specifies which directives are used with the annotated element.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public Class<? extends CContext.Directives> value()

Specifies which directives are used with the annotated element.

Since
19.0
org.graalvm.nativeimage.c back to summary

public Interface CContext.Directives

Describes a C context.
Since
19.0

Method Summary

Modifier and TypeMethod and Description
public default List<String>
getHeaderFiles()

All header files used in this context.

public default List<String>
getLibraries()

Returns a collection of libraries.

public default List<String>
getLibraryPaths()

Returns a list of library paths.

public default List<String>
getMacroDefinitions()

Unparameterized macro-definitions.

public default List<String>
getOptions()

Returns options to be passed to the C compiler when processing the directives.

public default boolean
isInConfiguration()

This method is called immediately after the constructor, to check whether the context is part of the configuration or not.

Method Detail

getHeaderFilesback to summary
public default List<String> getHeaderFiles()

All header files used in this context. C allows two kinds of imports: header files can be surrounded with <...>, or "...". One of them must be used for every element in the returned list.

Since
19.0
getLibrariesback to summary
public default List<String> getLibraries()

Returns a collection of libraries. They are treated the same way as libraries added via the CLibrary annotation.

Since
19.0
getLibraryPathsback to summary
public default List<String> getLibraryPaths()

Returns a list of library paths.

Since
19.0
getMacroDefinitionsback to summary
public default List<String> getMacroDefinitions()

Unparameterized macro-definitions. Each entry is in the form of <macro-name> or <macro-name> <macro-value>.

Since
19.0
getOptionsback to summary
public default List<String> getOptions()

Returns options to be passed to the C compiler when processing the directives. For example, the option "-Ipath" can be used to add a path for the lookup of header files.

Since
19.0
isInConfigurationback to summary
public default boolean isInConfiguration()

This method is called immediately after the constructor, to check whether the context is part of the configuration or not. If this method returns false, all elements registered inside this context are ignored.

Since
19.0