public/V8InspectorClient.h

// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef V8InspectorClient_h
#define V8InspectorClient_h

#include "platform/inspector_protocol/InspectorProtocol.h"

#include <v8.h>

namespace v8_inspector {

class V8StackTrace;

enum class V8ConsoleAPIType { kClear, kDebug, kLog, kInfo, kWarning, kError };

class PLATFORM_EXPORT V8InspectorClient {
public:
    virtual ~V8InspectorClient() { }

    virtual void runMessageLoopOnPause(int contextGroupId) { }
    virtual void quitMessageLoopOnPause() { }
    virtual void runIfWaitingForDebugger(int contextGroupId) { }

    virtual void muteMetrics(int contextGroupId) { }
    virtual void unmuteMetrics(int contextGroupId) { }

    virtual void beginUserGesture() { }
    virtual void endUserGesture() { }

    virtual String16 valueSubtype(v8::Local<v8::Value>) { return String16(); }
    virtual bool formatAccessorsAsProperties(v8::Local<v8::Value>) { return false; }
    virtual bool isInspectableHeapObject(v8::Local<v8::Object>) { return true; }

    virtual v8::Local<v8::Context> ensureDefaultContextInGroup(int contextGroupId) { return v8::Local<v8::Context>(); }
    virtual void beginEnsureAllContextsInGroup(int contextGroupId) { }
    virtual void endEnsureAllContextsInGroup(int contextGroupId) { }

    virtual void installAdditionalCommandLineAPI(v8::Local<v8::Context>, v8::Local<v8::Object>) { }
    virtual void consoleAPIMessage(int contextGroupId, V8ConsoleAPIType, const String16& message, const String16& url, unsigned lineNumber, unsigned columnNumber, V8StackTrace*) { }
    virtual v8::MaybeLocal<v8::Value> memoryInfo(v8::Isolate*, v8::Local<v8::Context>) { return v8::MaybeLocal<v8::Value>(); }

    virtual void consoleTime(const String16& title) { }
    virtual void consoleTimeEnd(const String16& title) { }
    virtual void consoleTimeStamp(const String16& title) { }
    virtual double currentTimeMS() { return 0; }
    typedef void (*TimerCallback)(void*);
    virtual void startRepeatingTimer(double, TimerCallback, void* data) { }
    virtual void cancelTimer(void* data) { }

    // TODO(dgozman): this was added to support service worker shadow page. We should not connect at all.
    virtual bool canExecuteScripts(int contextGroupId) { return true; }
};

} // namespace v8_inspector


#endif // V8InspectorClient_h