accessible/android/RemoteAccessibleWrap.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. *
   6  */
   7
   8 #ifndef MOZILLA_A11Y_RemoteAccessibleWrap_h
   9 #define MOZILLA_A11Y_RemoteAccessibleWrap_h
  10
  11 #include "AccessibleWrap.h"
  12 #include "DocAccessibleParent.h"
  13
  14 namespace mozilla {
  15 namespace a11y {
  16
  17 /**
  18  * A wrapper for Accessible proxies. The public methods here should be
  19  * overriden from AccessibleWrap or its super classes. This gives us an
  20  * abstraction layer so SessionAccessibility doesn't have to distinguish between
  21  * a local or remote accessibles. NOTE: This shouldn't be regarded as a full
  22  * Accessible implementation.
  23  */
  24 class RemoteAccessibleWrap : public AccessibleWrap {
  25  public:
  26   explicit RemoteAccessibleWrap(RemoteAccessible* aProxy);
  27
  28   virtual void Shutdown() override;
  29
  30   // LocalAccessible
  31
  32   virtual already_AddRefed<AccAttributes> Attributes() override;
  33
  34   virtual uint32_t ChildCount() const override;
  35
  36   virtual LocalAccessible* LocalChildAt(uint32_t aIndex) const override;
  37
  38   virtual ENameValueFlag Name(nsString& aName) const override;
  39
  40   virtual void Value(nsString& aValue) const override;
  41
  42   virtual uint64_t State() override;
  43
  44   virtual nsIntRect Bounds() const override;
  45
  46   MOZ_CAN_RUN_SCRIPT
  47   virtual void ScrollTo(uint32_t aHow) const override;
  48
  49   virtual uint8_t ActionCount() const override;
  50
  51   virtual bool DoAction(uint8_t aIndex) const override;
  52
  53   // AccessibleWrap
  54
  55   virtual void SetTextContents(const nsAString& aText) override;
  56
  57   virtual void GetTextContents(nsAString& aText) override;
  58
  59   virtual bool GetSelectionBounds(int32_t* aStartOffset,
  60                                   int32_t* aEndOffset) override;
  61
  62   virtual void PivotTo(int32_t aGranularity, bool aForward,
  63                        bool aInclusive) override;
  64
  65   virtual void NavigateText(int32_t aGranularity, int32_t aStartOffset,
  66                             int32_t aEndOffset, bool aForward,
  67                             bool aSelect) override;
  68
  69   virtual void SetSelection(int32_t aStart, int32_t aEnd) override;
  70
  71   virtual void Cut() override;
  72
  73   virtual void Copy() override;
  74
  75   virtual void Paste() override;
  76
  77   virtual void ExploreByTouch(float aX, float aY) override;
  78
  79   virtual void WrapperDOMNodeID(nsString& aDOMNodeID) override;
  80
  81  private:
  82   virtual role WrapperRole() override;
  83
  84   virtual AccessibleWrap* WrapperParent() override;
  85
  86   virtual bool WrapperRangeInfo(double* aCurVal, double* aMinVal,
  87                                 double* aMaxVal, double* aStep) override;
  88 };
  89
  90 class DocRemoteAccessibleWrap : public RemoteAccessibleWrap {
  91  public:
  92   explicit DocRemoteAccessibleWrap(DocAccessibleParent* aProxy)
  93       : RemoteAccessibleWrap(aProxy) {
  94     mGenericTypes |= eDocument;
  95
  96     if (aProxy->IsTopLevel()) {
  97       mID = kNoID;
  98     } else {
  99       mID = AcquireID();
 100     }
 101   }
 102
 103   virtual void Shutdown() override {
 104     if (mID) {
 105       auto doc = static_cast<DocAccessibleParent*>(Proxy());
 106       if (!doc->IsTopLevel()) {
 107         MOZ_ASSERT(mID != kNoID, "A non root accessible must have an id");
 108         ReleaseID(mID);
 109       }
 110     }
 111     mID = 0;
 112     mBits.proxy = nullptr;
 113     mStateFlags |= eIsDefunct;
 114   }
 115
 116   DocRemoteAccessibleWrap* ParentDocument() {
 117     DocAccessibleParent* proxy = static_cast<DocAccessibleParent*>(Proxy());
 118     MOZ_ASSERT(proxy);
 119     if (DocAccessibleParent* parent = proxy->ParentDoc()) {
 120       return reinterpret_cast<DocRemoteAccessibleWrap*>(parent->GetWrapper());
 121     }
 122
 123     return nullptr;
 124   }
 125
 126   DocRemoteAccessibleWrap* GetChildDocumentAt(uint32_t aIndex) {
 127     auto doc = Proxy()->AsDoc();
 128     if (doc && doc->ChildDocCount() > aIndex) {
 129       return reinterpret_cast<DocRemoteAccessibleWrap*>(
 130           doc->ChildDocAt(aIndex)->GetWrapper());
 131     }
 132
 133     return nullptr;
 134   }
 135
 136   void AddID(uint32_t aID, AccessibleWrap* aAcc) {
 137     mIDToAccessibleMap.InsertOrUpdate(aID, aAcc);
 138   }
 139   void RemoveID(uint32_t aID) { mIDToAccessibleMap.Remove(aID); }
 140   AccessibleWrap* GetAccessibleByID(uint32_t aID) const {
 141     return mIDToAccessibleMap.Get(aID);
 142   }
 143
 144  private:
 145   /*
 146    * This provides a mapping from 32 bit id to accessible objects.
 147    */
 148   nsTHashMap<nsUint32HashKey, AccessibleWrap*> mIDToAccessibleMap;
 149 };
 150 }  // namespace a11y
 151 }  // namespace mozilla
 152
 153 #endif