mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
Remove beast::Singleton
This commit is contained in:
Vinnie Falco
@@ -4,8 +4,6 @@ BEAST TODO
|
|||||||
|
|
||||||
- Tidy up CacheLine, MemoryAlignment
|
- Tidy up CacheLine, MemoryAlignment
|
||||||
|
|
||||||
- Kill off beast_Singleton.h since it uses macros
|
|
||||||
|
|
||||||
- Remove anything having to do with DLL builds like
|
- Remove anything having to do with DLL builds like
|
||||||
BEAST_DLL, BEAST_DLL_BUILD, BEAST_DISABLE_DLL_ALLOCATORS
|
BEAST_DLL, BEAST_DLL_BUILD, BEAST_DISABLE_DLL_ALLOCATORS
|
||||||
|
|
||||||
|
|||||||
@@ -263,7 +263,6 @@ namespace beast
|
|||||||
#include "threads/beast_SpinLock.h"
|
#include "threads/beast_SpinLock.h"
|
||||||
#include "time/beast_PerformedAtExit.h"
|
#include "time/beast_PerformedAtExit.h"
|
||||||
#include "memory/beast_SharedSingleton.h"
|
#include "memory/beast_SharedSingleton.h"
|
||||||
#include "memory/beast_Singleton.h"
|
|
||||||
#include "memory/beast_WeakReference.h"
|
#include "memory/beast_WeakReference.h"
|
||||||
#include "memory/beast_MemoryAlignment.h"
|
#include "memory/beast_MemoryAlignment.h"
|
||||||
#include "memory/beast_CacheLine.h"
|
#include "memory/beast_CacheLine.h"
|
||||||
|
|||||||
@@ -1,287 +0,0 @@
|
|||||||
//------------------------------------------------------------------------------
|
|
||||||
/*
|
|
||||||
This file is part of Beast: https://github.com/vinniefalco/Beast
|
|
||||||
Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>
|
|
||||||
|
|
||||||
Portions of this file are from JUCE.
|
|
||||||
Copyright (c) 2013 - Raw Material Software Ltd.
|
|
||||||
Please visit http://www.juce.com
|
|
||||||
|
|
||||||
Permission to use, copy, modify, and/or distribute this software for any
|
|
||||||
purpose with or without fee is hereby granted, provided that the above
|
|
||||||
copyright notice and this permission notice appear in all copies.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
*/
|
|
||||||
//==============================================================================
|
|
||||||
|
|
||||||
#ifndef BEAST_SINGLETON_BEASTHEADER
|
|
||||||
#define BEAST_SINGLETON_BEASTHEADER
|
|
||||||
|
|
||||||
|
|
||||||
//==============================================================================
|
|
||||||
/**
|
|
||||||
Macro to declare member variables and methods for a singleton class.
|
|
||||||
|
|
||||||
To use this, add the line beast_DeclareSingleton (MyClass, doNotRecreateAfterDeletion)
|
|
||||||
to the class's definition.
|
|
||||||
|
|
||||||
Then put a macro beast_ImplementSingleton (MyClass) along with the class's
|
|
||||||
implementation code.
|
|
||||||
|
|
||||||
It's also a very good idea to also add the call clearSingletonInstance() in your class's
|
|
||||||
destructor, in case it is deleted by other means than deleteInstance()
|
|
||||||
|
|
||||||
Clients can then call the static method MyClass::getInstance() to get a pointer
|
|
||||||
to the singleton, or MyClass::getInstanceWithoutCreating() which will return 0 if
|
|
||||||
no instance currently exists.
|
|
||||||
|
|
||||||
e.g. @code
|
|
||||||
|
|
||||||
class MySingleton
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
MySingleton()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
~MySingleton()
|
|
||||||
{
|
|
||||||
// this ensures that no dangling pointers are left when the
|
|
||||||
// singleton is deleted.
|
|
||||||
clearSingletonInstance();
|
|
||||||
}
|
|
||||||
|
|
||||||
beast_DeclareSingleton (MySingleton, false)
|
|
||||||
};
|
|
||||||
|
|
||||||
beast_ImplementSingleton (MySingleton)
|
|
||||||
|
|
||||||
|
|
||||||
// example of usage:
|
|
||||||
MySingleton* m = MySingleton::getInstance(); // creates the singleton if there isn't already one.
|
|
||||||
|
|
||||||
...
|
|
||||||
|
|
||||||
MySingleton::deleteInstance(); // safely deletes the singleton (if it's been created).
|
|
||||||
|
|
||||||
@endcode
|
|
||||||
|
|
||||||
If doNotRecreateAfterDeletion = true, it won't allow the object to be created more
|
|
||||||
than once during the process's lifetime - i.e. after you've created and deleted the
|
|
||||||
object, getInstance() will refuse to create another one. This can be useful to stop
|
|
||||||
objects being accidentally re-created during your app's shutdown code.
|
|
||||||
|
|
||||||
If you know that your object will only be created and deleted by a single thread, you
|
|
||||||
can use the slightly more efficient beast_DeclareSingleton_SingleThreaded() macro instead
|
|
||||||
of this one.
|
|
||||||
|
|
||||||
@see beast_ImplementSingleton, beast_DeclareSingleton_SingleThreaded
|
|
||||||
*/
|
|
||||||
#define beast_DeclareSingleton(classname, doNotRecreateAfterDeletion) \
|
|
||||||
\
|
|
||||||
static classname* _singletonInstance; \
|
|
||||||
static beast::CriticalSection _singletonLock; \
|
|
||||||
\
|
|
||||||
static classname* BEAST_CALLTYPE getInstance() \
|
|
||||||
{ \
|
|
||||||
if (_singletonInstance == nullptr) \
|
|
||||||
{\
|
|
||||||
const beast::ScopedLock sl (_singletonLock); \
|
|
||||||
\
|
|
||||||
if (_singletonInstance == nullptr) \
|
|
||||||
{ \
|
|
||||||
static bool alreadyInside = false; \
|
|
||||||
static bool createdOnceAlready = false; \
|
|
||||||
\
|
|
||||||
const bool problem = alreadyInside || ((doNotRecreateAfterDeletion) && createdOnceAlready); \
|
|
||||||
bassert (! problem); \
|
|
||||||
if (! problem) \
|
|
||||||
{ \
|
|
||||||
createdOnceAlready = true; \
|
|
||||||
alreadyInside = true; \
|
|
||||||
classname* newObject = new classname(); /* (use a stack variable to avoid setting the newObject value before the class has finished its constructor) */ \
|
|
||||||
alreadyInside = false; \
|
|
||||||
\
|
|
||||||
_singletonInstance = newObject; \
|
|
||||||
} \
|
|
||||||
} \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
return _singletonInstance; \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
static inline classname* BEAST_CALLTYPE getInstanceWithoutCreating() noexcept\
|
|
||||||
{ \
|
|
||||||
return _singletonInstance; \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
static void BEAST_CALLTYPE deleteInstance() \
|
|
||||||
{ \
|
|
||||||
const beast::ScopedLock sl (_singletonLock); \
|
|
||||||
if (_singletonInstance != nullptr) \
|
|
||||||
{ \
|
|
||||||
classname* const old = _singletonInstance; \
|
|
||||||
_singletonInstance = nullptr; \
|
|
||||||
delete old; \
|
|
||||||
} \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
void clearSingletonInstance() noexcept\
|
|
||||||
{ \
|
|
||||||
if (_singletonInstance == this) \
|
|
||||||
_singletonInstance = nullptr; \
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
//==============================================================================
|
|
||||||
/** This is a counterpart to the beast_DeclareSingleton macro.
|
|
||||||
|
|
||||||
After adding the beast_DeclareSingleton to the class definition, this macro has
|
|
||||||
to be used in the cpp file.
|
|
||||||
*/
|
|
||||||
#define beast_ImplementSingleton(classname) \
|
|
||||||
\
|
|
||||||
classname* classname::_singletonInstance = nullptr; \
|
|
||||||
beast::CriticalSection classname::_singletonLock;
|
|
||||||
|
|
||||||
|
|
||||||
//==============================================================================
|
|
||||||
/**
|
|
||||||
Macro to declare member variables and methods for a singleton class.
|
|
||||||
|
|
||||||
This is exactly the same as beast_DeclareSingleton, but doesn't use a critical
|
|
||||||
section to make access to it thread-safe. If you know that your object will
|
|
||||||
only ever be created or deleted by a single thread, then this is a
|
|
||||||
more efficient version to use.
|
|
||||||
|
|
||||||
If doNotRecreateAfterDeletion = true, it won't allow the object to be created more
|
|
||||||
than once during the process's lifetime - i.e. after you've created and deleted the
|
|
||||||
object, getInstance() will refuse to create another one. This can be useful to stop
|
|
||||||
objects being accidentally re-created during your app's shutdown code.
|
|
||||||
|
|
||||||
See the documentation for beast_DeclareSingleton for more information about
|
|
||||||
how to use it, the only difference being that you have to use
|
|
||||||
beast_ImplementSingleton_SingleThreaded instead of beast_ImplementSingleton.
|
|
||||||
|
|
||||||
@see beast_ImplementSingleton_SingleThreaded, beast_DeclareSingleton, beast_DeclareSingleton_SingleThreaded_Minimal
|
|
||||||
*/
|
|
||||||
#define beast_DeclareSingleton_SingleThreaded(classname, doNotRecreateAfterDeletion) \
|
|
||||||
\
|
|
||||||
static classname* _singletonInstance; \
|
|
||||||
\
|
|
||||||
static classname* getInstance() \
|
|
||||||
{ \
|
|
||||||
if (_singletonInstance == nullptr) \
|
|
||||||
{ \
|
|
||||||
static bool alreadyInside = false; \
|
|
||||||
static bool createdOnceAlready = false; \
|
|
||||||
\
|
|
||||||
const bool problem = alreadyInside || ((doNotRecreateAfterDeletion) && createdOnceAlready); \
|
|
||||||
bassert (! problem); \
|
|
||||||
if (! problem) \
|
|
||||||
{ \
|
|
||||||
createdOnceAlready = true; \
|
|
||||||
alreadyInside = true; \
|
|
||||||
classname* newObject = new classname(); /* (use a stack variable to avoid setting the newObject value before the class has finished its constructor) */ \
|
|
||||||
alreadyInside = false; \
|
|
||||||
\
|
|
||||||
_singletonInstance = newObject; \
|
|
||||||
} \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
return _singletonInstance; \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
static inline classname* getInstanceWithoutCreating() noexcept\
|
|
||||||
{ \
|
|
||||||
return _singletonInstance; \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
static void deleteInstance() \
|
|
||||||
{ \
|
|
||||||
if (_singletonInstance != nullptr) \
|
|
||||||
{ \
|
|
||||||
classname* const old = _singletonInstance; \
|
|
||||||
_singletonInstance = nullptr; \
|
|
||||||
delete old; \
|
|
||||||
} \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
void clearSingletonInstance() noexcept\
|
|
||||||
{ \
|
|
||||||
if (_singletonInstance == this) \
|
|
||||||
_singletonInstance = nullptr; \
|
|
||||||
}
|
|
||||||
|
|
||||||
//==============================================================================
|
|
||||||
/**
|
|
||||||
Macro to declare member variables and methods for a singleton class.
|
|
||||||
|
|
||||||
This is like beast_DeclareSingleton_SingleThreaded, but doesn't do any checking
|
|
||||||
for recursion or repeated instantiation. It's intended for use as a lightweight
|
|
||||||
version of a singleton, where you're using it in very straightforward
|
|
||||||
circumstances and don't need the extra checking.
|
|
||||||
|
|
||||||
Beast use the normal beast_ImplementSingleton_SingleThreaded as the counterpart
|
|
||||||
to this declaration, as you would with beast_DeclareSingleton_SingleThreaded.
|
|
||||||
|
|
||||||
See the documentation for beast_DeclareSingleton for more information about
|
|
||||||
how to use it, the only difference being that you have to use
|
|
||||||
beast_ImplementSingleton_SingleThreaded instead of beast_ImplementSingleton.
|
|
||||||
|
|
||||||
@see beast_ImplementSingleton_SingleThreaded, beast_DeclareSingleton
|
|
||||||
*/
|
|
||||||
#define beast_DeclareSingleton_SingleThreaded_Minimal(classname) \
|
|
||||||
\
|
|
||||||
static classname* _singletonInstance; \
|
|
||||||
\
|
|
||||||
static classname* getInstance() \
|
|
||||||
{ \
|
|
||||||
if (_singletonInstance == nullptr) \
|
|
||||||
_singletonInstance = new classname(); \
|
|
||||||
\
|
|
||||||
return _singletonInstance; \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
static inline classname* getInstanceWithoutCreating() noexcept\
|
|
||||||
{ \
|
|
||||||
return _singletonInstance; \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
static void deleteInstance() \
|
|
||||||
{ \
|
|
||||||
if (_singletonInstance != nullptr) \
|
|
||||||
{ \
|
|
||||||
classname* const old = _singletonInstance; \
|
|
||||||
_singletonInstance = nullptr; \
|
|
||||||
delete old; \
|
|
||||||
} \
|
|
||||||
} \
|
|
||||||
\
|
|
||||||
void clearSingletonInstance() noexcept\
|
|
||||||
{ \
|
|
||||||
if (_singletonInstance == this) \
|
|
||||||
_singletonInstance = nullptr; \
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
//==============================================================================
|
|
||||||
/** This is a counterpart to the beast_DeclareSingleton_SingleThreaded macro.
|
|
||||||
|
|
||||||
After adding beast_DeclareSingleton_SingleThreaded or beast_DeclareSingleton_SingleThreaded_Minimal
|
|
||||||
to the class definition, this macro has to be used somewhere in the cpp file.
|
|
||||||
*/
|
|
||||||
#define beast_ImplementSingleton_SingleThreaded(classname) \
|
|
||||||
\
|
|
||||||
classname* classname::_singletonInstance = nullptr;
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BEAST_SINGLETON_BEASTHEADER
|
|
||||||
Reference in New Issue
Block a user