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

**

** 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$

**

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

#include "qaccessible.h"

#ifndef QT_NO_ACCESSIBILITY

#include "qaccessible_mac_p.h"

#include "qhash.h"

#include "qset.h"

#include "qpointer.h"

#include "qapplication.h"

#include "qmainwindow.h"

#include "qtextdocument.h"

#include "qdebug.h"

#include "qabstractslider.h"

#include "qsplitter.h"

#include "qtabwidget.h"

#include "qlistview.h"

#include "qtableview.h"

#include "qdockwidget.h"

#include <private/qt_mac_p.h>

#include <private/qwidget_p.h>

#include <CoreFoundation/CoreFoundation.h>

QT_BEGIN_NAMESPACE

/*

    Set up platform defines. There is a one-to-one correspondence between the

    Carbon and Cocoa roles and attributes, but the prefix and type changes.

*/

#ifdef QT_MAC_USE_COCOA

typedef NSString * const QAXRoleType;

#define QAXApplicationRole NSAccessibilityApplicationRole

#define QAXButtonRole NSAccessibilityButtonRole

#define QAXCancelAction NSAccessibilityCancelAction

#define QAXCheckBoxRole NSAccessibilityCheckBoxRole

#define QAXChildrenAttribute NSAccessibilityChildrenAttribute

#define QAXCloseButtonAttribute NSAccessibilityCloseButtonAttribute

#define QAXCloseButtonAttribute NSAccessibilityCloseButtonAttribute

#define QAXColumnRole NSAccessibilityColumnRole

#define QAXConfirmAction NSAccessibilityConfirmAction

#define QAXContentsAttribute NSAccessibilityContentsAttribute

#define QAXDecrementAction NSAccessibilityDecrementAction

#define QAXDecrementArrowSubrole NSAccessibilityDecrementArrowSubrole

#define QAXDecrementPageSubrole NSAccessibilityDecrementPageSubrole

#define QAXDescriptionAttribute NSAccessibilityDescriptionAttribute

#define QAXEnabledAttribute NSAccessibilityEnabledAttribute

#define QAXExpandedAttribute NSAccessibilityExpandedAttribute

#define QAXFocusedAttribute NSAccessibilityFocusedAttribute

#define QAXFocusedUIElementChangedNotification NSAccessibilityFocusedUIElementChangedNotification

#define QAXFocusedWindowChangedNotification NSAccessibilityFocusedWindowChangedNotification

#define QAXGroupRole NSAccessibilityGroupRole

#define QAXGrowAreaAttribute NSAccessibilityGrowAreaAttribute

#define QAXGrowAreaRole NSAccessibilityGrowAreaRole

#define QAXHelpAttribute NSAccessibilityHelpAttribute

#define QAXHorizontalOrientationValue NSAccessibilityHorizontalOrientationValue

#define QAXHorizontalScrollBarAttribute NSAccessibilityHorizontalScrollBarAttribute

#define QAXIncrementAction NSAccessibilityIncrementAction

#define QAXIncrementArrowSubrole NSAccessibilityIncrementArrowSubrole

#define QAXIncrementPageSubrole NSAccessibilityIncrementPageSubrole

#define QAXIncrementorRole NSAccessibilityIncrementorRole

#define QAXLinkedUIElementsAttribute NSAccessibilityLinkedUIElementsAttribute

#define QAXListRole NSAccessibilityListRole

#define QAXMainAttribute NSAccessibilityMainAttribute

#define QAXMaxValueAttribute NSAccessibilityMaxValueAttribute

#define QAXMenuBarRole NSAccessibilityMenuBarRole

#define QAXMenuButtonRole NSAccessibilityMenuButtonRole

#define QAXMenuClosedNotification NSAccessibilityMenuClosedNotification

#define QAXMenuItemRole NSAccessibilityMenuItemRole

#define QAXMenuOpenedNotification NSAccessibilityMenuOpenedNotification

#define QAXMenuRole NSAccessibilityMenuRole

#define QAXMinValueAttribute NSAccessibilityMinValueAttribute

#define QAXMinimizeButtonAttribute NSAccessibilityMinimizeButtonAttribute

#define QAXMinimizedAttribute NSAccessibilityMinimizedAttribute

