src/third_party/WebKit/Source/bindings/v8/ExceptionState.h

   1 /*
   2  * Copyright (C) 2013 Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef ExceptionState_h
  32 #define ExceptionState_h
  33
  34 #include "bindings/v8/ScopedPersistent.h"
  35 #include "bindings/v8/V8ThrowException.h"
  36 #include "wtf/Noncopyable.h"
  37 #include "wtf/text/WTFString.h"
  38 #include <v8.h>
  39
  40 namespace WebCore {
  41
  42 typedef int ExceptionCode;
  43
  44 class ExceptionState {
  45     WTF_MAKE_NONCOPYABLE(ExceptionState);
  46 public:
  47     enum Context {
  48         ConstructionContext,
  49         ExecutionContext,
  50         DeletionContext,
  51         GetterContext,
  52         SetterContext,
  53         UnknownContext, // FIXME: Remove this once we've flipped over to the new API.
  54     };
  55
  56     explicit ExceptionState(const v8::Handle<v8::Object>& creationContext, v8::Isolate* isolate)
  57         : m_code(0)
  58         , m_context(UnknownContext)
  59         , m_propertyName(0)
  60         , m_interfaceName(0)
  61         , m_creationContext(creationContext)
  62         , m_isolate(isolate) { }
  63
  64     ExceptionState(Context context, const char* propertyName, const char* interfaceName, const v8::Handle<v8::Object>& creationContext, v8::Isolate* isolate)
  65         : m_code(0)
  66         , m_context(context)
  67         , m_propertyName(propertyName)
  68         , m_interfaceName(interfaceName)
  69         , m_creationContext(creationContext)
  70         , m_isolate(isolate) { }
  71
  72     ExceptionState(Context context, const char* interfaceName, const v8::Handle<v8::Object>& creationContext, v8::Isolate* isolate)
  73         : m_code(0)
  74         , m_context(context)
  75         , m_propertyName(0)
  76         , m_interfaceName(interfaceName)
  77         , m_creationContext(creationContext)
  78         , m_isolate(isolate) { ASSERT(m_context == ConstructionContext); }
  79
  80     virtual void throwDOMException(const ExceptionCode&, const String& message);
  81     virtual void throwTypeError(const String& message);
  82     virtual void throwSecurityError(const String& sanitizedMessage, const String& unsanitizedMessage = String());
  83
  84     // Please don't use these methods. Use ::throwDOMException and ::throwTypeError, and pass in a useful exception message.
  85     virtual void throwUninformativeAndGenericDOMException(const ExceptionCode& ec) { throwDOMException(ec, String()); }
  86
  87     bool hadException() const { return !m_exception.isEmpty() || m_code; }
  88     void clearException();
  89
  90     ExceptionCode code() const { return m_code; }
  91
  92     bool throwIfNeeded()
  93     {
  94         if (m_exception.isEmpty()) {
  95             if (!m_code)
  96                 return false;
  97             throwUninformativeAndGenericDOMException(m_code);
  98         }
  99
 100         V8ThrowException::throwError(m_exception.newLocal(m_isolate), m_isolate);
 101         return true;
 102     }
 103
 104     Context context() const { return m_context; }
 105     const char* propertyName() const { return m_propertyName; }
 106     const char* interfaceName() const { return m_interfaceName; }
 107
 108     void rethrowV8Exception(v8::Handle<v8::Value> value)
 109     {
 110         setException(value);
 111     }
 112
 113 protected:
 114     ExceptionCode m_code;
 115     Context m_context;
 116     const char* m_propertyName;
 117     const char* m_interfaceName;
 118
 119 private:
 120     void setException(v8::Handle<v8::Value>);
 121
 122     String addExceptionContext(const String&) const;
 123
 124     ScopedPersistent<v8::Value> m_exception;
 125     v8::Handle<v8::Object> m_creationContext;
 126     v8::Isolate* m_isolate;
 127 };
 128
 129 // Used if exceptions can/should not be directly thrown.
 130 class NonThrowableExceptionState FINAL : public ExceptionState {
 131 public:
 132     NonThrowableExceptionState(): ExceptionState(v8::Handle<v8::Object>(), v8::Isolate::GetCurrent()) { }
 133     virtual void throwDOMException(const ExceptionCode&, const String& message) OVERRIDE;
 134     virtual void throwTypeError(const String& message = String()) OVERRIDE;
 135     virtual void throwSecurityError(const String& sanitizedMessage, const String& unsanitizedMessage = String()) OVERRIDE;
 136 };
 137
 138 // Used if any exceptions thrown are ignorable.
 139 class TrackExceptionState FINAL : public ExceptionState {
 140 public:
 141     TrackExceptionState(): ExceptionState(v8::Handle<v8::Object>(), v8::Isolate::GetCurrent()) { }
 142     virtual void throwDOMException(const ExceptionCode&, const String& message) OVERRIDE;
 143     virtual void throwTypeError(const String& message = String()) OVERRIDE;
 144     virtual void throwSecurityError(const String& sanitizedMessage, const String& unsanitizedMessage = String()) OVERRIDE;
 145 };
 146
 147 } // namespace WebCore
 148
 149 #endif // ExceptionState_h