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
|
/**
* @file lluilistener.cpp
* @author Nat Goodspeed
* @date 2009-08-18
* @brief Implementation for lluilistener.
*
* $LicenseInfo:firstyear=2009&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$
*/
// Precompiled header
#include "llviewerprecompiledheaders.h"
// associated header
#include "lluilistener.h"
// STL headers
// std headers
#include <sstream>
// external library headers
// other Linden headers
#include "llviewerwindow.h" // to get root view
#include "lluictrl.h"
#include "llerror.h"
LLUIListener::LLUIListener():
LLEventAPI("UI",
"LLUICtrl::CommitCallbackRegistry listener.\n"
"Capable of invoking any function (with parameter) you can specify in XUI.")
{
add("call",
"Invoke the operation named by [\"function\"], passing [\"parameter\"],\n"
"as if from a user gesture on a menu -- or a button click.",
&LLUIListener::call,
LLSD().with("function", LLSD()));
add("getValue",
"For the UI control identified by the path in [\"path\"], return the control's\n"
"current value as [\"value\"] reply.",
&LLUIListener::getValue,
LLSD().with("path", LLSD()));
}
void LLUIListener::call(const LLSD& event) const
{
LLUICtrl::commit_callback_t* func =
LLUICtrl::CommitCallbackRegistry::getValue(event["function"]);
if (! func)
{
// This API is intended for use by a script. It's a fire-and-forget
// API: we provide no reply. Therefore, a typo in the script will
// provide no feedback whatsoever to that script. To rub the coder's
// nose in such an error, crump rather than quietly ignoring it.
LL_ERRS("LLUIListener") << "function '" << event["function"] << "' not found" << LL_ENDL;
}
else
{
// Interestingly, view_listener_t::addMenu() (addCommit(),
// addEnable()) constructs a commit_callback_t callable that accepts
// two parameters but discards the first. Only the second is passed to
// handleEvent(). Therefore we feel completely safe passing NULL for
// the first parameter.
(*func)(NULL, event["parameter"]);
}
}
// Split string given a single character delimiter.
// Note that this returns empty strings for leading, trailing, and adjacent
// delimiters, such as "/foo/bar//baz/" -> ["", "foo", "bar", "", "baz", "" ]
std::vector<std::string> split(const std::string& s, char delim)
{
std::stringstream ss(s);
std::string item;
std::vector<std::string> items;
while (std::getline(ss, item, delim))
{
items.push_back(item);
}
return items;
}
// Walk the LLView tree to resolve a path
// Paths can be discovered using Develop > XUI > Show XUI Paths
//
// A leading "/" indicates the root of the tree is the starting
// position of the search, (otherwise the context node is used)
//
// Adjacent "//" mean that the next level of the search is done
// recursively ("descendant" rather than "child").
//
// Return values: If no match is found, NULL is returned,
// otherwise the matching LLView* is returned.
//
// Examples:
//
// "/" -> return the root view
// "/foo" -> find "foo" as a direct child of the root
// "foo" -> find "foo" as a direct child of the context node
// "//foo" -> find the first "foo" child anywhere in the tree
// "/foo/bar" -> find "foo" as direct child of the root, and
// "bar" as a direct child of "foo"
// "//foo//bar/baz" -> find the first "foo" anywhere in the
// tree, the first "bar" anywhere under it, and "baz"
// as a direct child of that
//
const LLView* resolve_path(const LLView* context, const std::string path)
{
std::vector<std::string> parts = split(path, '/');
if (parts.size() == 0)
{
return context;
}
std::vector<std::string>::iterator it = parts.begin();
// leading / means "start at root"
if ((*it).length() == 0)
{
context = (LLView*)(gViewerWindow->getRootView());
it++;
}
bool recurse = false;
for (; it != parts.end() && context; it++)
{
std::string part = *it;
if (part.length() == 0)
{
recurse = true;
}
else
{
const LLView* found = context->findChildView(part, recurse);
if (!found)
return NULL;
context = found;
recurse = false;
}
}
return context;
}
void LLUIListener::getValue(const LLSD&event) const
{
LLSD reply = LLSD::emptyMap();
const LLView* root = (LLView*)(gViewerWindow->getRootView());
const LLView* view = resolve_path(root, event["path"].asString());
const LLUICtrl* ctrl(dynamic_cast<const LLUICtrl*>(view));
if (ctrl)
{
reply["value"] = ctrl->getValue();
}
else
{
// *TODO: ??? return something indicating failure to resolve
}
sendReply(reply, event);
}
|
