summaryrefslogtreecommitdiffstats
path: root/parser/html/nsHtml5StreamParserPtr.h
blob: 09bb2a0ea7335c40bc3f64a0be7e194f140ada96 (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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
/* -*- Mode: C++; tab-width: 2; 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/. */

#ifndef nsHtml5StreamParserPtr_h
#define nsHtml5StreamParserPtr_h

#include "nsHtml5StreamParser.h"
#include "nsHtml5StreamParserReleaser.h"
#include "nsThreadUtils.h"
#include "mozilla/dom/DocGroup.h"

/**
 * Like nsRefPtr except release is proxied to the main
 * thread. Mostly copied from nsRefPtr.
 */
class nsHtml5StreamParserPtr {
 private:
  void assign_with_AddRef(nsHtml5StreamParser* rawPtr) {
    if (rawPtr) rawPtr->AddRef();
    assign_assuming_AddRef(rawPtr);
  }
  void** begin_assignment() {
    assign_assuming_AddRef(0);
    return reinterpret_cast<void**>(&mRawPtr);
  }
  void assign_assuming_AddRef(nsHtml5StreamParser* newPtr) {
    nsHtml5StreamParser* oldPtr = mRawPtr;
    mRawPtr = newPtr;
    if (oldPtr) release(oldPtr);
  }
  void release(nsHtml5StreamParser* aPtr) {
    nsCOMPtr<nsIRunnable> releaser = new nsHtml5StreamParserReleaser(aPtr);
    if (NS_FAILED(aPtr->DispatchToMain(releaser.forget()))) {
      NS_WARNING("Failed to dispatch releaser event.");
    }
  }

 private:
  nsHtml5StreamParser* mRawPtr;

 public:
  ~nsHtml5StreamParserPtr() {
    if (mRawPtr) release(mRawPtr);
  }
  // Constructors
  nsHtml5StreamParserPtr()
      : mRawPtr(0)
  // default constructor
  {}
  nsHtml5StreamParserPtr(const nsHtml5StreamParserPtr& aSmartPtr)
      : mRawPtr(aSmartPtr.mRawPtr)
  // copy-constructor
  {
    if (mRawPtr) mRawPtr->AddRef();
  }
  explicit nsHtml5StreamParserPtr(nsHtml5StreamParser* aRawPtr)
      : mRawPtr(aRawPtr)
  // construct from a raw pointer (of the right type)
  {
    if (mRawPtr) mRawPtr->AddRef();
  }
  // Assignment operators
  nsHtml5StreamParserPtr& operator=(const nsHtml5StreamParserPtr& rhs)
  // copy assignment operator
  {
    assign_with_AddRef(rhs.mRawPtr);
    return *this;
  }
  nsHtml5StreamParserPtr& operator=(nsHtml5StreamParser* rhs)
  // assign from a raw pointer (of the right type)
  {
    assign_with_AddRef(rhs);
    return *this;
  }
  // Other pointer operators
  void swap(nsHtml5StreamParserPtr& rhs)
  // ...exchange ownership with |rhs|; can save a pair of refcount operations
  {
    nsHtml5StreamParser* temp = rhs.mRawPtr;
    rhs.mRawPtr = mRawPtr;
    mRawPtr = temp;
  }
  void swap(nsHtml5StreamParser*& rhs)
  // ...exchange ownership with |rhs|; can save a pair of refcount operations
  {
    nsHtml5StreamParser* temp = rhs;
    rhs = mRawPtr;
    mRawPtr = temp;
  }
  template <typename I>
  void forget(I** rhs)
  // Set the target of rhs to the value of mRawPtr and null out mRawPtr.
  // Useful to avoid unnecessary AddRef/Release pairs with "out"
  // parameters where rhs bay be a T** or an I** where I is a base class
  // of T.
  {
    NS_ASSERTION(rhs, "Null pointer passed to forget!");
    *rhs = mRawPtr;
    mRawPtr = 0;
  }
  nsHtml5StreamParser* get() const
  /*
            Prefer the implicit conversion provided automatically by |operator
     nsHtml5StreamParser*() const|. Use |get()| to resolve ambiguity or to get a
     castable pointer.
          */
  {
    return const_cast<nsHtml5StreamParser*>(mRawPtr);
  }
  operator nsHtml5StreamParser*() const
  /*
            ...makes an |nsHtml5StreamParserPtr| act like its underlying raw
     pointer type whenever it is used in a context where a raw pointer is
     expected.  It is this operator that makes an |nsHtml5StreamParserPtr|
     substitutable for a raw pointer. Prefer the implicit use of this operator
     to calling |get()|, except where necessary to resolve ambiguity.
          */
  {
    return get();
  }
  nsHtml5StreamParser* operator->() const MOZ_NO_ADDREF_RELEASE_ON_RETURN {
    MOZ_ASSERT(mRawPtr != 0,
               "You can't dereference a NULL nsHtml5StreamParserPtr with "
               "operator->().");
    return get();
  }
  nsHtml5StreamParserPtr* get_address()
  // This is not intended to be used by clients.  See |address_of|
  // below.
  {
    return this;
  }
  const nsHtml5StreamParserPtr* get_address() const
  // This is not intended to be used by clients.  See |address_of|
  // below.
  {
    return this;
  }

 public:
  nsHtml5StreamParser& operator*() const {
    MOZ_ASSERT(mRawPtr != 0,
               "You can't dereference a NULL nsHtml5StreamParserPtr with "
               "operator*().");
    return *get();
  }
  nsHtml5StreamParser** StartAssignment() {
#ifndef NSCAP_FEATURE_INLINE_STARTASSIGNMENT
    return reinterpret_cast<nsHtml5StreamParser**>(begin_assignment());
#else
    assign_assuming_AddRef(0);
    return reinterpret_cast<nsHtml5StreamParser**>(&mRawPtr);
#endif
  }
};

inline nsHtml5StreamParserPtr* address_of(nsHtml5StreamParserPtr& aPtr) {
  return aPtr.get_address();
}

inline const nsHtml5StreamParserPtr* address_of(
    const nsHtml5StreamParserPtr& aPtr) {
  return aPtr.get_address();
}

class nsHtml5StreamParserPtrGetterAddRefs
/*
      ...
      This class is designed to be used for anonymous temporary objects in the
      argument list of calls that return COM interface pointers, e.g.,
        nsHtml5StreamParserPtr<IFoo> fooP;
        ...->GetAddRefedPointer(getter_AddRefs(fooP))
      DO NOT USE THIS TYPE DIRECTLY IN YOUR CODE.  Use |getter_AddRefs()|
   instead. When initialized with a |nsHtml5StreamParserPtr|, as in the example
   above, it returns a |void**|, a |T**|, or an |nsISupports**| as needed, that
   the outer call (|GetAddRefedPointer| in this case) can fill in. This type
   should be a nested class inside |nsHtml5StreamParserPtr<T>|.
    */
{
 public:
  explicit nsHtml5StreamParserPtrGetterAddRefs(
      nsHtml5StreamParserPtr& aSmartPtr)
      : mTargetSmartPtr(aSmartPtr) {
    // nothing else to do
  }
  operator void**() {
    return reinterpret_cast<void**>(mTargetSmartPtr.StartAssignment());
  }
  operator nsHtml5StreamParser**() { return mTargetSmartPtr.StartAssignment(); }
  nsHtml5StreamParser*& operator*() {
    return *(mTargetSmartPtr.StartAssignment());
  }

 private:
  nsHtml5StreamParserPtr& mTargetSmartPtr;
};

inline nsHtml5StreamParserPtrGetterAddRefs getter_AddRefs(
    nsHtml5StreamParserPtr& aSmartPtr)
/*
      Used around a |nsHtml5StreamParserPtr| when
      ...makes the class |nsHtml5StreamParserPtrGetterAddRefs| invisible.
    */
{
  return nsHtml5StreamParserPtrGetterAddRefs(aSmartPtr);
}

// Comparing an |nsHtml5StreamParserPtr| to |0|

inline bool operator==(const nsHtml5StreamParserPtr& lhs, decltype(nullptr)) {
  return lhs.get() == nullptr;
}

inline bool operator==(decltype(nullptr), const nsHtml5StreamParserPtr& rhs) {
  return nullptr == rhs.get();
}

inline bool operator!=(const nsHtml5StreamParserPtr& lhs, decltype(nullptr)) {
  return lhs.get() != nullptr;
}

inline bool operator!=(decltype(nullptr), const nsHtml5StreamParserPtr& rhs) {
  return nullptr != rhs.get();
}

#endif  // !defined(nsHtml5StreamParserPtr_h)