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

**

** Copyright (C) 2010 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$

**

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

#include "qkeymapper_p.h"

#include "qdebug.h"

#include "qtextcodec.h"

#include "qwidget.h"

#include "qapplication_p.h"

#include "qevent_p.h"

#include "qt_x11_p.h"

#ifndef QT_NO_XKB

#  include <X11/XKBlib.h>

#endif

#define XK_MISCELLANY

#define XK_LATIN1

#define XK_KOREAN

#define XK_XKB_KEYS

#include <X11/keysymdef.h>

#include <ctype.h>

QT_BEGIN_NAMESPACE

#ifndef QT_NO_XKB

// bring in the auto-generated xkbLayoutData

#include "qkeymapper_x11_p.cpp"

#ifdef QT_LINUXBASE

// LSB's IsKeypadKey define is wrong - see

// http://bugs.linuxbase.org/show_bug.cgi?id=2521

#undef IsKeypadKey

#define IsKeypadKey(keysym) \

      (((KeySym)(keysym) >= XK_KP_Space) && ((KeySym)(keysym) <= XK_KP_Equal))

#undef IsPrivateKeypadKey

#define IsPrivateKeypadKey(keysym) \

      (((KeySym)(keysym) >= 0x11000000) && ((KeySym)(keysym) <= 0x1100FFFF))

#endif

static void getLocaleAndDirection(QLocale *locale,

                                  Qt::LayoutDirection *direction,

                                  const QByteArray &layoutName,

                                  const QByteArray &variantName)

{

    int i = 0;

    while (xkbLayoutData[i].layout != 0) {

        if (layoutName == xkbLayoutData[i].layout && variantName == xkbLayoutData[i].variant) {

            *locale = QLocale(xkbLayoutData[i].language, xkbLayoutData[i].country);

            *direction = xkbLayoutData[i].direction;

            return;

        }

        ++i;

    }

    *locale = QLocale::c();

    *direction = Qt::LeftToRight;

}

#endif // QT_NO_XKB

// from qapplication_x11.cpp

extern uchar qt_alt_mask;

extern uchar qt_meta_mask;

extern uchar qt_super_mask;

extern uchar qt_hyper_mask;

extern uchar qt_mode_switch_mask;

uchar qt_num_lock_mask = 0;

extern bool qt_sendSpontaneousEvent(QObject*, QEvent*);

// ### we should really resolve conflicts with other masks by

// ### decomposing the Qt::KeyboardModifers in possibleKeys()

#define SETMASK(sym, mask)                                              \

    do {                                                                \

        if (qt_alt_mask == 0                                            \

            && qt_meta_mask != mask                                     \

            && qt_super_mask != mask                                    \

            && qt_hyper_mask != mask                                    \

            && (sym == XK_Alt_L || sym == XK_Alt_R)) {                  \

            qt_alt_mask = mask;                                         \

        }                                                               \

        if (qt_meta_mask == 0                                           \

            && qt_alt_mask != mask                                      \

            && qt_super_mask != mask                                    \

            && qt_hyper_mask != mask                                    \

            && (sym == XK_Meta_L || sym == XK_Meta_R)) {                \

            qt_meta_mask = mask;                                        \

        }                                                               \

        if (qt_super_mask == 0                                          \

            && qt_alt_mask != mask                                      \

            && qt_meta_mask != mask                                     \

            && qt_hyper_mask != mask                                    \

            && (sym == XK_Super_L || sym == XK_Super_R)) {              \

            qt_super_mask = mask;                                       \

        }                                                               \

        if (qt_hyper_mask == 0                                          \

            && qt_alt_mask != mask                                      \

            && qt_meta_mask != mask                                     \

            && qt_super_mask != mask                                    \

            && (sym == XK_Hyper_L || sym == XK_Hyper_R)) {              \

            qt_hyper_mask = mask;                                       \

        }                                                               \

        if (qt_mode_switch_mask == 0                                    \

            && qt_alt_mask != mask                                      \

            && qt_meta_mask != mask                                     \

            && qt_super_mask != mask                                    \

            && qt_hyper_mask != mask                                    \

            && sym == XK_Mode_switch) {                                 \

            qt_mode_switch_mask = mask;                                 \

        }                                                               \

        if (qt_num_lock_mask == 0                                       \

            && sym == XK_Num_Lock) {                                    \

            qt_num_lock_mask = mask;                                    \

        }                                                               \

    } while(false)

