Make ImageBitmap Transferable

third_party/WebKit/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"
 #include "core/CoreExport.h"
+#include "core/frame/ImageBitmap.h"
 #include "wtf/ArrayBufferContents.h"
 #include "wtf/HashMap.h"
 #include "wtf/Noncopyable.h"
 #include "wtf/Vector.h"
 #include "wtf/text/WTFString.h"
 #include <v8.h>
 
 namespace blink {
 
 class CompositorProxy;
 class DOMArrayBuffer;
 class DOMArrayBufferView;
 class DOMSharedArrayBuffer;
 class File;
 class FileList;
+class ImageBitmap;
 
 typedef Vector<WTF::ArrayBufferContents, 1> ArrayBufferContentsArray;
 
 // V8ObjectMap is a map from V8 objects to arbitrary values of type T.
 // V8 objects (or handles to V8 objects) cannot be used as keys in ordinary wtf::HashMaps;
 // this class should be used instead. GCObject must be a subtype of v8::Object.
 // Suggested usage:
 //     V8ObjectMap<v8::Object, int> map;
 //     v8::Local<v8::Object> obj = ...;
 //     map.set(obj, 42);
@@ skipping 93 matching lines @@
     void writeFile(const File&);
     void writeFileIndex(int blobIndex);
     void writeFileList(const FileList&);
     void writeFileListIndex(const Vector<int>& blobIndices);
     void writeArrayBuffer(const DOMArrayBuffer&);
     void writeArrayBufferView(const DOMArrayBufferView&);
     void writeImageData(uint32_t width, uint32_t height, const uint8_t* pixelData, uint32_t pixelDataLength);
     void writeRegExp(v8::Local<v8::String> pattern, v8::RegExp::Flags);
     void writeTransferredMessagePort(uint32_t index);
     void writeTransferredArrayBuffer(uint32_t index);
+    void writeTransferredImageBitmap(uint32_t index);
     void writeTransferredSharedArrayBuffer(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);
@@ skipping 45 matching lines @@
 protected:
     class StateBase;
 public:
     enum Status {
         Success,
         InputError,
         DataCloneError,
         JSException
     };
 
-    ScriptValueSerializer(SerializedScriptValueWriter&, MessagePortArray* messagePorts, ArrayBufferArray* arrayBuffers, WebBlobInfoArray*, BlobDataHandleMap& blobDataHandles, v8::TryCatch&, ScriptState*);
+    ScriptValueSerializer(SerializedScriptValueWriter&, MessagePortArray* messagePorts, ArrayBufferArray* arrayBuffers, ImageBitmapArray* imageBitmaps, WebBlobInfoArray*, BlobDataHandleMap& blobDataHandles, v8::TryCatch&, ScriptState*);
     v8::Isolate* isolate() { return m_scriptState->isolate(); }
     v8::Local<v8::Context> context() { return m_scriptState->context(); }
 
     Status serialize(v8::Local<v8::Value>);
     String errorMessage() { return m_errorMessage; }
 
 protected:
     class StateBase {
         WTF_MAKE_FAST_ALLOCATED(StateBase);
         WTF_MAKE_NONCOPYABLE(StateBase);
@@ skipping 178 matching lines @@
     void writeBooleanObject(v8::Local<v8::Value>);
     StateBase* writeBlob(v8::Local<v8::Value>, StateBase* next);
     StateBase* writeCompositorProxy(v8::Local<v8::Value>, StateBase* next);
     StateBase* writeFile(v8::Local<v8::Value>, StateBase* next);
     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);
+    StateBase* writeTransferredImageBitmap(v8::Local<v8::Value>, uint32_t index, StateBase* next);
     StateBase* writeTransferredSharedArrayBuffer(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);
@@ skipping 12 matching lines @@
     RefPtr<ScriptState> m_scriptState;
     SerializedScriptValueWriter& m_writer;
     v8::TryCatch& m_tryCatch;
     int m_depth;
     Status m_status;
     String m_errorMessage;
     typedef V8ObjectMap<v8::Object, uint32_t> ObjectPool;
     ObjectPool m_objectPool;
     ObjectPool m_transferredMessagePorts;
     ObjectPool m_transferredArrayBuffers;
+    ObjectPool m_transferredImageBitmaps;
     uint32_t m_nextObjectReference;
     WebBlobInfoArray* m_blobInfo;
     BlobDataHandleMap& m_blobDataHandles;
 };
 
 // Interface used by SerializedScriptValueReader to create objects of composite types.
 class CORE_EXPORT ScriptValueCompositeCreator {
     STACK_ALLOCATED();
     WTF_MAKE_NONCOPYABLE(ScriptValueCompositeCreator);
 public:
     ScriptValueCompositeCreator() { }
     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 tryGetTransferredImageBitmap(uint32_t index, v8::Local<v8::Value>*) = 0;
     virtual bool tryGetTransferredSharedArrayBuffer(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;
@@ skipping 99 matching lines @@
     unsigned m_position;
     uint32_t m_version;
     const WebBlobInfoArray* m_blobInfo;
     const BlobDataHandleMap& m_blobDataHandles;
 };
 
 class CORE_EXPORT ScriptValueDeserializer : public ScriptValueCompositeCreator {
     STACK_ALLOCATED();
     WTF_MAKE_NONCOPYABLE(ScriptValueDeserializer);
 public:
-    ScriptValueDeserializer(SerializedScriptValueReader& reader, MessagePortArray* messagePorts, ArrayBufferContentsArray* arrayBufferContents)
+    ScriptValueDeserializer(SerializedScriptValueReader& reader, MessagePortArray* messagePorts, ArrayBufferContentsArray* arrayBufferContents, ImageBitmapArray* imageBitmaps)
         : m_reader(reader)
         , m_transferredMessagePorts(messagePorts)
         , m_arrayBufferContents(arrayBufferContents)
+        , m_imageBitmaps(imageBitmaps)
         , m_arrayBuffers(arrayBufferContents ? arrayBufferContents->size() : 0)
         , m_version(0)
     {
     }
 
     v8::Local<v8::Value> deserialize();
     bool newSparseArray(uint32_t) override;
     bool newDenseArray(uint32_t length) override;
     bool newMap() override;
     bool newSet() override;
     bool consumeTopOfStack(v8::Local<v8::Value>*) override;
     bool newObject() override;
     bool completeObject(uint32_t numProperties, v8::Local<v8::Value>*) override;
     bool completeSparseArray(uint32_t numProperties, uint32_t length, v8::Local<v8::Value>*) override;
     bool completeDenseArray(uint32_t numProperties, uint32_t length, v8::Local<v8::Value>*) override;
     bool completeMap(uint32_t length, v8::Local<v8::Value>*) override;
     bool completeSet(uint32_t length, v8::Local<v8::Value>*) override;
     void pushObjectReference(const v8::Local<v8::Value>&) override;
     bool tryGetTransferredMessagePort(uint32_t index, v8::Local<v8::Value>*) override;
     bool tryGetTransferredArrayBuffer(uint32_t index, v8::Local<v8::Value>*) override;
+    bool tryGetTransferredImageBitmap(uint32_t index, v8::Local<v8::Value>*) override;
     bool tryGetTransferredSharedArrayBuffer(uint32_t index, v8::Local<v8::Value>*) override;
     bool tryGetObjectFromObjectReference(uint32_t reference, v8::Local<v8::Value>*) override;
     uint32_t objectReferenceCount() override;
 
 protected:
     SerializedScriptValueReader& reader() { return m_reader; }
     virtual bool read(v8::Local<v8::Value>*);
 
 private:
     bool initializeObject(v8::Local<v8::Object>, uint32_t numProperties, v8::Local<v8::Value>*);
     bool doDeserialize();
     void push(v8::Local<v8::Value> value) { m_stack.append(value); };
     void pop(unsigned length)
     {
         ASSERT(length <= m_stack.size());
         m_stack.shrink(m_stack.size() - length);
     }
     unsigned stackDepth() const { return m_stack.size(); }
 
     v8::Local<v8::Value> element(unsigned index);
     void openComposite(const v8::Local<v8::Value>&);
     bool closeComposite(v8::Local<v8::Value>*);
 
     SerializedScriptValueReader& m_reader;
     Vector<v8::Local<v8::Value>> m_stack;
     Vector<v8::Local<v8::Value>> m_objectPool;
     Vector<uint32_t> m_openCompositeReferenceStack;
     MessagePortArray* m_transferredMessagePorts;
     ArrayBufferContentsArray* m_arrayBufferContents;
+    ImageBitmapArray* m_imageBitmaps;

[sof, 2015/10/26 16:31:35]

This works out overall, but it is not quite compatible with Oilpan stack
allocated objects to use pointers to collection wrapper objects.

You're not adding anything that wasn't here before (cf. line above), so could
you add a TODO:

 TODO(Oilpan): turn these optional heap vector objects into proper fields. 

[haraken, 2015/10/26 16:35:39]

yutak@: It would be better if the GC plugin can detect this error.

(BTW, as discussed offline with yutak@ a couple of weeks ago, I'm leaning toward
to replacing all Member<>s in stack-allocated objects to raw pointers.)

[xidachen, 2015/10/27 12:23:24]

Done.

     Vector<v8::Local<v8::Value>> m_arrayBuffers;
     uint32_t m_version;
 };
 
 } // namespace blink
 
 #endif // ScriptValueSerializer_h