[iOS] Replace "node assistance" terminology in WebKit with "focused element"
[WebKit-https.git] / Source / WebKit / UIProcess / WebURLSchemeTask.h
1 /*
2  * Copyright (C) 2017 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 <WebCore/ResourceRequest.h>
29 #include <WebCore/ResourceResponse.h>
30 #include <WebCore/SharedBuffer.h>
31 #include <wtf/CompletionHandler.h>
32 #include <wtf/InstanceCounted.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/RefPtr.h>
35
36 namespace IPC {
37 class DataReference;
38 }
39
40 namespace WebCore {
41 class ResourceError;
42 class ResourceResponse;
43 class SharedBuffer;
44 }
45
46 namespace WebKit {
47
48 class WebURLSchemeHandler;
49 class WebPageProxy;
50
51 using SyncLoadCompletionHandler = CompletionHandler<void(const WebCore::ResourceResponse&, const WebCore::ResourceError&, const IPC::DataReference&)>;
52
53 class WebURLSchemeTask : public RefCounted<WebURLSchemeTask>, public InstanceCounted<WebURLSchemeTask> {
54     WTF_MAKE_NONCOPYABLE(WebURLSchemeTask);
55 public:
56     static Ref<WebURLSchemeTask> create(WebURLSchemeHandler&, WebPageProxy&, uint64_t identifier, WebCore::ResourceRequest&&, SyncLoadCompletionHandler&&);
57
58     uint64_t identifier() const { return m_identifier; }
59     uint64_t pageID() const { return m_pageIdentifier; }
60
61     const WebCore::ResourceRequest& request() const { return m_request; }
62
63     enum class ExceptionType {
64         DataAlreadySent,
65         CompleteAlreadyCalled,
66         RedirectAfterResponse,
67         TaskAlreadyStopped,
68         NoResponseSent,
69         None,
70     };
71     ExceptionType didPerformRedirection(WebCore::ResourceResponse&&, WebCore::ResourceRequest&&);
72     ExceptionType didReceiveResponse(const WebCore::ResourceResponse&);
73     ExceptionType didReceiveData(Ref<WebCore::SharedBuffer>&&);
74     ExceptionType didComplete(const WebCore::ResourceError&);
75
76     void stop();
77     void pageDestroyed();
78
79 private:
80     WebURLSchemeTask(WebURLSchemeHandler&, WebPageProxy&, uint64_t identifier, WebCore::ResourceRequest&&, SyncLoadCompletionHandler&&);
81
82     bool isSync() const { return !!m_syncCompletionHandler; }
83
84     Ref<WebURLSchemeHandler> m_urlSchemeHandler;
85     WebPageProxy* m_page;
86     uint64_t m_identifier;
87     uint64_t m_pageIdentifier;
88     WebCore::ResourceRequest m_request;
89     bool m_stopped { false };
90     bool m_responseSent { false };
91     bool m_dataSent { false };
92     bool m_completed { false };
93     
94     SyncLoadCompletionHandler m_syncCompletionHandler;
95     WebCore::ResourceResponse m_syncResponse;
96     RefPtr<WebCore::SharedBuffer> m_syncData;
97 };
98
99 } // namespace WebKit