Initial implementation of bindings and basic classes for worklets.

third_party/WebKit/Source/bindings/core/v8/IsolatedScriptController.h

 /*
  * Copyright (C) 2009, 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 10 matching lines @@
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef WorkerScriptController_h
-#define WorkerScriptController_h
+#ifndef IsolatedScriptController_h
+#define IsolatedScriptController_h
 
 #include "bindings/core/v8/RejectedPromises.h"
 #include "bindings/core/v8/ScriptValue.h"
 #include "bindings/core/v8/V8Binding.h"
 #include "bindings/core/v8/V8CacheOptions.h"
 #include "core/CoreExport.h"
 #include "wtf/Allocator.h"
 #include "wtf/OwnPtr.h"
 #include "wtf/ThreadingPrimitives.h"
 #include "wtf/text/TextPosition.h"
 #include <v8.h>
 
 namespace blink {
 
 class CachedMetadataHandler;
 class ErrorEvent;
+class ExecutionContext;
 class ExceptionState;
 class ScriptSourceCode;
-class WorkerGlobalScope;
+class ScriptWrappable;
 
-class CORE_EXPORT WorkerScriptController : public NoBaseWillBeGarbageCollectedFinalized<WorkerScriptController> {
-    USING_FAST_MALLOC_WILL_BE_REMOVED(WorkerScriptController);
-    WTF_MAKE_NONCOPYABLE(WorkerScriptController);
+class CORE_EXPORT IsolatedScriptController : public NoBaseWillBeGarbageCollectedFinalized<IsolatedScriptController> {

[haraken, 2016/01/05 06:08:06]

I'd prefer GlobalScopeScriptController if kinuko-san and you are okay.

"Isolated" is confusing with the Isolate (a notion in V8) and the isolated world
(a notion in V8 bindings).

[kinuko, 2016/01/05 10:08:31]

I agree that isolated could be confusing while I also feel 'global scope' is
confusing too because we often say 'global scope' to mean window global scope in
contrast to 'worker global scope'.

Hmm... can we come up with a better common name for workers and worklets? 
WorkerOrWorkletScriptController?

[haraken, 2016/01/05 12:12:40]

WorkerOrWorkletScriptController sounds good.

Also it would be better to land the rename CL before (or after) landing this CL.
Then you can make this CL smaller.

[ikilpatrick, 2016/01/07 22:47:35]

Done.

+    USING_FAST_MALLOC_WILL_BE_REMOVED(IsolatedScriptController);
+    WTF_MAKE_NONCOPYABLE(IsolatedScriptController);
 public:
-    static PassOwnPtrWillBeRawPtr<WorkerScriptController> create(WorkerGlobalScope*, v8::Isolate*);
-    virtual ~WorkerScriptController();
+    static PassOwnPtrWillBeRawPtr<IsolatedScriptController> create(ExecutionContext*, ScriptWrappable*, v8::Isolate*);
+    virtual ~IsolatedScriptController();
     void dispose();
 
     bool isExecutionForbidden() const;
     bool isExecutionTerminating() const;
 
     // Returns true if the evaluation completed with no uncaught exception.
     bool evaluate(const ScriptSourceCode&, RefPtrWillBeRawPtr<ErrorEvent>* = nullptr, CachedMetadataHandler* = nullptr, V8CacheOptions = V8CacheOptionsDefault);
 
     // Prevents future JavaScript execution. See
     // willScheduleExecutionTermination, isExecutionForbidden.
     void forbidExecution();
 
     // Used by WorkerThread:
     bool initializeContextIfNeeded();
     // Async request to terminate future JavaScript execution on the
     // worker thread. JavaScript evaluation exits with a
-    // non-continuable exception and WorkerScriptController calls
+    // non-continuable exception and IsolatedScriptController calls
     // forbidExecution to prevent further JavaScript execution. Use
     // forbidExecution()/isExecutionForbidden() to guard against
     // reentry into JavaScript.
     void willScheduleExecutionTermination();
 
     // Used by WorkerGlobalScope:
     void rethrowExceptionFromImportedScript(PassRefPtrWillBeRawPtr<ErrorEvent>, ExceptionState&);
     void disableEval(const String&);
 
     // Used by Inspector agents:
     ScriptState* scriptState() { return m_scriptState.get(); }
 
     // Used by V8 bindings:
     v8::Local<v8::Context> context() { return m_scriptState ? m_scriptState->context() : v8::Local<v8::Context>(); }
 
     RejectedPromises* rejectedPromises() const { return m_rejectedPromises.get(); }
 
     DECLARE_TRACE();
 
     bool isContextInitialized() const { return m_scriptState && !!m_scriptState->perContextData(); }
 
 private:
-    WorkerScriptController(WorkerGlobalScope*, v8::Isolate*);
+    IsolatedScriptController(ExecutionContext*, ScriptWrappable*, v8::Isolate*);
     class ExecutionState;
 
-    v8::Isolate* isolate() const;
-
     // Evaluate a script file in the current execution environment.
     ScriptValue evaluate(const String& script, const String& fileName, const TextPosition& scriptStartPosition, CachedMetadataHandler*, V8CacheOptions);
 
-    RawPtrWillBeMember<WorkerGlobalScope> m_workerGlobalScope;
+    RawPtrWillBeMember<ExecutionContext> m_executionContext;

[haraken, 2016/01/05 06:08:06]

This is redundant. You can get the ExecutionContext by
m_scriptState->executionContext().

[ikilpatrick, 2016/01/07 22:47:35]

This is required before initializeContextIfNeeded is called (and scriptState
exists).

isExecutionForbidden() is called (which has an ASSERT to m_executionContext).

+    RawPtrWillBeMember<ScriptWrappable> m_scriptWrappable;

[haraken, 2016/01/05 06:08:06]

I'd rename this to m_globalScope.

Also I'd prefer introducing AbstractGlobalScope (as a parent class of
WorkerGlobalScope and WorkletGlobalScope) and use AbstractGlobalScope here.
ScriptWrappable is a base class of all DOM objects that have wrappers, which
sounds a bit too generic.

[kinuko, 2016/01/05 10:08:31]

I'd like to avoid deep inheritance while they share little.  If we do so I
prefer it being a specific, pure interface to be a client of this controller
class.  Would it work for you?

[haraken, 2016/01/05 12:12:40]

Or you can add two members:

  Member<WorkerGlobalScope> m_workerGlobalScope;
  Member<WorkletGlobalScope> m_workletGlobalScope;

[ikilpatrick, 2016/01/07 22:47:35]

Not sure that adding two members is good in this case. There would be two
private methods which do:
ExecutionContext* executionContext() { if (m_X) return m_X; if (m_Y) ... }
ScriptWrappable* scriptWrappable() { if (m_X) return m_X; if (m_Y) ... }
As there isn't a parent interface which shares these two super classes.

I can add back in a pure interface which just has a getter for ExecutionContext
& ScriptWrappable on it?

[haraken, 2016/01/08 04:59:07]

Yeah, I think it's better to introduce WorkerOrWorklet.

- We already have WorkerOrWorkletScriptController.
- Once we have WorkerOrWorklet, we can have toV8(WorkerOrWorklet*).

[ikilpatrick, 2016/01/11 04:13:19]

Added WorkerOrWorkletGlobalScope, @kinuko I've just added the minimum amount
possible, it's not a pure interface, (b/c otherwise bindings wouldn't work), but
just has the minimum amount.

+    v8::Isolate* m_isolate;

[haraken, 2016/01/05 06:08:06]

You can get the Isolate by m_scriptState->isolate().

[ikilpatrick, 2016/01/07 22:47:35]

This is actually needed before m_scriptState exists, see
initializeContextIfNeeded().

+
     RefPtr<ScriptState> m_scriptState;
     RefPtr<DOMWrapperWorld> m_world;
     String m_disableEvalPending;
     bool m_executionForbidden;
     bool m_executionScheduledToTerminate;
     mutable Mutex m_scheduledTerminationMutex;
 
     RefPtrWillBeMember<RejectedPromises> m_rejectedPromises;
 
     // |m_executionState| refers to a stack object that evaluate() allocates;
     // evaluate() ensuring that the pointer reference to it is removed upon
     // returning. Hence kept as a bare pointer here, and not a Persistent with
     // Oilpan enabled; stack scanning will visit the object and
     // trace its on-heap fields.
     GC_PLUGIN_IGNORE("394615")
     ExecutionState* m_executionState;
 };
 
 } // namespace blink
 
-#endif // WorkerScriptController_h
+#endif // IsolatedScriptController_h