#define QAXNextContentsAttribute NSAccessibilityNextContentsAttribute

#define QAXOrientationAttribute NSAccessibilityOrientationAttribute

#define QAXParentAttribute NSAccessibilityParentAttribute

#define QAXPickAction NSAccessibilityPickAction

#define QAXPopUpButtonRole NSAccessibilityPopUpButtonRole

#define QAXPositionAttribute NSAccessibilityPositionAttribute

#define QAXPressAction NSAccessibilityPressAction

#define QAXPreviousContentsAttribute NSAccessibilityPreviousContentsAttribute

#define QAXProgressIndicatorRole NSAccessibilityProgressIndicatorRole

#define QAXRadioButtonRole NSAccessibilityRadioButtonRole

#define QAXRoleAttribute NSAccessibilityRoleAttribute

#define QAXRoleDescriptionAttribute NSAccessibilityRoleDescriptionAttribute

#define QAXRowRole NSAccessibilityRowRole

#define QAXRowsAttribute NSAccessibilityRowsAttribute

#define QAXScrollAreaRole NSAccessibilityScrollAreaRole

#define QAXScrollBarRole NSAccessibilityScrollBarRole

#define QAXSelectedAttribute NSAccessibilitySelectedAttribute

#define QAXSelectedChildrenAttribute NSAccessibilitySelectedChildrenAttribute

#define QAXSelectedRowsAttribute NSAccessibilitySelectedRowsAttribute

#define QAXSizeAttribute NSAccessibilitySizeAttribute

#define QAXSliderRole NSAccessibilitySliderRole

#define QAXSplitGroupRole NSAccessibilitySplitGroupRole

#define QAXSplitterRole NSAccessibilitySplitterRole

#define QAXSplittersAttribute NSAccessibilitySplittersAttribute

#define QAXStaticTextRole NSAccessibilityStaticTextRole

#define QAXSubroleAttribute NSAccessibilitySubroleAttribute

#define QAXSubroleAttribute NSAccessibilitySubroleAttribute

#define QAXTabGroupRole NSAccessibilityTabGroupRole

#define QAXTableRole NSAccessibilityTableRole

#define QAXTabsAttribute NSAccessibilityTabsAttribute

#define QAXTextFieldRole NSAccessibilityTextFieldRole

#define QAXTitleAttribute NSAccessibilityTitleAttribute

#define QAXTitleUIElementAttribute NSAccessibilityTitleUIElementAttribute

#define QAXToolbarButtonAttribute NSAccessibilityToolbarButtonAttribute

#define QAXToolbarRole NSAccessibilityToolbarRole

#define QAXTopLevelUIElementAttribute NSAccessibilityTopLevelUIElementAttribute

#define QAXUnknownRole NSAccessibilityUnknownRole

#define QAXValueAttribute NSAccessibilityValueAttribute

#define QAXValueChangedNotification NSAccessibilityValueChangedNotification

#define QAXValueIndicatorRole NSAccessibilityValueIndicatorRole

#define QAXVerticalOrientationValue NSAccessibilityVerticalOrientationValue

#define QAXVerticalScrollBarAttribute NSAccessibilityVerticalScrollBarAttribute

#define QAXVisibleRowsAttribute NSAccessibilityVisibleRowsAttribute

#define QAXWindowAttribute NSAccessibilityWindowAttribute

#define QAXWindowCreatedNotification NSAccessibilityWindowCreatedNotification

#define QAXWindowMovedNotification NSAccessibilityWindowMovedNotification

#define QAXWindowRole NSAccessibilityWindowRole

#define QAXZoomButtonAttribute NSAccessibilityZoomButtonAttribute

#else

typedef CFStringRef const QAXRoleType;

#define QAXApplicationRole kAXApplicationRole

#define QAXButtonRole kAXButtonRole

#define QAXCancelAction kAXCancelAction

#define QAXCheckBoxRole kAXCheckBoxRole

#define QAXChildrenAttribute kAXChildrenAttribute

#define QAXCloseButtonAttribute kAXCloseButtonAttribute

#define QAXColumnRole kAXColumnRole

#define QAXConfirmAction kAXConfirmAction

