1 #ifndef DALI_INTERNAL_ATSPI_ACCESSIBILITY_IMPL_H
2 #define DALI_INTERNAL_ATSPI_ACCESSIBILITY_IMPL_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/actors/actor.h>
23 #include <dali/public-api/math/rect.h>
24 #include <dali/public-api/object/object-registry.h>
32 #include <unordered_map>
33 #include <unordered_set>
37 #include <dali/devel-api/adaptor-framework/accessibility.h>
38 #include <dali/integration-api/debug.h>
42 namespace Accessibility
44 class DALI_ADAPTOR_API Accessible;
45 class DALI_ADAPTOR_API Text;
46 class DALI_ADAPTOR_API Value;
47 class DALI_ADAPTOR_API Component;
48 class DALI_ADAPTOR_API Collection;
49 class DALI_ADAPTOR_API Action;
52 * @brief Base class for different accessibility bridges
54 * Bridge is resposible for initializing and managing connection on accessibility bus.
55 * Accessibility clients will not get any information about UI without initialized and upraised bridge.
56 * Concrete implementation depends on the accessibility technology available on the platform.
58 * @note This class is singleton.
60 struct DALI_ADAPTOR_API Bridge
62 enum class ForceUpResult
71 virtual ~Bridge() = default;
74 * @brief Get bus name which bridge is initialized on
76 virtual const std::string& GetBusName() const = 0;
79 * @brief Registers top level window
81 * Hierarchy of objects visible for accessibility clients is based on tree-like
82 * structure created from Actors objects. This method allows to connect chosen
83 * object as direct ancestor of application and therefore make it visible for
84 * accessibility clients.
86 virtual void AddTopLevelWindow(Accessible*) = 0;
89 * @brief Removes top level window
91 * Hierarchy of objects visible for accessibility clients is based on tree-like
92 * structure created from Actors objects. This method removes previously added
93 * window from visible accessibility objects.
95 virtual void RemoveTopLevelWindow(Accessible*) = 0;
98 * @brief Adds popup window
100 * Hierarchy of objects visible for accessibility clients is based on tree-like
101 * structure created from Actors objects. This method adds new popup to the tree.
103 virtual void AddPopup(Accessible*) = 0;
106 * @brief Removes popup window
108 * Hierarchy of objects visible for accessibility clients is based on tree-like
109 * structure created from Actors objects. This method removes previously added
112 virtual void RemovePopup(Accessible*) = 0;
115 * @brief Set name of current application which will be visible on accessibility bus
117 virtual void SetApplicationName(std::string) = 0;
120 * @brief Get object being root of accessibility tree
122 * @return handler to accessibility object
124 virtual Accessible* GetApplication() const = 0;
127 * @brief Find an object in accessibility tree
129 * @param[in] s path to object
131 * @return handler to accessibility object
133 virtual Accessible* FindByPath(const std::string& s) const = 0;
136 * @brief Show application on accessibility bus
138 virtual void ApplicationShown() = 0;
141 * @brief Hide application on accessibility bus
143 virtual void ApplicationHidden() = 0;
146 * @brief Initialize accessibility bus
148 virtual void Initialize() = 0;
151 * @brief Terminate accessibility bus
153 virtual void Terminate() = 0;
156 * @brief This method is called, when bridge is being activated.
158 virtual ForceUpResult ForceUp()
162 return ForceUpResult::ALREADY_UP;
164 data = std::make_shared<Data>();
166 return ForceUpResult::JUST_STARTED;
170 * @brief This method is called, when bridge is being deactivated.
172 virtual void ForceDown() = 0;
175 * @brief Check if bridge is activated or not.
176 * @return True if brige is activated.
184 * @brief Emits caret-moved event on at-spi bus.
186 virtual void EmitCaretMoved(Accessible* obj, unsigned int cursorPosition) = 0;
189 * @brief Emits active-descendant-changed event on at-spi bus.
191 virtual void EmitActiveDescendantChanged(Accessible* obj, Accessible* child) = 0;
194 * @brief Emits text-changed event on at-spi bus.
196 virtual void EmitTextChanged(Accessible* obj, TextChangedState state, unsigned int position, unsigned int length, const std::string& content) = 0;
199 * @brief Emits state-changed event on at-spi bus.
201 virtual void EmitStateChanged(Accessible* obj, State state, int val1, int val2 = 0) = 0;
204 * @brief Emits window event on at-spi bus.
206 virtual void Emit(Accessible* obj, WindowEvent we, unsigned int detail1 = 0) = 0;
209 * @brief Emits property-changed event on at-spi bus.
211 virtual void Emit(Accessible* obj, ObjectPropertyChangeEvent event) = 0;
214 * @brief Emits bounds-changed event on at-spi bus.
216 virtual void EmitBoundsChanged(Accessible* obj, Rect<> rect) = 0;
219 * @brief Emits key event on at-spi bus.
221 * Screen-reader might receive this event and reply, that given keycode is consumed. In that case
222 * further processing of the keycode should be ignored.
224 virtual Consumed Emit(KeyEventType type, unsigned int keyCode, const std::string& keyName, unsigned int timeStamp, bool isText) = 0;
227 * @brief Reads given text by screen reader
229 * @param text The text to read
230 * @param discardable If TRUE, reading can be discarded by subsequent reading requests,
231 * if FALSE the reading must finish before next reading request can be started
232 * @param callback the callback function that is called on reading signals emitted
233 * during processing of this reading request.
234 * Callback can be one of the following signals:
235 * ReadingCancelled, ReadingStopped, ReadingSkipped
237 virtual void Say(const std::string& text, bool discardable, std::function<void(std::string)> callback) = 0;
240 * @brief Force accessibility client to pause.
242 virtual void Pause() = 0;
245 * @brief Force accessibility client to resume.
247 virtual void Resume() = 0;
250 * @brief Cancels anything screen-reader is reading / has queued to read
252 * @param alsoNonDiscardable whether to cancel non-discardable readings as well
254 virtual void StopReading(bool alsoNonDiscardable) = 0;
257 * @brief Get screen reader status.
259 virtual bool GetScreenReaderEnabled() = 0;
262 * @brief Get ATSPI status.
264 virtual bool GetIsEnabled() = 0;
267 * @brief Returns instance of bridge singleton object.
269 static Bridge* GetCurrentBridge();
274 std::unordered_set<Accessible*> knownObjects;
276 Bridge* bridge = nullptr;
277 Actor highlightActor, currentlyHighlightedActor;
279 std::shared_ptr<Data> data;
280 friend class Accessible;
283 * @brief Registers accessible object to be known in bridge object
285 * Bridge must known about all currently alive accessible objects, as some requst
286 * might come and object will be identified by number id (it's memory address).
287 * To avoid memory corruption number id is checked against set of known objects.
289 void RegisterOnBridge(Accessible*);
292 * @brief Tells bridge, that given object is considered root (doesn't have any parents).
294 * All root objects will have the same parent - application object. Application object
295 * is controlled by bridge and private.
297 void SetIsOnRootLevel(Accessible*);
301 * @brief Check if ATSPI is activated or not.
302 * @return True if ATSPI is activated.
306 if(Bridge::GetCurrentBridge() == nullptr)
310 if(Bridge::GetCurrentBridge()->GetIsEnabled() == false)
314 return Bridge::GetCurrentBridge()->IsUp();
318 * @brief Basic interface implemented by all accessibility objects
323 virtual ~Accessible();
325 using utf8_t = unsigned char;
328 * @brief Calculaties word boundaries in given utf8 text.
330 * s and length represents source text pointer and it's length respectively. langauge represents
331 * language to use. Word boundaries are returned as non-zero values in table breaks, which
332 * must be of size at least length.
334 void FindWordSeparationsUtf8(const utf8_t* s, size_t length, const char* language, char* breaks);
337 * @brief Calculaties line boundaries in given utf8 text.
339 * s and length represents source text pointer and it's length respectively. langauge represents
340 * language to use. Line boundaries are returned as non-zero values in table breaks, which
341 * must be of size at least length.
343 void FindLineSeparationsUtf8(const utf8_t* s, size_t length, const char* language, char* breaks);
346 * @brief Helper function for emiting active-descendant-changed event
348 void EmitActiveDescendantChanged(Accessible* obj, Accessible* child);
351 * @brief Helper function for emiting state-changed event
353 void EmitStateChanged(State state, int newValue1, int newValue2 = 0);
356 * @brief Helper function for emiting bounds-changed event
358 void EmitBoundsChanged(Rect<> rect);
361 * @brief Emit "showing" event.
362 * The method inform accessibility clients about "showing" state
364 * @param[in] showing flag pointing if object is showing
366 void EmitShowing(bool showing);
369 * @brief Emit "visible" event.
370 * The method inform accessibility clients about "visible" state
372 * @param[in] visible flag pointing if object is visible
374 void EmitVisible(bool visible);
377 * @brief Emit "highlighted" event.
378 * The method inform accessibility clients about "highlighted" state
380 * @param[in] set flag pointing if object is highlighted
382 void EmitHighlighted(bool set);
385 * @brief Emit "focused" event.
386 * The method inform accessibility clients about "focused" state
388 * @param[in] set flag pointing if object is focused
390 void EmitFocused(bool set);
393 * @brief Emit "text inserted" event
395 * @param[in] position caret position
396 * @param[in] length text length
397 * @param[in] content inserted text
399 void EmitTextInserted(unsigned int position, unsigned int length, const std::string& content);
402 * @brief Emit "text deleted" event
404 * @param[in] position caret position
405 * @param[in] length text length
406 * @param[in] content deleted text
408 void EmitTextDeleted(unsigned int position, unsigned int length, const std::string& content);
411 * @brief Emit "caret moved" event
413 * @param[in] cursorPosition new caret position
415 void EmitTextCaretMoved(unsigned int cursorPosition);
418 * @brief Emit "highlighted" event
420 * @param[in] we enumerated window event
421 * @param[in] detail1 additional parameter which interpretation depends on chosen event
423 void Emit(WindowEvent we, unsigned int detail1 = 0);
426 * @brief Emits property-changed event
427 * @param[in] event Property changed event
429 void Emit(ObjectPropertyChangeEvent event);
432 * @brief Get accessibility name
434 * @return string with name
436 virtual std::string GetName() = 0;
439 * @brief Get accessibility description
441 * @return string with description
443 virtual std::string GetDescription() = 0;
448 * @return handler to accessibility object
450 virtual Accessible* GetParent() = 0;
453 * @brief Get count of children
455 * @return unsigned integer value
457 virtual size_t GetChildCount() = 0;
460 * @brief Get collection with all children
462 * @return collection of accessibility objects
464 virtual std::vector<Accessible*> GetChildren();
467 * @brief Get nth child
469 * @return accessibility object
471 virtual Accessible* GetChildAtIndex(size_t index) = 0;
474 * @brief Get index that current object has in its parent's children collection
476 * @return unsigned integer index
478 virtual size_t GetIndexInParent() = 0;
481 * @brief Get accessibility role
483 * @return Role enumeration
485 * @see Dali::Accessibility::Role
487 virtual Role GetRole() = 0;
490 * @brief Get name of accessibility role
492 * @return string with human readable role converted from enumeration
494 * @see Dali::Accessibility::Role
495 * @see Accessibility::Accessible::GetRole
497 virtual std::string GetRoleName();
500 * @brief Get localized name of accessibility role
502 * @return string with human readable role translated according to current
505 * @see Dali::Accessibility::Role
506 * @see Accessibility::Accessible::GetRole
507 * @see Accessibility::Accessible::GetRoleName
509 * @note translation is not supported in this version
511 virtual std::string GetLocalizedRoleName();
514 * @brief Get accessibility states
516 * @return collection of states
518 * @note States class is instatation of ArrayBitset template class
520 * @see Dali::Accessibility::State
521 * @see Dali::Accessibility::ArrayBitset
523 virtual States GetStates() = 0;
526 * @brief Get accessibility attributes
528 * @return map of attributes and their values
530 virtual Attributes GetAttributes() = 0;
533 * @brief Check if this is proxy
535 * @return True if this is proxy
537 virtual bool IsProxy();
540 * @brief Get unique address on accessibility bus
542 * @return class containing address
544 * @see Dali::Accessibility::Address
546 virtual Address GetAddress();
549 * @brief Get accessibility object, which is "default label" for this object
551 virtual Accessible* GetDefaultLabel();
554 * @brief Depute an object to perform provided gesture
556 * @param[in] gestureInfo structure describing the gesture
558 * @return true on success, false otherwise
560 * @see Dali::Accessibility::GestureInfo
562 virtual bool DoGesture(const GestureInfo& gestureInfo) = 0;
565 * @brief Re-emits selected states of an Accessibility Object
567 * @param[in] states chosen states to re-emit
568 * @param[in] doRecursive if true all children of the Accessibility Object will also re-emit the states
570 void NotifyAccessibilityStateChange(Dali::Accessibility::States states, bool doRecursive);
573 * @brief Get information about current object and all relations that connects
574 * it with other accessibility objects
576 * @return iterable collection of Relation objects
578 * @see Dali::Accessibility::Relation
580 virtual std::vector<Relation> GetRelationSet() = 0;
583 * @brief Get all implemented interfaces
585 * @return collection of strings with implemented interfaces
587 std::vector<std::string> GetInterfaces();
590 * @brief Check if object is on root level
592 bool GetIsOnRootLevel() const
594 return isOnRootLevel;
598 * @brief The method registers functor resposible for converting Actor into Accessible
599 * @param functor returning Accessible handle from Actor object
601 static void RegisterControlAccessibilityGetter(std::function<Accessible*(Dali::Actor)> functor);
604 * @brief Acquire Accessible object from Actor object
606 * @param[in] actor Actor object
607 * @param[in] root true, if it's top level object (window)
609 * @return handle to Accessible object
611 static Accessible* Get(Dali::Actor actor, bool root = false);
615 Accessible(const Accessible&) = delete;
616 Accessible(Accessible&&) = delete;
617 Accessible& operator=(const Accessible&) = delete;
618 Accessible& operator=(Accessible&&) = delete;
619 std::shared_ptr<Bridge::Data> GetBridgeData();
622 static Dali::Actor GetHighlightActor();
623 static void SetHighlightActor(Dali::Actor actor);
624 static Dali::Actor GetCurrentlyHighlightedActor();
625 static void SetCurrentlyHighlightedActor(Dali::Actor);
626 static void SetObjectRegistry(ObjectRegistry registry);
631 std::weak_ptr<Bridge::Data> bridgeData;
632 bool isOnRootLevel = false;
636 * @brief Interface enabling to perform provided actions
638 class Action : public virtual Accessible
642 * @brief Get name of action with given index
644 * @param[in] index index of action
646 * @return string with name of action
648 virtual std::string GetActionName(size_t index) = 0;
651 * @brief Get translated name of action with given index
653 * @param[in] index index of action
655 * @return string with name of action translated according to current translation domain
657 * @note translation is not supported in this version
659 virtual std::string GetLocalizedActionName(size_t index) = 0;
662 * @brief Get description of action with given index
664 * @param[in] index index of action
666 * @return string with description of action
668 virtual std::string GetActionDescription(size_t index) = 0;
671 * @brief Get key code binded to action with given index
673 * @param[in] index index of action
675 * @return string with key name
677 virtual std::string GetActionKeyBinding(size_t index) = 0;
680 * @brief Get number of provided actions
682 * @return unsigned integer with number of actions
684 virtual size_t GetActionCount() = 0;
687 * @brief Perform an action with given index
689 * @param index index of action
691 * @return true on success, false otherwise
693 virtual bool DoAction(size_t index) = 0;
696 * @brief Perform an action with given name
698 * @param name name of action
700 * @return true on success, false otherwise
702 virtual bool DoAction(const std::string& name) = 0;
706 * @brief Interface enabling advanced quering of accessibility objects
708 * @note since all mathods can be implemented inside bridge,
709 * none methods have to be overrided
711 class Collection : public virtual Accessible
717 * @brief Interface representing objects having screen coordinates
719 class Component : public virtual Accessible
723 * @brief Get rectangle describing size
725 * @param[in] ctype enumeration with type of coordinate systems
727 * @return Rect<> object
731 virtual Rect<> GetExtents(CoordType ctype) = 0;
734 * @brief Get layer current object is localized on
736 * @return enumeration pointing layer
738 * @see Dali::Accessibility::ComponentLayer
740 virtual ComponentLayer GetLayer() = 0;
743 * @brief Get value of z-order
745 * @return value of z-order
747 virtual int16_t GetMdiZOrder() = 0;
750 * @brief Set current object as "focused"
752 * @return true on success, false otherwise
754 virtual bool GrabFocus() = 0;
757 * @brief Get value of alpha channel
759 * @return alpha channel value in range [0.0, 1.0]
761 virtual double GetAlpha() = 0;
764 * @brief Set current object as "highlighted"
766 * The method assings "highlighted" state, simultaneously removing it
767 * from currently highlighted object.
769 * @return true on success, false otherwise
771 virtual bool GrabHighlight() = 0;
774 * @brief Set current object as "unhighlighted"
776 * The method removes "highlighted" state from object.
778 * @return true on success, false otherwise
780 * @see Dali:Accessibility::State
782 virtual bool ClearHighlight() = 0;
785 * @brief Check whether object can be scrolled
787 * @return true if object is scrollable, false otherwise
789 * @see Dali:Accessibility::State
791 virtual bool IsScrollable();
794 * @brief Get Accessible object containing given point
796 * @param[in] p two-dimensional point
797 * @param[in] ctype enumeration with type of coordinate system
799 * @return handle to last child of current object which contains given point
801 * @see Dali::Accessibility::Point
803 virtual Accessible* GetAccessibleAtPoint(Point p, CoordType ctype);
806 * @brief Check if current object contains given point
808 * @param[in] p two-dimensional point
809 * @param[in] ctype enumeration with type of coordinate system
811 * @return handle to Accessible object
813 * @see Dali::Accessibility::Point
815 virtual bool Contains(Point p, CoordType ctype);
819 * @brief Interface representing objects which can store numeric value
821 class Value : public virtual Accessible
825 * @brief Get the lowest possible value
827 * @return double value
829 virtual double GetMinimum() = 0;
832 * @brief Get current value
834 * @return double value
836 virtual double GetCurrent() = 0;
839 * @brief Get the highest possible value
841 * @return double value
843 virtual double GetMaximum() = 0;
848 * @param[in] val double value
850 * @return true if value could have been assigned, false otherwise
852 virtual bool SetCurrent(double val) = 0;
855 * @brief Get the lowest increment that can be distinguished
857 * @return double value
859 virtual double GetMinimumIncrement() = 0;
863 * @brief Interface representing objects which can store immutable texts
865 * @see Dali::Accessibility::EditableText
867 class DALI_ADAPTOR_API Text : public virtual Accessible
871 * @brief Get stored text in given range
873 * @param[in] startOffset index of first character
874 * @param[in] endOffset index of first character after the last one expected
876 * @return substring of stored text
878 virtual std::string GetText(size_t startOffset, size_t endOffset) = 0;
881 * @brief Get number of all stored characters
883 * @return number of characters
885 virtual size_t GetCharacterCount() = 0;
888 * @brief Get caret offset
890 * @return Value of caret offset
892 virtual size_t GetCaretOffset() = 0;
895 * @brief Set caret offset
897 * @param[in] offset Caret offset
899 * @return True if successful
901 virtual bool SetCaretOffset(size_t offset) = 0;
904 * @brief Get substring of stored text truncated in concrete gradation
906 * @param[in] offset position in stored text
907 * @param[in] boundary enumeration describing text gradation
909 * @return Range structure containing acquired text and offsets in original string
911 * @see Dali::Accessibility::Range
913 virtual Range GetTextAtOffset(size_t offset, TextBoundary boundary) = 0;
916 * @brief Get selected text
918 * @param[in] selectionNum selection index
919 * @note Currently only one selection (i.e. with index = 0) is supported
921 * @return Range structure containing acquired text and offsets in original string
923 * @see Dali::Accessibility::Range
925 virtual Range GetSelection(size_t selectionNum) = 0;
928 * @brief Remove selection
930 * @param[in] selectionNum selection index
931 * @note Currently only one selection (i.e. with index = 0) is supported
933 * @return bool on success, false otherwise
935 virtual bool RemoveSelection(size_t selectionNum) = 0;
938 * @brief Get selected text
940 * @param[in] selectionNum selection index
941 * @param[in] startOffset index of first character
942 * @param[in] endOffset index of first character after the last one expected
944 * @note Currently only one selection (i.e. with index = 0) is supported
946 * @return true on success, false otherwise
948 virtual bool SetSelection(size_t selectionNum, size_t startOffset, size_t endOffset) = 0;
952 * @brief Interface representing objects which can store editable texts
954 * @note Paste method is entirely implemented inside bridge
956 * @see Dali::Accessibility::EditableText
958 class DALI_ADAPTOR_API EditableText : public virtual Accessible
962 * @brief Copy text in range to system clipboard
964 * @param[in] startPosition index of first character
965 * @param[in] endPosition index of first character after the last one expected
967 * @return true on success, false otherwise
969 virtual bool CopyText(size_t startPosition, size_t endPosition) = 0;
972 * @brief Cut text in range to system clipboard
974 * @param[in] startPosition index of first character
975 * @param[in] endPosition index of first character after the last one expected
977 * @return true on success, false otherwise
979 virtual bool CutText(size_t startPosition, size_t endPosition) = 0;
983 * @brief minimalistic, always empty Accessible object with settable address
985 * For those situations, where you want to return address in different bridge
986 * (embedding for example), but the object itself ain't planned to be used otherwise.
987 * This object has null parent, no children, empty name and so on
989 class DALI_ADAPTOR_API EmptyAccessibleWithAddress : public virtual Accessible
992 EmptyAccessibleWithAddress() = default;
993 EmptyAccessibleWithAddress(Address address)
994 : address(std::move(address))
998 void SetAddress(Address address)
1000 this->address = std::move(address);
1003 std::string GetName() override
1007 std::string GetDescription() override
1011 Accessible* GetParent() override
1015 size_t GetChildCount() override
1019 std::vector<Accessible*> GetChildren() override
1023 Accessible* GetChildAtIndex(size_t index) override
1025 throw std::domain_error{"out of bounds index (" + std::to_string(index) + ") - no children"};
1027 size_t GetIndexInParent() override
1029 return static_cast<size_t>(-1);
1031 Role GetRole() override
1035 std::string GetRoleName() override;
1036 States GetStates() override
1040 Attributes GetAttributes() override
1044 Address GetAddress() override
1048 bool DoGesture(const GestureInfo& gestureInfo) override
1052 std::vector<Relation> GetRelationSet() override
1061 } // namespace Accessibility
1064 #endif // DALI_INTERNAL_ATSPI_ACCESSIBILITY_IMPL_H