Move BrowserAccessibilityRelation code to the ui/accessibility/

ui/accessibility/platform/ax_platform_node_win.h

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef UI_ACCESSIBILITY_PLATFORM_AX_PLATFORM_NODE_WIN_H_
 #define UI_ACCESSIBILITY_PLATFORM_AX_PLATFORM_NODE_WIN_H_
 
 #include <atlbase.h>
 #include <atlcom.h>
 #include <oleacc.h>
+#include <vector>
 
 #include "base/compiler_specific.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/observer_list.h"
+#include "base/win/scoped_comptr.h"
 #include "third_party/iaccessible2/ia2_api_all.h"
 #include "ui/accessibility/ax_export.h"
 #include "ui/accessibility/ax_text_utils.h"
 #include "ui/accessibility/platform/ax_platform_node_base.h"
 
 // IMPORTANT!
 // These values are written to logs.  Do not renumber or delete
 // existing items; add new entries to the end of the list.
 enum {
   UMA_API_ACC_DO_DEFAULT_ACTION = 0,
@@ skipping 157 matching lines @@
 
   // This must always be the last enum. It's okay for its value to
   // increase, but none of the other enum values may change.
   UMA_API_MAX
 };
 
 #define WIN_ACCESSIBILITY_API_HISTOGRAM(enum_value) \
   UMA_HISTOGRAM_ENUMERATION("Accessibility.WinAPIs", enum_value, UMA_API_MAX)
 
 namespace ui {
+class AXPlatformNodeWin;
 
 // A simple interface for a class that wants to be notified when IAccessible2
 // is used by a client, a strong indication that full accessibility support
 // should be enabled.
 class AX_EXPORT IAccessible2UsageObserver {
  public:
   IAccessible2UsageObserver();
   virtual ~IAccessible2UsageObserver();
   virtual void OnIAccessible2Used() = 0;
 };
 
 // Get an observer list that allows modules across the codebase to
 // listen to when usage of IAccessible2 is detected.
 extern AX_EXPORT base::ObserverList<IAccessible2UsageObserver>&
     GetIAccessible2UsageObserverList();
 
+//
+// AXPlatformNodeRelationWin
+//
+// A simple implementation of IAccessibleRelation, used to represent
+// a relationship between two accessible nodes in the tree.
+//
+class AXPlatformNodeRelationWin : public CComObjectRootEx<CComMultiThreadModel>,
+                                  public IAccessibleRelation {
+ public:
+  BEGIN_COM_MAP(AXPlatformNodeRelationWin)
+  COM_INTERFACE_ENTRY(IAccessibleRelation)
+  END_COM_MAP()
+
+  AXPlatformNodeRelationWin();
+  virtual ~AXPlatformNodeRelationWin();
+
+  void Initialize(ui::AXPlatformNodeWin* owner, const base::string16& type);
+  void AddTarget(int target_id);
+  void RemoveTarget(int target_id);
+
+  // IAccessibleRelation methods.
+  STDMETHODIMP get_relationType(BSTR* relation_type) override;
+  STDMETHODIMP get_nTargets(long* n_targets) override;
+  STDMETHODIMP get_target(long target_index, IUnknown** target) override;
+  STDMETHODIMP get_targets(long max_targets,
+                           IUnknown** targets,
+                           long* n_targets) override;
+  STDMETHODIMP get_localizedRelationType(BSTR* relation_type) override;
+
+  // Accessors.
+  const base::string16& get_type() const { return type_; }
+  const std::vector<int>& get_target_ids() const { return target_ids_; }
+
+ private:
+  base::string16 type_;
+  base::win::ScopedComPtr<ui::AXPlatformNodeWin> owner_;
+  std::vector<int> target_ids_;
+};
+
 class AX_EXPORT __declspec(uuid("26f5641a-246d-457b-a96d-07f3fae6acf2"))
     AXPlatformNodeWin
     : public NON_EXPORTED_BASE(CComObjectRootEx<CComMultiThreadModel>),
       public IDispatchImpl<IAccessible2_2,
                            &IID_IAccessible2,
                            &LIBID_IAccessible2Lib>,
       public IAccessibleText,
       public IAccessibleTable,
       public IAccessibleTable2,
       public IAccessibleTableCell,
       public IServiceProvider,
       public AXPlatformNodeBase {
  public:
   BEGIN_COM_MAP(AXPlatformNodeWin)
     COM_INTERFACE_ENTRY2(IDispatch, IAccessible2_2)
     COM_INTERFACE_ENTRY(AXPlatformNodeWin)
     COM_INTERFACE_ENTRY(IAccessible)
     COM_INTERFACE_ENTRY(IAccessible2)
     COM_INTERFACE_ENTRY(IAccessible2_2)
     COM_INTERFACE_ENTRY(IAccessibleText)
     COM_INTERFACE_ENTRY(IAccessibleTable)
     COM_INTERFACE_ENTRY(IAccessibleTable2)
     COM_INTERFACE_ENTRY(IAccessibleTableCell)
     COM_INTERFACE_ENTRY(IServiceProvider)
   END_COM_MAP()
 
   ~AXPlatformNodeWin() override;
 
+  // Clear node's current relationships and set them to the default values.
+  void CalculateRelationships();
+
   // AXPlatformNode overrides.
   gfx::NativeViewAccessible GetNativeViewAccessible() override;
   void NotifyAccessibilityEvent(ui::AXEvent event_type) override;
 
   // AXPlatformNodeBase overrides.
   void Destroy() override;
   int GetIndexInParent() override;
 
   //
   // IAccessible methods.
@@ skipping 78 matching lines @@
 
   STDMETHODIMP get_relationTargetsOfType(BSTR type,
                                          long max_targets,
                                          IUnknown*** targets,
                                          long* n_targets) override;
 
   STDMETHODIMP get_attributes(BSTR* attributes) override;
 
   STDMETHODIMP get_indexInParent(LONG* index_in_parent) override;
 
+  STDMETHODIMP get_nRelations(LONG* n_relations) override;
+
+  STDMETHODIMP get_relation(LONG relation_index,
+                            IAccessibleRelation** relation) override;
+
+  STDMETHODIMP get_relations(LONG max_relations,
+                             IAccessibleRelation** relations,
+                             LONG* n_relations) override;
   //
   // IAccessible2 methods not implemented.
   //
 
   STDMETHODIMP get_attribute(BSTR name, VARIANT* attribute) override;
   STDMETHODIMP get_extendedRole(BSTR* extended_role) override;
-  STDMETHODIMP get_nRelations(LONG* n_relations) override;
-  STDMETHODIMP get_relation(LONG relation_index,
-                            IAccessibleRelation** relation) override;
-  STDMETHODIMP get_relations(LONG max_relations,
-                             IAccessibleRelation** relations,
-                             LONG* n_relations) override;
   STDMETHODIMP scrollTo(enum IA2ScrollType scroll_type) override;
   STDMETHODIMP scrollToPoint(enum IA2CoordinateType coordinate_type,
                              LONG x,
                              LONG y) override;
   STDMETHODIMP get_groupPosition(LONG* group_level,
                                  LONG* similar_items_in_group,
                                  LONG* position_in_group) override;
   STDMETHODIMP get_localizedExtendedRole(
       BSTR* localized_extended_role) override;
   STDMETHODIMP get_nExtendedStates(LONG* n_extended_states) override;
@@ skipping 305 matching lines @@
 
   // Many MSAA methods take a var_id parameter indicating that the operation
   // should be performed on a particular child ID, rather than this object.
   // This method tries to figure out the target object from |var_id| and
   // returns a pointer to the target object if it exists, otherwise nullptr.
   // Does not return a new reference.
   AXPlatformNodeWin* GetTargetFromChildID(const VARIANT& var_id);
 
   // Returns true if this node is in a treegrid.
   bool IsInTreeGrid();
+
+  //
+  // For adding / removing IA2 relations.
+  //
+  void AddRelation(const base::string16& relation_type, int target_id);
+  void AddBidirectionalRelations(const base::string16& relation_type,
+                                 const base::string16& reverse_relation_type,
+                                 ui::AXIntListAttribute attribute);
+  void AddBidirectionalRelations(const base::string16& relation_type,
+                                 const base::string16& reverse_relation_type,
+                                 const std::vector<int32_t>& target_ids);
+  // Clears all the forward relations from this object to any other object and
+  // the associated  reverse relations on the other objects, but leaves any
+  // reverse relations on this object alone.
+  void ClearOwnRelations();
+  void RemoveBidirectionalRelationsOfType(
+      const base::string16& relation_type,
+      const base::string16& reverse_relation_type);
+  void RemoveTargetFromRelation(const base::string16& relation_type,
+                                int target_id);
+
+  // Relationships between this node and other nodes.
+  std::vector<ui::AXPlatformNodeRelationWin*> relations_;
 };
 
 }  // namespace ui
 
 #endif  // UI_ACCESSIBILITY_PLATFORM_AX_PLATFORM_NODE_WIN_H_