// qt_XTranslateKey() is based on _XTranslateKey() taken from:

/* $Xorg: KeyBind.c,v 1.4 2001/02/09 02:03:34 xorgcvs Exp $ */

/*

Copyright 1985, 1987, 1998  The Open Group

Permission to use, copy, modify, distribute, and sell this software and its

documentation for any purpose is hereby granted without fee, provided that

the above copyright notice appear in all copies and that both that

copyright notice and this permission notice appear in supporting

documentation.

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE

OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN

AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of The Open Group shall not be

used in advertising or otherwise to promote the sale, use or other dealings

in this Software without prior written authorization from The Open Group.

*/

static int

qt_XTranslateKey(register QXCoreDesc *dpy,

                 KeyCode keycode,

                 register unsigned int modifiers,

                 unsigned int *modifiers_return,

                 KeySym *keysym_return)

{

    int per;

    register KeySym *syms;

    KeySym sym, lsym, usym;

    if (! dpy->keysyms)

	return 0;

    *modifiers_return = ((ShiftMask|LockMask)

			 | dpy->mode_switch | dpy->num_lock);

    if (((int)keycode < dpy->min_keycode) || ((int)keycode > dpy->max_keycode))

    {

	*keysym_return = NoSymbol;

	return 1;

    }

    per = dpy->keysyms_per_keycode;

    syms = &dpy->keysyms[(keycode - dpy->min_keycode) * per];

    while ((per > 2) && (syms[per - 1] == NoSymbol))

	per--;

    if ((per > 2) && (modifiers & dpy->mode_switch)) {

	syms += 2;

	per -= 2;

    }

    if ((modifiers & dpy->num_lock) &&

	(per > 1 && (IsKeypadKey(syms[1]) || IsPrivateKeypadKey(syms[1])))) {

	if ((modifiers & ShiftMask) ||

	    ((modifiers & LockMask) && (dpy->lock_meaning == XK_Shift_Lock)))

	    *keysym_return = syms[0];

	else

	    *keysym_return = syms[1];

    } else if (!(modifiers & ShiftMask) &&

	(!(modifiers & LockMask) || (dpy->lock_meaning == NoSymbol))) {

	if ((per == 1) || (syms[1] == NoSymbol))

	    XConvertCase(syms[0], keysym_return, &usym);

	else

	    *keysym_return = syms[0];

    } else if (!(modifiers & LockMask) ||

	       (dpy->lock_meaning != XK_Caps_Lock)) {

	if ((per == 1) || ((usym = syms[1]) == NoSymbol))

	    XConvertCase(syms[0], &lsym, &usym);

	*keysym_return = usym;

    } else {

	if ((per == 1) || ((sym = syms[1]) == NoSymbol))

	    sym = syms[0];

	XConvertCase(sym, &lsym, &usym);

	if (!(modifiers & ShiftMask) && (sym != syms[0]) &&

	    ((sym != usym) || (lsym == usym)))

	    XConvertCase(syms[0], &lsym, &usym);

	*keysym_return = usym;

    }

    if (*keysym_return == XK_VoidSymbol)

	*keysym_return = NoSymbol;

    return 1;

}

QKeyMapperPrivate::QKeyMapperPrivate()

    : keyboardInputDirection(Qt::LeftToRight), useXKB(false)

{

    memset(&coreDesc, 0, sizeof(coreDesc));

#ifndef QT_NO_XKB

    int opcode = -1;

    int xkbEventBase = -1;

    int xkbErrorBase = -1;

    int xkblibMajor = XkbMajorVersion;

    int xkblibMinor = XkbMinorVersion;

    if (XkbQueryExtension(X11->display, &opcode, &xkbEventBase, &xkbErrorBase, &xkblibMajor, &xkblibMinor))

        useXKB = true;

#endif

#if 0

    qDebug() << "useXKB =" << useXKB;

#endif

}

