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

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

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

#ifndef QT_X11_P_H

#define QT_X11_P_H

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

//

#include "QtGui/qwindowdefs.h"

#include "QtCore/qlist.h"

#include "QtCore/qvariant.h"

// the following is necessary to work around breakage in many versions

// of XFree86's Xlib.h still in use

// ### which versions?

#if defined(_XLIB_H_) // crude hack, but...

#error "cannot include <X11/Xlib.h> before this file"

#endif

#define XRegisterIMInstantiateCallback qt_XRegisterIMInstantiateCallback

#define XUnregisterIMInstantiateCallback qt_XUnregisterIMInstantiateCallback

#define XSetIMValues qt_XSetIMValues

#include <X11/Xlib.h>

#undef XRegisterIMInstantiateCallback

#undef XUnregisterIMInstantiateCallback

#undef XSetIMValues

#include <X11/Xutil.h>

#include <X11/Xos.h>

#ifdef index

#  undef index

#endif

#ifdef rindex

#  undef rindex

#endif

#ifdef Q_OS_VXWORS

#  ifdef open

#    undef open

#  endif

#  ifdef getpid

#    undef getpid

#  endif

#endif // Q_OS_VXWORKS

#include <X11/Xatom.h>

//#define QT_NO_SHAPE

#ifdef QT_NO_SHAPE

#  define XShapeCombineRegion(a,b,c,d,e,f,g)

#  define XShapeCombineMask(a,b,c,d,e,f,g)

#else

#  include <X11/extensions/shape.h>

#endif // QT_NO_SHAPE

#if !defined (QT_NO_TABLET)

#  include <X11/extensions/XInput.h>

#if defined (Q_OS_IRIX)

#  include <X11/extensions/SGIMisc.h>

#  include <wacom.h>

#endif

#endif // QT_NO_TABLET

// #define QT_NO_XINERAMA

#ifndef QT_NO_XINERAMA

#  if 0 // ### Xsun, but how to detect it?

// Xinerama is only supported in Solaris 7 with patches 107648/108376 and

// Solaris 8 or above which introduce the X11R6.4 Xserver.

// To switch the Xinerama functionality on, you need to add the "+xinerama"

// argument to the Xsun start line.

// At least Solaris 7 and 8 are missing Xinerama system headers and function

// declarations (bug 4284701).

// The Xinerama API is not documented. In theory it could change but it

// probably won't because Sun are using it in at least dtlogin (bug 4221829).

extern "C" Bool XPanoramiXQueryExtension(

    Display*,

    int*,

    int*

);

extern "C" Status XPanoramiXQueryVersion(

    Display*,

    int*,

    int*

);

extern "C" Status XPanoramiXGetState(

    Display*,

    Drawable,

    XPanoramiXInfo*

);

extern "C" Status XPanoramiXGetScreenCount(

    Display *,

    Drawable,

    XPanoramiXInfo*

);

extern "C" Status XPanoramiXGetScreenSize(

    Display*,

    Drawable,

    int,

    XPanoramiXInfo*

);

#  else // XFree86

// XFree86 does not C++ify Xinerama (at least up to XFree86 4.0.3).

extern "C" {

#    include <X11/extensions/Xinerama.h>

}

#  endif

#endif // QT_NO_XINERAMA

// #define QT_NO_XRANDR

#ifndef QT_NO_XRANDR

#  include <X11/extensions/Xrandr.h>

#endif // QT_NO_XRANDR

// #define QT_NO_XRENDER

#ifndef QT_NO_XRENDER

#  include <X11/extensions/Xrender.h>

#endif // QT_NO_XRENDER

#ifndef QT_NO_XSYNC

#  include "X11/extensions/sync.h"

#endif

// #define QT_NO_XKB

#ifndef QT_NO_XKB

#  include <X11/XKBlib.h>

#endif // QT_NO_XKB

#if !defined(XlibSpecificationRelease)

#  define X11R4

typedef char *XPointer;

#else

#  undef X11R4

#endif

// #define QT_NO_XIM

#if defined(X11R4)

// X11R4 does not have XIM

