/*

 * 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.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

#ifdef HEADLESS

    #error This file should not be included in headless library

#endif

#include "awt_p.h"

#include "awt_Component.h"

#include "awt_GraphicsEnv.h"

#define XK_MISCELLANY

#include <X11/keysymdef.h>

#include <X11/Intrinsic.h>

#include <X11/Xutil.h>

#include <X11/Xmd.h>

#include <X11/extensions/xtestext1.h>

#include <X11/extensions/XTest.h>

#include <X11/extensions/XInput.h>

#include <X11/extensions/XI.h>

#include <jni.h>

#include "robot_common.h"

#include "canvas.h"

#include "wsutils.h"

#include "list.h"

#include "multiVis.h"

#ifdef __linux__

#include <sys/socket.h>

#endif

extern struct X11GraphicsConfigIDs x11GraphicsConfigIDs;

// 2 would be more correct, however that's how Robot originally worked

// and tests start to fail if this value is changed

static int32_t num_buttons = 3;

static int32_t isXTestAvailable() {

    int32_t major_opcode, first_event, first_error;

    int32_t  event_basep, error_basep, majorp, minorp;

    int32_t isXTestAvailable;

    /* check if XTest is available */

    isXTestAvailable = XQueryExtension(awt_display, XTestExtensionName, &major_opcode, &first_event, &first_error);

    DTRACE_PRINTLN3("RobotPeer: XQueryExtension(XTEST) returns major_opcode = %d, first_event = %d, first_error = %d",

                    major_opcode, first_event, first_error);

    if (isXTestAvailable) {

        /* check if XTest version is OK */

        XTestQueryExtension(awt_display, &event_basep, &error_basep, &majorp, &minorp);

        DTRACE_PRINTLN4("RobotPeer: XTestQueryExtension returns event_basep = %d, error_basep = %d, majorp = %d, minorp = %d",

                        event_basep, error_basep, majorp, minorp);

        if (majorp < 2 || (majorp == 2 && minorp < 2)) {

            /* bad version*/

            DTRACE_PRINTLN2("XRobotPeer: XTEST version is %d.%d \n", majorp, minorp);

            if (majorp == 2 && minorp == 1) {

                DTRACE_PRINTLN("XRobotPeer: XTEST is 2.1 - no grab is available\n");

            } else {

                isXTestAvailable = False;

            }

        } else {

            /* allow XTest calls even if someone else has the grab; e.g. during

             * a window resize operation. Works only with XTEST2.2*/

            XTestGrabControl(awt_display, True);

        }

    } else {

        DTRACE_PRINTLN("RobotPeer: XTEST extension is unavailable");

    }

    return isXTestAvailable;

}

static void getNumButtons() {

    int32_t major_opcode, first_event, first_error;

    int32_t xinputAvailable;

    int32_t numDevices, devIdx, clsIdx;

    XDeviceInfo* devices;

    XDeviceInfo* aDevice;

    XButtonInfo* bInfo;

    /* 4700242:

     * If XTest is asked to press a non-existant mouse button

     * (i.e. press Button3 on a system configured with a 2-button mouse),

     * then a crash may happen.  To avoid this, we use the XInput

     * extension to query for the number of buttons on the XPointer, and check

     * before calling XTestFakeButtonEvent().

     */

    xinputAvailable = XQueryExtension(awt_display, INAME, &major_opcode, &first_event, &first_error);

    DTRACE_PRINTLN3("RobotPeer: XQueryExtension(XINPUT) returns major_opcode = %d, first_event = %d, first_error = %d",

                    major_opcode, first_event, first_error);

    if (xinputAvailable) {

        devices = XListInputDevices(awt_display, &numDevices);

        for (devIdx = 0; devIdx < numDevices; devIdx++) {

            aDevice = &(devices[devIdx]);

            if (aDevice->use == IsXPointer) {

                for (clsIdx = 0; clsIdx < aDevice->num_classes; clsIdx++) {

                    if (aDevice->inputclassinfo[clsIdx].class == ButtonClass) {

                        bInfo = (XButtonInfo*)(&(aDevice->inputclassinfo[clsIdx]));

                        num_buttons = bInfo->num_buttons;

                        DTRACE_PRINTLN1("RobotPeer: XPointer has %d buttons", num_buttons);

                        break;

                    }

                }

                break;

            }

        }

        XFreeDeviceList(devices);

    }

    else {

        DTRACE_PRINTLN1("RobotPeer: XINPUT extension is unavailable, assuming %d mouse buttons", num_buttons);

    }

}

