src/third_party/WebKit/Source/core/dom/ExecutionContextTask.h

   1 /*
   2  * Copyright (C) 2013 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  *     * Neither the name of Google Inc. nor the names of its
  11  * contributors may be used to endorse or promote products derived from
  12  * this software without specific prior written permission.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef ExecutionContextTask_h
  28 #define ExecutionContextTask_h
  29
  30 #include "wtf/FastAllocBase.h"
  31 #include "wtf/Functional.h"
  32 #include "wtf/Noncopyable.h"
  33 #include "wtf/PassOwnPtr.h"
  34 #include "wtf/text/WTFString.h"
  35
  36 namespace blink {
  37
  38 class ExecutionContext;
  39
  40 class ExecutionContextTask {
  41     WTF_MAKE_NONCOPYABLE(ExecutionContextTask);
  42     WTF_MAKE_FAST_ALLOCATED;
  43 public:
  44     ExecutionContextTask() { }
  45     virtual ~ExecutionContextTask() { }
  46     virtual void performTask(ExecutionContext*) = 0;
  47     // Certain tasks get marked specially so that they aren't discarded, and are executed, when the context is shutting down its message queue.
  48     virtual bool isCleanupTask() const { return false; }
  49     virtual String taskNameForInstrumentation() const { return String(); }
  50 };
  51
  52 class CallClosureTask final : public ExecutionContextTask {
  53 public:
  54     // Do not use |create| other than in createCrossThreadTask and
  55     // createSameThreadTask.
  56     // See http://crbug.com/390851
  57     static PassOwnPtr<CallClosureTask> create(const Closure& closure)
  58     {
  59         return adoptPtr(new CallClosureTask(closure));
  60     }
  61     virtual void performTask(ExecutionContext*) override { m_closure(); }
  62
  63 private:
  64     explicit CallClosureTask(const Closure& closure) : m_closure(closure) { }
  65     Closure m_closure;
  66 };
  67
  68 // Create tasks passed within a single thread.
  69 // When posting tasks within a thread, use |createSameThreadTask| instead
  70 // of using |bind| directly to state explicitly that there is no need to care
  71 // about thread safety when posting the task.
  72 // When posting tasks across threads, use |createCrossThreadTask|.
  73 template<typename FunctionType, typename... P>
  74 PassOwnPtr<ExecutionContextTask> createSameThreadTask(
  75     FunctionType function, const P&... parameters)
  76 {
  77     return CallClosureTask::create(bind(function, parameters...));
  78 }
  79
  80 } // namespace
  81
  82 #endif