#define QT_NO_XIM

#elif defined(Q_OS_OSF) && (XlibSpecificationRelease < 6)

// broken in Xlib up to OSF/1 3.2

#define QT_NO_XIM

#elif defined(Q_OS_AIX)

// broken in Xlib up to what version of AIX?

#define QT_NO_XIM

#elif defined(QT_NO_DEBUG) && defined(Q_OS_IRIX)

// XmbLookupString broken on IRIX

// XCreateIC broken when compiling -64 on IRIX 6.5.2

#define QT_NO_XIM

#elif defined(Q_OS_HPUX) && defined(__LP64__)

// XCreateIC broken when compiling 64-bit ELF on HP-UX 11.0

#define QT_NO_XIM

#elif defined(Q_OS_SCO)

// ### suggested by user...

// ### #define QT_NO_XIM

#endif // QT_NO_XIM

#ifndef QT_NO_XFIXES

typedef Bool (*PtrXFixesQueryExtension)(Display *, int *, int *);

typedef Status (*PtrXFixesQueryVersion)(Display *, int *, int *);

typedef void (*PtrXFixesSetCursorName)(Display *dpy, Cursor cursor, const char *name);

typedef void (*PtrXFixesSelectSelectionInput)(Display *dpy, Window win, Atom selection, unsigned long eventMask);

#endif // QT_NO_XFIXES

#ifndef QT_NO_XCURSOR

#include <X11/Xcursor/Xcursor.h>

typedef Cursor (*PtrXcursorLibraryLoadCursor)(Display *, const char *);

#endif // QT_NO_XCURSOR

#ifndef QT_NO_XINERAMA

typedef Bool (*PtrXineramaQueryExtension)(Display *dpy, int *event_base, int *error_base);

typedef Bool (*PtrXineramaIsActive)(Display *dpy);

typedef XineramaScreenInfo *(*PtrXineramaQueryScreens)(Display *dpy, int *number);

#endif // QT_NO_XINERAMA

#ifndef QT_NO_XRANDR

typedef void (*PtrXRRSelectInput)(Display *, Window, int);

typedef int (*PtrXRRUpdateConfiguration)(XEvent *);

typedef int (*PtrXRRRootToScreen)(Display *, Window);

typedef Bool (*PtrXRRQueryExtension)(Display *, int *, int *);

#endif // QT_NO_XRANDR

#ifndef QT_NO_XINPUT

typedef int (*PtrXCloseDevice)(Display *, XDevice *);

typedef XDeviceInfo* (*PtrXListInputDevices)(Display *, int *);

typedef XDevice* (*PtrXOpenDevice)(Display *, XID);

typedef void (*PtrXFreeDeviceList)(XDeviceInfo *);

typedef int (*PtrXSelectExtensionEvent)(Display *, Window, XEventClass *, int);

#endif // QT_NO_XINPUT

/*

 * Solaris patch 108652-47 and higher fixes crases in

 * XRegisterIMInstantiateCallback, but the function doesn't seem to

 * work.

 *

 * Instead, we disabled R6 input, and open the input method

 * immediately at application start.

 */

#if !defined(QT_NO_XIM) && (XlibSpecificationRelease >= 6) && \

    !defined(Q_OS_SOLARIS)

#define USE_X11R6_XIM

//######### XFree86 has wrong declarations for XRegisterIMInstantiateCallback

//######### and XUnregisterIMInstantiateCallback in at least version 3.3.2.

//######### Many old X11R6 header files lack XSetIMValues.

//######### Therefore, we have to declare these functions ourselves.

extern "C" Bool XRegisterIMInstantiateCallback(

    Display*,

    struct _XrmHashBucketRec*,

    char*,

    char*,

    XIMProc, //XFree86 has XIDProc, which has to be wrong

    XPointer

);

extern "C" Bool XUnregisterIMInstantiateCallback(

    Display*,

    struct _XrmHashBucketRec*,

    char*,

    char*,

    XIMProc, //XFree86 has XIDProc, which has to be wrong

    XPointer

);

extern "C" char *XSetIMValues(XIM /* im */, ...);

