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 mHighlightedActor = {};
213 mHighlightClearAction = {};
214 BridgeAccessible::ForceDown();
215 mRegistryClient = {};
216 mDirectReadingClient = {};
217 mDirectReadingCallbacks.clear();
221 * @copydoc Dali::Accessibility::Bridge::Terminate()
223 void Terminate() override
227 mData->mCurrentlyHighlightedActor = {};
228 mData->mHighlightActor = {};
231 if((NULL != mIdleCallback) && Dali::Adaptor::IsAvailable())
233 Dali::Adaptor::Get().RemoveIdle(mIdleCallback);
235 mAccessibilityStatusClient = {};
241 * @copydoc Dali::Accessibility::Bridge::ForceUp()
243 ForceUpResult ForceUp() override
245 if(BridgeAccessible::ForceUp() == ForceUpResult::ALREADY_UP)
247 return ForceUpResult::ALREADY_UP;
250 BridgeObject::RegisterInterfaces();
251 BridgeAccessible::RegisterInterfaces();
252 BridgeComponent::RegisterInterfaces();
253 BridgeCollection::RegisterInterfaces();
254 BridgeAction::RegisterInterfaces();
255 BridgeValue::RegisterInterfaces();
256 BridgeText::RegisterInterfaces();
257 BridgeEditableText::RegisterInterfaces();
258 BridgeSelection::RegisterInterfaces();
259 BridgeApplication::RegisterInterfaces();
261 RegisterOnBridge(&mApplication);
263 mRegistryClient = {AtspiDbusNameRegistry, AtspiDbusPathDec, AtspiDbusInterfaceDec, mConnectionPtr};
264 mDirectReadingClient = DBus::DBusClient{DirectReadingDBusName, DirectReadingDBusPath, DirectReadingDBusInterface, mConnectionPtr};
266 mDirectReadingClient.addSignal<void(int32_t, std::string)>("ReadingStateChanged", [=](int32_t id, std::string readingState) {
267 auto it = mDirectReadingCallbacks.find(id);
268 if(it != mDirectReadingCallbacks.end())
270 it->second(readingState);
271 if(readingState != "ReadingPaused" && readingState != "ReadingResumed" && readingState != "ReadingStarted")
273 mDirectReadingCallbacks.erase(it);
278 auto proxy = DBus::DBusClient{AtspiDbusNameRegistry, AtspiDbusPathRoot, AtspiDbusInterfaceSocket, mConnectionPtr};
279 Address root{"", "root"};
280 auto res = proxy.method<Address(Address)>("Embed").call(root);
283 LOG() << "Call to Embed failed: " << res.getError().message;
287 mApplication.mParent.SetAddress(std::move(std::get<0>(res)));
292 return ForceUpResult::JUST_STARTED;
296 * @brief Sends a signal to dbus that the default window is activated.
298 * TODO : This is subject to change if/when we implement multi-window support.
299 * @see BridgeObject::Emit()
303 auto win = mApplication.GetActiveWindow();
306 win->Emit(WindowEvent::ACTIVATE, 0);
311 * @brief Sends a signal to dbus that the default window is deactivated.
313 * TODO : This is subject to change if/when we implement multi-window support.
314 * @see BridgeObject::Emit()
316 void EmitDeactivate()
318 auto win = mApplication.GetActiveWindow();
321 win->Emit(WindowEvent::DEACTIVATE, 0);
326 * @copydoc Dali::Accessibility::Bridge::WindowHidden()
328 void WindowHidden() override
330 if(mIsShown && IsUp())
338 * @copydoc Dali::Accessibility::Bridge::WindowShown()
340 void WindowShown() override
342 if(!mIsShown && IsUp())
349 void ReadAndListenProperty()
352 auto enabled = mAccessibilityStatusClient.property<bool>("ScreenReaderEnabled").get();
355 mIsScreenReaderEnabled = std::get<0>(enabled);
358 enabled = mAccessibilityStatusClient.property<bool>("IsEnabled").get();
361 mIsEnabled = std::get<0>(enabled);
364 if(mIsScreenReaderEnabled || mIsEnabled)
369 // listen property change
370 mAccessibilityStatusClient.addPropertyChangedEvent<bool>("ScreenReaderEnabled", [this](bool res) {
371 mIsScreenReaderEnabled = res;
372 if(mIsScreenReaderEnabled || mIsEnabled)
382 mAccessibilityStatusClient.addPropertyChangedEvent<bool>("IsEnabled", [this](bool res) {
384 if(mIsScreenReaderEnabled || mIsEnabled)
395 bool InitializeAccessibilityStatusClient()
397 mAccessibilityStatusClient = DBus::DBusClient{A11yDbusName, A11yDbusPath, A11yDbusStatusInterface, DBus::ConnectionType::SESSION};
399 if (!mAccessibilityStatusClient)
401 DALI_LOG_ERROR("Accessibility Status DbusClient is not ready\n");
410 if ( InitializeAccessibilityStatusClient() )
412 ReadAndListenProperty();
413 mIdleCallback = NULL;
421 * @copydoc Dali::Accessibility::Bridge::Initialize()
423 void Initialize() override
425 if ( InitializeAccessibilityStatusClient() )
427 ReadAndListenProperty();
431 // Initialize failed. Try it again on Idle
432 if( Dali::Adaptor::IsAvailable() )
434 Dali::Adaptor& adaptor = Dali::Adaptor::Get();
435 if( NULL == mIdleCallback )
437 mIdleCallback = MakeCallback( this, &BridgeImpl::OnIdleSignal );
438 adaptor.AddIdle( mIdleCallback, true );
444 * @copydoc Dali::Accessibility::Bridge::GetScreenReaderEnabled()
446 bool GetScreenReaderEnabled() override
448 return mIsScreenReaderEnabled;
452 * @copydoc Dali::Accessibility::Bridge::IsEnabled()
454 bool IsEnabled() override
460 namespace // unnamed namespace
463 bool INITIALIZED_BRIDGE = false;
466 * @brief Creates BridgeImpl instance.
468 * @return The BridgeImpl instance
469 * @note This method is to check environment variable first. If ATSPI is disable using env, it returns dummy bridge instance.
471 Bridge* CreateBridge()
473 INITIALIZED_BRIDGE = true;
477 /* check environment variable first */
478 const char* envAtspiDisabled = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_DISABLE_ATSPI);
479 if(envAtspiDisabled && std::atoi(envAtspiDisabled) != 0)
481 return Dali::Accessibility::DummyBridge::GetInstance();
484 return new BridgeImpl;
486 catch(const std::exception&)
488 DALI_LOG_ERROR("Failed to initialize AT-SPI bridge");
489 return Dali::Accessibility::DummyBridge::GetInstance();
493 } // unnamed namespace
495 // Dali::Accessibility::Bridge class implementation
497 Bridge* Bridge::GetCurrentBridge()
499 static Bridge* bridge;
505 else if(mAutoInitState == AutoInitState::ENABLED)
507 bridge = CreateBridge();
509 /* check environment variable for suppressing screen-reader */
510 const char* envSuppressScreenReader = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_SUPPRESS_SCREEN_READER);
511 if(envSuppressScreenReader && std::atoi(envSuppressScreenReader) != 0)
513 bridge->SuppressScreenReader(true);
519 return Dali::Accessibility::DummyBridge::GetInstance();
522 void Bridge::DisableAutoInit()
524 if(INITIALIZED_BRIDGE)
526 DALI_LOG_ERROR("Bridge::DisableAutoInit() called after bridge auto-initialization");
529 mAutoInitState = AutoInitState::DISABLED;
532 void Bridge::EnableAutoInit()
534 mAutoInitState = AutoInitState::ENABLED;
536 if(INITIALIZED_BRIDGE)
541 auto rootLayer = Dali::Stage::GetCurrent().GetRootLayer();
542 auto window = Dali::DevelWindow::Get(rootLayer);
543 auto applicationName = Dali::Internal::Adaptor::Adaptor::GetApplicationPackageName();
545 auto* bridge = Bridge::GetCurrentBridge();
546 bridge->AddTopLevelWindow(Dali::Accessibility::Accessible::Get(rootLayer, true));
547 bridge->SetApplicationName(applicationName);
548 bridge->Initialize();
550 if(window && window.IsVisible())
552 bridge->WindowShown();