mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 06:35:42 +00:00
116 lines
3.5 KiB
C++
116 lines
3.5 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
// vim: ft=cpp tw=78 sw=2 et ts=2
|
|
/* 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/. */
|
|
|
|
/* Utilities for managing the script settings object stack defined in webapps */
|
|
|
|
#ifndef mozilla_dom_ScriptSettings_h
|
|
#define mozilla_dom_ScriptSettings_h
|
|
|
|
#include "nsCxPusher.h"
|
|
#include "MainThreadUtils.h"
|
|
#include "nsIGlobalObject.h"
|
|
|
|
#include "mozilla/Maybe.h"
|
|
|
|
class nsIGlobalObject;
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
|
|
/*
|
|
* System-wide setup/teardown routines. Init and Destroy should be invoked
|
|
* once each, at startup and shutdown (respectively).
|
|
*/
|
|
void InitScriptSettings();
|
|
void DestroyScriptSettings();
|
|
|
|
// Note: We don't yet expose GetEntryGlobal, because in order for it to be
|
|
// correct, we first need to replace a bunch of explicit cx pushing in the
|
|
// browser with AutoEntryScript. But GetIncumbentGlobal is simpler, because it
|
|
// can mostly be inferred from the JS stack.
|
|
nsIGlobalObject* GetIncumbentGlobal();
|
|
|
|
class ScriptSettingsStack;
|
|
struct ScriptSettingsStackEntry {
|
|
nsCOMPtr<nsIGlobalObject> mGlobalObject;
|
|
bool mIsCandidateEntryPoint;
|
|
|
|
ScriptSettingsStackEntry(nsIGlobalObject *aGlobal, bool aCandidate)
|
|
: mGlobalObject(aGlobal)
|
|
, mIsCandidateEntryPoint(aCandidate)
|
|
{
|
|
MOZ_ASSERT(mGlobalObject);
|
|
MOZ_ASSERT(mGlobalObject->GetGlobalJSObject(),
|
|
"Must have an actual JS global for the duration on the stack");
|
|
MOZ_ASSERT(JS_IsGlobalObject(mGlobalObject->GetGlobalJSObject()),
|
|
"No outer windows allowed");
|
|
}
|
|
|
|
~ScriptSettingsStackEntry() {
|
|
// We must have an actual JS global for the entire time this is on the stack.
|
|
MOZ_ASSERT_IF(mGlobalObject, mGlobalObject->GetGlobalJSObject());
|
|
}
|
|
|
|
bool IsSystemSingleton() { return this == &SystemSingleton; }
|
|
static ScriptSettingsStackEntry SystemSingleton;
|
|
|
|
private:
|
|
ScriptSettingsStackEntry() : mGlobalObject(nullptr)
|
|
, mIsCandidateEntryPoint(true)
|
|
{}
|
|
};
|
|
|
|
/*
|
|
* A class that represents a new script entry point.
|
|
*/
|
|
class AutoEntryScript {
|
|
public:
|
|
AutoEntryScript(nsIGlobalObject* aGlobalObject,
|
|
bool aIsMainThread = NS_IsMainThread(),
|
|
// Note: aCx is mandatory off-main-thread.
|
|
JSContext* aCx = nullptr);
|
|
~AutoEntryScript();
|
|
|
|
private:
|
|
dom::ScriptSettingsStack& mStack;
|
|
dom::ScriptSettingsStackEntry mEntry;
|
|
nsCxPusher mCxPusher;
|
|
mozilla::Maybe<JSAutoCompartment> mAc; // This can de-Maybe-fy when mCxPusher
|
|
// goes away.
|
|
};
|
|
|
|
/*
|
|
* A class that can be used to force a particular incumbent script on the stack.
|
|
*/
|
|
class AutoIncumbentScript {
|
|
public:
|
|
AutoIncumbentScript(nsIGlobalObject* aGlobalObject);
|
|
~AutoIncumbentScript();
|
|
private:
|
|
dom::ScriptSettingsStack& mStack;
|
|
dom::ScriptSettingsStackEntry mEntry;
|
|
JS::AutoHideScriptedCaller mCallerOverride;
|
|
};
|
|
|
|
/*
|
|
* A class used for C++ to indicate that existing entry and incumbent scripts
|
|
* should not apply to anything in scope, and that callees should act as if
|
|
* they were invoked "from C++".
|
|
*/
|
|
class AutoSystemCaller {
|
|
public:
|
|
AutoSystemCaller(bool aIsMainThread = NS_IsMainThread());
|
|
~AutoSystemCaller();
|
|
private:
|
|
dom::ScriptSettingsStack& mStack;
|
|
nsCxPusher mCxPusher;
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_dom_ScriptSettings_h
|