gecko-dev/mfbt/ReentrancyGuard.h
Nathan Froyd e3ebda1914 Bug 1223932 - delete guard object uses from the tree; r=jwalden
CLOSED TREE

We don't need these macros anymore, for two reasons:

1. We have static analysis to provide the same sort of checks via `MOZ_RAII`
   and friends.
2. clang now warns for the "temporary that should have been a declaration" case.

The extra requirements on class construction also show up during debug tests
as performance problems.

This change was automated by using the following sed script:

```
# Remove declarations in classes.
/MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER/d
/MOZ_GUARD_OBJECT_NOTIFIER_INIT/d

# Remove individual macros, carefully.
{
  # We don't have to worry about substrings here because the closing
  # parenthesis "anchors" the match.
  s/MOZ_GUARD_OBJECT_NOTIFIER_PARAM)/)/g;
  s/MOZ_GUARD_OBJECT_NOTIFIER_PARAM_TO_PARENT)/)/g;
  s/MOZ_GUARD_OBJECT_NOTIFIER_PARAM_IN_IMPL)/)/g;
  s/MOZ_GUARD_OBJECT_NOTIFIER_ONLY_PARAM_IN_IMPL)/)/g;

  # Remove the longer identifier first.
  s/MOZ_GUARD_OBJECT_NOTIFIER_ONLY_PARAM_TO_PARENT//g;
  s/MOZ_GUARD_OBJECT_NOTIFIER_ONLY_PARAM//g;
}

# Remove the actual include.
\@# *include "mozilla/GuardObjects.h"@d
```

and running:

```
find . -name \*.cpp -o -name \*.h | grep -v 'GuardObjects.h' |xargs sed -i -f script 2>/dev/null
mach clang-format
```

Differential Revision: https://phabricator.services.mozilla.com/D85168
2020-07-30 14:22:38 +00:00

51 lines
1.2 KiB
C++

/* -*- 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"
namespace mozilla {
/* Useful for implementing containers that assert non-reentrancy */
class MOZ_RAII ReentrancyGuard {
#ifdef DEBUG
bool& mEntered;
#endif
public:
template <class T>
#ifdef DEBUG
explicit ReentrancyGuard(T& aObj)
: mEntered(aObj.mEntered)
#else
explicit ReentrancyGuard(T&)
#endif
{
#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 */