QKeyMapperPrivate::~QKeyMapperPrivate()

{

    if (coreDesc.keysyms)

        XFree(coreDesc.keysyms);

}

QList<int> QKeyMapperPrivate::possibleKeys(QKeyEvent *event)

{

#ifndef QT_NO_XKB

    if (useXKB)

        return possibleKeysXKB(event);

#endif

    return possibleKeysCore(event);

}

enum { MaxBits = sizeof(uint) * 8 };

static QString translateKeySym(KeySym keysym, uint xmodifiers,

                               int &code, Qt::KeyboardModifiers &modifiers,

                               QByteArray &chars, int &count);

QList<int> QKeyMapperPrivate::possibleKeysXKB(QKeyEvent *event)

{

#ifndef QT_NO_XKB

    const int xkeycode = event->nativeScanCode();

    const uint xmodifiers = event->nativeModifiers();

    // first, translate key only using lock modifiers (there are no Qt equivalents for these, so we must

    // always use them when determining the baseKeySym)

    KeySym baseKeySym;

    uint consumedModifiers;

    if (!XkbLookupKeySym(X11->display, xkeycode, (xmodifiers & (LockMask | qt_num_lock_mask)),

                         &consumedModifiers, &baseKeySym))

        return QList<int>();

    QList<int> result;

    // translate sym -> code

    Qt::KeyboardModifiers baseModifiers = 0;

    int baseCode = -1;

    QByteArray chars;

    int count = 0;

    QString text = translateKeySym(baseKeySym, xmodifiers, baseCode, baseModifiers, chars, count);

    if (baseCode == -1) {

        if (text.isEmpty())

            return QList<int>();

        baseCode = text.at(0).unicode();

    }

    if (baseCode && baseCode < 0xfffe)

        baseCode = QChar(baseCode).toUpper().unicode();

    result += (baseCode | baseModifiers);

    int pos1Bits[MaxBits];

    int num1Bits = 0;

    for (int i = 0; i < MaxBits; ++i) {

        if (consumedModifiers & (1 << i))

            pos1Bits[num1Bits++] = i;

    }

    const int numPerms = (1 << num1Bits);

    // translate the key again using each permutation of consumedModifiers

    for (int i = 1; i < numPerms; ++i) {

        uint val = 0;

        for (int j = 0; j < num1Bits; ++j) {

            if (i & (1 << j))

                val |= (1 << pos1Bits[j]);

        }

        if ((xmodifiers & val) != val)

            continue;

        KeySym sym;

        uint mods;

        if (!XkbLookupKeySym(X11->display, xkeycode, val, &mods, &sym))

            continue;

        // translate sym -> code

        Qt::KeyboardModifiers modifiers = 0;

        int code = -1;

        chars.clear();

        count = 0;

        // mask out the modifiers needed to translate keycode

        text = translateKeySym(sym, xmodifiers & ~val, code, modifiers, chars, count);

        if (code == -1) {

            if (text.isEmpty())

                continue;

            code = text.at(0).unicode();

        }

        if (code && code < 0xfffe)

            code = QChar(code).toUpper().unicode();

        if (code == Qt::Key_Tab && (baseModifiers & Qt::ShiftModifier)) {

            // map shift+tab to shift+backtab

            code = Qt::Key_Backtab;

            text = QString();

        }

        if (code == baseCode)

            continue;

        result += (code | modifiers);

    }

#if 0

    qDebug() << "possibleKeysXKB()" << hex << result;

#endif

    return result;

#else

    Q_UNUSED(event);

    return QList<int>();

#endif // QT_NO_XKB

}

QList<int> QKeyMapperPrivate::possibleKeysCore(QKeyEvent *event)

