summaryrefslogtreecommitdiff
path: root/indra/newview/llcallbacklist.cpp
blob: 2231d07c23701ff502012eb68ea75f394483204c (plain)
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
/**
 * @file llcallbacklist.cpp
 * @brief A simple list of callback functions to call.
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#include "llviewerprecompiledheaders.h"

#include "llcallbacklist.h"
#include "lleventtimer.h"

// Library includes
#include "llerror.h"


//
// Globals
//
LLCallbackList gIdleCallbacks;

//
// Member functions
//

LLCallbackList::LLCallbackList()
{
    // nothing
}

LLCallbackList::~LLCallbackList()
{
}


void LLCallbackList::addFunction( callback_t func, void *data)
{
    if (!func)
    {
        LL_ERRS() << "LLCallbackList::addFunction - function is NULL" << LL_ENDL;
        return;
    }

    // only add one callback per func/data pair
    callback_pair_t t(func, data);
    callback_list_t::iterator iter = std::find(mCallbackList.begin(), mCallbackList.end(), t);
    if (iter == mCallbackList.end())
    {
        mCallbackList.push_back(t);
    }
}


BOOL LLCallbackList::containsFunction( callback_t func, void *data)
{
    callback_pair_t t(func, data);
    callback_list_t::iterator iter = std::find(mCallbackList.begin(), mCallbackList.end(), t);
    if (iter != mCallbackList.end())
    {
        return TRUE;
    }
    else
    {
        return FALSE;
    }
}


BOOL LLCallbackList::deleteFunction( callback_t func, void *data)
{
    callback_pair_t t(func, data);
    callback_list_t::iterator iter = std::find(mCallbackList.begin(), mCallbackList.end(), t);
    if (iter != mCallbackList.end())
    {
        mCallbackList.erase(iter);
        return TRUE;
    }
    else
    {
        return FALSE;
    }
}


void LLCallbackList::deleteAllFunctions()
{
    mCallbackList.clear();
}


void LLCallbackList::callFunctions()
{
    for (callback_list_t::iterator iter = mCallbackList.begin(); iter != mCallbackList.end();  )
    {
        callback_list_t::iterator curiter = iter++;
        curiter->first(curiter->second);
    }
}

// Shim class to allow arbitrary boost::bind
// expressions to be run as one-time idle callbacks.
class OnIdleCallbackOneTime
{
public:
    OnIdleCallbackOneTime(nullary_func_t callable):
        mCallable(callable)
    {
    }
    static void onIdle(void *data)
    {
        gIdleCallbacks.deleteFunction(onIdle, data);
        OnIdleCallbackOneTime* self = reinterpret_cast<OnIdleCallbackOneTime*>(data);
        self->call();
        delete self;
    }
    void call()
    {
        mCallable();
    }
private:
    nullary_func_t mCallable;
};

void doOnIdleOneTime(nullary_func_t callable)
{
    OnIdleCallbackOneTime* cb_functor = new OnIdleCallbackOneTime(callable);
    gIdleCallbacks.addFunction(&OnIdleCallbackOneTime::onIdle,cb_functor);
}

// Shim class to allow generic boost functions to be run as
// recurring idle callbacks.  Callable should return true when done,
// false to continue getting called.
class OnIdleCallbackRepeating
{
public:
    OnIdleCallbackRepeating(bool_func_t callable):
        mCallable(callable)
    {
    }
    // Will keep getting called until the callable returns true.
    static void onIdle(void *data)
    {
        OnIdleCallbackRepeating* self = reinterpret_cast<OnIdleCallbackRepeating*>(data);
        bool done = self->call();
        if (done)
        {
            gIdleCallbacks.deleteFunction(onIdle, data);
            delete self;
        }
    }
    bool call()
    {
        return mCallable();
    }
private:
    bool_func_t mCallable;
};

void doOnIdleRepeating(bool_func_t callable)
{
    OnIdleCallbackRepeating* cb_functor = new OnIdleCallbackRepeating(callable);
    gIdleCallbacks.addFunction(&OnIdleCallbackRepeating::onIdle,cb_functor);
}

class NullaryFuncEventTimer: public LLEventTimer
{
public:
    NullaryFuncEventTimer(nullary_func_t callable, F32 seconds):
        LLEventTimer(seconds),
        mCallable(callable)
    {
    }

private:
    bool tick()
    {
        mCallable();
        return true;
    }

    nullary_func_t mCallable;
};

// Call a given callable once after specified interval.
void doAfterInterval(nullary_func_t callable, F32 seconds)
{
    new NullaryFuncEventTimer(callable, seconds);
}

class BoolFuncEventTimer: public LLEventTimer
{
public:
    BoolFuncEventTimer(bool_func_t callable, F32 seconds):
        LLEventTimer(seconds),
        mCallable(callable)
    {
    }
private:
    bool tick()
    {
        return mCallable();
    }

    bool_func_t mCallable;
};

// Call a given callable every specified number of seconds, until it returns true.
void doPeriodically(bool_func_t callable, F32 seconds)
{
    new BoolFuncEventTimer(callable, seconds);
}

#ifdef _DEBUG

void test1(void *data)
{
    S32 *s32_data = (S32 *)data;
    LL_INFOS() << "testfunc1 " << *s32_data << LL_ENDL;
}


void test2(void *data)
{
    S32 *s32_data = (S32 *)data;
    LL_INFOS() << "testfunc2 " << *s32_data << LL_ENDL;
}


void
LLCallbackList::test()
{
    S32 a = 1;
    S32 b = 2;
    LLCallbackList *list = new LLCallbackList;

    LL_INFOS() << "Testing LLCallbackList" << LL_ENDL;

    if (!list->deleteFunction(NULL))
    {
        LL_INFOS() << "passed 1" << LL_ENDL;
    }
    else
    {
        LL_INFOS() << "error, removed function from empty list" << LL_ENDL;
    }

    // LL_INFOS() << "This should crash" << LL_ENDL;
    // list->addFunction(NULL);

    list->addFunction(&test1, &a);
    list->addFunction(&test1, &a);

    LL_INFOS() << "Expect: test1 1, test1 1" << LL_ENDL;
    list->callFunctions();

    list->addFunction(&test1, &b);
    list->addFunction(&test2, &b);

    LL_INFOS() << "Expect: test1 1, test1 1, test1 2, test2 2" << LL_ENDL;
    list->callFunctions();

    if (list->deleteFunction(&test1, &b))
    {
        LL_INFOS() << "passed 3" << LL_ENDL;
    }
    else
    {
        LL_INFOS() << "error removing function" << LL_ENDL;
    }

    LL_INFOS() << "Expect: test1 1, test1 1, test2 2" << LL_ENDL;
    list->callFunctions();

    list->deleteAllFunctions();

    LL_INFOS() << "Expect nothing" << LL_ENDL;
    list->callFunctions();

    LL_INFOS() << "nothing :-)" << LL_ENDL;

    delete list;

    LL_INFOS() << "test complete" << LL_ENDL;
}

#endif  // _DEBUG