#define QAXContentsAttribute kAXContentsAttribute

#define QAXDecrementAction kAXDecrementAction

#define QAXDecrementArrowSubrole kAXDecrementArrowSubrole

#define QAXDecrementPageSubrole kAXDecrementPageSubrole

#define QAXDescriptionAttribute kAXDescriptionAttribute

#define QAXEnabledAttribute kAXEnabledAttribute

#define QAXExpandedAttribute kAXExpandedAttribute

#define QAXFocusedAttribute kAXFocusedAttribute

#define QAXFocusedUIElementChangedNotification kAXFocusedUIElementChangedNotification

#define QAXFocusedWindowChangedNotification kAXFocusedWindowChangedNotification

#define QAXGroupRole kAXGroupRole

#define QAXGrowAreaAttribute kAXGrowAreaAttribute

#define QAXGrowAreaRole kAXGrowAreaRole

#define QAXHelpAttribute kAXHelpAttribute

#define QAXHorizontalOrientationValue kAXHorizontalOrientationValue

#define QAXHorizontalScrollBarAttribute kAXHorizontalScrollBarAttribute

#define QAXIncrementAction kAXIncrementAction

#define QAXIncrementArrowSubrole kAXIncrementArrowSubrole

#define QAXIncrementPageSubrole kAXIncrementPageSubrole

#define QAXIncrementorRole kAXIncrementorRole

#define QAXLinkedUIElementsAttribute kAXLinkedUIElementsAttribute

#define QAXListRole kAXListRole

#define QAXMainAttribute kAXMainAttribute

#define QAXMaxValueAttribute kAXMaxValueAttribute

#define QAXMenuBarRole kAXMenuBarRole

#define QAXMenuButtonRole kAXMenuButtonRole

#define QAXMenuClosedNotification kAXMenuClosedNotification

#define QAXMenuItemRole kAXMenuItemRole

#define QAXMenuOpenedNotification kAXMenuOpenedNotification

#define QAXMenuRole kAXMenuRole

#define QAXMinValueAttribute kAXMinValueAttribute

#define QAXMinimizeButtonAttribute kAXMinimizeButtonAttribute

#define QAXMinimizedAttribute kAXMinimizedAttribute

#define QAXNextContentsAttribute kAXNextContentsAttribute

#define QAXOrientationAttribute kAXOrientationAttribute

#define QAXParentAttribute kAXParentAttribute

#define QAXPickAction kAXPickAction

#define QAXPopUpButtonRole kAXPopUpButtonRole

#define QAXPositionAttribute kAXPositionAttribute

#define QAXPressAction kAXPressAction

#define QAXPreviousContentsAttribute kAXPreviousContentsAttribute

#define QAXProgressIndicatorRole kAXProgressIndicatorRole

#define QAXRadioButtonRole kAXRadioButtonRole

#define QAXRoleAttribute kAXRoleAttribute

#define QAXRoleDescriptionAttribute kAXRoleDescriptionAttribute

#define QAXRowRole kAXRowRole

#define QAXRowsAttribute kAXRowsAttribute

#define QAXScrollAreaRole kAXScrollAreaRole

#define QAXScrollBarRole kAXScrollBarRole

#define QAXSelectedAttribute kAXSelectedAttribute

#define QAXSelectedChildrenAttribute kAXSelectedChildrenAttribute

#define QAXSelectedRowsAttribute kAXSelectedRowsAttribute

#define QAXSizeAttribute kAXSizeAttribute

#define QAXSliderRole kAXSliderRole

#define QAXSplitGroupRole kAXSplitGroupRole

#define QAXSplitterRole kAXSplitterRole

#define QAXSplittersAttribute kAXSplittersAttribute

#define QAXStaticTextRole kAXStaticTextRole

#define QAXSubroleAttribute kAXSubroleAttribute

#define QAXTabGroupRole kAXTabGroupRole

#define QAXTableRole kAXTableRole

#define QAXTabsAttribute kAXTabsAttribute

#define QAXTextFieldRole kAXTextFieldRole

#define QAXTitleAttribute kAXTitleAttribute

#define QAXTitleUIElementAttribute kAXTitleUIElementAttribute

