summaryrefslogtreecommitdiff
path: root/xpcom/threads/LeakRefPtr.h
blob: 241cee77ea3bbf873e194669a633804004a998f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/* Smart pointer which leaks its owning refcounted object by default. */

#ifndef LeakRefPtr_h
#define LeakRefPtr_h

#include "mozilla/AlreadyAddRefed.h"

namespace mozilla {

/**
 * Instance of this class behaves like a raw pointer which leaks the
 * resource it's owning if not explicitly released.
 */
template<class T>
class LeakRefPtr
{
public:
  explicit LeakRefPtr(already_AddRefed<T>&& aPtr)
    : mRawPtr(aPtr.take()) { }

  explicit operator bool() const { return !!mRawPtr; }

  LeakRefPtr<T>& operator=(already_AddRefed<T>&& aPtr)
  {
    mRawPtr = aPtr.take();
    return *this;
  }

  T* get() const { return mRawPtr; }

  already_AddRefed<T> take()
  {
    T* rawPtr = mRawPtr;
    mRawPtr = nullptr;
    return already_AddRefed<T>(rawPtr);
  }

  void release() { NS_RELEASE(mRawPtr); }

private:
  T* MOZ_OWNING_REF mRawPtr;
};

} // namespace mozilla

#endif // LeakRefPtr_h