Changeset 243863 in webkit


Ignore:
Timestamp:
Apr 3, 2019 10:52:44 PM (5 years ago)
Author:
Carlos Garcia Campos
Message:

[ATK] Cleanup WebPageAccessibilityObjectAtk
​https://bugs.webkit.org/show_bug.cgi?id=196537

Reviewed by Michael Catanzaro.

Source/WebKit:

Several changes and cleanups:

  • Add WebKit prefix so that style checker doesn't complain about GObject conventions.
  • Rename the header to remove the Atk prefix to match the cpp file and class name.
  • Use pragma once.
  • Use nullptr instead of 0.
  • Use WEBKIT_DEFINE_TYPE instead of G_DEFINE_TYPE.
  • Return generic AtkObject* from constructor.
  • SourcesGTK.txt:
  • WebProcess/WebPage/WebPage.h:
  • WebProcess/WebPage/atk/WebKitWebPageAccessibilityObject.cpp: Renamed from Source/WebKit/WebProcess/WebPage/atk/WebPageAccessibilityObjectAtk.cpp.

(accessibilityRootObjectWrapper):
(webkitWebPageAccessibilityObjectInitialize):
(webkitWebPageAccessibilityObjectGetIndexInParent):
(webkitWebPageAccessibilityObjectGetNChildren):
(webkitWebPageAccessibilityObjectRefChild):
(webkit_web_page_accessibility_object_class_init):
(webkitWebPageAccessibilityObjectNew):
(webkitWebPageAccessibilityObjectRefresh):

  • WebProcess/WebPage/atk/WebKitWebPageAccessibilityObject.h: Added.
  • WebProcess/WebPage/atk/WebPageAccessibilityObject.h: Removed.
  • WebProcess/WebPage/gtk/WebPageGtk.cpp:

(WebKit::WebPage::platformInitialize):
(WebKit::WebPage::updateAccessibilityTree):

Tools:

Also consider files under atk directories as exceptions for GObject conventions.

  • Scripts/webkitpy/style/checkers/cpp.py:

(check_identifier_name_in_declaration):

Location:
trunk
Files:
1 added
1 deleted
6 edited
1 moved

Legend:

Unmodified
Added
Removed

  • trunk/Source/WebKit/ChangeLog

    r243862 r243863  
     12019-04-03  Carlos Garcia Campos  <cgarcia@igalia.com>
     2
     3        [ATK] Cleanup WebPageAccessibilityObjectAtk
     4        https://bugs.webkit.org/show_bug.cgi?id=196537
     5
     6        Reviewed by Michael Catanzaro.
     7
     8        Several changes and cleanups:
     9
     10         - Add WebKit prefix so that style checker doesn't complain about GObject conventions.
     11         - Rename the header to remove the Atk prefix to match the cpp file and class name.
     12         - Use pragma once.
     13         - Use nullptr instead of 0.
     14         - Use WEBKIT_DEFINE_TYPE instead of G_DEFINE_TYPE.
     15         - Return generic AtkObject* from constructor.
     16
     17        * SourcesGTK.txt:
     18        * WebProcess/WebPage/WebPage.h:
     19        * WebProcess/WebPage/atk/WebKitWebPageAccessibilityObject.cpp: Renamed from Source/WebKit/WebProcess/WebPage/atk/WebPageAccessibilityObjectAtk.cpp.
     20        (accessibilityRootObjectWrapper):
     21        (webkitWebPageAccessibilityObjectInitialize):
     22        (webkitWebPageAccessibilityObjectGetIndexInParent):
     23        (webkitWebPageAccessibilityObjectGetNChildren):
     24        (webkitWebPageAccessibilityObjectRefChild):
     25        (webkit_web_page_accessibility_object_class_init):
     26        (webkitWebPageAccessibilityObjectNew):
     27        (webkitWebPageAccessibilityObjectRefresh):
     28        * WebProcess/WebPage/atk/WebKitWebPageAccessibilityObject.h: Added.
     29        * WebProcess/WebPage/atk/WebPageAccessibilityObject.h: Removed.
     30        * WebProcess/WebPage/gtk/WebPageGtk.cpp:
     31        (WebKit::WebPage::platformInitialize):
     32        (WebKit::WebPage::updateAccessibilityTree):
     33
    1342019-04-03  Carlos Garcia Campos  <cgarcia@igalia.com>
    235

  • trunk/Source/WebKit/SourcesGTK.txt

    r243409 r243863  
    411411WebProcess/WebPage/CoordinatedGraphics/LayerTreeHost.cpp
    412412
    413 WebProcess/WebPage/atk/WebPageAccessibilityObjectAtk.cpp
     413WebProcess/WebPage/atk/WebKitWebPageAccessibilityObject.cpp
    414414
    415415WebProcess/WebPage/gstreamer/WebPageGStreamer.cpp

  • trunk/Source/WebKit/WebProcess/WebPage/WebPage.h

    r243630 r243863  
    8686
    8787#if HAVE(ACCESSIBILITY) && PLATFORM(GTK)
    88 #include "WebPageAccessibilityObject.h"
     88typedef struct _AtkObject AtkObject;
    8989#include <wtf/glib/GRefPtr.h>
    9090#endif
    … …  
    16351635
    16361636#if HAVE(ACCESSIBILITY) && PLATFORM(GTK)
    1637     GRefPtr<WebPageAccessibilityObject> m_accessibilityObject;
     1637    GRefPtr<AtkObject> m_accessibilityObject;
    16381638#endif
    16391639

  • trunk/Source/WebKit/WebProcess/WebPage/atk/WebKitWebPageAccessibilityObject.cpp

    r243862 r243863  
    11/*
    2  * Copyright (C) 2012 Igalia S.L.
     2 * Copyright (C) 2012, 2019 Igalia S.L.
    33 *
    44 * Redistribution and use in source and binary forms, with or without
    … …  
    2525
    2626#include "config.h"
    27 #include "WebPageAccessibilityObject.h"
     27#include "WebKitWebPageAccessibilityObject.h"
    2828
    2929#if HAVE(ACCESSIBILITY)
    … …  
    3434#include <WebCore/Frame.h>
    3535#include <WebCore/Page.h>
     36#include <wtf/glib/WTFGType.h>
    3637
    3738using namespace WebKit;
    3839using namespace WebCore;
    3940
    40 G_DEFINE_TYPE(WebPageAccessibilityObject, web_page_accessibility_object, ATK_TYPE_PLUG)
     41struct _WebKitWebPageAccessibilityObjectPrivate {
     42    WebPage* page;
     43};
     44
     45WEBKIT_DEFINE_TYPE(WebKitWebPageAccessibilityObject, webkit_web_page_accessibility_object, ATK_TYPE_PLUG)
    4146
    4247static AtkObject* accessibilityRootObjectWrapper(AtkObject* atkObject)
    … …  
    4550        AXObjectCache::enableAccessibility();
    4651
    47     WebPageAccessibilityObject* accessible = WEB_PAGE_ACCESSIBILITY_OBJECT(atkObject);
    48     if (!accessible->m_page)
    49         return 0;
     52    auto* accessible = WEBKIT_WEB_PAGE_ACCESSIBILITY_OBJECT(atkObject);
     53    if (!accessible->priv->page)
     54        return nullptr;
    5055
    51     Page* corePage = accessible->m_page->corePage();
     56    Page* corePage = accessible->priv->page->corePage();
    5257    if (!corePage)
    53         return 0;
     58        return nullptr;
    5459
    5560    Frame& coreFrame = corePage->mainFrame();
    5661    if (!coreFrame.document())
    57         return 0;
     62        return nullptr;
    5863
    5964    AXObjectCache* cache = coreFrame.document()->axObjectCache();
    … …  
    6368    AccessibilityObject* coreRootObject = cache->rootObject();
    6469    if (!coreRootObject)
    65         return 0;
     70        return nullptr;
    6671
    6772    AtkObject* rootObject = coreRootObject->wrapper();
    6873    if (!rootObject || !ATK_IS_OBJECT(rootObject))
    69         return 0;
     74        return nullptr;
    7075
    7176    return rootObject;
    7277}
    7378
    74 static void webPageAccessibilityObjectInitialize(AtkObject* atkObject, gpointer data)
     79static void webkitWebPageAccessibilityObjectInitialize(AtkObject* atkObject, gpointer data)
    7580{
    76     if (ATK_OBJECT_CLASS(web_page_accessibility_object_parent_class)->initialize)
    77         ATK_OBJECT_CLASS(web_page_accessibility_object_parent_class)->initialize(atkObject, data);
     81    if (ATK_OBJECT_CLASS(webkit_web_page_accessibility_object_parent_class)->initialize)
     82        ATK_OBJECT_CLASS(webkit_web_page_accessibility_object_parent_class)->initialize(atkObject, data);
    7883
    79     WEB_PAGE_ACCESSIBILITY_OBJECT(atkObject)->m_page = reinterpret_cast<WebPage*>(data);
     84    WEBKIT_WEB_PAGE_ACCESSIBILITY_OBJECT(atkObject)->priv->page = reinterpret_cast<WebPage*>(data);
    8085    atk_object_set_role(atkObject, ATK_ROLE_FILLER);
    8186}
    8287
    83 static gint webPageAccessibilityObjectGetIndexInParent(AtkObject*)
     88static gint webkitWebPageAccessibilityObjectGetIndexInParent(AtkObject*)
    8489{
    8590    // An AtkPlug is the only child an AtkSocket can have.
    … …  
    8792}
    8893
    89 static gint webPageAccessibilityObjectGetNChildren(AtkObject* atkObject)
     94static gint webkitWebPageAccessibilityObjectGetNChildren(AtkObject* atkObject)
    9095{
    91     AtkObject* rootObject = accessibilityRootObjectWrapper(atkObject);
    92     if (!rootObject)
    93         return 0;
    94 
    95     return 1;
     96    return accessibilityRootObjectWrapper(atkObject) ? 1 : 0;
    9697}
    9798
    98 static AtkObject* webPageAccessibilityObjectRefChild(AtkObject* atkObject, gint index)
     99static AtkObject* webkitWebPageAccessibilityObjectRefChild(AtkObject* atkObject, gint index)
    99100{
    100101    // It's supposed to have either one child or zero.
    101102    if (index && index != 1)
    102         return 0;
     103        return nullptr;
    103104
    104105    AtkObject* rootObject = accessibilityRootObjectWrapper(atkObject);
    105106    if (!rootObject)
    106         return 0;
     107        return nullptr;
    107108
    108109    atk_object_set_parent(rootObject, atkObject);
    … …  
    112113}
    113114
    114 static void web_page_accessibility_object_init(WebPageAccessibilityObject*)
    115 {
    116 }
    117 
    118 static void web_page_accessibility_object_class_init(WebPageAccessibilityObjectClass* klass)
     115static void webkit_web_page_accessibility_object_class_init(WebKitWebPageAccessibilityObjectClass* klass)
    119116{
    120117    AtkObjectClass* atkObjectClass = ATK_OBJECT_CLASS(klass);
    121 
    122118    // No need to implement get_parent() here since this is a subclass
    123119    // of AtkPlug and all the logic related to that function will be
    124120    // implemented by the ATK bridge.
    125     atkObjectClass->initialize = webPageAccessibilityObjectInitialize;
    126     atkObjectClass->get_index_in_parent = webPageAccessibilityObjectGetIndexInParent;
    127     atkObjectClass->get_n_children = webPageAccessibilityObjectGetNChildren;
    128     atkObjectClass->ref_child = webPageAccessibilityObjectRefChild;
     121    atkObjectClass->initialize = webkitWebPageAccessibilityObjectInitialize;
     122    atkObjectClass->get_index_in_parent = webkitWebPageAccessibilityObjectGetIndexInParent;
     123    atkObjectClass->get_n_children = webkitWebPageAccessibilityObjectGetNChildren;
     124    atkObjectClass->ref_child = webkitWebPageAccessibilityObjectRefChild;
    129125}
    130126
    131 WebPageAccessibilityObject* webPageAccessibilityObjectNew(WebPage* page)
     127AtkObject* webkitWebPageAccessibilityObjectNew(WebPage* page)
    132128{
    133     AtkObject* object = ATK_OBJECT(g_object_new(WEB_TYPE_PAGE_ACCESSIBILITY_OBJECT, NULL));
     129    AtkObject* object = ATK_OBJECT(g_object_new(WEBKIT_TYPE_WEB_PAGE_ACCESSIBILITY_OBJECT, nullptr));
    134130    atk_object_initialize(object, page);
    135     return WEB_PAGE_ACCESSIBILITY_OBJECT(object);
     131    return object;
    136132}
    137133
    138 void webPageAccessibilityObjectRefresh(WebPageAccessibilityObject* accessible)
     134void webkitWebPageAccessibilityObjectRefresh(WebKitWebPageAccessibilityObject* accessible)
    139135{
    140136    // We just need to ensure that there's a connection in the ATK
    141137    // world between this accessibility object and the AtkObject of
    142138    // the accessibility object for the root of the DOM tree.
    143     AtkObject* rootObject = accessibilityRootObjectWrapper(ATK_OBJECT(accessible));
    144     if (!rootObject)
    145         return;
    146     atk_object_set_parent(rootObject, ATK_OBJECT(accessible));
     139    if (auto* rootObject = accessibilityRootObjectWrapper(ATK_OBJECT(accessible)))
     140        atk_object_set_parent(rootObject, ATK_OBJECT(accessible));
    147141}
    148142
    149 #endif
     143#endif // HAVE(ACCESSIBILITY)

  • trunk/Source/WebKit/WebProcess/WebPage/gtk/WebPageGtk.cpp

    r243326 r243863  
    3232#include "WebEvent.h"
    3333#include "WebFrame.h"
    34 #include "WebPageAccessibilityObject.h"
     34#include "WebKitWebPageAccessibilityObject.h"
    3535#include "WebPageProxyMessages.h"
    3636#include "WebProcess.h"
    … …  
    6262    // process to connect the two worlds through the accessibility
    6363    // object there specifically placed for that purpose (the socket).
    64     m_accessibilityObject = adoptGRef(webPageAccessibilityObjectNew(this));
     64    m_accessibilityObject = adoptGRef(webkitWebPageAccessibilityObjectNew(this));
    6565    GUniquePtr<gchar> plugID(atk_plug_get_id(ATK_PLUG(m_accessibilityObject.get())));
    6666    send(Messages::WebPageProxy::BindAccessibilityTree(String(plugID.get())));
    … …  
    118118        return;
    119119
    120     webPageAccessibilityObjectRefresh(m_accessibilityObject.get());
     120    webkitWebPageAccessibilityObjectRefresh(WEBKIT_WEB_PAGE_ACCESSIBILITY_OBJECT(m_accessibilityObject.get()));
    121121}
    122122#endif

  • trunk/Tools/ChangeLog

    r243858 r243863  
     12019-04-03  Carlos Garcia Campos  <cgarcia@igalia.com>
     2
     3        [ATK] Cleanup WebPageAccessibilityObjectAtk
     4        https://bugs.webkit.org/show_bug.cgi?id=196537
     5
     6        Reviewed by Michael Catanzaro.
     7
     8        Also consider files under atk directories as exceptions for GObject conventions.
     9
     10        * Scripts/webkitpy/style/checkers/cpp.py:
     11        (check_identifier_name_in_declaration):
     12
    1132019-04-03  Fujii Hironori  <Hironori.Fujii@sony.com>
    214

  • trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py

    r243411 r243863  
    35863586            # Various exceptions to the rule: JavaScript op codes functions, const_iterator.
    35873587            if (not (filename.find('JavaScriptCore') >= 0 and (modified_identifier.find('op_') >= 0 or modified_identifier.find('intrinsic_') >= 0))
    3588                 and not (('gtk' in filename or 'glib' in filename or 'wpe' in filename) and modified_identifier.startswith('webkit_'))
     3588                and not (('gtk' in filename or 'glib' in filename or 'wpe' in filename or 'atk' in filename) and modified_identifier.startswith('webkit_'))
    35893589                and not modified_identifier.startswith('tst_')
    35903590                and not modified_identifier.startswith('webkit_dom_object_')
Note: See TracChangeset for help on using the changeset viewer.