#define QAXToolbarButtonAttribute kAXToolbarButtonAttribute

#define QAXToolbarRole kAXToolbarRole

#define QAXTopLevelUIElementAttribute kAXTopLevelUIElementAttribute

#define QAXUnknownRole kAXUnknownRole

#define QAXValueAttribute kAXValueAttribute

#define QAXValueChangedNotification kAXValueChangedNotification

#define QAXValueIndicatorRole kAXValueIndicatorRole

#define QAXVerticalOrientationValue kAXVerticalOrientationValue

#define QAXVerticalScrollBarAttribute kAXVerticalScrollBarAttribute

#define QAXVisibleRowsAttribute kAXVisibleRowsAttribute

#define QAXWindowAttribute kAXWindowAttribute

#define QAXWindowCreatedNotification kAXWindowCreatedNotification

#define QAXWindowMovedNotification kAXWindowMovedNotification

#define QAXWindowRole kAXWindowRole

#define QAXZoomButtonAttribute kAXZoomButtonAttribute

#endif

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

  Externals

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

extern bool qt_mac_is_macsheet(const QWidget *w); //qwidget_mac.cpp

extern bool qt_mac_is_macdrawer(const QWidget *w); //qwidget_mac.cpp

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

  QAccessible Bindings

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

//hardcoded bindings between control info and (known) QWidgets

struct QAccessibleTextBinding {

    int qt;

    QAXRoleType mac;

    bool settable;

} text_bindings[][10] = {

    { { QAccessible::MenuItem, QAXMenuItemRole, false },

      { -1, 0, false }

    },

    { { QAccessible::MenuBar, QAXMenuBarRole, false },

      { -1, 0, false }

    },

    { { QAccessible::ScrollBar, QAXScrollBarRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Grip, QAXGrowAreaRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Window, QAXWindowRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Dialog, QAXWindowRole, false },

      { -1, 0, false }

    },

    { { QAccessible::AlertMessage, QAXWindowRole, false },

      { -1, 0, false }

    },

    { { QAccessible::ToolTip, QAXWindowRole, false },

      { -1, 0, false }

    },

    { { QAccessible::HelpBalloon, QAXWindowRole, false },

      { -1, 0, false }

    },

    { { QAccessible::PopupMenu, QAXMenuRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Application, QAXApplicationRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Pane, QAXGroupRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Grouping, QAXGroupRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Separator, QAXSplitterRole, false },

      { -1, 0, false }

    },

    { { QAccessible::ToolBar, QAXToolbarRole, false },

      { -1, 0, false }

    },

    { { QAccessible::PageTab, QAXRadioButtonRole, false },

      { -1, 0, false }

    },

    { { QAccessible::ButtonMenu, QAXMenuButtonRole, false },

      { -1, 0, false }

    },

    { { QAccessible::ButtonDropDown, QAXPopUpButtonRole, false },

      { -1, 0, false }

    },

    { { QAccessible::SpinBox, QAXIncrementorRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Slider, QAXSliderRole, false },

      { -1, 0, false }

    },

    { { QAccessible::ProgressBar, QAXProgressIndicatorRole, false },

      { -1, 0, false }

    },

    { { QAccessible::ComboBox, QAXPopUpButtonRole, false },

      { -1, 0, false }

    },

    { { QAccessible::RadioButton, QAXRadioButtonRole, false },

      { -1, 0, false }

    },

    { { QAccessible::CheckBox, QAXCheckBoxRole, false },

      { -1, 0, false }

    },

    { { QAccessible::StaticText, QAXStaticTextRole, false },

      { QAccessible::Name, QAXValueAttribute, false },

      { -1, 0, false }

    },

    { { QAccessible::Table, QAXTableRole, false },

      { -1, 0, false }

    },

    { { QAccessible::StatusBar, QAXStaticTextRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Column, QAXColumnRole, false },

      { -1, 0, false }

    },

    { { QAccessible::ColumnHeader, QAXColumnRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Row, QAXRowRole, false },

      { -1, 0, false }

    },

    { { QAccessible::RowHeader, QAXRowRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Cell, QAXTextFieldRole, false },

      { -1, 0, false }

    },

    { { QAccessible::PushButton, QAXButtonRole, false },

      { -1, 0, false }

    },

    { { QAccessible::EditableText, QAXTextFieldRole, true },

      { -1, 0, false }

    },

    { { QAccessible::Link, QAXTextFieldRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Indicator, QAXValueIndicatorRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Splitter, QAXSplitGroupRole, false },

      { -1, 0, false }

    },

    { { QAccessible::List, QAXListRole, false },

      { -1, 0, false }

    },

    { { QAccessible::ListItem, QAXStaticTextRole, false },

      { -1, 0, false }

    },

    { { QAccessible::Cell, QAXStaticTextRole, false },

      { -1, 0, false }

    },

    { { -1, 0, false } }

};

