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;
46 class BridgeImpl : public virtual BridgeBase,
47 public BridgeAccessible,
49 public BridgeComponent,
50 public BridgeCollection,
54 public BridgeEditableText,
55 public BridgeSelection,
56 public BridgeApplication
58 DBus::DBusClient accessibilityStatusClient;
59 DBus::DBusClient registryClient, directReadingClient;
60 bool screenReaderEnabled = false;
61 bool isEnabled = false;
63 std::unordered_map<int32_t, std::function<void(std::string)>> directReadingCallbacks;
64 Dali::Actor highlightedActor;
65 std::function<void(Dali::Actor)> highlightClearAction;
66 Dali::CallbackBase* mIdleCallback = NULL;
73 Consumed Emit(KeyEventType type, unsigned int keyCode, const std::string& keyName, unsigned int timeStamp, bool isText) override
80 unsigned int keyType = 0;
84 case KeyEventType::KEY_PRESSED:
89 case KeyEventType::KEY_RELEASED:
99 auto m = registryClient.method<bool(std::tuple<uint32_t, int32_t, int32_t, int32_t, int32_t, std::string, bool>)>("NotifyListenersSync");
100 auto result = m.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});
103 LOG() << result.getError().message;
106 return std::get<0>(result) ? Consumed::YES : Consumed::NO;
109 void Pause() override
116 directReadingClient.method<DBus::ValueOrError<void>(bool)>("PauseResume").asyncCall([](DBus::ValueOrError<void> msg) {
119 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
125 void Resume() override
132 directReadingClient.method<DBus::ValueOrError<void>(bool)>("PauseResume").asyncCall([](DBus::ValueOrError<void> msg) {
135 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
141 void StopReading(bool alsoNonDiscardable) override
148 directReadingClient.method<DBus::ValueOrError<void>(bool)>("StopReading").asyncCall([](DBus::ValueOrError<void> msg) {
151 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
157 void Say(const std::string& text, bool discardable, std::function<void(std::string)> callback) override
164 directReadingClient.method<DBus::ValueOrError<std::string, bool, int32_t>(std::string, bool)>("ReadCommand").asyncCall([=](DBus::ValueOrError<std::string, bool, int32_t> msg) {
167 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
171 directReadingCallbacks.emplace(std::get<2>(msg), callback);
178 void ForceDown() override
182 if(mData->mCurrentlyHighlightedActor && mData->mHighlightActor)
184 mData->mCurrentlyHighlightedActor.Remove(mData->mHighlightActor);
186 mData->mCurrentlyHighlightedActor = {};
187 mData->mHighlightActor = {};
189 highlightedActor = {};
190 highlightClearAction = {};
191 BridgeAccessible::ForceDown();
193 directReadingClient = {};
194 directReadingCallbacks.clear();
197 void Terminate() override
201 mData->mCurrentlyHighlightedActor = {};
202 mData->mHighlightActor = {};
205 if((NULL != mIdleCallback) && Dali::Adaptor::IsAvailable())
207 Dali::Adaptor::Get().RemoveIdle(mIdleCallback);
209 accessibilityStatusClient = {};
214 ForceUpResult ForceUp() override
216 if(BridgeAccessible::ForceUp() == ForceUpResult::ALREADY_UP)
218 return ForceUpResult::ALREADY_UP;
221 BridgeObject::RegisterInterfaces();
222 BridgeAccessible::RegisterInterfaces();
223 BridgeComponent::RegisterInterfaces();
224 BridgeCollection::RegisterInterfaces();
225 BridgeAction::RegisterInterfaces();
226 BridgeValue::RegisterInterfaces();
227 BridgeText::RegisterInterfaces();
228 BridgeEditableText::RegisterInterfaces();
229 BridgeSelection::RegisterInterfaces();
230 BridgeApplication::RegisterInterfaces();
232 RegisterOnBridge(&application);
234 registryClient = {AtspiDbusNameRegistry, AtspiDbusPathDec, AtspiDbusInterfaceDec, con};
235 directReadingClient = DBus::DBusClient{DirectReadingDBusName, DirectReadingDBusPath, DirectReadingDBusInterface, con};
236 directReadingClient.addSignal<void(int32_t, std::string)>("ReadingStateChanged", [=](int32_t id, std::string readingState) {
237 auto it = directReadingCallbacks.find(id);
238 if(it != directReadingCallbacks.end())
240 it->second(readingState);
241 if(readingState != "ReadingPaused" && readingState != "ReadingResumed" && readingState != "ReadingStarted")
242 directReadingCallbacks.erase(it);
246 auto proxy = DBus::DBusClient{AtspiDbusNameRegistry, AtspiDbusPathRoot, AtspiDbusInterfaceSocket, con};
247 Address root{"", "root"};
248 auto res = proxy.method<Address(Address)>("Embed").call(root);
251 LOG() << "Call to Embed failed: " << res.getError().message;
254 application.parent.SetAddress(std::move(std::get<0>(res)));
259 return ForceUpResult::JUST_STARTED;
264 auto win = application.getActiveWindow();
267 win->Emit(WindowEvent::ACTIVATE, 0);
271 void EmitDeactivate()
273 auto win = application.getActiveWindow();
276 win->Emit(WindowEvent::DEACTIVATE, 0);
280 void WindowHidden() override
282 if(isShown && IsUp())
289 void WindowShown() override
291 if(!isShown && IsUp())
298 void ReadAndListenProperty()
301 auto enabled = accessibilityStatusClient.property<bool>("ScreenReaderEnabled").get();
304 screenReaderEnabled = std::get<0>(enabled);
306 enabled = accessibilityStatusClient.property<bool>("IsEnabled").get();
309 isEnabled = std::get<0>(enabled);
311 if(screenReaderEnabled || isEnabled)
316 // listen property change
317 accessibilityStatusClient.addPropertyChangedEvent<bool>("ScreenReaderEnabled", [this](bool res) {
318 screenReaderEnabled = res;
319 if(screenReaderEnabled || isEnabled)
329 accessibilityStatusClient.addPropertyChangedEvent<bool>("IsEnabled", [this](bool res) {
331 if(screenReaderEnabled || isEnabled)
342 bool InitializeAccessibilityStatusClient()
344 accessibilityStatusClient = DBus::DBusClient{A11yDbusName, A11yDbusPath, A11yDbusStatusInterface, DBus::ConnectionType::SESSION};
346 if (!accessibilityStatusClient)
348 DALI_LOG_ERROR("Accessibility Status DbusClient is not ready\n");
357 if ( InitializeAccessibilityStatusClient() )
359 ReadAndListenProperty();
360 mIdleCallback = NULL;
367 void Initialize() override
369 if ( InitializeAccessibilityStatusClient() )
371 ReadAndListenProperty();
375 // Initialize failed. Try it again on Idle
376 if( Dali::Adaptor::IsAvailable() )
378 Dali::Adaptor& adaptor = Dali::Adaptor::Get();
379 if( NULL == mIdleCallback )
381 mIdleCallback = MakeCallback( this, &BridgeImpl::OnIdleSignal );
382 adaptor.AddIdle( mIdleCallback, true );
387 bool GetScreenReaderEnabled()
389 return screenReaderEnabled;
398 static bool bridgeInitialized;
400 static Bridge* CreateBridge()
402 bridgeInitialized = true;
406 /* check environment variable first */
407 const char* envAtspiDisabled = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_DISABLE_ATSPI);
408 if(envAtspiDisabled && std::atoi(envAtspiDisabled) != 0)
410 return Dali::Accessibility::DummyBridge::GetInstance();
413 return new BridgeImpl;
415 catch(const std::exception&)
417 DALI_LOG_ERROR("Failed to initialize AT-SPI bridge");
418 return Dali::Accessibility::DummyBridge::GetInstance();
422 Bridge* Bridge::GetCurrentBridge()
424 static Bridge* bridge;
430 else if(autoInitState == AutoInitState::ENABLED)
432 bridge = CreateBridge();
434 /* check environment variable for suppressing screen-reader */
435 const char* envSuppressScreenReader = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_SUPPRESS_SCREEN_READER);
436 if(envSuppressScreenReader && std::atoi(envSuppressScreenReader) != 0)
438 bridge->SuppressScreenReader(true);
444 return Dali::Accessibility::DummyBridge::GetInstance();
447 void Bridge::DisableAutoInit()
449 if(bridgeInitialized)
451 DALI_LOG_ERROR("Bridge::DisableAutoInit() called after bridge auto-initialization");
454 autoInitState = AutoInitState::DISABLED;
457 void Bridge::EnableAutoInit()
459 autoInitState = AutoInitState::ENABLED;
461 if(bridgeInitialized)
466 auto rootLayer = Dali::Stage::GetCurrent().GetRootLayer();
467 auto window = Dali::DevelWindow::Get(rootLayer);
468 auto applicationName = Dali::Internal::Adaptor::Adaptor::GetApplicationPackageName();
470 auto* bridge = Bridge::GetCurrentBridge();
471 bridge->AddTopLevelWindow(Dali::Accessibility::Accessible::Get(rootLayer, true));
472 bridge->SetApplicationName(applicationName);
473 bridge->Initialize();
475 if(window && window.IsVisible())
477 bridge->WindowShown();