Work In Progress: Handle Maps and Sets in Structured Clone

Source/bindings/core/v8/ScriptValueSerializer.h

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef ScriptValueSerializer_h
 #define ScriptValueSerializer_h
 
 #include "bindings/core/v8/SerializationTag.h"
 #include "bindings/core/v8/SerializedScriptValue.h"
 #include "bindings/core/v8/V8Binding.h"
@@ skipping 125 matching lines @@
     void writeTransferredArrayBuffer(uint32_t index);
     void writeObjectReference(uint32_t reference);
     void writeObject(uint32_t numProperties);
     void writeSparseArray(uint32_t numProperties, uint32_t length);
     void writeDenseArray(uint32_t numProperties, uint32_t length);
     String takeWireString();
     void writeReferenceCount(uint32_t numberOfReferences);
     void writeGenerateFreshObject();
     void writeGenerateFreshSparseArray(uint32_t length);
     void writeGenerateFreshDenseArray(uint32_t length);
+    void writeGenerateFreshMap();
+    void writeGenerateFreshSet();
+    void writeMap(uint32_t length);
+    void writeSet(uint32_t length);
 
 protected:
     void doWriteFile(const File&);
     void doWriteArrayBuffer(const DOMArrayBuffer&);
     void doWriteString(const char* data, int length);
     void doWriteWebCoreString(const String&);
     int bytesNeededToWireEncode(uint32_t value);
 
     template<class T>
     void doWriteUintHelper(T value)
@@ skipping 164 matching lines @@
         {
             m_propertyNames = v8::Local<v8::Array>::New(isolate, propertyNames);
         }
 
         virtual StateBase* advance(ScriptValueSerializer&) override;
 
     protected:
         virtual StateBase* objectDone(unsigned numProperties, ScriptValueSerializer&) override;
     };
 
+    template <typename T>
+    class CollectionState : public State<T> {
+    public:
+        CollectionState(v8::Local<T> collection, StateBase* next)
+            : State<T>(collection, next)
+            , m_entries(collection->AsArray())
+            , m_index(0)
+            , m_length(m_entries->Length())
+        {
+        }
+
+        virtual StateBase* advance(ScriptValueSerializer&) override;
+
+    private:
+        v8::Local<v8::Array> m_entries;
+        uint32_t m_index;
+        uint32_t m_length;
+    };
+
     // Functions used by serialization states.
     virtual StateBase* doSerializeValue(v8::Local<v8::Value>, StateBase* next);
 
 private:
     StateBase* doSerialize(v8::Local<v8::Value>, StateBase* next);
     StateBase* doSerializeArrayBuffer(v8::Local<v8::Value> arrayBuffer, StateBase* next);
     StateBase* checkException(StateBase*);
     StateBase* writeObject(uint32_t numProperties, StateBase*);
     StateBase* writeSparseArray(uint32_t numProperties, uint32_t length, StateBase*);
     StateBase* writeDenseArray(uint32_t numProperties, uint32_t length, StateBase*);
