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

**

** 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 "qaccessible.h"

#ifndef QT_NO_ACCESSIBILITY

#include "qapplication.h"

#include "qlibrary.h"

#include "qmessagebox.h" // ### dependency

#include "qt_windows.h"

#include "qwidget.h"

#include "qsettings.h"

#include <winuser.h>

#if !defined(WINABLEAPI)

#  if defined(Q_WS_WINCE)

#    include <bldver.h>

#  endif

#  include <winable.h>

#endif

#include <oleacc.h>

#if !defined(Q_CC_BOR) && !defined (Q_CC_GNU)

#include <comdef.h>

#endif

#ifdef Q_WS_WINCE

#include "qguifunctions_wince.h"

#endif

QT_BEGIN_NAMESPACE

//#define DEBUG_SHOW_ATCLIENT_COMMANDS

#ifdef DEBUG_SHOW_ATCLIENT_COMMANDS

QT_BEGIN_INCLUDE_NAMESPACE

#include <qdebug.h>

QT_END_INCLUDE_NAMESPACE

static const char *roleString(QAccessible::Role role)

{

    static const char *roles[] = {

       "NoRole"         /*= 0x00000000*/,

       "TitleBar"       /*= 0x00000001*/,

       "MenuBar"        /*= 0x00000002*/,

       "ScrollBar"      /*= 0x00000003*/,

       "Grip"           /*= 0x00000004*/,

       "Sound"          /*= 0x00000005*/,

       "Cursor"         /*= 0x00000006*/,

       "Caret"          /*= 0x00000007*/,

       "AlertMessage"   /*= 0x00000008*/,

       "Window"         /*= 0x00000009*/,

       "Client"         /*= 0x0000000A*/,

       "PopupMenu"      /*= 0x0000000B*/,

       "MenuItem"       /*= 0x0000000C*/,

       "ToolTip"        /*= 0x0000000D*/,

       "Application"    /*= 0x0000000E*/,

       "Document"       /*= 0x0000000F*/,

       "Pane"           /*= 0x00000010*/,

       "Chart"          /*= 0x00000011*/,

       "Dialog"         /*= 0x00000012*/,

       "Border"         /*= 0x00000013*/,

       "Grouping"       /*= 0x00000014*/,

       "Separator"      /*= 0x00000015*/,

       "ToolBar"        /*= 0x00000016*/,

       "StatusBar"      /*= 0x00000017*/,

       "Table"          /*= 0x00000018*/,

       "ColumnHeader"   /*= 0x00000019*/,

       "RowHeader"      /*= 0x0000001A*/,

       "Column"         /*= 0x0000001B*/,

       "Row"            /*= 0x0000001C*/,

       "Cell"           /*= 0x0000001D*/,

       "Link"           /*= 0x0000001E*/,

       "HelpBalloon"    /*= 0x0000001F*/,

       "Assistant"      /*= 0x00000020*/,

       "List"           /*= 0x00000021*/,

       "ListItem"       /*= 0x00000022*/,

       "Tree"           /*= 0x00000023*/,

       "TreeItem"       /*= 0x00000024*/,

       "PageTab"        /*= 0x00000025*/,

       "PropertyPage"   /*= 0x00000026*/,

       "Indicator"      /*= 0x00000027*/,

       "Graphic"        /*= 0x00000028*/,

       "StaticText"     /*= 0x00000029*/,

       "EditableText"   /*= 0x0000002A*/,  // Editable, selectable, etc.

       "PushButton"     /*= 0x0000002B*/,

       "CheckBox"       /*= 0x0000002C*/,

       "RadioButton"    /*= 0x0000002D*/,

       "ComboBox"       /*= 0x0000002E*/,

       "DropList"       /*= 0x0000002F*/,    // commented out

       "ProgressBar"    /*= 0x00000030*/,

       "Dial"           /*= 0x00000031*/,

       "HotkeyField"    /*= 0x00000032*/,

       "Slider"         /*= 0x00000033*/,

       "SpinBox"        /*= 0x00000034*/,

       "Canvas"         /*= 0x00000035*/,

       "Animation"      /*= 0x00000036*/,

       "Equation"       /*= 0x00000037*/,

       "ButtonDropDown" /*= 0x00000038*/,

       "ButtonMenu"     /*= 0x00000039*/,

       "ButtonDropGrid" /*= 0x0000003A*/,

       "Whitespace"     /*= 0x0000003B*/,

       "PageTabList"    /*= 0x0000003C*/,

       "Clock"          /*= 0x0000003D*/,

       "Splitter"       /*= 0x0000003E*/,

       "LayeredPane"    /*= 0x0000003F*/,

       "UserRole"       /*= 0x0000ffff*/

   };

   if (role >=0x40)

        role = QAccessible::UserRole;

   return roles[int(role)];

}

