[AT-SPI] do not keep window in ApplicationAccessible
[platform/core/uifw/dali-adaptor.git] / dali / internal / accessibility / bridge / bridge-base.cpp
index dcca27b..9b920d8 100644 (file)
@@ -19,6 +19,7 @@
 #include <dali/internal/accessibility/bridge/bridge-base.h>
 
 // EXTERNAL INCLUDES
+#include <dali/devel-api/common/stage.h>
 #include <atomic>
 #include <cstdlib>
 #include <memory>
@@ -30,22 +31,23 @@ using namespace Dali::Accessibility;
 
 static Dali::Timer tickTimer;
 
-BridgeBase::~BridgeBase()
+BridgeBase::BridgeBase()
 {
 }
 
-BridgeBase::BridgeBase()
+BridgeBase::~BridgeBase()
 {
+  mApplication.mChildren.clear();
 }
 
-void BridgeBase::addFilteredEvent(FilteredEvents kind, Dali::Accessibility::Accessible* obj, float delay, std::function<void()> functor)
+void BridgeBase::AddFilteredEvent(FilteredEvents kind, Dali::Accessibility::Accessible* obj, float delay, std::function<void()> functor)
 {
   if(delay < 0)
   {
     delay = 0;
   }
 
-  auto it = filteredEvents.insert({{kind, obj}, {static_cast<unsigned int>(delay * 10), {}}});
+  auto it = mFilteredEvents.insert({{kind, obj}, {static_cast<unsigned int>(delay * 10), {}}});
   if(it.second)
   {
     functor();
@@ -58,13 +60,13 @@ void BridgeBase::addFilteredEvent(FilteredEvents kind, Dali::Accessibility::Acce
   if(!tickTimer)
   {
     tickTimer = Dali::Timer::New(100);
-    tickTimer.TickSignal().Connect(this, &BridgeBase::tickFilteredEvents);
+    tickTimer.TickSignal().Connect(this, &BridgeBase::TickFilteredEvents);
   }
 }
 
-bool BridgeBase::tickFilteredEvents()
+bool BridgeBase::TickFilteredEvents()
 {
-  for(auto it = filteredEvents.begin(); it != filteredEvents.end();)
+  for(auto it = mFilteredEvents.begin(); it != mFilteredEvents.end();)
   {
     if(it->second.first)
     {
@@ -79,33 +81,33 @@ bool BridgeBase::tickFilteredEvents()
       }
       else
       {
-        it = filteredEvents.erase(it);
+        it = mFilteredEvents.erase(it);
         continue;
       }
     }
     ++it;
   }
-  return !filteredEvents.empty();
+  return !mFilteredEvents.empty();
 }
 
-void BridgeBase::RegisteredEventsUpdate()
+void BridgeBase::UpdateRegisteredEvents()
 {
   using ReturnType = std::vector<std::tuple<std::string, std::string>>;
-  registry.method<DBus::ValueOrError<ReturnType>()>( "GetRegisteredEvents" ).asyncCall([this](DBus::ValueOrError<ReturnType> msg) {
+  mRegistry.method<DBus::ValueOrError<ReturnType>()>("GetRegisteredEvents").asyncCall([this](DBus::ValueOrError<ReturnType> msg) {
     if(!msg)
     {
       LOG() << "Get registered events failed";
       return;
     }
 
-    allowObjectBoundsChangedEvent = false;
+    IsBoundsChangedEventAllowed = false;
 
     ReturnType values = std::get<ReturnType>(msg.getValues());
     for(long unsigned int i = 0; i < values.size(); i++)
     {
-      if (!std::get<1>(values[i]).compare("Object:BoundsChanged"))
+      if(!std::get<1>(values[i]).compare("Object:BoundsChanged"))
       {
-        allowObjectBoundsChangedEvent = true;
+        IsBoundsChangedEventAllowed = true;
       }
     }
   });
@@ -113,7 +115,8 @@ void BridgeBase::RegisteredEventsUpdate()
 
 BridgeBase::ForceUpResult BridgeBase::ForceUp()
 {
-  if(Bridge::ForceUp() == ForceUpResult::ALREADY_UP)
+  //TODO: checking mBusName is enough? or a new variable to check bridge state?
+  if(Bridge::ForceUp() == ForceUpResult::ALREADY_UP && !GetBusName().empty())
   {
     return ForceUpResult::ALREADY_UP;
   }
@@ -122,34 +125,35 @@ BridgeBase::ForceUpResult BridgeBase::ForceUp()
 
   if(!addr)
   {
-    throw std::domain_error{std::string("failed at call '") + dbusLocators::atspi::GET_ADDRESS + "': " + addr.getError().message};
+    DALI_LOG_ERROR("failed at call '%s': %s\n", dbusLocators::atspi::GET_ADDRESS, addr.getError().message.c_str());
+    return ForceUpResult::FAILED;
   }
 
-  con           = DBusWrapper::Installed()->eldbus_address_connection_get_impl(std::get<0>(addr));
-  data->busName = DBus::getConnectionName(con);
-  dbusServer    = {con};
+  mConnectionPtr  = DBusWrapper::Installed()->eldbus_address_connection_get_impl(std::get<0>(addr));
+  mData->mBusName = DBus::getConnectionName(mConnectionPtr);
+  mDbusServer     = {mConnectionPtr};
 
   {
-    DBus::DBusInterfaceDescription desc{"org.a11y.atspi.Cache"};
+    DBus::DBusInterfaceDescription desc{Accessible::GetInterfaceName(AtspiInterface::CACHE)};
     AddFunctionToInterface(desc, "GetItems", &BridgeBase::GetItems);
-    dbusServer.addInterface("/org/a11y/atspi/cache", desc);
+    mDbusServer.addInterface(AtspiDbusPathCache, desc);
   }
   {
-    DBus::DBusInterfaceDescription desc{"org.a11y.atspi.Application"};
-    AddGetSetPropertyToInterface(desc, "Id", &BridgeBase::IdGet, &BridgeBase::IdSet);
-    dbusServer.addInterface(AtspiPath, desc);
+    DBus::DBusInterfaceDescription desc{Accessible::GetInterfaceName(AtspiInterface::APPLICATION)};
+    AddGetSetPropertyToInterface(desc, "Id", &BridgeBase::GetId, &BridgeBase::SetId);
+    mDbusServer.addInterface(AtspiPath, desc);
   }
 
-  registry = {AtspiDbusNameRegistry, AtspiDbusPathRegistry, AtspiDbusInterfaceRegistry, con};
+  mRegistry = {AtspiDbusNameRegistry, AtspiDbusPathRegistry, Accessible::GetInterfaceName(AtspiInterface::REGISTRY), mConnectionPtr};
 
-  RegisteredEventsUpdate();
+  UpdateRegisteredEvents();
 
-  registry.addSignal<void(void)>("EventListenerRegistered", [this](void) {
-    RegisteredEventsUpdate();
+  mRegistry.addSignal<void(void)>("EventListenerRegistered", [this](void) {
+    UpdateRegisteredEvents();
   });
 
-  registry.addSignal<void(void)>("EventListenerDeregistered", [this](void) {
-    RegisteredEventsUpdate();
+  mRegistry.addSignal<void(void)>("EventListenerDeregistered", [this](void) {
+    UpdateRegisteredEvents();
   });
 
   return ForceUpResult::JUST_STARTED;
@@ -158,15 +162,15 @@ BridgeBase::ForceUpResult BridgeBase::ForceUp()
 void BridgeBase::ForceDown()
 {
   Bridge::ForceDown();
-  registry   = {};
-  dbusServer = {};
-  con        = {};
+  mRegistry      = {};
+  mDbusServer    = {};
+  mConnectionPtr = {};
 }
 
 const std::string& BridgeBase::GetBusName() const
 {
   static std::string empty;
-  return data ? data->busName : empty;
+  return mData ? mData->mBusName : empty;
 }
 
 Accessible* BridgeBase::FindByPath(const std::string& name) const
@@ -181,56 +185,55 @@ Accessible* BridgeBase::FindByPath(const std::string& name) const
   }
 }
 
-void BridgeBase::AddPopup(Accessible* obj)
+void BridgeBase::AddTopLevelWindow(Accessible* windowAccessible)
 {
-  if(std::find(popups.begin(), popups.end(), obj) != popups.end())
+  if(windowAccessible->GetInternalActor() == nullptr)
   {
     return;
   }
-  popups.push_back(obj);
-  if(IsUp())
+
+  // Prevent adding the default window twice.
+  if(!mApplication.mChildren.empty() &&
+     mApplication.mChildren[0]->GetInternalActor() == windowAccessible->GetInternalActor())
   {
-    obj->Emit(WindowEvent::ACTIVATE, 0);
+    return;
   }
+
+  // Adds Window to a list of Windows.
+  mApplication.mChildren.push_back(windowAccessible);
+  SetIsOnRootLevel(windowAccessible);
+
+  RegisterDefaultLabel(windowAccessible);
 }
 
-void BridgeBase::RemovePopup(Accessible* obj)
+void BridgeBase::RemoveTopLevelWindow(Accessible* windowAccessible)
 {
-  auto it = std::find(popups.begin(), popups.end(), obj);
-  if(it == popups.end())
-  {
-    return;
-  }
-  popups.erase(it);
-  if(IsUp())
+  UnregisterDefaultLabel(windowAccessible);
+
+  for(auto i = 0u; i < mApplication.mChildren.size(); ++i)
   {
-    obj->Emit(WindowEvent::DEACTIVATE, 0);
-    if(popups.empty())
+    if(mApplication.mChildren[i] == windowAccessible)
     {
-      application.children.back()->Emit(WindowEvent::ACTIVATE, 0);
-    }
-    else
-    {
-      popups.back()->Emit(WindowEvent::ACTIVATE, 0);
+      mApplication.mChildren.erase(mApplication.mChildren.begin() + i);
+      break;
     }
   }
 }
 
-void BridgeBase::AddTopLevelWindow(Accessible* root)
+void BridgeBase::RegisterDefaultLabel(Accessible* object)
 {
-  application.children.push_back(root);
-  SetIsOnRootLevel(root);
+  if(std::find(mDefaultLabels.begin(), mDefaultLabels.end(), object) == mDefaultLabels.end())
+  {
+    mDefaultLabels.push_back(object);
+  }
 }
 
-void BridgeBase::RemoveTopLevelWindow(Accessible* root)
+void BridgeBase::UnregisterDefaultLabel(Accessible* object)
 {
-  for(auto i = 0u; i < application.children.size(); ++i)
+  auto it = std::find(mDefaultLabels.begin(), mDefaultLabels.end(), object);
+  if(it != mDefaultLabels.end())
   {
-    if(application.children[i] == root)
-    {
-      application.children.erase(application.children.begin() + i);
-      break;
-    }
+    mDefaultLabels.erase(it);
   }
 }
 
@@ -244,60 +247,63 @@ Accessible* BridgeBase::Find(const std::string& path) const
 {
   if(path == "root")
   {
-    return &application;
+    return &mApplication;
   }
-  void*              p;
+
+  void*              accessible;
   std::istringstream tmp{path};
-  if(!(tmp >> p))
+  if(!(tmp >> accessible))
   {
     throw std::domain_error{"invalid path '" + path + "'"};
   }
-  auto it = data->knownObjects.find(static_cast<Accessible*>(p));
-  if(it == data->knownObjects.end())
+
+  auto it = mData->mKnownObjects.find(static_cast<Accessible*>(accessible));
+  if(it == mData->mKnownObjects.end() || (*it)->IsHidden())
   {
     throw std::domain_error{"unknown object '" + path + "'"};
   }
-  return static_cast<Accessible*>(p);
+
+  return static_cast<Accessible*>(accessible);
 }
 
 Accessible* BridgeBase::Find(const Address& ptr) const
 {
-  assert(ptr.GetBus() == data->busName);
+  assert(ptr.GetBus() == mData->mBusName);
   return Find(ptr.GetPath());
 }
 
-Accessible* BridgeBase::FindSelf() const
+Accessible* BridgeBase::FindCurrentObject() const
 {
-  auto pth  = DBus::DBusServer::getCurrentObjectPath();
+  auto path = DBus::DBusServer::getCurrentObjectPath();
   auto size = strlen(AtspiPath);
-  if(pth.size() <= size)
+  if(path.size() <= size)
   {
-    throw std::domain_error{"invalid path '" + pth + "'"};
+    throw std::domain_error{"invalid path '" + path + "'"};
   }
-  if(pth.substr(0, size) != AtspiPath)
+  if(path.substr(0, size) != AtspiPath)
   {
-    throw std::domain_error{"invalid path '" + pth + "'"};
+    throw std::domain_error{"invalid path '" + path + "'"};
   }
-  if(pth[size] != '/')
+  if(path[size] != '/')
   {
-    throw std::domain_error{"invalid path '" + pth + "'"};
+    throw std::domain_error{"invalid path '" + path + "'"};
   }
-  return Find(StripPrefix(pth));
+  return Find(StripPrefix(path));
 }
 
-void BridgeBase::IdSet(int id)
+void BridgeBase::SetId(int id)
 {
-  this->id = id;
+  this->mId = id;
 }
 
-int BridgeBase::IdGet()
+int BridgeBase::GetId()
 {
-  return this->id;
+  return this->mId;
 }
 
-auto BridgeBase::GetItems() -> DBus::ValueOrError<std::vector<CacheElementType> >
+auto BridgeBase::GetItems() -> DBus::ValueOrError<std::vector<CacheElementType>>
 {
-  auto root = &application;
+  auto root = &mApplication;
 
   std::vector<CacheElementType> res;
 
@@ -320,7 +326,7 @@ auto BridgeBase::CreateCacheElement(Accessible* item) -> CacheElementType
     return {};
   }
 
-  auto root   = &application;
+  auto root   = &mApplication;
   auto parent = item->GetParent();
 
   std::vector<Address> children;
@@ -334,7 +340,7 @@ auto BridgeBase::CreateCacheElement(Accessible* item) -> CacheElementType
     root->GetAddress(),
     parent ? parent->GetAddress() : Address{},
     children,
-    item->GetInterfaces(),
+    item->GetInterfacesAsStrings(),
     item->GetName(),
     item->GetRole(),
     item->GetDescription(),