class QAInterface;

static CFStringRef macRole(const QAInterface &interface);

QDebug operator<<(QDebug debug, const QAInterface &interface)

{

    if (interface.isValid() == false)

        debug << "invalid interface";

    else 

        debug << interface.object() << "id" << interface.id() << "role" << hex << interface.role();

    return debug;

}

// The root of the Qt accessible hiearchy.

static QObject *rootObject = 0;

bool QAInterface::operator==(const QAInterface &other) const

{

    if (isValid() == false || other.isValid() == false)

        return (isValid() && other.isValid());

    // walk up the parent chain, comparing child indexes, until we reach

    // an interface that has a QObject.

    QAInterface currentThis = *this;

    QAInterface currentOther = other;

    while (currentThis.object() == 0) {

        if (currentOther.object() != 0)

            return false;

        // fail if the child indexes in the two hirearchies don't match.

        if (currentThis.parent().indexOfChild(currentThis) !=

            currentOther.parent().indexOfChild(currentOther))

            return false;

        currentThis = currentThis.parent();

        currentOther = currentOther.parent();

    }

    return (currentThis.object() == currentOther.object() && currentThis.id() == currentOther.id());

}

bool QAInterface::operator!=(const QAInterface &other) const

{

    return !operator==(other);

}

uint qHash(const QAInterface &item)

{

    if (item.isValid())

        return qHash(item.object()) + qHash(item.id());

    else

        return qHash(item.cachedObject()) + qHash(item.id());

}

QAInterface QAInterface::navigate(RelationFlag relation, int entry) const

{

        if (!checkValid())

            return QAInterface();

    // On a QAccessibleInterface that handles its own children we can short-circut

    // the navigation if this QAInterface refers to one of the children:

    if (child != 0) {

        // The Ancestor interface will always be the same QAccessibleInterface with

        // a child value of 0.

        if (relation == QAccessible::Ancestor)

            return QAInterface(*this, 0);

        // The child hiearchy is only one level deep, so navigating to a child

        // of a child is not possible.

        if (relation == QAccessible::Child) {

            return QAInterface();

        }

    }

    QAccessibleInterface *child_iface = 0;

    const int status = base.interface->navigate(relation, entry, &child_iface);

    if (status == -1)

        return QAInterface(); // not found;

    // Check if target is a child of this interface.

    if (!child_iface) {

        return QAInterface(*this, status);

    } else {

        // Target is child_iface or a child of that (status decides).

        return QAInterface(child_iface, status);

    }

}

QAElement::QAElement()

:elementRef(0)

{}

QAElement::QAElement(AXUIElementRef elementRef)

:elementRef(elementRef)

{

    if (elementRef != 0) {

        CFRetain(elementRef);

        CFRetain(object());

    }

}

QAElement::QAElement(const QAElement &element)

:elementRef(element.elementRef)

{

    if (elementRef != 0) {

        CFRetain(elementRef);

        CFRetain(object());

    }

}

QAElement::QAElement(HIObjectRef object, int child)

{

#ifndef QT_MAC_USE_COCOA

    if (object == 0) {

        elementRef = 0; // Create invalid QAElement.

    } else {

        elementRef = AXUIElementCreateWithHIObjectAndIdentifier(object, child);

        CFRetain(object);

    }

#else

    Q_UNUSED(object);

    Q_UNUSED(child);

#endif

}

QAElement::~QAElement()

{

    if (elementRef != 0) {

        CFRelease(object());

        CFRelease(elementRef);

    }

}