static XImage *getWindowImage(Display * display, Window window,

                              int32_t x, int32_t y,

                              int32_t w, int32_t h) {

    XImage         *image;

    int32_t        transparentOverlays;

    int32_t        numVisuals;

    XVisualInfo    *pVisuals;

    int32_t        numOverlayVisuals;

    OverlayInfo    *pOverlayVisuals;

    int32_t        numImageVisuals;

    XVisualInfo    **pImageVisuals;

    list_ptr       vis_regions;    /* list of regions to read from */

    list_ptr       vis_image_regions ;

    int32_t        allImage = 0 ;

    int32_t        format = ZPixmap;

    /* prevent user from moving stuff around during the capture */

    XGrabServer(display);

    /*

     * The following two functions live in multiVis.c-- they are pretty

     * much verbatim taken from the source to the xwd utility from the

     * X11 source. This version of the xwd source was somewhat better written

     * for reuse compared to Sun's version.

     *

     *        ftp.x.org/pub/R6.3/xc/programs/xwd

     *

     * We use these functions since they do the very tough job of capturing

     * the screen correctly when it contains multiple visuals. They take into

     * account the depth/colormap of each visual and produce a capture as a

     * 24-bit RGB image so we don't have to fool around with colormaps etc.

     */

    GetMultiVisualRegions(

        display,

        window,

        x, y, w, h,

        &transparentOverlays,

        &numVisuals,

        &pVisuals,

        &numOverlayVisuals,

        &pOverlayVisuals,

        &numImageVisuals,

        &pImageVisuals,

        &vis_regions,

        &vis_image_regions,

        &allImage );

    image = ReadAreaToImage(

        display,

        window,

        x, y, w, h,

        numVisuals,

        pVisuals,

        numOverlayVisuals,

        pOverlayVisuals,

        numImageVisuals,

        pImageVisuals,

        vis_regions,

        vis_image_regions,

        format,

        allImage );

    /* allow user to do stuff again */

    XUngrabServer(display);

    /* make sure the grab/ungrab is flushed */

    XSync(display, False);

    return image;

}

/*********************************************************************************************/

JNIEXPORT void JNICALL

Java_sun_awt_X11_XRobotPeer_setup (JNIEnv * env, jclass cls) {

    int32_t xtestAvailable;

    DTRACE_PRINTLN("RobotPeer: setup()");

    AWT_LOCK();

    xtestAvailable = isXTestAvailable();

    DTRACE_PRINTLN1("RobotPeer: XTest available = %d", xtestAvailable);

    if (!xtestAvailable) {

        JNU_ThrowByName(env, "java/awt/AWTException", "java.awt.Robot requires your X server support the XTEST extension version 2.2");

        AWT_UNLOCK();

        return;

    }

    getNumButtons();

}

JNIEXPORT void JNICALL

Java_sun_awt_X11_XRobotPeer_getRGBPixelsImpl( JNIEnv *env,

                             jclass cls,

                             jobject xgc,

                             jint x,

                             jint y,

                             jint width,

                             jint height,

                             jintArray pixelArray) {

    XImage *image;

    jint *ary;               /* Array of jints for sending pixel values back

                              * to parent process.

                              */

    Window rootWindow;

    AwtGraphicsConfigDataPtr adata;

    DTRACE_PRINTLN6("RobotPeer: getRGBPixelsImpl(%lx, %d, %d, %d, %d, %x)", xgc, x, y, width, height, pixelArray);

    AWT_LOCK();

    /* avoid a lot of work for empty rectangles */

    if ((width * height) == 0) {

        AWT_UNLOCK();

        return;

    }

    DASSERT(width * height > 0); /* only allow positive size */

    adata = (AwtGraphicsConfigDataPtr) JNU_GetLongFieldAsPtr(env, xgc, x11GraphicsConfigIDs.aData);

    DASSERT(adata != NULL);

    rootWindow = XRootWindow(awt_display, adata->awt_visInfo.screen);

    image = getWindowImage(awt_display, rootWindow, x, y, width, height);

    /* Array to use to crunch around the pixel values */

    ary = (jint *) malloc(width * height * sizeof (jint));

    if (ary == NULL) {

        JNU_ThrowOutOfMemoryError(env, "OutOfMemoryError");

        XDestroyImage(image);

        AWT_UNLOCK();

        return;

    }

    /* convert to Java ARGB pixels */

    for (y = 0; y < height; y++) {

        for (x = 0; x < width; x++) {

            jint pixel = (jint) XGetPixel(image, x, y); /* Note ignore upper

                                                         * 32-bits on 64-bit

                                                         * OSes.

                                                         */

            pixel |= 0xff000000; /* alpha - full opacity */

            ary[(y * width) + x] = pixel;

        }

    }

    (*env)->SetIntArrayRegion(env, pixelArray, 0, height * width, ary);

    free(ary);

    XDestroyImage(image);

    AWT_UNLOCK();

}

JNIEXPORT void JNICALL

Java_sun_awt_X11_XRobotPeer_keyPressImpl (JNIEnv *env,

                         jclass cls,

                         jint keycode) {

    AWT_LOCK();

    DTRACE_PRINTLN1("RobotPeer: keyPressImpl(%i)", keycode);

    XTestFakeKeyEvent(awt_display,

                      XKeysymToKeycode(awt_display, awt_getX11KeySym(keycode)),

                      True,

                      CurrentTime);

    XSync(awt_display, False);

    AWT_UNLOCK();

}

