Changeset 286059 in webkit

Timestamp:

Nov 19, 2021, 6:51:09 AM (5 years ago)

Author:

Carlos Garcia Campos

Message:

[GTK][a11y] Add implementation of document interface when building with ATSPI
​https://bugs.webkit.org/show_bug.cgi?id=232755

Reviewed by Adrian Perez de Castro.

Source/WebCore:

• SourcesGTK.txt:
• accessibility/atspi/AccessibilityObjectAtspi.cpp:

(WebCore::AccessibilityObjectAtspi::interfacesForObject):
(WebCore::AccessibilityObjectAtspi::path):
(WebCore::AccessibilityObjectAtspi::locale const):
(WebCore::AccessibilityObjectAtspi::buildInterfaces const):

• accessibility/atspi/AccessibilityObjectAtspi.h:
• accessibility/atspi/AccessibilityObjectDocumentAtspi.cpp: Added.

(WebCore::AccessibilityObjectAtspi::documentAttribute const):
(WebCore::AccessibilityObjectAtspi::documentAttributes const):
(WebCore::AccessibilityObjectAtspi::documentLocale const):

Tools:

Add unit test for the document interface and WTR implementation.

• TestWebKitAPI/Tests/WebKitGtk/TestWebKitAccessibility.cpp:

(testDocumentBasic):
(beforeAll):

• WebKitTestRunner/InjectedBundle/atspi/AccessibilityUIElementAtspi.cpp:

(WTR::AccessibilityUIElement::language):
(WTR::AccessibilityUIElement::documentEncoding):
(WTR::AccessibilityUIElement::documentURI):

Location:

trunk

Files:

• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/SourcesGTK.txt (modified) (1 diff)
• Source/WebCore/accessibility/atspi/AccessibilityObjectAtspi.cpp (modified) (5 diffs)
• Source/WebCore/accessibility/atspi/AccessibilityObjectAtspi.h (modified) (5 diffs)
• Source/WebCore/accessibility/atspi/AccessibilityObjectDocumentAtspi.cpp (added)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitGtk/TestWebKitAccessibility.cpp (modified) (2 diffs)
• Tools/WebKitTestRunner/InjectedBundle/atspi/AccessibilityUIElementAtspi.cpp (modified) (2 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2021-11-19  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK][a11y] Add implementation of document interface when building with ATSPI
+        https://bugs.webkit.org/show_bug.cgi?id=232755
+
+        Reviewed by Adrian Perez de Castro.
+
+        * SourcesGTK.txt:
+        * accessibility/atspi/AccessibilityObjectAtspi.cpp:
+        (WebCore::AccessibilityObjectAtspi::interfacesForObject):
+        (WebCore::AccessibilityObjectAtspi::path):
+        (WebCore::AccessibilityObjectAtspi::locale const):
+        (WebCore::AccessibilityObjectAtspi::buildInterfaces const):
+        * accessibility/atspi/AccessibilityObjectAtspi.h:
+        * accessibility/atspi/AccessibilityObjectDocumentAtspi.cpp: Added.
+        (WebCore::AccessibilityObjectAtspi::documentAttribute const):
+        (WebCore::AccessibilityObjectAtspi::documentAttributes const):
+        (WebCore::AccessibilityObjectAtspi::documentLocale const):
+
 2021-11-19  Antti Koivisto  <antti@apple.com>
 

trunk/Source/WebCore/SourcesGTK.txt

@@ -44 +44 @@
 accessibility/atspi/AccessibilityObjectActionAtspi.cpp
 accessibility/atspi/AccessibilityObjectComponentAtspi.cpp
+accessibility/atspi/AccessibilityObjectDocumentAtspi.cpp
 accessibility/atspi/AccessibilityObjectHyperlinkAtspi.cpp
 accessibility/atspi/AccessibilityObjectHypertextAtspi.cpp

trunk/Source/WebCore/accessibility/atspi/AccessibilityObjectAtspi.cpp

@@ -91 +91 @@
     if (coreObject.isLink() || (isRendererReplacedElement(renderer)))
         interfaces.add(Interface::Hyperlink);
+
+    if (coreObject.roleValue() == AccessibilityRole::WebArea)
+        interfaces.add(Interface::Document);
 
     return interfaces;
@@ -446 +449 @@
             return g_variant_new_string(atspiObject->description().data());
         if (!g_strcmp0(propertyName, "Locale"))
-            return g_variant_new_string(setlocale(LC_MESSAGES, nullptr));
+            return g_variant_new_string(atspiObject->locale().utf8().data());
         if (!g_strcmp0(propertyName, "AccessibleId"))
             return g_variant_new_string(atspiObject->m_axObject ? String::number(atspiObject->m_axObject->objectID().toUInt64()).utf8().data() : "");
@@ -486 +489 @@
         if (m_interfaces.contains(Interface::Action))
             interfaces.append({ const_cast<GDBusInterfaceInfo*>(&webkit_action_interface), &s_actionFunctions });
