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      // Let the layout widget work in the same property subtree.
 368     LayoutWidget wid(props);
 369
 370     int pw=0, ph=0;
 371     if(!userw || !userh)
 372         wid.calcPrefSize(&pw, &ph);
 373     pw = props->getIntValue("width", pw);
 374     ph = props->getIntValue("height", ph);
 375     int px = props->getIntValue("x", (screenw - pw) / 2);
 376     int py = props->getIntValue("y", (screenh - ph) / 2);
 377
 378     // Define "x", "y", "width" and/or "height" in the property tree if they
 379     // are not specified in the configuration file.
 380     wid.layout(px, py, pw, ph);
 381
 382     // Use the dimension and location properties as specified in the
 383     // configuration file or from the layout widget.
 384     _object = makeObject(props, screenw, screenh);
 385
 386     // Remove automatically generated properties, so the layout looks
 387     // the same next time around.
 388     if(!userx) props->removeChild("x");
 389     if(!usery) props->removeChild("y");
 390     if(!userw) props->removeChild("width");
 391     if(!userh) props->removeChild("height");
 392
 393     if (_object != 0) {
 394         _object->reveal();
 395     } else {
 396         SG_LOG(SG_GENERAL, SG_ALERT, "Widget "
 397                << props->getStringValue("name", "[unnamed]")
 398                << " does not contain a proper GUI definition");
 399     }
 400 }
 401
 402 puObject *
 403 FGDialog::makeObject (SGPropertyNode * props, int parentWidth, int parentHeight)
 404 {
 405     bool presetSize = props->hasValue("width") && props->hasValue("height");
 406     int width = props->getIntValue("width", parentWidth);
 407     int height = props->getIntValue("height", parentHeight);
 408     int x = props->getIntValue("x", (parentWidth - width) / 2);
 409     int y = props->getIntValue("y", (parentHeight - height) / 2);
 410
 411     sgVec4 color = {0.8, 0.8, 0.9, 0.85};
 412     SGPropertyNode *ncs = props->getNode("color", false);
 413     if ( ncs ) {
 414        color[0] = ncs->getFloatValue("red", 0.8);
 415        color[1] = ncs->getFloatValue("green", 0.8);
 416        color[2] = ncs->getFloatValue("blue", 0.9);
 417        color[3] = ncs->getFloatValue("alpha", 0.85);
 418     }
 419
 420     string type = props->getName();
 421     if (type == "")
 422         type = "dialog";
 423
 424     if (type == "dialog") {
 425         puPopup * dialog;
 426         bool draggable = props->getBoolValue("draggable", true);
 427         if (props->getBoolValue("modal", false))
 428             dialog = new puDialogBox(x, y);
 429         else
 430             dialog = new fgPopup(x, y, draggable);
 431         setupGroup(dialog, props, width, height, color, true);
 432         return dialog;
 433     } else if (type == "group") {
 434         puGroup * group = new puGroup(x, y);
 435         setupGroup(group, props, width, height, color, false);
 436         return group;
 437     } else if (type == "frame") {
 438         puGroup * group = new puGroup(x, y);
 439         setupGroup(group, props, width, height, color, true);
 440         return group;
 441     } else if (type == "hrule") {
 442         puFrame * rule = new puFrame(3, y, parentWidth - 4, y + (height ? height : 1));
 443         rule->setBorderThickness(0);
 444         rule->setColorScheme(color[0], color[1], color[2], color[3]);
 445         return rule;
 446     } else if (type == "list") {
 447         puList * list = new puList(x, y, x + width, y + height);
 448         setupObject(list, props);
 449         return list;
 450     } else if (type == "airport-list") {
 451         AirportList * list = new AirportList(x, y, x + width, y + height);
 452         setupObject(list, props);
 453         return list;
 454     } else if (type == "input") {
 455         puInput * input = new puInput(x, y, x + width, y + height);
 456         setupObject(input, props);
 457         return input;
 458     } else if (type == "text") {
 459         puText * text = new puText(x, y);
 460         setupObject(text, props);
 461
 462         if (props->getNode("format")) {
 463             SGPropertyNode *live = props->getNode("live");
 464             if (live && live->getBoolValue())
 465                 text->setRenderCallback(format_callback, props);
 466             else
 467                 format_callback(text, x, y, props);
 468         }
 469         // Layed-out objects need their size set, and non-layout ones
 470         // get a different placement.
 471         if(presetSize) text->setSize(width, height);
 472         else text->setLabelPlace(PUPLACE_LABEL_DEFAULT);
 473         return text;
 474     } else if (type == "checkbox") {
 475         puButton * b;
 476         b = new puButton(x, y, x + width, y + height, PUBUTTON_XCHECK);
 477         b->setColourScheme(.8, .7, .7); // matches "PUI input pink"
 478         setupObject(b, props);
 479         return b;
 480     } else if (type == "radio") {
 481         puButton * b;
 482         b = new puButton(x, y, x + width, y + height, PUBUTTON_CIRCLE);
 483         b->setColourScheme(.8, .7, .7); // matches "PUI input pink"
 484         setupObject(b, props);
 485         return b;
 486     } else if (type == "button") {
 487         puButton * b;
 488         const char * legend = props->getStringValue("legend", "[none]");
 489         if (props->getBoolValue("one-shot", true))
 490             b = new puOneShot(x, y, legend);
 491         else
 492             b = new puButton(x, y, legend);
 493         if(presetSize)
 494             b->setSize(width, height);
 495         setupObject(b, props);
 496         return b;
 497     } else if (type == "combo") {
 498         vector<SGPropertyNode_ptr> value_nodes = props->getChildren("value");
 499         char ** entries = make_char_array(value_nodes.size());
 500         for (unsigned int i = 0, j = value_nodes.size() - 1;
 501              i < value_nodes.size();
 502              i++, j--)
 503             entries[i] = strdup((char *)value_nodes[i]->getStringValue());
 504         puComboBox * combo =
 505             new puComboBox(x, y, x + width, y + height, entries,
 506                            props->getBoolValue("editable", false));
 507         setupObject(combo, props);
 508         return combo;
 509     } else if (type == "slider") {
 510         bool vertical = props->getBoolValue("vertical", false);
 511         puSlider * slider = new puSlider(x, y, (vertical ? height : width));
 512         slider->setMinValue(props->getFloatValue("min", 0.0));
 513         slider->setMaxValue(props->getFloatValue("max", 1.0));
 514         setupObject(slider, props);
 515         if(presetSize)
 516             slider->setSize(width, height);
 517         return slider;
 518     } else if (type == "dial") {
 519         puDial * dial = new puDial(x, y, width);
 520         dial->setMinValue(props->getFloatValue("min", 0.0));
 521         dial->setMaxValue(props->getFloatValue("max", 1.0));
 522         dial->setWrap(props->getBoolValue("wrap", true));
 523         setupObject(dial, props);
 524         return dial;
 525     } else if (type == "textbox") {
 526        int slider_width = props->getIntValue("slider", parentHeight);
 527        int wrap = props->getBoolValue("wrap", true);
 528        if (slider_width==0) slider_width=20;
 529        puLargeInput * puTextBox =
 530                      new puLargeInput(x, y, x+width, x+height, 2, slider_width, wrap);
 531        if  (props->hasValue("editable"))
 532        {
 533           if (props->getBoolValue("editable")==false)
 534              puTextBox->disableInput();
 535           else
 536              puTextBox->enableInput();
 537        }
 538        setupObject(puTextBox,props);
 539        return puTextBox;
 540     } else if (type == "select") {
 541         vector<SGPropertyNode_ptr> value_nodes;
 542         SGPropertyNode * selection_node =
 543                 fgGetNode(props->getChild("selection")->getStringValue(), true);
 544
 545         for (int q = 0; q < selection_node->nChildren(); q++)
 546             value_nodes.push_back(selection_node->getChild(q));
 547
 548         char ** entries = make_char_array(value_nodes.size());
 549         for (unsigned int i = 0, j = value_nodes.size() - 1;
 550              i < value_nodes.size();
 551              i++, j--)
 552             entries[i] = strdup((char *)value_nodes[i]->getName());
 553         puSelectBox * select =
 554             new puSelectBox(x, y, x + width, y + height, entries);
 555         setupObject(select, props);
 556         return select;
 557     } else {
 558         return 0;
 559     }
 560 }
 561
 562 void
 563 FGDialog::setupObject (puObject * object, SGPropertyNode * props)
 564 {
 565     object->setLabelPlace(PUPLACE_CENTERED_RIGHT);
 566
 567     if (props->hasValue("legend"))
 568         object->setLegend(props->getStringValue("legend"));
 569
 570     if (props->hasValue("label"))
 571         object->setLabel(props->getStringValue("label"));
 572
 573     if (props->hasValue("border"))
 574         object->setBorderThickness( props->getIntValue("border", 2) );
 575
 576     if ( SGPropertyNode *nft = props->getNode("font", false) ) {
 577        SGPath path( _font_path );
 578        const char *name = nft->getStringValue("name", "default");
 579        float size = nft->getFloatValue("size", 13.0);
 580        float slant = nft->getFloatValue("slant", 0.0);
 581        path.append( name );
 582        path.concat( ".txf" );
 583
 584        fntFont *font = new fntTexFont;
 585        font->load( (char *)path.c_str() );
 586
 587        puFont lfnt(font, size, slant);
 588        object->setLabelFont( lfnt );
 589     }
 590
 591     if ( SGPropertyNode *ncs = props->getNode("color", false) ) {
 592        sgVec4 color;
 593        color[0] = ncs->getFloatValue("red", 0.0);
 594        color[1] = ncs->getFloatValue("green", 0.0);
 595        color[2] = ncs->getFloatValue("blue", 0.0);
 596        color[3] = ncs->getFloatValue("alpha", 1.0);
 597        object->setColor(PUCOL_LABEL, color[0], color[1], color[2], color[3]);
 598     }
 599
 600     if (props->hasValue("property")) {
 601         const char * name = props->getStringValue("name");
 602         if (name == 0)
 603             name = "";
 604         const char * propname = props->getStringValue("property");
 605         SGPropertyNode_ptr node = fgGetNode(propname, true);
 606         copy_to_pui(node, object);
 607         PropertyObject* po = new PropertyObject(name, object, node);
 608         _propertyObjects.push_back(po);
 609         if(props->getBoolValue("live"))
 610             _liveObjects.push_back(po);
 611     }
 612
 613     SGPropertyNode * dest = fgGetNode("/sim/bindings", true);
 614     vector<SGPropertyNode_ptr> bindings = props->getChildren("binding");
 615     if (bindings.size() > 0) {
 616         GUIInfo * info = new GUIInfo(this);
 617
 618         for (unsigned int i = 0; i < bindings.size(); i++) {
 619             unsigned int j = 0;
 620             SGPropertyNode *binding;
 621             while (dest->getChild("binding", j))
 622                 j++;
 623
 624             binding = dest->getChild("binding", j, true);
 625             copyProperties(bindings[i], binding);
 626             info->bindings.push_back(new FGBinding(binding));
 627         }
 628         object->setCallback(action_callback);
 629         object->setUserData(info);
 630         _info.push_back(info);
 631     }
 632
 633     object->makeReturnDefault(props->getBoolValue("default"));
 634 }
 635
 636 void
 637 FGDialog::setupGroup (puGroup * group, SGPropertyNode * props,
 638                     int width, int height, sgVec4 color, bool makeFrame)
 639 {
 640     setupObject(group, props);
 641
 642     if (makeFrame) {
 643         puFrame* f = new puFrame(0, 0, width, height);
 644         f->setColorScheme(color[0], color[1], color[2], color[3]);
 645     }
 646
 647     int nChildren = props->nChildren();
 648     for (int i = 0; i < nChildren; i++)
 649         makeObject(props->getChild(i), width, height);
 650     group->close();
 651 }
 652
 653 char **
 654 FGDialog::make_char_array (int size)
 655 {
 656     char ** list = new char*[size+1];
 657     for (int i = 0; i <= size; i++)
 658         list[i] = 0;
 659     _char_arrays.push_back(list);
 660     return list;
 661 }
 662
 663
 664 \f
 665 ////////////////////////////////////////////////////////////////////////
 666 // Implementation of FGDialog::PropertyObject.
 667 ////////////////////////////////////////////////////////////////////////
 668
 669 FGDialog::PropertyObject::PropertyObject (const char * n,
 670                                            puObject * o,
 671                                            SGPropertyNode_ptr p)
 672     : name(n),
 673       object(o),
 674       node(p)
 675 {
 676 }
 677
 678
 679 // end of dialog.cxx