/* * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved. * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. * * * * * * * * * * * * * * * * * * * * */ #ifndef _JAVASOFT_JAWT_H_ #define _JAVASOFT_JAWT_H_ #include "jni.h" #ifdef __cplusplus extern "C" { #endif /* * AWT native interface. * * The AWT native interface allows a native C or C++ application a means * by which to access native structures in AWT. This is to facilitate moving * legacy C and C++ applications to Java and to target the needs of the * developers who need to do their own native rendering to canvases * for performance or other reasons. * * Conversely it also provides mechanisms for an application which already * has a native window to provide that to AWT for AWT rendering. * * Since every platform may be different in its native data structures * and APIs for windowing systems the application must necessarily * provided per-platform source and compile and deliver per-platform * native code to use this API. * * These interfaces are not part of the Java SE specification and * a VM is not required to implement this API. However it is strongly * recommended that all implementations which support headful AWT * also support these interfaces. * */ /* * AWT Native Drawing Surface (JAWT_DrawingSurface). * * For each platform, there is a native drawing surface structure. This * platform-specific structure can be found in jawt_md.h. It is recommended * that additional platforms follow the same model. It is also recommended * that VMs on all platforms support the existing structures in jawt_md.h. * ******************* * EXAMPLE OF USAGE: ******************* * * In Win32, a programmer wishes to access the HWND of a canvas to perform * native rendering into it. The programmer has declared the paint() method * for their canvas subclass to be native: * * * MyCanvas.java: * * import java.awt.*; * * public class MyCanvas extends Canvas { * * static { * System.loadLibrary("mylib"); * } * * public native void paint(Graphics g); * } * * * myfile.c: * * #include "jawt_md.h" * #include * * JNIEXPORT void JNICALL * Java_MyCanvas_paint(JNIEnv* env, jobject canvas, jobject graphics) * { * JAWT awt; * JAWT_DrawingSurface* ds; * JAWT_DrawingSurfaceInfo* dsi; * JAWT_Win32DrawingSurfaceInfo* dsi_win; * jboolean result; * jint lock; * * // Get the AWT. Request version 9 to access features in that release. * awt.version = JAWT_VERSION_9; * result = JAWT_GetAWT(env, &awt); * assert(result != JNI_FALSE); * * // Get the drawing surface * ds = awt.GetDrawingSurface(env, canvas); * assert(ds != NULL); * * // Lock the drawing surface * lock = ds->Lock(ds); * assert((lock & JAWT_LOCK_ERROR) == 0); * * // Get the drawing surface info * dsi = ds->GetDrawingSurfaceInfo(ds); * * // Get the platform-specific drawing info * dsi_win = (JAWT_Win32DrawingSurfaceInfo*)dsi->platformInfo; * * ////////////////////////////// * // !!! DO PAINTING HERE !!! // * ////////////////////////////// * * // Free the drawing surface info * ds->FreeDrawingSurfaceInfo(dsi); * * // Unlock the drawing surface * ds->Unlock(ds); * * // Free the drawing surface * awt.FreeDrawingSurface(ds); * } * */ /* * JAWT_Rectangle * Structure for a native rectangle. */ typedef struct jawt_Rectangle { jint x; jint y; jint width; jint height; } JAWT_Rectangle; struct jawt_DrawingSurface; /* * JAWT_DrawingSurfaceInfo * Structure for containing the underlying drawing information of a component. */ typedef struct jawt_DrawingSurfaceInfo { /* * Pointer to the platform-specific information. This can be safely * cast to a JAWT_Win32DrawingSurfaceInfo on Windows or a * JAWT_X11DrawingSurfaceInfo on Linux and Solaris. On Mac OS X this is a * pointer to a NSObject that conforms to the JAWT_SurfaceLayers * protocol. See jawt_md.h for details. */ void* platformInfo; /* Cached pointer to the underlying drawing surface */ struct jawt_DrawingSurface* ds; /* Bounding rectangle of the drawing surface */ JAWT_Rectangle bounds; /* Number of rectangles in the clip */ jint clipSize; /* Clip rectangle array */ JAWT_Rectangle* clip; } JAWT_DrawingSurfaceInfo; #define JAWT_LOCK_ERROR 0x00000001 #define JAWT_LOCK_CLIP_CHANGED 0x00000002 #define JAWT_LOCK_BOUNDS_CHANGED 0x00000004 #define JAWT_LOCK_SURFACE_CHANGED 0x00000008 /* * JAWT_DrawingSurface * Structure for containing the underlying drawing information of a component. * All operations on a JAWT_DrawingSurface MUST be performed from the same * thread as the call to GetDrawingSurface. */ typedef struct jawt_DrawingSurface { /* * Cached reference to the Java environment of the calling thread. * If Lock(), Unlock(), GetDrawingSurfaceInfo() or * FreeDrawingSurfaceInfo() are called from a different thread, * this data member should be set before calling those functions. */ JNIEnv* env; /* Cached reference to the target object */ jobject target; /* * Lock the surface of the target component for native rendering. * When finished drawing, the surface must be unlocked with * Unlock(). This function returns a bitmask with one or more of the * following values: * * JAWT_LOCK_ERROR - When an error has occurred and the surface could not * be locked. * * JAWT_LOCK_CLIP_CHANGED - When the clip region has changed. * * JAWT_LOCK_BOUNDS_CHANGED - When the bounds of the surface have changed. * * JAWT_LOCK_SURFACE_CHANGED - When the surface itself has changed */ jint (JNICALL *Lock) (struct jawt_DrawingSurface* ds); /* * Get the drawing surface info. * The value returned may be cached, but the values may change if * additional calls to Lock() or Unlock() are made. * Lock() must be called before this can return a valid value. * Returns NULL if an error has occurred. * When finished with the returned value, FreeDrawingSurfaceInfo must be * called. */ JAWT_DrawingSurfaceInfo* (JNICALL *GetDrawingSurfaceInfo) (struct jawt_DrawingSurface* ds); /* * Free the drawing surface info. */ void (JNICALL *FreeDrawingSurfaceInfo) (JAWT_DrawingSurfaceInfo* dsi); /* * Unlock the drawing surface of the target component for native rendering. */ void (JNICALL *Unlock) (struct jawt_DrawingSurface* ds); } JAWT_DrawingSurface; /* * JAWT * Structure for containing native AWT functions. */ typedef struct jawt { /* * Version of this structure. This must always be set before * calling JAWT_GetAWT(). It affects the functions returned. * Must be one of the known pre-defined versions. */ jint version; /* * Return a drawing surface from a target jobject. This value * may be cached. * Returns NULL if an error has occurred. * Target must be a java.awt.Component (should be a Canvas * or Window for native rendering). * FreeDrawingSurface() must be called when finished with the * returned JAWT_DrawingSurface. */ JAWT_DrawingSurface* (JNICALL *GetDrawingSurface) (JNIEnv* env, jobject target); /* * Free the drawing surface allocated in GetDrawingSurface. */ void (JNICALL *FreeDrawingSurface) (JAWT_DrawingSurface* ds); /* * Since 1.4 * Locks the entire AWT for synchronization purposes */ void (JNICALL *Lock)(JNIEnv* env); /* * Since 1.4 * Unlocks the entire AWT for synchronization purposes */ void (JNICALL *Unlock)(JNIEnv* env); /* * Since 1.4 * Returns a reference to a java.awt.Component from a native * platform handle. On Windows, this corresponds to an HWND; * on Solaris and Linux, this is a Drawable. For other platforms, * see the appropriate machine-dependent header file for a description. * The reference returned by this function is a local * reference that is only valid in this environment. * This function returns a NULL reference if no component could be * found with matching platform information. */ jobject (JNICALL *GetComponent)(JNIEnv* env, void* platformInfo); /** * Since 9 * Creates a java.awt.Frame placed in a native container. Container is * referenced by the native platform handle. For example on Windows this * corresponds to an HWND. For other platforms, see the appropriate * machine-dependent header file for a description. The reference returned * by this function is a local reference that is only valid in this * environment. This function returns a NULL reference if no frame could be * created with matching platform information. */ jobject (JNICALL *CreateEmbeddedFrame) (JNIEnv *env, void* platformInfo); /** * Since 9 * Moves and resizes the embedded frame. The new location of the top-left * corner is specified by x and y parameters relative to the native parent * component. The new size is specified by width and height. * * The embedded frame should be created by CreateEmbeddedFrame() method, or * this function will not have any effect. * * java.awt.Component.setLocation() and java.awt.Component.setBounds() for * EmbeddedFrame really don't move it within the native parent. These * methods always locate the embedded frame at (0, 0) for backward * compatibility. To allow moving embedded frames this method was * introduced, and it works just the same way as setLocation() and * setBounds() for usual, non-embedded components. * * Using usual get/setLocation() and get/setBounds() together with this new * method is not recommended. */ void (JNICALL *SetBounds) (JNIEnv *env, jobject embeddedFrame, jint x, jint y, jint w, jint h); /** * Since 9 * Synthesize a native message to activate or deactivate an EmbeddedFrame * window depending on the value of parameter doActivate, if "true" * activates the window; otherwise, deactivates the window. * * The embedded frame should be created by CreateEmbeddedFrame() method, or * this function will not have any effect. */ void (JNICALL *SynthesizeWindowActivation) (JNIEnv *env, jobject embeddedFrame, jboolean doActivate); } JAWT; /* * Get the AWT native structure. This function returns JNI_FALSE if * an error occurs. */ _JNI_IMPORT_OR_EXPORT_ jboolean JNICALL JAWT_GetAWT(JNIEnv* env, JAWT* awt); /* * Specify one of these constants as the JAWT.version * Specifying an earlier version will limit the available functions to * those provided in that earlier version of JAWT. * See the "Since" note on each API. Methods with no "Since" * may be presumed to be present in JAWT_VERSION_1_3. */ #define JAWT_VERSION_1_3 0x00010003 #define JAWT_VERSION_1_4 0x00010004 #define JAWT_VERSION_1_7 0x00010007 #define JAWT_VERSION_9 0x00090000 #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !_JAVASOFT_JAWT_H_ */