Rename WebKitTools to Tools
[WebKit-https.git] / Tools / DumpRenderTree / chromium / Task.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 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  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef Task_h
32 #define Task_h
33
34 #include <wtf/Vector.h>
35
36 class TaskList;
37
38 // WebTask represents a task which can run by postTask() or postDelayedTask().
39 // it is named "WebTask", not "Task", to avoid conflist with base/task.h.
40 class WebTask {
41 public:
42     WebTask(TaskList*);
43     // The main code of this task.
44     // An implementation of run() should return immediately if cancel() was called.
45     virtual void run() = 0;
46     virtual void cancel() = 0;
47     virtual ~WebTask();
48 protected:
49     TaskList* m_taskList;
50 };
51
52 class TaskList {
53 public:
54     TaskList() {}
55     ~TaskList() { revokeAll(); }
56     void registerTask(WebTask* task) { m_tasks.append(task); }
57     void unregisterTask(WebTask* task);
58     void revokeAll();
59 private:
60     Vector<WebTask*> m_tasks;
61 };
62
63 // A task containing an object pointer of class T. Is is supposed that
64 // runifValid() calls a member function of the object pointer.
65 // Class T must have "TaskList* taskList()".
66 template<class T> class MethodTask: public WebTask {
67 public:
68     MethodTask(T* object): WebTask(object->taskList()), m_object(object) {}
69     virtual void run()
70     {
71         if (m_object)
72             runIfValid();
73     }
74     virtual void cancel()
75     {
76         m_object = 0;
77         m_taskList->unregisterTask(this);
78         m_taskList = 0;
79     }
80     virtual void runIfValid() = 0;
81 protected:
82     T* m_object;
83 };
84
85 void postTask(WebTask* task);
86 void postDelayedTask(WebTask* task, int64_t ms);
87
88 #endif // Task_h