modules/core/include/dpl/singleton_impl.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   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  * @file        singleton_impl.h
  18  * @author      Lukasz Wrzosek (l.wrzosek@samsung.com)
  19  * @version     1.0
  20  * @brief       This file is the implementation file of singleton
  21  */
  22 #ifndef DPL_SINGLETON_IMPL_H
  23 #define DPL_SINGLETON_IMPL_H
  24
  25 /*
  26  * WARNING!
  27  *
  28  * If some singleton's implementation uses another singletons implementation,
  29  * those templates make the second singleton a dubleton. Be warned. Try to use
  30  * singleton_safe_impl.h if possible.
  31  */
  32
  33 namespace DPL
  34 {
  35
  36 template<typename Class>
  37 Singleton<Class>& Singleton<Class>::InternalInstance()
  38 {
  39     static Singleton<Class> instance;
  40     return instance;
  41 }
  42
  43 template<typename Class>
  44 Class &Singleton<Class>::Instance()
  45 {
  46     Singleton<Class>& instance = Singleton<Class>::InternalInstance();
  47
  48     if (!!instance.m_guard)
  49     {
  50         Assert(Thread::GetCurrentThread() == *instance.m_guard &&
  51                "Singleton thread guard failed. A forbidden call from foreign thread was detected!");
  52     }
  53
  54     return instance;
  55 }
  56
  57 // Thread guarding
  58 template<typename Class>
  59 void Singleton<Class>::SetThreadGuard(Thread *thread)
  60 {
  61     Singleton<Class>& instance = Singleton<Class>::InternalInstance();
  62     instance.m_guard = OptionalThreadPtr(thread);
  63 }
  64
  65 template<typename Class>
  66 void Singleton<Class>::ResetThreadGuard()
  67 {
  68     Singleton<Class>& instance = Singleton<Class>::InternalInstance();
  69     instance.m_guard = OptionalThreadPtr::Null;
  70 }
  71
  72 } // namespace DPL
  73
  74 #define IMPLEMENT_SINGLETON(Type)                                           \
  75 template DPL::Singleton<Type>& DPL::Singleton<Type>::InternalInstance();    \
  76 template Type& DPL::Singleton<Type>::Instance();                            \
  77 template void DPL::Singleton<Type>::SetThreadGuard(DPL::Thread *thread);    \
  78 template void DPL::Singleton<Type>::ResetThreadGuard();
  79
  80 #endif // DPL_SINGLETON_IMPL_H