#endif

#ifndef QT_NO_FONTCONFIG

#include <fontconfig/fontconfig.h>

#endif

#ifndef QT_NO_XIM

// some platforms (eg. Solaris 2.51) don't have these defines in Xlib.h

#ifndef XNResetState

#define XNResetState "resetState"

#endif

#ifndef XIMPreserveState

#define XIMPreserveState (1L<<1)

#endif

#endif

#ifndef X11R4

#  include <X11/Xlocale.h>

#endif // X11R4

#ifndef QT_NO_MITSHM

#  include <X11/extensions/XShm.h>

#endif // QT_NO_MITSHM

QT_BEGIN_NAMESPACE

class QWidget;

struct QX11InfoData {

    uint ref;

    int screen;

    int dpiX;

    int dpiY;

    int depth;

    int cells;

    Colormap colormap;

    Visual *visual;

    bool defaultColormap;

    bool defaultVisual;

    int subpixel;

};

class QDrag;

struct QXdndDropTransaction

{

    Time timestamp;

    Window target;

    Window proxy_target;

    QWidget *targetWidget;

    QWidget *embedding_widget;

    QDrag *object;

};

class QMimeData;

struct QX11Data;

extern QX11Data *qt_x11Data;

enum DesktopEnvironment {

    DE_UNKNOWN,

    DE_KDE,

    DE_GNOME,

    DE_CDE,

    DE_4DWM

};

struct QX11Data

{

    static Qt::KeyboardModifiers translateModifiers(int s);

    Window findClientWindow(Window, Atom, bool);

    // from qclipboard_x11.cpp

    bool clipboardWaitForEvent(Window win, int type, XEvent *event, int timeout);

    bool clipboardReadProperty(Window win, Atom property, bool deleteProperty,

                            QByteArray *buffer, int *size, Atom *type, int *format, bool nullterm);

    QByteArray clipboardReadIncrementalProperty(Window win, Atom property, int nbytes, bool nullterm);

    // from qdnd_x11.cpp

    bool dndEnable(QWidget* w, bool on);

    static void xdndSetup();

    void xdndHandleEnter(QWidget *, const XEvent *, bool);

    void xdndHandlePosition(QWidget *, const XEvent *, bool);

    void xdndHandleStatus(QWidget *, const XEvent *, bool);

    void xdndHandleLeave(QWidget *, const XEvent *, bool);

    void xdndHandleDrop(QWidget *, const XEvent *, bool);

    void xdndHandleFinished(QWidget *, const XEvent *, bool);

    void xdndHandleSelectionRequest(const XSelectionRequestEvent *);

    static bool xdndHandleBadwindow();

    QByteArray xdndAtomToString(Atom a);

    Atom xdndStringToAtom(const char *);

    QString xdndMimeAtomToString(Atom a);

    Atom xdndMimeStringToAtom(const QString &mimeType);

    QStringList xdndMimeFormatsForAtom(Atom a);

    bool xdndMimeDataForAtom(Atom a, QMimeData *mimeData, QByteArray *data, Atom *atomFormat, int *dataFormat);

    QList<Atom> xdndMimeAtomsForFormat(const QString &format);

    QVariant xdndMimeConvertToFormat(Atom a, const QByteArray &data, const QString &format, QVariant::Type requestedType, const QByteArray &encoding);

    Atom xdndMimeAtomForFormat(const QString &format, QVariant::Type requestedType, const QList<Atom> &atoms, QByteArray *requestedEncoding);

    QList<QXdndDropTransaction> dndDropTransactions;

    // from qmotifdnd_x11.cpp

    void motifdndHandle(QWidget *, const XEvent *, bool);

    void motifdndEnable(QWidget *, bool);

    QVariant motifdndObtainData(const char *format);

    QByteArray motifdndFormat(int n);

    bool motifdnd_active;

    Display *display;

    char *displayName;

    bool foreignDisplay;

    // current focus model

    enum {

        FM_Unknown = -1,

        FM_Other = 0,

        FM_PointerRoot = 1

    };

    int focus_model;

