зеркало из https://github.com/mozilla/gecko-dev.git
324 строки
11 KiB
C++
324 строки
11 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_Console_h
|
|
#define mozilla_dom_Console_h
|
|
|
|
#include "mozilla/dom/BindingDeclarations.h"
|
|
#include "mozilla/ErrorResult.h"
|
|
#include "mozilla/JSObjectHolder.h"
|
|
#include "nsCycleCollectionParticipant.h"
|
|
#include "nsDataHashtable.h"
|
|
#include "nsHashKeys.h"
|
|
#include "nsIObserver.h"
|
|
#include "nsWeakReference.h"
|
|
#include "nsWrapperCache.h"
|
|
#include "nsDOMNavigationTiming.h"
|
|
#include "nsPIDOMWindow.h"
|
|
|
|
class nsIConsoleAPIStorage;
|
|
class nsIPrincipal;
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
|
|
class ConsoleCallData;
|
|
class ConsoleRunnable;
|
|
class ConsoleCallDataRunnable;
|
|
class ConsoleProfileRunnable;
|
|
struct ConsoleStackEntry;
|
|
|
|
class Console final : public nsIObserver
|
|
, public nsWrapperCache
|
|
, public nsSupportsWeakReference
|
|
{
|
|
~Console();
|
|
|
|
public:
|
|
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
|
|
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_AMBIGUOUS(Console, nsIObserver)
|
|
NS_DECL_NSIOBSERVER
|
|
|
|
explicit Console(nsPIDOMWindowInner* aWindow);
|
|
|
|
// WebIDL methods
|
|
nsPIDOMWindowInner* GetParentObject() const
|
|
{
|
|
return mWindow;
|
|
}
|
|
|
|
virtual JSObject*
|
|
WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
void
|
|
Log(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Info(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Warn(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Error(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Exception(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Debug(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Table(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Trace(JSContext* aCx);
|
|
|
|
void
|
|
Dir(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Dirxml(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Group(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
GroupCollapsed(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
GroupEnd(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Time(JSContext* aCx, const JS::Handle<JS::Value> aTime);
|
|
|
|
void
|
|
TimeEnd(JSContext* aCx, const JS::Handle<JS::Value> aTime);
|
|
|
|
void
|
|
TimeStamp(JSContext* aCx, const JS::Handle<JS::Value> aData);
|
|
|
|
void
|
|
Profile(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
ProfileEnd(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Assert(JSContext* aCx, bool aCondition, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
Count(JSContext* aCx, const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
NoopMethod();
|
|
|
|
private:
|
|
enum MethodName
|
|
{
|
|
MethodLog,
|
|
MethodInfo,
|
|
MethodWarn,
|
|
MethodError,
|
|
MethodException,
|
|
MethodDebug,
|
|
MethodTable,
|
|
MethodTrace,
|
|
MethodDir,
|
|
MethodDirxml,
|
|
MethodGroup,
|
|
MethodGroupCollapsed,
|
|
MethodGroupEnd,
|
|
MethodTime,
|
|
MethodTimeEnd,
|
|
MethodTimeStamp,
|
|
MethodAssert,
|
|
MethodCount
|
|
};
|
|
|
|
void
|
|
Method(JSContext* aCx, MethodName aName, const nsAString& aString,
|
|
const Sequence<JS::Value>& aData);
|
|
|
|
void
|
|
ProcessCallData(ConsoleCallData* aData,
|
|
JS::Handle<JSObject*> aGlobal,
|
|
const Sequence<JS::Value>& aArguments);
|
|
|
|
// If the first JS::Value of the array is a string, this method uses it to
|
|
// format a string. The supported sequences are:
|
|
// %s - string
|
|
// %d,%i - integer
|
|
// %f - double
|
|
// %o,%O - a JS object.
|
|
// %c - style string.
|
|
// The output is an array where any object is a separated item, the rest is
|
|
// unified in a format string.
|
|
// Example if the input is:
|
|
// "string: %s, integer: %d, object: %o, double: %d", 's', 1, window, 0.9
|
|
// The output will be:
|
|
// [ "string: s, integer: 1, object: ", window, ", double: 0.9" ]
|
|
//
|
|
// The aStyles array is populated with the style strings that the function
|
|
// finds based the format string. The index of the styles matches the indexes
|
|
// of elements that need the custom styling from aSequence. For elements with
|
|
// no custom styling the array is padded with null elements.
|
|
bool
|
|
ProcessArguments(JSContext* aCx, const Sequence<JS::Value>& aData,
|
|
Sequence<JS::Value>& aSequence,
|
|
Sequence<nsString>& aStyles) const;
|
|
|
|
void
|
|
MakeFormatString(nsCString& aFormat, int32_t aInteger, int32_t aMantissa,
|
|
char aCh) const;
|
|
|
|
// Stringify and Concat all the JS::Value in a single string using ' ' as
|
|
// separator.
|
|
void
|
|
ComposeGroupName(JSContext* aCx, const Sequence<JS::Value>& aData,
|
|
nsAString& aName) const;
|
|
|
|
// StartTimer is called on the owning thread and populates aTimerLabel and
|
|
// aTimerValue. It returns false if a JS exception is thrown or if
|
|
// the max number of timers is reached.
|
|
// * aCx - the JSContext rooting aName.
|
|
// * aName - this is (should be) the name of the timer as JS::Value.
|
|
// * aTimestamp - the monotonicTimer for this context (taken from
|
|
// window->performance.now() or from Now() -
|
|
// workerPrivate->NowBaseTimeStamp() in workers.
|
|
// * aTimerLabel - This label will be populated with the aName converted to a
|
|
// string.
|
|
// * aTimerValue - the StartTimer value stored into (or taken from)
|
|
// mTimerRegistry.
|
|
bool
|
|
StartTimer(JSContext* aCx, const JS::Value& aName,
|
|
DOMHighResTimeStamp aTimestamp,
|
|
nsAString& aTimerLabel,
|
|
DOMHighResTimeStamp* aTimerValue);
|
|
|
|
// CreateStartTimerValue is called on the main thread only and generates a
|
|
// ConsoleTimerStart dictionary exposed as JS::Value. If aTimerStatus is
|
|
// false, it generates a ConsoleTimerError instead. It's called only after
|
|
// the execution StartTimer on the owning thread.
|
|
// * aCx - this is the context that will root the returned value.
|
|
// * aTimerLabel - this label must be what StartTimer received as aTimerLabel.
|
|
// * aTimerValue - this is what StartTimer received as aTimerValue
|
|
// * aTimerStatus - the return value of StartTimer.
|
|
JS::Value
|
|
CreateStartTimerValue(JSContext* aCx, const nsAString& aTimerLabel,
|
|
DOMHighResTimeStamp aTimerValue,
|
|
bool aTimerStatus) const;
|
|
|
|
// StopTimer follows the same pattern as StartTimer: it runs on the
|
|
// owning thread and populates aTimerLabel and aTimerDuration, used by
|
|
// CreateStopTimerValue on the main thread. It returns false if a JS
|
|
// exception is thrown or if the aName timer doesn't exist in mTimerRegistry.
|
|
// * aCx - the JSContext rooting aName.
|
|
// * aName - this is (should be) the name of the timer as JS::Value.
|
|
// * aTimestamp - the monotonicTimer for this context (taken from
|
|
// window->performance.now() or from Now() -
|
|
// workerPrivate->NowBaseTimeStamp() in workers.
|
|
// * aTimerLabel - This label will be populated with the aName converted to a
|
|
// string.
|
|
// * aTimerDuration - the difference between aTimestamp and when the timer
|
|
// started (see StartTimer).
|
|
bool
|
|
StopTimer(JSContext* aCx, const JS::Value& aName,
|
|
DOMHighResTimeStamp aTimestamp,
|
|
nsAString& aTimerLabel,
|
|
double* aTimerDuration);
|
|
|
|
// Executed on the main thread and generates a ConsoleTimerEnd dictionary
|
|
// exposed as JS::Value, or a ConsoleTimerError dictionary if aTimerStatus is
|
|
// false. See StopTimer.
|
|
// * aCx - this is the context that will root the returned value.
|
|
// * aTimerLabel - this label must be what StopTimer received as aTimerLabel.
|
|
// * aTimerDuration - this is what StopTimer received as aTimerDuration
|
|
// * aTimerStatus - the return value of StopTimer.
|
|
JS::Value
|
|
CreateStopTimerValue(JSContext* aCx, const nsAString& aTimerLabel,
|
|
double aTimerDuration,
|
|
bool aTimerStatus) const;
|
|
|
|
// The method populates a Sequence from an array of JS::Value.
|
|
bool
|
|
ArgumentsToValueList(const Sequence<JS::Value>& aData,
|
|
Sequence<JS::Value>& aSequence) const;
|
|
|
|
void
|
|
ProfileMethod(JSContext* aCx, const nsAString& aAction,
|
|
const Sequence<JS::Value>& aData);
|
|
|
|
// This method follows the same pattern as StartTimer: its runs on the owning
|
|
// thread and populates aCountLabel, used by CreateCounterValue on the
|
|
// main thread. Returns MAX_PAGE_COUNTERS in case of error otherwise the
|
|
// incremented counter value.
|
|
// * aCx - the JSContext rooting aData.
|
|
// * aFrame - the first frame of ConsoleCallData.
|
|
// * aData - the arguments received by the console.count() method.
|
|
// * aCountLabel - the label that will be populated by this method.
|
|
uint32_t
|
|
IncreaseCounter(JSContext* aCx, const ConsoleStackEntry& aFrame,
|
|
const Sequence<JS::Value>& aData,
|
|
nsAString& aCountLabel);
|
|
|
|
// Executed on the main thread and generates a ConsoleCounter dictionary as
|
|
// JS::Value. If aCountValue is == MAX_PAGE_COUNTERS it generates a
|
|
// ConsoleCounterError instead. See IncreaseCounter.
|
|
// * aCx - this is the context that will root the returned value.
|
|
// * aCountLabel - this label must be what IncreaseCounter received as
|
|
// aTimerLabel.
|
|
// * aCountValue - the return value of IncreaseCounter.
|
|
JS::Value
|
|
CreateCounterValue(JSContext* aCx, const nsAString& aCountLabel,
|
|
uint32_t aCountValue) const;
|
|
|
|
bool
|
|
ShouldIncludeStackTrace(MethodName aMethodName) const;
|
|
|
|
JSObject*
|
|
GetOrCreateSandbox(JSContext* aCx, nsIPrincipal* aPrincipal);
|
|
|
|
void
|
|
RegisterConsoleCallData(ConsoleCallData* aData);
|
|
|
|
void
|
|
UnregisterConsoleCallData(ConsoleCallData* aData);
|
|
|
|
void
|
|
AssertIsOnOwningThread() const;
|
|
|
|
// All these nsCOMPtr are touched on main thread only.
|
|
nsCOMPtr<nsPIDOMWindowInner> mWindow;
|
|
nsCOMPtr<nsIConsoleAPIStorage> mStorage;
|
|
RefPtr<JSObjectHolder> mSandbox;
|
|
|
|
// Touched on the owner thread.
|
|
nsDataHashtable<nsStringHashKey, DOMHighResTimeStamp> mTimerRegistry;
|
|
nsDataHashtable<nsStringHashKey, uint32_t> mCounterRegistry;
|
|
|
|
// Raw pointers because ConsoleCallData manages its own
|
|
// registration/unregistration.
|
|
nsTArray<ConsoleCallData*> mConsoleCallDataArray;
|
|
|
|
#ifdef DEBUG
|
|
PRThread* mOwningThread;
|
|
#endif
|
|
|
|
uint64_t mOuterID;
|
|
uint64_t mInnerID;
|
|
|
|
friend class ConsoleCallData;
|
|
friend class ConsoleRunnable;
|
|
friend class ConsoleCallDataRunnable;
|
|
friend class ConsoleProfileRunnable;
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif /* mozilla_dom_Console_h */
|