1 // Implementation of the <property-list> widget.
3 // Copyright (C) 2001 Steve BAKER
4 // Copyright (C) 2001 Jim WILSON
5 // Copyright (C) 2006 Melchior FRANZ
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
28 #include <simgear/compiler.h>
32 typedef string stdString; // puObject has a "string" member
34 #include <Main/fg_os.hxx> // fgGetKeyModifiers()
35 #include <Main/fg_props.hxx>
37 #include "property_list.hxx"
40 static string getValueTypeString(const SGPropertyNode *node)
47 SGPropertyNode::Type type = node->getType();
48 if (type == SGPropertyNode::UNSPECIFIED)
49 result = "unspecified";
50 else if (type == SGPropertyNode::NONE)
52 else if (type == SGPropertyNode::BOOL)
54 else if (type == SGPropertyNode::INT)
56 else if (type == SGPropertyNode::LONG)
58 else if (type == SGPropertyNode::FLOAT)
60 else if (type == SGPropertyNode::DOUBLE)
62 else if (type == SGPropertyNode::STRING)
71 PropertyList::PropertyList(int minx, int miny, int maxx, int maxy, SGPropertyNode *start) :
72 puList(minx, miny, maxx, maxy, short(0), 20),
73 GUI_ID(FGCLASS_PROPERTYLIST),
75 _flags(fgGetNode("/sim/gui/dialogs/property-browser/show-flags", true)),
81 _list_box->setUserData(this);
82 _list_box->setCallback(handle_select);
83 _list_box->setValue(0);
88 PropertyList::~PropertyList()
94 void PropertyList::delete_arrays()
99 for (int i = 0; i < _num_entries; i++)
100 delete[] _entries[i];
109 void PropertyList::handle_select(puObject *list_box)
111 PropertyList *prop_list = (PropertyList *)list_box->getUserData();
112 int selected = list_box->getIntegerValue();
113 bool mod_ctrl = fgGetKeyModifiers() & KEYMOD_CTRL;
115 if (selected >= 0 && selected < prop_list->_num_entries) {
116 const char *src = prop_list->_entries[selected];
118 if (prop_list->dotFiles && (selected < 2)) {
119 if (!strcmp(src, ".")) {
121 prop_list->toggleFlags();
126 } else if (!strcmp(src, "..")) {
127 SGPropertyNode *parent = prop_list->getCurrent()->getParent();
130 for (; parent->getParent(); parent = parent->getParent())
132 prop_list->setCurrent(parent);
138 // we know we're dealing with a regular entry, so convert
139 // it to an index into children[]
140 if (prop_list->dotFiles)
143 SGPropertyNode_ptr child = prop_list->_children[selected].node;
146 // check if it's a directory
147 if (child->nChildren()) {
148 prop_list->setCurrent(child);
152 // it is a regular property
153 if (child->getType() == SGPropertyNode::BOOL && mod_ctrl) {
154 child->setBoolValue(!child->getBoolValue());
155 prop_list->update(true);
157 prop_list->publish(child);
160 // the user clicked on blank screen
161 prop_list->update(true);
166 void PropertyList::update(bool restore_pos)
171 _num_entries = (int)_curr->nChildren();
173 // instantiate string objects and add [.] and [..] for subdirs
174 if (!_curr->getParent()) {
175 _entries = new char*[_num_entries + 1];
180 _num_entries += 2; // for . and ..
181 _entries = new char*[_num_entries + 1];
183 _entries[0] = new char[2];
184 strcpy(_entries[0], ".");
186 _entries[1] = new char[3];
187 strcpy(_entries[1], "..");
194 _num_children = _curr->nChildren();
195 _children = new NodeData[_num_children];
196 for (i = 0; i < _num_children; i++)
197 _children[i].node = _curr->getChild(i);
199 qsort(_children, _num_children, sizeof(_children[0]), nodeNameCompare);
201 // Make lists of the children's names, values, etc.
202 for (i = 0; i < _num_children; i++, pi++) {
203 SGPropertyNode *child = _children[i].node;
205 if (child->nChildren() > 0) {
206 stdString name = stdString(child->getDisplayName(true)) + '/';
207 _entries[pi] = new char[name.size() + 1];
208 strcpy(_entries[pi], name.c_str());
211 _entries[pi] = 0; // ensure it's 0 before setting intial value
212 updateTextForEntry(i);
213 _children[i].setListener(this);
217 _entries[_num_entries] = 0;
219 int top = getTopItem();
226 void PropertyList::updateTextForEntry(int index)
228 assert((index >= 0) && (index < _num_children));
229 SGPropertyNode_ptr node = _children[index].node;
231 stdString name = node->getDisplayName(true);
232 stdString type = getValueTypeString(node);
233 stdString value = node->getStringValue();
235 stdString line = name + " = '" + value + "' (" + type;
237 if (_flags->getBoolValue()) {
239 if (!node->getAttribute(SGPropertyNode::READ))
241 if (!node->getAttribute(SGPropertyNode::WRITE))
243 if (node->getAttribute(SGPropertyNode::TRACE_READ))
245 if (node->getAttribute(SGPropertyNode::TRACE_WRITE))
247 if (node->getAttribute(SGPropertyNode::ARCHIVE))
249 if (node->getAttribute(SGPropertyNode::USERARCHIVE))
259 if (line.size() >= PUSTRING_MAX)
260 line.resize(PUSTRING_MAX - 1);
265 delete[] _entries[index];
266 _entries[index] = new char[line.size() + 1];
267 strcpy(_entries[index], line.c_str());
271 void PropertyList::valueChanged(SGPropertyNode *nd)
273 for (int i = 0; i < _num_children; i++)
274 if (_children[i].node == nd) {
275 updateTextForEntry(i);
281 int PropertyList::nodeNameCompare(const void *ppNode1, const void *ppNode2)
283 const SGPropertyNode_ptr pNode1 = (*(const NodeData *)ppNode1).node;
284 const SGPropertyNode_ptr pNode2 = (*(const NodeData *)ppNode2).node;
286 int diff = strcmp(pNode1->getName(), pNode2->getName());
287 return diff ? diff : pNode1->getIndex() - pNode2->getIndex();
291 void PropertyList::setValue(const char *s)
293 SGPropertyNode *p = fgGetNode(s, false);
297 throw stdString("node doesn't exist");
298 } catch (const stdString& m) {
299 SG_LOG(SG_GENERAL, SG_DEBUG, "property-list node `" << s << "': " << m);
303 void PropertyList::setCurrent(SGPropertyNode *p)
305 bool same = (_curr == p);