1 // dialog.cxx: implementation of an XML-configurable dialog box.
7 #include <stdlib.h> // atof()
9 #include <Input/input.hxx>
10 #include <Scripting/NasalSys.hxx>
13 #include "new_gui.hxx"
16 #include "AirportList.hxx"
19 ////////////////////////////////////////////////////////////////////////
20 // Implementation of GUIInfo.
21 ////////////////////////////////////////////////////////////////////////
24 * User data for a GUI object.
28 GUIInfo (FGDialog * d);
32 vector <FGBinding *> bindings;
36 GUIInfo::GUIInfo (FGDialog * d)
44 for (unsigned int i = 0; i < bindings.size(); i++) {
54 int fgPopup::checkKey(int key, int updown)
56 if (updown == PU_UP || !isVisible() || !isActive() || window != puGetWindow())
59 puObject *input = getActiveInputField(this);
61 return input->checkKey(key, updown);
63 puObject *object = getKeyObject(this, key);
65 return puPopup::checkKey(key, updown);
67 // invokeCallback() isn't enough; we need to simulate a mouse button press
68 object->checkHit(PU_LEFT_BUTTON, PU_DOWN,
69 (object->getABox()->min[0] + object->getABox()->max[0]) / 2,
70 (object->getABox()->min[1] + object->getABox()->max[1]) / 2);
71 object->checkHit(PU_LEFT_BUTTON, PU_UP,
72 (object->getABox()->min[0] + object->getABox()->max[0]) / 2,
73 (object->getABox()->min[1] + object->getABox()->max[1]) / 2);
77 puObject *fgPopup::getKeyObject(puObject *object, int key)
80 if(object->getType() & PUCLASS_GROUP)
81 for (puObject *obj = ((puGroup *)object)->getFirstChild();
82 obj; obj = obj->getNextObject())
83 if ((ret = getKeyObject(obj, key)))
86 GUIInfo *info = (GUIInfo *)object->getUserData();
87 if (info && info->key == key)
93 puObject *fgPopup::getActiveInputField(puObject *object)
96 if(object->getType() & PUCLASS_GROUP)
97 for (puObject *obj = ((puGroup *)object)->getFirstChild();
98 obj; obj = obj->getNextObject())
99 if ((ret = getActiveInputField(obj)))
102 if (object->getType() & PUCLASS_INPUT && ((puInput *)object)->isAcceptingInput())
111 int fgPopup::checkHit(int button, int updown, int x, int y)
113 int result = puPopup::checkHit(button, updown, x, y);
118 // This is annoying. We would really want a true result from the
119 // superclass to indicate "handled by child object", but all it
120 // tells us is that the pointer is inside the dialog. So do the
121 // intersection test (again) to make sure we don't start a drag
122 // when inside controls.
124 if(updown == PU_DOWN && !_dragging) {
128 int hit = getHitObjects(this, x, y);
129 if(hit & (PUCLASS_BUTTON|PUCLASS_ONESHOT|PUCLASS_INPUT))
133 getPosition(&px, &py);
137 } else if(updown == PU_DRAG && _dragging) {
138 setPosition(x + _dX, y + _dY);
145 int fgPopup::getHitObjects(puObject *object, int x, int y)
148 if(object->getType() & PUCLASS_GROUP)
149 for (puObject *obj = ((puGroup *)object)->getFirstChild();
150 obj; obj = obj->getNextObject())
151 type |= getHitObjects(obj, x, y);
154 object->getAbsolutePosition(&cx, &cy);
155 object->getSize(&cw, &ch);
156 if(x >= cx && x < cx + cw && y >= cy && y < cy + ch)
157 type |= object->getType();
163 ////////////////////////////////////////////////////////////////////////
165 ////////////////////////////////////////////////////////////////////////
171 action_callback (puObject * object)
173 GUIInfo * info = (GUIInfo *)object->getUserData();
174 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
175 gui->setActiveDialog(info->dialog);
176 int nBindings = info->bindings.size();
177 for (int i = 0; i < nBindings; i++) {
178 info->bindings[i]->fire();
179 if (gui->getActiveDialog() == 0)
182 gui->setActiveDialog(0);
187 format_callback(puObject *obj, int dx, int dy, void *n)
189 SGPropertyNode *node = (SGPropertyNode *)n;
190 const char *format = node->getStringValue("format"), *f = format;
191 bool number, l = false;
192 // make sure the format matches '[ -+#]?\d*(\.\d*)?l?[fs]'
203 if (*f == ' ' || *f == '+' || *f == '-' || *f == '#')
205 while (*f && isdigit(*f))
209 while (*f && isdigit(*f))
217 else if (*f == 's') {
234 const char *src = obj->getLabel();
237 float value = atof(src);
238 snprintf(buf, 256, format, value);
240 snprintf(buf, 256, format, src);
245 SGPropertyNode *result = node->getNode("formatted", true);
246 result->setStringValue(buf);
247 obj->setLabel(result->getStringValue());
252 ////////////////////////////////////////////////////////////////////////
253 // Static helper functions.
254 ////////////////////////////////////////////////////////////////////////
257 * Copy a property value to a PUI object.
260 copy_to_pui (SGPropertyNode * node, puObject * object)
262 // Treat puText objects specially, so their "values" can be set
264 if(object->getType() & PUCLASS_TEXT) {
265 object->setLabel(node->getStringValue());
269 switch (node->getType()) {
270 case SGPropertyNode::BOOL:
271 case SGPropertyNode::INT:
272 case SGPropertyNode::LONG:
273 object->setValue(node->getIntValue());
275 case SGPropertyNode::FLOAT:
276 case SGPropertyNode::DOUBLE:
277 object->setValue(node->getFloatValue());
280 object->setValue(node->getStringValue());
287 copy_from_pui (puObject * object, SGPropertyNode * node)
289 // puText objects are immutable, so should not be copied out
290 if(object->getType() & PUCLASS_TEXT)
293 switch (node->getType()) {
294 case SGPropertyNode::BOOL:
295 case SGPropertyNode::INT:
296 case SGPropertyNode::LONG:
297 node->setIntValue(object->getIntegerValue());
299 case SGPropertyNode::FLOAT:
300 case SGPropertyNode::DOUBLE:
301 node->setFloatValue(object->getFloatValue());
304 // Special case to handle lists, as getStringValue cannot be overridden
305 if(object->getType() & PUCLASS_LIST)
307 const char *s = ((puList *) object)->getListStringValue();
309 node->setStringValue(s);
313 node->setStringValue(object->getStringValue());
321 ////////////////////////////////////////////////////////////////////////
322 // Implementation of FGDialog.
323 ////////////////////////////////////////////////////////////////////////
325 FGDialog::FGDialog (SGPropertyNode * props)
327 _gui((NewGUI *)globals->get_subsystem("gui")),
330 _module = string("__dlg:") + props->getStringValue("name", "[unnamed]");
331 SGPropertyNode *nasal = props->getNode("nasal");
333 _nasal_close = nasal->getNode("close");
334 SGPropertyNode *open = nasal->getNode("open");
336 const char *s = open->getStringValue();
337 FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
338 nas->createModule(_module.c_str(), _module.c_str(), s, strlen(s), props);
344 FGDialog::~FGDialog ()
347 _object->getAbsolutePosition(&x, &y);
348 _props->setIntValue("lastx", x);
349 _props->setIntValue("lasty", y);
351 FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
353 const char *s = _nasal_close->getStringValue();
354 nas->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _props);
356 nas->deleteModule(_module.c_str());
358 puDeleteObject(_object);
361 // Delete all the arrays we made
362 // and were forced to keep around
363 // because PUI won't do its own
364 // memory management.
365 for (i = 0; i < _char_arrays.size(); i++)
366 destroy_char_array(_char_arrays[i]);
368 // Delete all the info objects we
369 // were forced to keep around because
370 // PUI cannot delete its own user data.
371 for (i = 0; i < _info.size(); i++) {
372 delete (GUIInfo *)_info[i];
375 // Finally, delete the property links.
376 for (i = 0; i < _propertyObjects.size(); i++) {
377 delete _propertyObjects[i];
378 _propertyObjects[i] = 0;
383 FGDialog::updateValues (const char * objectName)
385 for (unsigned int i = 0; i < _propertyObjects.size(); i++) {
386 const string &name = _propertyObjects[i]->name;
387 if (name.size() && name != objectName)
390 puObject *obj = _propertyObjects[i]->object;
391 copy_to_pui(_propertyObjects[i]->node, obj);
396 FGDialog::applyValues (const char * objectName)
398 for (unsigned int i = 0; i < _propertyObjects.size(); i++) {
399 const string &name = _propertyObjects[i]->name;
400 if (name.size() && name != objectName)
403 copy_from_pui(_propertyObjects[i]->object,
404 _propertyObjects[i]->node);
411 for (unsigned int i = 0; i < _liveObjects.size(); i++) {
412 puObject *obj = _liveObjects[i]->object;
413 if (obj->getType() & PUCLASS_INPUT && ((puInput *)obj)->isAcceptingInput())
416 copy_to_pui(_liveObjects[i]->node, obj);
421 FGDialog::display (SGPropertyNode * props)
424 SG_LOG(SG_GENERAL, SG_ALERT, "This widget is already active");
428 int screenw = globals->get_props()->getIntValue("/sim/startup/xsize");
429 int screenh = globals->get_props()->getIntValue("/sim/startup/ysize");
431 bool userx = props->hasValue("x");
432 bool usery = props->hasValue("y");
433 bool userw = props->hasValue("width");
434 bool userh = props->hasValue("height");
436 // Let the layout widget work in the same property subtree.
437 LayoutWidget wid(props);
439 SGPropertyNode *fontnode = props->getNode("font");
441 FGFontCache *fc = _gui->get_fontcache();
442 _font = fc->get(fontnode);
444 _font = _gui->getDefaultFont();
446 wid.setDefaultFont(_font, int(_font->getPointSize()));
449 int px, py, savex, savey;
451 wid.calcPrefSize(&pw, &ph);
452 pw = props->getIntValue("width", pw);
453 ph = props->getIntValue("height", ph);
454 px = savex = props->getIntValue("x", (screenw - pw) / 2);
455 py = savey = props->getIntValue("y", (screenh - ph) / 2);
457 // Negative x/y coordinates are interpreted as distance from the top/right
458 // corner rather than bottom/left.
460 px = screenw - pw + px;
462 py = screenh - ph + py;
464 // Define "x", "y", "width" and/or "height" in the property tree if they
465 // are not specified in the configuration file.
466 wid.layout(px, py, pw, ph);
468 // Use the dimension and location properties as specified in the
469 // configuration file or from the layout widget.
470 _object = makeObject(props, screenw, screenh);
472 // Remove automatically generated properties, so the layout looks
473 // the same next time around, or restore x and y to preserve negative coords.
475 props->setIntValue("x", savex);
477 props->removeChild("x");
480 props->setIntValue("y", savey);
482 props->removeChild("y");
484 if(!userw) props->removeChild("width");
485 if(!userh) props->removeChild("height");
490 SG_LOG(SG_GENERAL, SG_ALERT, "Widget "
491 << props->getStringValue("name", "[unnamed]")
492 << " does not contain a proper GUI definition");
497 FGDialog::makeObject (SGPropertyNode * props, int parentWidth, int parentHeight)
499 if (props->getBoolValue("hide"))
502 bool presetSize = props->hasValue("width") && props->hasValue("height");
503 int width = props->getIntValue("width", parentWidth);
504 int height = props->getIntValue("height", parentHeight);
505 int x = props->getIntValue("x", (parentWidth - width) / 2);
506 int y = props->getIntValue("y", (parentHeight - height) / 2);
507 string type = props->getName();
512 if (type == "dialog") {
514 bool draggable = props->getBoolValue("draggable", true);
515 if (props->getBoolValue("modal", false))
516 obj = new puDialogBox(x, y);
518 obj = new fgPopup(x, y, draggable);
519 setupGroup(obj, props, width, height, true);
520 setColor(obj, props);
523 } else if (type == "group") {
524 puGroup * obj = new puGroup(x, y);
525 setupGroup(obj, props, width, height, false);
526 setColor(obj, props);
529 } else if (type == "frame") {
530 puGroup * obj = new puGroup(x, y);
531 setupGroup(obj, props, width, height, true);
532 setColor(obj, props);
535 } else if (type == "hrule" || type == "vrule") {
536 puFrame * obj = new puFrame(x, y, x + width, y + height);
537 obj->setBorderThickness(0);
538 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
541 } else if (type == "list") {
542 char ** entries = value_list(props);
543 int slider_width = props->getIntValue("slider", 20);
544 puList * obj = new puList(x, y, x + width, y + height, entries, slider_width);
546 obj->setSize(width, height);
547 setupObject(obj, props);
548 setColor(obj, props);
551 } else if (type == "airport-list") {
552 AirportList * obj = new AirportList(x, y, x + width, y + height);
554 obj->setSize(width, height);
555 setupObject(obj, props);
556 setColor(obj, props);
559 } else if (type == "input") {
560 puInput * obj = new puInput(x, y, x + width, y + height);
561 setupObject(obj, props);
562 setColor(obj, props, FOREGROUND|LABEL);
565 } else if (type == "text") {
566 puText * obj = new puText(x, y);
567 setupObject(obj, props);
569 if (props->getNode("format")) {
570 SGPropertyNode *live = props->getNode("live");
571 if (live && live->getBoolValue())
572 obj->setRenderCallback(format_callback, props);
574 format_callback(obj, x, y, props);
576 // Layed-out objects need their size set, and non-layout ones
577 // get a different placement.
579 obj->setSize(width, height);
581 obj->setLabelPlace(PUPLACE_LABEL_DEFAULT);
582 setColor(obj, props, LABEL);
585 } else if (type == "checkbox") {
587 obj = new puButton(x, y, x + width, y + height, PUBUTTON_XCHECK);
588 setupObject(obj, props);
589 setColor(obj, props, FOREGROUND|LABEL);
592 } else if (type == "radio") {
594 obj = new puButton(x, y, x + width, y + height, PUBUTTON_CIRCLE);
595 setupObject(obj, props);
596 setColor(obj, props, FOREGROUND|LABEL);
599 } else if (type == "button") {
601 const char * legend = props->getStringValue("legend", "[none]");
602 if (props->getBoolValue("one-shot", true))
603 obj = new puOneShot(x, y, legend);
605 obj = new puButton(x, y, legend);
607 obj->setSize(width, height);
608 setupObject(obj, props);
609 setColor(obj, props);
612 } else if (type == "combo") {
613 char ** entries = value_list(props);
614 puComboBox * obj = new puComboBox(x, y, x + width, y + height, entries,
615 props->getBoolValue("editable", false));
616 setupObject(obj, props);
617 #ifdef PUCOL_EDITFIELD // plib > 0.8.4
618 setColor(obj, props, EDITFIELD);
620 setColor(obj, props, FOREGROUND|LABEL);
624 } else if (type == "slider") {
625 bool vertical = props->getBoolValue("vertical", false);
626 puSlider * obj = new puSlider(x, y, (vertical ? height : width));
627 obj->setMinValue(props->getFloatValue("min", 0.0));
628 obj->setMaxValue(props->getFloatValue("max", 1.0));
629 setupObject(obj, props);
631 obj->setSize(width, height);
632 setColor(obj, props, FOREGROUND|LABEL);
635 } else if (type == "dial") {
636 puDial * obj = new puDial(x, y, width);
637 obj->setMinValue(props->getFloatValue("min", 0.0));
638 obj->setMaxValue(props->getFloatValue("max", 1.0));
639 obj->setWrap(props->getBoolValue("wrap", true));
640 setupObject(obj, props);
641 setColor(obj, props, FOREGROUND|LABEL);
644 } else if (type == "textbox") {
645 int slider_width = props->getIntValue("slider", 20);
646 int wrap = props->getBoolValue("wrap", true);
647 puLargeInput * obj = new puLargeInput(x, y,
648 x+width, x+height, 2, slider_width, wrap);
650 if (props->hasValue("editable")) {
651 if (props->getBoolValue("editable")==false)
657 obj->setSize(width, height);
658 setupObject(obj, props);
659 setColor(obj, props, FOREGROUND|LABEL);
662 } else if (type == "select") {
663 vector<SGPropertyNode_ptr> value_nodes;
664 SGPropertyNode * selection_node =
665 fgGetNode(props->getChild("selection")->getStringValue(), true);
667 for (int q = 0; q < selection_node->nChildren(); q++)
668 value_nodes.push_back(selection_node->getChild(q));
670 char ** entries = make_char_array(value_nodes.size());
671 for (unsigned int i = 0; i < value_nodes.size(); i++)
672 entries[i] = strdup((char *)value_nodes[i]->getName());
675 new puSelectBox(x, y, x + width, y + height, entries);
676 setupObject(obj, props);
677 #ifdef PUCOL_EDITFIELD // plib > 0.8.4
678 setColor(obj, props, EDITFIELD);
680 setColor(obj, props, FOREGROUND|LABEL);
689 FGDialog::setupObject (puObject * object, SGPropertyNode * props)
691 string type = props->getName();
692 object->setLabelPlace(PUPLACE_CENTERED_RIGHT);
694 if (props->hasValue("legend"))
695 object->setLegend(props->getStringValue("legend"));
697 if (props->hasValue("label"))
698 object->setLabel(props->getStringValue("label"));
700 if (props->hasValue("border"))
701 object->setBorderThickness( props->getIntValue("border", 2) );
703 if ( SGPropertyNode *nft = props->getNode("font", false) ) {
704 FGFontCache *fc = _gui->get_fontcache();
705 puFont *lfnt = fc->get(nft);
706 object->setLabelFont(*lfnt);
708 object->setLabelFont(*_font);
711 if (props->hasValue("property")) {
712 const char * name = props->getStringValue("name");
715 const char * propname = props->getStringValue("property");
716 SGPropertyNode_ptr node = fgGetNode(propname, true);
717 copy_to_pui(node, object);
718 PropertyObject* po = new PropertyObject(name, object, node);
719 _propertyObjects.push_back(po);
720 if(props->getBoolValue("live"))
721 _liveObjects.push_back(po);
724 SGPropertyNode * dest = fgGetNode("/sim/bindings/gui", true);
725 vector<SGPropertyNode_ptr> bindings = props->getChildren("binding");
726 if (bindings.size() > 0) {
727 GUIInfo * info = new GUIInfo(this);
728 info->key = props->getIntValue("keynum", -1);
729 if (props->hasValue("key"))
730 info->key = getKeyCode(props->getStringValue("key", ""));
732 for (unsigned int i = 0; i < bindings.size(); i++) {
734 SGPropertyNode *binding;
735 while (dest->getChild("binding", j))
738 const char *cmd = bindings[i]->getStringValue("command");
739 if (!strcmp(cmd, "nasal"))
740 bindings[i]->setStringValue("module", _module.c_str());
742 binding = dest->getChild("binding", j, true);
743 copyProperties(bindings[i], binding);
744 info->bindings.push_back(new FGBinding(binding));
746 object->setCallback(action_callback);
748 if (type == "input" && props->getBoolValue("live"))
749 object->setDownCallback(action_callback);
751 object->setUserData(info);
752 _info.push_back(info);
755 object->makeReturnDefault(props->getBoolValue("default"));
759 FGDialog::setupGroup (puGroup * group, SGPropertyNode * props,
760 int width, int height, bool makeFrame)
762 setupObject(group, props);
765 puFrame* f = new puFrame(0, 0, width, height);
769 int nChildren = props->nChildren();
770 for (int i = 0; i < nChildren; i++)
771 makeObject(props->getChild(i), width, height);
776 FGDialog::setColor(puObject * object, SGPropertyNode * props, int which)
778 string type = props->getName();
781 if (type == "textbox" && props->getBoolValue("editable"))
784 FGColor *c = new FGColor(_gui->getColor("background"));
785 c->merge(_gui->getColor(type));
786 c->merge(props->getNode("color"));
788 object->setColourScheme(c->red(), c->green(), c->blue(), c->alpha());
796 { BACKGROUND, PUCOL_BACKGROUND, "background", "color-background" },
797 { FOREGROUND, PUCOL_FOREGROUND, "foreground", "color-foreground" },
798 { HIGHLIGHT, PUCOL_HIGHLIGHT, "highlight", "color-highlight" },
799 { LABEL, PUCOL_LABEL, "label", "color-label" },
800 { LEGEND, PUCOL_LEGEND, "legend", "color-legend" },
801 { MISC, PUCOL_MISC, "misc", "color-misc" },
802 #ifdef PUCOL_EDITFIELD // plib > 0.8.4
803 { EDITFIELD, PUCOL_EDITFIELD, "editfield", "color-editfield" },
807 const int numcol = sizeof(pucol) / sizeof(pucol[0]);
809 for (int i = 0; i < numcol; i++) {
814 dirty |= c->merge(_gui->getColor(type + '-' + pucol[i].name));
815 if (which & pucol[i].mask)
816 dirty |= c->merge(props->getNode("color"));
818 if ((pucol[i].mask == LABEL) && !c->isValid())
819 dirty |= c->merge(_gui->getColor("label"));
821 dirty |= c->merge(props->getNode(pucol[i].cname));
823 if (c->isValid() && dirty)
824 object->setColor(pucol[i].id, c->red(), c->green(), c->blue(), c->alpha());
856 {"left", PU_KEY_LEFT},
858 {"right", PU_KEY_RIGHT},
859 {"down", PU_KEY_DOWN},
860 {"pageup", PU_KEY_PAGE_UP},
861 {"pagedn", PU_KEY_PAGE_DOWN},
862 {"home", PU_KEY_HOME},
864 {"insert", PU_KEY_INSERT},
869 FGDialog::getKeyCode(const char *str)
880 char *buf = new char[strlen(str) + 1];
882 char *s = buf + strlen(buf);
883 while (s > str && s[-1] == ' ')
890 if (!strncmp(s, "Ctrl-", 5) || !strncmp(s, "CTRL-", 5))
892 else if (!strncmp(s, "Shift-", 6) || !strncmp(s, "SHIFT-", 6))
893 s += 6, mod |= SHIFT;
894 else if (!strncmp(s, "Alt-", 4) || !strncmp(s, "ALT-", 4))
901 if (strlen(s) == 1 && isascii(*s)) {
906 key = toupper(key) - 64;
908 ; // Alt not propagated to the gui
910 for (char *t = s; *t; t++)
912 for (int i = 0; keymap[i].name; i++) {
913 if (!strcmp(s, keymap[i].name)) {
924 FGDialog::value_list (const SGPropertyNode *props)
926 vector<SGPropertyNode_ptr> value_nodes = props->getChildren("value");
927 char ** entries = make_char_array(value_nodes.size());
928 for (unsigned int i = 0; i < value_nodes.size(); i++)
929 entries[i] = strdup((char *)value_nodes[i]->getStringValue());
934 FGDialog::make_char_array (int size)
936 char ** list = new char*[size+1];
937 for (int i = 0; i <= size; i++)
939 _char_arrays.push_back(list);
944 FGDialog::destroy_char_array (char ** array)
946 for (int i = 0; array[i] != 0; i++)
948 free(array[i]);// added with strdup
953 ////////////////////////////////////////////////////////////////////////
954 // Implementation of FGDialog::PropertyObject.
955 ////////////////////////////////////////////////////////////////////////
957 FGDialog::PropertyObject::PropertyObject (const char * n,
959 SGPropertyNode_ptr p)