Mathias Agopian | 6b35f97 | 2009-04-10 14:24:30 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2007 The Android Open Source Project |
| 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 | #ifndef ANDROID_UTILS_SINGLETON_H |
| 18 | #define ANDROID_UTILS_SINGLETON_H |
| 19 | |
| 20 | #include <stdint.h> |
Mathias Agopian | 22dbf39 | 2017-02-28 15:06:51 -0800 | [diff] [blame] | 21 | |
| 22 | // some vendor code assumes they have atoi() after including this file. |
| 23 | #include <stdlib.h> |
| 24 | |
Mathias Agopian | 6b35f97 | 2009-04-10 14:24:30 -0700 | [diff] [blame] | 25 | #include <sys/types.h> |
Colin Cross | 17b5b82 | 2016-09-15 18:15:37 -0700 | [diff] [blame] | 26 | #include <utils/Mutex.h> |
Romain Guy | 5cd3247 | 2011-10-12 13:48:51 -0700 | [diff] [blame] | 27 | #include <cutils/compiler.h> |
Mathias Agopian | 6b35f97 | 2009-04-10 14:24:30 -0700 | [diff] [blame] | 28 | |
| 29 | namespace android { |
| 30 | // --------------------------------------------------------------------------- |
| 31 | |
Colin Cross | b014509 | 2017-02-23 14:48:51 -0800 | [diff] [blame] | 32 | // Singleton<TYPE> may be used in multiple libraries, only one of which should |
| 33 | // define the static member variables using ANDROID_SINGLETON_STATIC_INSTANCE. |
| 34 | // Turn off -Wundefined-var-template so other users don't get: |
| 35 | // instantiation of variable 'android::Singleton<TYPE>::sLock' required here, |
| 36 | // but no definition is available |
| 37 | #if defined(__clang__) |
| 38 | #pragma clang diagnostic push |
| 39 | #pragma clang diagnostic ignored "-Wundefined-var-template" |
| 40 | #endif |
| 41 | |
Steven Moreland | b8f152d | 2017-12-18 16:14:13 -0800 | [diff] [blame] | 42 | // DO NOT USE: Please use scoped static initialization. For instance: |
| 43 | // MyClass& getInstance() { |
| 44 | // static MyClass gInstance(...); |
| 45 | // return gInstance; |
| 46 | // } |
Mathias Agopian | 6b35f97 | 2009-04-10 14:24:30 -0700 | [diff] [blame] | 47 | template <typename TYPE> |
Romain Guy | 5cd3247 | 2011-10-12 13:48:51 -0700 | [diff] [blame] | 48 | class ANDROID_API Singleton |
Mathias Agopian | 6b35f97 | 2009-04-10 14:24:30 -0700 | [diff] [blame] | 49 | { |
| 50 | public: |
| 51 | static TYPE& getInstance() { |
| 52 | Mutex::Autolock _l(sLock); |
| 53 | TYPE* instance = sInstance; |
Yi Kong | c1a1562 | 2018-07-11 17:37:34 -0700 | [diff] [blame] | 54 | if (instance == nullptr) { |
Mathias Agopian | 6b35f97 | 2009-04-10 14:24:30 -0700 | [diff] [blame] | 55 | instance = new TYPE(); |
| 56 | sInstance = instance; |
| 57 | } |
| 58 | return *instance; |
| 59 | } |
Romain Guy | 4e30623 | 2010-09-08 18:04:33 -0700 | [diff] [blame] | 60 | |
| 61 | static bool hasInstance() { |
| 62 | Mutex::Autolock _l(sLock); |
Yi Kong | c1a1562 | 2018-07-11 17:37:34 -0700 | [diff] [blame] | 63 | return sInstance != nullptr; |
Romain Guy | 4e30623 | 2010-09-08 18:04:33 -0700 | [diff] [blame] | 64 | } |
Mathias Agopian | 6b35f97 | 2009-04-10 14:24:30 -0700 | [diff] [blame] | 65 | |
| 66 | protected: |
Colin Cross | 17b5b82 | 2016-09-15 18:15:37 -0700 | [diff] [blame] | 67 | ~Singleton() { } |
| 68 | Singleton() { } |
Mathias Agopian | 6b35f97 | 2009-04-10 14:24:30 -0700 | [diff] [blame] | 69 | |
| 70 | private: |
| 71 | Singleton(const Singleton&); |
| 72 | Singleton& operator = (const Singleton&); |
| 73 | static Mutex sLock; |
| 74 | static TYPE* sInstance; |
| 75 | }; |
| 76 | |
Colin Cross | b014509 | 2017-02-23 14:48:51 -0800 | [diff] [blame] | 77 | #if defined(__clang__) |
| 78 | #pragma clang diagnostic pop |
| 79 | #endif |
Colin Cross | 17b5b82 | 2016-09-15 18:15:37 -0700 | [diff] [blame] | 80 | |
Mathias Agopian | d8c95cc | 2009-04-17 14:15:18 -0700 | [diff] [blame] | 81 | /* |
| 82 | * use ANDROID_SINGLETON_STATIC_INSTANCE(TYPE) in your implementation file |
| 83 | * (eg: <TYPE>.cpp) to create the static instance of Singleton<>'s attributes, |
| 84 | * and avoid to have a copy of them in each compilation units Singleton<TYPE> |
| 85 | * is used. |
Mathias Agopian | 24ed905 | 2010-05-28 15:13:30 -0700 | [diff] [blame] | 86 | * NOTE: we use a version of Mutex ctor that takes a parameter, because |
| 87 | * for some unknown reason using the default ctor doesn't emit the variable! |
Mathias Agopian | d8c95cc | 2009-04-17 14:15:18 -0700 | [diff] [blame] | 88 | */ |
| 89 | |
Mathias Agopian | 24ed905 | 2010-05-28 15:13:30 -0700 | [diff] [blame] | 90 | #define ANDROID_SINGLETON_STATIC_INSTANCE(TYPE) \ |
Chih-Hung Hsieh | c777f21 | 2014-12-10 13:55:21 -0800 | [diff] [blame] | 91 | template<> ::android::Mutex \ |
| 92 | (::android::Singleton< TYPE >::sLock)(::android::Mutex::PRIVATE); \ |
Yi Kong | c1a1562 | 2018-07-11 17:37:34 -0700 | [diff] [blame] | 93 | template<> TYPE* ::android::Singleton< TYPE >::sInstance(nullptr); /* NOLINT */ \ |
Chih-Hung Hsieh | c777f21 | 2014-12-10 13:55:21 -0800 | [diff] [blame] | 94 | template class ::android::Singleton< TYPE >; |
Mathias Agopian | d8c95cc | 2009-04-17 14:15:18 -0700 | [diff] [blame] | 95 | |
| 96 | |
Mathias Agopian | 6b35f97 | 2009-04-10 14:24:30 -0700 | [diff] [blame] | 97 | // --------------------------------------------------------------------------- |
Pirama Arumuga Nainar | 90affce | 2018-04-11 23:10:28 -0700 | [diff] [blame] | 98 | } // namespace android |
Mathias Agopian | 6b35f97 | 2009-04-10 14:24:30 -0700 | [diff] [blame] | 99 | |
| 100 | #endif // ANDROID_UTILS_SINGLETON_H |
| 101 | |