+    StateBase* writeMap(uint32_t length, StateBase*);
+    StateBase* writeSet(uint32_t length, StateBase*);
 
     StateBase* push(StateBase* state)
     {
         ASSERT(state);
         ++m_depth;
         return checkComposite(state) ? state : handleError(InputError, "Value being cloned is either cyclic or too deeply nested.", state);
     }
 
     StateBase* pop(StateBase* state)
     {
@@ skipping 15 matching lines @@
     StateBase* writeFileList(v8::Local<v8::Value>, StateBase* next);
     void writeImageData(v8::Local<v8::Value>);
     void writeRegExp(v8::Local<v8::Value>);
     StateBase* writeAndGreyArrayBufferView(v8::Local<v8::Object>, StateBase* next);
     StateBase* writeArrayBuffer(v8::Local<v8::Value>, StateBase* next);
     StateBase* writeTransferredArrayBuffer(v8::Local<v8::Value>, uint32_t index, StateBase* next);
     static bool shouldSerializeDensely(uint32_t length, uint32_t propertyCount);
 
     StateBase* startArrayState(v8::Local<v8::Array>, StateBase* next);
     StateBase* startObjectState(v8::Local<v8::Object>, StateBase* next);
+    StateBase* startMapState(v8::Local<v8::Map>, StateBase* next);
+    StateBase* startSetState(v8::Local<v8::Set>, StateBase* next);
 
     bool appendBlobInfo(const String& uuid, const String& type, unsigned long long size, int* index);
     bool appendFileInfo(const File*, int* index);
 
 protected:
     // Marks object as having been visited by the serializer and assigns it a unique object reference ID.
     // An object may only be greyed once.
     void greyObject(const v8::Local<v8::Object>&);
 
     StateBase* handleError(Status errorStatus, const String& message, StateBase*);
@@ skipping 26 matching lines @@
     virtual ~ScriptValueCompositeCreator() { }
 
     virtual bool consumeTopOfStack(v8::Local<v8::Value>*) = 0;
     virtual uint32_t objectReferenceCount() = 0;
     virtual void pushObjectReference(const v8::Local<v8::Value>&) = 0;
     virtual bool tryGetObjectFromObjectReference(uint32_t reference, v8::Local<v8::Value>*) = 0;
     virtual bool tryGetTransferredMessagePort(uint32_t index, v8::Local<v8::Value>*) = 0;
     virtual bool tryGetTransferredArrayBuffer(uint32_t index, v8::Local<v8::Value>*) = 0;
     virtual bool newSparseArray(uint32_t length) = 0;
     virtual bool newDenseArray(uint32_t length) = 0;
+    virtual bool newMap() = 0;
+    virtual bool newSet() = 0;
     virtual bool newObject() = 0;
     virtual bool completeObject(uint32_t numProperties, v8::Local<v8::Value>*) = 0;
     virtual bool completeSparseArray(uint32_t numProperties, uint32_t length, v8::Local<v8::Value>*) = 0;
     virtual bool completeDenseArray(uint32_t numProperties, uint32_t length, v8::Local<v8::Value>*) = 0;
+    virtual bool completeMap(uint32_t length, v8::Local<v8::Value>*) = 0;
+    virtual bool completeSet(uint32_t length, v8::Local<v8::Value>*) = 0;
 };
 
 // SerializedScriptValueReader is responsible for deserializing primitive types and
 // restoring information about saved objects of composite types.
 class CORE_EXPORT SerializedScriptValueReader {
     STACK_ALLOCATED();
     WTF_MAKE_NONCOPYABLE(SerializedScriptValueReader);
 public:
     SerializedScriptValueReader(const uint8_t* buffer, int length, const WebBlobInfoArray* blobInfo, BlobDataHandleMap& blobDataHandles, ScriptState* scriptState)
         : m_scriptState(scriptState)
@@ skipping 100 matching lines @@
         , m_transferredMessagePorts(messagePorts)
         , m_arrayBufferContents(arrayBufferContents)
         , m_arrayBuffers(arrayBufferContents ? arrayBufferContents->size() : 0)
         , m_version(0)
     {
     }
 
     v8::Local<v8::Value> deserialize();
     virtual bool newSparseArray(uint32_t) override;
     virtual bool newDenseArray(uint32_t length) override;
+    virtual bool newMap() override;
+    virtual bool newSet() override;
     virtual bool consumeTopOfStack(v8::Local<v8::Value>*) override;
     virtual bool newObject() override;
     virtual bool completeObject(uint32_t numProperties, v8::Local<v8::Value>*) override;
     virtual bool completeSparseArray(uint32_t numProperties, uint32_t length, v8::Local<v8::Value>*) override;
     virtual bool completeDenseArray(uint32_t numProperties, uint32_t length, v8::Local<v8::Value>*) override;
+    virtual bool completeMap(uint32_t length, v8::Local<v8::Value>*) override;
+    virtual bool completeSet(uint32_t length, v8::Local<v8::Value>*) override;
     virtual void pushObjectReference(const v8::Local<v8::Value>&) override;
     virtual bool tryGetTransferredMessagePort(uint32_t index, v8::Local<v8::Value>*) override;
     virtual bool tryGetTransferredArrayBuffer(uint32_t index, v8::Local<v8::Value>*) override;
     virtual bool tryGetObjectFromObjectReference(uint32_t reference, v8::Local<v8::Value>*) override;
     virtual uint32_t objectReferenceCount() override;
 
 protected:
     SerializedScriptValueReader& reader() { return m_reader; }
     virtual bool read(v8::Local<v8::Value>*);
 
@@ skipping 18 matching lines @@
     Vector<uint32_t> m_openCompositeReferenceStack;
     MessagePortArray* m_transferredMessagePorts;
     ArrayBufferContentsArray* m_arrayBufferContents;
     Vector<v8::Local<v8::Value>> m_arrayBuffers;
     uint32_t m_version;
 };
 
 } // namespace blink
 
 #endif // ScriptValueSerializer_h