dali/devel-api/adaptor-framework/accessibility-bridge.h

   1 #ifndef DALI_ADAPTOR_ACCESSIBILITY_BRIDGE_H
   2 #define DALI_ADAPTOR_ACCESSIBILITY_BRIDGE_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/actors/actor.h>
  23 #include <dali/public-api/math/rect.h>
  24 #include <functional>
  25 #include <memory>
  26 #include <stdexcept>
  27 #include <string>
  28 #include <unordered_set>
  29
  30 // INTERNAL INCLUDES
  31 #include <dali/devel-api/adaptor-framework/accessibility.h>
  32 #include <dali/public-api/adaptor-framework/window.h>
  33
  34 namespace Dali
  35 {
  36 namespace Accessibility
  37 {
  38 class Accessible;
  39 class ProxyAccessible;
  40
  41 /**
  42  * @brief Base class for different accessibility bridges.
  43  *
  44  * Bridge is resposible for initializing and managing connection on accessibility bus.
  45  * Accessibility clients will not get any information about UI without initialized and upraised bridge.
  46  * Concrete implementation depends on the accessibility technology available on the platform.
  47  *
  48  * @note This class is singleton.
  49  */
  50 struct DALI_ADAPTOR_API Bridge
  51 {
  52   enum class ForceUpResult
  53   {
  54     JUST_STARTED,
  55     ALREADY_UP,
  56     FAILED
  57   };
  58
  59   /**
  60    * @brief Destructor
  61    */
  62   virtual ~Bridge() = default;
  63
  64   /**
  65    * @brief Gets bus name which bridge is initialized on.
  66    *
  67    * @return The bus name
  68    */
  69   virtual const std::string& GetBusName() const = 0;
  70
  71   /**
  72    * @brief Registers top level window.
  73    *
  74    * Hierarchy of objects visible for accessibility clients is based on tree-like
  75    * structure created from Actors objects. This method allows to connect chosen
  76    * object as direct ancestor of application and therefore make it visible for
  77    * accessibility clients.
  78    *
  79    * @param[in] object The accessible object
  80    */
  81   virtual void AddTopLevelWindow(Accessible* object) = 0;
  82
  83   /**
  84    * @brief Removes top level window.
  85    *
  86    * Hierarchy of objects visible for accessibility clients is based on tree-like
  87    * structure created from Actors objects. This method removes previously added
  88    * window from visible accessibility objects.
  89    *
  90    * @param[in] object The accessible object
  91    */
  92   virtual void RemoveTopLevelWindow(Accessible* object) = 0;
  93
  94   /**
  95    * @brief Adds object on the top of the stack of "default label" sourcing objects.
  96    *
  97    * @see GetDefaultLabel
  98    *
  99    * @param[in] object The accessible object
 100    */
 101   virtual void RegisterDefaultLabel(Accessible* object) = 0;
 102
 103   /**
 104    * @brief Removes object from the stack of "default label" sourcing objects.
 105    *
 106    * @see GetDefaultLabel
 107    *
 108    * @param[in] object The accessible object
 109    */
 110   virtual void UnregisterDefaultLabel(Accessible* object) = 0;
 111
 112   /**
 113    * @brief Gets the top-most object from the stack of "default label" sourcing objects.
 114    *
 115    * The "default label" is a reading material (text) derived from an accesibility object
 116    * that could be read by screen-reader immediately after the navigation context has changed
 117    * (window activates, popup shows up, tab changes) and before first UI element is highlighted.
 118    *
 119    * @param[in] root The root of the navigation context for which to retrieve the default label.
 120    *
 121    * @return The handler to accessibility object
 122    * @note This is a Tizen only feature not present in upstream ATSPI.
 123    * Feature can be enabled/disabled for particular context root object
 124    * by setting value of its accessibility attribute "default_label".
 125    * Following strings are valid values for "default_label" attribute: "enabled", "disabled".
 126    * Any other value will be interpreted as "enabled".
 127    */
 128   virtual Accessible* GetDefaultLabel(Accessible* root) const = 0;
 129
 130   /**
 131    * @brief Sets name of current application which will be visible on accessibility bus.
 132    *
 133    * @param[in] name The application name
 134    */
 135   virtual void SetApplicationName(std::string name) = 0;
 136
 137   /**
 138    * @brief Sets the name of the GUI toolkit that AT-SPI clients can query.
 139    *
 140    * The default name is "dali".
 141    *
 142    * @param toolkitName The toolkit name
 143    */
 144   virtual void SetToolkitName(std::string_view toolkitName) = 0;
 145
 146   /**
 147    * @brief Gets object being root of accessibility tree.
 148    *
 149    * @return handler to accessibility object
 150    */
 151   virtual Accessible* GetApplication() const = 0;
 152
 153   /**
 154    * @brief Finds an object in accessibility tree.
 155    *
 156    * @param[in] path The path to object
 157    *
 158    * @return The handler to accessibility object
 159    */
 160   virtual Accessible* FindByPath(const std::string& path) const = 0;
 161
 162   /**
 163    * @brief Notifies accessibility dbus that window has just been shown.
 164    *
 165    * @param[in] window The window to be shown
 166    */
 167   virtual void WindowShown(Window window) = 0;
 168
 169   /**
 170    * @brief Notifies accessibility dbus that window has just been hidden.
 171    *
 172    * @param[in] window The window to be hidden
 173    */
 174   virtual void WindowHidden(Window window) = 0;
 175
 176   /**
 177    * @brief Notifies accessibility dbus that window has just been focused.
 178    *
 179    * @param[in] window The window to be focused
 180    */
 181   virtual void WindowFocused(Window window) = 0;
 182
 183   /**
 184    * @brief Notifies accessibility dbus that window has just been out of focus.
 185    *
 186    * @param[in] window The window to be out of focus
 187    */
 188   virtual void WindowUnfocused(Window window) = 0;
 189
 190   /**
 191    * @brief Notifies accessibility dbus that window has just been minimized.
 192    *
 193    * @param[in] window The window to be minimized
 194    */
 195   virtual void WindowMinimized(Window window) = 0;
 196
 197   /**
 198    * @brief Notifies accessibility dbus that window has just been restored.
 199    *
 200    * @param[in] window The window to be restored
 201    * @param[in] detail Restored window state
 202    */
 203   virtual void WindowRestored(Window window, WindowRestoreType detail) = 0;
 204
 205   /**
 206    * @brief Notifies accessibility dbus that window has just been maximized.
 207    *
 208    * @param[in] window The window to be maximized
 209    */
 210   virtual void WindowMaximized(Window window) = 0;
 211
 212   /**
 213    * @brief Initializes accessibility bus.
 214    */
 215   virtual void Initialize() = 0;
 216
 217   /**
 218    * @brief Terminates accessibility bus.
 219    */
 220   virtual void Terminate() = 0;
 221
 222   /**
 223    * @brief This method is called, when bridge is being activated.
 224    */
 225   virtual ForceUpResult ForceUp()
 226   {
 227     if(mData)
 228     {
 229       return ForceUpResult::ALREADY_UP;
 230     }
 231     mData          = std::make_shared<Data>();
 232     mData->mBridge = this;
 233     return ForceUpResult::JUST_STARTED;
 234   }
 235
 236   /**
 237    * @brief This method is called, when bridge is being deactivated.
 238    */
 239   virtual void ForceDown() = 0;
 240
 241   /**
 242    * @brief Checks if bridge is activated or not.
 243    * @return True if brige is activated.
 244    */
 245   bool IsUp() const
 246   {
 247     return bool(mData);
 248   }
 249
 250   /**
 251    * @brief Emits cursor-moved event on at-spi bus.
 252    *
 253    * @param[in] obj The accessible object
 254    * @param[in] cursorPosition The new cursor position
 255    **/
 256   virtual void EmitCursorMoved(Accessible* obj, unsigned int cursorPosition) = 0;
 257
 258   /**
 259    * @brief Emits active-descendant-changed event on at-spi bus.
 260    *
 261    * @param[in] obj The accessible object
 262    * @param[in] child The child of the object
 263    **/
 264   virtual void EmitActiveDescendantChanged(Accessible* obj, Accessible* child) = 0;
 265
 266   /**
 267    * @brief Emits text-changed event on at-spi bus.
 268    *
 269    * @param[in] obj The accessible object
 270    * @param[in] state The changed state for text, such as Inserted or Deleted
 271    * @param[in] position The cursor position
 272    * @param[in] length The text length
 273    * @param[in] content The changed text
 274    **/
 275   virtual void EmitTextChanged(Accessible* obj, TextChangedState state, unsigned int position, unsigned int length, const std::string& content) = 0;
 276
 277   /**
 278    * @brief Emits MoveOuted event on at-spi bus.
 279    *
 280    * @param[in] obj Accessible object
 281    * @param[in] type Direction type when an Accessible object moves out of screen
 282    **/
 283   virtual void EmitMovedOutOfScreen(Accessible* obj, ScreenRelativeMoveType type) = 0;
 284
 285   /**
 286    * @brief Emits "org.a11y.atspi.Socket.Available" event on AT-SPI bus.
 287    *
 288    * @param obj Accessible object
 289    */
 290   virtual void EmitSocketAvailable(Accessible* obj) = 0;
 291
 292   /**
 293    * @brief Emits state-changed event on at-spi bus.
 294    *
 295    * @param[in] obj The accessible object
 296    * @param[in] state The accessibility state (SHOWING, HIGHLIGHTED, etc)
 297    * @param[in] newValue Whether the state value is changed to new value or not.
 298    * @param[in] reserved Reserved. (Currently, this argument is not implemented in dali)
 299    **/
 300   virtual void EmitStateChanged(Accessible* obj, State state, int newValue, int reserved = 0) = 0;
 301
 302   /**
 303    * @brief Emits window event on at-spi bus.
 304    *
 305    * @param[in] obj The accessible object
 306    * @param[in] event The enumerated window event
 307    * @param[in] detail The additional parameter which interpretation depends on chosen event
 308    **/
 309   virtual void Emit(Accessible* obj, WindowEvent event, unsigned int detail = 0) = 0;
 310
 311   /**
 312    * @brief Emits property-changed event on at-spi bus.
 313    *
 314    * @param[in] obj The accessible object
 315    * @param[in] event Property changed event
 316    **/
 317   virtual void Emit(Accessible* obj, ObjectPropertyChangeEvent event) = 0;
 318
 319   /**
 320    * @brief Emits bounds-changed event on at-spi bus.
 321    *
 322    * @param[in] obj The accessible object
 323    * @param[in] rect The rectangle for changed bounds
 324    **/
 325   virtual void EmitBoundsChanged(Accessible* obj, Rect<> rect) = 0;
 326
 327   /**
 328    * @brief Emits key event on at-spi bus.
 329    *
 330    * Screen-reader might receive this event and reply, that given keycode is consumed. In that case
 331    * further processing of the keycode should be ignored.
 332    *
 333    * @param[in] type Key event type
 334    * @param[in] keyCode Key code
 335    * @param[in] keyName Key name
 336    * @param[in] timeStamp Time stamp
 337    * @param[in] isText Whether it's text or not
 338    * @return Whether this event is consumed or not
 339    **/
 340   virtual Consumed Emit(KeyEventType type, unsigned int keyCode, const std::string& keyName, unsigned int timeStamp, bool isText) = 0;
 341
 342   /**
 343    * @brief Reads given text by screen reader
 344    *
 345    * @param[in] text The text to read
 346    * @param[in] discardable If TRUE, reading can be discarded by subsequent reading requests,
 347    * if FALSE the reading must finish before next reading request can be started
 348    * @param[in] callback the callback function that is called on reading signals emitted
 349    * during processing of this reading request.
 350    * Callback can be one of the following signals:
 351    * ReadingCancelled, ReadingStopped, ReadingSkipped
 352    */
 353   virtual void Say(const std::string& text, bool discardable, std::function<void(std::string)> callback) = 0;
 354
 355   /**
 356    * @brief Force accessibility client to pause.
 357    */
 358   virtual void Pause() = 0;
 359
 360   /**
 361    * @brief Force accessibility client to resume.
 362    */
 363   virtual void Resume() = 0;
 364
 365   /**
 366    * @brief Cancels anything screen-reader is reading / has queued to read
 367    *
 368    * @param[in] alsoNonDiscardable whether to cancel non-discardable readings as well
 369    */
 370   virtual void StopReading(bool alsoNonDiscardable) = 0;
 371
 372   /**
 373    * @brief Suppresses reading of screen-reader
 374    *
 375    * @param[in] suppress whether to suppress reading of screen-reader
 376    */
 377   virtual void SuppressScreenReader(bool suppress) = 0;
 378
 379   /**
 380    * @brief Gets screen reader status.
 381    *
 382    * @return True if screen reader is enabled
 383    */
 384   virtual bool GetScreenReaderEnabled() = 0;
 385
 386   /**
 387    * @brief Gets ATSPI status.
 388    *
 389    * @return True if ATSPI is enabled
 390    */
 391   virtual bool IsEnabled() = 0;
 392
 393   /**
 394    * @brief Calls socket.Embed(plug) via D-Bus.
 395    *
 396    * @param[in] plug The plug
 397    * @param[in] socket The socket
 398    *
 399    * @return Address returned by the D-Bus call.
 400    *
 401    * @note Remote object pointed to by 'socket' must implement 'org.a11y.atspi.Socket'.
 402    * @see UnembedSocket()
 403    */
 404   virtual Address EmbedSocket(const Address& plug, const Address& socket) = 0;
 405
 406   /**
 407    * @brief Calls socket.Embedded(plug) via D-Bus.
 408    *
 409    * The "Embedded" D-Bus method is an ATK extension.
 410    * See 'impl_Embedded' in AT_SPI2_ATK/atk-adaptor/adaptors/socket-adaptor.c for more information.
 411    *
 412    * @param[in] plug The plug
 413    * @param[in] socket The socket
 414    */
 415   virtual void EmbedAtkSocket(const Address& plug, const Address& socket) = 0;
 416
 417   /**
 418    * @brief Calls socket.Unmbed(plug) via D-Bus.
 419    *
 420    * @param[in] plug The plug
 421    * @param[in] socket The socket
 422    *
 423    * @note Remote object pointed to by 'socket' must implement 'org.a11y.atspi.Socket'.
 424    * @see EmbedSocket()
 425    */
 426   virtual void UnembedSocket(const Address& plug, const Address& socket) = 0;
 427
 428   /**
 429    * @brief Calls socket.SetOffset(x, y) via D-Bus.
 430    *
 431    * The "SetOffset" D-Bus method is a DALi extension. It can be used to inform a DALi widget about
 432    * its position on the screen.
 433    *
 434    * @param[in] socket The socket
 435    * @param[in] x Horizontal offset
 436    * @param[in] y Vertical offset
 437    *
 438    * @note Remote object pointed to by 'socket' must implement 'org.a11y.atspi.Socket'.
 439    * @see EmbedSocket()
 440    * @see SetExtentsOffset()
 441    */
 442   virtual void SetSocketOffset(ProxyAccessible* socket, std::int32_t x, std::int32_t y) = 0;
 443
 444   /**
 445    * @brief Sets the global extents offset.
 446    *
 447    * This offset will be added during serialization of GetExtents() return value to D-Bus.
 448    * Local calls to GetExtents() are unaffected.
 449    *
 450    * @param[in] x Horizontal offset
 451    * @param[in] y Vertical offset
 452    *
 453    * @see SetSocketOffset()
 454    * @see Dali::Accessibility::Component::GetExtents()
 455    */
 456   virtual void SetExtentsOffset(std::int32_t x, std::int32_t y) = 0;
 457
 458   /**
 459    * @brief Sets the preferred bus name.
 460    *
 461    * If the Bridge is enabled, it will immediately release the previous name and request the new one.
 462    *
 463    * Otherwise, the Bridge will request this name on AT-SPI activation (and release it on deactivation).
 464    * It is up to the caller to determine whether a given name will be available in the system.
 465    *
 466    * @param preferredBusName The preferred bus name
 467    */
 468   virtual void SetPreferredBusName(std::string_view preferredBusName) = 0;
 469
 470   /**
 471    * @brief Returns instance of bridge singleton object.
 472    *
 473    * @return The current bridge object
 474    **/
 475   static std::shared_ptr<Bridge> GetCurrentBridge();
 476
 477   /**
 478    * @brief Blocks auto-initialization of AT-SPI bridge
 479    *
 480    * Use this only if your application starts before DBus does, and call it early in main()
 481    * (before GetCurrentBridge() is called by anyone). GetCurrentBridge() will then return an
 482    * instance of DummyBridge.
 483    *
 484    * When DBus is ready, call EnableAutoInit(). Please note that GetCurrentBridge() may still
 485    * return an instance of DummyBridge if AT-SPI was disabled at compile time or using an
 486    * environment variable, or if creating the real bridge failed.
 487    *
 488    * @see Dali::Accessibility::DummyBridge
 489    * @see Dali::Accessibility::Bridge::EnableAutoInit
 490    */
 491   static void DisableAutoInit();
 492
 493   /**
 494    * @brief Re-enables auto-initialization of AT-SPI bridge
 495    *
 496    * Normal applications do not have to call this function. GetCurrentBridge() tries to
 497    * initialize the AT-SPI bridge when it is called for the first time.
 498    *
 499    * @see Dali::Accessibility::Bridge::DisableAutoInit
 500    * @see Dali::Accessibility::Bridge::AddTopLevelWindow
 501    * @see Dali::Accessibility::Bridge::SetApplicationName
 502    */
 503   static void EnableAutoInit();
 504
 505   /**
 506    * @brief Encodes a widget ID as a usable bus name.
 507    *
 508    * @param widgetInstanceId The instance ID of a widget
 509    * @return std::string Encoded bus name
 510    *
 511    * @see SetPreferredBusName
 512    */
 513   static std::string MakeBusNameForWidget(std::string_view widgetInstanceId);
 514
 515   static Signal<void()>& EnabledSignal()
 516   {
 517     return mEnabledSignal;
 518   }
 519
 520   static Signal<void()>& DisabledSignal()
 521   {
 522     return mDisabledSignal;
 523   }
 524
 525   static Signal<void()>& ScreenReaderEnabledSignal()
 526   {
 527     return mScreenReaderEnabledSignal;
 528   }
 529
 530   static Signal<void()>& ScreenReaderDisabledSignal()
 531   {
 532     return mScreenReaderDisabledSignal;
 533   }
 534
 535 protected:
 536   struct Data
 537   {
 538     std::unordered_set<const Accessible*> mKnownObjects;
 539     std::string                           mBusName;
 540     Bridge*                               mBridge = nullptr;
 541     Actor                                 mHighlightActor;
 542     Actor                                 mCurrentlyHighlightedActor;
 543     std::pair<std::int32_t, std::int32_t> mExtentsOffset{0, 0};
 544   };
 545   std::shared_ptr<Data> mData;
 546   friend class Accessible;
 547
 548   enum class AutoInitState
 549   {
 550     DISABLED,
 551     ENABLED
 552   };
 553
 554   inline static AutoInitState mAutoInitState = AutoInitState::ENABLED;
 555
 556   inline static Signal<void()> mEnabledSignal;
 557   inline static Signal<void()> mDisabledSignal;
 558   inline static Signal<void()> mScreenReaderEnabledSignal;
 559   inline static Signal<void()> mScreenReaderDisabledSignal;
 560
 561   /**
 562    * @brief Registers accessible object to be known in bridge object.
 563    *
 564    * Bridge must known about all currently alive accessible objects, as some requst
 565    * might come and object will be identified by number id (it's memory address).
 566    * To avoid memory corruption number id is checked against set of known objects.
 567    *
 568    * @param[in] object The accessible object
 569    **/
 570   void RegisterOnBridge(const Accessible* object);
 571
 572   /**
 573    * @brief Tells bridge, that given object is considered root (doesn't have any parents).
 574    *
 575    * All root objects will have the same parent - application object. Application object
 576    * is controlled by bridge and private.
 577    *
 578    * @param[in] owner The accessible object
 579    **/
 580   void SetIsOnRootLevel(Accessible* owner);
 581 };
 582
 583 /**
 584  * @brief Checks if ATSPI is activated or not.
 585  * @return True if ATSPI is activated.
 586  */
 587 inline bool IsUp()
 588 {
 589   if(Bridge::GetCurrentBridge() == nullptr)
 590   {
 591     return false;
 592   }
 593
 594   if(Bridge::GetCurrentBridge()->IsEnabled() == false)
 595   {
 596     return false;
 597   }
 598
 599   return Bridge::GetCurrentBridge()->IsUp();
 600 }
 601
 602 } // namespace Accessibility
 603 } // namespace Dali
 604
 605 #endif // DALI_ADAPTOR_ACCESSIBILITY_BRIDGE_H