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         EnumerationContext,
  54         QueryContext,
  55         IndexedGetterContext,
  56         IndexedSetterContext,
  57         IndexedDeletionContext,
  58         UnknownContext, // FIXME: Remove this once we've flipped over to the new API.
  59     };
  60
  61     ExceptionState(Context context, const char* propertyName, const char* interfaceName, const v8::Handle<v8::Object>& creationContext, v8::Isolate* isolate)
  62         : m_code(0)
  63         , m_context(context)
  64         , m_propertyName(propertyName)
  65         , m_interfaceName(interfaceName)
  66         , m_creationContext(creationContext)
  67         , m_isolate(isolate) { }
  68
  69     ExceptionState(Context context, const char* interfaceName, const v8::Handle<v8::Object>& creationContext, v8::Isolate* isolate)
  70         : m_code(0)
  71         , m_context(context)
  72         , m_propertyName(0)
  73         , m_interfaceName(interfaceName)
  74         , m_creationContext(creationContext)
  75         , m_isolate(isolate) { ASSERT(m_context == ConstructionContext || m_context == EnumerationContext || m_context == IndexedSetterContext || m_context == IndexedGetterContext || m_context == IndexedDeletionContext); }
  76
  77     virtual void throwDOMException(const ExceptionCode&, const String& message);
  78     virtual void throwTypeError(const String& message);
  79     virtual void throwSecurityError(const String& sanitizedMessage, const String& unsanitizedMessage = String());
  80
  81     bool hadException() const { return !m_exception.isEmpty() || m_code; }
  82     void clearException();
  83
  84     ExceptionCode code() const { return m_code; }
  85     const String& message() const { return m_message; }
  86
  87     bool throwIfNeeded()
  88     {
  89         if (!hadException())
  90             return false;
  91         throwException();
  92         return true;
  93     }
  94
  95     Context context() const { return m_context; }
  96     const char* propertyName() const { return m_propertyName; }
  97     const char* interfaceName() const { return m_interfaceName; }
  98
  99     void rethrowV8Exception(v8::Handle<v8::Value> value)
 100     {
 101         setException(value);
 102     }
 103
 104 protected:
 105     ExceptionCode m_code;
 106     Context m_context;
 107     String m_message;
 108     const char* m_propertyName;
 109     const char* m_interfaceName;
 110
 111 private:
 112     void setException(v8::Handle<v8::Value>);
 113     void throwException();
 114
 115     String addExceptionContext(const String&) const;
 116
 117     ScopedPersistent<v8::Value> m_exception;
 118     v8::Handle<v8::Object> m_creationContext;
 119     v8::Isolate* m_isolate;
 120 };
 121
 122 // Used if exceptions can/should not be directly thrown.
 123 class NonThrowableExceptionState FINAL : public ExceptionState {
 124 public:
 125     NonThrowableExceptionState(): ExceptionState(ExceptionState::UnknownContext, 0, 0, v8::Handle<v8::Object>(), v8::Isolate::GetCurrent()) { }
 126     virtual void throwDOMException(const ExceptionCode&, const String& message) OVERRIDE;
 127     virtual void throwTypeError(const String& message = String()) OVERRIDE;
 128     virtual void throwSecurityError(const String& sanitizedMessage, const String& unsanitizedMessage = String()) OVERRIDE;
 129 };
 130
 131 // Used if any exceptions thrown are ignorable.
 132 class TrackExceptionState FINAL : public ExceptionState {
 133 public:
 134     TrackExceptionState(): ExceptionState(ExceptionState::UnknownContext, 0, 0, v8::Handle<v8::Object>(), v8::Isolate::GetCurrent()) { }
 135     virtual void throwDOMException(const ExceptionCode&, const String& message) OVERRIDE;
 136     virtual void throwTypeError(const String& message = String()) OVERRIDE;
 137     virtual void throwSecurityError(const String& sanitizedMessage, const String& unsanitizedMessage = String()) OVERRIDE;
 138 };
 139
 140 } // namespace WebCore
 141
 142 #endif // ExceptionState_h