{

    const int xkeycode = event->nativeScanCode();

    const uint xmodifiers = event->nativeModifiers();

    // first, translate key only using lock modifiers (there are no Qt equivalents for these, so we must

    // always use them when determining the baseKeySym)

    KeySym baseKeySym;

    uint consumedModifiers;

    if (!qt_XTranslateKey(&coreDesc, xkeycode, (xmodifiers & (LockMask | qt_num_lock_mask)),

                          &consumedModifiers, &baseKeySym))

        return QList<int>();

    QList<int> result;

    // translate sym -> code

    Qt::KeyboardModifiers baseModifiers = 0;

    int baseCode = -1;

    QByteArray chars;

    int count = 0;

    QString text = translateKeySym(baseKeySym, xmodifiers, baseCode, baseModifiers, chars, count);

    if (baseCode == -1) {

        if (text.isEmpty())

            return QList<int>();

        baseCode = text.at(0).unicode();

    }

    if (baseCode && baseCode < 0xfffe)

        baseCode = QChar(baseCode).toUpper().unicode();

    result += (baseCode | baseModifiers);

    int pos1Bits[MaxBits];

    int num1Bits = 0;

    for (int i = 0; i < MaxBits; ++i) {

        if (consumedModifiers & (1 << i))

            pos1Bits[num1Bits++] = i;

    }

    const int numPerms = (1 << num1Bits);

    // translate the key again using each permutation of consumedModifiers

    for (int i = 1; i < numPerms; ++i) {

        uint val = 0;

        for (int j = 0; j < num1Bits; ++j) {

            if (i & (1 << j))

                val |= (1 << pos1Bits[j]);

        }

        if ((xmodifiers & val) != val)

            continue;

        KeySym sym;

        uint mods;

        if (!qt_XTranslateKey(&coreDesc, xkeycode, val, &mods, &sym))

            continue;

        // translate sym -> code

        Qt::KeyboardModifiers modifiers = 0;

        int code = -1;

        chars.clear();

        count = 0;

        // mask out the modifiers needed to translate keycode

        text = translateKeySym(sym, xmodifiers & ~val, code, modifiers, chars, count);

        if (code == -1) {

            if (text.isEmpty())

                continue;

            code = text.at(0).unicode();

        }

        if (code && code < 0xfffe)

            code = QChar(code).toUpper().unicode();

        if (code == Qt::Key_Tab && (baseModifiers & Qt::ShiftModifier)) {

            // map shift+tab to shift+backtab

            code = Qt::Key_Backtab;

            text = QString();

        }

        if (code == baseCode)

            continue;

        result += (code | modifiers);

    }

#if 0

    qDebug() << "possibleKeysCore()" << hex << result;

#endif

    return result;

}

// for parsing the _XKB_RULES_NAMES property

enum {

    RulesFileIndex = 0,

    ModelIndex = 1,

    LayoutIndex = 2,

    VariantIndex = 3,

    OptionsIndex = 4

};

void QKeyMapperPrivate::clearMappings()

{

#ifndef QT_NO_XKB

    if (useXKB) {

        // try to determine the layout name and input direction by reading the _XKB_RULES_NAMES property off

        // the root window

        QByteArray layoutName;

        QByteArray variantName;

        Atom type = XNone;

        int format = 0;

        ulong nitems = 0;

        ulong bytesAfter = 0;

        uchar *data = 0;

        if (XGetWindowProperty(X11->display, RootWindow(X11->display, 0), ATOM(_XKB_RULES_NAMES), 0, 1024,

                               false, XA_STRING, &type, &format, &nitems, &bytesAfter, &data) == Success

            && type == XA_STRING && format == 8 && nitems > 2) {

            /*

              index 0 == rules file name

              index 1 == model name

              index 2 == layout name

              index 3 == variant name

              index 4 == options

            */

            char *names[5] = { 0, 0, 0, 0, 0 };

            char *p = reinterpret_cast<char *>(data), *end = p + nitems;

            int i = 0;

            do {

                names[i++] = p;

                p += qstrlen(p) + 1;

            } while (p < end);

            layoutName = QByteArray::fromRawData(names[2], qstrlen(names[2]));

            variantName = QByteArray::fromRawData(names[3], qstrlen(names[3]));

        }

        // ### ???

        // if (keyboardLayoutName.isEmpty())

        //     qWarning("Qt: unable to determine keyboard layout, please talk to qt-bugs@trolltech.com"); ?

        getLocaleAndDirection(&keyboardInputLocale,

                              &keyboardInputDirection,

                              layoutName,

                              variantName);