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-text.h>
40 #include <dali/internal/accessibility/bridge/bridge-value.h>
41 #include <dali/internal/accessibility/bridge/bridge-application.h>
42 #include <dali/internal/accessibility/bridge/dummy-atspi.h>
43 #include <dali/internal/adaptor/common/adaptor-impl.h>
44 #include <dali/internal/system/common/environment-variables.h>
46 using namespace Dali::Accessibility;
48 namespace // unnamed namespace
51 const int RETRY_INTERVAL = 1000;
53 } // unnamed namespace
56 * @brief The BridgeImpl class is to implement some Bridge functions.
58 class BridgeImpl : public virtual BridgeBase,
59 public BridgeAccessible,
61 public BridgeComponent,
62 public BridgeCollection,
66 public BridgeEditableText,
67 public BridgeSelection,
68 public BridgeApplication,
69 public BridgeHypertext,
70 public BridgeHyperlink
72 DBus::DBusClient mAccessibilityStatusClient;
73 DBus::DBusClient mRegistryClient;
74 DBus::DBusClient mDirectReadingClient;
75 bool mIsScreenReaderEnabled = false;
76 bool mIsEnabled = false;
77 bool mIsShown = false;
78 std::unordered_map<int32_t, std::function<void(std::string)>> mDirectReadingCallbacks;
79 Dali::Actor mHighlightedActor;
80 std::function<void(Dali::Actor)> mHighlightClearAction;
81 Dali::CallbackBase* mIdleCallback = NULL;
82 Dali::Timer mInitializeTimer;
83 Dali::Timer mReadIsEnabledTimer;
84 Dali::Timer mReadScreenReaderEnabledTimer;
85 Dali::Timer mForceUpTimer;
93 * @copydoc Dali::Accessibility::Bridge::Emit()
95 Consumed Emit(KeyEventType type, unsigned int keyCode, const std::string& keyName, unsigned int timeStamp, bool isText) override
102 unsigned int keyType = 0;
106 case KeyEventType::KEY_PRESSED:
111 case KeyEventType::KEY_RELEASED:
122 auto methodObject = mRegistryClient.method<bool(std::tuple<uint32_t, int32_t, int32_t, int32_t, int32_t, std::string, bool>)>("NotifyListenersSync");
123 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});
126 LOG() << result.getError().message;
129 return std::get<0>(result) ? Consumed::YES : Consumed::NO;
133 * @copydoc Dali::Accessibility::Bridge::Pause()
135 void Pause() override
142 mDirectReadingClient.method<DBus::ValueOrError<void>(bool)>("PauseResume").asyncCall([](DBus::ValueOrError<void> msg) {
145 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
152 * @copydoc Dali::Accessibility::Bridge::Resume()
154 void Resume() override
161 mDirectReadingClient.method<DBus::ValueOrError<void>(bool)>("PauseResume").asyncCall([](DBus::ValueOrError<void> msg) {
164 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
171 * @copydoc Dali::Accessibility::Bridge::StopReading()
173 void StopReading(bool alsoNonDiscardable) override
180 mDirectReadingClient.method<DBus::ValueOrError<void>(bool)>("StopReading").asyncCall([](DBus::ValueOrError<void> msg) {
183 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
190 * @copydoc Dali::Accessibility::Bridge::Say()
192 void Say(const std::string& text, bool discardable, std::function<void(std::string)> callback) override
199 mDirectReadingClient.method<DBus::ValueOrError<std::string, bool, int32_t>(std::string, bool)>("ReadCommand").asyncCall([=](DBus::ValueOrError<std::string, bool, int32_t> msg) {
202 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
206 mDirectReadingCallbacks.emplace(std::get<2>(msg), callback);
214 * @copydoc Dali::Accessibility::Bridge::ForceDown()
216 void ForceDown() override
220 if(mData->mCurrentlyHighlightedActor && mData->mHighlightActor)
222 mData->mCurrentlyHighlightedActor.Remove(mData->mHighlightActor);
224 mData->mCurrentlyHighlightedActor = {};
225 mData->mHighlightActor = {};
227 mDisabledSignal.Emit();
229 mHighlightedActor = {};
230 mHighlightClearAction = {};
231 BridgeAccessible::ForceDown();
232 mRegistryClient = {};
233 mDirectReadingClient = {};
234 mDirectReadingCallbacks.clear();
235 mApplication.mChildren.clear();
236 mApplication.mWindows.clear();
244 mInitializeTimer.Stop();
245 mInitializeTimer.Reset();
248 if(mReadIsEnabledTimer)
250 mReadIsEnabledTimer.Stop();
251 mReadIsEnabledTimer.Reset();
254 if(mReadScreenReaderEnabledTimer)
256 mReadScreenReaderEnabledTimer.Stop();
257 mReadScreenReaderEnabledTimer.Reset();
262 mForceUpTimer.Stop();
263 mForceUpTimer.Reset();
268 * @copydoc Dali::Accessibility::Bridge::Terminate()
270 void Terminate() override
274 mData->mCurrentlyHighlightedActor = {};
275 mData->mHighlightActor = {};
278 if((NULL != mIdleCallback) && Dali::Adaptor::IsAvailable())
280 Dali::Adaptor::Get().RemoveIdle(mIdleCallback);
282 mAccessibilityStatusClient = {};
287 bool ForceUpTimerCallback()
289 if(ForceUp() != ForceUpResult::FAILED)
297 * @copydoc Dali::Accessibility::Bridge::ForceUp()
299 ForceUpResult ForceUp() override
301 auto forceUpResult = BridgeAccessible::ForceUp();
302 if(forceUpResult == ForceUpResult::ALREADY_UP)
304 return forceUpResult;
306 else if(forceUpResult == ForceUpResult::FAILED)
310 mForceUpTimer = Dali::Timer::New(RETRY_INTERVAL);
311 mForceUpTimer.TickSignal().Connect(this, &BridgeImpl::ForceUpTimerCallback);
312 mForceUpTimer.Start();
314 return forceUpResult;
317 BridgeObject::RegisterInterfaces();
318 BridgeAccessible::RegisterInterfaces();
319 BridgeComponent::RegisterInterfaces();
320 BridgeCollection::RegisterInterfaces();
321 BridgeAction::RegisterInterfaces();
322 BridgeValue::RegisterInterfaces();
323 BridgeText::RegisterInterfaces();
324 BridgeEditableText::RegisterInterfaces();
325 BridgeSelection::RegisterInterfaces();
326 BridgeApplication::RegisterInterfaces();
327 BridgeHypertext::RegisterInterfaces();
328 BridgeHyperlink::RegisterInterfaces();
330 RegisterOnBridge(&mApplication);
332 mRegistryClient = {AtspiDbusNameRegistry, AtspiDbusPathDec, AtspiDbusInterfaceDec, mConnectionPtr};
333 mDirectReadingClient = DBus::DBusClient{DirectReadingDBusName, DirectReadingDBusPath, DirectReadingDBusInterface, mConnectionPtr};
335 mDirectReadingClient.addSignal<void(int32_t, std::string)>("ReadingStateChanged", [=](int32_t id, std::string readingState) {
336 auto it = mDirectReadingCallbacks.find(id);
337 if(it != mDirectReadingCallbacks.end())
339 it->second(readingState);
340 if(readingState != "ReadingPaused" && readingState != "ReadingResumed" && readingState != "ReadingStarted")
342 mDirectReadingCallbacks.erase(it);
347 auto proxy = DBus::DBusClient{AtspiDbusNameRegistry, AtspiDbusPathRoot, AtspiDbusInterfaceSocket, mConnectionPtr};
348 Address root{"", "root"};
349 auto res = proxy.method<Address(Address)>("Embed").call(root);
352 LOG() << "Call to Embed failed: " << res.getError().message;
356 mApplication.mParent.SetAddress(std::move(std::get<0>(res)));
358 mEnabledSignal.Emit();
362 auto rootLayer = Dali::Stage::GetCurrent().GetRootLayer();
363 auto window = Dali::DevelWindow::Get(rootLayer);
364 EmitActivate(window); // Currently, sends a signal that the default window is activated here.
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 ListenScreenReaderEnabledProperty()
587 mAccessibilityStatusClient.addPropertyChangedEvent<bool>("ScreenReaderEnabled", [this](bool res) {
588 mIsScreenReaderEnabled = res;
593 void ReadAndListenProperties()
595 ReadIsEnabledProperty();
596 ListenIsEnabledProperty();
598 ReadScreenReaderEnabledProperty();
599 ListenScreenReaderEnabledProperty();
602 bool InitializeAccessibilityStatusClient()
604 mAccessibilityStatusClient = DBus::DBusClient{A11yDbusName, A11yDbusPath, A11yDbusStatusInterface, DBus::ConnectionType::SESSION};
606 if (!mAccessibilityStatusClient)
608 DALI_LOG_ERROR("Accessibility Status DbusClient is not ready\n");
615 bool InitializeTimerCallback()
617 if ( InitializeAccessibilityStatusClient() )
619 ReadAndListenProperties();
627 if ( InitializeAccessibilityStatusClient() )
629 ReadAndListenProperties();
630 mIdleCallback = NULL;
634 if(!mInitializeTimer)
636 mInitializeTimer = Dali::Timer::New(RETRY_INTERVAL);
637 mInitializeTimer.TickSignal().Connect(this, &BridgeImpl::InitializeTimerCallback);
639 mInitializeTimer.Start();
641 mIdleCallback = NULL;
646 * @copydoc Dali::Accessibility::Bridge::Initialize()
648 void Initialize() override
650 if ( InitializeAccessibilityStatusClient() )
652 ReadAndListenProperties();
656 // Initialize failed. Try it again on Idle
657 if( Dali::Adaptor::IsAvailable() )
659 Dali::Adaptor& adaptor = Dali::Adaptor::Get();
660 if( NULL == mIdleCallback )
662 mIdleCallback = MakeCallback( this, &BridgeImpl::OnIdleSignal );
663 adaptor.AddIdle( mIdleCallback, true );
669 * @copydoc Dali::Accessibility::Bridge::GetScreenReaderEnabled()
671 bool GetScreenReaderEnabled() override
673 return mIsScreenReaderEnabled;
677 * @copydoc Dali::Accessibility::Bridge::IsEnabled()
679 bool IsEnabled() override
685 namespace // unnamed namespace
688 bool INITIALIZED_BRIDGE = false;
691 * @brief Creates BridgeImpl instance.
693 * @return The BridgeImpl instance
694 * @note This method is to check environment variable first. If ATSPI is disable using env, it returns dummy bridge instance.
696 Bridge* CreateBridge()
698 INITIALIZED_BRIDGE = true;
702 /* check environment variable first */
703 const char* envAtspiDisabled = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_DISABLE_ATSPI);
704 if(envAtspiDisabled && std::atoi(envAtspiDisabled) != 0)
706 return Dali::Accessibility::DummyBridge::GetInstance();
709 return new BridgeImpl;
711 catch(const std::exception&)
713 DALI_LOG_ERROR("Failed to initialize AT-SPI bridge");
714 return Dali::Accessibility::DummyBridge::GetInstance();
718 } // unnamed namespace
720 // Dali::Accessibility::Bridge class implementation
722 Bridge* Bridge::GetCurrentBridge()
724 static Bridge* bridge;
730 else if(mAutoInitState == AutoInitState::ENABLED)
732 bridge = CreateBridge();
734 /* check environment variable for suppressing screen-reader */
735 const char* envSuppressScreenReader = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_SUPPRESS_SCREEN_READER);
736 if(envSuppressScreenReader && std::atoi(envSuppressScreenReader) != 0)
738 bridge->SuppressScreenReader(true);
744 return Dali::Accessibility::DummyBridge::GetInstance();
747 void Bridge::DisableAutoInit()
749 if(INITIALIZED_BRIDGE)
751 DALI_LOG_ERROR("Bridge::DisableAutoInit() called after bridge auto-initialization");
754 mAutoInitState = AutoInitState::DISABLED;
757 void Bridge::EnableAutoInit()
759 mAutoInitState = AutoInitState::ENABLED;
761 if(INITIALIZED_BRIDGE)
766 auto rootLayer = Dali::Stage::GetCurrent().GetRootLayer(); // A root layer of the default window.
767 auto window = Dali::DevelWindow::Get(rootLayer);
768 auto applicationName = Dali::Internal::Adaptor::Adaptor::GetApplicationPackageName();
770 auto accessible = Accessibility::Accessible::Get(rootLayer, true);
772 auto* bridge = Bridge::GetCurrentBridge();
773 bridge->AddTopLevelWindow(accessible);
774 bridge->SetApplicationName(applicationName);
775 bridge->Initialize();
777 if(window && window.IsVisible())
779 bridge->WindowShown(window);