File: SpiderMonkeyInterface.h

package info (click to toggle)
thunderbird 1:60.8.0-1~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,339,208 kB
  • sloc: cpp: 5,456,704; ansic: 2,360,384; python: 596,095; asm: 340,963; java: 326,291; xml: 258,664; sh: 84,366; makefile: 23,702; perl: 17,317; objc: 3,768; yacc: 1,766; ada: 1,681; lex: 1,364; pascal: 1,264; cs: 879; exp: 527; php: 436; lisp: 258; ruby: 153; awk: 152; sed: 53; csh: 27
file content (125 lines) | stat: -rw-r--r-- 3,995 bytes parent folder | download | duplicates (16)
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
/* -*- 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 MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
      : JS::CustomAutoRooter(cx MOZ_GUARD_OBJECT_NOTIFIER_PARAM_TO_PARENT),
        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
                                                MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
      : JS::CustomAutoRooter(cx MOZ_GUARD_OBJECT_NOTIFIER_PARAM_TO_PARENT),
        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 MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
      : InterfaceType(),
        SpiderMonkeyInterfaceRooter<InterfaceType>(
            cx, this MOZ_GUARD_OBJECT_NOTIFIER_PARAM_TO_PARENT) {}

  template <typename CX>
  RootedSpiderMonkeyInterface(const CX& cx,
                              JSObject* obj MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
      : InterfaceType(obj),
        SpiderMonkeyInterfaceRooter<InterfaceType>(
            cx, this MOZ_GUARD_OBJECT_NOTIFIER_PARAM_TO_PARENT) {}
};

}  // namespace dom
}  // namespace mozilla

#endif /* mozilla_dom_SpiderMonkeyInterface_h */