llvm-project/lldb/tools/lldb-mi/MIUtilSingletonBase.h
Chandler Carruth 2946cd7010 Update the file headers across all of the LLVM projects in the monorepo
to reflect the new license.

We understand that people may be surprised that we're moving the header
entirely to discuss the new license. We checked this carefully with the
Foundation's lawyer and we believe this is the correct approach.

Essentially, all code in the project is now made available by the LLVM
project under our new license, so you will see that the license headers
include that license only. Some of our contributors have contributed
code under our old license, and accordingly, we have retained a copy of
our old license notice in the top-level files in each project and
repository.

llvm-svn: 351636
2019-01-19 08:50:56 +00:00

53 lines
1.4 KiB
C++

//===-- MIUtilSingletonBase.h -----------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#pragma once
namespace MI {
// MI::ISingleton base class usage:
//
// class CMIDerivedClass
// : public MI::ISingleton< CMIDerivedClass >
// {
// friend MI::ISingleton< CMIDerivedClass >;
//
// // Overridden:
// public:
// // From MI::ISingleton
// bool Initialize() override;
// bool Shutdown() override;
// };
//++
//============================================================================
// Details: Base class for the singleton pattern.
// Gotchas: Derived class must specify MI::ISingleton<> as a friend class.
//--
template <typename T> class ISingleton {
// Statics:
public:
// Return an instance of the derived class
static T &Instance() {
// This will fail if the derived class has not
// declared itself to be a friend of MI::ISingleton
static T instance;
return instance;
}
// Overrideable:
public:
virtual bool Initialize() = 0;
virtual bool Shutdown() = 0;
//
/* dtor */ virtual ~ISingleton() {}
};
} // namespace MI