ax_tree_id_registry.h

Go to the documentation of this file.

// Copyright 2014 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_AX_TREE_ID_REGISTRY_H_
#define UI_ACCESSIBILITY_AX_TREE_ID_REGISTRY_H_
 
#include <map>
#include <string>
#include <utility>
 
#include "ax_action_handler.h"
#include "ax_export.h"
#include "ax_tree_id.h"
#include "base/macros.h"
 
namespace base {
template <typename T>
struct DefaultSingletonTraits;
}  // namespace base
 
namespace ui {
 
class AXActionHandlerBase;
 
// This class generates and saves a runtime id for an accessibility tree.
// It provides a few distinct forms of generating an id:
//     - from a frame id (which consists of a process and routing id)
//     - from a backing |AXActionHandlerBase| object
//
// The first form allows underlying instances to change but refer to the same
// frame.
// The second form allows this registry to track the object for later retrieval.
class AX_EXPORT AXTreeIDRegistry {
 public:
  using FrameID = std::pair<int, int>;
 
  // Get the single instance of this class.
  static AXTreeIDRegistry& GetInstance();
 
  // Gets the frame id based on an ax tree id.
  FrameID GetFrameID(const AXTreeID& ax_tree_id);
 
  // Gets an ax tree id from a frame id.
  AXTreeID GetAXTreeID(FrameID frame_id);
 
  // Retrieve an |AXActionHandlerBase| based on an ax tree id.
  AXActionHandlerBase* GetActionHandler(AXTreeID ax_tree_id);
 
  // Removes an ax tree id, and its associated delegate and frame id (if it
  // exists).
  void RemoveAXTreeID(AXTreeID ax_tree_id);
 
  // Associate a frame id with an ax tree id.
  void SetFrameIDForAXTreeID(const FrameID& frame_id,
                             const AXTreeID& ax_tree_id);
 
 private:
  friend struct base::DefaultSingletonTraits<AXTreeIDRegistry>;
  friend AXActionHandler;
  friend AXActionHandlerBase;
 
  // Get or create a ax tree id keyed on |handler|.
  AXTreeID GetOrCreateAXTreeID(AXActionHandlerBase* handler);
 
  // Set a mapping between an AXTreeID and AXActionHandlerBase explicitly.
  void SetAXTreeID(const AXTreeID& ax_tree_id,
                   AXActionHandlerBase* action_handler);
 
  AXTreeIDRegistry();
  virtual ~AXTreeIDRegistry();
 
  // Maps an accessibility tree to its frame via ids.
  std::map<AXTreeID, FrameID> ax_tree_to_frame_id_map_;
 
  // Maps frames to an accessibility tree via ids.
  std::map<FrameID, AXTreeID> frame_to_ax_tree_id_map_;
 
  // Maps an id to its handler.
  std::map<AXTreeID, AXActionHandlerBase*> id_to_action_handler_;
 
  BASE_DISALLOW_COPY_AND_ASSIGN(AXTreeIDRegistry);
};
 
}  // namespace ui
 
#endif  // UI_ACCESSIBILITY_AX_TREE_ID_REGISTRY_H_