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 listenOnAtspiEnabledSignalClient;
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;
70 listenOnAtspiEnabledSignalClient = DBus::DBusClient{A11yDbusName, A11yDbusPath, A11yDbusStatusInterface, DBus::ConnectionType::SESSION};
72 listenOnAtspiEnabledSignalClient.addPropertyChangedEvent<bool>("ScreenReaderEnabled", [this](bool res) {
73 screenReaderEnabled = res;
74 if(screenReaderEnabled || isEnabled)
84 listenOnAtspiEnabledSignalClient.addPropertyChangedEvent<bool>("IsEnabled", [this](bool res) {
86 if(screenReaderEnabled || isEnabled)
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:
123 auto m = registryClient.method<bool(std::tuple<uint32_t, int32_t, int32_t, int32_t, int32_t, std::string, bool>)>("NotifyListenersSync");
124 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});
127 LOG() << result.getError().message;
130 return std::get<0>(result) ? Consumed::YES : Consumed::NO;
133 void Pause() override
140 directReadingClient.method<DBus::ValueOrError<void>(bool)>("PauseResume").asyncCall([](DBus::ValueOrError<void> msg) {
143 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
149 void Resume() override
156 directReadingClient.method<DBus::ValueOrError<void>(bool)>("PauseResume").asyncCall([](DBus::ValueOrError<void> msg) {
159 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
165 void StopReading(bool alsoNonDiscardable) override
172 directReadingClient.method<DBus::ValueOrError<void>(bool)>("StopReading").asyncCall([](DBus::ValueOrError<void> msg) {
175 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
181 void Say(const std::string& text, bool discardable, std::function<void(std::string)> callback) override
188 directReadingClient.method<DBus::ValueOrError<std::string, bool, int32_t>(std::string, bool)>("ReadCommand").asyncCall([=](DBus::ValueOrError<std::string, bool, int32_t> msg) {
191 LOG() << "Direct reading command failed (" << msg.getError().message << ")";
195 directReadingCallbacks.emplace(std::get<2>(msg), callback);
202 void ForceDown() override
206 if(mData->mCurrentlyHighlightedActor && mData->mHighlightActor)
208 mData->mCurrentlyHighlightedActor.Remove(mData->mHighlightActor);
210 mData->mCurrentlyHighlightedActor = {};
211 mData->mHighlightActor = {};
213 highlightedActor = {};
214 highlightClearAction = {};
215 BridgeAccessible::ForceDown();
217 directReadingClient = {};
218 directReadingCallbacks.clear();
221 void Terminate() override
225 mData->mCurrentlyHighlightedActor = {};
226 mData->mHighlightActor = {};
229 listenOnAtspiEnabledSignalClient = {};
234 ForceUpResult ForceUp() override
236 if(BridgeAccessible::ForceUp() == ForceUpResult::ALREADY_UP)
238 return ForceUpResult::ALREADY_UP;
241 BridgeObject::RegisterInterfaces();
242 BridgeAccessible::RegisterInterfaces();
243 BridgeComponent::RegisterInterfaces();
244 BridgeCollection::RegisterInterfaces();
245 BridgeAction::RegisterInterfaces();
246 BridgeValue::RegisterInterfaces();
247 BridgeText::RegisterInterfaces();
248 BridgeEditableText::RegisterInterfaces();
249 BridgeSelection::RegisterInterfaces();
250 BridgeApplication::RegisterInterfaces();
252 RegisterOnBridge(&application);
254 registryClient = {AtspiDbusNameRegistry, AtspiDbusPathDec, AtspiDbusInterfaceDec, con};
255 directReadingClient = DBus::DBusClient{DirectReadingDBusName, DirectReadingDBusPath, DirectReadingDBusInterface, con};
256 directReadingClient.addSignal<void(int32_t, std::string)>("ReadingStateChanged", [=](int32_t id, std::string readingState) {
257 auto it = directReadingCallbacks.find(id);
258 if(it != directReadingCallbacks.end())
260 it->second(readingState);
261 if(readingState != "ReadingPaused" && readingState != "ReadingResumed" && readingState != "ReadingStarted")
262 directReadingCallbacks.erase(it);
266 auto proxy = DBus::DBusClient{AtspiDbusNameRegistry, AtspiDbusPathRoot, AtspiDbusInterfaceSocket, con};
267 Address root{"", "root"};
268 auto res = proxy.method<Address(Address)>("Embed").call(root);
271 LOG() << "Call to Embed failed: " << res.getError().message;
274 application.parent.SetAddress(std::move(std::get<0>(res)));
279 return ForceUpResult::JUST_STARTED;
284 auto win = application.getActiveWindow();
287 win->Emit(WindowEvent::ACTIVATE, 0);
291 void EmitDeactivate()
293 auto win = application.getActiveWindow();
296 win->Emit(WindowEvent::DEACTIVATE, 0);
300 void WindowHidden() override
302 if(isShown && IsUp())
309 void WindowShown() override
311 if(!isShown && IsUp())
318 void Initialize() override
320 auto dbusClient = DBus::DBusClient{A11yDbusName, A11yDbusPath, A11yDbusStatusInterface, DBus::ConnectionType::SESSION};
321 auto enabled = dbusClient.property<bool>("ScreenReaderEnabled").get();
324 screenReaderEnabled = std::get<0>(enabled);
327 enabled = dbusClient.property<bool>("IsEnabled").get();
330 isEnabled = std::get<0>(enabled);
333 if(screenReaderEnabled || isEnabled)
339 bool GetScreenReaderEnabled()
341 return screenReaderEnabled;
350 static bool bridgeInitialized;
352 static Bridge* CreateBridge()
354 bridgeInitialized = true;
358 /* check environment variable first */
359 const char* envAtspiDisabled = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_DISABLE_ATSPI);
360 if(envAtspiDisabled && std::atoi(envAtspiDisabled) != 0)
362 return Dali::Accessibility::DummyBridge::GetInstance();
365 return new BridgeImpl;
367 catch(const std::exception&)
369 DALI_LOG_ERROR("Failed to initialize AT-SPI bridge");
370 return Dali::Accessibility::DummyBridge::GetInstance();
374 Bridge* Bridge::GetCurrentBridge()
376 static Bridge* bridge;
382 else if(autoInitState == AutoInitState::ENABLED)
384 bridge = CreateBridge();
386 /* check environment variable for suppressing screen-reader */
387 const char* envSuppressScreenReader = Dali::EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_SUPPRESS_SCREEN_READER);
388 if(envSuppressScreenReader && std::atoi(envSuppressScreenReader) != 0)
390 bridge->SuppressScreenReader(true);
396 return Dali::Accessibility::DummyBridge::GetInstance();
399 void Bridge::DisableAutoInit()
401 if(bridgeInitialized)
403 DALI_LOG_ERROR("Bridge::DisableAutoInit() called after bridge auto-initialization");
406 autoInitState = AutoInitState::DISABLED;
409 void Bridge::EnableAutoInit()
411 autoInitState = AutoInitState::ENABLED;
413 if(bridgeInitialized)
418 auto rootLayer = Dali::Stage::GetCurrent().GetRootLayer();
419 auto window = Dali::DevelWindow::Get(rootLayer);
420 auto applicationName = Dali::Internal::Adaptor::Adaptor::GetApplicationPackageName();
422 auto* bridge = Bridge::GetCurrentBridge();
423 bridge->AddTopLevelWindow(Dali::Accessibility::Accessible::Get(rootLayer, true));
424 bridge->SetApplicationName(applicationName);
425 bridge->Initialize();
427 if(window && window.IsVisible())
429 bridge->WindowShown();