File: CallbackList.h

package info (click to toggle)
bzflag 2.4.30-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 26,488 kB
  • sloc: cpp: 150,376; ansic: 3,463; sh: 2,535; makefile: 2,194; perl: 486; python: 260; objc: 246; php: 206
file content (139 lines) | stat: -rw-r--r-- 3,802 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/* bzflag
 * Copyright (c) 1993-2025 Tim Riker
 *
 * This package is free software;  you can redistribute it and/or
 * modify it under the terms of the license found in the file
 * named COPYING that should have accompanied this file.
 *
 * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 */

#ifndef BZF_CALLBACK_LIST_H
#define BZF_CALLBACK_LIST_H

// 1st
#include "common.h"

// system headers
#include <utility>
#include <list>
#include <map>

template <class F>
class CallbackList
{
public:
    typedef bool (*Callback)(F, void* userData, void* iterateUserData);

    CallbackList();
    ~CallbackList();

    // add/remove callback.  adding an existing callback has no effect.
    void              add(F func, void* userData);
    void              remove(F func, void* userData);

    // iterate over callbacks.  this is done by invoking the given
    // callback function for each stored callback.  it is safe to
    // add and remove callbacks during iteration.  stops iterating
    // if the callback returns false.
    void              iterate(Callback, void* userData) const;

private:
    void              doIterate(Callback, void* userData);

private:
    typedef std::pair<F, void*> Item;
    typedef std::list<Item> ItemList;
    typedef std::map<Item, typename ItemList::iterator> ItemMap;

    ItemList          items;
    ItemMap           itemMap;
};

//
// CallbackList
//

template <class F>
CallbackList<F>::CallbackList()
{
    // do nothing
}

template <class F>
CallbackList<F>::~CallbackList()
{
    // do nothing
}

template <class F>
void            CallbackList<F>::add(F callback, void* userData)
{
    Item item = std::make_pair(callback, userData);
    if (itemMap.find(item) == itemMap.end())
    {
        typename ItemList::iterator index = items.insert(items.end(), item);
        itemMap.insert(std::make_pair(item, index));
    }
}

template <class F>
void            CallbackList<F>::remove(F callback, void* userData)
{
    Item item = std::make_pair(callback, userData);
    typename ItemMap::iterator index = itemMap.find(item);
    if (index != itemMap.end())
    {
        items.erase(index->second);
        itemMap.erase(index);
    }
}

template <class F>
void            CallbackList<F>::iterate(Callback callback,
        void* userData) const
{
    const_cast<CallbackList<F>*>(this)->doIterate(callback, userData);
}

template <class F>
void            CallbackList<F>::doIterate(Callback callback,
        void* userData)
{
    // insert a dummy item into the list.  this is our safe harbor
    // in case the list is modified while we're iterating over it.
    // the dummy item will remain no matter what other changes
    // occur to the list.  as we invoke each callback we move the
    // dummy item forward.
    Item dummyItem = std::make_pair((F)NULL, (void*)NULL);
    typename ItemList::iterator dummyIndex = items.insert(items.begin(), dummyItem);

    // now invoke each callback
    typename ItemList::iterator index = dummyIndex;
    for (; ++index != items.end(); index = dummyIndex)
    {
        // move dummy past the item we're about to invoke
        items.splice(dummyIndex, items, index);

        // invoke callback.  skip dummy items (any item with a NULL function).
        // stop if a callback returns false.
        if (index->first != NULL)
            if (!callback(index->first, index->second, userData))
                break;
    }

    // now remove the dummy item
    items.erase(dummyIndex);
}

#endif

// Local Variables: ***
// mode: C++ ***
// tab-width: 4 ***
// c-basic-offset: 4 ***
// indent-tabs-mode: nil ***
// End: ***
// ex: shiftwidth=4 tabstop=4