src/GUI/dialog.cxx

   1 // dialog.cxx: implementation of an XML-configurable dialog box.
   2
   3 #include <stdlib.h>             // atof()
   4
   5 #include <Input/input.hxx>
   6
   7 #include "dialog.hxx"
   8 #include "new_gui.hxx"
   9
  10 #include "puList.hxx"
  11 #include "AirportList.hxx"
  12 #include "layout.hxx"
  13
  14 int fgPopup::checkHit(int button, int updown, int x, int y)
  15 {
  16     int result = puPopup::checkHit(button, updown, x, y);
  17
  18     if ( !_draggable)
  19        return result;
  20
  21     // This is annoying.  We would really want a true result from the
  22     // superclass to indicate "handled by child object", but all it
  23     // tells us is that the pointer is inside the dialog.  So do the
  24     // intersection test (again) to make sure we don't start a drag
  25     // when inside controls.
  26
  27     if(updown == PU_DOWN && !_dragging) {
  28         if(!result)
  29             return 0;
  30
  31         int hit = getHitObjects(this, x, y);
  32         if(hit & (PUCLASS_BUTTON|PUCLASS_ONESHOT|PUCLASS_INPUT))
  33             return result;
  34
  35         int px, py;
  36         getPosition(&px, &py);
  37         _dragging = true;
  38         _dX = px - x;
  39         _dY = py - y;
  40     } else if(updown == PU_DRAG && _dragging) {
  41         setPosition(x + _dX, y + _dY);
  42     } else {
  43         _dragging = false;
  44     }
  45     return result;
  46 }
  47
  48 int fgPopup::getHitObjects(puObject *object, int x, int y)
  49 {
  50     int type = 0;
  51     if(object->getType() & PUCLASS_GROUP)
  52         for (puObject *obj = ((puGroup *)object)->getFirstChild();
  53                 obj; obj = obj->getNextObject())
  54             type |= getHitObjects(obj, x, y);
  55
  56     int cx, cy, cw, ch;
  57     object->getAbsolutePosition(&cx, &cy);
  58     object->getSize(&cw, &ch);
  59     if(x >= cx && x < cx + cw && y >= cy && y < cy + ch)
  60         type |= object->getType();
  61     return type;
  62 }
  63
  64
  65 \f
  66 ////////////////////////////////////////////////////////////////////////
  67 // Callbacks.
  68 ////////////////////////////////////////////////////////////////////////
  69
  70 /**
  71  * User data for a GUI object.
  72  */
  73 struct GUIInfo
  74 {
  75     GUIInfo (FGDialog * d);
  76     virtual ~GUIInfo ();
  77
  78     FGDialog * dialog;
  79     vector <FGBinding *> bindings;
  80 };
  81
  82
  83 /**
  84  * Action callback.
  85  */
  86 static void
  87 action_callback (puObject * object)
  88 {
  89     GUIInfo * info = (GUIInfo *)object->getUserData();
  90     NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
  91     gui->setActiveDialog(info->dialog);
  92     int nBindings = info->bindings.size();
  93     for (int i = 0; i < nBindings; i++) {
  94         info->bindings[i]->fire();
  95         if (gui->getActiveDialog() == 0)
  96             break;
  97     }
  98     gui->setActiveDialog(0);
  99 }
 100
 101
 102 static void
 103 format_callback(puObject *obj, int dx, int dy, void *n)
 104 {
 105     SGPropertyNode *node = (SGPropertyNode *)n;
 106     const char *format = node->getStringValue("format"), *f = format;
 107     bool number, l = false;
 108     // make sure the format matches '[ -+#]?\d*(\.\d*)?l?[fs]'
 109     for (; *f; f++) {
 110         if (*f == '%') {
 111             if (f[1] == '%')
 112                 f++;
 113             else
 114                 break;
 115         }
 116     }
 117     if (*f++ != '%')
 118         return;
 119     if (*f == ' ' || *f == '+' || *f == '-' || *f == '#')
 120         f++;
 121     while (*f && isdigit(*f))
 122         f++;
 123     if (*f == '.') {
 124         f++;
 125         while (*f && isdigit(*f))
 126             f++;
 127     }
 128     if (*f == 'l')
 129         l = true, f++;
 130
 131     if (*f == 'f')
 132         number = true;
 133     else if (*f == 's') {
 134         if (l)
 135             return;
 136         number = false;
 137     } else
 138         return;
 139
 140     for (++f; *f; f++) {
 141         if (*f == '%') {
 142             if (f[1] == '%')
 143                 f++;
 144             else
 145                 return;
 146         }
 147     }
 148
 149     char buf[256];
 150     const char *src = obj->getLabel();
 151
 152     if (number) {
 153         float value = atof(src);
 154         snprintf(buf, 256, format, value);
 155     } else {
 156         snprintf(buf, 256, format, src);
 157     }
 158
 159     buf[255] = '\0';
 160
 161     SGPropertyNode *result = node->getNode("formatted", true);
 162     result->setStringValue(buf);
 163     obj->setLabel(result->getStringValue());
 164 }
 165
 166
 167 \f
 168 ////////////////////////////////////////////////////////////////////////
 169 // Static helper functions.
 170 ////////////////////////////////////////////////////////////////////////
 171
 172 /**
 173  * Copy a property value to a PUI object.
 174  */
 175 static void
 176 copy_to_pui (SGPropertyNode * node, puObject * object)
 177 {
 178     // Treat puText objects specially, so their "values" can be set
 179     // from properties.
 180     if(object->getType() & PUCLASS_TEXT) {
 181         object->setLabel(node->getStringValue());
 182         return;
 183     }
 184
 185     switch (node->getType()) {
 186     case SGPropertyNode::BOOL:
 187     case SGPropertyNode::INT:
 188     case SGPropertyNode::LONG:
 189         object->setValue(node->getIntValue());
 190         break;
 191     case SGPropertyNode::FLOAT:
 192     case SGPropertyNode::DOUBLE:
 193         object->setValue(node->getFloatValue());
 194         break;
 195     default:
 196         object->setValue(node->getStringValue());
 197         break;
 198     }
 199 }
 200
 201
 202 static void
 203 copy_from_pui (puObject * object, SGPropertyNode * node)
 204 {
 205     // puText objects are immutable, so should not be copied out
 206     if(object->getType() & PUCLASS_TEXT)
 207         return;
 208
 209     switch (node->getType()) {
 210     case SGPropertyNode::BOOL:
 211     case SGPropertyNode::INT:
 212     case SGPropertyNode::LONG:
 213         node->setIntValue(object->getIntegerValue());
 214         break;
 215     case SGPropertyNode::FLOAT:
 216     case SGPropertyNode::DOUBLE:
 217         node->setFloatValue(object->getFloatValue());
 218         break;
 219     default:
 220         // Special case to handle lists, as getStringValue cannot be overridden
 221         if(object->getType() & PUCLASS_LIST)
 222         {
 223             node->setStringValue(((puList *) object)->getListStringValue());
 224         }
 225         else
 226         {
 227             node->setStringValue(object->getStringValue());
 228         }
 229         break;
 230     }
 231 }
 232
 233
 234 \f
 235 ////////////////////////////////////////////////////////////////////////
 236 // Implementation of GUIInfo.
 237 ////////////////////////////////////////////////////////////////////////
 238
 239 GUIInfo::GUIInfo (FGDialog * d)
 240     : dialog(d)
 241 {
 242 }
 243
 244 GUIInfo::~GUIInfo ()
 245 {
 246     for (unsigned int i = 0; i < bindings.size(); i++) {
 247         delete bindings[i];
 248         bindings[i] = 0;
 249     }
 250 }
 251
 252
 253 \f
 254 ////////////////////////////////////////////////////////////////////////
 255 // Implementation of FGDialog.
 256 ////////////////////////////////////////////////////////////////////////
 257
 258 FGDialog::FGDialog (SGPropertyNode * props)
 259     : _object(0)
 260 {
 261     char* envp = ::getenv( "FG_FONTS" );
 262     if ( envp != NULL ) {
 263         _font_path.set( envp );
 264     } else {
 265         _font_path.set( globals->get_fg_root() );
 266         _font_path.append( "Fonts" );
 267     }
 268
 269     display(props);
 270 }
 271
 272 FGDialog::~FGDialog ()
 273 {
 274     puDeleteObject(_object);
 275
 276     unsigned int i;
 277
 278                                 // Delete all the arrays we made
 279                                 // and were forced to keep around
 280                                 // because PUI won't do its own
 281                                 // memory management.
 282     for (i = 0; i < _char_arrays.size(); i++) {
 283         for (int j = 0; _char_arrays[i][j] != 0; j++)
 284             free(_char_arrays[i][j]); // added with strdup
 285         delete[] _char_arrays[i];
 286     }
 287
 288                                 // Delete all the info objects we
 289                                 // were forced to keep around because
 290                                 // PUI cannot delete its own user data.
 291     for (i = 0; i < _info.size(); i++) {
 292         delete (GUIInfo *)_info[i];
 293         _info[i] = 0;
 294     }
 295
 296                                 // Finally, delete the property links.
 297     for (i = 0; i < _propertyObjects.size(); i++) {
 298         delete _propertyObjects[i];
 299         _propertyObjects[i] = 0;
 300     }
 301 }
 302
 303 void
 304 FGDialog::updateValue (const char * objectName)
 305 {
 306     for (unsigned int i = 0; i < _propertyObjects.size(); i++) {
 307         const string &name = _propertyObjects[i]->name;
 308         if (name == objectName)
 309             copy_to_pui(_propertyObjects[i]->node,
 310                         _propertyObjects[i]->object);
 311     }
 312 }
 313
 314 void
 315 FGDialog::applyValue (const char * objectName)
 316 {
 317     for (unsigned int i = 0; i < _propertyObjects.size(); i++) {
 318         if (_propertyObjects[i]->name == objectName)
 319             copy_from_pui(_propertyObjects[i]->object,
 320                           _propertyObjects[i]->node);
 321     }
 322 }
 323
 324 void
 325 FGDialog::updateValues ()
 326 {
 327     for (unsigned int i = 0; i < _propertyObjects.size(); i++)
 328         copy_to_pui(_propertyObjects[i]->node, _propertyObjects[i]->object);
 329 }
 330
 331 void
 332 FGDialog::applyValues ()
 333 {
 334     for (unsigned int i = 0; i < _propertyObjects.size(); i++)
 335         copy_from_pui(_propertyObjects[i]->object,
 336                       _propertyObjects[i]->node);
 337 }
 338
 339 void
 340 FGDialog::update ()
 341 {
 342     for (unsigned int i = 0; i < _liveObjects.size(); i++) {
 343         puObject *obj = _liveObjects[i]->object;
 344         if (obj->getType() & PUCLASS_INPUT && ((puInput *)obj)->isAcceptingInput())
 345             continue;
 346
 347         copy_to_pui(_liveObjects[i]->node, obj);
 348     }
 349 }
 350
 351 void
 352 FGDialog::display (SGPropertyNode * props)
 353 {
 354     if (_object != 0) {
 355         SG_LOG(SG_GENERAL, SG_ALERT, "This widget is already active");
 356         return;
 357     }
 358
 359     int screenw = globals->get_props()->getIntValue("/sim/startup/xsize");
 360     int screenh = globals->get_props()->getIntValue("/sim/startup/ysize");
 361
 362     bool userx = props->hasValue("x");
 363     bool usery = props->hasValue("y");
 364     bool userw = props->hasValue("width");
 365     bool userh = props->hasValue("height");
 366
 367     LayoutWidget wid(props);
 368     int pw=0, ph=0;
 369     if(!userw || !userh)
 370         wid.calcPrefSize(&pw, &ph);
 371     pw = props->getIntValue("width", pw);
 372     ph = props->getIntValue("height", ph);
 373     int px = props->getIntValue("x", (screenw - pw) / 2);
 374     int py = props->getIntValue("y", (screenh - ph) / 2);
 375     wid.layout(px, py, pw, ph);
 376
 377     _object = makeObject(props, screenw, screenh);
 378
 379     // Remove automatically generated properties, so the layout looks
 380     // the same next time around.
 381     if(!userx) props->removeChild("x");
 382     if(!usery) props->removeChild("y");
 383     if(!userw) props->removeChild("width");
 384     if(!userh) props->removeChild("height");
 385
 386     if (_object != 0) {
 387         _object->reveal();
 388     } else {
 389         SG_LOG(SG_GENERAL, SG_ALERT, "Widget "
 390                << props->getStringValue("name", "[unnamed]")
 391                << " does not contain a proper GUI definition");
 392     }
 393 }
 394
 395 puObject *
 396 FGDialog::makeObject (SGPropertyNode * props, int parentWidth, int parentHeight)
 397 {
 398     bool presetSize = props->hasValue("width") && props->hasValue("height");
 399     int width = props->getIntValue("width", parentWidth);
 400     int height = props->getIntValue("height", parentHeight);
 401     int x = props->getIntValue("x", (parentWidth - width) / 2);
 402     int y = props->getIntValue("y", (parentHeight - height) / 2);
 403
 404     sgVec4 color = {0.8, 0.8, 0.9, 0.85};
 405     SGPropertyNode *ncs = props->getNode("color", false);
 406     if ( ncs ) {
 407        color[0] = ncs->getFloatValue("red", 0.8);
 408        color[1] = ncs->getFloatValue("green", 0.8);
 409        color[2] = ncs->getFloatValue("blue", 0.9);
 410        color[3] = ncs->getFloatValue("alpha", 0.85);
 411     }
 412
 413     string type = props->getName();
 414     if (type == "")
 415         type = "dialog";
 416
 417     if (type == "dialog") {
 418         puPopup * dialog;
 419         bool draggable = props->getBoolValue("draggable", true);
 420         if (props->getBoolValue("modal", false))
 421             dialog = new puDialogBox(x, y);
 422         else
 423             dialog = new fgPopup(x, y, draggable);
 424         setupGroup(dialog, props, width, height, color, true);
 425         return dialog;
 426     } else if (type == "group") {
 427         puGroup * group = new puGroup(x, y);
 428         setupGroup(group, props, width, height, color, false);
 429         return group;
 430     } else if (type == "frame") {
 431         puFrame * frame = new puFrame(x, y,  width, height);
 432         frame->setBorderThickness(1);
 433         frame->setColorScheme(color[0], color[1], color[2], color[3]);
 434         puGroup * group = new puGroup(x, y);
 435         setupGroup(group, props, width, height, color, false);
 436         return group;
 437     } else if (type == "list") {
 438         puList * list = new puList(x, y, x + width, y + height);
 439         setupObject(list, props);
 440         return list;
 441     } else if (type == "airport-list") {
 442         AirportList * list = new AirportList(x, y, x + width, y + height);
 443         setupObject(list, props);
 444         return list;
 445     } else if (type == "input") {
 446         puInput * input = new puInput(x, y, x + width, y + height);
 447         setupObject(input, props);
 448         return input;
 449     } else if (type == "text") {
 450         puText * text = new puText(x, y);
 451         setupObject(text, props);
 452
 453         if (props->getNode("format")) {
 454             SGPropertyNode *live = props->getNode("live");
 455             if (live && live->getBoolValue())
 456                 text->setRenderCallback(format_callback, props);
 457             else
 458                 format_callback(text, x, y, props);
 459         }
 460         // Layed-out objects need their size set, and non-layout ones
 461         // get a different placement.
 462         if(presetSize) text->setSize(width, height);
 463         else text->setLabelPlace(PUPLACE_LABEL_DEFAULT);
 464         return text;
 465     } else if (type == "checkbox") {
 466         puButton * b;
 467         b = new puButton(x, y, x + width, y + height, PUBUTTON_XCHECK);
 468         b->setColourScheme(.8, .7, .7); // matches "PUI input pink"
 469         setupObject(b, props);
 470         return b;
 471     } else if (type == "radio") {
 472         puButton * b;
 473         b = new puButton(x, y, x + width, y + height, PUBUTTON_CIRCLE);
 474         b->setColourScheme(.8, .7, .7); // matches "PUI input pink"
 475         setupObject(b, props);
 476         return b;
 477     } else if (type == "button") {
 478         puButton * b;
 479         const char * legend = props->getStringValue("legend", "[none]");
 480         if (props->getBoolValue("one-shot", true))
 481             b = new puOneShot(x, y, legend);
 482         else
 483             b = new puButton(x, y, legend);
 484         if(presetSize)
 485             b->setSize(width, height);
 486         setupObject(b, props);
 487         return b;
 488     } else if (type == "combo") {
 489         vector<SGPropertyNode_ptr> value_nodes = props->getChildren("value");
 490         char ** entries = make_char_array(value_nodes.size());
 491         for (unsigned int i = 0, j = value_nodes.size() - 1;
 492              i < value_nodes.size();
 493              i++, j--)
 494             entries[i] = strdup((char *)value_nodes[i]->getStringValue());
 495         puComboBox * combo =
 496             new puComboBox(x, y, x + width, y + height, entries,
 497                            props->getBoolValue("editable", false));
 498         setupObject(combo, props);
 499         return combo;
 500     } else if (type == "slider") {
 501         bool vertical = props->getBoolValue("vertical", false);
 502         puSlider * slider = new puSlider(x, y, (vertical ? height : width));
 503         slider->setMinValue(props->getFloatValue("min", 0.0));
 504         slider->setMaxValue(props->getFloatValue("max", 1.0));
 505         setupObject(slider, props);
 506         if(presetSize)
 507             slider->setSize(width, height);
 508         return slider;
 509     } else if (type == "dial") {
 510         puDial * dial = new puDial(x, y, width);
 511         dial->setMinValue(props->getFloatValue("min", 0.0));
 512         dial->setMaxValue(props->getFloatValue("max", 1.0));
 513         dial->setWrap(props->getBoolValue("wrap", true));
 514         setupObject(dial, props);
 515         return dial;
 516     } else if (type == "textbox") {
 517        int slider_width = props->getIntValue("slider", parentHeight);
 518        int wrap = props->getBoolValue("wrap", true)==true;
 519        if (slider_width==0) slider_width=20;
 520        puLargeInput * puTextBox =
 521                      new puLargeInput(x, y, x+width, x+height, 2, slider_width, wrap);
 522        if  (props->hasValue("editable"))
 523        {
 524           if (props->getBoolValue("editable")==false)
 525              puTextBox->disableInput();
 526           else
 527              puTextBox->enableInput();
 528        }
 529        setupObject(puTextBox,props);
 530        return puTextBox;
 531     } else if (type == "select") {
 532         vector<SGPropertyNode_ptr> value_nodes;
 533         SGPropertyNode * selection_node =
 534                 fgGetNode(props->getChild("selection")->getStringValue(), true);
 535
 536         for (int q = 0; q < selection_node->nChildren(); q++)
 537             value_nodes.push_back(selection_node->getChild(q));
 538
 539         char ** entries = make_char_array(value_nodes.size());
 540         for (unsigned int i = 0, j = value_nodes.size() - 1;
 541              i < value_nodes.size();
 542              i++, j--)
 543             entries[i] = strdup((char *)value_nodes[i]->getName());
 544         puSelectBox * select =
 545             new puSelectBox(x, y, x + width, y + height, entries);
 546         setupObject(select, props);
 547         return select;
 548     } else {
 549         return 0;
 550     }
 551 }
 552
 553 void
 554 FGDialog::setupObject (puObject * object, SGPropertyNode * props)
 555 {
 556     object->setLabelPlace(PUPLACE_CENTERED_RIGHT);
 557
 558     if (props->hasValue("legend"))
 559         object->setLegend(props->getStringValue("legend"));
 560
 561     if (props->hasValue("label"))
 562         object->setLabel(props->getStringValue("label"));
 563
 564     if (props->hasValue("border"))
 565         object->setBorderThickness( props->getIntValue("border", 2) );
 566
 567     if ( SGPropertyNode *nft = props->getNode("font", false) ) {
 568        SGPath path( _font_path );
 569        const char *name = nft->getStringValue("name", "default");
 570        float size = nft->getFloatValue("size", 13.0);
 571        float slant = nft->getFloatValue("slant", 0.0);
 572        path.append( name );
 573        path.concat( ".txf" );
 574
 575        fntFont *font = new fntTexFont;
 576        font->load( (char *)path.c_str() );
 577
 578        puFont lfnt(font, size, slant);
 579        object->setLabelFont( lfnt );
 580     }
 581
 582     if ( SGPropertyNode *ncs = props->getNode("color", false) ) {
 583        sgVec4 color;
 584        color[0] = ncs->getFloatValue("red", 0.0);
 585        color[1] = ncs->getFloatValue("green", 0.0);
 586        color[2] = ncs->getFloatValue("blue", 0.0);
 587        color[3] = ncs->getFloatValue("alpha", 1.0);
 588        object->setColor(PUCOL_LABEL, color[0], color[1], color[2], color[3]);
 589     }
 590
 591     if (props->hasValue("property")) {
 592         const char * name = props->getStringValue("name");
 593         if (name == 0)
 594             name = "";
 595         const char * propname = props->getStringValue("property");
 596         SGPropertyNode_ptr node = fgGetNode(propname, true);
 597         copy_to_pui(node, object);
 598         PropertyObject* po = new PropertyObject(name, object, node);
 599         _propertyObjects.push_back(po);
 600         if(props->getBoolValue("live"))
 601             _liveObjects.push_back(po);
 602     }
 603
 604     vector<SGPropertyNode_ptr> nodes = props->getChildren("binding");
 605     if (nodes.size() > 0) {
 606         GUIInfo * info = new GUIInfo(this);
 607
 608         for (unsigned int i = 0; i < nodes.size(); i++)
 609             info->bindings.push_back(new FGBinding(nodes[i]));
 610         object->setCallback(action_callback);
 611         object->setUserData(info);
 612         _info.push_back(info);
 613     }
 614
 615     object->makeReturnDefault(props->getBoolValue("default"));
 616 }
 617
 618 void
 619 FGDialog::setupGroup (puGroup * group, SGPropertyNode * props,
 620                     int width, int height, sgVec4 color, bool makeFrame)
 621 {
 622     setupObject(group, props);
 623
 624     if (makeFrame) {
 625         puFrame* f = new puFrame(0, 0, width, height);
 626         f->setColorScheme(color[0], color[1], color[2], color[3]);
 627     }
 628
 629     int nChildren = props->nChildren();
 630     for (int i = 0; i < nChildren; i++)
 631         makeObject(props->getChild(i), width, height);
 632     group->close();
 633 }
 634
 635 char **
 636 FGDialog::make_char_array (int size)
 637 {
 638     char ** list = new char*[size+1];
 639     for (int i = 0; i <= size; i++)
 640         list[i] = 0;
 641     _char_arrays.push_back(list);
 642     return list;
 643 }
 644
 645
 646 \f
 647 ////////////////////////////////////////////////////////////////////////
 648 // Implementation of FGDialog::PropertyObject.
 649 ////////////////////////////////////////////////////////////////////////
 650
 651 FGDialog::PropertyObject::PropertyObject (const char * n,
 652                                            puObject * o,
 653                                            SGPropertyNode_ptr p)
 654     : name(n),
 655       object(o),
 656       node(p)
 657 {
 658 }
 659
 660
 661 // end of dialog.cxx