WebCore/ResourceErrorBase.h

   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 class ResourceErrorBase {
  36 public:
  37     bool isNull() const { return m_isNull; }
  38
  39     const String& domain() const { lazyInit(); return m_domain; }
  40     int errorCode() const { lazyInit(); return m_errorCode; }
  41     const String& failingURL() const { lazyInit(); return m_failingURL; }
  42     const String& localizedDescription() const { lazyInit(); return m_localizedDescription; }
  43
  44     void setIsCancellation(bool isCancellation) { m_isCancellation = isCancellation; }
  45     bool isCancellation() const { return m_isCancellation; }
  46
  47     static bool compare(const ResourceError& a, const ResourceError& b);
  48
  49 protected:
  50     ResourceErrorBase()
  51         : m_errorCode(0)
  52         , m_isNull(true)
  53         , m_isCancellation(false)
  54     {
  55     }
  56
  57     ResourceErrorBase(const String& domain, int errorCode, const String& failingURL, const String& localizedDescription)
  58         : m_domain(domain)
  59         , m_errorCode(errorCode)
  60         , m_failingURL(failingURL)
  61         , m_localizedDescription(localizedDescription)
  62         , m_isNull(false)
  63         , m_isCancellation(false)
  64     {
  65     }
  66
  67     void lazyInit() const;
  68
  69     // The ResourceError subclass may "shadow" this method to lazily initialize platform specific fields
  70     void platformLazyInit() {}
  71
  72     // The ResourceError subclass may "shadow" this method to compare platform specific fields
  73     static bool platformCompare(const ResourceError&, const ResourceError&) { return true; }
  74
  75     String m_domain;
  76     int m_errorCode;
  77     String m_failingURL;
  78     String m_localizedDescription;
  79     bool m_isNull;
  80     bool m_isCancellation;
  81 };
  82
  83 inline bool operator==(const ResourceError& a, const ResourceError& b) { return ResourceErrorBase::compare(a, b); }
  84 inline bool operator!=(const ResourceError& a, const ResourceError& b) { return !(a == b); }
  85
  86 } // namespace WebCore
  87
  88 #endif // ResourceErrorBase_h_