dali/internal/accessibility/bridge/accessibility-common.h

   1 #ifndef DALI_INTERNAL_ATSPI_ACCESSIBILITY_COMMON_H
   2 #define DALI_INTERNAL_ATSPI_ACCESSIBILITY_COMMON_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/integration-api/debug.h>
  23 #include <iomanip>
  24 #include <sstream>
  25 #include <string>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali/public-api/dali-adaptor-common.h>
  29 #include <dali/devel-api/adaptor-framework/accessibility-impl.h>
  30 #include <dali/internal/accessibility/bridge/dbus.h>
  31 #include <dali/internal/accessibility/bridge/dbus-locators.h>
  32
  33 #define A11yDbusName "org.a11y.Bus"
  34 #define A11yDbusPath "/org/a11y/bus"
  35 #define A11yDbusStatusInterface "org.a11y.Status"
  36 #define AtspiDbusNameRegistry "org.a11y.atspi.Registry"
  37 #define AtspiDbusPathRoot "/org/a11y/atspi/accessible/root"
  38 #define AtspiDbusInterfaceSocket "org.a11y.atspi.Socket"
  39 #define AtspiPath "/org/a11y/atspi/accessible"
  40 #define AtspiDbusInterfaceAccessible "org.a11y.atspi.Accessible"
  41 #define AtspiDbusInterfaceAction "org.a11y.atspi.Action"
  42 #define AtspiDbusInterfaceApplication "org.a11y.atspi.Application"
  43 #define AtspiDbusInterfaceCollection "org.a11y.atspi.Collection"
  44 #define AtspiDbusInterfaceComponent "org.a11y.atspi.Component"
  45 #define AtspiDbusInterfaceDocument "org.a11y.atspi.Document"
  46 #define AtspiDbusInterfaceEditableText "org.a11y.atspi.EditableText"
  47 #define AtspiDbusInterfaceEventKeyboard "org.a11y.atspi.Event.Keyboard"
  48 #define AtspiDbusInterfaceEventMouse "org.a11y.atspi.Event.Mouse"
  49 #define AtspiDbusInterfaceEventObject "org.a11y.atspi.Event.Object"
  50 #define AtspiDbusInterfaceHyperlink "org.a11y.atspi.Hyperlink"
  51 #define AtspiDbusInterfaceHypertext "org.a11y.atspi.Hypertext"
  52 #define AtspiDbusInterfaceImage "org.a11y.atspi.Image"
  53 #define AtspiDbusInterfaceSelection "org.a11y.atspi.Selection"
  54 #define AtspiDbusInterfaceTable "org.a11y.atspi.Table"
  55 #define AtspiDbusInterfaceTableCell "org.a11y.atspi.TableCell"
  56 #define AtspiDbusInterfaceText "org.a11y.atspi.Text"
  57 #define AtspiDbusInterfaceValue "org.a11y.atspi.Value"
  58 #define AtspiDbusInterfaceSocket "org.a11y.atspi.Socket"
  59 #define AtspiDbusInterfaceEventWindow "org.a11y.atspi.Event.Window"
  60
  61 #define AtspiDbusPathDec "/org/a11y/atspi/registry/deviceeventcontroller"
  62 #define AtspiDbusInterfaceDec "org.a11y.atspi.DeviceEventController"
  63 #define AtspiDbusInterfaceDeviceEventListener "org.a11y.atspi.DeviceEventListener"
  64
  65 #define DirectReadingDBusName "org.tizen.ScreenReader"
  66 #define DirectReadingDBusPath "/org/tizen/DirectReading"
  67 #define DirectReadingDBusInterface "org.tizen.DirectReading"
  68
  69 struct ObjectPath;
  70
  71 /**
  72  * @brief Enumeration used for quering Accessibility objects
  73  */
  74 enum class MatchType : int32_t
  75 {
  76   INVALID,
  77   ALL,
  78   ANY,
  79   NONE,
  80   EMPTY
  81 };
  82
  83 /**
  84  * @brief Enumeration used for quering Accessibility objects
  85  * SortOrder::Canonical uses breadth-first search and sort objects in order of indexes in parent
  86  * SortOrder::ReverseCanonical uses SortOrder::Canonical and reverse collection
  87  * The rest of orders is not supported.
  88  */
  89 enum class SortOrder : uint32_t
  90 {
  91   INVALID,
  92   CANONICAL,
  93   FLOW,
  94   TAB,
  95   REVERSE_CANONICAL,
  96   REVERSE_FLOW,
  97   REVERSE_TAB,
  98   LAST_DEFINED
  99 };
 100
 101 namespace DBus
 102 {
 103
 104 class CurrentBridgePtr
 105 {
 106   static Dali::Accessibility::Bridge*& get()
 107   {
 108     static thread_local Dali::Accessibility::Bridge* b = nullptr;
 109     return b;
 110   }
 111   Dali::Accessibility::Bridge* prev;
 112   CurrentBridgePtr( const CurrentBridgePtr& ) = delete;
 113   CurrentBridgePtr( CurrentBridgePtr&& ) = delete;
 114   CurrentBridgePtr& operator=( const CurrentBridgePtr& ) = delete;
 115   CurrentBridgePtr& operator=( CurrentBridgePtr&& ) = delete;
 116
 117 public:
 118   CurrentBridgePtr( Dali::Accessibility::Bridge* b )
 119   : prev( get() )
 120   {
 121     get() = b;
 122   }
 123
 124   ~CurrentBridgePtr()
 125   {
 126     get() = prev;
 127   }
 128
 129   static Dali::Accessibility::Bridge* current()
 130   {
 131     return get();
 132   }
 133 };
 134
 135 namespace detail
 136 {
 137
 138 template < typename T >
 139 struct signature_accessible_impl : signature_helper<signature_accessible_impl<T>>
 140 {
 141   using subtype = std::pair< std::string, ObjectPath >;
 142
 143   static constexpr auto name_v = concat("AtspiAccessiblePtr");
 144   static constexpr auto sig_v = concat("(so)");
 145
 146   /**
 147    * @brief Marshals value v as marshalled type into message
 148    */
 149   static void set( const DBusWrapper::MessageIterPtr& iter, T* t )
 150   {
 151     if( t )
 152     {
 153       auto v = t->GetAddress();
 154       signature< subtype >::set( iter, { v.GetBus(), ObjectPath{std::string{ ATSPI_PREFIX_PATH } +v.GetPath()} } );
 155     }
 156     else
 157     {
 158       signature< subtype >::set( iter, { "", ObjectPath{ ATSPI_NULL_PATH } } );
 159     }
 160   }
 161
 162   /**
 163    * @brief Marshals value from marshalled type into variable v
 164    */
 165   static bool get( const DBusWrapper::MessageIterPtr& iter, T*& v )
 166   {
 167     subtype tmp;
 168     if( !signature< subtype >::get( iter, tmp ) )
 169     {
 170       return false;
 171     }
 172
 173     if( tmp.second.value == ATSPI_NULL_PATH )
 174     {
 175       v = nullptr;
 176       return true;
 177     }
 178
 179     if( tmp.second.value.substr( 0, strlen( ATSPI_PREFIX_PATH ) ) != ATSPI_PREFIX_PATH )
 180     {
 181       return false;
 182     }
 183
 184     auto b = CurrentBridgePtr::current();
 185     if( b->GetBusName() != tmp.first )
 186     {
 187       return false;
 188     }
 189
 190     v = b->FindByPath( tmp.second.value.substr( strlen( ATSPI_PREFIX_PATH ) ) );
 191     return v != nullptr;
 192   }
 193 };
 194
 195 template <>
 196 struct signature< Dali::Accessibility::Accessible* > : public signature_accessible_impl< Dali::Accessibility::Accessible >
 197 {
 198 };
 199
 200 template <>
 201 struct signature< Dali::Accessibility::Address > : signature_helper<signature<Dali::Accessibility::Address>>
 202 {
 203   using subtype = std::pair< std::string, ObjectPath >;
 204
 205   static constexpr auto name_v = concat("AtspiAccessiblePtr");
 206   static constexpr auto sig_v = concat("(so)");
 207
 208   /**
 209    * @brief Marshals value v as marshalled type into message
 210    */
 211   static void set( const DBusWrapper::MessageIterPtr& iter, const Dali::Accessibility::Address& v )
 212   {
 213     if( v )
 214     {
 215       signature< subtype >::set( iter, { v.GetBus(), ObjectPath{ std::string{ ATSPI_PREFIX_PATH } + v.GetPath() } } );
 216     }
 217     else
 218     {
 219       signature< subtype >::set( iter, { v.GetBus(), ObjectPath{ ATSPI_NULL_PATH } } );
 220     }
 221   }
 222
 223   /**
 224    * @brief Marshals value from marshalled type into variable v
 225    */
 226   static bool get( const DBusWrapper::MessageIterPtr& iter, Dali::Accessibility::Address& v )
 227   {
 228     subtype tmp;
 229     if( !signature< subtype >::get( iter, tmp ) )
 230     {
 231       return false;
 232     }
 233
 234     if( tmp.second.value == ATSPI_NULL_PATH )
 235     {
 236       v = {};
 237       return true;
 238     }
 239     if( tmp.second.value.substr( 0, strlen( ATSPI_PREFIX_PATH ) ) != ATSPI_PREFIX_PATH )
 240     {
 241       return false;
 242     }
 243
 244   v = { std::move( tmp.first ), tmp.second.value.substr( strlen( ATSPI_PREFIX_PATH ) ) };
 245   return true;
 246   }
 247 };
 248
 249 template <>
 250 struct signature< Dali::Accessibility::States > : signature_helper<signature<Dali::Accessibility::States>>
 251 {
 252   using subtype = std::array<uint32_t, 2>;
 253
 254   static constexpr auto name_v = signature<subtype>::name_v;
 255   static constexpr auto sig_v = signature<subtype>::sig_v;
 256
 257   /**
 258    * @brief Marshals value v as marshalled type into message
 259    */
 260   static void set( const DBusWrapper::MessageIterPtr& iter, const Dali::Accessibility::States& v )
 261   {
 262     signature< subtype >::set( iter, v.GetRawData() );
 263   }
 264
 265   /**
 266    * @brief Marshals value from marshalled type into variable v
 267    */
 268   static bool get( const DBusWrapper::MessageIterPtr& iter, Dali::Accessibility::States& v )
 269   {
 270     subtype tmp;
 271     if( !signature< subtype >::get( iter, tmp ) )
 272     {
 273       return false;
 274     }
 275     v = Dali::Accessibility::States{ tmp };
 276     return true;
 277   }
 278 };
 279 }
 280 }
 281
 282 struct _Logger
 283 {
 284   const char* file;
 285   int line;
 286   std::ostringstream tmp;
 287
 288   _Logger( const char* f, int l )
 289   : file( f ),
 290     line( l ){}
 291
 292   ~_Logger()
 293   {
 294     Dali::Integration::Log::LogMessage( Dali::Integration::Log::DebugInfo, "%s:%d: %s", file, line, tmp.str().c_str() );
 295   }
 296
 297   template < typename T >
 298   _Logger& operator<<( T&& t )
 299   {
 300     tmp << std::forward< T >( t );
 301     return *this;
 302   }
 303 };
 304
 305 struct _LoggerEmpty
 306 {
 307   template < typename T >
 308   _LoggerEmpty& operator<<( T&& t )
 309   {
 310     return *this;
 311   }
 312 };
 313
 314 struct _LoggerScope
 315 {
 316   const char* file;
 317   int line;
 318
 319   _LoggerScope( const char* f, int l )
 320   : file( f ),
 321     line( l )
 322   {
 323     Dali::Integration::Log::LogMessage( Dali::Integration::Log::DebugInfo, "%s:%d: +", file, line );
 324   }
 325
 326   ~_LoggerScope()
 327   {
 328     Dali::Integration::Log::LogMessage( Dali::Integration::Log::DebugInfo, "%s:%d: -", file, line );
 329   }
 330 };
 331
 332 #define LOG() _Logger( __FILE__, __LINE__ )
 333 #define SCOPE() _LoggerScope _l##__LINE__( __FILE__, __LINE__ )
 334
 335 #endif // DALI_INTERNAL_ATSPI_ACCESSIBILITY_COMMON_H