2011-03-29 Sheriff Bot <webkit.review.bot@gmail.com>
[WebKit.git] / Source / WebCore / accessibility / mac / AXObjectCacheMac.mm
1 /*
2  * Copyright (C) 2003, 2004, 2005, 2006, 2008 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import "config.h"
27 #import "AXObjectCache.h"
28
29 #if HAVE(ACCESSIBILITY)
30
31 #import "AccessibilityObject.h"
32 #import "AccessibilityObjectWrapper.h"
33 #import "RenderObject.h"
34 #import "WebCoreSystemInterface.h"
35
36 #import <wtf/PassRefPtr.h>
37
38 #ifndef NSAccessibilityLiveRegionChangedNotification
39 #define NSAccessibilityLiveRegionChangedNotification @"AXLiveRegionChanged"
40 #endif
41
42 // The simple Cocoa calls in this file don't throw exceptions.
43
44 namespace WebCore {
45
46 void AXObjectCache::detachWrapper(AccessibilityObject* obj)
47 {
48     [obj->wrapper() detach];
49     [obj->wrapper() release];
50     obj->setWrapper(0);
51 }
52
53 void AXObjectCache::attachWrapper(AccessibilityObject* obj)
54 {
55     obj->setWrapper([[AccessibilityObjectWrapper alloc] initWithAccessibilityObject:obj]);
56 }
57
58 void AXObjectCache::postPlatformNotification(AccessibilityObject* obj, AXNotification notification)
59 {
60     if (!obj)
61         return;
62     
63     // Some notifications are unique to Safari and do not have NSAccessibility equivalents.
64     String macNotification;
65     switch (notification) {
66         case AXActiveDescendantChanged:
67             // An active descendant change for trees means a selected rows change.
68             if (obj->isTree())
69                 macNotification = NSAccessibilitySelectedRowsChangedNotification;
70             else
71                 macNotification = NSAccessibilityFocusedUIElementChangedNotification;                
72             break;
73         case AXFocusedUIElementChanged:
74             macNotification = NSAccessibilityFocusedUIElementChangedNotification;
75             break;
76         case AXLayoutComplete:
77             macNotification = "AXLayoutComplete";
78             break;
79         case AXLoadComplete:
80             macNotification = "AXLoadComplete";
81             break;
82         case AXInvalidStatusChanged:
83             macNotification = "AXInvalidStatusChanged";
84             break;
85         case AXSelectedChildrenChanged:
86             macNotification = NSAccessibilitySelectedChildrenChangedNotification;
87             break;
88         case AXSelectedTextChanged:
89             macNotification = NSAccessibilitySelectedTextChangedNotification;
90             break;
91         case AXValueChanged:
92             macNotification = NSAccessibilityValueChangedNotification;
93             break;
94         case AXLiveRegionChanged:
95             macNotification = NSAccessibilityLiveRegionChangedNotification;
96             break;
97         case AXRowCountChanged:
98             macNotification = NSAccessibilityRowCountChangedNotification;
99             break;
100 #if !defined(BUILDING_ON_TIGER) && !defined(BUILDING_ON_LEOPARD)
101         case AXRowExpanded:
102             macNotification = NSAccessibilityRowExpandedNotification;
103             break;
104         case AXRowCollapsed:
105             macNotification = NSAccessibilityRowCollapsedNotification;
106             break;
107 #endif
108             // Does not exist on Mac.
109         case AXCheckedStateChanged:
110         default:
111             return;
112     }
113     
114     // NSAccessibilityPostNotification will call this method, (but not when running DRT), so ASSERT here to make sure it does not crash.
115     // https://bugs.webkit.org/show_bug.cgi?id=46662
116     ASSERT([obj->wrapper() accessibilityIsIgnored] || true);
117     
118     NSAccessibilityPostNotification(obj->wrapper(), macNotification);
119     
120     // Used by DRT to know when notifications are posted.
121     [obj->wrapper() accessibilityPostedNotification:macNotification];
122 }
123
124 void AXObjectCache::nodeTextChangePlatformNotification(AccessibilityObject*, AXTextChange, unsigned, unsigned)
125 {
126 }
127
128 void AXObjectCache::handleFocusedUIElementChanged(RenderObject*, RenderObject*)
129 {
130     wkAccessibilityHandleFocusChanged();
131 }
132
133 void AXObjectCache::handleScrolledToAnchor(const Node*)
134 {
135 }
136
137 }
138
139 #endif // HAVE(ACCESSIBILITY)