mfbt/ReentrancyGuard.h
author Ed Lee <edilee@mozilla.com>
Wed, 06 Jun 2018 10:32:43 -0700
changeset 421752 09a74b229025e9cd883bf6e6b4dd1ed7998e7050
parent 262213 31a26ed444843f086c468a98236e8c98b7115b44
child 448947 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
Bug 1440421 part 1. Ignore activity-stream and node_modules for linting. r=ahal MozReview-Commit-ID: EEua2y790cW

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */

/* Small helper class for asserting uses of a class are non-reentrant. */

#ifndef mozilla_ReentrancyGuard_h
#define mozilla_ReentrancyGuard_h

#include "mozilla/Assertions.h"
#include "mozilla/Attributes.h"
#include "mozilla/GuardObjects.h"

namespace mozilla {

/* Useful for implementing containers that assert non-reentrancy */
class MOZ_RAII ReentrancyGuard
{
  MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
#ifdef DEBUG
  bool& mEntered;
#endif

public:
  template<class T>
#ifdef DEBUG
  explicit ReentrancyGuard(T& aObj
                           MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
    : mEntered(aObj.mEntered)
#else
  explicit ReentrancyGuard(T&
                           MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
#endif
  {
    MOZ_GUARD_OBJECT_NOTIFIER_INIT;
#ifdef DEBUG
    MOZ_ASSERT(!mEntered);
    mEntered = true;
#endif
  }
  ~ReentrancyGuard()
  {
#ifdef DEBUG
    mEntered = false;
#endif
  }

private:
  ReentrancyGuard(const ReentrancyGuard&) = delete;
  void operator=(const ReentrancyGuard&) = delete;
};

} // namespace mozilla

#endif /* mozilla_ReentrancyGuard_h */