mirror of
https://github.com/mozilla/gecko-dev.git
synced 2025-02-26 20:30:41 +00:00
e3ebda1914
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
117 lines
3.5 KiB
C++
117 lines
3.5 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/. */
|
|
|
|
#ifndef mozilla_dom_SpiderMonkeyInterface_h
|
|
#define mozilla_dom_SpiderMonkeyInterface_h
|
|
|
|
#include "jsapi.h"
|
|
#include "jsfriendapi.h"
|
|
#include "js/TracingAPI.h"
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
|
|
/*
|
|
* Class that just handles the JSObject storage and tracing for spidermonkey
|
|
* interfaces
|
|
*/
|
|
struct SpiderMonkeyInterfaceObjectStorage {
|
|
protected:
|
|
JSObject* mImplObj;
|
|
JSObject* mWrappedObj;
|
|
|
|
SpiderMonkeyInterfaceObjectStorage()
|
|
: mImplObj(nullptr), mWrappedObj(nullptr) {}
|
|
|
|
SpiderMonkeyInterfaceObjectStorage(
|
|
SpiderMonkeyInterfaceObjectStorage&& aOther)
|
|
: mImplObj(aOther.mImplObj), mWrappedObj(aOther.mWrappedObj) {
|
|
aOther.mImplObj = nullptr;
|
|
aOther.mWrappedObj = nullptr;
|
|
}
|
|
|
|
public:
|
|
inline void TraceSelf(JSTracer* trc) {
|
|
JS::UnsafeTraceRoot(trc, &mImplObj,
|
|
"SpiderMonkeyInterfaceObjectStorage.mImplObj");
|
|
JS::UnsafeTraceRoot(trc, &mWrappedObj,
|
|
"SpiderMonkeyInterfaceObjectStorage.mWrappedObj");
|
|
}
|
|
|
|
inline bool inited() const { return !!mImplObj; }
|
|
|
|
inline bool WrapIntoNewCompartment(JSContext* cx) {
|
|
return JS_WrapObject(
|
|
cx, JS::MutableHandle<JSObject*>::fromMarkedLocation(&mWrappedObj));
|
|
}
|
|
|
|
inline JSObject* Obj() const {
|
|
MOZ_ASSERT(inited());
|
|
return mWrappedObj;
|
|
}
|
|
|
|
private:
|
|
SpiderMonkeyInterfaceObjectStorage(
|
|
const SpiderMonkeyInterfaceObjectStorage&) = delete;
|
|
};
|
|
|
|
// A class for rooting an existing SpiderMonkey Interface struct
|
|
template <typename InterfaceType>
|
|
class MOZ_RAII SpiderMonkeyInterfaceRooter : private JS::CustomAutoRooter {
|
|
public:
|
|
template <typename CX>
|
|
SpiderMonkeyInterfaceRooter(const CX& cx, InterfaceType* aInterface)
|
|
: JS::CustomAutoRooter(cx), mInterface(aInterface) {}
|
|
|
|
virtual void trace(JSTracer* trc) override { mInterface->TraceSelf(trc); }
|
|
|
|
private:
|
|
SpiderMonkeyInterfaceObjectStorage* const mInterface;
|
|
};
|
|
|
|
// And a specialization for dealing with nullable SpiderMonkey interfaces
|
|
template <typename Inner>
|
|
struct Nullable;
|
|
template <typename InterfaceType>
|
|
class MOZ_RAII SpiderMonkeyInterfaceRooter<Nullable<InterfaceType>>
|
|
: private JS::CustomAutoRooter {
|
|
public:
|
|
template <typename CX>
|
|
SpiderMonkeyInterfaceRooter(const CX& cx, Nullable<InterfaceType>* aInterface)
|
|
: JS::CustomAutoRooter(cx), mInterface(aInterface) {}
|
|
|
|
virtual void trace(JSTracer* trc) override {
|
|
if (!mInterface->IsNull()) {
|
|
mInterface->Value().TraceSelf(trc);
|
|
}
|
|
}
|
|
|
|
private:
|
|
Nullable<InterfaceType>* const mInterface;
|
|
};
|
|
|
|
// Class for easily setting up a rooted SpiderMonkey interface object on the
|
|
// stack
|
|
template <typename InterfaceType>
|
|
class MOZ_RAII RootedSpiderMonkeyInterface final
|
|
: public InterfaceType,
|
|
private SpiderMonkeyInterfaceRooter<InterfaceType> {
|
|
public:
|
|
template <typename CX>
|
|
explicit RootedSpiderMonkeyInterface(const CX& cx)
|
|
: InterfaceType(), SpiderMonkeyInterfaceRooter<InterfaceType>(cx, this) {}
|
|
|
|
template <typename CX>
|
|
RootedSpiderMonkeyInterface(const CX& cx, JSObject* obj)
|
|
: InterfaceType(obj),
|
|
SpiderMonkeyInterfaceRooter<InterfaceType>(cx, this) {}
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif /* mozilla_dom_SpiderMonkeyInterface_h */
|