summaryrefslogtreecommitdiff
path: root/indra/llui/llcommandmanager.h
blob: e6df0d3a4bf6044780e96c3395b9bf20a8daa6df (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
/**
 * @file llcommandmanager.h
 * @brief LLCommandManager class to hold commands
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2011, 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_LLCOMMANDMANAGER_H
#define LL_LLCOMMANDMANAGER_H

#include "llinitparam.h"
#include "llsingleton.h"


class LLCommand;
class LLCommandManager;


class LLCommandId
{
public:
    friend class LLCommand;
    friend class LLCommandManager;

    struct Params : public LLInitParam::Block<Params>
    {
        Mandatory<std::string> name;

        Params()
        :   name("name")
        {}
    };

    LLCommandId(const std::string& name)
    {
        mUUID = LLUUID::generateNewID(name);
    }

    LLCommandId(const Params& p)
    {
        mUUID = LLUUID::generateNewID(p.name);
    }

    LLCommandId(const LLUUID& uuid)
    :   mUUID(uuid)
    {}

    const LLUUID& uuid() const { return mUUID; }

    bool operator!=(const LLCommandId& command) const
    {
        return (mUUID != command.mUUID);
    }

    bool operator==(const LLCommandId& command) const
    {
        return (mUUID == command.mUUID);
    }

    static const LLCommandId null;

private:
    LLUUID      mUUID;
};

typedef std::list<LLCommandId> command_id_list_t;


class LLCommand
{
public:
    struct Params : public LLInitParam::Block<Params>
    {
        Mandatory<bool>         available_in_toybox;
        Mandatory<std::string>  icon;
        Mandatory<std::string>  label_ref;
        Mandatory<std::string>  name;
        Mandatory<std::string>  tooltip_ref;

        Mandatory<std::string>  execute_function;
        Optional<LLSD>          execute_parameters;

        Optional<std::string>   execute_stop_function;
        Optional<LLSD>          execute_stop_parameters;

        Optional<std::string>   is_enabled_function;
        Optional<LLSD>          is_enabled_parameters;

        Optional<std::string>   is_running_function;
        Optional<LLSD>          is_running_parameters;

        Optional<std::string>   is_starting_function;
        Optional<LLSD>          is_starting_parameters;

        Optional<bool>          is_flashing_allowed;

        Params();
    };

    LLCommand(const LLCommand::Params& p);

    const bool availableInToybox() const { return mAvailableInToybox; }
    const std::string& icon() const { return mIcon; }
    const LLCommandId& id() const { return mIdentifier; }
    const std::string& labelRef() const { return mLabelRef; }
    const std::string& name() const { return mName; }
    const std::string& tooltipRef() const { return mTooltipRef; }

    const std::string& executeFunctionName() const { return mExecuteFunction; }
    const LLSD& executeParameters() const { return mExecuteParameters; }

    const std::string& executeStopFunctionName() const { return mExecuteStopFunction; }
    const LLSD& executeStopParameters() const { return mExecuteStopParameters; }

    const std::string& isEnabledFunctionName() const { return mIsEnabledFunction; }
    const LLSD& isEnabledParameters() const { return mIsEnabledParameters; }

    const std::string& isRunningFunctionName() const { return mIsRunningFunction; }
    const LLSD& isRunningParameters() const { return mIsRunningParameters; }

    const std::string& isStartingFunctionName() const { return mIsStartingFunction; }
    const LLSD& isStartingParameters() const { return mIsStartingParameters; }

    bool isFlashingAllowed() const { return mIsFlashingAllowed; }

private:
    LLCommandId mIdentifier;

    bool        mAvailableInToybox;
    std::string mIcon;
    std::string mLabelRef;
    std::string mName;
    std::string mTooltipRef;

    std::string mExecuteFunction;
    LLSD        mExecuteParameters;

    std::string mExecuteStopFunction;
    LLSD        mExecuteStopParameters;

    std::string mIsEnabledFunction;
    LLSD        mIsEnabledParameters;

    std::string mIsRunningFunction;
    LLSD        mIsRunningParameters;

    std::string mIsStartingFunction;
    LLSD        mIsStartingParameters;

    bool        mIsFlashingAllowed;
};


class LLCommandManager
:   public LLSingleton<LLCommandManager>
{
    LLSINGLETON(LLCommandManager);
    ~LLCommandManager();

public:
    struct Params : public LLInitParam::Block<Params>
    {
        Multiple< LLCommand::Params, AtLeast<1> > commands;

        Params()
            :   commands("command")
        {
        }
    };

    U32 commandCount() const;
    LLCommand * getCommand(U32 commandIndex);
    LLCommand * getCommand(const LLCommandId& commandId);
    LLCommand * getCommand(const std::string& name);

    static bool load();

protected:
    void addCommand(LLCommand * command);

private:
    typedef std::map<LLUUID, size_t>    CommandIndexMap;
    typedef std::vector<LLCommand *>    CommandVector;

    CommandVector   mCommands;
    CommandIndexMap mCommandIndices;
};


#endif // LL_LLCOMMANDMANAGER_H