src/Input/input.cxx

   1 // input.cxx -- handle user input from various sources.
   2 //
   3 // Written by David Megginson, started May 2001.
   4 //
   5 // Copyright (C) 2001 David Megginson, david@megginson.com
   6 //
   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.
  11 //
  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.
  16 //
  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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include <config.h>
  25 #endif
  26
  27 #ifdef HAVE_WINDOWS_H
  28 #  include <windows.h>
  29 #endif
  30
  31 #include <simgear/compiler.h>
  32
  33 #include <math.h>
  34 #include <ctype.h>
  35
  36 #include STL_FSTREAM
  37 #include STL_STRING
  38 #include <vector>
  39
  40 #include <simgear/compiler.h>
  41
  42 #include <simgear/constants.h>
  43 #include <simgear/debug/logstream.hxx>
  44 #include <simgear/props/props.hxx>
  45
  46 #include <Aircraft/aircraft.hxx>
  47 #include <Autopilot/xmlauto.hxx>
  48 #include <Cockpit/hud.hxx>
  49 #include <Cockpit/panel.hxx>
  50 #include <Cockpit/panel_io.hxx>
  51 #include <GUI/gui.h>
  52 #include <Model/panelnode.hxx>
  53 #include <Scripting/NasalSys.hxx>
  54
  55 #include <Main/globals.hxx>
  56 #include <Main/fg_props.hxx>
  57
  58 #include "input.hxx"
  59
  60 SG_USING_STD(ifstream);
  61 SG_USING_STD(string);
  62 SG_USING_STD(vector);
  63
  64 void mouseClickHandler(int button, int updown, int x, int y);
  65 void mouseMotionHandler(int x, int y);
  66 void keyHandler(int key, int keymod, int mousex, int mousey);
  67
  68 \f
  69 ////////////////////////////////////////////////////////////////////////
  70 // Local variables.
  71 ////////////////////////////////////////////////////////////////////////
  72
  73 static FGInput * default_input = 0;
  74
  75
  76 \f
  77 ////////////////////////////////////////////////////////////////////////
  78 // Implementation of FGBinding.
  79 ////////////////////////////////////////////////////////////////////////
  80
  81 FGBinding::FGBinding ()
  82   : _command(0),
  83     _arg(new SGPropertyNode),
  84     _setting(0)
  85 {
  86 }
  87
  88 FGBinding::FGBinding (const SGPropertyNode * node)
  89   : _command(0),
  90     _arg(0),
  91     _setting(0)
  92 {
  93   read(node);
  94 }
  95
  96 void
  97 FGBinding::read (const SGPropertyNode * node)
  98 {
  99   const SGPropertyNode * conditionNode = node->getChild("condition");
 100   if (conditionNode != 0)
 101     setCondition(sgReadCondition(globals->get_props(), conditionNode));
 102
 103   _command_name = node->getStringValue("command", "");
 104   if (_command_name.empty()) {
 105     SG_LOG(SG_INPUT, SG_WARN, "No command supplied for binding.");
 106     _command = 0;
 107     return;
 108   }
 109
 110   _arg = new SGPropertyNode;
 111   _setting = 0;
 112   copyProperties(node, _arg);  // FIXME: don't use whole node!!!
 113 }
 114
 115 void
 116 FGBinding::fire () const
 117 {
 118   if (test()) {
 119     if (_command == 0)
 120       _command = globals->get_commands()->getCommand(_command_name);
 121     if (_command == 0) {
 122       SG_LOG(SG_INPUT, SG_WARN, "No command attached to binding");
 123     } else if (!(*_command)(_arg)) {
 124       SG_LOG(SG_INPUT, SG_ALERT, "Failed to execute command "
 125              << _command_name);
 126     }
 127   }
 128 }
 129
 130 void
 131 FGBinding::fire (double offset, double max) const
 132 {
 133   if (test()) {
 134     _arg->setDoubleValue("offset", offset/max);
 135     fire();
 136   }
 137 }
 138
 139 void
 140 FGBinding::fire (double setting) const
 141 {
 142   if (test()) {
 143                                 // A value is automatically added to
 144                                 // the args
 145     if (_setting == 0)          // save the setting node for efficiency
 146       _setting = _arg->getChild("setting", 0, true);
 147     _setting->setDoubleValue(setting);
 148     fire();
 149   }
 150 }
 151
 152
 153 \f
 154 ////////////////////////////////////////////////////////////////////////
 155 // Implementation of FGInput.
 156 ////////////////////////////////////////////////////////////////////////
 157
 158
 159 FGInput::FGInput ()
 160 {
 161     if (default_input == 0)
 162         default_input = this;
 163 }
 164
 165 FGInput::~FGInput ()
 166 {
 167     if (default_input == this)
 168         default_input = 0;
 169 }
 170
 171 void
 172 FGInput::init ()
 173 {
 174   _init_keyboard();
 175   _init_joystick();
 176   _init_mouse();
 177
 178   fgRegisterKeyHandler(keyHandler);
 179   fgRegisterMouseClickHandler(mouseClickHandler);
 180   fgRegisterMouseMotionHandler(mouseMotionHandler);
 181 }
 182
 183 void
 184 FGInput::reinit ()
 185 {
 186     init();
 187 }
 188
 189 void
 190 FGInput::postinit ()
 191 {
 192   _postinit_joystick();
 193 }
 194
 195 void
 196 FGInput::update (double dt)
 197 {
 198   _update_keyboard();
 199   _update_joystick(dt);
 200   _update_mouse(dt);
 201 }
 202
 203 void
 204 FGInput::suspend ()
 205 {
 206     // NO-OP
 207 }
 208
 209 void
 210 FGInput::resume ()
 211 {
 212     // NO-OP
 213 }
 214
 215 bool
 216 FGInput::is_suspended () const
 217 {
 218     return false;
 219 }
 220
 221 void
 222 FGInput::makeDefault (bool status)
 223 {
 224     if (status)
 225         default_input = this;
 226     else if (default_input == this)
 227         default_input = 0;
 228 }
 229
 230 void
 231 FGInput::doKey (int k, int modifiers, int x, int y)
 232 {
 233                                 // Sanity check.
 234   if (k < 0 || k >= MAX_KEYS) {
 235     SG_LOG(SG_INPUT, SG_WARN, "Key value " << k << " out of range");
 236     return;
 237   }
 238
 239   button &b = _key_bindings[k];
 240
 241                                 // Key pressed.
 242   if (modifiers&KEYMOD_RELEASED == 0) {
 243     SG_LOG( SG_INPUT, SG_DEBUG, "User pressed key " << k
 244             << " with modifiers " << modifiers );
 245     if (!b.last_state || b.is_repeatable) {
 246       const binding_list_t &bindings =
 247         _find_key_bindings(k, modifiers);
 248       int max = bindings.size();
 249       if (max > 0) {
 250         for (int i = 0; i < max; i++)
 251           bindings[i]->fire();
 252         return;
 253       }
 254     }
 255   }
 256                                 // Key released.
 257   else {
 258     SG_LOG(SG_INPUT, SG_DEBUG, "User released key " << k
 259            << " with modifiers " << modifiers);
 260     if (b.last_state) {
 261       const binding_list_t &bindings =
 262         _find_key_bindings(k, modifiers);
 263       int max = bindings.size();
 264       if (max > 0) {
 265         for (int i = 0; i < max; i++)
 266           bindings[i]->fire();
 267         return;
 268       }
 269     }
 270   }
 271 }
 272
 273 void
 274 FGInput::doMouseClick (int b, int updown, int x, int y)
 275 {
 276   int modifiers = fgGetKeyModifiers();
 277
 278   mouse &m = _mouse_bindings[0];
 279   mouse_mode &mode = m.modes[m.current_mode];
 280
 281                                 // Let the property manager know.
 282   if (b >= 0 && b < MAX_MOUSE_BUTTONS)
 283     m.mouse_button_nodes[b]->setBoolValue(updown == MOUSE_BUTTON_DOWN);
 284
 285                                 // Pass on to PUI and the panel if
 286                                 // requested, and return if one of
 287                                 // them consumes the event.
 288   if (mode.pass_through) {
 289     if (puMouse(b, updown, x, y))
 290       return;
 291     else if ((globals->get_current_panel() != 0) &&
 292              globals->get_current_panel()->getVisibility() &&
 293              globals->get_current_panel()->doMouseAction(b, updown, x, y))
 294       return;
 295     else if (fgHandle3DPanelMouseEvent(b, updown, x, y))
 296       return;
 297   }
 298
 299                                 // OK, PUI and the panel didn't want the click
 300   if (b >= MAX_MOUSE_BUTTONS) {
 301     SG_LOG(SG_INPUT, SG_ALERT, "Mouse button " << b
 302            << " where only " << MAX_MOUSE_BUTTONS << " expected");
 303     return;
 304   }
 305
 306   _update_button(m.modes[m.current_mode].buttons[b], modifiers, 0 != updown, x, y);
 307 }
 308
 309 void
 310 FGInput::doMouseMotion (int x, int y)
 311 {
 312   // Don't call fgGetKeyModifiers() here, until we are using a
 313   // toolkit that supports getting the mods from outside a key
 314   // callback.  Glut doesn't.
 315   int modifiers = KEYMOD_NONE;
 316
 317   int xsize = fgGetInt("/sim/startup/xsize", 800);
 318   int ysize = fgGetInt("/sim/startup/ysize", 600);
 319
 320   mouse &m = _mouse_bindings[0];
 321
 322   if (m.current_mode < 0 || m.current_mode >= m.nModes) {
 323       m.x = x;
 324       m.y = y;
 325       return;
 326   }
 327   mouse_mode &mode = m.modes[m.current_mode];
 328
 329                                 // Pass on to PUI if requested, and return
 330                                 // if PUI consumed the event.
 331   if (mode.pass_through && puMouse(x, y)) {
 332       m.x = x;
 333       m.y = y;
 334       return;
 335   }
 336
 337                                 // OK, PUI didn't want the event,
 338                                 // so we can play with it.
 339   if (x != m.x) {
 340     int delta = x - m.x;
 341     for (unsigned int i = 0; i < mode.x_bindings[modifiers].size(); i++)
 342       mode.x_bindings[modifiers][i]->fire(double(delta), double(xsize));
 343   }
 344   if (y != m.y) {
 345     int delta = y - m.y;
 346     for (unsigned int i = 0; i < mode.y_bindings[modifiers].size(); i++)
 347       mode.y_bindings[modifiers][i]->fire(double(delta), double(ysize));
 348   }
 349
 350                                 // Constrain the mouse if requested
 351   if (mode.constrained) {
 352     bool need_warp = false;
 353     if (x <= 0) {
 354       x = xsize - 2;
 355       need_warp = true;
 356     } else if (x >= (xsize-1)) {
 357       x = 1;
 358       need_warp = true;
 359     }
 360
 361     if (y <= 0) {
 362       y = ysize - 2;
 363       need_warp = true;
 364     } else if (y >= (ysize-1)) {
 365       y = 1;
 366       need_warp = true;
 367     }
 368
 369     if (need_warp)
 370       fgWarpMouse(x, y);
 371   }
 372   m.x = x;
 373   m.y = y;
 374 }
 375
 376 void
 377 FGInput::_init_keyboard ()
 378 {
 379   SG_LOG(SG_INPUT, SG_DEBUG, "Initializing key bindings");
 380   SGPropertyNode * key_nodes = fgGetNode("/input/keyboard");
 381   if (key_nodes == 0) {
 382     SG_LOG(SG_INPUT, SG_WARN, "No key bindings (/input/keyboard)!!");
 383     key_nodes = fgGetNode("/input/keyboard", true);
 384   }
 385
 386   vector<SGPropertyNode_ptr> keys = key_nodes->getChildren("key");
 387   for (unsigned int i = 0; i < keys.size(); i++) {
 388     int index = keys[i]->getIndex();
 389     SG_LOG(SG_INPUT, SG_DEBUG, "Binding key " << index);
 390
 391     _key_bindings[index].bindings->clear();
 392     _key_bindings[index].is_repeatable = keys[i]->getBoolValue("repeatable");
 393     _read_bindings(keys[i], _key_bindings[index].bindings, KEYMOD_NONE);
 394   }
 395 }
 396
 397
 398 void
 399 FGInput::_scan_joystick_dir(SGPath *path, SGPropertyNode* node, int *index)
 400 {
 401   ulDir *dir = ulOpenDir(path->c_str());
 402   if (dir) {
 403     ulDirEnt* dent;
 404     while ((dent = ulReadDir(dir)) != 0) {
 405       if (dent->d_name[0] == '.')
 406         continue;
 407
 408       SGPath p(path->str());
 409       p.append(dent->d_name);
 410       _scan_joystick_dir(&p, node, index);
 411     }
 412     ulCloseDir(dir);
 413
 414   } else if (path->extension() == "xml") {
 415     SG_LOG(SG_INPUT, SG_DEBUG, "Reading joystick file " << path->str());
 416     SGPropertyNode *n = node->getChild("js-named", (*index)++, true);
 417     readProperties(path->str(), n);
 418     n->setStringValue("source", path->c_str());
 419   }
 420 }
 421
 422
 423 void
 424 FGInput::_init_joystick ()
 425 {
 426   jsInit();
 427                                 // TODO: zero the old bindings first.
 428   SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick bindings");
 429   SGPropertyNode * js_nodes = fgGetNode("/input/joysticks");
 430   if (js_nodes == 0) {
 431     SG_LOG(SG_INPUT, SG_WARN, "No joystick bindings (/input/joysticks)!!");
 432     js_nodes = fgGetNode("/input/joysticks", true);
 433   }
 434
 435   // read all joystick xml files into /input/joysticks/js_named[1000++]
 436   SGPath path(globals->get_fg_root());
 437   path.append("Input/Joysticks");
 438   int js_named_index = 1000;
 439   _scan_joystick_dir(&path, js_nodes, &js_named_index);
 440
 441   // build name->node map with each <name> (reverse order)
 442   map<string, SGPropertyNode_ptr> jsmap;
 443   vector<SGPropertyNode_ptr> js_named = js_nodes->getChildren("js-named");
 444
 445   for (int k = (int)js_named.size() - 1; k >= 0; k--) {
 446     SGPropertyNode *n = js_named[k];
 447     vector<SGPropertyNode_ptr> names = n->getChildren("name");
 448     if (names.size() && (n->getChildren("axis").size() || n->getChildren("button").size()))
 449       for (unsigned int j = 0; j < names.size(); j++)
 450         jsmap[names[j]->getStringValue()] = n;
 451   }
 452
 453   for (int i = 0; i < MAX_JOYSTICKS; i++) {
 454     jsJoystick * js = new jsJoystick(i);
 455     _joystick_bindings[i].js = js;
 456     if (js->notWorking()) {
 457       SG_LOG(SG_INPUT, SG_DEBUG, "Joystick " << i << " not found");
 458       continue;
 459     }
 460
 461     const char * name = js->getName();
 462     SGPropertyNode_ptr js_node = js_nodes->getChild("js", i);
 463
 464     if (js_node) {
 465       SG_LOG(SG_INPUT, SG_INFO, "Using existing bindings for joystick " << i);
 466
 467     } else {
 468       SG_LOG(SG_INPUT, SG_INFO, "Looking for bindings for joystick \"" << name << '"');
 469       SGPropertyNode_ptr named;
 470
 471       if ((named = jsmap[name])) {
 472         string source = named->getStringValue("source", "user defined");
 473         SG_LOG(SG_INPUT, SG_INFO, "... found joystick: \"" << source << '"');
 474
 475       } else if ((named = jsmap["default"])) {
 476         string source = named->getStringValue("source", "user defined");
 477         SG_LOG(SG_INPUT, SG_INFO, "No config found for joystick \"" << name
 478             << "\"\nUsing default: \"" << source << '"');
 479
 480       } else {
 481         throw sg_throwable(string("No default joystick found! (<name>default</name>)"));
 482       }
 483
 484       js_node = js_nodes->getChild("js", i, true);
 485       copyProperties(named, js_node);
 486       js_node->setStringValue("id", name);
 487     }
 488
 489
 490 #ifdef WIN32
 491     JOYCAPS jsCaps ;
 492     joyGetDevCaps( i, &jsCaps, sizeof(jsCaps) );
 493     int nbuttons = jsCaps.wNumButtons;
 494     if (nbuttons > MAX_JOYSTICK_BUTTONS) nbuttons = MAX_JOYSTICK_BUTTONS;
 495 #else
 496     int nbuttons = MAX_JOYSTICK_BUTTONS;
 497 #endif
 498
 499     int naxes = js->getNumAxes();
 500     if (naxes > MAX_JOYSTICK_AXES) naxes = MAX_JOYSTICK_AXES;
 501     _joystick_bindings[i].naxes = naxes;
 502     _joystick_bindings[i].nbuttons = nbuttons;
 503
 504     SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick " << i);
 505
 506                                 // Set up range arrays
 507     float minRange[MAX_JOYSTICK_AXES];
 508     float maxRange[MAX_JOYSTICK_AXES];
 509     float center[MAX_JOYSTICK_AXES];
 510
 511                                 // Initialize with default values
 512     js->getMinRange(minRange);
 513     js->getMaxRange(maxRange);
 514     js->getCenter(center);
 515
 516                                 // Allocate axes and buttons
 517     _joystick_bindings[i].axes = new axis[naxes];
 518     _joystick_bindings[i].buttons = new button[nbuttons];
 519
 520
 521     //
 522     // Initialize the axes.
 523     //
 524     vector<SGPropertyNode_ptr> axes = js_node->getChildren("axis");
 525     size_t nb_axes = axes.size();
 526     int j;
 527     for (j = 0; j < (int)nb_axes; j++) {
 528       const SGPropertyNode * axis_node = axes[j];
 529       const SGPropertyNode * num_node = axis_node->getChild("number");
 530       int n_axis = axis_node->getIndex();
 531       if (num_node != 0) {
 532           n_axis = num_node->getIntValue(TGT_PLATFORM, -1);
 533
 534           // Silently ignore platforms that are not specified within the
 535           // <number></number> section
 536           if (n_axis < 0)
 537              continue;
 538       }
 539
 540       if (n_axis >= naxes) {
 541           SG_LOG(SG_INPUT, SG_DEBUG, "Dropping bindings for axis " << n_axis);
 542           continue;
 543       }
 544       axis &a = _joystick_bindings[i].axes[n_axis];
 545
 546       js->setDeadBand(n_axis, axis_node->getDoubleValue("dead-band", 0.0));
 547
 548       a.tolerance = axis_node->getDoubleValue("tolerance", 0.002);
 549       minRange[n_axis] = axis_node->getDoubleValue("min-range", minRange[n_axis]);
 550       maxRange[n_axis] = axis_node->getDoubleValue("max-range", maxRange[n_axis]);
 551       center[n_axis] = axis_node->getDoubleValue("center", center[n_axis]);
 552
 553       _read_bindings(axis_node, a.bindings, KEYMOD_NONE);
 554
 555       // Initialize the virtual axis buttons.
 556       _init_button(axis_node->getChild("low"), a.low, "low");
 557       a.low_threshold = axis_node->getDoubleValue("low-threshold", -0.9);
 558
 559       _init_button(axis_node->getChild("high"), a.high, "high");
 560       a.high_threshold = axis_node->getDoubleValue("high-threshold", 0.9);
 561       a.interval_sec = axis_node->getDoubleValue("interval-sec",0.0);
 562       a.last_dt = 0.0;
 563     }
 564
 565     //
 566     // Initialize the buttons.
 567     //
 568     vector<SGPropertyNode_ptr> buttons = js_node->getChildren("button");
 569     char buf[32];
 570     for (j = 0; (j < (int)buttons.size()) && (j < nbuttons); j++) {
 571       const SGPropertyNode * button_node = buttons[j];
 572       const SGPropertyNode * num_node = button_node->getChild("number");
 573       size_t n_but = button_node->getIndex();
 574       if (num_node != 0) {
 575           n_but = num_node->getIntValue(TGT_PLATFORM,n_but);
 576       }
 577
 578       if (n_but >= (size_t)nbuttons) {
 579           SG_LOG(SG_INPUT, SG_DEBUG, "Dropping bindings for button " << n_but);
 580           continue;
 581       }
 582
 583       sprintf(buf, "%d", n_but);
 584       SG_LOG(SG_INPUT, SG_DEBUG, "Initializing button " << n_but);
 585       _init_button(button_node,
 586                    _joystick_bindings[i].buttons[n_but],
 587                    buf);
 588
 589       // get interval-sec property
 590       button &b = _joystick_bindings[i].buttons[n_but];
 591       if (button_node != 0) {
 592         b.interval_sec = button_node->getDoubleValue("interval-sec",0.0);
 593         b.last_dt = 0.0;
 594       }
 595     }
 596
 597     js->setMinRange(minRange);
 598     js->setMaxRange(maxRange);
 599     js->setCenter(center);
 600   }
 601
 602   for (unsigned int m = 0; m < js_named.size(); m++)
 603     js_nodes->removeChild("js-named", js_named[m]->getIndex(), false);
 604 }
 605
 606
 607 void
 608 FGInput::_postinit_joystick()
 609 {
 610   vector<SGPropertyNode_ptr> js = fgGetNode("/input/joysticks")->getChildren("js");
 611   for (unsigned int i = 0; i < js.size(); i++) {
 612     vector<SGPropertyNode_ptr> nasal = js[i]->getChildren("nasal");
 613     for (unsigned int j = 0; j < nasal.size(); j++)
 614       ((FGNasalSys*)globals->get_subsystem("nasal"))->handleCommand(nasal[j]);
 615   }
 616 }
 617
 618
 619 //
 620 // Map of all known cursor names
 621 // This used to contain all the Glut cursors, but those are
 622 // not defined by other toolkits.  It now supports only the cursor
 623 // images we actually use, in the interest of portability.  Someday,
 624 // it would be cool to write an OpenGL cursor renderer, with the
 625 // cursors defined as textures referenced in the property tree.  This
 626 // list could then be eliminated. -Andy
 627 //
 628 static struct {
 629   const char * name;
 630   int cursor;
 631 } mouse_cursor_map[] = {
 632   { "none", MOUSE_CURSOR_NONE },
 633   { "inherit", MOUSE_CURSOR_POINTER },
 634   { "wait", MOUSE_CURSOR_WAIT },
 635   { "crosshair", MOUSE_CURSOR_CROSSHAIR },
 636   { "left-right", MOUSE_CURSOR_LEFTRIGHT },
 637   { 0, 0 }
 638 };
 639
 640 void
 641 FGInput::_init_mouse ()
 642 {
 643   SG_LOG(SG_INPUT, SG_DEBUG, "Initializing mouse bindings");
 644
 645   SGPropertyNode * mouse_nodes = fgGetNode("/input/mice");
 646   if (mouse_nodes == 0) {
 647     SG_LOG(SG_INPUT, SG_WARN, "No mouse bindings (/input/mice)!!");
 648     mouse_nodes = fgGetNode("/input/mice", true);
 649   }
 650
 651   int j;
 652   for (int i = 0; i < MAX_MICE; i++) {
 653     SGPropertyNode * mouse_node = mouse_nodes->getChild("mouse", i, true);
 654     mouse &m = _mouse_bindings[i];
 655
 656                                 // Grab node pointers
 657     char buf[64];
 658     sprintf(buf, "/devices/status/mice/mouse[%d]/mode", i);
 659     m.mode_node = fgGetNode(buf);
 660     if (m.mode_node == NULL) {
 661       m.mode_node = fgGetNode(buf, true);
 662       m.mode_node->setIntValue(0);
 663     }
 664     for (j = 0; j < MAX_MOUSE_BUTTONS; j++) {
 665       sprintf(buf, "/devices/status/mice/mouse[%d]/button[%d]", i, j);
 666       m.mouse_button_nodes[j] = fgGetNode(buf, true);
 667       m.mouse_button_nodes[j]->setBoolValue(false);
 668     }
 669
 670                                 // Read all the modes
 671     m.nModes = mouse_node->getIntValue("mode-count", 1);
 672     m.modes = new mouse_mode[m.nModes];
 673
 674     for (int j = 0; j < m.nModes; j++) {
 675       int k;
 676
 677                                 // Read the mouse cursor for this mode
 678       SGPropertyNode * mode_node = mouse_node->getChild("mode", j, true);
 679       const char * cursor_name =
 680         mode_node->getStringValue("cursor", "inherit");
 681       m.modes[j].cursor = MOUSE_CURSOR_POINTER;
 682       for (k = 0; mouse_cursor_map[k].name != 0; k++) {
 683         if (!strcmp(mouse_cursor_map[k].name, cursor_name)) {
 684           m.modes[j].cursor = mouse_cursor_map[k].cursor;
 685           break;
 686         }
 687       }
 688
 689                                 // Read other properties for this mode
 690       m.modes[j].constrained = mode_node->getBoolValue("constrained", false);
 691       m.modes[j].pass_through = mode_node->getBoolValue("pass-through", false);
 692
 693                                 // Read the button bindings for this mode
 694       m.modes[j].buttons = new button[MAX_MOUSE_BUTTONS];
 695       char buf[32];
 696       for (k = 0; k < MAX_MOUSE_BUTTONS; k++) {
 697         sprintf(buf, "mouse button %d", k);
 698         SG_LOG(SG_INPUT, SG_DEBUG, "Initializing mouse button " << k);
 699         _init_button(mode_node->getChild("button", k),
 700                      m.modes[j].buttons[k],
 701                      buf);
 702       }
 703
 704                                 // Read the axis bindings for this mode
 705       _read_bindings(mode_node->getChild("x-axis", 0, true),
 706                      m.modes[j].x_bindings,
 707                      KEYMOD_NONE);
 708       _read_bindings(mode_node->getChild("y-axis", 0, true),
 709                      m.modes[j].y_bindings,
 710                      KEYMOD_NONE);
 711     }
 712   }
 713 }
 714
 715
 716 void
 717 FGInput::_init_button (const SGPropertyNode * node,
 718                        button &b,
 719                        const string name)
 720 {
 721   if (node == 0) {
 722     SG_LOG(SG_INPUT, SG_DEBUG, "No bindings for button " << name);
 723   } else {
 724     b.is_repeatable = node->getBoolValue("repeatable", b.is_repeatable);
 725
 726                 // Get the bindings for the button
 727     _read_bindings(node, b.bindings, KEYMOD_NONE);
 728   }
 729 }
 730
 731
 732 void
 733 FGInput::_update_keyboard ()
 734 {
 735   // no-op
 736 }
 737
 738
 739 void
 740 FGInput::_update_joystick (double dt)
 741 {
 742   int modifiers = KEYMOD_NONE;  // FIXME: any way to get the real ones?
 743   int buttons;
 744   // float js_val, diff;
 745   float axis_values[MAX_JOYSTICK_AXES];
 746
 747   int i;
 748   int j;
 749
 750   for ( i = 0; i < MAX_JOYSTICKS; i++) {
 751
 752     jsJoystick * js = _joystick_bindings[i].js;
 753     if (js == 0 || js->notWorking())
 754       continue;
 755
 756     js->read(&buttons, axis_values);
 757
 758
 759                                 // Fire bindings for the axes.
 760     for ( j = 0; j < _joystick_bindings[i].naxes; j++) {
 761       axis &a = _joystick_bindings[i].axes[j];
 762
 763                                 // Do nothing if the axis position
 764                                 // is unchanged; only a change in
 765                                 // position fires the bindings.
 766       if (fabs(axis_values[j] - a.last_value) > a.tolerance) {
 767 //      SG_LOG(SG_INPUT, SG_DEBUG, "Axis " << j << " has moved");
 768         a.last_value = axis_values[j];
 769 //      SG_LOG(SG_INPUT, SG_DEBUG, "There are "
 770 //             << a.bindings[modifiers].size() << " bindings");
 771         for (unsigned int k = 0; k < a.bindings[modifiers].size(); k++)
 772           a.bindings[modifiers][k]->fire(axis_values[j]);
 773       }
 774
 775                                 // do we have to emulate axis buttons?
 776       a.last_dt += dt;
 777       if(a.last_dt >= a.interval_sec) {
 778         if (a.low.bindings[modifiers].size())
 779           _update_button(_joystick_bindings[i].axes[j].low,
 780                          modifiers,
 781                          axis_values[j] < a.low_threshold,
 782                          -1, -1);
 783
 784         if (a.high.bindings[modifiers].size())
 785           _update_button(_joystick_bindings[i].axes[j].high,
 786                          modifiers,
 787                          axis_values[j] > a.high_threshold,
 788                          -1, -1);
 789          a.last_dt -= a.interval_sec;
 790       }
 791     }
 792
 793                                 // Fire bindings for the buttons.
 794     for (j = 0; j < _joystick_bindings[i].nbuttons; j++) {
 795       button &b = _joystick_bindings[i].buttons[j];
 796       b.last_dt += dt;
 797       if(b.last_dt >= b.interval_sec) {
 798         _update_button(_joystick_bindings[i].buttons[j],
 799                        modifiers,
 800                        (buttons & (1 << j)) > 0,
 801                        -1, -1);
 802         b.last_dt -= b.interval_sec;
 803       }
 804     }
 805   }
 806 }
 807
 808 void
 809 FGInput::_update_mouse ( double dt )
 810 {
 811   mouse &m = _mouse_bindings[0];
 812   int mode =  m.mode_node->getIntValue();
 813   if (mode != m.current_mode) {
 814     m.current_mode = mode;
 815     m.timeout = fgGetDouble( "/sim/mouse/cursor-timeout-sec", 10.0 );
 816     if (mode >= 0 && mode < m.nModes) {
 817       fgSetMouseCursor(m.modes[mode].cursor);
 818       m.x = fgGetInt("/sim/startup/xsize", 800) / 2;
 819       m.y = fgGetInt("/sim/startup/ysize", 600) / 2;
 820       fgWarpMouse(m.x, m.y);
 821     } else {
 822       SG_LOG(SG_INPUT, SG_DEBUG, "Mouse mode " << mode << " out of range");
 823       fgSetMouseCursor(MOUSE_CURSOR_POINTER);
 824     }
 825   }
 826
 827   if ( fgGetBool( "/sim/mouse/hide-cursor", true ) ) {
 828       if ( m.x != m.save_x || m.y != m.save_y ) {
 829           m.timeout = fgGetDouble( "/sim/mouse/cursor-timeout-sec", 10.0 );
 830           fgSetMouseCursor(m.modes[mode].cursor);
 831       } else {
 832           m.timeout -= dt;
 833           if ( m.timeout <= 0.0 ) {
 834               fgSetMouseCursor(MOUSE_CURSOR_NONE);
 835               m.timeout = 0.0;
 836           }
 837       }
 838       m.save_x = m.x;
 839       m.save_y = m.y;
 840   }
 841 }
 842
 843 void
 844 FGInput::_update_button (button &b, int modifiers, bool pressed,
 845                          int x, int y)
 846 {
 847   if (pressed) {
 848                                 // The press event may be repeated.
 849     if (!b.last_state || b.is_repeatable) {
 850       SG_LOG( SG_INPUT, SG_DEBUG, "Button has been pressed" );
 851       for (unsigned int k = 0; k < b.bindings[modifiers].size(); k++)
 852         b.bindings[modifiers][k]->fire(x, y);
 853     }
 854   } else {
 855                                 // The release event is never repeated.
 856     if (b.last_state) {
 857       SG_LOG( SG_INPUT, SG_DEBUG, "Button has been released" );
 858       for (unsigned int k = 0; k < b.bindings[modifiers|KEYMOD_RELEASED].size(); k++)
 859         b.bindings[modifiers|KEYMOD_RELEASED][k]->fire(x, y);
 860     }
 861   }
 862
 863   b.last_state = pressed;
 864 }
 865
 866
 867 void
 868 FGInput::_read_bindings (const SGPropertyNode * node,
 869                          binding_list_t * binding_list,
 870                          int modifiers)
 871 {
 872   SG_LOG(SG_INPUT, SG_DEBUG, "Reading all bindings");
 873   vector<SGPropertyNode_ptr> bindings = node->getChildren("binding");
 874   for (unsigned int i = 0; i < bindings.size(); i++) {
 875     SG_LOG(SG_INPUT, SG_DEBUG, "Reading binding "
 876            << bindings[i]->getStringValue("command"));
 877     binding_list[modifiers].push_back(new FGBinding(bindings[i]));
 878   }
 879
 880                                 // Read nested bindings for modifiers
 881   if (node->getChild("mod-up") != 0)
 882     _read_bindings(node->getChild("mod-up"), binding_list,
 883                    modifiers|KEYMOD_RELEASED);
 884
 885   if (node->getChild("mod-shift") != 0)
 886     _read_bindings(node->getChild("mod-shift"), binding_list,
 887                    modifiers|KEYMOD_SHIFT);
 888
 889   if (node->getChild("mod-ctrl") != 0)
 890     _read_bindings(node->getChild("mod-ctrl"), binding_list,
 891                    modifiers|KEYMOD_CTRL);
 892
 893   if (node->getChild("mod-alt") != 0)
 894     _read_bindings(node->getChild("mod-alt"), binding_list,
 895                    modifiers|KEYMOD_ALT);
 896 }
 897
 898
 899 const vector<FGBinding *> &
 900 FGInput::_find_key_bindings (unsigned int k, int modifiers)
 901 {
 902   unsigned char kc = (unsigned char)k;
 903   button &b = _key_bindings[k];
 904
 905                                 // Try it straight, first.
 906   if (b.bindings[modifiers].size() > 0)
 907     return b.bindings[modifiers];
 908
 909                                 // Alt-Gr is CTRL+ALT
 910   else if (modifiers&(KEYMOD_CTRL|KEYMOD_ALT))
 911     return _find_key_bindings(k, modifiers&~(KEYMOD_CTRL|KEYMOD_ALT));
 912
 913                                 // Try removing the control modifier
 914                                 // for control keys.
 915   else if ((modifiers&KEYMOD_CTRL) && iscntrl(kc))
 916     return _find_key_bindings(k, modifiers&~KEYMOD_CTRL);
 917
 918                                 // Try removing shift modifier
 919                                 // for upper case or any punctuation
 920                                 // (since different keyboards will
 921                                 // shift different punctuation types)
 922   else if ((modifiers&KEYMOD_SHIFT) && (isupper(kc) || ispunct(kc)))
 923     return _find_key_bindings(k, modifiers&~KEYMOD_SHIFT);
 924
 925                                 // Try removing alt modifier for
 926                                 // high-bit characters.
 927   else if ((modifiers&KEYMOD_ALT) && k >= 128 && k < 256)
 928     return _find_key_bindings(k, modifiers&~KEYMOD_ALT);
 929
 930                                 // Give up and return the empty vector.
 931   else
 932     return b.bindings[modifiers];
 933 }
 934
 935
 936 \f
 937 ////////////////////////////////////////////////////////////////////////
 938 // Implementation of FGInput::button.
 939 ////////////////////////////////////////////////////////////////////////
 940
 941 FGInput::button::button ()
 942   : is_repeatable(false),
 943     last_state(-1)
 944 {
 945 }
 946
 947 FGInput::button::~button ()
 948 {
 949                                 // FIXME: memory leak
 950 //   for (int i = 0; i < KEYMOD_MAX; i++)
 951 //     for (int j = 0; i < bindings[i].size(); j++)
 952 //       delete bindings[i][j];
 953 }
 954
 955
 956 \f
 957 ////////////////////////////////////////////////////////////////////////
 958 // Implementation of FGInput::axis.
 959 ////////////////////////////////////////////////////////////////////////
 960
 961 FGInput::axis::axis ()
 962   : last_value(9999999),
 963     tolerance(0.002),
 964     low_threshold(-0.9),
 965     high_threshold(0.9)
 966 {
 967 }
 968
 969 FGInput::axis::~axis ()
 970 {
 971 //   for (int i = 0; i < KEYMOD_MAX; i++)
 972 //     for (int j = 0; i < bindings[i].size(); j++)
 973 //       delete bindings[i][j];
 974 }
 975
 976
 977 \f
 978 ////////////////////////////////////////////////////////////////////////
 979 // Implementation of FGInput::joystick.
 980 ////////////////////////////////////////////////////////////////////////
 981
 982 FGInput::joystick::joystick ()
 983 {
 984 }
 985
 986 FGInput::joystick::~joystick ()
 987 {
 988 //   delete js;
 989   delete[] axes;
 990   delete[] buttons;
 991 }
 992
 993
 994 \f
 995 ////////////////////////////////////////////////////////////////////////
 996 // Implementation of FGInput::mouse_mode
 997 ////////////////////////////////////////////////////////////////////////
 998
 999 FGInput::mouse_mode::mouse_mode ()