    // true if Qt is compiled w/ RANDR support and RANDR is supported on the connected Display

    bool use_xrandr;

    int xrandr_major;

    int xrandr_eventbase;

    int xrandr_errorbase;

    // true if Qt is compiled w/ RENDER support and RENDER is supported on the connected Display

    bool use_xrender;

    int xrender_major;

    int xrender_version;

    // true if Qt is compiled w/ XFIXES support and XFIXES is supported on the connected Display

    bool use_xfixes;

    int xfixes_major;

    int xfixes_eventbase;

    int xfixes_errorbase;

#ifndef QT_NO_XFIXES

    PtrXFixesQueryExtension ptrXFixesQueryExtension;

    PtrXFixesQueryVersion ptrXFixesQueryVersion;

    PtrXFixesSetCursorName ptrXFixesSetCursorName;

    PtrXFixesSelectSelectionInput ptrXFixesSelectSelectionInput;

#endif

#ifndef QT_NO_XINPUT

    PtrXCloseDevice ptrXCloseDevice;

    PtrXListInputDevices ptrXListInputDevices;

    PtrXOpenDevice ptrXOpenDevice;

    PtrXFreeDeviceList ptrXFreeDeviceList;

    PtrXSelectExtensionEvent ptrXSelectExtensionEvent;

#endif // QT_NO_XINPUT

    // true if Qt is compiled w/ MIT-SHM support and MIT-SHM is supported on the connected Display

    bool use_mitshm;

    int mitshm_major;

    // true if Qt is compiled w/ Tablet support and we have a tablet.

    bool use_xinput;

    int xinput_major;

    int xinput_eventbase;

    int xinput_errorbase;

    QList<QWidget *> deferred_map;

    struct ScrollInProgress {

        long id;

        QWidget* scrolled_widget;

        int dx, dy;

    };

    long sip_serial;

    QList<ScrollInProgress> sip_list;

    // window managers list of supported "stuff"

    Atom *net_supported_list;

    // list of virtual root windows

    Window *net_virtual_root_list;

    // client leader window

    Window wm_client_leader;

    QX11InfoData *screens;

    Visual **argbVisuals;

    Colormap *argbColormaps;

    int screenCount;

    int defaultScreen;

    Time time;

    Time userTime;

    QString default_im;

    // starts to ignore bad window errors from X

    static inline void ignoreBadwindow() {

        qt_x11Data->ignore_badwindow = true;

        qt_x11Data->seen_badwindow = false;

    }

    // ends ignoring bad window errors and returns whether an error had happened.

    static inline bool badwindow() {

        qt_x11Data->ignore_badwindow = false;

        return qt_x11Data->seen_badwindow;

    }

    bool ignore_badwindow;

    bool seen_badwindow;

    // options

    int visual_class;

    int visual_id;

    int color_count;

    bool custom_cmap;

    // outside visual/colormap

    Visual *visual;

    Colormap colormap;

#ifndef QT_NO_XRENDER

    enum { solid_fill_count = 16 };

    struct SolidFills {

        XRenderColor color;

        int screen;

        Picture picture;

    } solid_fills[solid_fill_count];

    enum { pattern_fill_count = 16 };

    struct PatternFills {

        XRenderColor color;

        XRenderColor bg_color;

        int screen;

        int style;

        bool opaque;

        Picture picture;

    } pattern_fills[pattern_fill_count];

    Picture getSolidFill(int screen, const QColor &c);

    XRenderColor preMultiply(const QColor &c);

#endif

    bool has_fontconfig;

    qreal fc_scale;

    bool fc_antialias;

    int fc_hint_style;

    char *startupId;

    DesktopEnvironment desktopEnvironment : 8;

    uint desktopVersion : 8;  /* Used only for KDE */

    /* Warning: if you modify this list, modify the names of atoms in qapplication_x11.cpp as well! */

    enum X11Atom {

        // window-manager <-> client protocols

        WM_PROTOCOLS,

        WM_DELETE_WINDOW,

        WM_TAKE_FOCUS,

        _NET_WM_PING,

        _NET_WM_CONTEXT_HELP,