DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (87fabdfb0915)

VCS Links

FakeMutableHandle

FakeRooted

MaybeRooted

Macros

Line Code
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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 * vim: set ts=8 sts=4 et sw=4 tw=99:
 * 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 gc_Rooting_h
#define gc_Rooting_h

#include "js/GCVector.h"
#include "js/RootingAPI.h"

class JSAtom;
class JSLinearString;

namespace js {

class PropertyName;
class NativeObject;
class ArrayObject;
class GlobalObject;
class PlainObject;
class ScriptSourceObject;
class SavedFrame;
class Shape;
class ObjectGroup;
class DebuggerArguments;
class DebuggerEnvironment;
class DebuggerFrame;
class DebuggerObject;
class Scope;

// These are internal counterparts to the public types such as HandleObject.

typedef JS::Handle<NativeObject*>           HandleNativeObject;
typedef JS::Handle<Shape*>                  HandleShape;
typedef JS::Handle<ObjectGroup*>            HandleObjectGroup;
typedef JS::Handle<JSAtom*>                 HandleAtom;
typedef JS::Handle<JSLinearString*>         HandleLinearString;
typedef JS::Handle<PropertyName*>           HandlePropertyName;
typedef JS::Handle<ArrayObject*>            HandleArrayObject;
typedef JS::Handle<PlainObject*>            HandlePlainObject;
typedef JS::Handle<SavedFrame*>             HandleSavedFrame;
typedef JS::Handle<ScriptSourceObject*>     HandleScriptSource;
typedef JS::Handle<DebuggerArguments*>      HandleDebuggerArguments;
typedef JS::Handle<DebuggerEnvironment*>    HandleDebuggerEnvironment;
typedef JS::Handle<DebuggerFrame*>          HandleDebuggerFrame;
typedef JS::Handle<DebuggerObject*>         HandleDebuggerObject;
typedef JS::Handle<Scope*>                  HandleScope;

typedef JS::MutableHandle<Shape*>               MutableHandleShape;
typedef JS::MutableHandle<JSAtom*>              MutableHandleAtom;
typedef JS::MutableHandle<NativeObject*>        MutableHandleNativeObject;
typedef JS::MutableHandle<PlainObject*>         MutableHandlePlainObject;
typedef JS::MutableHandle<SavedFrame*>          MutableHandleSavedFrame;
typedef JS::MutableHandle<DebuggerArguments*>   MutableHandleDebuggerArguments;
typedef JS::MutableHandle<DebuggerEnvironment*> MutableHandleDebuggerEnvironment;
typedef JS::MutableHandle<DebuggerFrame*>       MutableHandleDebuggerFrame;
typedef JS::MutableHandle<DebuggerObject*>      MutableHandleDebuggerObject;
typedef JS::MutableHandle<Scope*>               MutableHandleScope;

typedef JS::Rooted<NativeObject*>           RootedNativeObject;
typedef JS::Rooted<Shape*>                  RootedShape;
typedef JS::Rooted<ObjectGroup*>            RootedObjectGroup;
typedef JS::Rooted<JSAtom*>                 RootedAtom;
typedef JS::Rooted<JSLinearString*>         RootedLinearString;
typedef JS::Rooted<PropertyName*>           RootedPropertyName;
typedef JS::Rooted<ArrayObject*>            RootedArrayObject;
typedef JS::Rooted<GlobalObject*>           RootedGlobalObject;
typedef JS::Rooted<PlainObject*>            RootedPlainObject;
typedef JS::Rooted<SavedFrame*>             RootedSavedFrame;
typedef JS::Rooted<ScriptSourceObject*>     RootedScriptSource;
typedef JS::Rooted<DebuggerArguments*>      RootedDebuggerArguments;
typedef JS::Rooted<DebuggerEnvironment*>    RootedDebuggerEnvironment;
typedef JS::Rooted<DebuggerFrame*>          RootedDebuggerFrame;
typedef JS::Rooted<DebuggerObject*>         RootedDebuggerObject;
typedef JS::Rooted<Scope*>                  RootedScope;

typedef JS::GCVector<JSFunction*>   FunctionVector;
typedef JS::GCVector<PropertyName*> PropertyNameVector;
typedef JS::GCVector<Shape*>        ShapeVector;
typedef JS::GCVector<JSString*>     StringVector;

/** Interface substitute for Rooted<T> which does not root the variable's memory. */
template <typename T>
class MOZ_RAII FakeRooted : public RootedBase<T, FakeRooted<T>>
{
  public:
    using ElementType = T;

    template <typename CX>
    explicit FakeRooted(CX* cx) : ptr(JS::GCPolicy<T>::initial()) {}

    template <typename CX>
    FakeRooted(CX* cx, T initial) : ptr(initial) {}

    DECLARE_POINTER_CONSTREF_OPS(T);
    DECLARE_POINTER_ASSIGN_OPS(FakeRooted, T);
    DECLARE_NONPOINTER_ACCESSOR_METHODS(ptr);
    DECLARE_NONPOINTER_MUTABLE_ACCESSOR_METHODS(ptr);

  private:
    T ptr;

    void set(const T& value) {
        ptr = value;
    }

    FakeRooted(const FakeRooted&) = delete;
};

/** Interface substitute for MutableHandle<T> which is not required to point to rooted memory. */
template <typename T>
class FakeMutableHandle : public js::MutableHandleBase<T, FakeMutableHandle<T>>
{
  public:
    using ElementType = T;

    MOZ_IMPLICIT FakeMutableHandle(T* t) {
        ptr = t;
    }

    MOZ_IMPLICIT FakeMutableHandle(FakeRooted<T>* root) {
        ptr = root->address();
    }

    void set(const T& v) {
        *ptr = v;
    }

    DECLARE_POINTER_CONSTREF_OPS(T);
    DECLARE_NONPOINTER_ACCESSOR_METHODS(*ptr);
    DECLARE_NONPOINTER_MUTABLE_ACCESSOR_METHODS(*ptr);

  private:
    FakeMutableHandle() {}
    DELETE_ASSIGNMENT_OPS(FakeMutableHandle, T);

    T* ptr;
};

template <typename T> class MaybeRooted<T, NoGC>
{
  public:
    typedef const T& HandleType;
    typedef FakeRooted<T> RootType;
    typedef FakeMutableHandle<T> MutableHandleType;

    static JS::Handle<T> toHandle(HandleType v) {
        MOZ_CRASH("Bad conversion");
    }

    static JS::MutableHandle<T> toMutableHandle(MutableHandleType v) {
        MOZ_CRASH("Bad conversion");
    }

    template <typename T2>
    static inline T2* downcastHandle(HandleType v) {
        return &v->template as<T2>();
    }
};

} /* namespace js */

#endif /* gc_Rooting_h */