summaryrefslogtreecommitdiff
path: root/indra/llui/llcommandmanager.cpp
blob: 03717da80baf866de88de7c229dd7da9a010e3de (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
/**
 * @file llcommandmanager.cpp
 * @brief LLCommandManager class
 *
 * $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$
 */

// A control that displays the name of the chosen item, which when
// clicked shows a scrolling box of options.

#include "linden_common.h"

#include "llcommandmanager.h"
#include "lldir.h"
#include "llerror.h"
#include "llxuiparser.h"


//
// LLCommandId class
//

const LLCommandId LLCommandId::null = LLCommandId("null command");

//
// LLCommand class
//

LLCommand::Params::Params()
    : available_in_toybox("available_in_toybox", false)
    , icon("icon")
    , label_ref("label_ref")
    , name("name")
    , tooltip_ref("tooltip_ref")
    , execute_function("execute_function")
    , execute_parameters("execute_parameters")
    , execute_stop_function("execute_stop_function")
    , execute_stop_parameters("execute_stop_parameters")
    , is_enabled_function("is_enabled_function")
    , is_enabled_parameters("is_enabled_parameters")
    , is_running_function("is_running_function")
    , is_running_parameters("is_running_parameters")
    , is_starting_function("is_starting_function")
    , is_starting_parameters("is_starting_parameters")
    , is_flashing_allowed("is_flashing_allowed", false)
{
}

LLCommand::LLCommand(const LLCommand::Params& p)
    : mIdentifier(p.name)
    , mAvailableInToybox(p.available_in_toybox)
    , mIcon(p.icon)
    , mLabelRef(p.label_ref)
    , mName(p.name)
    , mTooltipRef(p.tooltip_ref)
    , mExecuteFunction(p.execute_function)
    , mExecuteParameters(p.execute_parameters)
    , mExecuteStopFunction(p.execute_stop_function)
    , mExecuteStopParameters(p.execute_stop_parameters)
    , mIsEnabledFunction(p.is_enabled_function)
    , mIsEnabledParameters(p.is_enabled_parameters)
    , mIsRunningFunction(p.is_running_function)
    , mIsRunningParameters(p.is_running_parameters)
    , mIsStartingFunction(p.is_starting_function)
    , mIsStartingParameters(p.is_starting_parameters)
    , mIsFlashingAllowed(p.is_flashing_allowed)
{
}


//
// LLCommandManager class
//

LLCommandManager::LLCommandManager()
{
}

LLCommandManager::~LLCommandManager()
{
    for (CommandVector::iterator cmdIt = mCommands.begin(); cmdIt != mCommands.end(); ++cmdIt)
    {
        LLCommand * command = *cmdIt;

        delete command;
    }
}

U32 LLCommandManager::commandCount() const
{
    return static_cast<U32>(mCommands.size());
}

LLCommand * LLCommandManager::getCommand(U32 commandIndex)
{
    return mCommands[commandIndex];
}

LLCommand * LLCommandManager::getCommand(const LLCommandId& commandId)
{
    LLCommand * command_match = NULL;

    CommandIndexMap::const_iterator found = mCommandIndices.find(commandId.uuid());

    if (found != mCommandIndices.end())
    {
        command_match = mCommands[found->second];
    }

    return command_match;
}

LLCommand * LLCommandManager::getCommand(const std::string& name)
{
    LLCommand * command_match = NULL;

    CommandVector::const_iterator it = mCommands.begin();

    while (it != mCommands.end())
    {
        if ((*it)->name() == name)
        {
            command_match = *it;
            break;
        }
        it++;
    }

    return command_match;
}

void LLCommandManager::addCommand(LLCommand * command)
{
    LLCommandId command_id = command->id();
    mCommandIndices[command_id.uuid()] = mCommands.size();
    mCommands.push_back(command);

    LL_DEBUGS() << "Successfully added command: " << command->name() << LL_ENDL;
}

//static
bool LLCommandManager::load()
{
    LLCommandManager& mgr = LLCommandManager::instance();

    std::string commands_file = gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, "commands.xml");

    LLCommandManager::Params commandsParams;

    LLSimpleXUIParser parser;

    if (!parser.readXUI(commands_file, commandsParams))
    {
        LL_ERRS() << "Unable to load xml file: " << commands_file << LL_ENDL;
        return false;
    }

    if (!commandsParams.validateBlock())
    {
        LL_ERRS() << "Invalid commands file: " << commands_file << LL_ENDL;
        return false;
    }

    for (const LLCommand::Params& commandParams : commandsParams.commands)
    {
        LLCommand * command = new LLCommand(commandParams);

        mgr.addCommand(command);
    }

    return true;
}