+        if (m_interfaces.contains(Interface::Document))
+            interfaces.append({ const_cast<GDBusInterfaceInfo*>(&webkit_document_interface), &s_documentFunctions });
         m_path = atspiRoot->atspi().registerObject(*this, WTFMove(interfaces));
     }
@@ -694 +699 @@
 
     return "";
+}
+
+String AccessibilityObjectAtspi::locale() const
+{
+    auto* axObject = isMainThread() ? m_coreObject : m_axObject;
+    return axObject ? axObject->language() : String();
 }
 
@@ -1120 +1131 @@
     if (m_interfaces.contains(Interface::Action))
         g_variant_builder_add(builder, "s", webkit_action_interface.name);
+    if (m_interfaces.contains(Interface::Document))
+        g_variant_builder_add(builder, "s", webkit_document_interface.name);
 }
 

trunk/Source/WebCore/accessibility/atspi/AccessibilityObjectAtspi.h

@@ -50 +50 @@
         Hyperlink = 1 << 4,
         Hypertext = 1 << 5,
-        Action = 1 << 6
+        Action = 1 << 6,
+        Document = 1 << 7
     };
     const OptionSet<Interface>& interfaces() const { return m_interfaces; }
@@ -75 +76 @@
     WEBCORE_EXPORT CString name() const;
     WEBCORE_EXPORT CString description() const;
+    WEBCORE_EXPORT String locale() const;
     WEBCORE_EXPORT unsigned role() const;
     WEBCORE_EXPORT unsigned childCount() const;
@@ -127 +129 @@
     WEBCORE_EXPORT bool doAction() const;
 
+    WEBCORE_EXPORT String documentAttribute(const String&) const;
+
 private:
     explicit AccessibilityObjectAtspi(AXCoreObject*);
@@ -169 +173 @@
     String actionKeyBinding() const;
 
+    HashMap<String, String> documentAttributes() const;
+    String documentLocale() const;
+
     static OptionSet<Interface> interfacesForObject(AXCoreObject&);
 
@@ -178 +185 @@
     static GDBusInterfaceVTable s_hypertextFunctions;
     static GDBusInterfaceVTable s_actionFunctions;
+    static GDBusInterfaceVTable s_documentFunctions;
 
     AXCoreObject* m_axObject { nullptr };

trunk/Tools/ChangeLog

@@ +1 @@
+2021-11-19  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK][a11y] Add implementation of document interface when building with ATSPI
+        https://bugs.webkit.org/show_bug.cgi?id=232755
+
+        Reviewed by Adrian Perez de Castro.
+
+        Add unit test for the document interface and WTR implementation.
+
+        * TestWebKitAPI/Tests/WebKitGtk/TestWebKitAccessibility.cpp:
+        (testDocumentBasic):
+        (beforeAll):
+        * WebKitTestRunner/InjectedBundle/atspi/AccessibilityUIElementAtspi.cpp:
+        (WTR::AccessibilityUIElement::language):
+        (WTR::AccessibilityUIElement::documentEncoding):
+        (WTR::AccessibilityUIElement::documentURI):
+
 2021-11-19  Carlos Garcia Campos  <cgarcia@igalia.com>
 

trunk/Tools/TestWebKitAPI/Tests/WebKitGtk/TestWebKitAccessibility.cpp

@@ -1940 +1940 @@
 }
 
