src/third_party/WebKit/Source/core/dom/ScriptRunner.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
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef ScriptRunner_h
  27 #define ScriptRunner_h
  28
  29 #include "core/fetch/ResourcePtr.h"
  30 #include "platform/Timer.h"
  31 #include "platform/heap/Handle.h"
  32 #include "wtf/HashMap.h"
  33 #include "wtf/Noncopyable.h"
  34 #include "wtf/PassOwnPtr.h"
  35 #include "wtf/Vector.h"
  36
  37 namespace blink {
  38
  39 class ScriptResource;
  40 class Document;
  41 class PendingScript;
  42 class ScriptLoader;
  43
  44 class ScriptRunner FINAL : public NoBaseWillBeGarbageCollectedFinalized<ScriptRunner> {
  45     WTF_MAKE_NONCOPYABLE(ScriptRunner); WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED;
  46 public:
  47     static PassOwnPtrWillBeRawPtr<ScriptRunner> create(Document* document)
  48     {
  49         return adoptPtrWillBeNoop(new ScriptRunner(document));
  50     }
  51     ~ScriptRunner();
  52
  53     enum ExecutionType { ASYNC_EXECUTION, IN_ORDER_EXECUTION };
  54     void queueScriptForExecution(ScriptLoader*, ResourcePtr<ScriptResource>, ExecutionType);
  55     bool hasPendingScripts() const { return !m_scriptsToExecuteSoon.isEmpty() || !m_scriptsToExecuteInOrder.isEmpty() || !m_pendingAsyncScripts.isEmpty(); }
  56     void suspend();
  57     void resume();
  58     void notifyScriptReady(ScriptLoader*, ExecutionType);
  59     void notifyScriptLoadError(ScriptLoader*, ExecutionType);
  60
  61     void trace(Visitor*);
  62
  63 private:
  64     explicit ScriptRunner(Document*);
  65
  66     void timerFired(Timer<ScriptRunner>*);
  67
  68     RawPtrWillBeMember<Document> m_document;
  69     // FIXME: Oilpan: consider using heap vectors and hash map here;
  70     // PendingScript does have a (trivial) destructor, however.
  71     Vector<PendingScript> m_scriptsToExecuteInOrder;
  72     Vector<PendingScript> m_scriptsToExecuteSoon; // http://www.whatwg.org/specs/web-apps/current-work/#set-of-scripts-that-will-execute-as-soon-as-possible
  73     WillBeHeapHashMap<ScriptLoader*, PendingScript> m_pendingAsyncScripts;
  74     Timer<ScriptRunner> m_timer;
  75 };
  76
  77 }
  78
  79 #endif