src/third_party/WebKit/Source/bindings/v8/ScriptPromise.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 ScriptPromise_h
  32 #define ScriptPromise_h
  33
  34 #include "bindings/v8/ScriptFunction.h"
  35 #include "bindings/v8/ScriptValue.h"
  36 #include "wtf/PassOwnPtr.h"
  37 #include <v8.h>
  38
  39 namespace WebCore {
  40
  41 class ExecutionContext;
  42
  43 // ScriptPromise is the class for representing Promise values in C++ world.
  44 // ScriptPromise holds a Promise.
  45 // So holding a ScriptPromise as a member variable in DOM object causes
  46 // memory leaks since it has a reference from C++ to V8.
  47 //
  48 class ScriptPromise {
  49 public:
  50     // Constructs an empty promise.
  51     ScriptPromise() { }
  52
  53     // Constructs a ScriptPromise from |promise|.
  54     // If |promise| is not a Promise object, throws a v8 TypeError.
  55     ScriptPromise(ScriptState*, v8::Handle<v8::Value> promise);
  56
  57     ScriptPromise then(PassOwnPtr<ScriptFunction> onFulfilled, PassOwnPtr<ScriptFunction> onRejected = PassOwnPtr<ScriptFunction>());
  58
  59     bool isObject() const
  60     {
  61         return m_promise.isObject();
  62     }
  63
  64     bool isNull() const
  65     {
  66         return m_promise.isNull();
  67     }
  68
  69     bool isUndefinedOrNull() const
  70     {
  71         return m_promise.isUndefined() || m_promise.isNull();
  72     }
  73
  74     v8::Handle<v8::Value> v8Value() const
  75     {
  76         return m_promise.v8Value();
  77     }
  78
  79     v8::Isolate* isolate() const
  80     {
  81         return m_promise.isolate();
  82     }
  83
  84     bool isEmpty() const
  85     {
  86         return m_promise.isEmpty();
  87     }
  88
  89     void clear()
  90     {
  91         m_promise.clear();
  92     }
  93
  94     // Constructs and returns a ScriptPromise from |value|.
  95     // if |value| is not a Promise object, returns a Promise object
  96     // resolved with |value|.
  97     static ScriptPromise cast(const ScriptValue& /*value*/);
  98
  99 private:
 100     RefPtr<ScriptState> m_scriptState;
 101     ScriptValue m_promise;
 102 };
 103
 104 } // namespace WebCore
 105
 106
 107 #endif // ScriptPromise_h