Modernize how many platform/network classes do isolatedCopy().
[WebKit-https.git] / Source / WebCore / platform / network / ResourceErrorBase.h
1 /*
2  * Copyright (C) 2006 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "URL.h"
29 #include <wtf/text/WTFString.h>
30
31 namespace WebCore {
32
33 class ResourceError;
34
35 extern const char* const errorDomainWebKitInternal; // Used for errors that won't be exposed to clients.
36
37 class ResourceErrorBase {
38 public:
39     ResourceError isolatedCopy() const;
40
41     bool isNull() const { return m_isNull; }
42
43     const String& domain() const { lazyInit(); return m_domain; }
44     int errorCode() const { lazyInit(); return m_errorCode; }
45     const URL& failingURL() const { lazyInit(); return m_failingURL; }
46     const String& localizedDescription() const { lazyInit(); return m_localizedDescription; }
47
48     void setIsCancellation(bool isCancellation) { m_isCancellation = isCancellation; }
49     bool isCancellation() const { return m_isCancellation; }
50
51     void setIsTimeout(bool isTimeout) { m_isTimeout = isTimeout; }
52     bool isTimeout() const { return m_isTimeout; }
53
54     static bool compare(const ResourceError&, const ResourceError&);
55
56 protected:
57     ResourceErrorBase()
58         : m_errorCode(0)
59         , m_isNull(true)
60         , m_isCancellation(false)
61         , m_isTimeout(false)
62     {
63     }
64
65     ResourceErrorBase(const String& domain, int errorCode, const URL& failingURL, const String& localizedDescription)
66         : m_domain(domain)
67         , m_failingURL(failingURL)
68         , m_localizedDescription(localizedDescription)
69         , m_errorCode(errorCode)
70         , m_isNull(false)
71         , m_isCancellation(false)
72         , m_isTimeout(false)
73     {
74     }
75
76     WEBCORE_EXPORT void lazyInit() const;
77
78     // The ResourceError subclass may "shadow" this method to lazily initialize platform specific fields
79     void platformLazyInit() {}
80
81     // The ResourceError subclass may "shadow" this method to compare platform specific fields
82     static bool platformCompare(const ResourceError&, const ResourceError&) { return true; }
83
84     String m_domain;
85     URL m_failingURL;
86     String m_localizedDescription;
87     int m_errorCode;
88     bool m_isNull : 1;
89     bool m_isCancellation : 1;
90     bool m_isTimeout : 1;
91
92 private:
93     const ResourceError& asResourceError() const;
94 };
95
96 inline bool operator==(const ResourceError& a, const ResourceError& b) { return ResourceErrorBase::compare(a, b); }
97 inline bool operator!=(const ResourceError& a, const ResourceError& b) { return !(a == b); }
98
99 } // namespace WebCore