void showDebug(const char* funcName, const QAccessibleInterface *iface)

{

    qDebug() << "Role:" << roleString(iface->role(0)) 

             << "Name:" << iface->text(QAccessible::Name, 0) 

             << "State:" << QString::number(int(iface->state(0)), 16) 

             << QLatin1String(funcName);

}

#else

# define showDebug(f, iface)

#endif

void QAccessible::initialize()

{

}

void QAccessible::cleanup()

{

}

void QAccessible::updateAccessibility(QObject *o, int who, Event reason)

{

    Q_ASSERT(o);

    if (updateHandler) {

        updateHandler(o, who, reason);

        return;

    }

    QString soundName;

    switch (reason) {

    case PopupMenuStart:

        soundName = QLatin1String("MenuPopup");

        break;

    case MenuCommand:

        soundName = QLatin1String("MenuCommand");

        break;

    case Alert:

        {

#ifndef QT_NO_MESSAGEBOX

            QMessageBox *mb = qobject_cast<QMessageBox*>(o);

            if (mb) {

                switch (mb->icon()) {

                case QMessageBox::Warning:

                    soundName = QLatin1String("SystemExclamation");

                    break;

                case QMessageBox::Critical:

                    soundName = QLatin1String("SystemHand");

                    break;

                case QMessageBox::Information:

                    soundName = QLatin1String("SystemAsterisk");

                    break;

                default:

                    break;

                }

            } else

#endif // QT_NO_MESSAGEBOX

            {

                soundName = QLatin1String("SystemAsterisk");

            }

        }

        break;

    default:

        break;

    }

    if (soundName.size()) {

#ifndef QT_NO_SETTINGS

        QSettings settings(QLatin1String("HKEY_CURRENT_USER\\AppEvents\\Schemes\\Apps\\.Default\\") + soundName,

                           QSettings::NativeFormat);

        QString file = settings.value(QLatin1String(".Current/.")).toString();

#else

        QString file;

#endif

        if (!file.isEmpty()) {

				    PlaySound(reinterpret_cast<const wchar_t *>(soundName.utf16()), 0, SND_ALIAS | SND_ASYNC | SND_NODEFAULT | SND_NOWAIT);

        }

    }

    if (!isActive())

        return;

    typedef void (WINAPI *PtrNotifyWinEvent)(DWORD, HWND, LONG, LONG);

#if defined(Q_WS_WINCE) // ### TODO: check for NotifyWinEvent in CE 6.0

    // There is no user32.lib nor NotifyWinEvent for CE

    return;

#else

    static PtrNotifyWinEvent ptrNotifyWinEvent = 0;

    static bool resolvedNWE = false;

    if (!resolvedNWE) {

        resolvedNWE = true;

        ptrNotifyWinEvent = (PtrNotifyWinEvent)QLibrary::resolve(QLatin1String("user32"), "NotifyWinEvent");

    }

    if (!ptrNotifyWinEvent)

        return;

    // An event has to be associated with a window,

    // so find the first parent that is a widget.

    QWidget *w = 0;

    if (o->isWidgetType()) {

        w = (QWidget*)o;

    } else {

        QObject *p = o;

        while ((p = p->parent()) != 0) {

            if (p->isWidgetType()) {

                w = (QWidget*)p;

                break;

            }

        }

    }

    if (!w) {

        if (reason != QAccessible::ContextHelpStart &&

             reason != QAccessible::ContextHelpEnd)

            w = QApplication::focusWidget();

        if (!w) {

            w = QApplication::activeWindow();

            if (!w)

                return;

// ### Fixme

//             if (!w) {

//                 w = qApp->mainWidget();

//                 if (!w)

//                     return;

//             }

        }

    }

    if (reason != MenuCommand) { // MenuCommand is faked

        ptrNotifyWinEvent(reason, w->winId(), OBJID_CLIENT, who);

    }

#endif // Q_WS_WINCE

}

void QAccessible::setRootObject(QObject *o)

{

    if (rootObjectHandler) {

        rootObjectHandler(o);

    }

}

