blob: 87ceb5f780b45116bea6540ab65c6ba68f5f76ad [file] [log] [blame]
/*
* Copyright (C) 2011 Apple 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:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``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 APPLE INC. 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.
*/
#pragma once
#include "AccessibilityTextMarker.h"
#include "AccessibilityTextMarkerRange.h"
#include "JSWrappable.h"
#include <JavaScriptCore/JSObjectRef.h>
#include <JavaScriptCore/JSRetainPtr.h>
#include <wtf/Platform.h>
#include <wtf/Vector.h>
#if PLATFORM(COCOA)
OBJC_CLASS NSArray;
OBJC_CLASS NSString;
#include <wtf/RetainPtr.h>
using PlatformUIElement = id;
#elif HAVE(ACCESSIBILITY) && USE(ATK)
#include "AccessibilityNotificationHandlerAtk.h"
#include <atk/atk.h>
#include <wtf/glib/GRefPtr.h>
typedef GRefPtr<AtkObject> PlatformUIElement;
#else
typedef void* PlatformUIElement;
#endif
namespace WTR {
class AccessibilityController;
class AccessibilityUIElement : public JSWrappable {
#if PLATFORM(COCOA)
// Helper functions that dispatch the corresponding AccessibilityObjectWrapper method to the AX secondary thread when appropriate.
friend RetainPtr<NSArray> supportedAttributes(id);
friend id attributeValue(id, NSString *);
friend void setAttributeValue(id, NSString *, id, bool synchronous);
#endif
public:
static Ref<AccessibilityUIElement> create(PlatformUIElement);
static Ref<AccessibilityUIElement> create(const AccessibilityUIElement&);
~AccessibilityUIElement();
#if PLATFORM(COCOA)
id platformUIElement() { return m_element.get(); }
#endif
#if !PLATFORM(COCOA)
PlatformUIElement platformUIElement() { return m_element; }
#endif
virtual JSClassRef wrapperClass();
static JSObjectRef makeJSAccessibilityUIElement(JSContextRef, const AccessibilityUIElement&);
bool isEqual(AccessibilityUIElement* otherElement);
RefPtr<AccessibilityUIElement> elementAtPoint(int x, int y);
RefPtr<AccessibilityUIElement> childAtIndex(unsigned);
unsigned indexOfChild(AccessibilityUIElement*);
int childrenCount();
RefPtr<AccessibilityUIElement> titleUIElement();
RefPtr<AccessibilityUIElement> parentElement();
void takeFocus();
void takeSelection();
void addSelection();
void removeSelection();
// Methods - platform-independent implementations
JSRetainPtr<JSStringRef> allAttributes();
JSRetainPtr<JSStringRef> attributesOfLinkedUIElements();
RefPtr<AccessibilityUIElement> linkedUIElementAtIndex(unsigned);
JSRetainPtr<JSStringRef> attributesOfDocumentLinks();
JSRetainPtr<JSStringRef> attributesOfChildren();
JSRetainPtr<JSStringRef> parameterizedAttributeNames();
void increment();
void decrement();
void showMenu();
void press();
bool dismiss();
#if PLATFORM(MAC)
void syncPress();
void asyncIncrement();
void asyncDecrement();
#else
void syncPress() { press(); }
void asyncIncrement() { }
void asyncDecrement() { };
#endif
// Attributes - platform-independent implementations
JSRetainPtr<JSStringRef> stringDescriptionOfAttributeValue(JSStringRef attribute);
JSRetainPtr<JSStringRef> stringAttributeValue(JSStringRef attribute);
double numberAttributeValue(JSStringRef attribute);
JSValueRef uiElementArrayAttributeValue(JSStringRef attribute) const;
RefPtr<AccessibilityUIElement> uiElementAttributeValue(JSStringRef attribute) const;
bool boolAttributeValue(JSStringRef attribute);
#if PLATFORM(MAC)
void attributeValueAsync(JSStringRef attribute, JSValueRef callback);
#else
void attributeValueAsync(JSStringRef attribute, JSValueRef callback) { }
#endif
void setBoolAttributeValue(JSStringRef attribute, bool value);
bool isAttributeSupported(JSStringRef attribute);
bool isAttributeSettable(JSStringRef attribute);
bool isPressActionSupported();
bool isIncrementActionSupported();
bool isDecrementActionSupported();
void setValue(JSStringRef);
JSRetainPtr<JSStringRef> role();
JSRetainPtr<JSStringRef> subrole();
JSRetainPtr<JSStringRef> roleDescription();
JSRetainPtr<JSStringRef> computedRoleString();
JSRetainPtr<JSStringRef> title();
JSRetainPtr<JSStringRef> description();
JSRetainPtr<JSStringRef> language();
JSRetainPtr<JSStringRef> stringValue();
JSRetainPtr<JSStringRef> accessibilityValue() const;
JSRetainPtr<JSStringRef> helpText() const;
JSRetainPtr<JSStringRef> orientation() const;
double x();
double y();
double width();
double height();
double intValue() const;
double minValue();
double maxValue();
JSRetainPtr<JSStringRef> valueDescription();
int insertionPointLineNumber();
JSRetainPtr<JSStringRef> selectedTextRange();
bool isEnabled();
bool isRequired() const;
bool isFocused() const;
bool isFocusable() const;
bool isSelected() const;
bool isSelectedOptionActive() const;
bool isSelectable() const;
bool isMultiSelectable() const;
void setSelectedChild(AccessibilityUIElement*) const;
void setSelectedChildAtIndex(unsigned) const;
void removeSelectionAtIndex(unsigned) const;
void clearSelectedChildren() const;
unsigned selectedChildrenCount() const;
RefPtr<AccessibilityUIElement> selectedChildAtIndex(unsigned) const;
bool isValid() const;
bool isExpanded() const;
bool isChecked() const;
bool isIndeterminate() const;
bool isVisible() const;
bool isOffScreen() const;
bool isCollapsed() const;
bool isIgnored() const;
bool isSingleLine() const;
bool isMultiLine() const;
bool hasPopup() const;
JSRetainPtr<JSStringRef> popupValue() const;
int hierarchicalLevel() const;
double clickPointX();
double clickPointY();
JSRetainPtr<JSStringRef> documentEncoding();
JSRetainPtr<JSStringRef> documentURI();
JSRetainPtr<JSStringRef> url();
JSRetainPtr<JSStringRef> classList() const;
// CSS3-speech properties.
JSRetainPtr<JSStringRef> speakAs();
// Table-specific attributes
JSRetainPtr<JSStringRef> attributesOfColumnHeaders();
JSRetainPtr<JSStringRef> attributesOfRowHeaders();
JSRetainPtr<JSStringRef> attributesOfColumns();
JSRetainPtr<JSStringRef> attributesOfRows();
JSRetainPtr<JSStringRef> attributesOfVisibleCells();
JSRetainPtr<JSStringRef> attributesOfHeader();
bool isInTableCell() const;
int indexInTable();
JSRetainPtr<JSStringRef> rowIndexRange();
JSRetainPtr<JSStringRef> columnIndexRange();
int rowCount();
int columnCount();
JSValueRef rowHeaders() const;
JSValueRef columnHeaders() const;
// Tree/Outline specific attributes
RefPtr<AccessibilityUIElement> selectedRowAtIndex(unsigned);
RefPtr<AccessibilityUIElement> disclosedByRow();
RefPtr<AccessibilityUIElement> disclosedRowAtIndex(unsigned);
RefPtr<AccessibilityUIElement> rowAtIndex(unsigned);
// ARIA specific
RefPtr<AccessibilityUIElement> ariaOwnsElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaFlowToElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaControlsElementAtIndex(unsigned);
#if PLATFORM(MAC) || USE(ATK)
RefPtr<AccessibilityUIElement> ariaDetailsElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaErrorMessageElementAtIndex(unsigned);
#else
RefPtr<AccessibilityUIElement> ariaDetailsElementAtIndex(unsigned) { return nullptr; }
RefPtr<AccessibilityUIElement> ariaErrorMessageElementAtIndex(unsigned) { return nullptr; }
#endif
#if USE(ATK)
RefPtr<AccessibilityUIElement> ariaLabelledByElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaDescribedByElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaOwnsReferencingElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaFlowToReferencingElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaControlsReferencingElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaLabelledByReferencingElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaDescribedByReferencingElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaDetailsReferencingElementAtIndex(unsigned);
RefPtr<AccessibilityUIElement> ariaErrorMessageReferencingElementAtIndex(unsigned);
#else
RefPtr<AccessibilityUIElement> ariaLabelledByElementAtIndex(unsigned) { return nullptr; }
RefPtr<AccessibilityUIElement> ariaDescribedByElementAtIndex(unsigned) { return nullptr; }
RefPtr<AccessibilityUIElement> ariaOwnsReferencingElementAtIndex(unsigned) { return nullptr; }
RefPtr<AccessibilityUIElement> ariaFlowToReferencingElementAtIndex(unsigned) { return nullptr; }
RefPtr<AccessibilityUIElement> ariaControlsReferencingElementAtIndex(unsigned) { return nullptr; }
RefPtr<AccessibilityUIElement> ariaLabelledByReferencingElementAtIndex(unsigned) { return nullptr; }
RefPtr<AccessibilityUIElement> ariaDescribedByReferencingElementAtIndex(unsigned) { return nullptr; }
RefPtr<AccessibilityUIElement> ariaDetailsReferencingElementAtIndex(unsigned) { return nullptr; }
RefPtr<AccessibilityUIElement> ariaErrorMessageReferencingElementAtIndex(unsigned) { return nullptr; }
#endif
// ARIA Drag and Drop
bool ariaIsGrabbed() const;
// A space concatentated string of all the drop effects.
JSRetainPtr<JSStringRef> ariaDropEffects() const;
// Parameterized attributes
int lineForIndex(int);
JSRetainPtr<JSStringRef> rangeForLine(int);
JSRetainPtr<JSStringRef> rangeForPosition(int x, int y);
JSRetainPtr<JSStringRef> boundsForRange(unsigned location, unsigned length);
bool setSelectedTextRange(unsigned location, unsigned length);
JSRetainPtr<JSStringRef> stringForRange(unsigned location, unsigned length);
JSRetainPtr<JSStringRef> attributedStringForRange(unsigned location, unsigned length);
JSRetainPtr<JSStringRef> attributedStringForElement();
bool attributedStringRangeIsMisspelled(unsigned location, unsigned length);
unsigned uiElementCountForSearchPredicate(JSContextRef, AccessibilityUIElement* startElement, bool isDirectionNext, JSValueRef searchKey, JSStringRef searchText, bool visibleOnly, bool immediateDescendantsOnly);
RefPtr<AccessibilityUIElement> uiElementForSearchPredicate(JSContextRef, AccessibilityUIElement* startElement, bool isDirectionNext, JSValueRef searchKey, JSStringRef searchText, bool visibleOnly, bool immediateDescendantsOnly);
JSRetainPtr<JSStringRef> selectTextWithCriteria(JSContextRef, JSStringRef ambiguityResolution, JSValueRef searchStrings, JSStringRef replacementString, JSStringRef activity);
JSValueRef searchTextWithCriteria(JSContextRef, JSValueRef searchStrings, JSStringRef startFrom, JSStringRef direction);
// Text-specific
JSRetainPtr<JSStringRef> characterAtOffset(int offset);
JSRetainPtr<JSStringRef> wordAtOffset(int offset);
JSRetainPtr<JSStringRef> lineAtOffset(int offset);
JSRetainPtr<JSStringRef> sentenceAtOffset(int offset);
// Table-specific
RefPtr<AccessibilityUIElement> cellForColumnAndRow(unsigned column, unsigned row);
// Scrollarea-specific
RefPtr<AccessibilityUIElement> horizontalScrollbar() const;
RefPtr<AccessibilityUIElement> verticalScrollbar() const;
void scrollToMakeVisible();
void scrollToGlobalPoint(int x, int y);
void scrollToMakeVisibleWithSubFocus(int x, int y, int width, int height);
// Text markers.
RefPtr<AccessibilityTextMarkerRange> lineTextMarkerRangeForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarkerRange> misspellingTextMarkerRange(AccessibilityTextMarkerRange* start, bool forward);
RefPtr<AccessibilityTextMarkerRange> textMarkerRangeForElement(AccessibilityUIElement*);
RefPtr<AccessibilityTextMarkerRange> textMarkerRangeForMarkers(AccessibilityTextMarker* startMarker, AccessibilityTextMarker* endMarker);
RefPtr<AccessibilityTextMarkerRange> selectedTextMarkerRange();
void resetSelectedTextMarkerRange();
bool replaceTextInRange(JSStringRef, int position, int length);
bool insertText(JSStringRef);
RefPtr<AccessibilityTextMarker> startTextMarkerForTextMarkerRange(AccessibilityTextMarkerRange*);
RefPtr<AccessibilityTextMarker> endTextMarkerForTextMarkerRange(AccessibilityTextMarkerRange*);
RefPtr<AccessibilityTextMarker> endTextMarkerForBounds(int x, int y, int width, int height);
RefPtr<AccessibilityTextMarker> startTextMarkerForBounds(int x, int y, int width, int height);
RefPtr<AccessibilityTextMarker> textMarkerForPoint(int x, int y);
RefPtr<AccessibilityTextMarker> previousTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarker> nextTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityUIElement> accessibilityElementForTextMarker(AccessibilityTextMarker*);
JSRetainPtr<JSStringRef> stringForTextMarkerRange(AccessibilityTextMarkerRange*);
JSRetainPtr<JSStringRef> attributedStringForTextMarkerRange(AccessibilityTextMarkerRange*);
JSRetainPtr<JSStringRef> attributedStringForTextMarkerRangeWithOptions(AccessibilityTextMarkerRange*, bool);
int textMarkerRangeLength(AccessibilityTextMarkerRange*);
bool attributedStringForTextMarkerRangeContainsAttribute(JSStringRef, AccessibilityTextMarkerRange*);
int indexForTextMarker(AccessibilityTextMarker*);
bool isTextMarkerValid(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarker> textMarkerForIndex(int);
RefPtr<AccessibilityTextMarker> startTextMarker();
RefPtr<AccessibilityTextMarker> endTextMarker();
bool setSelectedVisibleTextRange(AccessibilityTextMarkerRange*);
RefPtr<AccessibilityTextMarkerRange> leftWordTextMarkerRangeForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarkerRange> rightWordTextMarkerRangeForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarker> previousWordStartTextMarkerForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarker> nextWordEndTextMarkerForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarkerRange> paragraphTextMarkerRangeForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarker> nextParagraphEndTextMarkerForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarker> previousParagraphStartTextMarkerForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarkerRange> sentenceTextMarkerRangeForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarker> nextSentenceEndTextMarkerForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarker> previousSentenceStartTextMarkerForTextMarker(AccessibilityTextMarker*);
RefPtr<AccessibilityTextMarkerRange> textMarkerRangeMatchesTextNearMarkers(JSStringRef, AccessibilityTextMarker*, AccessibilityTextMarker*);
// Returns an ordered list of supported actions for an element.
JSRetainPtr<JSStringRef> supportedActions() const;
JSRetainPtr<JSStringRef> mathPostscriptsDescription() const;
JSRetainPtr<JSStringRef> mathPrescriptsDescription() const;
JSRetainPtr<JSStringRef> pathDescription() const;
// Notifications
// Function callback should take one argument, the name of the notification.
bool addNotificationListener(JSValueRef functionCallback);
// Make sure you call remove, because you can't rely on objects being deallocated in a timely fashion.
bool removeNotificationListener();
JSRetainPtr<JSStringRef> identifier();
JSRetainPtr<JSStringRef> traits();
int elementTextPosition();
int elementTextLength();
JSRetainPtr<JSStringRef> stringForSelection();
JSValueRef elementsForRange(unsigned location, unsigned length);
void increaseTextSelection();
void decreaseTextSelection();
RefPtr<AccessibilityUIElement> linkedElement();
RefPtr<AccessibilityUIElement> headerElementAtIndex(unsigned index);
void assistiveTechnologySimulatedFocus();
bool isSearchField() const;
bool isTextArea() const;
bool scrollPageUp();
bool scrollPageDown();
bool scrollPageLeft();
bool scrollPageRight();
// Fieldset
bool hasContainedByFieldsetTrait();
RefPtr<AccessibilityUIElement> fieldsetAncestorElement();
private:
AccessibilityUIElement(PlatformUIElement);
AccessibilityUIElement(const AccessibilityUIElement&);
#if !PLATFORM(COCOA)
PlatformUIElement m_element;
#endif
// A retained, platform specific object used to help manage notifications for this object.
#if HAVE(ACCESSIBILITY)
#if PLATFORM(COCOA)
RetainPtr<id> m_element;
RetainPtr<id> m_notificationHandler;
static RefPtr<AccessibilityController> s_controller;
void getLinkedUIElements(Vector<RefPtr<AccessibilityUIElement> >&);
void getDocumentLinks(Vector<RefPtr<AccessibilityUIElement> >&);
RefPtr<AccessibilityUIElement> elementForAttribute(NSString*) const;
RefPtr<AccessibilityUIElement> elementForAttributeAtIndex(NSString*, unsigned) const;
void getUIElementsWithAttribute(JSStringRef, Vector<RefPtr<AccessibilityUIElement> >&) const;
#endif
void getChildren(Vector<RefPtr<AccessibilityUIElement> >&);
void getChildrenWithRange(Vector<RefPtr<AccessibilityUIElement> >&, unsigned location, unsigned length);
#if USE(ATK)
RefPtr<AccessibilityNotificationHandler> m_notificationHandler;
#endif
#endif
};
#ifdef __OBJC__
inline Optional<RefPtr<AccessibilityUIElement>> makeVectorElement(const RefPtr<AccessibilityUIElement>*, id element) { return { { AccessibilityUIElement::create(element) } }; }
#endif
} // namespace WTR