Tools/DumpRenderTree/chromium/TestRunner/src/AccessibilityUIElementChromium.h

/*
 * Copyright (C) 2010 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef AccessibilityUIElementChromium_h
#define AccessibilityUIElementChromium_h

#include "CppBoundClass.h"
#include "WebAccessibilityObject.h"
#include <vector>

namespace WebTestRunner {

class AccessibilityUIElement : public CppBoundClass {
public:
    class Factory {
    public:
        virtual ~Factory() { }
        virtual AccessibilityUIElement* getOrCreate(const WebKit::WebAccessibilityObject&) = 0;
    };

    AccessibilityUIElement(const WebKit::WebAccessibilityObject&, Factory*);

    virtual AccessibilityUIElement* getChildAtIndex(unsigned);
    virtual bool isRoot() const { return false; }
    virtual bool isEqual(const WebKit::WebAccessibilityObject&);

    virtual void notificationReceived(const char *notificationName);

protected:
    const WebKit::WebAccessibilityObject& accessibilityObject() const { return m_accessibilityObject; }

    Factory* factory() const { return m_factory; }

private:
    // Bound properties.
    void roleGetterCallback(CppVariant*);
    void titleGetterCallback(CppVariant*);
    void descriptionGetterCallback(CppVariant*);
    void helpTextGetterCallback(CppVariant*);
    void stringValueGetterCallback(CppVariant*);
    void xGetterCallback(CppVariant*);
    void yGetterCallback(CppVariant*);
    void widthGetterCallback(CppVariant*);
    void heightGetterCallback(CppVariant*);
    void intValueGetterCallback(CppVariant*);
    void minValueGetterCallback(CppVariant*);
    void maxValueGetterCallback(CppVariant*);
    void valueDescriptionGetterCallback(CppVariant*);
    void childrenCountGetterCallback(CppVariant*);
    void insertionPointLineNumberGetterCallback(CppVariant*);
    void selectedTextRangeGetterCallback(CppVariant*);
    void isEnabledGetterCallback(CppVariant*);
    void isRequiredGetterCallback(CppVariant*);
    void isFocusedGetterCallback(CppVariant*);
    void isFocusableGetterCallback(CppVariant*);
    void isSelectedGetterCallback(CppVariant*);
    void isSelectableGetterCallback(CppVariant*);
    void isMultiSelectableGetterCallback(CppVariant*);
    void isSelectedOptionActiveGetterCallback(CppVariant*);
    void isExpandedGetterCallback(CppVariant*);
    void isCheckedGetterCallback(CppVariant*);
    void isVisibleGetterCallback(CppVariant*);
    void isOffScreenGetterCallback(CppVariant*);
    void isCollapsedGetterCallback(CppVariant*);
    void hasPopupGetterCallback(CppVariant*);
    void isValidGetterCallback(CppVariant*);
    void isReadOnlyGetterCallback(CppVariant*);
    void orientationGetterCallback(CppVariant*);
    void clickPointXGetterCallback(CppVariant*);
    void clickPointYGetterCallback(CppVariant*);

    // Bound methods.
    void allAttributesCallback(const CppArgumentList&, CppVariant*);
    void attributesOfLinkedUIElementsCallback(const CppArgumentList&, CppVariant*);
    void attributesOfDocumentLinksCallback(const CppArgumentList&, CppVariant*);
    void attributesOfChildrenCallback(const CppArgumentList&, CppVariant*);
    void parametrizedAttributeNamesCallback(const CppArgumentList&, CppVariant*);
    void lineForIndexCallback(const CppArgumentList&, CppVariant*);
    void boundsForRangeCallback(const CppArgumentList&, CppVariant*);
    void stringForRangeCallback(const CppArgumentList&, CppVariant*);
    void childAtIndexCallback(const CppArgumentList&, CppVariant*);
    void elementAtPointCallback(const CppArgumentList&, CppVariant*);
    void attributesOfColumnHeadersCallback(const CppArgumentList&, CppVariant*);
    void attributesOfRowHeadersCallback(const CppArgumentList&, CppVariant*);
    void attributesOfColumnsCallback(const CppArgumentList&, CppVariant*);
    void attributesOfRowsCallback(const CppArgumentList&, CppVariant*);
    void attributesOfVisibleCellsCallback(const CppArgumentList&, CppVariant*);
    void attributesOfHeaderCallback(const CppArgumentList&, CppVariant*);
    void indexInTableCallback(const CppArgumentList&, CppVariant*);
    void rowIndexRangeCallback(const CppArgumentList&, CppVariant*);
    void columnIndexRangeCallback(const CppArgumentList&, CppVariant*);
    void cellForColumnAndRowCallback(const CppArgumentList&, CppVariant*);
    void titleUIElementCallback(const CppArgumentList&, CppVariant*);
    void setSelectedTextRangeCallback(const CppArgumentList&, CppVariant*);
    void attributeValueCallback(const CppArgumentList&, CppVariant*);
    void isAttributeSettableCallback(const CppArgumentList&, CppVariant*);
    void isPressActionSupportedCallback(const CppArgumentList&, CppVariant*);
    void isIncrementActionSupportedCallback(const CppArgumentList&, CppVariant*);
    void isDecrementActionSupportedCallback(const CppArgumentList&, CppVariant*);
    void parentElementCallback(const CppArgumentList&, CppVariant*);
    void incrementCallback(const CppArgumentList&, CppVariant*);
    void decrementCallback(const CppArgumentList&, CppVariant*);
    void showMenuCallback(const CppArgumentList&, CppVariant*);
    void pressCallback(const CppArgumentList&, CppVariant*);
    void isEqualCallback(const CppArgumentList&, CppVariant*);
    void addNotificationListenerCallback(const CppArgumentList&, CppVariant*);
    void removeNotificationListenerCallback(const CppArgumentList&, CppVariant*);
    void takeFocusCallback(const CppArgumentList&, CppVariant*);
    void scrollToMakeVisibleCallback(const CppArgumentList&, CppVariant*);
    void scrollToMakeVisibleWithSubFocusCallback(const CppArgumentList&, CppVariant*);
    void scrollToGlobalPointCallback(const CppArgumentList&, CppVariant*);

    void fallbackCallback(const CppArgumentList&, CppVariant*);

    WebKit::WebAccessibilityObject m_accessibilityObject;
    Factory* m_factory;
    std::vector<CppVariant> m_notificationCallbacks;
};


class RootAccessibilityUIElement : public AccessibilityUIElement {
public:
    RootAccessibilityUIElement(const WebKit::WebAccessibilityObject&, Factory*);

    virtual AccessibilityUIElement* getChildAtIndex(unsigned);
    virtual bool isRoot() const { return true; }
};


// Provides simple lifetime management of the AccessibilityUIElement instances:
// all AccessibilityUIElements ever created from the controller are stored in
// a list and cleared explicitly.
class AccessibilityUIElementList : public AccessibilityUIElement::Factory {
public:
    AccessibilityUIElementList() { }
    virtual ~AccessibilityUIElementList();

    void clear();
    virtual AccessibilityUIElement* getOrCreate(const WebKit::WebAccessibilityObject&);
    AccessibilityUIElement* createRoot(const WebKit::WebAccessibilityObject&);

private:
    typedef std::vector<AccessibilityUIElement*> ElementList;
    ElementList m_elements;
};

}

#endif // AccessibilityUIElementChromium_h