blob: 6b53493c75a2e777794da1dedf5021a4b3db71a6 [file] [log] [blame]
/*
* Copyright (C) 2007-2021 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Apple Inc. ("Apple") nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "ContextMenu.h"
#include "ContextMenuProvider.h"
#include "ExceptionOr.h"
#include "InspectorFrontendClient.h"
#include <wtf/RefCounted.h>
#include <wtf/Vector.h>
#include <wtf/text/WTFString.h>
namespace WebCore {
class CanvasPath;
class CanvasRenderingContext2D;
class DOMWrapperWorld;
class DeferredPromise;
class Event;
class File;
class FrontendMenuProvider;
class HTMLIFrameElement;
class Page;
class Path2D;
class InspectorFrontendHost : public RefCounted<InspectorFrontendHost> {
public:
static Ref<InspectorFrontendHost> create(InspectorFrontendClient* client, Page* frontendPage)
{
return adoptRef(*new InspectorFrontendHost(client, frontendPage));
}
WEBCORE_EXPORT ~InspectorFrontendHost();
WEBCORE_EXPORT void disconnectClient();
WEBCORE_EXPORT void addSelfToGlobalObjectInWorld(DOMWrapperWorld&);
void loaded();
void closeWindow();
void reopen();
void reset();
void bringToFront();
void inspectedURLChanged(const String&);
bool supportsShowCertificate() const;
bool showCertificate(const String& serializedCertificate);
void setZoomFactor(float);
float zoomFactor();
void setForcedAppearance(String);
String userInterfaceLayoutDirection();
bool supportsDockSide(const String&);
void requestSetDockSide(const String&);
void setAttachedWindowHeight(unsigned);
void setAttachedWindowWidth(unsigned);
void setSheetRect(float x, float y, unsigned width, unsigned height);
void startWindowDrag();
void moveWindowBy(float x, float y) const;
bool isRemote() const;
String localizedStringsURL() const;
String backendCommandsURL() const;
unsigned inspectionLevel() const;
String platform() const;
String platformVersionName() const;
struct DebuggableInfo {
String debuggableType;
String targetPlatformName;
String targetBuildVersion;
String targetProductVersion;
bool targetIsSimulator;
};
DebuggableInfo debuggableInfo() const;
void copyText(const String& text);
void killText(const String& text, bool shouldPrependToKillRing, bool shouldStartNewSequence);
void openURLExternally(const String& url);
void revealFileExternally(const String& path);
using SaveMode = InspectorFrontendClient::SaveMode;
using SaveData = InspectorFrontendClient::SaveData;
bool canSave(SaveMode);
void save(Vector<SaveData>&&, bool forceSaveAs);
bool canLoad();
void load(const String& path, Ref<DeferredPromise>&&);
bool canPickColorFromScreen();
void pickColorFromScreen(Ref<DeferredPromise>&&);
struct ContextMenuItem {
String type;
String label;
std::optional<int> id;
std::optional<bool> enabled;
std::optional<bool> checked;
std::optional<Vector<ContextMenuItem>> subItems;
};
void showContextMenu(Event&, Vector<ContextMenuItem>&&);
void sendMessageToBackend(const String& message);
void dispatchEventAsContextMenuEvent(Event&);
bool isUnderTest();
void unbufferedLog(const String& message);
void beep();
void inspectInspector();
bool isBeingInspected();
void setAllowsInspectingInspector(bool);
bool supportsDiagnosticLogging();
#if ENABLE(INSPECTOR_TELEMETRY)
bool diagnosticLoggingAvailable();
void logDiagnosticEvent(const String& eventName, const String& payload);
#endif
bool supportsWebExtensions();
#if ENABLE(INSPECTOR_EXTENSIONS)
void didShowExtensionTab(const String& extensionID, const String& extensionTabID, HTMLIFrameElement& extensionFrame);
void didHideExtensionTab(const String& extensionID, const String& extensionTabID);
void didNavigateExtensionTab(const String& extensionID, const String& extensionTabID, const String& url);
void inspectedPageDidNavigate(const String& url);
ExceptionOr<JSC::JSValue> evaluateScriptInExtensionTab(HTMLIFrameElement& extensionFrame, const String& scriptSource);
#endif
// IDL extensions.
String getPath(const File&) const;
float getCurrentX(const CanvasRenderingContext2D&) const;
float getCurrentY(const CanvasRenderingContext2D&) const;
Ref<Path2D> getPath(const CanvasRenderingContext2D&) const;
void setPath(CanvasRenderingContext2D&, Path2D&) const;
private:
#if ENABLE(CONTEXT_MENUS)
friend class FrontendMenuProvider;
#endif
WEBCORE_EXPORT InspectorFrontendHost(InspectorFrontendClient*, Page* frontendPage);
InspectorFrontendClient* m_client;
Page* m_frontendPage;
#if ENABLE(CONTEXT_MENUS)
FrontendMenuProvider* m_menuProvider;
#endif
};
} // namespace WebCore