Home | History | Annotate | Download | only in v8 
      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/core/v8/ScriptFunction.h"
     35 #include "bindings/core/v8/ScriptValue.h"
     36 #include "bindings/core/v8/V8ThrowException.h"
     37 #include "core/dom/ExceptionCode.h"
     38 #include "platform/heap/Handle.h"
     39 #include "wtf/PassOwnPtr.h"
     40 #include "wtf/PassRefPtr.h"
     41 #include "wtf/text/WTFString.h"
     42 #include <v8.h>
     43 
     44 namespace blink {
     45 
     46 class DOMException;
     47 class ExceptionState;
     48 
     49 // ScriptPromise is the class for representing Promise values in C++ world.
     50 // ScriptPromise holds a Promise.
     51 // So holding a ScriptPromise as a member variable in DOM object causes
     52 // memory leaks since it has a reference from C++ to V8.
     53 //
     54 class ScriptPromise FINAL {
     55 public:
     56     // Constructs an empty promise.
     57     ScriptPromise() { }
     58 
     59     // Constructs a ScriptPromise from |promise|.
     60     // If |promise| is not a Promise object, throws a v8 TypeError.
     61     ScriptPromise(ScriptState*, v8::Handle<v8::Value> promise);
     62 
     63     ScriptPromise then(v8::Handle<v8::Function> onFulfilled, v8::Handle<v8::Function> onRejected = v8::Handle<v8::Function>());
     64 
     65     bool isObject() const
     66     {
     67         return m_promise.isObject();
     68     }
     69 
     70     bool isNull() const
     71     {
     72         return m_promise.isNull();
     73     }
     74 
     75     bool isUndefinedOrNull() const
     76     {
     77         return m_promise.isUndefined() || m_promise.isNull();
     78     }
     79 
     80     v8::Handle<v8::Value> v8Value() const
     81     {
     82         return m_promise.v8Value();
     83     }
     84 
     85     v8::Isolate* isolate() const
     86     {
     87         return m_promise.isolate();
     88     }
     89 
     90     bool isEmpty() const
     91     {
     92         return m_promise.isEmpty();
     93     }
     94 
     95     void clear()
     96     {
     97         m_promise.clear();
     98     }
     99 
    100     bool operator==(const ScriptPromise& value) const
    101     {
    102         return m_promise == value.m_promise;
    103     }
    104 
    105     bool operator!=(const ScriptPromise& value) const
    106     {
    107         return !operator==(value);
    108     }
    109 
    110     // Constructs and returns a ScriptPromise from |value|.
    111     // if |value| is not a Promise object, returns a Promise object
    112     // resolved with |value|.
    113     // Returns |value| itself if it is a Promise.
    114     static ScriptPromise cast(ScriptState*, const ScriptValue& /*value*/);
    115     static ScriptPromise cast(ScriptState*, v8::Handle<v8::Value> /*value*/);
    116 
    117     static ScriptPromise reject(ScriptState*, const ScriptValue&);
    118     static ScriptPromise reject(ScriptState*, v8::Handle<v8::Value>);
    119 
    120     static ScriptPromise rejectWithDOMException(ScriptState*, PassRefPtrWillBeRawPtr<DOMException>);
    121 
    122     static v8::Local<v8::Promise> rejectRaw(v8::Isolate*, v8::Handle<v8::Value>);
    123 
    124     // This is a utility class intended to be used internally.
    125     // ScriptPromiseResolver is for general purpose.
    126     class InternalResolver FINAL {
    127     public:
    128         explicit InternalResolver(ScriptState*);
    129         v8::Local<v8::Promise> v8Promise() const;
    130         ScriptPromise promise() const;
    131         void resolve(v8::Local<v8::Value>);
    132         void reject(v8::Local<v8::Value>);
    133         void clear() { m_resolver.clear(); }
    134 
    135     private:
    136         ScriptValue m_resolver;
    137     };
    138 
    139 private:
    140     RefPtr<ScriptState> m_scriptState;
    141     ScriptValue m_promise;
    142 };
    143 
    144 } // namespace blink
    145 
    146 
    147 #endif // ScriptPromise_h
    148