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-object.h>
36 #include <dali/internal/accessibility/bridge/bridge-selection.h>
37 #include <dali/internal/accessibility/bridge/bridge-text.h>
38 #include <dali/internal/accessibility/bridge/bridge-value.h>
39 #include <dali/internal/accessibility/bridge/bridge-application.h>
40 #include <dali/internal/accessibility/bridge/dummy-atspi.h>
41 #include <dali/internal/adaptor/common/adaptor-impl.h>
42 #include <dali/internal/system/common/environment-variables.h>
44 using namespace Dali::Accessibility;
47 * @brief The BridgeImpl class is to implement some Bridge functions.
49 class BridgeImpl : public virtual BridgeBase,
50 public BridgeAccessible,
52 public BridgeComponent,
53 public BridgeCollection,
57 public BridgeEditableText,
58 public BridgeSelection,
59 public BridgeApplication
61 DBus::DBusClient mAccessibilityStatusClient;
62 DBus::DBusClient mRegistryClient;
63 DBus::DBusClient mDirectReadingClient;
64 bool mIsScreenReaderEnabled = false;
65 bool mIsEnabled = false;
66 bool mIsShown = false;
67 std::unordered_map<int32_t, std::function<void(std::string)>> mDirectReadingCallbacks;
68 Dali::Actor mHighlightedActor;
69 std::function<void(Dali::Actor)> mHighlightClearAction;
70 Dali::CallbackBase* mIdleCallback = NULL;
78 * @copydoc Dali::Accessibility::Bridge::Emit()
80 Consumed Emit(KeyEventType type, unsigned int keyCode, const std::string& keyName, unsigned int timeStamp, bool isText) override
87 unsigned int keyType = 0;
91 case KeyEventType::KEY_PRESSED:
96 case KeyEventType::KEY_RELEASED:
107 auto methodObject = mRegistryClient.method<bool(std::tuple<uint32_t, int32_t, int32_t, int32_t, int32_t, std::string, bool>)>("NotifyListenersSync");
108 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});
111 LOG() << result.getError().message;
114 return std::get<0>(result) ? Consumed::YES : Consumed::NO;
118 * @copydoc Dali::Accessibility::Bridge::Pause()
120 void Pause() override
127 mDirectReadingClient.method<DBus::ValueOrError<void>(bool)>("PauseResume").asyncCall([](DBus::ValueOrError<void> msg) {
130 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
137 * @copydoc Dali::Accessibility::Bridge::Resume()
139 void Resume() override
146 mDirectReadingClient.method<DBus::ValueOrError<void>(bool)>("PauseResume").asyncCall([](DBus::ValueOrError<void> msg) {
149 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
156 * @copydoc Dali::Accessibility::Bridge::StopReading()
158 void StopReading(bool alsoNonDiscardable) override
165 mDirectReadingClient.method<DBus::ValueOrError<void>(bool)>("StopReading").asyncCall([](DBus::ValueOrError<void> msg) {
168 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
175 * @copydoc Dali::Accessibility::Bridge::Say()
177 void Say(const std::string& text, bool discardable, std::function<void(std::string)> callback) override
184 mDirectReadingClient.method<DBus::ValueOrError<std::string, bool, int32_t>(std::string, bool)>("ReadCommand").asyncCall([=](DBus::ValueOrError<std::string, bool, int32_t> msg) {
187 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
191 mDirectReadingCallbacks.emplace(std::get<2>(msg), callback);
199 * @copydoc Dali::Accessibility::Bridge::ForceDown()
201 void ForceDown() override
205 if(mData->mCurrentlyHighlightedActor && mData->mHighlightActor)
207 mData->mCurrentlyHighlightedActor.Remove(mData->mHighlightActor);
209 mData->mCurrentlyHighlightedActor = {};
210 mData->mHighlightActor = {};
212 mDisabledSignal.Emit();
214 mHighlightedActor = {};
215 mHighlightClearAction = {};
216 BridgeAccessible::ForceDown();
217 mRegistryClient = {};
218 mDirectReadingClient = {};
219 mDirectReadingCallbacks.clear();
220 mApplication.mChildren.clear();
221 mApplication.mWindows.clear();
225 * @copydoc Dali::Accessibility::Bridge::Terminate()
227 void Terminate() override
231 mData->mCurrentlyHighlightedActor = {};
232 mData->mHighlightActor = {};
235 if((NULL != mIdleCallback) && Dali::Adaptor::IsAvailable())
237 Dali::Adaptor::Get().RemoveIdle(mIdleCallback);
239 mAccessibilityStatusClient = {};
245 * @copydoc Dali::Accessibility::Bridge::ForceUp()
247 ForceUpResult ForceUp() override
249 if(BridgeAccessible::ForceUp() == ForceUpResult::ALREADY_UP)
251 return ForceUpResult::ALREADY_UP;
254 BridgeObject::RegisterInterfaces();
255 BridgeAccessible::RegisterInterfaces();
256 BridgeComponent::RegisterInterfaces();
257 BridgeCollection::RegisterInterfaces();
258 BridgeAction::RegisterInterfaces();
259 BridgeValue::RegisterInterfaces();
260 BridgeText::RegisterInterfaces();
261 BridgeEditableText::RegisterInterfaces();
262 BridgeSelection::RegisterInterfaces();
263 BridgeApplication::RegisterInterfaces();
265 RegisterOnBridge(&mApplication);
267 mRegistryClient = {AtspiDbusNameRegistry, AtspiDbusPathDec, AtspiDbusInterfaceDec, mConnectionPtr};
268 mDirectReadingClient = DBus::DBusClient{DirectReadingDBusName, DirectReadingDBusPath, DirectReadingDBusInterface, mConnectionPtr};
270 mDirectReadingClient.addSignal<void(int32_t, std::string)>("ReadingStateChanged", [=](int32_t id, std::string readingState) {
271 auto it = mDirectReadingCallbacks.find(id);
272 if(it != mDirectReadingCallbacks.end())
274 it->second(readingState);
275 if(readingState != "ReadingPaused" && readingState != "ReadingResumed" && readingState != "ReadingStarted")
277 mDirectReadingCallbacks.erase(it);
282 auto proxy = DBus::DBusClient{AtspiDbusNameRegistry, AtspiDbusPathRoot, AtspiDbusInterfaceSocket, mConnectionPtr};
283 Address root{"", "root"};
284 auto res = proxy.method<Address(Address)>("Embed").call(root);
287 LOG() << "Call to Embed failed: " << res.getError().message;
291 mApplication.mParent.SetAddress(std::move(std::get<0>(res)));
295 auto rootLayer = Dali::Stage::GetCurrent().GetRootLayer();
296 auto window = Dali::DevelWindow::Get(rootLayer);
297 EmitActivate(window); // Currently, sends a signal that the default window is activated here.
300 mEnabledSignal.Emit();
302 return ForceUpResult::JUST_STARTED;
306 * @brief Sends a signal to dbus that the window is shown.
308 * @param[in] window The window to be shown
309 * @see Accessible::EmitShowing() and BridgeObject::EmitStateChanged()
311 void EmitShown(Dali::Window window)
313 auto windowAccessible = mApplication.GetWindowAccessible(window);
316 windowAccessible->EmitShowing(true);
321 * @brief Sends a signal to dbus that the window is hidden.
323 * @param[in] window The window to be hidden
324 * @see Accessible::EmitShowing() and BridgeObject::EmitStateChanged()
326 void EmitHidden(Dali::Window window)
328 auto windowAccessible = mApplication.GetWindowAccessible(window);
331 windowAccessible->EmitShowing(false);
336 * @brief Sends a signal to dbus that the window is activated.
338 * @param[in] window The window to be activated
339 * @see BridgeObject::Emit()
341 void EmitActivate(Dali::Window window)
343 auto windowAccessible = mApplication.GetWindowAccessible(window);
346 windowAccessible->Emit(WindowEvent::ACTIVATE, 0);
351 * @brief Sends a signal to dbus that the window is deactivated.
353 * @param[in] window The window to be deactivated
354 * @see BridgeObject::Emit()
356 void EmitDeactivate(Dali::Window window)
358 auto windowAccessible = mApplication.GetWindowAccessible(window);
361 windowAccessible->Emit(WindowEvent::DEACTIVATE, 0);
366 * @copydoc Dali::Accessibility::Bridge::WindowShown()
368 void WindowShown(Dali::Window window) override
370 if(!mIsShown && IsUp())
378 * @copydoc Dali::Accessibility::Bridge::WindowHidden()
380 void WindowHidden(Dali::Window window) override
382 if(mIsShown && IsUp())
390 * @copydoc Dali::Accessibility::Bridge::WindowFocused()
392 void WindowFocused(Dali::Window window) override
394 if(mIsShown && IsUp())
396 EmitActivate(window);
401 * @copydoc Dali::Accessibility::Bridge::WindowUnfocused()
403 void WindowUnfocused(Dali::Window window) override
405 if(mIsShown && IsUp())
407 EmitDeactivate(window);
411 void ReadIsEnabledProperty()
413 mAccessibilityStatusClient.property<bool>("IsEnabled").asyncGet([this](DBus::ValueOrError<bool> msg) {
416 DALI_LOG_ERROR("Get IsEnabled property error: %s\n", msg.getError().message.c_str());
417 if(msg.getError().errorType == DBus::ErrorType::INVALID_REPLY)
419 ReadIsEnabledProperty();
423 mIsEnabled = std::get<0>(msg);
431 void ListenIsEnabledProperty()
433 mAccessibilityStatusClient.addPropertyChangedEvent<bool>("IsEnabled", [this](bool res) {
435 if(mIsScreenReaderEnabled || mIsEnabled)
446 void ReadScreenReaderEnabledProperty()
448 mAccessibilityStatusClient.property<bool>("ScreenReaderEnabled").asyncGet([this](DBus::ValueOrError<bool> msg) {
451 DALI_LOG_ERROR("Get ScreenReaderEnabled property error: %s\n", msg.getError().message.c_str());
452 if(msg.getError().errorType == DBus::ErrorType::INVALID_REPLY)
454 ReadScreenReaderEnabledProperty();
458 mIsScreenReaderEnabled = std::get<0>(msg);
459 if(mIsScreenReaderEnabled)
466 void ListenScreenReaderEnabledProperty()
468 mAccessibilityStatusClient.addPropertyChangedEvent<bool>("ScreenReaderEnabled", [this](bool res) {
469 mIsScreenReaderEnabled = res;
470 if(mIsScreenReaderEnabled || mIsEnabled)
481 void ReadAndListenProperties()
483 ReadIsEnabledProperty();
484 ListenIsEnabledProperty();
486 ReadScreenReaderEnabledProperty();
487 ListenScreenReaderEnabledProperty();
490 bool InitializeAccessibilityStatusClient()
492 mAccessibilityStatusClient = DBus::DBusClient{A11yDbusName, A11yDbusPath, A11yDbusStatusInterface, DBus::ConnectionType::SESSION};
494 if (!mAccessibilityStatusClient)
496 DALI_LOG_ERROR("Accessibility Status DbusClient is not ready\n");
505 if ( InitializeAccessibilityStatusClient() )
507 ReadAndListenProperties();
508 mIdleCallback = NULL;
516 * @copydoc Dali::Accessibility::Bridge::Initialize()
518 void Initialize() override
520 if ( InitializeAccessibilityStatusClient() )
522 ReadAndListenProperties();
526 // Initialize failed. Try it again on Idle
527 if( Dali::Adaptor::IsAvailable() )
529 Dali::Adaptor& adaptor = Dali::Adaptor::Get();
530 if( NULL == mIdleCallback )
532 mIdleCallback = MakeCallback( this, &BridgeImpl::OnIdleSignal );
533 adaptor.AddIdle( mIdleCallback, true );
539 * @copydoc Dali::Accessibility::Bridge::GetScreenReaderEnabled()
541 bool GetScreenReaderEnabled() override
543 return mIsScreenReaderEnabled;
547 * @copydoc Dali::Accessibility::Bridge::IsEnabled()
549 bool IsEnabled() override
555 namespace // unnamed namespace
558 bool INITIALIZED_BRIDGE = false;
561 * @brief Creates BridgeImpl instance.
563 * @return The BridgeImpl instance
564 * @note This method is to check environment variable first. If ATSPI is disable using env, it returns dummy bridge instance.
566 Bridge* CreateBridge()
568 INITIALIZED_BRIDGE = true;
572 /* check environment variable first */
573 const char* envAtspiDisabled = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_DISABLE_ATSPI);
574 if(envAtspiDisabled && std::atoi(envAtspiDisabled) != 0)
576 return Dali::Accessibility::DummyBridge::GetInstance();
579 return new BridgeImpl;
581 catch(const std::exception&)
583 DALI_LOG_ERROR("Failed to initialize AT-SPI bridge");
584 return Dali::Accessibility::DummyBridge::GetInstance();
588 } // unnamed namespace
590 // Dali::Accessibility::Bridge class implementation
592 Bridge* Bridge::GetCurrentBridge()
594 static Bridge* bridge;
600 else if(mAutoInitState == AutoInitState::ENABLED)
602 bridge = CreateBridge();
604 /* check environment variable for suppressing screen-reader */
605 const char* envSuppressScreenReader = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_SUPPRESS_SCREEN_READER);
606 if(envSuppressScreenReader && std::atoi(envSuppressScreenReader) != 0)
608 bridge->SuppressScreenReader(true);
614 return Dali::Accessibility::DummyBridge::GetInstance();
617 void Bridge::DisableAutoInit()
619 if(INITIALIZED_BRIDGE)
621 DALI_LOG_ERROR("Bridge::DisableAutoInit() called after bridge auto-initialization");
624 mAutoInitState = AutoInitState::DISABLED;
627 void Bridge::EnableAutoInit()
629 mAutoInitState = AutoInitState::ENABLED;
631 if(INITIALIZED_BRIDGE)
636 auto rootLayer = Dali::Stage::GetCurrent().GetRootLayer(); // A root layer of the default window.
637 auto window = Dali::DevelWindow::Get(rootLayer);
638 auto applicationName = Dali::Internal::Adaptor::Adaptor::GetApplicationPackageName();
640 auto accessible = Accessibility::Accessible::Get(rootLayer, true);
642 auto* bridge = Bridge::GetCurrentBridge();
643 bridge->AddTopLevelWindow(accessible);
644 bridge->SetApplicationName(applicationName);
645 bridge->Initialize();
647 if(window && window.IsVisible())
649 bridge->WindowShown(window);