1 #ifndef DALI_INTERNAL_ACCESSIBILITY_BRIDGE_BASE_H
2 #define DALI_INTERNAL_ACCESSIBILITY_BRIDGE_BASE_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/layer.h>
23 #include <dali/public-api/dali-adaptor-version.h>
24 #include <dali/public-api/signals/connection-tracker.h>
28 #include <dali/devel-api/adaptor-framework/proxy-accessible.h>
29 #include <dali/devel-api/adaptor-framework/window-devel.h>
30 #include <dali/devel-api/atspi-interfaces/accessible.h>
31 #include <dali/devel-api/atspi-interfaces/application.h>
32 #include <dali/devel-api/atspi-interfaces/collection.h>
33 #include <dali/devel-api/atspi-interfaces/socket.h>
34 #include <dali/internal/accessibility/bridge/accessibility-common.h>
37 * @brief The ApplicationAccessible class is to define Accessibility Application.
39 class ApplicationAccessible : public virtual Dali::Accessibility::Accessible,
40 public virtual Dali::Accessibility::Application,
41 public virtual Dali::Accessibility::Collection,
42 public virtual Dali::Accessibility::Component,
43 public virtual Dali::Accessibility::Socket
46 Dali::Accessibility::ProxyAccessible mParent;
47 std::vector<Dali::Accessibility::Accessible*> mChildren;
49 std::string mToolkitName{"dali"};
50 bool mIsEmbedded{false};
52 std::string GetName() const override
57 std::string GetDescription() const override
62 Dali::Accessibility::Accessible* GetParent() override
67 size_t GetChildCount() const override
69 return mChildren.size();
72 std::vector<Dali::Accessibility::Accessible*> GetChildren() override
77 Dali::Accessibility::Accessible* GetChildAtIndex(size_t index) override
79 auto size = mChildren.size();
82 throw std::domain_error{"invalid index " + std::to_string(index) + " for object with " + std::to_string(size) + " children"};
84 return mChildren[index];
87 size_t GetIndexInParent() override
94 throw std::domain_error{"can't call GetIndexInParent on application object"};
97 Dali::Accessibility::Role GetRole() const override
99 return Dali::Accessibility::Role::APPLICATION;
102 Dali::Accessibility::States GetStates() override
104 Dali::Accessibility::States result;
106 for(auto* child : mChildren)
108 result = result | child->GetStates();
114 Dali::Accessibility::Attributes GetAttributes() const override
120 * @brief Gets the Accessible object from the window.
122 * @param[in] window The window to find
123 * @return Null if mChildren is empty, otherwise the Accessible object
124 * @note Currently, the default window would be returned when mChildren is not empty.
126 Dali::Accessibility::Accessible* GetWindowAccessible(Dali::Window window)
128 if(mChildren.empty())
133 Dali::Layer rootLayer = window.GetRootLayer();
135 // Find a child which is related to the window.
136 for(auto i = 0u; i < mChildren.size(); ++i)
138 if(rootLayer == mChildren[i]->GetInternalActor())
144 // If can't find its children, return the default window.
148 bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override
153 std::vector<Dali::Accessibility::Relation> GetRelationSet() override
158 Dali::Actor GetInternalActor() override
160 return Dali::Actor{};
163 Dali::Accessibility::Address GetAddress() const override
170 std::string GetToolkitName() const override
175 std::string GetVersion() const override
177 return std::to_string(Dali::ADAPTOR_MAJOR_VERSION) + "." + std::to_string(Dali::ADAPTOR_MINOR_VERSION);
182 Dali::Accessibility::Address Embed(Dali::Accessibility::Address plug) override
185 mParent.SetAddress(plug);
190 void Unembed(Dali::Accessibility::Address plug) override
192 if(mParent.GetAddress() == plug)
195 mParent.SetAddress({});
196 Dali::Accessibility::Bridge::GetCurrentBridge()->SetExtentsOffset(0, 0);
200 void SetOffset(std::int32_t x, std::int32_t y) override
207 Dali::Accessibility::Bridge::GetCurrentBridge()->SetExtentsOffset(x, y);
212 Dali::Rect<> GetExtents(Dali::Accessibility::CoordinateType type) const override
214 using limits = std::numeric_limits<float>;
216 float minX = limits::max();
217 float minY = limits::max();
218 float maxX = limits::min();
219 float maxY = limits::min();
221 for(Dali::Accessibility::Accessible* child : mChildren)
223 auto* component = Dali::Accessibility::Component::DownCast(child);
229 auto extents = component->GetExtents(type);
231 minX = std::min(minX, extents.x);
232 minY = std::min(minY, extents.y);
233 maxX = std::max(maxX, extents.x + extents.width);
234 maxY = std::max(maxY, extents.y + extents.height);
237 return {minX, minY, maxX - minX, maxY - minY};
240 Dali::Accessibility::ComponentLayer GetLayer() const override
242 return Dali::Accessibility::ComponentLayer::WINDOW;
245 std::int16_t GetMdiZOrder() const override
250 bool GrabFocus() override
255 double GetAlpha() const override
260 bool GrabHighlight() override
265 bool ClearHighlight() override
270 bool IsScrollable() const override
277 * @brief Enumeration for CoalescableMessages.
279 enum class CoalescableMessages
281 BOUNDS_CHANGED, ///< Bounds changed
282 SET_OFFSET, ///< Set offset
285 // Custom specialization of std::hash
289 struct hash<std::pair<CoalescableMessages, Dali::Accessibility::Accessible*>>
291 size_t operator()(std::pair<CoalescableMessages, Dali::Accessibility::Accessible*> value) const
293 return (static_cast<size_t>(value.first) * 131) ^ reinterpret_cast<size_t>(value.second);
299 * @brief The BridgeBase class is basic class for Bridge functions.
301 class BridgeBase : public Dali::Accessibility::Bridge, public Dali::ConnectionTracker
303 std::unordered_map<std::pair<CoalescableMessages, Dali::Accessibility::Accessible*>, std::pair<unsigned int, std::function<void()>>> mCoalescableMessages;
306 * @brief Removes all CoalescableMessages using Tick signal.
308 * @return False if mCoalescableMessages is empty, otherwise true.
310 bool TickCoalescableMessages();
314 * @brief Adds CoalescableMessages, Accessible, and delay time to mCoalescableMessages.
316 * @param[in] kind CoalescableMessages enum value
317 * @param[in] obj Accessible object
318 * @param[in] delay The delay time
319 * @param[in] functor The function to be called // NEED TO UPDATE!
321 void AddCoalescableMessage(CoalescableMessages kind, Dali::Accessibility::Accessible* obj, float delay, std::function<void()> functor);
324 * @brief Callback when the visibility of the window is changed.
326 * @param[in] window The window to be changed
327 * @param[in] visible The visibility of the window
329 void OnWindowVisibilityChanged(Dali::Window window, bool visible);
332 * @brief Callback when the window focus is changed.
334 * @param[in] window The window whose focus is changed
335 * @param[in] focusIn Whether the focus is in/out
337 void OnWindowFocusChanged(Dali::Window window, bool focusIn);
340 * @copydoc Dali::Accessibility::Bridge::GetBusName()
342 const std::string& GetBusName() const override;
345 * @copydoc Dali::Accessibility::Bridge::AddTopLevelWindow()
347 void AddTopLevelWindow(Dali::Accessibility::Accessible* windowAccessible) override;
350 * @copydoc Dali::Accessibility::Bridge::RemoveTopLevelWindow()
352 void RemoveTopLevelWindow(Dali::Accessibility::Accessible* windowAccessible) override;
355 * @copydoc Dali::Accessibility::Bridge::RegisterDefaultLabel()
357 void RegisterDefaultLabel(Dali::Accessibility::Accessible* object) override;
360 * @copydoc Dali::Accessibility::Bridge::UnregisterDefaultLabel()
362 void UnregisterDefaultLabel(Dali::Accessibility::Accessible* object) override;
365 * @copydoc Dali::Accessibility::Bridge::GetDefaultLabel()
367 Dali::Accessibility::Accessible* GetDefaultLabel() const override
369 return mDefaultLabels.empty() ? nullptr : mDefaultLabels.back();
373 * @copydoc Dali::Accessibility::Bridge::GetApplication()
375 Dali::Accessibility::Accessible* GetApplication() const override
377 return &mApplication;
381 * @brief Adds function to dbus interface.
383 template<typename SELF, typename... RET, typename... ARGS>
384 void AddFunctionToInterface(
385 DBus::DBusInterfaceDescription& desc, const std::string& funcName, DBus::ValueOrError<RET...> (SELF::*funcPtr)(ARGS...))
387 if(auto self = dynamic_cast<SELF*>(this))
388 desc.addMethod<DBus::ValueOrError<RET...>(ARGS...)>(
390 [=](ARGS... args) -> DBus::ValueOrError<RET...> {
393 return (self->*funcPtr)(std::move(args)...);
395 catch(std::domain_error& e)
397 return DBus::Error{e.what()};
403 * @brief Adds 'Get' property to dbus interface.
405 template<typename T, typename SELF>
406 void AddGetPropertyToInterface(DBus::DBusInterfaceDescription& desc,
407 const std::string& funcName,
408 T (SELF::*funcPtr)())
410 if(auto self = dynamic_cast<SELF*>(this))
411 desc.addProperty<T>(funcName,
412 [=]() -> DBus::ValueOrError<T> {
415 return (self->*funcPtr)();
417 catch(std::domain_error& e)
419 return DBus::Error{e.what()};
426 * @brief Adds 'Set' property to dbus interface.
428 template<typename T, typename SELF>
429 void AddSetPropertyToInterface(DBus::DBusInterfaceDescription& desc,
430 const std::string& funcName,
431 void (SELF::*funcPtr)(T))
433 if(auto self = dynamic_cast<SELF*>(this))
434 desc.addProperty<T>(funcName, {}, [=](T t) -> DBus::ValueOrError<void> {
437 (self->*funcPtr)(std::move(t));
440 catch(std::domain_error& e)
442 return DBus::Error{e.what()};
448 * @brief Adds 'Set' and 'Get' properties to dbus interface.
450 template<typename T, typename T1, typename SELF>
451 void AddGetSetPropertyToInterface(DBus::DBusInterfaceDescription& desc,
452 const std::string& funcName,
453 T1 (SELF::*funcPtrGet)(),
454 DBus::ValueOrError<void> (SELF::*funcPtrSet)(T))
456 if(auto self = dynamic_cast<SELF*>(this))
459 [=]() -> DBus::ValueOrError<T> {
462 return (self->*funcPtrGet)();
464 catch(std::domain_error& e)
466 return DBus::Error{e.what()};
469 [=](T t) -> DBus::ValueOrError<void> {
472 (self->*funcPtrSet)(std::move(t));
475 catch(std::domain_error& e)
477 return DBus::Error{e.what()};
483 * @brief Adds 'Get' and 'Set' properties to dbus interface.
485 template<typename T, typename T1, typename SELF>
486 void AddGetSetPropertyToInterface(DBus::DBusInterfaceDescription& desc,
487 const std::string& funcName,
488 T1 (SELF::*funcPtrGet)(),
489 void (SELF::*funcPtrSet)(T))
491 if(auto self = dynamic_cast<SELF*>(this))
494 [=]() -> DBus::ValueOrError<T> {
497 return (self->*funcPtrGet)();
499 catch(std::domain_error& e)
501 return DBus::Error{e.what()};
504 [=](T t) -> DBus::ValueOrError<void> {
507 (self->*funcPtrSet)(std::move(t));
510 catch(std::domain_error& e)
512 return DBus::Error{e.what()};
518 * @brief Gets the string of the path excluding the specified prefix.
520 * @param path The path to get
521 * @return The string stripped of the specific prefix
523 static std::string StripPrefix(const std::string& path);
526 * @brief Finds the Accessible object according to the path.
528 * @param[in] path The path for Accessible object
529 * @return The Accessible object corresponding to the path
531 Dali::Accessibility::Accessible* Find(const std::string& path) const;
534 * @brief Finds the Accessible object with the given address.
536 * @param[in] ptr The unique Address of the object
537 * @return The Accessible object corresponding to the path
539 Dali::Accessibility::Accessible* Find(const Dali::Accessibility::Address& ptr) const;
542 * @brief Returns the target object of the currently executed DBus method call.
544 * @return The Accessible object
545 * @note When a DBus method is called on some object, this target object (`currentObject`) is temporarily saved by the bridge,
546 * because DBus handles the invocation target separately from the method arguments.
547 * We then use the saved object inside the 'glue' method (e.g. BridgeValue::GetMinimum)
548 * to call the equivalent method on the respective C++ object (this could be ScrollBar::AccessibleImpl::GetMinimum in the example given).
550 Dali::Accessibility::Accessible* FindCurrentObject() const;
553 * @brief Returns the target object of the currently executed DBus method call.
555 * This method tries to downcast the return value of FindCurrentObject() to the requested type,
556 * issuing an error reply to the DBus caller if the requested type is not implemented. Whether
557 * a given type is implemented is decided based on the return value of Accessible::GetInterfaces()
558 * for the current object.
560 * @tparam I The requested AT-SPI interface
561 * @return The Accessible object (cast to a more derived type)
563 * @see FindCurrentObject()
564 * @see Dali::Accessibility::AtspiInterface
565 * @see Dali::Accessibility::AtspiInterfaceType
566 * @see Dali::Accessibility::Accessible::GetInterfaces()
568 template<Dali::Accessibility::AtspiInterface I>
569 auto* FindCurrentObjectWithInterface() const
571 using Type = Dali::Accessibility::AtspiInterfaceType<I>;
574 auto* currentObject = FindCurrentObject();
575 DALI_ASSERT_DEBUG(currentObject); // FindCurrentObject() throws domain_error
577 if(!(result = Dali::Accessibility::Accessible::DownCast<I>(currentObject)))
581 s << "Object " << currentObject->GetAddress().ToString();
582 s << " does not implement ";
583 s << Dali::Accessibility::Accessible::GetInterfaceName(I);
585 throw std::domain_error{s.str()};
592 * @copydoc Dali::Accessibility::Bridge::FindByPath()
594 Dali::Accessibility::Accessible* FindByPath(const std::string& name) const override;
597 * @copydoc Dali::Accessibility::Bridge::SetApplicationName()
599 void SetApplicationName(std::string name) override
601 mApplication.mName = std::move(name);
605 * @copydoc Dali::Accessibility::Bridge::SetToolkitName()
607 void SetToolkitName(std::string_view toolkitName) override
609 mApplication.mToolkitName = std::string{toolkitName};
613 mutable ApplicationAccessible mApplication;
614 std::vector<Dali::Accessibility::Accessible*> mDefaultLabels;
615 bool mIsScreenReaderSuppressed = false;
620 * @param[in] id An ID (integer value)
625 * @brief Gets the ID.
626 * @return The ID to be set
631 * @brief Update registered events.
633 void UpdateRegisteredEvents();
635 using CacheElementType = std::tuple<
636 Dali::Accessibility::Address,
637 Dali::Accessibility::Address,
638 Dali::Accessibility::Address,
639 std::vector<Dali::Accessibility::Address>,
640 std::vector<std::string>,
642 Dali::Accessibility::Role,
644 std::array<uint32_t, 2>>;
647 * @brief Gets Items // NEED TO UPDATE!
651 DBus::ValueOrError<std::vector<CacheElementType>> GetItems();
654 * @brief Creates CacheElement.
656 * CreateCacheElement method works for GetItems which is a part of ATSPI protocol.
657 * ATSPI client library (libatspi from at-spi2-core) depending on cacheing policy configuration uses GetItems
658 * to pre-load entire accessible tree from application to its own cache in single dbus call.
659 * Otherwise the particular nodes in a tree are cached lazily when client library tries to access them.
660 * @param item Accessible to get information
661 * @return The elements to be cached
663 CacheElementType CreateCacheElement(Dali::Accessibility::Accessible* item);
667 virtual ~BridgeBase();
670 * @copydoc Dali::Accessibility::Bridge::ForceUp()
672 ForceUpResult ForceUp() override;
675 * @copydoc Dali::Accessibility::Bridge::ForceDown()
677 void ForceDown() override;
679 DBus::DBusServer mDbusServer;
680 DBusWrapper::ConnectionPtr mConnectionPtr;
682 DBus::DBusClient mRegistry;
683 bool IsBoundsChangedEventAllowed{false};
686 #endif // DALI_INTERNAL_ACCESSIBILITY_BRIDGE_BASE_H