658c9caf236518012e5150b962c4ce122c5166ff
[WebKit-https.git] / Source / WebCore / platform / network / ResourceErrorBase.h
1 /*
2  * Copyright (C) 2006 Apple Inc.  All rights reserved.
3  * Copyright (C) 2016 Canon Inc.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "URL.h"
30 #include <wtf/text/WTFString.h>
31
32 namespace WebCore {
33
34 class ResourceError;
35
36 extern const char* const errorDomainWebKitInternal; // Used for errors that won't be exposed to clients.
37
38 class ResourceErrorBase {
39 public:
40     ResourceError isolatedCopy() const;
41
42     const String& domain() const { lazyInit(); return m_domain; }
43     int errorCode() const { lazyInit(); return m_errorCode; }
44     const URL& failingURL() const { lazyInit(); return m_failingURL; }
45     const String& localizedDescription() const { lazyInit(); return m_localizedDescription; }
46
47     enum class Type {
48         Null,
49         General,
50         AccessControl,
51         Cancellation,
52         Timeout
53     };
54
55     bool isNull() const { return m_type == Type::Null; }
56     bool isGeneral() const { return m_type == Type::General; }
57     bool isAccessControl() const { return m_type == Type::AccessControl; }
58     bool isCancellation() const { return m_type == Type::Cancellation; }
59     bool isTimeout() const { return m_type == Type::Timeout; }
60
61     static bool compare(const ResourceError&, const ResourceError&);
62
63     void setType(Type);
64     Type type() const { return m_type; }
65
66 protected:
67     ResourceErrorBase(Type type) : m_type(type) { }
68
69     ResourceErrorBase(const String& domain, int errorCode, const URL& failingURL, const String& localizedDescription, Type type)
70         : m_domain(domain)
71         , m_failingURL(failingURL)
72         , m_localizedDescription(localizedDescription)
73         , m_errorCode(errorCode)
74         , m_type(type)
75     {
76     }
77
78     WEBCORE_EXPORT void lazyInit() const;
79
80     // The ResourceError subclass may "shadow" this method to lazily initialize platform specific fields
81     void platformLazyInit() {}
82
83     // The ResourceError subclass may "shadow" this method to compare platform specific fields
84     static bool platformCompare(const ResourceError&, const ResourceError&) { return true; }
85
86     String m_domain;
87     URL m_failingURL;
88     String m_localizedDescription;
89     int m_errorCode { 0 };
90     Type m_type { Type::General };
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