1 // dialog.cxx: implementation of an XML-configurable dialog box.
3 #include <stdlib.h> // atof()
5 #include <Input/input.hxx>
11 #include "AirportList.hxx"
14 ////////////////////////////////////////////////////////////////////////
15 // Implementation of GUIInfo.
16 ////////////////////////////////////////////////////////////////////////
19 * User data for a GUI object.
23 GUIInfo (FGDialog * d);
27 vector <FGBinding *> bindings;
31 GUIInfo::GUIInfo (FGDialog * d)
39 for (unsigned int i = 0; i < bindings.size(); i++) {
49 int fgPopup::checkKey(int key, int updown)
51 if (updown == PU_UP || !isVisible() || !isActive() || window != puGetWindow())
54 puObject *input = getActiveInputField(this);
56 return input->checkKey(key, updown);
58 puObject *object = getKeyObject(this, key);
60 return puPopup::checkKey(key, updown);
62 // invokeCallback() isn't enough; we need to simulate a mouse button press
63 object->checkHit(PU_LEFT_BUTTON, PU_DOWN,
64 (object->getABox()->min[0] + object->getABox()->max[0]) / 2,
65 (object->getABox()->min[1] + object->getABox()->max[1]) / 2);
66 object->checkHit(PU_LEFT_BUTTON, PU_UP,
67 (object->getABox()->min[0] + object->getABox()->max[0]) / 2,
68 (object->getABox()->min[1] + object->getABox()->max[1]) / 2);
72 puObject *fgPopup::getKeyObject(puObject *object, int key)
75 if(object->getType() & PUCLASS_GROUP)
76 for (puObject *obj = ((puGroup *)object)->getFirstChild();
77 obj; obj = obj->getNextObject())
78 if ((ret = getKeyObject(obj, key)))
81 GUIInfo *info = (GUIInfo *)object->getUserData();
82 if (info && info->key == key)
88 puObject *fgPopup::getActiveInputField(puObject *object)
91 if(object->getType() & PUCLASS_GROUP)
92 for (puObject *obj = ((puGroup *)object)->getFirstChild();
93 obj; obj = obj->getNextObject())
94 if ((ret = getActiveInputField(obj)))
97 if (object->getType() & PUCLASS_INPUT && ((puInput *)object)->isAcceptingInput())
106 int fgPopup::checkHit(int button, int updown, int x, int y)
108 int result = puPopup::checkHit(button, updown, x, y);
113 // This is annoying. We would really want a true result from the
114 // superclass to indicate "handled by child object", but all it
115 // tells us is that the pointer is inside the dialog. So do the
116 // intersection test (again) to make sure we don't start a drag
117 // when inside controls.
119 if(updown == PU_DOWN && !_dragging) {
123 int hit = getHitObjects(this, x, y);
124 if(hit & (PUCLASS_BUTTON|PUCLASS_ONESHOT|PUCLASS_INPUT))
128 getPosition(&px, &py);
132 } else if(updown == PU_DRAG && _dragging) {
133 setPosition(x + _dX, y + _dY);
140 int fgPopup::getHitObjects(puObject *object, int x, int y)
143 if(object->getType() & PUCLASS_GROUP)
144 for (puObject *obj = ((puGroup *)object)->getFirstChild();
145 obj; obj = obj->getNextObject())
146 type |= getHitObjects(obj, x, y);
149 object->getAbsolutePosition(&cx, &cy);
150 object->getSize(&cw, &ch);
151 if(x >= cx && x < cx + cw && y >= cy && y < cy + ch)
152 type |= object->getType();
158 ////////////////////////////////////////////////////////////////////////
160 ////////////////////////////////////////////////////////////////////////
166 action_callback (puObject * object)
168 GUIInfo * info = (GUIInfo *)object->getUserData();
169 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
170 gui->setActiveDialog(info->dialog);
171 int nBindings = info->bindings.size();
172 for (int i = 0; i < nBindings; i++) {
173 info->bindings[i]->fire();
174 if (gui->getActiveDialog() == 0)
177 gui->setActiveDialog(0);
182 format_callback(puObject *obj, int dx, int dy, void *n)
184 SGPropertyNode *node = (SGPropertyNode *)n;
185 const char *format = node->getStringValue("format"), *f = format;
186 bool number, l = false;
187 // make sure the format matches '[ -+#]?\d*(\.\d*)?l?[fs]'
198 if (*f == ' ' || *f == '+' || *f == '-' || *f == '#')
200 while (*f && isdigit(*f))
204 while (*f && isdigit(*f))
212 else if (*f == 's') {
229 const char *src = obj->getLabel();
232 float value = atof(src);
233 snprintf(buf, 256, format, value);
235 snprintf(buf, 256, format, src);
240 SGPropertyNode *result = node->getNode("formatted", true);
241 result->setStringValue(buf);
242 obj->setLabel(result->getStringValue());
247 ////////////////////////////////////////////////////////////////////////
248 // Static helper functions.
249 ////////////////////////////////////////////////////////////////////////
252 * Copy a property value to a PUI object.
255 copy_to_pui (SGPropertyNode * node, puObject * object)
257 // Treat puText objects specially, so their "values" can be set
259 if(object->getType() & PUCLASS_TEXT) {
260 object->setLabel(node->getStringValue());
264 switch (node->getType()) {
265 case SGPropertyNode::BOOL:
266 case SGPropertyNode::INT:
267 case SGPropertyNode::LONG:
268 object->setValue(node->getIntValue());
270 case SGPropertyNode::FLOAT:
271 case SGPropertyNode::DOUBLE:
272 object->setValue(node->getFloatValue());
275 object->setValue(node->getStringValue());
282 copy_from_pui (puObject * object, SGPropertyNode * node)
284 // puText objects are immutable, so should not be copied out
285 if(object->getType() & PUCLASS_TEXT)
288 switch (node->getType()) {
289 case SGPropertyNode::BOOL:
290 case SGPropertyNode::INT:
291 case SGPropertyNode::LONG:
292 node->setIntValue(object->getIntegerValue());
294 case SGPropertyNode::FLOAT:
295 case SGPropertyNode::DOUBLE:
296 node->setFloatValue(object->getFloatValue());
299 // Special case to handle lists, as getStringValue cannot be overridden
300 if(object->getType() & PUCLASS_LIST)
302 node->setStringValue(((puList *) object)->getListStringValue());
306 node->setStringValue(object->getStringValue());
314 ////////////////////////////////////////////////////////////////////////
315 // Implementation of FGDialog.
316 ////////////////////////////////////////////////////////////////////////
318 FGDialog::FGDialog (SGPropertyNode * props)
320 _gui((NewGUI *)globals->get_subsystem("gui")),
326 FGDialog::~FGDialog ()
329 _object->getAbsolutePosition(&x, &y);
330 _props->setIntValue("lastx", x);
331 _props->setIntValue("lasty", y);
332 puDeleteObject(_object);
336 // Delete all the arrays we made
337 // and were forced to keep around
338 // because PUI won't do its own
339 // memory management.
340 for (i = 0; i < _char_arrays.size(); i++) {
341 for (int j = 0; _char_arrays[i][j] != 0; j++)
342 free(_char_arrays[i][j]); // added with strdup
343 delete[] _char_arrays[i];
346 // Delete all the info objects we
347 // were forced to keep around because
348 // PUI cannot delete its own user data.
349 for (i = 0; i < _info.size(); i++) {
350 delete (GUIInfo *)_info[i];
354 // Finally, delete the property links.
355 for (i = 0; i < _propertyObjects.size(); i++) {
356 delete _propertyObjects[i];
357 _propertyObjects[i] = 0;
362 FGDialog::updateValue (const char * objectName)
364 for (unsigned int i = 0; i < _propertyObjects.size(); i++) {
365 const string &name = _propertyObjects[i]->name;
366 if (name == objectName)
367 copy_to_pui(_propertyObjects[i]->node,
368 _propertyObjects[i]->object);
373 FGDialog::applyValue (const char * objectName)
375 for (unsigned int i = 0; i < _propertyObjects.size(); i++) {
376 if (_propertyObjects[i]->name == objectName)
377 copy_from_pui(_propertyObjects[i]->object,
378 _propertyObjects[i]->node);
383 FGDialog::updateValues ()
385 for (unsigned int i = 0; i < _propertyObjects.size(); i++)
386 copy_to_pui(_propertyObjects[i]->node, _propertyObjects[i]->object);
390 FGDialog::applyValues ()
392 for (unsigned int i = 0; i < _propertyObjects.size(); i++)
393 copy_from_pui(_propertyObjects[i]->object,
394 _propertyObjects[i]->node);
400 for (unsigned int i = 0; i < _liveObjects.size(); i++) {
401 puObject *obj = _liveObjects[i]->object;
402 if (obj->getType() & PUCLASS_INPUT && ((puInput *)obj)->isAcceptingInput())
405 copy_to_pui(_liveObjects[i]->node, obj);
410 FGDialog::display (SGPropertyNode * props)
413 SG_LOG(SG_GENERAL, SG_ALERT, "This widget is already active");
417 int screenw = globals->get_props()->getIntValue("/sim/startup/xsize");
418 int screenh = globals->get_props()->getIntValue("/sim/startup/ysize");
420 bool userx = props->hasValue("x");
421 bool usery = props->hasValue("y");
422 bool userw = props->hasValue("width");
423 bool userh = props->hasValue("height");
425 // Let the layout widget work in the same property subtree.
426 LayoutWidget wid(props);
428 SGPropertyNode *fontnode = props->getNode("font");
430 FGFontCache *fc = _gui->get_fontcache();
431 _font = fc->get(fontnode);
433 _font = _gui->getDefaultFont();
435 wid.setDefaultFont(_font, int(_font->getPointSize()));
438 int px, py, savex, savey;
440 wid.calcPrefSize(&pw, &ph);
441 pw = props->getIntValue("width", pw);
442 ph = props->getIntValue("height", ph);
443 px = savex = props->getIntValue("x", (screenw - pw) / 2);
444 py = savey = props->getIntValue("y", (screenh - ph) / 2);
446 // Negative x/y coordinates are interpreted as distance from the top/right
447 // corner rather than bottom/left.
449 px = screenw - pw + px;
451 py = screenh - ph + py;
453 // Define "x", "y", "width" and/or "height" in the property tree if they
454 // are not specified in the configuration file.
455 wid.layout(px, py, pw, ph);
457 // Use the dimension and location properties as specified in the
458 // configuration file or from the layout widget.
459 _object = makeObject(props, screenw, screenh);
461 // Remove automatically generated properties, so the layout looks
462 // the same next time around, or restore x and y to preserve negative coords.
464 props->setIntValue("x", savex);
466 props->removeChild("x");
469 props->setIntValue("y", savey);
471 props->removeChild("y");
473 if(!userw) props->removeChild("width");
474 if(!userh) props->removeChild("height");
479 SG_LOG(SG_GENERAL, SG_ALERT, "Widget "
480 << props->getStringValue("name", "[unnamed]")
481 << " does not contain a proper GUI definition");
486 FGDialog::makeObject (SGPropertyNode * props, int parentWidth, int parentHeight)
488 if (props->getBoolValue("hide"))
491 bool presetSize = props->hasValue("width") && props->hasValue("height");
492 int width = props->getIntValue("width", parentWidth);
493 int height = props->getIntValue("height", parentHeight);
494 int x = props->getIntValue("x", (parentWidth - width) / 2);
495 int y = props->getIntValue("y", (parentHeight - height) / 2);
496 string type = props->getName();
501 if (type == "dialog") {
503 bool draggable = props->getBoolValue("draggable", true);
504 if (props->getBoolValue("modal", false))
505 obj = new puDialogBox(x, y);
507 obj = new fgPopup(x, y, draggable);
508 setupGroup(obj, props, width, height, true);
509 setColor(obj, props);
512 } else if (type == "group") {
513 puGroup * obj = new puGroup(x, y);
514 setupGroup(obj, props, width, height, false);
515 setColor(obj, props);
518 } else if (type == "frame") {
519 puGroup * obj = new puGroup(x, y);
520 setupGroup(obj, props, width, height, true);
521 setColor(obj, props);
524 } else if (type == "hrule" || type == "vrule") {
525 puFrame * obj = new puFrame(x, y, x + width, y + height);
526 obj->setBorderThickness(0);
527 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
530 } else if (type == "list") {
531 vector<SGPropertyNode_ptr> value_nodes = props->getChildren("value");
532 char ** entries = make_char_array(value_nodes.size());
533 for (unsigned int i = 0; i < value_nodes.size(); i++)
534 entries[i] = strdup((char *)value_nodes[i]->getStringValue());
536 puList * obj = new puList(x, y, x + width, y + height, entries);
537 setupObject(obj, props);
538 setColor(obj, props);
541 } else if (type == "airport-list") {
542 AirportList * obj = new AirportList(x, y, x + width, y + height);
543 setupObject(obj, props);
544 setColor(obj, props);
547 } else if (type == "input") {
548 puInput * obj = new puInput(x, y, x + width, y + height);
549 setupObject(obj, props);
550 setColor(obj, props, FOREGROUND|LABEL);
553 } else if (type == "text") {
554 puText * obj = new puText(x, y);
555 setupObject(obj, props);
557 if (props->getNode("format")) {
558 SGPropertyNode *live = props->getNode("live");
559 if (live && live->getBoolValue())
560 obj->setRenderCallback(format_callback, props);
562 format_callback(obj, x, y, props);
564 // Layed-out objects need their size set, and non-layout ones
565 // get a different placement.
566 if(presetSize) obj->setSize(width, height);
567 else obj->setLabelPlace(PUPLACE_LABEL_DEFAULT);
568 setColor(obj, props, LABEL);
571 } else if (type == "checkbox") {
573 obj = new puButton(x, y, x + width, y + height, PUBUTTON_XCHECK);
574 setupObject(obj, props);
575 setColor(obj, props, FOREGROUND|LABEL);
578 } else if (type == "radio") {
580 obj = new puButton(x, y, x + width, y + height, PUBUTTON_CIRCLE);
581 setupObject(obj, props);
582 setColor(obj, props, FOREGROUND|LABEL);
585 } else if (type == "button") {
587 const char * legend = props->getStringValue("legend", "[none]");
588 if (props->getBoolValue("one-shot", true))
589 obj = new puOneShot(x, y, legend);
591 obj = new puButton(x, y, legend);
593 obj->setSize(width, height);
594 setupObject(obj, props);
595 setColor(obj, props);
598 } else if (type == "combo") {
599 vector<SGPropertyNode_ptr> value_nodes = props->getChildren("value");
600 char ** entries = make_char_array(value_nodes.size());
601 for (unsigned int i = 0; i < value_nodes.size(); i++)
602 entries[i] = strdup((char *)value_nodes[i]->getStringValue());
604 puComboBox * obj = new puComboBox(x, y, x + width, y + height, entries,
605 props->getBoolValue("editable", false));
606 setupObject(obj, props);
607 #ifdef PUCOL_EDITFIELD // plib > 0.8.4
608 setColor(obj, props, EDITFIELD);
610 setColor(obj, props, FOREGROUND|LABEL);
614 } else if (type == "slider") {
615 bool vertical = props->getBoolValue("vertical", false);
616 puSlider * obj = new puSlider(x, y, (vertical ? height : width));
617 obj->setMinValue(props->getFloatValue("min", 0.0));
618 obj->setMaxValue(props->getFloatValue("max", 1.0));
619 setupObject(obj, props);
621 obj->setSize(width, height);
622 setColor(obj, props, FOREGROUND|LABEL);
625 } else if (type == "dial") {
626 puDial * obj = new puDial(x, y, width);
627 obj->setMinValue(props->getFloatValue("min", 0.0));
628 obj->setMaxValue(props->getFloatValue("max", 1.0));
629 obj->setWrap(props->getBoolValue("wrap", true));
630 setupObject(obj, props);
631 setColor(obj, props, FOREGROUND|LABEL);
634 } else if (type == "textbox") {
635 int slider_width = props->getIntValue("slider", parentHeight);
636 int wrap = props->getBoolValue("wrap", true);
637 if (slider_width==0) slider_width=20;
638 puLargeInput * obj = new puLargeInput(x, y,
639 x+width, x+height, 2, slider_width, wrap);
641 if (props->hasValue("editable")) {
642 if (props->getBoolValue("editable")==false)
647 setupObject(obj, props);
648 setColor(obj, props, FOREGROUND|LABEL);
651 } else if (type == "select") {
652 vector<SGPropertyNode_ptr> value_nodes;
653 SGPropertyNode * selection_node =
654 fgGetNode(props->getChild("selection")->getStringValue(), true);
656 for (int q = 0; q < selection_node->nChildren(); q++)
657 value_nodes.push_back(selection_node->getChild(q));
659 char ** entries = make_char_array(value_nodes.size());
660 for (unsigned int i = 0; i < value_nodes.size(); i++)
661 entries[i] = strdup((char *)value_nodes[i]->getName());
664 new puSelectBox(x, y, x + width, y + height, entries);
665 setupObject(obj, props);
666 #ifdef PUCOL_EDITFIELD // plib > 0.8.4
667 setColor(obj, props, EDITFIELD);
669 setColor(obj, props, FOREGROUND|LABEL);
678 FGDialog::setupObject (puObject * object, SGPropertyNode * props)
680 object->setLabelPlace(PUPLACE_CENTERED_RIGHT);
682 if (props->hasValue("legend"))
683 object->setLegend(props->getStringValue("legend"));
685 if (props->hasValue("label"))
686 object->setLabel(props->getStringValue("label"));
688 if (props->hasValue("border"))
689 object->setBorderThickness( props->getIntValue("border", 2) );
691 if ( SGPropertyNode *nft = props->getNode("font", false) ) {
692 FGFontCache *fc = _gui->get_fontcache();
693 puFont *lfnt = fc->get(nft);
694 object->setLabelFont(*lfnt);
696 object->setLabelFont(*_font);
699 if (props->hasValue("property")) {
700 const char * name = props->getStringValue("name");
703 const char * propname = props->getStringValue("property");
704 SGPropertyNode_ptr node = fgGetNode(propname, true);
705 copy_to_pui(node, object);
706 PropertyObject* po = new PropertyObject(name, object, node);
707 _propertyObjects.push_back(po);
708 if(props->getBoolValue("live"))
709 _liveObjects.push_back(po);
712 SGPropertyNode * dest = fgGetNode("/sim/bindings/gui", true);
713 vector<SGPropertyNode_ptr> bindings = props->getChildren("binding");
714 if (bindings.size() > 0) {
715 GUIInfo * info = new GUIInfo(this);
716 info->key = props->getIntValue("keynum", -1);
717 if (props->hasValue("key"))
718 info->key = getKeyCode(props->getStringValue("key", ""));
720 for (unsigned int i = 0; i < bindings.size(); i++) {
722 SGPropertyNode *binding;
723 while (dest->getChild("binding", j))
726 binding = dest->getChild("binding", j, true);
727 copyProperties(bindings[i], binding);
728 info->bindings.push_back(new FGBinding(binding));
730 object->setCallback(action_callback);
731 object->setUserData(info);
732 _info.push_back(info);
735 object->makeReturnDefault(props->getBoolValue("default"));
739 FGDialog::setupGroup (puGroup * group, SGPropertyNode * props,
740 int width, int height, bool makeFrame)
742 setupObject(group, props);
745 puFrame* f = new puFrame(0, 0, width, height);
749 int nChildren = props->nChildren();
750 for (int i = 0; i < nChildren; i++)
751 makeObject(props->getChild(i), width, height);
756 FGDialog::setColor(puObject * object, SGPropertyNode * props, int which)
758 string type = props->getName();
761 if (type == "textbox" && props->getBoolValue("editable"))
764 FGColor *c = new FGColor(_gui->getColor("background"));
765 c->merge(_gui->getColor(type));
766 c->merge(props->getNode("color"));
768 object->setColourScheme(c->red(), c->green(), c->blue(), c->alpha());
776 { BACKGROUND, PUCOL_BACKGROUND, "background", "color-background" },
777 { FOREGROUND, PUCOL_FOREGROUND, "foreground", "color-foreground" },
778 { HIGHLIGHT, PUCOL_HIGHLIGHT, "highlight", "color-highlight" },
779 { LABEL, PUCOL_LABEL, "label", "color-label" },
780 { LEGEND, PUCOL_LEGEND, "legend", "color-legend" },
781 { MISC, PUCOL_MISC, "misc", "color-misc" },
782 #ifdef PUCOL_EDITFIELD // plib > 0.8.4
783 { EDITFIELD, PUCOL_EDITFIELD, "editfield", "color-editfield" },
787 const int numcol = sizeof(pucol) / sizeof(pucol[0]);
789 for (int i = 0; i < numcol; i++) {
794 dirty |= c->merge(_gui->getColor(type + '-' + pucol[i].name));
795 if (which & pucol[i].mask)
796 dirty |= c->merge(props->getNode("color"));
798 if ((pucol[i].mask == LABEL) && !c->isValid())
799 dirty |= c->merge(_gui->getColor("label"));
801 if (c->isValid() && dirty)
802 object->setColor(pucol[i].id, c->red(), c->green(), c->blue(), c->alpha());
833 {"left", PU_KEY_LEFT},
835 {"right", PU_KEY_RIGHT},
836 {"down", PU_KEY_DOWN},
837 {"pageup", PU_KEY_PAGE_UP},
838 {"pagedn", PU_KEY_PAGE_DOWN},
839 {"home", PU_KEY_HOME},
841 {"insert", PU_KEY_INSERT},
846 FGDialog::getKeyCode(const char *str)
857 char *buf = new char[strlen(str) + 1];
859 char *s = buf + strlen(buf);
860 while (s > str && s[-1] == ' ')
867 if (!strncmp(s, "Ctrl-", 5) || !strncmp(s, "CTRL-", 5))
869 else if (!strncmp(s, "Shift-", 6) || !strncmp(s, "SHIFT-", 6))
870 s += 6, mod |= SHIFT;
871 else if (!strncmp(s, "Alt-", 4) || !strncmp(s, "ALT-", 4))
878 if (strlen(s) == 1 && isascii(*s)) {
883 key = toupper(key) - 64;
885 ; // Alt not propagated to the gui
887 for (char *t = s; *t; t++)
889 for (int i = 0; keymap[i].name; i++) {
890 if (!strcmp(s, keymap[i].name)) {
901 FGDialog::make_char_array (int size)
903 char ** list = new char*[size+1];
904 for (int i = 0; i <= size; i++)
906 _char_arrays.push_back(list);
912 ////////////////////////////////////////////////////////////////////////
913 // Implementation of FGDialog::PropertyObject.
914 ////////////////////////////////////////////////////////////////////////
916 FGDialog::PropertyObject::PropertyObject (const char * n,
918 SGPropertyNode_ptr p)