Blame mfbt/tests/TestWeakPtr.cpp

Packit f0b94e
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
Packit f0b94e
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
Packit f0b94e
/* This Source Code Form is subject to the terms of the Mozilla Public
Packit f0b94e
 * License, v. 2.0. If a copy of the MPL was not distributed with this
Packit f0b94e
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
Packit f0b94e
Packit f0b94e
#include "mozilla/WeakPtr.h"
Packit f0b94e
Packit f0b94e
using mozilla::SupportsWeakPtr;
Packit f0b94e
using mozilla::WeakPtr;
Packit f0b94e
Packit f0b94e
// To have a class C support weak pointers, inherit from SupportsWeakPtr<C>.
Packit f0b94e
class C : public SupportsWeakPtr<C>
Packit f0b94e
{
Packit f0b94e
public:
Packit f0b94e
  MOZ_DECLARE_WEAKREFERENCE_TYPENAME(C)
Packit f0b94e
Packit f0b94e
  int mNum;
Packit f0b94e
Packit f0b94e
  C()
Packit f0b94e
    : mNum(0)
Packit f0b94e
  {}
Packit f0b94e
Packit f0b94e
  ~C()
Packit f0b94e
  {
Packit f0b94e
    // Setting mNum in the destructor allows us to test against use-after-free below
Packit f0b94e
    mNum = 0xDEAD;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  void act() {}
Packit f0b94e
Packit f0b94e
  bool isConst() {
Packit f0b94e
    return false;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  bool isConst() const {
Packit f0b94e
    return true;
Packit f0b94e
  }
Packit f0b94e
};
Packit f0b94e
Packit f0b94e
bool isConst(C*)
Packit f0b94e
{
Packit f0b94e
  return false;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
bool isConst(const C*)
Packit f0b94e
{
Packit f0b94e
  return true;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
int
Packit f0b94e
main()
Packit f0b94e
{
Packit f0b94e
  C* c1 = new C;
Packit f0b94e
  MOZ_RELEASE_ASSERT(c1->mNum == 0);
Packit f0b94e
Packit f0b94e
  // Get weak pointers to c1. The first time,
Packit f0b94e
  // a reference-counted WeakReference object is created that
Packit f0b94e
  // can live beyond the lifetime of 'c1'. The WeakReference
Packit f0b94e
  // object will be notified of 'c1's destruction.
Packit f0b94e
  WeakPtr<C> w1 = c1;
Packit f0b94e
  // Test a weak pointer for validity before using it.
Packit f0b94e
  MOZ_RELEASE_ASSERT(w1);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w1 == c1);
Packit f0b94e
  w1->mNum = 1;
Packit f0b94e
  w1->act();
Packit f0b94e
Packit f0b94e
  // Test taking another WeakPtr<C> to c1
Packit f0b94e
  WeakPtr<C> w2 = c1;
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2 == c1);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2 == w1);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2->mNum == 1);
Packit f0b94e
Packit f0b94e
  // Test a WeakPtr<const C>
Packit f0b94e
  WeakPtr<const C> w3const = c1;
Packit f0b94e
  MOZ_RELEASE_ASSERT(w3const);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w3const == c1);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w3const == w1);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w3const == w2);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w3const->mNum == 1);
Packit f0b94e
Packit f0b94e
  // Test const-correctness of operator-> and operator T*
Packit f0b94e
  MOZ_RELEASE_ASSERT(!w1->isConst());
Packit f0b94e
  MOZ_RELEASE_ASSERT(w3const->isConst());
Packit f0b94e
  MOZ_RELEASE_ASSERT(!isConst(w1));
Packit f0b94e
  MOZ_RELEASE_ASSERT(isConst(w3const));
Packit f0b94e
Packit f0b94e
  // Test that when a WeakPtr is destroyed, it does not destroy the object that it points to,
Packit f0b94e
  // and it does not affect other WeakPtrs pointing to the same object (e.g. it does not
Packit f0b94e
  // destroy the WeakReference object).
Packit f0b94e
  {
Packit f0b94e
    WeakPtr<C> w4local = c1;
Packit f0b94e
    MOZ_RELEASE_ASSERT(w4local == c1);
Packit f0b94e
  }
Packit f0b94e
  // Now w4local has gone out of scope. If that had destroyed c1, then the following would fail
Packit f0b94e
  // for sure (see C::~C()).
Packit f0b94e
  MOZ_RELEASE_ASSERT(c1->mNum == 1);
Packit f0b94e
  // Check that w4local going out of scope hasn't affected other WeakPtr's pointing to c1
Packit f0b94e
  MOZ_RELEASE_ASSERT(w1 == c1);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2 == c1);
Packit f0b94e
Packit f0b94e
  // Now construct another C object and test changing what object a WeakPtr points to
Packit f0b94e
  C* c2 = new C;
Packit f0b94e
  c2->mNum = 2;
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2->mNum == 1); // w2 was pointing to c1
Packit f0b94e
  w2 = c2;
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2 == c2);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2 != c1);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2 != w1);
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2->mNum == 2);
Packit f0b94e
Packit f0b94e
  // Destroying the underlying object clears weak pointers to it.
Packit f0b94e
  // It should not affect pointers that are not currently pointing to it.
Packit f0b94e
  delete c1;
Packit f0b94e
  MOZ_RELEASE_ASSERT(!w1, "Deleting an object should clear WeakPtr's to it.");
Packit f0b94e
  MOZ_RELEASE_ASSERT(!w3const, "Deleting an object should clear WeakPtr's to it.");
Packit f0b94e
  MOZ_RELEASE_ASSERT(w2, "Deleting an object should not clear WeakPtr that are not pointing to it.");
Packit f0b94e
Packit f0b94e
  delete c2;
Packit f0b94e
  MOZ_RELEASE_ASSERT(!w2, "Deleting an object should clear WeakPtr's to it.");
Packit f0b94e
}