1000   : cursor(MOUSE_CURSOR_POINTER),
1001     constrained(false),
1002     pass_through(false),
1003     buttons(0)
1004 {
1005 }
1006
1007 FGInput::mouse_mode::~mouse_mode ()
1008 {
1009                                 // FIXME: memory leak
1010 //   for (int i = 0; i < KEYMOD_MAX; i++) {
1011 //     int j;
1012 //     for (j = 0; i < x_bindings[i].size(); j++)
1013 //       delete bindings[i][j];
1014 //     for (j = 0; j < y_bindings[i].size(); j++)
1015 //       delete bindings[i][j];
1016 //   }
1017   delete [] buttons;
1018 }
1019
1020
1021 \f
1022 ////////////////////////////////////////////////////////////////////////
1023 // Implementation of FGInput::mouse
1024 ////////////////////////////////////////////////////////////////////////
1025
1026 FGInput::mouse::mouse ()
1027   : x(-1),
1028     y(-1),
1029     nModes(1),
1030     current_mode(0),
1031     modes(0)
1032 {
1033 }
1034
1035 FGInput::mouse::~mouse ()
1036 {
1037   delete [] modes;
1038 }
1039
1040 ////////////////////////////////////////////////////////////////////////
1041 // Implementation of OS callbacks.
1042 ////////////////////////////////////////////////////////////////////////
1043
1044 void keyHandler(int key, int keymod, int mousex, int mousey)
1045 {
1046     if((keymod & KEYMOD_RELEASED) == 0)
1047         if(puKeyboard(key, PU_DOWN))
1048             return;
1049
1050     if(default_input)
1051         default_input->doKey(key, keymod, mousex, mousey);
1052 }
1053
1054 void mouseClickHandler(int button, int updown, int x, int y)
1055 {
1056     if(default_input)
1057         default_input->doMouseClick(button, updown, x, y);
1058 }
1059
1060 void mouseMotionHandler(int x, int y)
1061 {
1062     if (default_input != 0)
1063         default_input->doMouseMotion(x, y);
1064 }