• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2006 Apple Computer, 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 COMPUTER, 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 COMPUTER, 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 #ifndef ResourceErrorBase_h
27 #define ResourceErrorBase_h
28 
29 #include "PlatformString.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     // Makes a deep copy. Useful for when you need to use a ResourceError on another thread.
40     ResourceError copy() const;
41 
isNull()42     bool isNull() const { return m_isNull; }
43 
domain()44     const String& domain() const { lazyInit(); return m_domain; }
errorCode()45     int errorCode() const { lazyInit(); return m_errorCode; }
failingURL()46     const String& failingURL() const { lazyInit(); return m_failingURL; }
localizedDescription()47     const String& localizedDescription() const { lazyInit(); return m_localizedDescription; }
48 
setIsCancellation(bool isCancellation)49     void setIsCancellation(bool isCancellation) { m_isCancellation = isCancellation; }
isCancellation()50     bool isCancellation() const { return m_isCancellation; }
51 
52     static bool compare(const ResourceError&, const ResourceError&);
53 
54 protected:
ResourceErrorBase()55     ResourceErrorBase()
56         : m_errorCode(0)
57         , m_isNull(true)
58         , m_isCancellation(false)
59     {
60     }
61 
ResourceErrorBase(const String & domain,int errorCode,const String & failingURL,const String & localizedDescription)62     ResourceErrorBase(const String& domain, int errorCode, const String& failingURL, const String& localizedDescription)
63         : m_domain(domain)
64         , m_errorCode(errorCode)
65         , m_failingURL(failingURL)
66         , m_localizedDescription(localizedDescription)
67         , m_isNull(false)
68         , m_isCancellation(false)
69     {
70     }
71 
72     void lazyInit() const;
73 
74     // The ResourceError subclass may "shadow" this method to lazily initialize platform specific fields
platformLazyInit()75     void platformLazyInit() {}
76 
77     // The ResourceError subclass may "shadow" this method to copy platform specific fields
platformCopy(ResourceError &)78     void platformCopy(ResourceError&) const {}
79 
80     // The ResourceError subclass may "shadow" this method to compare platform specific fields
platformCompare(const ResourceError &,const ResourceError &)81     static bool platformCompare(const ResourceError&, const ResourceError&) { return true; }
82 
83     String m_domain;
84     int m_errorCode;
85     String m_failingURL;
86     String m_localizedDescription;
87     bool m_isNull;
88     bool m_isCancellation;
89 };
90 
91 inline bool operator==(const ResourceError& a, const ResourceError& b) { return ResourceErrorBase::compare(a, b); }
92 inline bool operator!=(const ResourceError& a, const ResourceError& b) { return !(a == b); }
93 
94 } // namespace WebCore
95 
96 #endif // ResourceErrorBase_h
97