summaryrefslogtreecommitdiff
path: root/indra/llui/llfunctorregistry.h
blob: da5570d922e49dc381ad595cdb7bb1dc6b2a4e27 (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
/**
 * @file llfunctorregistry.h
 * @author Kent Quirk
 * @brief Maintains a registry of named callback functors taking a single LLSD parameter
 *
 * $LicenseInfo:firstyear=2008&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$
 */

#ifndef LL_LLFUNCTORREGISTRY_H
#define LL_LLFUNCTORREGISTRY_H

#include <string>
#include <map>

#include <boost/function.hpp>

#include "llsd.h"
#include "llsingleton.h"

/**
 * @class LLFunctorRegistry
 * @brief Maintains a collection of named functors for remote binding
 * (mainly for use in callbacks from notifications and other signals)
 * @see LLNotifications
 *
 * This class maintains a collection of named functors in a singleton.
 * We wanted to be able to persist notifications with their callbacks
 * across restarts of the viewer; we couldn't store functors that way.
 * Using this registry, systems that require a functor to be maintained
 * long term can register it at system startup, and then pass in the
 * functor by name.
 */

template <typename FUNCTOR_TYPE>
class LLFunctorRegistry : public LLSingleton<LLFunctorRegistry<FUNCTOR_TYPE> >
{
    LLSINGLETON(LLFunctorRegistry);
    LOG_CLASS(LLFunctorRegistry);

public:
    typedef FUNCTOR_TYPE ResponseFunctor;
    typedef typename std::map<std::string, FUNCTOR_TYPE> FunctorMap;

    bool registerFunctor(const std::string& name, ResponseFunctor f)
    {
        bool retval = true;
        if (mMap.count(name) == 0)
        {
            mMap[name] = f;
        }
        else
        {
            LL_ERRS() << "attempt to store duplicate name '" << name << "' in LLFunctorRegistry. NOT ADDED." << LL_ENDL;
            retval = false;
        }

        return retval;
    }

    bool unregisterFunctor(const std::string& name)
    {
        if (mMap.count(name) == 0)
        {
            LL_WARNS() << "trying to remove '" << name << "' from LLFunctorRegistry but it's not there." << LL_ENDL;
            return false;
        }
        mMap.erase(name);
        return true;
    }

    FUNCTOR_TYPE getFunctor(const std::string& name)
    {
        if (mMap.count(name) != 0)
        {
            return mMap[name];
        }
        else
        {
            LL_DEBUGS() << "tried to find '" << name << "' in LLFunctorRegistry, but it wasn't there." << LL_ENDL;
            return mMap[LOGFUNCTOR];
        }
    }

    const std::string LOGFUNCTOR;
    const std::string DONOTHING;

private:

    static void log_functor(const LLSD& notification, const LLSD& payload)
    {
        LL_DEBUGS() << "log_functor called with payload: " << payload << LL_ENDL;
    }

    static void do_nothing(const LLSD& notification, const LLSD& payload)
    {
        // what the sign sez
    }

    FunctorMap mMap;
};

template <typename FUNCTOR_TYPE>
LLFunctorRegistry<FUNCTOR_TYPE>::LLFunctorRegistry() :
    LOGFUNCTOR("LogFunctor"), DONOTHING("DoNothing")
{
    mMap[LOGFUNCTOR] = log_functor;
    mMap[DONOTHING] = do_nothing;
}

template <typename FUNCTOR_TYPE>
class LLFunctorRegistration
{
public:
    LLFunctorRegistration(const std::string& name, FUNCTOR_TYPE functor)
    {
        LLFunctorRegistry<FUNCTOR_TYPE>::instance().registerFunctor(name, functor);
    }
};

#endif//LL_LLFUNCTORREGISTRY_H