third_party/WebKit/public/web/WebSerializedScriptValue.h

   1 /*
   2  * Copyright (C) 2010 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 WebSerializedScriptValue_h
  32 #define WebSerializedScriptValue_h
  33
  34 #include "../platform/WebCommon.h"
  35 #include "../platform/WebPrivatePtr.h"
  36
  37 namespace v8 {
  38 class Value;
  39 template <class T> class Local;
  40 }
  41
  42 namespace blink {
  43
  44 class SerializedScriptValue;
  45 class WebString;
  46
  47 // FIXME: Should this class be in platform?
  48 class WebSerializedScriptValue {
  49 public:
  50     ~WebSerializedScriptValue() { reset(); }
  51
  52     WebSerializedScriptValue() { }
  53     WebSerializedScriptValue(const WebSerializedScriptValue& d) { assign(d); }
  54     WebSerializedScriptValue& operator=(const WebSerializedScriptValue& d)
  55     {
  56         assign(d);
  57         return *this;
  58     }
  59
  60     BLINK_EXPORT static WebSerializedScriptValue fromString(const WebString&);
  61
  62     BLINK_EXPORT static WebSerializedScriptValue serialize(v8::Local<v8::Value>);
  63
  64     // Create a WebSerializedScriptValue that represents a serialization error.
  65     BLINK_EXPORT static WebSerializedScriptValue createInvalid();
  66
  67     BLINK_EXPORT void reset();
  68     BLINK_EXPORT void assign(const WebSerializedScriptValue&);
  69
  70     bool isNull() const { return m_private.isNull(); }
  71
  72     // Returns a string representation of the WebSerializedScriptValue.
  73     BLINK_EXPORT WebString toString() const;
  74
  75     // Convert the serialized value to a parsed v8 value.
  76     BLINK_EXPORT v8::Local<v8::Value> deserialize();
  77
  78 #if BLINK_IMPLEMENTATION
  79     WebSerializedScriptValue(const WTF::PassRefPtr<SerializedScriptValue>&);
  80     WebSerializedScriptValue& operator=(const WTF::PassRefPtr<SerializedScriptValue>&);
  81     operator WTF::PassRefPtr<SerializedScriptValue>() const;
  82 #endif
  83
  84 private:
  85     WebPrivatePtr<SerializedScriptValue> m_private;
  86 };
  87
  88 } // namespace blink
  89
  90 #endif