class QWindowsEnumerate : public IEnumVARIANT

{

public:

    QWindowsEnumerate(const QVector<int> &a)

        : ref(0), current(0),array(a)

    {

    }

    virtual ~QWindowsEnumerate() {}

    HRESULT STDMETHODCALLTYPE QueryInterface(REFIID, LPVOID *);

    ULONG STDMETHODCALLTYPE AddRef();

    ULONG STDMETHODCALLTYPE Release();

    HRESULT STDMETHODCALLTYPE Clone(IEnumVARIANT **ppEnum);

    HRESULT STDMETHODCALLTYPE Next(unsigned long  celt, VARIANT FAR*  rgVar, unsigned long FAR*  pCeltFetched);

    HRESULT STDMETHODCALLTYPE Reset();

    HRESULT STDMETHODCALLTYPE Skip(unsigned long celt);

private:

    ULONG ref;

    ULONG current;

    QVector<int> array;

};

HRESULT STDMETHODCALLTYPE QWindowsEnumerate::QueryInterface(REFIID id, LPVOID *iface)

{

    *iface = 0;

    if (id == IID_IUnknown)

        *iface = (IUnknown*)this;

    else if (id == IID_IEnumVARIANT)

        *iface = (IEnumVARIANT*)this;

    if (*iface) {

        AddRef();

        return S_OK;

    }

    return E_NOINTERFACE;

}

ULONG STDMETHODCALLTYPE QWindowsEnumerate::AddRef()

{

    return ++ref;

}

ULONG STDMETHODCALLTYPE QWindowsEnumerate::Release()

{

    if (!--ref) {

        delete this;

        return 0;

    }

    return ref;

}

HRESULT STDMETHODCALLTYPE QWindowsEnumerate::Clone(IEnumVARIANT **ppEnum)

{

    QWindowsEnumerate *penum = 0;

    *ppEnum = 0;

    penum = new QWindowsEnumerate(array);

    if (!penum)

        return E_OUTOFMEMORY;

    penum->current = current;

    penum->array = array;

    penum->AddRef();

    *ppEnum = penum;

    return S_OK;

}

HRESULT STDMETHODCALLTYPE QWindowsEnumerate::Next(unsigned long  celt, VARIANT FAR*  rgVar, unsigned long FAR*  pCeltFetched)

{

    if (pCeltFetched)

        *pCeltFetched = 0;

    ULONG l;

    for (l = 0; l < celt; l++) {

        VariantInit(&rgVar[l]);

        if ((current+1) > (ULONG)array.size()) {

            *pCeltFetched = l;

            return S_FALSE;

        }

        rgVar[l].vt = VT_I4;

        rgVar[l].lVal = array[(int)current];

        ++current;

    }

    *pCeltFetched = l;

    return S_OK;

}

HRESULT STDMETHODCALLTYPE QWindowsEnumerate::Reset()

{

    current = 0;

    return S_OK;

}

HRESULT STDMETHODCALLTYPE QWindowsEnumerate::Skip(unsigned long celt)

{

    current += celt;

    if (current > (ULONG)array.size()) {

        current = array.size();

        return S_FALSE;

    }

    return S_OK;

}

/*

*/

class QWindowsAccessible : public IAccessible, IOleWindow, QAccessible

{

public:

    QWindowsAccessible(QAccessibleInterface *a)

        : ref(0), accessible(a)

    {

    }

    virtual ~QWindowsAccessible()

    {

        delete accessible;

    }

    HRESULT STDMETHODCALLTYPE QueryInterface(REFIID, LPVOID *);

    ULONG STDMETHODCALLTYPE AddRef();

    ULONG STDMETHODCALLTYPE Release();

    HRESULT STDMETHODCALLTYPE GetTypeInfoCount(unsigned int *);

    HRESULT STDMETHODCALLTYPE GetTypeInfo(unsigned int, unsigned long, ITypeInfo **);

    HRESULT STDMETHODCALLTYPE GetIDsOfNames(const _GUID &, wchar_t **, unsigned int, unsigned long, long *);

    HRESULT STDMETHODCALLTYPE Invoke(long, const _GUID &, unsigned long, unsigned short, tagDISPPARAMS *, tagVARIANT *, tagEXCEPINFO *, unsigned int *);

    HRESULT STDMETHODCALLTYPE accHitTest(long xLeft, long yTop, VARIANT *pvarID);

