Rename AtomicString to AtomString
[WebKit-https.git] / Source / WebCore / loader / ThreadableLoader.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #pragma once
32
33 #include "ResourceLoaderOptions.h"
34 #include <wtf/Noncopyable.h>
35 #include <wtf/RefPtr.h>
36 #include <wtf/text/AtomString.h>
37
38 namespace WebCore {
39
40     class ResourceError;
41     class ResourceRequest;
42     class ResourceResponse;
43     class ScriptExecutionContext;
44     class ThreadableLoaderClient;
45
46     enum class ContentSecurityPolicyEnforcement {
47         DoNotEnforce,
48         EnforceChildSrcDirective,
49         EnforceConnectSrcDirective,
50         EnforceScriptSrcDirective,
51     };
52
53     enum class ResponseFilteringPolicy {
54         Enable,
55         Disable,
56     };
57
58     struct ThreadableLoaderOptions : ResourceLoaderOptions {
59         ThreadableLoaderOptions();
60         explicit ThreadableLoaderOptions(FetchOptions&&);
61         ThreadableLoaderOptions(const ResourceLoaderOptions&, ContentSecurityPolicyEnforcement, String&& initiator, ResponseFilteringPolicy);
62         ~ThreadableLoaderOptions();
63
64         ThreadableLoaderOptions isolatedCopy() const;
65
66         ContentSecurityPolicyEnforcement contentSecurityPolicyEnforcement { ContentSecurityPolicyEnforcement::EnforceConnectSrcDirective };
67         String initiator; // This cannot be an AtomString, as isolatedCopy() wouldn't create an object that's safe for passing to another thread.
68         ResponseFilteringPolicy filteringPolicy { ResponseFilteringPolicy::Disable };
69     };
70
71     // Useful for doing loader operations from any thread (not threadsafe,
72     // just able to run on threads other than the main thread).
73     class ThreadableLoader {
74         WTF_MAKE_NONCOPYABLE(ThreadableLoader);
75     public:
76         static void loadResourceSynchronously(ScriptExecutionContext&, ResourceRequest&&, ThreadableLoaderClient&, const ThreadableLoaderOptions&);
77         static RefPtr<ThreadableLoader> create(ScriptExecutionContext&, ThreadableLoaderClient&, ResourceRequest&&, const ThreadableLoaderOptions&, String&& referrer = String());
78
79         virtual void cancel() = 0;
80         void ref() { refThreadableLoader(); }
81         void deref() { derefThreadableLoader(); }
82
83         static void logError(ScriptExecutionContext&, const ResourceError&, const String&);
84
85     protected:
86         ThreadableLoader() = default;
87         virtual ~ThreadableLoader() = default;
88         virtual void refThreadableLoader() = 0;
89         virtual void derefThreadableLoader() = 0;
90     };
91
92 } // namespace WebCore