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 Initializes accessibility bus.
 192    */
 193   virtual void Initialize() = 0;
 194
 195   /**
 196    * @brief Terminates accessibility bus.
 197    */
 198   virtual void Terminate() = 0;
 199
 200   /**
 201    * @brief This method is called, when bridge is being activated.
 202    */
 203   virtual ForceUpResult ForceUp()
 204   {
 205     if(mData)
 206     {
 207       return ForceUpResult::ALREADY_UP;
 208     }
 209     mData          = std::make_shared<Data>();
 210     mData->mBridge = this;
 211     return ForceUpResult::JUST_STARTED;
 212   }
 213
 214   /**
 215    * @brief This method is called, when bridge is being deactivated.
 216    */
 217   virtual void ForceDown() = 0;
 218
 219   /**
 220    * @brief Checks if bridge is activated or not.
 221    * @return True if brige is activated.
 222    */
 223   bool IsUp() const
 224   {
 225     return bool(mData);
 226   }
 227
 228   /**
 229    * @brief Emits cursor-moved event on at-spi bus.
 230    *
 231    * @param[in] obj The accessible object
 232    * @param[in] cursorPosition The new cursor position
 233    **/
 234   virtual void EmitCursorMoved(Accessible* obj, unsigned int cursorPosition) = 0;
 235
 236   /**
 237    * @brief Emits active-descendant-changed event on at-spi bus.
 238    *
 239    * @param[in] obj The accessible object
 240    * @param[in] child The child of the object
 241    **/
 242   virtual void EmitActiveDescendantChanged(Accessible* obj, Accessible* child) = 0;
 243
 244   /**
 245    * @brief Emits text-changed event on at-spi bus.
 246    *
 247    * @param[in] obj The accessible object
 248    * @param[in] state The changed state for text, such as Inserted or Deleted
 249    * @param[in] position The cursor position
 250    * @param[in] length The text length
 251    * @param[in] content The changed text
 252    **/
 253   virtual void EmitTextChanged(Accessible* obj, TextChangedState state, unsigned int position, unsigned int length, const std::string& content) = 0;
 254
 255   /**
 256    * @brief Emits MoveOuted event on at-spi bus.
 257    *
 258    * @param[in] obj Accessible object
 259    * @param[in] type Direction type when an Accessible object moves out of screen
 260    **/
 261   virtual void EmitMovedOutOfScreen(Accessible* obj, ScreenRelativeMoveType type) = 0;
 262
 263   /**
 264    * @brief Emits "org.a11y.atspi.Socket.Available" event on AT-SPI bus.
 265    *
 266    * @param obj Accessible object
 267    */
 268   virtual void EmitSocketAvailable(Accessible* obj) = 0;
 269
 270   /**
 271    * @brief Emits state-changed event on at-spi bus.
 272    *
 273    * @param[in] obj The accessible object
 274    * @param[in] state The accessibility state (SHOWING, HIGHLIGHTED, etc)
 275    * @param[in] newValue Whether the state value is changed to new value or not.
 276    * @param[in] reserved Reserved. (Currently, this argument is not implemented in dali)
 277    **/
 278   virtual void EmitStateChanged(Accessible* obj, State state, int newValue, int reserved = 0) = 0;
 279
 280   /**
 281    * @brief Emits window event on at-spi bus.
 282    *
 283    * @param[in] obj The accessible object
 284    * @param[in] event The enumerated window event
 285    * @param[in] detail The additional parameter which interpretation depends on chosen event
 286    **/
 287   virtual void Emit(Accessible* obj, WindowEvent event, unsigned int detail = 0) = 0;
 288
 289   /**
 290    * @brief Emits property-changed event on at-spi bus.
 291    *
 292    * @param[in] obj The accessible object
 293    * @param[in] event Property changed event
 294    **/
 295   virtual void Emit(Accessible* obj, ObjectPropertyChangeEvent event) = 0;
 296
 297   /**
 298    * @brief Emits bounds-changed event on at-spi bus.
 299    *
 300    * @param[in] obj The accessible object
 301    * @param[in] rect The rectangle for changed bounds
 302    **/
 303   virtual void EmitBoundsChanged(Accessible* obj, Rect<> rect) = 0;
 304
 305   /**
 306    * @brief Emits key event on at-spi bus.
 307    *
 308    * Screen-reader might receive this event and reply, that given keycode is consumed. In that case
 309    * further processing of the keycode should be ignored.
 310    *
 311    * @param[in] type Key event type
 312    * @param[in] keyCode Key code
 313    * @param[in] keyName Key name
 314    * @param[in] timeStamp Time stamp
 315    * @param[in] isText Whether it's text or not
 316    * @return Whether this event is consumed or not
 317    **/
 318   virtual Consumed Emit(KeyEventType type, unsigned int keyCode, const std::string& keyName, unsigned int timeStamp, bool isText) = 0;
 319
 320   /**
 321    * @brief Reads given text by screen reader
 322    *
 323    * @param[in] text The text to read
 324    * @param[in] discardable If TRUE, reading can be discarded by subsequent reading requests,
 325    * if FALSE the reading must finish before next reading request can be started
 326    * @param[in] callback the callback function that is called on reading signals emitted
 327    * during processing of this reading request.
 328    * Callback can be one of the following signals:
 329    * ReadingCancelled, ReadingStopped, ReadingSkipped
 330    */
 331   virtual void Say(const std::string& text, bool discardable, std::function<void(std::string)> callback) = 0;
 332
 333   /**
 334    * @brief Force accessibility client to pause.
 335    */
 336   virtual void Pause() = 0;
 337
 338   /**
 339    * @brief Force accessibility client to resume.
 340    */
 341   virtual void Resume() = 0;
 342
 343   /**
 344    * @brief Cancels anything screen-reader is reading / has queued to read
 345    *
 346    * @param[in] alsoNonDiscardable whether to cancel non-discardable readings as well
 347    */
 348   virtual void StopReading(bool alsoNonDiscardable) = 0;
 349
 350   /**
 351    * @brief Suppresses reading of screen-reader
 352    *
 353    * @param[in] suppress whether to suppress reading of screen-reader
 354    */
 355   virtual void SuppressScreenReader(bool suppress) = 0;
 356
 357   /**
 358    * @brief Gets screen reader status.
 359    *
 360    * @return True if screen reader is enabled
 361    */
 362   virtual bool GetScreenReaderEnabled() = 0;
 363
 364   /**
 365    * @brief Gets ATSPI status.
 366    *
 367    * @return True if ATSPI is enabled
 368    */
 369   virtual bool IsEnabled() = 0;
 370
 371   /**
 372    * @brief Calls socket.Embed(plug) via D-Bus.
 373    *
 374    * @param[in] plug The plug
 375    * @param[in] socket The socket
 376    *
 377    * @return Address returned by the D-Bus call.
 378    *
 379    * @note Remote object pointed to by 'socket' must implement 'org.a11y.atspi.Socket'.
 380    * @see UnembedSocket()
 381    */
 382   virtual Address EmbedSocket(const Address& plug, const Address& socket) = 0;
 383
 384   /**
 385    * @brief Calls socket.Embedded(plug) via D-Bus.
 386    *
 387    * The "Embedded" D-Bus method is an ATK extension.
 388    * See 'impl_Embedded' in AT_SPI2_ATK/atk-adaptor/adaptors/socket-adaptor.c for more information.
 389    *
 390    * @param[in] plug The plug
 391    * @param[in] socket The socket
 392    */
 393   virtual void EmbedAtkSocket(const Address& plug, const Address& socket) = 0;
 394
 395   /**
 396    * @brief Calls socket.Unmbed(plug) via D-Bus.
 397    *
 398    * @param[in] plug The plug
 399    * @param[in] socket The socket
 400    *
 401    * @note Remote object pointed to by 'socket' must implement 'org.a11y.atspi.Socket'.
 402    * @see EmbedSocket()
 403    */
 404   virtual void UnembedSocket(const Address& plug, const Address& socket) = 0;
 405
 406   /**
 407    * @brief Calls socket.SetOffset(x, y) via D-Bus.
 408    *
 409    * The "SetOffset" D-Bus method is a DALi extension. It can be used to inform a DALi widget about
 410    * its position on the screen.
 411    *
 412    * @param[in] socket The socket
 413    * @param[in] x Horizontal offset
 414    * @param[in] y Vertical offset
 415    *
 416    * @note Remote object pointed to by 'socket' must implement 'org.a11y.atspi.Socket'.
 417    * @see EmbedSocket()
 418    * @see SetExtentsOffset()
 419    */
 420   virtual void SetSocketOffset(ProxyAccessible* socket, std::int32_t x, std::int32_t y) = 0;
 421
 422   /**
 423    * @brief Sets the global extents offset.
 424    *
 425    * This offset will be added during serialization of GetExtents() return value to D-Bus.
 426    * Local calls to GetExtents() are unaffected.
 427    *
 428    * @param[in] x Horizontal offset
 429    * @param[in] y Vertical offset
 430    *
 431    * @see SetSocketOffset()
 432    * @see Dali::Accessibility::Component::GetExtents()
 433    */
 434   virtual void SetExtentsOffset(std::int32_t x, std::int32_t y) = 0;
 435
 436   /**
 437    * @brief Sets the preferred bus name.
 438    *
 439    * If the Bridge is enabled, it will immediately release the previous name and request the new one.
 440    *
 441    * Otherwise, the Bridge will request this name on AT-SPI activation (and release it on deactivation).
 442    * It is up to the caller to determine whether a given name will be available in the system.
 443    *
 444    * @param preferredBusName The preferred bus name
 445    */
 446   virtual void SetPreferredBusName(std::string_view preferredBusName) = 0;
 447
 448   /**
 449    * @brief Returns instance of bridge singleton object.
 450    *
 451    * @return The current bridge object
 452    **/
 453   static std::shared_ptr<Bridge> GetCurrentBridge();
 454
 455   /**
 456    * @brief Blocks auto-initialization of AT-SPI bridge
 457    *
 458    * Use this only if your application starts before DBus does, and call it early in main()
 459    * (before GetCurrentBridge() is called by anyone). GetCurrentBridge() will then return an
 460    * instance of DummyBridge.
 461    *
 462    * When DBus is ready, call EnableAutoInit(). Please note that GetCurrentBridge() may still
 463    * return an instance of DummyBridge if AT-SPI was disabled at compile time or using an
 464    * environment variable, or if creating the real bridge failed.
 465    *
 466    * @see Dali::Accessibility::DummyBridge
 467    * @see Dali::Accessibility::Bridge::EnableAutoInit
 468    */
 469   static void DisableAutoInit();
 470
 471   /**
 472    * @brief Re-enables auto-initialization of AT-SPI bridge
 473    *
 474    * Normal applications do not have to call this function. GetCurrentBridge() tries to
 475    * initialize the AT-SPI bridge when it is called for the first time.
 476    *
 477    * @see Dali::Accessibility::Bridge::DisableAutoInit
 478    * @see Dali::Accessibility::Bridge::AddTopLevelWindow
 479    * @see Dali::Accessibility::Bridge::SetApplicationName
 480    */
 481   static void EnableAutoInit();
 482
 483   /**
 484    * @brief Encodes a widget ID as a usable bus name.
 485    *
 486    * @param widgetInstanceId The instance ID of a widget
 487    * @return std::string Encoded bus name
 488    *
 489    * @see SetPreferredBusName
 490    */
 491   static std::string MakeBusNameForWidget(std::string_view widgetInstanceId);
 492
 493   static Signal<void()>& EnabledSignal()
 494   {
 495     return mEnabledSignal;
 496   }
 497
 498   static Signal<void()>& DisabledSignal()
 499   {
 500     return mDisabledSignal;
 501   }
 502
 503   static Signal<void()>& ScreenReaderEnabledSignal()
 504   {
 505     return mScreenReaderEnabledSignal;
 506   }
 507
 508   static Signal<void()>& ScreenReaderDisabledSignal()
 509   {
 510     return mScreenReaderDisabledSignal;
 511   }
 512
 513 protected:
 514   struct Data
 515   {
 516     std::unordered_set<const Accessible*> mKnownObjects;
 517     std::string                           mBusName;
 518     Bridge*                               mBridge = nullptr;
 519     Actor                                 mHighlightActor;
 520     Actor                                 mCurrentlyHighlightedActor;
 521     std::pair<std::int32_t, std::int32_t> mExtentsOffset{0, 0};
 522   };
 523   std::shared_ptr<Data> mData;
 524   friend class Accessible;
 525
 526   enum class AutoInitState
 527   {
 528     DISABLED,
 529     ENABLED
 530   };
 531
 532   inline static AutoInitState mAutoInitState = AutoInitState::ENABLED;
 533
 534   inline static Signal<void()> mEnabledSignal;
 535   inline static Signal<void()> mDisabledSignal;
 536   inline static Signal<void()> mScreenReaderEnabledSignal;
 537   inline static Signal<void()> mScreenReaderDisabledSignal;
 538
 539   /**
 540    * @brief Registers accessible object to be known in bridge object.
 541    *
 542    * Bridge must known about all currently alive accessible objects, as some requst
 543    * might come and object will be identified by number id (it's memory address).
 544    * To avoid memory corruption number id is checked against set of known objects.
 545    *
 546    * @param[in] object The accessible object
 547    **/
 548   void RegisterOnBridge(const Accessible* object);
 549
 550   /**
 551    * @brief Tells bridge, that given object is considered root (doesn't have any parents).
 552    *
 553    * All root objects will have the same parent - application object. Application object
 554    * is controlled by bridge and private.
 555    *
 556    * @param[in] owner The accessible object
 557    **/
 558   void SetIsOnRootLevel(Accessible* owner);
 559 };
 560
 561 /**
 562  * @brief Checks if ATSPI is activated or not.
 563  * @return True if ATSPI is activated.
 564  */
 565 inline bool IsUp()
 566 {
 567   if(Bridge::GetCurrentBridge() == nullptr)
 568   {
 569     return false;
 570   }
 571
 572   if(Bridge::GetCurrentBridge()->IsEnabled() == false)
 573   {
 574     return false;
 575   }
 576
 577   return Bridge::GetCurrentBridge()->IsUp();
 578 }
 579
 580 } // namespace Accessibility
 581 } // namespace Dali
 582
 583 #endif // DALI_ADAPTOR_ACCESSIBILITY_BRIDGE_H