    HRESULT STDMETHODCALLTYPE accLocation(long *pxLeft, long *pyTop, long *pcxWidth, long *pcyHeight, VARIANT varID);

    HRESULT STDMETHODCALLTYPE accNavigate(long navDir, VARIANT varStart, VARIANT *pvarEnd);

    HRESULT STDMETHODCALLTYPE get_accChild(VARIANT varChildID, IDispatch** ppdispChild);

    HRESULT STDMETHODCALLTYPE get_accChildCount(long* pcountChildren);

    HRESULT STDMETHODCALLTYPE get_accParent(IDispatch** ppdispParent);

    HRESULT STDMETHODCALLTYPE accDoDefaultAction(VARIANT varID);

    HRESULT STDMETHODCALLTYPE get_accDefaultAction(VARIANT varID, BSTR* pszDefaultAction);

    HRESULT STDMETHODCALLTYPE get_accDescription(VARIANT varID, BSTR* pszDescription);

    HRESULT STDMETHODCALLTYPE get_accHelp(VARIANT varID, BSTR *pszHelp);

    HRESULT STDMETHODCALLTYPE get_accHelpTopic(BSTR *pszHelpFile, VARIANT varChild, long *pidTopic);

    HRESULT STDMETHODCALLTYPE get_accKeyboardShortcut(VARIANT varID, BSTR *pszKeyboardShortcut);

    HRESULT STDMETHODCALLTYPE get_accName(VARIANT varID, BSTR* pszName);

    HRESULT STDMETHODCALLTYPE put_accName(VARIANT varChild, BSTR szName);

    HRESULT STDMETHODCALLTYPE get_accRole(VARIANT varID, VARIANT *pvarRole);

    HRESULT STDMETHODCALLTYPE get_accState(VARIANT varID, VARIANT *pvarState);

    HRESULT STDMETHODCALLTYPE get_accValue(VARIANT varID, BSTR* pszValue);

    HRESULT STDMETHODCALLTYPE put_accValue(VARIANT varChild, BSTR szValue);

    HRESULT STDMETHODCALLTYPE accSelect(long flagsSelect, VARIANT varID);

    HRESULT STDMETHODCALLTYPE get_accFocus(VARIANT *pvarID);

    HRESULT STDMETHODCALLTYPE get_accSelection(VARIANT *pvarChildren);

    HRESULT STDMETHODCALLTYPE GetWindow(HWND *phwnd);

    HRESULT STDMETHODCALLTYPE ContextSensitiveHelp(BOOL fEnterMode);

private:

    ULONG ref;

    QAccessibleInterface *accessible;

};

static inline BSTR QStringToBSTR(const QString &str)

{

    BSTR bstrVal;

    int wlen = str.length()+1;

    bstrVal = SysAllocStringByteLen(0, wlen*2);

    memcpy(bstrVal, str.unicode(), sizeof(QChar)*(wlen));

    bstrVal[wlen] = 0;

    return bstrVal;

}

/*

*/

IAccessible *qt_createWindowsAccessible(QAccessibleInterface *access)

{

    QWindowsAccessible *acc = new QWindowsAccessible(access);

    IAccessible *iface;

    acc->QueryInterface(IID_IAccessible, (void**)&iface);

    return iface;

}

/*

  IUnknown

*/

HRESULT STDMETHODCALLTYPE QWindowsAccessible::QueryInterface(REFIID id, LPVOID *iface)

{

    *iface = 0;

    if (id == IID_IUnknown)

        *iface = (IUnknown*)(IDispatch*)this;

    else if (id == IID_IDispatch)

        *iface = (IDispatch*)this;

    else if (id == IID_IAccessible)

        *iface = (IAccessible*)this;

    else if (id == IID_IOleWindow)

        *iface = (IOleWindow*)this;

    else

        return E_NOINTERFACE;

    AddRef();

    return S_OK;

}

ULONG STDMETHODCALLTYPE QWindowsAccessible::AddRef()

{

    return ++ref;

}

ULONG STDMETHODCALLTYPE QWindowsAccessible::Release()

{

    if (!--ref) {

        delete this;

        return 0;

    }

    return ref;

}

/*

  IDispatch

*/

HRESULT STDMETHODCALLTYPE QWindowsAccessible::GetTypeInfoCount(unsigned int * pctinfo)

{

    // We don't use a type library

    *pctinfo = 0;

    return S_OK;