src/third_party/WebKit/Source/core/dom/DOMException.h

   1 /*
   2  * Copyright (C) 2007, 2008 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  *
   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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef DOMException_h
  30 #define DOMException_h
  31
  32 #include "bindings/v8/ScriptWrappable.h"
  33 #include "platform/heap/Handle.h"
  34 #include "wtf/PassRefPtr.h"
  35 #include "wtf/RefCounted.h"
  36 #include "wtf/text/WTFString.h"
  37
  38 namespace WebCore {
  39
  40 typedef int ExceptionCode;
  41
  42 class DOMException FINAL : public RefCountedWillBeGarbageCollectedFinalized<DOMException>, public ScriptWrappable {
  43 public:
  44     static PassRefPtrWillBeRawPtr<DOMException> create(ExceptionCode, const String& sanitizedMessage = String(), const String& unsanitizedMessage = String());
  45
  46     unsigned short code() const { return m_code; }
  47     String name() const { return m_name; }
  48
  49     // This is the message that's exposed to JavaScript: never return unsanitized data.
  50     String message() const { return m_sanitizedMessage; }
  51     String toString() const;
  52
  53     // This is the message that's exposed to the console: if an unsanitized message is present, we prefer it.
  54     String messageForConsole() const { return !m_unsanitizedMessage.isEmpty() ? m_unsanitizedMessage : m_sanitizedMessage; }
  55     String toStringForConsole() const;
  56
  57     static String getErrorName(ExceptionCode);
  58     static String getErrorMessage(ExceptionCode);
  59
  60     void trace(Visitor*) { }
  61
  62 private:
  63     DOMException(unsigned short m_code, const String& name, const String& sanitizedMessage, const String& unsanitizedMessage);
  64
  65     unsigned short m_code;
  66     String m_name;
  67     String m_sanitizedMessage;
  68     String m_unsanitizedMessage;
  69 };
  70
  71 } // namespace WebCore
  72
  73 #endif // DOMException_h