+static void testDocumentBasic(AccessibilityTest* test, gconstpointer)
+{
+    test->showInWindow(800, 600);
+    test->loadHtml(
+        "<!doctype html>"
+        "<html>"
+        "  <head>"
+        "    <meta http-equiv='content-language' content='en-us'/>"
+        "    <meta http-equiv='content-type' content='text/html; charset=UTF-8'/>"
+        "    <title>Document attributes</title>"
+        "  </head>"
+        "  <body>"
+        "    <p>This is a paragraph</p>"
+        "    <p lang='es'>Spanish</p>"
+        "  </body>"
+        "</html>",
+        "http://example.org");
+    test->waitUntilLoadFinished();
+
+    auto testApp = test->findTestApplication();
+    g_assert_true(ATSPI_IS_ACCESSIBLE(testApp.get()));
+
+    auto documentWeb = test->findDocumentWeb(testApp.get());
+    g_assert_true(ATSPI_IS_DOCUMENT(documentWeb.get()));
+    g_assert_cmpint(atspi_accessible_get_child_count(documentWeb.get(), nullptr), ==, 2);
+
+    GUniquePtr<char> language(atspi_document_get_locale(ATSPI_DOCUMENT(documentWeb.get()), nullptr));
+    g_assert_cmpstr(language.get(), ==, "en-us");
+    // Elements with no language attribute inhewir the document one.
+    auto p1 = adoptGRef(atspi_accessible_get_child_at_index(documentWeb.get(), 0, nullptr));
+    g_assert_true(ATSPI_IS_ACCESSIBLE(p1.get()));
+    g_assert_cmpstr(atspi_accessible_get_object_locale(p1.get(), nullptr), ==, "en-us");
+    auto p2 = adoptGRef(atspi_accessible_get_child_at_index(documentWeb.get(), 1, nullptr));
+    g_assert_true(ATSPI_IS_ACCESSIBLE(p2.get()));
+    g_assert_cmpstr(atspi_accessible_get_object_locale(p2.get(), nullptr), ==, "es");
+
+    GRefPtr<GHashTable> attributes = adoptGRef(atspi_document_get_attributes(ATSPI_DOCUMENT(documentWeb.get()), nullptr));
+    g_assert_nonnull(attributes.get());
+#if USE(ATSPI)
+    g_assert_cmpuint(g_hash_table_size(attributes.get()), ==, 5);
+#else
+    g_assert_cmpuint(g_hash_table_size(attributes.get()), ==, 3);
+#endif
+    g_assert_cmpstr(static_cast<const char*>(g_hash_table_lookup(attributes.get(), "DocType")), ==, "html");
+    GUniquePtr<char> value(atspi_document_get_document_attribute_value(ATSPI_DOCUMENT(documentWeb.get()), const_cast<char*>("DocType"), nullptr));
+    g_assert_cmpstr(value.get(), ==, "html");
+    g_assert_cmpstr(static_cast<const char*>(g_hash_table_lookup(attributes.get(), "Encoding")), ==, "UTF-8");
+    value.reset(atspi_document_get_document_attribute_value(ATSPI_DOCUMENT(documentWeb.get()), const_cast<char*>("Encoding"), nullptr));
+    g_assert_cmpstr(value.get(), ==, "UTF-8");
+    g_assert_cmpstr(static_cast<const char*>(g_hash_table_lookup(attributes.get(), "URI")), ==, "http://example.org/");
+    value.reset(atspi_document_get_document_attribute_value(ATSPI_DOCUMENT(documentWeb.get()), const_cast<char*>("URI"), nullptr));
+    g_assert_cmpstr(value.get(), ==, "http://example.org/");
+#if USE(ATSPI)
+    g_assert_cmpstr(static_cast<const char*>(g_hash_table_lookup(attributes.get(), "MimeType")), ==, "text/html");
+    value.reset(atspi_document_get_document_attribute_value(ATSPI_DOCUMENT(documentWeb.get()), const_cast<char*>("MimeType"), nullptr));
+    g_assert_cmpstr(value.get(), ==, "text/html");
+    g_assert_cmpstr(static_cast<const char*>(g_hash_table_lookup(attributes.get(), "Title")), ==, "Document attributes");
+    value.reset(atspi_document_get_document_attribute_value(ATSPI_DOCUMENT(documentWeb.get()), const_cast<char*>("Title"), nullptr));
+    g_assert_cmpstr(value.get(), ==, "Document attributes");
+#endif
+}
+
 void beforeAll()
 {
@@ -1964 +2026 @@
     AccessibilityTest::add("WebKitAccessibility", "hypertext/basic", testHypertextBasic);
     AccessibilityTest::add("WebKitAccessibility", "action/basic", testActionBasic);
+    AccessibilityTest::add("WebKitAccessibility", "document/basic", testDocumentBasic);
 }
 

trunk/Tools/WebKitTestRunner/InjectedBundle/atspi/AccessibilityUIElementAtspi.cpp

@@ -685 +685 @@
 JSRetainPtr<JSStringRef> AccessibilityUIElement::language()
 {
-    return JSStringCreateWithCharacters(0, 0);
+    m_element->updateBackingStore();
+    auto locale = m_element->locale();
+    if (locale.isEmpty())
+        return JSStringCreateWithCharacters(0, 0);
+
+    return OpaqueJSString::tryCreate(makeString("AXLanguage: ", locale)).leakRef();
 }
 
@@ -1123 +1128 @@
 JSRetainPtr<JSStringRef> AccessibilityUIElement::documentEncoding()
 {
-    return JSStringCreateWithCharacters(0, 0);
+    if (!m_element->interfaces().contains(WebCore::AccessibilityObjectAtspi::Interface::Document))
+        return JSStringCreateWithCharacters(0, 0);
+
+    return OpaqueJSString::tryCreate(m_element->documentAttribute("Encoding")).leakRef();
 }
 
 JSRetainPtr<JSStringRef> AccessibilityUIElement::documentURI()
 {
-    return JSStringCreateWithCharacters(0, 0);
+    if (!m_element->interfaces().contains(WebCore::AccessibilityObjectAtspi::Interface::Document))
+        return JSStringCreateWithCharacters(0, 0);
+
+    return OpaqueJSString::tryCreate(m_element->documentAttribute("URI")).leakRef();
 }