[ATK] Protect entry points in the ATK wrapper against outdated render trees
[WebKit-https.git] / Source / WebCore / accessibility / atk / WebKitAccessibleUtil.h
1 /*
2  * Copyright (C) 2008 Nuanti Ltd.
3  * Copyright (C) 2009 Jan Alonzo
4  * Copyright (C) 2009, 2010, 2012 Igalia S.L.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #ifndef WebKitAccessibleUtil_h
23 #define WebKitAccessibleUtil_h
24
25 #if HAVE(ACCESSIBILITY)
26
27 #include <atk/atk.h>
28 #include <wtf/text/WTFString.h>
29
30 namespace WebCore {
31 class AccessibilityObject;
32 class IntRect;
33 class VisibleSelection;
34 }
35
36 // An existing accessibility object is considered to be invalid whether it's already
37 // detached or if it's not but just updating the layout will detach it anyway.
38 #define returnIfWebKitAccessibleIsInvalid(webkitAccessible) G_STMT_START { \
39     if (!webkitAccessible || webkitAccessibleIsDetached(webkitAccessible)) { \
40         return; \
41     } else { \
42         webkitAccessibleGetAccessibilityObject(webkitAccessible)->updateBackingStore(); \
43         if (webkitAccessibleIsDetached(webkitAccessible)) \
44             return; \
45     }; } G_STMT_END
46
47 #define returnValIfWebKitAccessibleIsInvalid(webkitAccessible, val) G_STMT_START { \
48     if (!webkitAccessible || webkitAccessibleIsDetached(webkitAccessible)) { \
49         return (val); \
50     } else { \
51         webkitAccessibleGetAccessibilityObject(webkitAccessible)->updateBackingStore(); \
52         if (webkitAccessibleIsDetached(webkitAccessible)) \
53             return (val); \
54     }; } G_STMT_END
55
56 AtkAttributeSet* addToAtkAttributeSet(AtkAttributeSet*, const char* name, const char* value);
57
58 void contentsRelativeToAtkCoordinateType(WebCore::AccessibilityObject*, AtkCoordType, WebCore::IntRect, gint* x, gint* y, gint* width = 0, gint* height = 0);
59
60 String accessibilityTitle(WebCore::AccessibilityObject*);
61
62 String accessibilityDescription(WebCore::AccessibilityObject*);
63
64 bool selectionBelongsToObject(WebCore::AccessibilityObject*, WebCore::VisibleSelection&);
65
66 #endif
67 #endif // WebKitAccessibleUtil_h