2 * Copyright (c) 2003-2005 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * 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 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Authors: Nathan Binkert
31 #ifndef __BASE_CALLBACK_HH__
32 #define __BASE_CALLBACK_HH__
38 * Generic callback class. This base class provides a virtual process
39 * function that gets called when the callback queue is processed.
44 friend class CallbackQueue;
45 virtual void autoDestruct() {}
49 * virtualize the destructor to make sure that the correct one
52 virtual ~Callback() {}
55 * virtual process function that is invoked when the callback
58 virtual void process() = 0;
61 /// Helper template class to turn a simple class member function into
63 template <class T, void (T::* F)()>
64 class MakeCallback : public Callback
68 const bool autoDestroy;
70 void autoDestruct() { if (autoDestroy) delete this; }
73 MakeCallback(T *o, bool auto_destroy = false)
74 : object(o), autoDestroy(auto_destroy)
77 MakeCallback(T &o, bool auto_destroy = false)
78 : object(&o), autoDestroy(auto_destroy)
81 void process() { (object->*F)(); }
88 * Simple typedef for the data structure that stores all of the
91 typedef std::list<Callback *> queue;
94 * List of all callbacks. To be called in fifo order.
100 std::string name() const { return "CallbackQueue"; }
103 * Add a callback to the end of the queue
104 * @param callback the callback to be added to the queue
107 add(Callback *callback)
109 callbacks.push_back(callback);
112 template <class T, void (T::* F)()>
116 add(new MakeCallback<T, F>(obj, true));
119 template <class T, void (T::* F)()>
123 add(new MakeCallback<T, F>(&obj, true));
127 * Find out if there are any callbacks in the queue
129 bool empty() const { return callbacks.empty(); }
132 * process all callbacks
137 queue::iterator i = callbacks.begin();
138 queue::iterator end = callbacks.end();
147 * clear the callback queue
156 #endif // __BASE_CALLBACK_HH__