dali/internal/event/common/type-info-impl.cpp

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali/internal/event/common/type-info-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <algorithm> // std::find_if
  23 #include <string>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/integration-api/debug.h>
  27 #include <dali/internal/event/common/type-registry-impl.h>
  28 #include <dali/internal/event/common/proxy-object.h>
  29
  30 using std::find_if;
  31
  32 namespace
  33 {
  34
  35 /*
  36  * Functor to find by given type for vector of pairs
  37  */
  38 template <typename S, typename T>
  39 struct PairFinder
  40 {
  41   PairFinder(const S& find)
  42   : mFind(find)
  43   {
  44   }
  45
  46   bool operator()(const T& p) const
  47   {
  48     return p.first == mFind;
  49   }
  50
  51 private:
  52
  53   const S& mFind;
  54 };
  55
  56 /**
  57  * Functor to find a matching property name
  58  */
  59 template <typename T>
  60 struct PropertyNameFinder
  61 {
  62   PropertyNameFinder( const std::string& find )
  63   : mFind( find )
  64   {
  65   }
  66
  67   bool operator()(const T &p) const
  68   {
  69     return p.second.name == mFind;
  70   }
  71
  72 private:
  73
  74   const std::string& mFind;
  75 };
  76
  77 } // namespace anon
  78
  79 namespace Dali
  80 {
  81
  82 namespace Internal
  83 {
  84
  85 TypeInfo::TypeInfo(const std::string &name, const std::string &baseTypeName, Dali::TypeInfo::CreateFunction creator)
  86   : mTypeName(name), mBaseTypeName(baseTypeName), mCreate(creator)
  87 {
  88   DALI_ASSERT_ALWAYS(!name.empty() && "Type info construction must have a name");
  89   DALI_ASSERT_ALWAYS(!baseTypeName.empty() && "Type info construction must have a base type name");
  90 }
  91
  92 TypeInfo::~TypeInfo()
  93 {
  94 }
  95
  96 BaseHandle TypeInfo::CreateInstance() const
  97 {
  98   BaseHandle ret;
  99
 100   if(mCreate)
 101   {
 102     ret = mCreate();
 103
 104     if ( ret )
 105     {
 106       BaseObject& handle = ret.GetBaseObject();
 107       ProxyObject *proxyObject = dynamic_cast<Internal::ProxyObject*>(&handle);
 108
 109       if ( proxyObject )
 110       {
 111         proxyObject->SetTypeInfo( this );
 112       }
 113     }
 114   }
 115   return ret;
 116 }
 117
 118 bool TypeInfo::DoActionTo(BaseObject *object, const std::string &actionName, const std::vector<Property::Value> &properties)
 119 {
 120   bool done = false;
 121
 122   ActionContainer::iterator iter = find_if(mActions.begin(), mActions.end(), PairFinder<std::string, ActionPair>(actionName));
 123
 124   if( iter != mActions.end() )
 125   {
 126     done = (iter->second)(object, actionName, properties);
 127   }
 128   else
 129   {
 130     DALI_LOG_WARNING("Type '%s' cannot do action '%s'\n", mTypeName.c_str(), actionName.c_str());
 131   }
 132
 133   if(!done)
 134   {
 135     Dali::TypeInfo base = Dali::TypeRegistry::Get().GetTypeInfo( mBaseTypeName );
 136     while( base )
 137     {
 138       done = GetImplementation(base).DoActionTo(object, actionName, properties);
 139       if( done )
 140       {
 141         break;
 142       }
 143       base =  Dali::TypeRegistry::Get().GetTypeInfo( base.GetBaseName() );
 144     }
 145   }
 146
 147   return done;
 148 }
 149
 150 bool TypeInfo::ConnectSignal( BaseObject* object, ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functor )
 151 {
 152   bool connected( false );
 153
 154   ConnectorContainerV2::iterator iter = find_if( mSignalConnectors.begin(), mSignalConnectors.end(),
 155                                                  PairFinder<std::string, ConnectionPairV2>(signalName) );
 156
 157   if( iter != mSignalConnectors.end() )
 158   {
 159     connected = (iter->second)( object, connectionTracker, signalName, functor );
 160   }
 161
 162   return connected;
 163 }
 164
 165 const std::string& TypeInfo::GetName() const
 166 {
 167   return mTypeName;
 168 }
 169
 170 const std::string& TypeInfo::GetBaseName() const
 171 {
 172   return mBaseTypeName;
 173 }
 174
 175 Dali::TypeInfo::CreateFunction TypeInfo::GetCreator() const
 176 {
 177   return mCreate;
 178 }
 179
 180 void TypeInfo::GetActions( Dali::TypeInfo::NameContainer& ret ) const
 181 {
 182   for(ActionContainer::const_iterator iter = mActions.begin(); iter != mActions.end(); ++iter)
 183   {
 184     ret.push_back(iter->first);
 185   }
 186
 187   Dali::TypeInfo base = Dali::TypeRegistry::Get().GetTypeInfo( mBaseTypeName );
 188   while( base )
 189   {
 190     for(ActionContainer::const_iterator iter = GetImplementation(base).mActions.begin();
 191         iter != GetImplementation(base).mActions.end(); ++iter)
 192     {
 193       ret.push_back(iter->first);
 194     }
 195
 196     base = Dali::TypeRegistry::Get().GetTypeInfo( base.GetBaseName() );
 197   }
 198 }
 199
 200 void TypeInfo::GetSignals(Dali::TypeInfo::NameContainer& ret) const
 201 {
 202   for(ConnectorContainerV2::const_iterator iter = mSignalConnectors.begin(); iter != mSignalConnectors.end(); ++iter)
 203   {
 204     ret.push_back(iter->first);
 205   }
 206
 207   Dali::TypeInfo base = Dali::TypeRegistry::Get().GetTypeInfo( mBaseTypeName );
 208   while( base )
 209   {
 210     for(ConnectorContainerV2::const_iterator iter = GetImplementation(base).mSignalConnectors.begin();
 211         iter != GetImplementation(base).mSignalConnectors.end(); ++iter)
 212     {
 213       ret.push_back(iter->first);
 214     }
 215
 216     base = Dali::TypeRegistry::Get().GetTypeInfo( base.GetBaseName() );
 217   }
 218 }
 219
 220 void TypeInfo::GetProperties( Dali::TypeInfo::NameContainer& ret ) const
 221 {
 222   Property::IndexContainer indices;
 223
 224   GetPropertyIndices(indices);
 225
 226   ret.reserve(indices.size());
 227
 228   typedef std::vector< Property::Index > IndexContainer; ///< A vector of property indices
 229   for(Property::IndexContainer::iterator iter = indices.begin(); iter != indices.end(); ++iter)
 230   {
 231     const std::string& name = GetPropertyName( *iter );
 232     if(name.size())
 233     {
 234       ret.push_back( name );
 235     }
 236     else
 237     {
 238       DALI_LOG_WARNING("Property had no name\n");
 239     }
 240   }
 241 }
 242
 243 void TypeInfo::GetPropertyIndices( Property::IndexContainer& indices ) const
 244 {
 245   Dali::TypeInfo base = TypeRegistry::Get()->GetTypeInfo( mBaseTypeName );
 246   if ( base )
 247   {
 248     const TypeInfo& baseImpl( GetImplementation( base ) );
 249     baseImpl.GetPropertyIndices( indices );
 250   }
 251
 252   if ( ! mRegisteredProperties.empty() )
 253   {
 254     indices.reserve( indices.size() + mRegisteredProperties.size() );
 255
 256     const RegisteredPropertyContainer::const_iterator endIter = mRegisteredProperties.end();
 257     for ( RegisteredPropertyContainer::const_iterator iter = mRegisteredProperties.begin(); iter != endIter; ++iter )
 258     {
 259       indices.push_back( iter->first );
 260     }
 261   }
 262 }
 263
 264 const std::string& TypeInfo::GetPropertyName( Property::Index index ) const
 265 {
 266   RegisteredPropertyContainer::const_iterator iter = find_if( mRegisteredProperties.begin(), mRegisteredProperties.end(),
 267                                                           PairFinder< Property::Index, RegisteredPropertyPair >( index ) );
 268
 269   if ( iter != mRegisteredProperties.end() )
 270   {
 271     return iter->second.name;
 272   }
 273
 274   Dali::TypeInfo base = TypeRegistry::Get()->GetTypeInfo( mBaseTypeName );
 275   if ( base )
 276   {
 277     return GetImplementation(base).GetPropertyName( index );
 278   }
 279
 280   DALI_ASSERT_ALWAYS( ! "Cannot find property index" ); // use the same assert as ProxyObject
 281
 282   // Property not found, return reference to invalid property string.
 283   static const std::string EMPTY_PROPERTY_NAME;
 284   return EMPTY_PROPERTY_NAME;
 285 }
 286
 287 void TypeInfo::AddActionFunction( const std::string &actionName, Dali::TypeInfo::ActionFunction function )
 288 {
 289   if( NULL == function)
 290   {
 291     DALI_LOG_WARNING("Action function is empty\n");
 292   }
 293   else
 294   {
 295     ActionContainer::iterator iter = std::find_if(mActions.begin(), mActions.end(),
 296                                                   PairFinder<std::string, ActionPair>(actionName));
 297
 298     if( iter == mActions.end() )
 299     {
 300       mActions.push_back( ActionPair( actionName, function ) );
 301     }
 302     else
 303     {
 304       DALI_LOG_WARNING("Action already exists in TypeRegistry Type", actionName.c_str());
 305     }
 306   }
 307 }
 308
 309 void TypeInfo::AddConnectorFunction( const std::string& signalName, Dali::TypeInfo::SignalConnectorFunctionV2 function )
 310 {
 311   if( NULL == function)
 312   {
 313     DALI_LOG_WARNING("Connector function is empty\n");
 314   }
 315   else
 316   {
 317     ConnectorContainerV2::iterator iter = find_if( mSignalConnectors.begin(), mSignalConnectors.end(),
 318                                                    PairFinder<std::string, ConnectionPairV2>(signalName) );
 319
 320     if( iter == mSignalConnectors.end() )
 321     {
 322       mSignalConnectors.push_back( ConnectionPairV2( signalName, function ) );
 323     }
 324     else
 325     {
 326       DALI_LOG_WARNING("Signal name already exists in TypeRegistry Type for signal connector function", signalName.c_str());
 327     }
 328   }
 329 }
 330
 331 void TypeInfo::AddProperty( const std::string& name, Property::Index index, Property::Type type, Dali::TypeInfo::SetPropertyFunction setFunc, Dali::TypeInfo::GetPropertyFunction getFunc )
 332 {
 333   // The setter can be empty as a property can be read-only.
 334
 335   if ( NULL == getFunc )
 336   {
 337     DALI_ASSERT_ALWAYS( ! "GetProperty Function is empty" );
 338   }
 339   else
 340   {
 341     RegisteredPropertyContainer::iterator iter = find_if( mRegisteredProperties.begin(), mRegisteredProperties.end(),
 342                                                           PairFinder< Property::Index, RegisteredPropertyPair>(index) );
 343
 344     if ( iter == mRegisteredProperties.end() )
 345     {
 346       mRegisteredProperties.push_back( RegisteredPropertyPair( index, RegisteredProperty( type, setFunc, getFunc, name ) ) );
 347     }
 348     else
 349     {
 350       DALI_ASSERT_ALWAYS( ! "Property index already added to Type" );
 351     }
 352   }
 353 }
 354
 355 unsigned int TypeInfo::GetPropertyCount() const
 356 {
 357   unsigned int count( mRegisteredProperties.size() );
 358
 359   Dali::TypeInfo base = TypeRegistry::Get()->GetTypeInfo( mBaseTypeName );
 360   while ( base )
 361   {
 362     const TypeInfo& baseImpl( GetImplementation(base) );
 363     count += baseImpl.mRegisteredProperties.size();
 364     base = TypeRegistry::Get()->GetTypeInfo( baseImpl.mBaseTypeName );
 365   }
 366
 367   return count;
 368 }
 369
 370 Property::Index TypeInfo::GetPropertyIndex( const std::string& name ) const
 371 {
 372   Property::Index index = Property::INVALID_INDEX;
 373
 374   // Slow but should not be done that often
 375   RegisteredPropertyContainer::const_iterator iter = find_if( mRegisteredProperties.begin(), mRegisteredProperties.end(),
 376                                                           PropertyNameFinder< RegisteredPropertyPair >( name ) );
 377
 378   if ( iter != mRegisteredProperties.end() )
 379   {
 380     index = iter->first;
 381   }
 382   else
 383   {
 384     Dali::TypeInfo base = TypeRegistry::Get()->GetTypeInfo( mBaseTypeName );
 385     if ( base )
 386     {
 387       index = GetImplementation(base).GetPropertyIndex( name );
 388     }
 389   }
 390
 391   return index;
 392 }
 393
 394 bool TypeInfo::IsPropertyWritable( Property::Index index ) const
 395 {
 396   bool writable( false );
 397
 398   RegisteredPropertyContainer::const_iterator iter = find_if( mRegisteredProperties.begin(), mRegisteredProperties.end(),
 399                                                           PairFinder< Property::Index, RegisteredPropertyPair >( index ) );
 400
 401   if ( iter != mRegisteredProperties.end() )
 402   {
 403     writable = iter->second.setFunc ? true : false;
 404   }
 405   else
 406   {
 407     Dali::TypeInfo base = TypeRegistry::Get()->GetTypeInfo( mBaseTypeName );
 408     if ( base )
 409     {
 410       writable = GetImplementation(base).IsPropertyWritable( index );
 411     }
 412     else
 413     {
 414       DALI_ASSERT_ALWAYS( ! "Cannot find property index" ); // use the same assert as ProxyObject
 415     }
 416   }
 417
 418   return writable;
 419 }
 420
 421 Property::Type TypeInfo::GetPropertyType( Property::Index index ) const
 422 {
 423   Property::Type type( Property::NONE );
 424
 425   RegisteredPropertyContainer::const_iterator iter = find_if( mRegisteredProperties.begin(), mRegisteredProperties.end(),
 426                                                           PairFinder< Property::Index, RegisteredPropertyPair >( index ) );
 427
 428   if ( iter != mRegisteredProperties.end() )
 429   {
 430     type = iter->second.type;
 431   }
 432   else
 433   {
 434     Dali::TypeInfo base = TypeRegistry::Get()->GetTypeInfo( mBaseTypeName );
 435     if ( base )
 436     {
 437       type = GetImplementation(base).GetPropertyType( index );
 438     }
 439     else
 440     {
 441       DALI_ASSERT_ALWAYS( ! "Cannot find property index" ); // use the same assert as ProxyObject
 442     }
 443   }
 444
 445   return type;
 446 }
 447
 448 void TypeInfo::SetProperty( BaseObject *object, Property::Index index, const Property::Value& value ) const
 449 {
 450   RegisteredPropertyContainer::const_iterator iter = find_if( mRegisteredProperties.begin(), mRegisteredProperties.end(),
 451                                                               PairFinder< Property::Index, RegisteredPropertyPair >( index ) );
 452   if ( iter != mRegisteredProperties.end() )
 453   {
 454     DALI_ASSERT_ALWAYS( iter->second.setFunc && "Trying to write to a read-only property" );
 455     iter->second.setFunc( object, index, value );
 456   }
 457   else
 458   {
 459     Dali::TypeInfo base = TypeRegistry::Get()->GetTypeInfo( mBaseTypeName );
 460     if ( base )
 461     {
 462       GetImplementation(base).SetProperty( object, index, value );
 463     }
 464     else
 465     {
 466       DALI_ASSERT_ALWAYS( ! "Cannot find property index" ); // use the same assert as ProxyObject
 467     }
 468   }
 469 }
 470
 471 void TypeInfo::SetProperty( BaseObject *object, const std::string& name, const Property::Value& value ) const
 472 {
 473   RegisteredPropertyContainer::const_iterator iter = find_if( mRegisteredProperties.begin(), mRegisteredProperties.end(),
 474                                                               PropertyNameFinder< RegisteredPropertyPair >( name ) );
 475   if ( iter != mRegisteredProperties.end() )
 476   {
 477     DALI_ASSERT_ALWAYS( iter->second.setFunc && "Trying to write to a read-only property" );
 478     iter->second.setFunc( object, iter->first, value );
 479   }
 480   else
 481   {
 482     Dali::TypeInfo base = TypeRegistry::Get()->GetTypeInfo( mBaseTypeName );
 483     if ( base )
 484     {
 485       GetImplementation(base).SetProperty( object, name, value );
 486     }
 487     else
 488     {
 489       DALI_ASSERT_ALWAYS( ! "Cannot find property name" );
 490     }
 491   }
 492 }
 493
 494 Property::Value TypeInfo::GetProperty( const BaseObject *object, Property::Index index ) const
 495 {
 496   RegisteredPropertyContainer::const_iterator iter = find_if( mRegisteredProperties.begin(), mRegisteredProperties.end(),
 497                                                           PairFinder< Property::Index, RegisteredPropertyPair >( index ) );
 498   if( iter != mRegisteredProperties.end() )
 499   {
 500     // Need to remove the constness here as CustomActor will not be able to call Downcast with a const pointer to the object
 501     return iter->second.getFunc( const_cast< BaseObject* >( object ), index );
 502   }
 503
 504   Dali::TypeInfo base = TypeRegistry::Get()->GetTypeInfo( mBaseTypeName );
 505   if ( base )
 506   {
 507     return GetImplementation( base ).GetProperty( object, index );
 508   }
 509
 510   DALI_ASSERT_ALWAYS( ! "Cannot find property index" ); // use the same assert as ProxyObject
 511
 512   return Property::Value();
 513 }
 514
 515 Property::Value TypeInfo::GetProperty( const BaseObject *object, const std::string& name ) const
 516 {
 517   RegisteredPropertyContainer::const_iterator iter = find_if( mRegisteredProperties.begin(), mRegisteredProperties.end(),
 518                                                           PropertyNameFinder< RegisteredPropertyPair >( name ) );
 519   if( iter != mRegisteredProperties.end() )
 520   {
 521     // Need to remove the constness here as CustomActor will not be able to call Downcast with a const pointer to the object
 522     return iter->second.getFunc( const_cast< BaseObject* >( object ), iter->first );
 523   }
 524
 525   Dali::TypeInfo base = TypeRegistry::Get()->GetTypeInfo( mBaseTypeName );
 526   if ( base )
 527   {
 528     return GetImplementation( base ).GetProperty( object, name );
 529   }
 530
 531   DALI_ASSERT_ALWAYS( ! "Cannot find property name" );
 532
 533   return Property::Value();
 534 }
 535
 536 } // namespace Internal
 537
 538 } // namespace Dali