2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
21 #include <dali/devel-api/common/stage.h>
22 #include <dali/integration-api/debug.h>
23 #include <dali/public-api/actors/layer.h>
25 #include <unordered_map>
28 #include <dali/devel-api/adaptor-framework/environment-variable.h>
29 #include <dali/devel-api/adaptor-framework/window-devel.h>
30 #include <dali/internal/accessibility/bridge/bridge-accessible.h>
31 #include <dali/internal/accessibility/bridge/bridge-action.h>
32 #include <dali/internal/accessibility/bridge/bridge-collection.h>
33 #include <dali/internal/accessibility/bridge/bridge-component.h>
34 #include <dali/internal/accessibility/bridge/bridge-editable-text.h>
35 #include <dali/internal/accessibility/bridge/bridge-hypertext.h>
36 #include <dali/internal/accessibility/bridge/bridge-hyperlink.h>
37 #include <dali/internal/accessibility/bridge/bridge-object.h>
38 #include <dali/internal/accessibility/bridge/bridge-selection.h>
39 #include <dali/internal/accessibility/bridge/bridge-socket.h>
40 #include <dali/internal/accessibility/bridge/bridge-text.h>
41 #include <dali/internal/accessibility/bridge/bridge-value.h>
42 #include <dali/internal/accessibility/bridge/bridge-application.h>
43 #include <dali/internal/accessibility/bridge/dummy-atspi.h>
44 #include <dali/internal/adaptor/common/adaptor-impl.h>
45 #include <dali/internal/system/common/environment-variables.h>
47 using namespace Dali::Accessibility;
49 namespace // unnamed namespace
52 const int RETRY_INTERVAL = 1000;
54 } // unnamed namespace
57 * @brief The BridgeImpl class is to implement some Bridge functions.
59 class BridgeImpl : public virtual BridgeBase,
60 public BridgeAccessible,
62 public BridgeComponent,
63 public BridgeCollection,
67 public BridgeEditableText,
68 public BridgeSelection,
69 public BridgeApplication,
70 public BridgeHypertext,
71 public BridgeHyperlink,
74 DBus::DBusClient mAccessibilityStatusClient;
75 DBus::DBusClient mRegistryClient;
76 DBus::DBusClient mDirectReadingClient;
77 bool mIsScreenReaderEnabled = false;
78 bool mIsEnabled = false;
79 bool mIsShown = false;
80 std::unordered_map<int32_t, std::function<void(std::string)>> mDirectReadingCallbacks;
81 Dali::Actor mHighlightedActor;
82 std::function<void(Dali::Actor)> mHighlightClearAction;
83 Dali::CallbackBase* mIdleCallback = NULL;
84 Dali::Timer mInitializeTimer;
85 Dali::Timer mReadIsEnabledTimer;
86 Dali::Timer mReadScreenReaderEnabledTimer;
87 Dali::Timer mForceUpTimer;
95 * @copydoc Dali::Accessibility::Bridge::Emit()
97 Consumed Emit(KeyEventType type, unsigned int keyCode, const std::string& keyName, unsigned int timeStamp, bool isText) override
104 unsigned int keyType = 0;
108 case KeyEventType::KEY_PRESSED:
113 case KeyEventType::KEY_RELEASED:
124 auto methodObject = mRegistryClient.method<bool(std::tuple<uint32_t, int32_t, int32_t, int32_t, int32_t, std::string, bool>)>("NotifyListenersSync");
125 auto result = methodObject.call(std::tuple<uint32_t, int32_t, int32_t, int32_t, int32_t, std::string, bool>{keyType, 0, static_cast<int32_t>(keyCode), 0, static_cast<int32_t>(timeStamp), keyName, isText ? 1 : 0});
128 LOG() << result.getError().message;
131 return std::get<0>(result) ? Consumed::YES : Consumed::NO;
135 * @copydoc Dali::Accessibility::Bridge::Pause()
137 void Pause() override
144 mDirectReadingClient.method<DBus::ValueOrError<void>(bool)>("PauseResume").asyncCall([](DBus::ValueOrError<void> msg) {
147 LOG() << "Direct reading command failed (" << msg.getError().message << ")\n";
154 * @copydoc Dali::Accessibility::Bridge::Resume()
156 void Resume() override
163 mDirectReadingClient.method<DBus::ValueOrError<void>(bool)>("PauseResume").asyncCall([](DBus::ValueOrError<void> msg) {
166 LOG() << "Direct reading command failed (" << msg.getError().message << ")\n";
173 * @copydoc Dali::Accessibility::Bridge::StopReading()
175 void StopReading(bool alsoNonDiscardable) override
182 mDirectReadingClient.method<DBus::ValueOrError<void>(bool)>("StopReading").asyncCall([](DBus::ValueOrError<void> msg) {
185 LOG() << "Direct reading command failed (" << msg.getError().message << ")\n";
192 * @copydoc Dali::Accessibility::Bridge::Say()
194 void Say(const std::string& text, bool discardable, std::function<void(std::string)> callback) override
201 mDirectReadingClient.method<DBus::ValueOrError<std::string, bool, int32_t>(std::string, bool)>("ReadCommand").asyncCall([=](DBus::ValueOrError<std::string, bool, int32_t> msg) {
204 LOG() << "Direct reading command failed (" << msg.getError().message << ")\n";
208 mDirectReadingCallbacks.emplace(std::get<2>(msg), callback);
216 * @copydoc Dali::Accessibility::Bridge::ForceDown()
218 void ForceDown() override
222 if(mData->mCurrentlyHighlightedActor && mData->mHighlightActor)
224 mData->mCurrentlyHighlightedActor.Remove(mData->mHighlightActor);
226 mData->mCurrentlyHighlightedActor = {};
227 mData->mHighlightActor = {};
229 mDisabledSignal.Emit();
231 mHighlightedActor = {};
232 mHighlightClearAction = {};
233 BridgeAccessible::ForceDown();
234 mRegistryClient = {};
235 mDirectReadingClient = {};
236 mDirectReadingCallbacks.clear();
237 mApplication.mChildren.clear();
245 mInitializeTimer.Stop();
246 mInitializeTimer.Reset();
249 if(mReadIsEnabledTimer)
251 mReadIsEnabledTimer.Stop();
252 mReadIsEnabledTimer.Reset();
255 if(mReadScreenReaderEnabledTimer)
257 mReadScreenReaderEnabledTimer.Stop();
258 mReadScreenReaderEnabledTimer.Reset();
263 mForceUpTimer.Stop();
264 mForceUpTimer.Reset();
269 * @copydoc Dali::Accessibility::Bridge::Terminate()
271 void Terminate() override
275 // The ~Window() after this point cannot emit DESTROY, because Bridge is not available. So emit DESTROY here.
276 for(auto windowAccessible : mApplication.mChildren)
278 BridgeObject::Emit(windowAccessible, WindowEvent::DESTROY);
280 mData->mCurrentlyHighlightedActor = {};
281 mData->mHighlightActor = {};
284 if((NULL != mIdleCallback) && Dali::Adaptor::IsAvailable())
286 Dali::Adaptor::Get().RemoveIdle(mIdleCallback);
288 mAccessibilityStatusClient = {};
293 bool ForceUpTimerCallback()
295 if(ForceUp() != ForceUpResult::FAILED)
303 * @copydoc Dali::Accessibility::Bridge::ForceUp()
305 ForceUpResult ForceUp() override
307 auto forceUpResult = BridgeAccessible::ForceUp();
308 if(forceUpResult == ForceUpResult::ALREADY_UP)
310 return forceUpResult;
312 else if(forceUpResult == ForceUpResult::FAILED)
316 mForceUpTimer = Dali::Timer::New(RETRY_INTERVAL);
317 mForceUpTimer.TickSignal().Connect(this, &BridgeImpl::ForceUpTimerCallback);
318 mForceUpTimer.Start();
320 return forceUpResult;
323 BridgeObject::RegisterInterfaces();
324 BridgeAccessible::RegisterInterfaces();
325 BridgeComponent::RegisterInterfaces();
326 BridgeCollection::RegisterInterfaces();
327 BridgeAction::RegisterInterfaces();
328 BridgeValue::RegisterInterfaces();
329 BridgeText::RegisterInterfaces();
330 BridgeEditableText::RegisterInterfaces();
331 BridgeSelection::RegisterInterfaces();
332 BridgeApplication::RegisterInterfaces();
333 BridgeHypertext::RegisterInterfaces();
334 BridgeHyperlink::RegisterInterfaces();
335 BridgeSocket::RegisterInterfaces();
337 RegisterOnBridge(&mApplication);
339 mRegistryClient = {AtspiDbusNameRegistry, AtspiDbusPathDec, Accessible::GetInterfaceName(AtspiInterface::DEVICE_EVENT_CONTROLLER), mConnectionPtr};
340 mDirectReadingClient = DBus::DBusClient{DirectReadingDBusName, DirectReadingDBusPath, DirectReadingDBusInterface, mConnectionPtr};
342 mDirectReadingClient.addSignal<void(int32_t, std::string)>("ReadingStateChanged", [=](int32_t id, std::string readingState) {
343 auto it = mDirectReadingCallbacks.find(id);
344 if(it != mDirectReadingCallbacks.end())
346 it->second(readingState);
347 if(readingState != "ReadingPaused" && readingState != "ReadingResumed" && readingState != "ReadingStarted")
349 mDirectReadingCallbacks.erase(it);
354 auto proxy = DBus::DBusClient{AtspiDbusNameRegistry, AtspiDbusPathRoot, Accessible::GetInterfaceName(AtspiInterface::SOCKET), mConnectionPtr};
355 Address root{"", "root"};
356 auto res = proxy.method<Address(Address)>("Embed").call(root);
359 LOG() << "Call to Embed failed: " << res.getError().message;
363 mApplication.mParent.SetAddress(std::move(std::get<0>(res)));
365 mEnabledSignal.Emit();
367 return ForceUpResult::JUST_STARTED;
371 * @brief Sends a signal to dbus that the window is shown.
373 * @param[in] window The window to be shown
374 * @see Accessible::EmitShowing() and BridgeObject::EmitStateChanged()
376 void EmitShown(Dali::Window window)
378 auto windowAccessible = mApplication.GetWindowAccessible(window);
381 windowAccessible->EmitShowing(true);
386 * @brief Sends a signal to dbus that the window is hidden.
388 * @param[in] window The window to be hidden
389 * @see Accessible::EmitShowing() and BridgeObject::EmitStateChanged()
391 void EmitHidden(Dali::Window window)
393 auto windowAccessible = mApplication.GetWindowAccessible(window);
396 windowAccessible->EmitShowing(false);
401 * @brief Sends a signal to dbus that the window is activated.
403 * @param[in] window The window to be activated
404 * @see BridgeObject::Emit()
406 void EmitActivate(Dali::Window window)
408 auto windowAccessible = mApplication.GetWindowAccessible(window);
411 windowAccessible->Emit(WindowEvent::ACTIVATE, 0);
416 * @brief Sends a signal to dbus that the window is deactivated.
418 * @param[in] window The window to be deactivated
419 * @see BridgeObject::Emit()
421 void EmitDeactivate(Dali::Window window)
423 auto windowAccessible = mApplication.GetWindowAccessible(window);
426 windowAccessible->Emit(WindowEvent::DEACTIVATE, 0);
431 * @copydoc Dali::Accessibility::Bridge::WindowShown()
433 void WindowShown(Dali::Window window) override
435 if(!mIsShown && IsUp())
443 * @copydoc Dali::Accessibility::Bridge::WindowHidden()
445 void WindowHidden(Dali::Window window) override
447 if(mIsShown && IsUp())
455 * @copydoc Dali::Accessibility::Bridge::WindowFocused()
457 void WindowFocused(Dali::Window window) override
459 if(mIsShown && IsUp())
461 EmitActivate(window);
466 * @copydoc Dali::Accessibility::Bridge::WindowUnfocused()
468 void WindowUnfocused(Dali::Window window) override
470 if(mIsShown && IsUp())
472 EmitDeactivate(window);
477 * @copydoc Dali::Accessibility::Bridge::SuppressScreenReader()
479 void SuppressScreenReader(bool suppress) override
481 if(mIsScreenReaderSuppressed == suppress)
485 mIsScreenReaderSuppressed = suppress;
486 ReadScreenReaderEnabledProperty();
491 if((!mIsScreenReaderSuppressed && mIsScreenReaderEnabled) || mIsEnabled)
501 bool ReadIsEnabledTimerCallback()
503 ReadIsEnabledProperty();
507 void ReadIsEnabledProperty()
509 mAccessibilityStatusClient.property<bool>("IsEnabled").asyncGet([this](DBus::ValueOrError<bool> msg) {
512 DALI_LOG_ERROR("Get IsEnabled property error: %s\n", msg.getError().message.c_str());
513 if(msg.getError().errorType == DBus::ErrorType::INVALID_REPLY)
515 if(!mReadIsEnabledTimer)
517 mReadIsEnabledTimer = Dali::Timer::New(RETRY_INTERVAL);
518 mReadIsEnabledTimer.TickSignal().Connect(this, &BridgeImpl::ReadIsEnabledTimerCallback);
520 mReadIsEnabledTimer.Start();
525 if(mReadIsEnabledTimer)
527 mReadIsEnabledTimer.Stop();
528 mReadIsEnabledTimer.Reset();
531 mIsEnabled = std::get<0>(msg);
536 void ListenIsEnabledProperty()
538 mAccessibilityStatusClient.addPropertyChangedEvent<bool>("IsEnabled", [this](bool res) {
544 bool ReadScreenReaderEnabledTimerCallback()
546 ReadScreenReaderEnabledProperty();
550 void ReadScreenReaderEnabledProperty()
552 // can be true because of SuppressScreenReader before init
553 if (!mAccessibilityStatusClient)
558 mAccessibilityStatusClient.property<bool>("ScreenReaderEnabled").asyncGet([this](DBus::ValueOrError<bool> msg) {
561 DALI_LOG_ERROR("Get ScreenReaderEnabled property error: %s\n", msg.getError().message.c_str());
562 if(msg.getError().errorType == DBus::ErrorType::INVALID_REPLY)
564 if(!mReadScreenReaderEnabledTimer)
566 mReadScreenReaderEnabledTimer = Dali::Timer::New(RETRY_INTERVAL);
567 mReadScreenReaderEnabledTimer.TickSignal().Connect(this, &BridgeImpl::ReadScreenReaderEnabledTimerCallback);
569 mReadScreenReaderEnabledTimer.Start();
574 if(mReadScreenReaderEnabledTimer)
576 mReadScreenReaderEnabledTimer.Stop();
577 mReadScreenReaderEnabledTimer.Reset();
580 mIsScreenReaderEnabled = std::get<0>(msg);
585 void EmitScreenReaderEnabledSignal()
587 if (mIsScreenReaderEnabled)
589 mScreenReaderEnabledSignal.Emit();
593 mScreenReaderDisabledSignal.Emit();
597 void ListenScreenReaderEnabledProperty()
599 mAccessibilityStatusClient.addPropertyChangedEvent<bool>("ScreenReaderEnabled", [this](bool res) {
600 mIsScreenReaderEnabled = res;
601 EmitScreenReaderEnabledSignal();
606 void ReadAndListenProperties()
608 ReadIsEnabledProperty();
609 ListenIsEnabledProperty();
611 ReadScreenReaderEnabledProperty();
612 ListenScreenReaderEnabledProperty();
615 bool InitializeAccessibilityStatusClient()
617 mAccessibilityStatusClient = DBus::DBusClient{A11yDbusName, A11yDbusPath, A11yDbusStatusInterface, DBus::ConnectionType::SESSION};
619 if (!mAccessibilityStatusClient)
621 DALI_LOG_ERROR("Accessibility Status DbusClient is not ready\n");
628 bool InitializeTimerCallback()
630 if ( InitializeAccessibilityStatusClient() )
632 ReadAndListenProperties();
640 if ( InitializeAccessibilityStatusClient() )
642 ReadAndListenProperties();
643 mIdleCallback = NULL;
647 if(!mInitializeTimer)
649 mInitializeTimer = Dali::Timer::New(RETRY_INTERVAL);
650 mInitializeTimer.TickSignal().Connect(this, &BridgeImpl::InitializeTimerCallback);
652 mInitializeTimer.Start();
654 mIdleCallback = NULL;
659 * @copydoc Dali::Accessibility::Bridge::Initialize()
661 void Initialize() override
663 if ( InitializeAccessibilityStatusClient() )
665 ReadAndListenProperties();
669 // Initialize failed. Try it again on Idle
670 if( Dali::Adaptor::IsAvailable() )
672 Dali::Adaptor& adaptor = Dali::Adaptor::Get();
673 if( NULL == mIdleCallback )
675 mIdleCallback = MakeCallback( this, &BridgeImpl::OnIdleSignal );
676 adaptor.AddIdle( mIdleCallback, true );
682 * @copydoc Dali::Accessibility::Bridge::GetScreenReaderEnabled()
684 bool GetScreenReaderEnabled() override
686 return mIsScreenReaderEnabled;
690 * @copydoc Dali::Accessibility::Bridge::IsEnabled()
692 bool IsEnabled() override
698 namespace // unnamed namespace
701 bool INITIALIZED_BRIDGE = false;
704 * @brief Creates BridgeImpl instance.
706 * @return The BridgeImpl instance
707 * @note This method is to check environment variable first. If ATSPI is disable using env, it returns dummy bridge instance.
709 std::shared_ptr<Bridge> CreateBridge()
711 INITIALIZED_BRIDGE = true;
715 /* check environment variable first */
716 const char* envAtspiDisabled = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_DISABLE_ATSPI);
717 if(envAtspiDisabled && std::atoi(envAtspiDisabled) != 0)
719 return Dali::Accessibility::DummyBridge::GetInstance();
722 return std::make_shared<BridgeImpl>();
724 catch(const std::exception&)
726 DALI_LOG_ERROR("Failed to initialize AT-SPI bridge");
727 return Dali::Accessibility::DummyBridge::GetInstance();
731 } // unnamed namespace
733 // Dali::Accessibility::Bridge class implementation
735 std::shared_ptr<Bridge> Bridge::GetCurrentBridge()
737 static std::shared_ptr<Bridge> bridge;
743 else if(mAutoInitState == AutoInitState::ENABLED)
745 bridge = CreateBridge();
747 /* check environment variable for suppressing screen-reader */
748 const char* envSuppressScreenReader = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_SUPPRESS_SCREEN_READER);
749 if(envSuppressScreenReader && std::atoi(envSuppressScreenReader) != 0)
751 bridge->SuppressScreenReader(true);
757 return Dali::Accessibility::DummyBridge::GetInstance();
760 void Bridge::DisableAutoInit()
762 if(INITIALIZED_BRIDGE)
764 DALI_LOG_ERROR("Bridge::DisableAutoInit() called after bridge auto-initialization");
767 mAutoInitState = AutoInitState::DISABLED;
770 void Bridge::EnableAutoInit()
772 mAutoInitState = AutoInitState::ENABLED;
774 if(INITIALIZED_BRIDGE)
779 auto rootLayer = Dali::Stage::GetCurrent().GetRootLayer(); // A root layer of the default window.
780 auto window = Dali::DevelWindow::Get(rootLayer);
781 auto applicationName = Dali::Internal::Adaptor::Adaptor::GetApplicationPackageName();
783 auto accessible = Accessibility::Accessible::Get(rootLayer, true);
785 auto bridge = Bridge::GetCurrentBridge();
786 bridge->AddTopLevelWindow(accessible);
787 bridge->SetApplicationName(applicationName);
788 bridge->Initialize();
790 if(window && window.IsVisible())
792 bridge->WindowShown(window);