JNIEXPORT void JNICALL

Java_sun_awt_X11_XRobotPeer_keyReleaseImpl (JNIEnv *env,

                           jclass cls,

                           jint keycode) {

    AWT_LOCK();

    DTRACE_PRINTLN1("RobotPeer: keyReleaseImpl(%i)", keycode);

    XTestFakeKeyEvent(awt_display,

                      XKeysymToKeycode(awt_display, awt_getX11KeySym(keycode)),

                      False,

                      CurrentTime);

    XSync(awt_display, False);

    AWT_UNLOCK();

}

JNIEXPORT void JNICALL

Java_sun_awt_X11_XRobotPeer_mouseMoveImpl (JNIEnv *env,

                          jclass cls,

                          jobject xgc,

                          jint root_x,

                          jint root_y) {

    AwtGraphicsConfigDataPtr adata;

    AWT_LOCK();

    DTRACE_PRINTLN3("RobotPeer: mouseMoveImpl(%lx, %i, %i)", xgc, root_x, root_y);

    adata = (AwtGraphicsConfigDataPtr) JNU_GetLongFieldAsPtr(env, xgc, x11GraphicsConfigIDs.aData);

    DASSERT(adata != NULL);

    XWarpPointer(awt_display, None, XRootWindow(awt_display, adata->awt_visInfo.screen), 0, 0, 0, 0, root_x, root_y);

    XSync(awt_display, False);

    AWT_UNLOCK();

}

JNIEXPORT void JNICALL

Java_sun_awt_X11_XRobotPeer_mousePressImpl (JNIEnv *env,

                           jclass cls,

                           jint buttonMask) {

    AWT_LOCK();

    DTRACE_PRINTLN1("RobotPeer: mousePressImpl(%i)", buttonMask);

    if (buttonMask & java_awt_event_InputEvent_BUTTON1_MASK) {

        XTestFakeButtonEvent(awt_display, 1, True, CurrentTime);

    }

    if ((buttonMask & java_awt_event_InputEvent_BUTTON2_MASK) &&

        (num_buttons >= 2)) {

        XTestFakeButtonEvent(awt_display, 2, True, CurrentTime);

    }

    if ((buttonMask & java_awt_event_InputEvent_BUTTON3_MASK) &&

        (num_buttons >= 3)) {

        XTestFakeButtonEvent(awt_display, 3, True, CurrentTime);

    }

    XSync(awt_display, False);

    AWT_UNLOCK();

}

JNIEXPORT void JNICALL

Java_sun_awt_X11_XRobotPeer_mouseReleaseImpl (JNIEnv *env,

                             jclass cls,

                             jint buttonMask) {

    AWT_LOCK();

    DTRACE_PRINTLN1("RobotPeer: mouseReleaseImpl(%i)", buttonMask);

    if (buttonMask & java_awt_event_InputEvent_BUTTON1_MASK) {

        XTestFakeButtonEvent(awt_display, 1, False, CurrentTime);

    }

    if ((buttonMask & java_awt_event_InputEvent_BUTTON2_MASK) &&

        (num_buttons >= 2)) {

        XTestFakeButtonEvent(awt_display, 2, False, CurrentTime);

    }

    if ((buttonMask & java_awt_event_InputEvent_BUTTON3_MASK) &&

        (num_buttons >= 3)) {

        XTestFakeButtonEvent(awt_display, 3, False, CurrentTime);

    }

    XSync(awt_display, False);

    AWT_UNLOCK();

}

JNIEXPORT void JNICALL

Java_sun_awt_X11_XRobotPeer_mouseWheelImpl (JNIEnv *env,

                           jclass cls,

                           jint wheelAmt) {

/* Mouse wheel is implemented as a button press of button 4 and 5, so it */

/* probably could have been hacked into robot_mouseButtonEvent, but it's */

/* cleaner to give it its own command type, in case the implementation   */

/* needs to be changed later.  -bchristi, 6/20/01                        */

    int32_t repeat = abs(wheelAmt);

    int32_t button = wheelAmt < 0 ? 4 : 5;  /* wheel up:   button 4 */

                                                 /* wheel down: button 5 */

    int32_t loopIdx;

    AWT_LOCK();

    DTRACE_PRINTLN1("RobotPeer: mouseWheelImpl(%i)", wheelAmt);

    for (loopIdx = 0; loopIdx < repeat; loopIdx++) { /* do nothing for   */

                                                     /* wheelAmt == 0    */

        XTestFakeButtonEvent(awt_display, button, True, CurrentTime);

        XTestFakeButtonEvent(awt_display, button, False, CurrentTime);

    }

    XSync(awt_display, False);

    AWT_UNLOCK();

}