[LFC][Floats] FloatAvoider does not need to keep a pointer to Layout::Box around.
[WebKit-https.git] / Source / WebCore / inspector / InspectorFrontendAPIDispatcher.h
1 /*
2  * Copyright (C) 2014-2020 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <JavaScriptCore/JSCJSValue.h>
29 #include <wtf/CompletionHandler.h>
30 #include <wtf/Expected.h>
31 #include <wtf/JSONValues.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/WeakPtr.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WebCore {
37
38 class Page;
39
40 class InspectorFrontendAPIDispatcher final : public RefCounted<InspectorFrontendAPIDispatcher> {
41 public:
42     enum class EvaluationError { ExecutionSuspended, ContextDestroyed };
43     using EvaluationResult = Expected<JSC::JSValue, EvaluationError>;
44     using EvaluationResultHandler = CompletionHandler<void(EvaluationResult)>;
45
46     enum class UnsuspendSoon { Yes, No };
47     
48     WEBCORE_EXPORT ~InspectorFrontendAPIDispatcher();
49
50     static Ref<InspectorFrontendAPIDispatcher> create(Page& page)
51     {
52         return adoptRef(*new InspectorFrontendAPIDispatcher(page));
53     }
54
55     WEBCORE_EXPORT void reset();
56     WEBCORE_EXPORT void frontendLoaded();
57
58     // If it's not currently safe to evaluate JavaScript on the frontend page, the
59     // dispatcher will become suspended and dispatch any queued evaluations when unsuspended.
60     WEBCORE_EXPORT void suspend(UnsuspendSoon = UnsuspendSoon::No);
61     WEBCORE_EXPORT void unsuspend();
62     bool isSuspended() const { return m_suspended; }
63
64     EvaluationResult dispatchCommandWithResultSync(const String& command, Vector<Ref<JSON::Value>>&& arguments = { });
65     WEBCORE_EXPORT void dispatchCommandWithResultAsync(const String& command, Vector<Ref<JSON::Value>>&& arguments = { }, EvaluationResultHandler&& handler = { });
66
67     // Used to forward messages from the backend connection to the frontend.
68     WEBCORE_EXPORT void dispatchMessageAsync(const String& message);
69
70     WEBCORE_EXPORT void evaluateExpressionForTesting(const String&);
71     
72     // Convenience method to obtain a JSGlobalObject for the frontend page.
73     // This is used to convert between C++ values and frontend JSC::JSValue objects.
74     WEBCORE_EXPORT JSC::JSGlobalObject* frontendGlobalObject();
75 private:
76     WEBCORE_EXPORT InspectorFrontendAPIDispatcher(Page&);
77
78     void evaluateOrQueueExpression(const String&, EvaluationResultHandler&& handler = { });
79     void evaluateQueuedExpressions();
80     void invalidateQueuedExpressions();
81     JSC::JSValue evaluateExpression(const String&);
82
83     WeakPtr<Page> m_frontendPage;
84     Vector<std::pair<String, EvaluationResultHandler>> m_queuedEvaluations;
85     bool m_frontendLoaded { false };
86     bool m_suspended { false };
87 };
88
89 } // namespace WebCore