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", true);
 430
 431   // read all joystick xml files into /input/joysticks/js_named[1000++]
 432   SGPath path(globals->get_fg_root());
 433   path.append("Input/Joysticks");
 434   int js_named_index = 1000;
 435   _scan_joystick_dir(&path, js_nodes, &js_named_index);
 436
 437   // build name->node map with each <name> (reverse order)
 438   map<string, SGPropertyNode_ptr> jsmap;
 439   vector<SGPropertyNode_ptr> js_named = js_nodes->getChildren("js-named");
 440
 441   for (int k = (int)js_named.size() - 1; k >= 0; k--) {
 442     SGPropertyNode *n = js_named[k];
 443     vector<SGPropertyNode_ptr> names = n->getChildren("name");
 444     if (names.size() && (n->getChildren("axis").size() || n->getChildren("button").size()))
 445       for (unsigned int j = 0; j < names.size(); j++)
 446         jsmap[names[j]->getStringValue()] = n;
 447   }
 448
 449   for (int i = 0; i < MAX_JOYSTICKS; i++) {
 450     jsJoystick * js = new jsJoystick(i);
 451     _joystick_bindings[i].js = js;
 452     if (js->notWorking()) {
 453       SG_LOG(SG_INPUT, SG_DEBUG, "Joystick " << i << " not found");
 454       continue;
 455     }
 456
 457     const char * name = js->getName();
 458     SGPropertyNode_ptr js_node = js_nodes->getChild("js", i);
 459
 460     if (js_node) {
 461       SG_LOG(SG_INPUT, SG_INFO, "Using existing bindings for joystick " << i);
 462
 463     } else {
 464       SG_LOG(SG_INPUT, SG_INFO, "Looking for bindings for joystick \"" << name << '"');
 465       SGPropertyNode_ptr named;
 466
 467       if ((named = jsmap[name])) {
 468         string source = named->getStringValue("source", "user defined");
 469         SG_LOG(SG_INPUT, SG_INFO, "... found joystick: \"" << source << '"');
 470
 471       } else if ((named = jsmap["default"])) {
 472         string source = named->getStringValue("source", "user defined");
 473         SG_LOG(SG_INPUT, SG_INFO, "No config found for joystick \"" << name
 474             << "\"\nUsing default: \"" << source << '"');
 475
 476       } else {
 477         throw sg_throwable(string("No joystick with <name>default</name> entry found!"));
 478       }
 479
 480       js_node = js_nodes->getChild("js", i, true);
 481       copyProperties(named, js_node);
 482       js_node->setStringValue("id", name);
 483     }
 484
 485
 486 #ifdef WIN32
 487     JOYCAPS jsCaps ;
 488     joyGetDevCaps( i, &jsCaps, sizeof(jsCaps) );
 489     int nbuttons = jsCaps.wNumButtons;
 490     if (nbuttons > MAX_JOYSTICK_BUTTONS) nbuttons = MAX_JOYSTICK_BUTTONS;
 491 #else
 492     int nbuttons = MAX_JOYSTICK_BUTTONS;
 493 #endif
 494
 495     int naxes = js->getNumAxes();
 496     if (naxes > MAX_JOYSTICK_AXES) naxes = MAX_JOYSTICK_AXES;
 497     _joystick_bindings[i].naxes = naxes;
 498     _joystick_bindings[i].nbuttons = nbuttons;
 499
 500     SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick " << i);
 501
 502                                 // Set up range arrays
 503     float minRange[MAX_JOYSTICK_AXES];
 504     float maxRange[MAX_JOYSTICK_AXES];
 505     float center[MAX_JOYSTICK_AXES];
 506
 507                                 // Initialize with default values
 508     js->getMinRange(minRange);
 509     js->getMaxRange(maxRange);
 510     js->getCenter(center);
 511
 512                                 // Allocate axes and buttons
 513     _joystick_bindings[i].axes = new axis[naxes];
 514     _joystick_bindings[i].buttons = new button[nbuttons];
 515
 516
 517     //
 518     // Initialize the axes.
 519     //
 520     vector<SGPropertyNode_ptr> axes = js_node->getChildren("axis");
 521     size_t nb_axes = axes.size();
 522     int j;
 523     for (j = 0; j < (int)nb_axes; j++) {
 524       const SGPropertyNode * axis_node = axes[j];
 525       const SGPropertyNode * num_node = axis_node->getChild("number");
 526       int n_axis = axis_node->getIndex();
 527       if (num_node != 0) {
 528           n_axis = num_node->getIntValue(TGT_PLATFORM, -1);
 529
 530           // Silently ignore platforms that are not specified within the
 531           // <number></number> section
 532           if (n_axis < 0)
 533              continue;
 534       }
 535
 536       if (n_axis >= naxes) {
 537           SG_LOG(SG_INPUT, SG_DEBUG, "Dropping bindings for axis " << n_axis);
 538           continue;
 539       }
 540       axis &a = _joystick_bindings[i].axes[n_axis];
 541
 542       js->setDeadBand(n_axis, axis_node->getDoubleValue("dead-band", 0.0));
 543
 544       a.tolerance = axis_node->getDoubleValue("tolerance", 0.002);
 545       minRange[n_axis] = axis_node->getDoubleValue("min-range", minRange[n_axis]);
 546       maxRange[n_axis] = axis_node->getDoubleValue("max-range", maxRange[n_axis]);
 547       center[n_axis] = axis_node->getDoubleValue("center", center[n_axis]);
 548
 549       _read_bindings(axis_node, a.bindings, KEYMOD_NONE);
 550
 551       // Initialize the virtual axis buttons.
 552       _init_button(axis_node->getChild("low"), a.low, "low");
 553       a.low_threshold = axis_node->getDoubleValue("low-threshold", -0.9);
 554
 555       _init_button(axis_node->getChild("high"), a.high, "high");
 556       a.high_threshold = axis_node->getDoubleValue("high-threshold", 0.9);
 557       a.interval_sec = axis_node->getDoubleValue("interval-sec",0.0);
 558       a.last_dt = 0.0;
 559     }
 560
 561     //
 562     // Initialize the buttons.
 563     //
 564     vector<SGPropertyNode_ptr> buttons = js_node->getChildren("button");
 565     char buf[32];
 566     for (j = 0; (j < (int)buttons.size()) && (j < nbuttons); j++) {
 567       const SGPropertyNode * button_node = buttons[j];
 568       const SGPropertyNode * num_node = button_node->getChild("number");
 569       size_t n_but = button_node->getIndex();
 570       if (num_node != 0) {
 571           n_but = num_node->getIntValue(TGT_PLATFORM,n_but);
 572       }
 573
 574       if (n_but >= (size_t)nbuttons) {
 575           SG_LOG(SG_INPUT, SG_DEBUG, "Dropping bindings for button " << n_but);
 576           continue;
 577       }
 578
 579       sprintf(buf, "%d", n_but);
 580       SG_LOG(SG_INPUT, SG_DEBUG, "Initializing button " << n_but);
 581       _init_button(button_node,
 582                    _joystick_bindings[i].buttons[n_but],
 583                    buf);
 584
 585       // get interval-sec property
 586       button &b = _joystick_bindings[i].buttons[n_but];
 587       if (button_node != 0) {
 588         b.interval_sec = button_node->getDoubleValue("interval-sec",0.0);
 589         b.last_dt = 0.0;
 590       }
 591     }
 592
 593     js->setMinRange(minRange);
 594     js->setMaxRange(maxRange);
 595     js->setCenter(center);
 596   }
 597
 598   for (unsigned int m = 0; m < js_named.size(); m++)
 599     js_nodes->removeChild("js-named", js_named[m]->getIndex(), false);
 600 }
 601
 602
 603 void
 604 FGInput::_postinit_joystick()
 605 {
 606   vector<SGPropertyNode_ptr> js = fgGetNode("/input/joysticks")->getChildren("js");
 607   for (unsigned int i = 0; i < js.size(); i++) {
 608     vector<SGPropertyNode_ptr> nasal = js[i]->getChildren("nasal");
 609     for (unsigned int j = 0; j < nasal.size(); j++)
 610       ((FGNasalSys*)globals->get_subsystem("nasal"))->handleCommand(nasal[j]);
 611   }
 612 }
 613
 614
 615 //
 616 // Map of all known cursor names
 617 // This used to contain all the Glut cursors, but those are
 618 // not defined by other toolkits.  It now supports only the cursor
 619 // images we actually use, in the interest of portability.  Someday,
 620 // it would be cool to write an OpenGL cursor renderer, with the
 621 // cursors defined as textures referenced in the property tree.  This
 622 // list could then be eliminated. -Andy
 623 //
 624 static struct {
 625   const char * name;
 626   int cursor;
 627 } mouse_cursor_map[] = {
 628   { "none", MOUSE_CURSOR_NONE },
 629   { "inherit", MOUSE_CURSOR_POINTER },
 630   { "wait", MOUSE_CURSOR_WAIT },
 631   { "crosshair", MOUSE_CURSOR_CROSSHAIR },
 632   { "left-right", MOUSE_CURSOR_LEFTRIGHT },
 633   { 0, 0 }
 634 };
 635
 636 void
 637 FGInput::_init_mouse ()
 638 {
 639   SG_LOG(SG_INPUT, SG_DEBUG, "Initializing mouse bindings");
 640
 641   SGPropertyNode * mouse_nodes = fgGetNode("/input/mice");
 642   if (mouse_nodes == 0) {
 643     SG_LOG(SG_INPUT, SG_WARN, "No mouse bindings (/input/mice)!!");
 644     mouse_nodes = fgGetNode("/input/mice", true);
 645   }
 646
 647   int j;
 648   for (int i = 0; i < MAX_MICE; i++) {
 649     SGPropertyNode * mouse_node = mouse_nodes->getChild("mouse", i, true);
 650     mouse &m = _mouse_bindings[i];
 651
 652                                 // Grab node pointers
 653     char buf[64];
 654     sprintf(buf, "/devices/status/mice/mouse[%d]/mode", i);
 655     m.mode_node = fgGetNode(buf);
 656     if (m.mode_node == NULL) {
 657       m.mode_node = fgGetNode(buf, true);
 658       m.mode_node->setIntValue(0);
 659     }
 660     for (j = 0; j < MAX_MOUSE_BUTTONS; j++) {
 661       sprintf(buf, "/devices/status/mice/mouse[%d]/button[%d]", i, j);
 662       m.mouse_button_nodes[j] = fgGetNode(buf, true);
 663       m.mouse_button_nodes[j]->setBoolValue(false);
 664     }
 665
 666                                 // Read all the modes
 667     m.nModes = mouse_node->getIntValue("mode-count", 1);
 668     m.modes = new mouse_mode[m.nModes];
 669
 670     for (int j = 0; j < m.nModes; j++) {
 671       int k;
 672
 673                                 // Read the mouse cursor for this mode
 674       SGPropertyNode * mode_node = mouse_node->getChild("mode", j, true);
 675       const char * cursor_name =
 676         mode_node->getStringValue("cursor", "inherit");
 677       m.modes[j].cursor = MOUSE_CURSOR_POINTER;
 678       for (k = 0; mouse_cursor_map[k].name != 0; k++) {
 679         if (!strcmp(mouse_cursor_map[k].name, cursor_name)) {
 680           m.modes[j].cursor = mouse_cursor_map[k].cursor;
 681           break;
 682         }
 683       }
 684
 685                                 // Read other properties for this mode
 686       m.modes[j].constrained = mode_node->getBoolValue("constrained", false);
 687       m.modes[j].pass_through = mode_node->getBoolValue("pass-through", false);
 688
 689                                 // Read the button bindings for this mode
 690       m.modes[j].buttons = new button[MAX_MOUSE_BUTTONS];
 691       char buf[32];
 692       for (k = 0; k < MAX_MOUSE_BUTTONS; k++) {
 693         sprintf(buf, "mouse button %d", k);
 694         SG_LOG(SG_INPUT, SG_DEBUG, "Initializing mouse button " << k);
 695         _init_button(mode_node->getChild("button", k),
 696                      m.modes[j].buttons[k],
 697                      buf);
 698       }
 699
 700                                 // Read the axis bindings for this mode
 701       _read_bindings(mode_node->getChild("x-axis", 0, true),
 702                      m.modes[j].x_bindings,
 703                      KEYMOD_NONE);
 704       _read_bindings(mode_node->getChild("y-axis", 0, true),
 705                      m.modes[j].y_bindings,
 706                      KEYMOD_NONE);
 707     }
 708   }
 709 }
 710
 711
 712 void
 713 FGInput::_init_button (const SGPropertyNode * node,
 714                        button &b,
 715                        const string name)
 716 {
 717   if (node == 0) {
 718     SG_LOG(SG_INPUT, SG_DEBUG, "No bindings for button " << name);
 719   } else {
 720     b.is_repeatable = node->getBoolValue("repeatable", b.is_repeatable);
 721
 722                 // Get the bindings for the button
 723     _read_bindings(node, b.bindings, KEYMOD_NONE);
 724   }
 725 }
 726
 727
 728 void
 729 FGInput::_update_keyboard ()
 730 {
 731   // no-op
 732 }
 733
 734
 735 void
 736 FGInput::_update_joystick (double dt)
 737 {
 738   int modifiers = KEYMOD_NONE;  // FIXME: any way to get the real ones?
 739   int buttons;
 740   // float js_val, diff;
 741   float axis_values[MAX_JOYSTICK_AXES];
 742
 743   int i;
 744   int j;
 745
 746   for ( i = 0; i < MAX_JOYSTICKS; i++) {
 747
 748     jsJoystick * js = _joystick_bindings[i].js;
 749     if (js == 0 || js->notWorking())
 750       continue;
 751
 752     js->read(&buttons, axis_values);
 753
 754
 755                                 // Fire bindings for the axes.
 756     for ( j = 0; j < _joystick_bindings[i].naxes; j++) {
 757       axis &a = _joystick_bindings[i].axes[j];
 758
 759                                 // Do nothing if the axis position
 760                                 // is unchanged; only a change in
 761                                 // position fires the bindings.
 762       if (fabs(axis_values[j] - a.last_value) > a.tolerance) {
 763 //      SG_LOG(SG_INPUT, SG_DEBUG, "Axis " << j << " has moved");
 764         a.last_value = axis_values[j];
 765 //      SG_LOG(SG_INPUT, SG_DEBUG, "There are "
 766 //             << a.bindings[modifiers].size() << " bindings");
 767         for (unsigned int k = 0; k < a.bindings[modifiers].size(); k++)
 768           a.bindings[modifiers][k]->fire(axis_values[j]);
 769       }
 770
 771                                 // do we have to emulate axis buttons?
 772       a.last_dt += dt;
 773       if(a.last_dt >= a.interval_sec) {
 774         if (a.low.bindings[modifiers].size())
 775           _update_button(_joystick_bindings[i].axes[j].low,
 776                          modifiers,
 777                          axis_values[j] < a.low_threshold,
 778                          -1, -1);
 779
 780         if (a.high.bindings[modifiers].size())
 781           _update_button(_joystick_bindings[i].axes[j].high,
 782                          modifiers,
 783                          axis_values[j] > a.high_threshold,
 784                          -1, -1);
 785          a.last_dt -= a.interval_sec;
 786       }
 787     }
 788
 789                                 // Fire bindings for the buttons.
 790     for (j = 0; j < _joystick_bindings[i].nbuttons; j++) {
 791       button &b = _joystick_bindings[i].buttons[j];
 792       b.last_dt += dt;
 793       if(b.last_dt >= b.interval_sec) {
 794         _update_button(_joystick_bindings[i].buttons[j],
 795                        modifiers,
 796                        (buttons & (1 << j)) > 0,
 797                        -1, -1);
 798         b.last_dt -= b.interval_sec;
 799       }
 800     }
 801   }
 802 }
 803
 804 void
 805 FGInput::_update_mouse ( double dt )
 806 {
 807   mouse &m = _mouse_bindings[0];
 808   int mode =  m.mode_node->getIntValue();
 809   if (mode != m.current_mode) {
 810     m.current_mode = mode;
 811     m.timeout = fgGetDouble( "/sim/mouse/cursor-timeout-sec", 10.0 );
 812     if (mode >= 0 && mode < m.nModes) {
 813       fgSetMouseCursor(m.modes[mode].cursor);
 814       m.x = fgGetInt("/sim/startup/xsize", 800) / 2;
 815       m.y = fgGetInt("/sim/startup/ysize", 600) / 2;
 816       fgWarpMouse(m.x, m.y);
 817     } else {
 818       SG_LOG(SG_INPUT, SG_DEBUG, "Mouse mode " << mode << " out of range");
 819       fgSetMouseCursor(MOUSE_CURSOR_POINTER);
 820     }
 821   }
 822
 823   if ( fgGetBool( "/sim/mouse/hide-cursor", true ) ) {
 824       if ( m.x != m.save_x || m.y != m.save_y ) {
 825           m.timeout = fgGetDouble( "/sim/mouse/cursor-timeout-sec", 10.0 );
 826           fgSetMouseCursor(m.modes[mode].cursor);
 827       } else {
 828           m.timeout -= dt;
 829           if ( m.timeout <= 0.0 ) {
 830               fgSetMouseCursor(MOUSE_CURSOR_NONE);
 831               m.timeout = 0.0;
 832           }
 833       }
 834       m.save_x = m.x;
 835       m.save_y = m.y;
 836   }
 837 }
 838
 839 void
 840 FGInput::_update_button (button &b, int modifiers, bool pressed,
 841                          int x, int y)
 842 {
 843   if (pressed) {
 844                                 // The press event may be repeated.
 845     if (!b.last_state || b.is_repeatable) {
 846       SG_LOG( SG_INPUT, SG_DEBUG, "Button has been pressed" );
 847       for (unsigned int k = 0; k < b.bindings[modifiers].size(); k++)
 848         b.bindings[modifiers][k]->fire(x, y);
 849     }
 850   } else {
 851                                 // The release event is never repeated.
 852     if (b.last_state) {
 853       SG_LOG( SG_INPUT, SG_DEBUG, "Button has been released" );
 854       for (unsigned int k = 0; k < b.bindings[modifiers|KEYMOD_RELEASED].size(); k++)
 855         b.bindings[modifiers|KEYMOD_RELEASED][k]->fire(x, y);
 856     }
 857   }
 858
 859   b.last_state = pressed;
 860 }
 861
 862
 863 void
 864 FGInput::_read_bindings (const SGPropertyNode * node,
 865                          binding_list_t * binding_list,
 866                          int modifiers)
 867 {
 868   SG_LOG(SG_INPUT, SG_DEBUG, "Reading all bindings");
 869   vector<SGPropertyNode_ptr> bindings = node->getChildren("binding");
 870   for (unsigned int i = 0; i < bindings.size(); i++) {
 871     SG_LOG(SG_INPUT, SG_DEBUG, "Reading binding "
 872            << bindings[i]->getStringValue("command"));
 873     binding_list[modifiers].push_back(new FGBinding(bindings[i]));
 874   }
 875
 876                                 // Read nested bindings for modifiers
 877   if (node->getChild("mod-up") != 0)
 878     _read_bindings(node->getChild("mod-up"), binding_list,
 879                    modifiers|KEYMOD_RELEASED);
 880
 881   if (node->getChild("mod-shift") != 0)
 882     _read_bindings(node->getChild("mod-shift"), binding_list,
 883                    modifiers|KEYMOD_SHIFT);
 884
 885   if (node->getChild("mod-ctrl") != 0)
 886     _read_bindings(node->getChild("mod-ctrl"), binding_list,
 887                    modifiers|KEYMOD_CTRL);
 888
 889   if (node->getChild("mod-alt") != 0)
 890     _read_bindings(node->getChild("mod-alt"), binding_list,
 891                    modifiers|KEYMOD_ALT);
 892 }
 893
 894
 895 const vector<FGBinding *> &
 896 FGInput::_find_key_bindings (unsigned int k, int modifiers)
 897 {
 898   unsigned char kc = (unsigned char)k;
 899   button &b = _key_bindings[k];
 900
 901                                 // Try it straight, first.
 902   if (b.bindings[modifiers].size() > 0)
 903     return b.bindings[modifiers];
 904
 905                                 // Alt-Gr is CTRL+ALT
 906   else if (modifiers&(KEYMOD_CTRL|KEYMOD_ALT))
 907     return _find_key_bindings(k, modifiers&~(KEYMOD_CTRL|KEYMOD_ALT));
 908
 909                                 // Try removing the control modifier
 910                                 // for control keys.
 911   else if ((modifiers&KEYMOD_CTRL) && iscntrl(kc))
 912     return _find_key_bindings(k, modifiers&~KEYMOD_CTRL);
 913
 914                                 // Try removing shift modifier
 915                                 // for upper case or any punctuation
 916                                 // (since different keyboards will
 917                                 // shift different punctuation types)
 918   else if ((modifiers&KEYMOD_SHIFT) && (isupper(kc) || ispunct(kc)))
 919     return _find_key_bindings(k, modifiers&~KEYMOD_SHIFT);
 920
 921                                 // Try removing alt modifier for
 922                                 // high-bit characters.
 923   else if ((modifiers&KEYMOD_ALT) && k >= 128 && k < 256)
 924     return _find_key_bindings(k, modifiers&~KEYMOD_ALT);
 925
 926                                 // Give up and return the empty vector.
 927   else
 928     return b.bindings[modifiers];
 929 }
 930
 931
 932 \f
 933 ////////////////////////////////////////////////////////////////////////
 934 // Implementation of FGInput::button.
 935 ////////////////////////////////////////////////////////////////////////
 936
 937 FGInput::button::button ()
 938   : is_repeatable(false),
 939     last_state(-1)
 940 {
 941 }
 942
 943 FGInput::button::~button ()
 944 {
 945                                 // FIXME: memory leak
 946 //   for (int i = 0; i < KEYMOD_MAX; i++)
 947 //     for (int j = 0; i < bindings[i].size(); j++)
 948 //       delete bindings[i][j];
 949 }
 950
 951
 952 \f
 953 ////////////////////////////////////////////////////////////////////////
 954 // Implementation of FGInput::axis.
 955 ////////////////////////////////////////////////////////////////////////
 956
 957 FGInput::axis::axis ()
 958   : last_value(9999999),
 959     tolerance(0.002),
 960     low_threshold(-0.9),
 961     high_threshold(0.9)
 962 {
 963 }
 964
 965 FGInput::axis::~axis ()
 966 {
 967 //   for (int i = 0; i < KEYMOD_MAX; i++)
 968 //     for (int j = 0; i < bindings[i].size(); j++)
 969 //       delete bindings[i][j];
 970 }
 971
 972
 973 \f
 974 ////////////////////////////////////////////////////////////////////////
 975 // Implementation of FGInput::joystick.
 976 ////////////////////////////////////////////////////////////////////////
 977
 978 FGInput::joystick::joystick ()
 979 {
 980 }
 981
 982 FGInput::joystick::~joystick ()
 983 {
 984 //   delete js;
 985   delete[] axes;
 986   delete[] buttons;
 987 }
 988
 989
 990 \f
 991 ////////////////////////////////////////////////////////////////////////
 992 // Implementation of FGInput::mouse_mode
 993 ////////////////////////////////////////////////////////////////////////
 994
 995 FGInput::mouse_mode::mouse_mode ()
 996   : cursor(MOUSE_CURSOR_POINTER),
 997     constrained(false),
 998     pass_through(false),
 999     buttons(0)
1000 {
1001 }
1002
1003 FGInput::mouse_mode::~mouse_mode ()
1004 {
1005                                 // FIXME: memory leak
1006 //   for (int i = 0; i < KEYMOD_MAX; i++) {
1007 //     int j;
1008 //     for (j = 0; i < x_bindings[i].size(); j++)
1009 //       delete bindings[i][j];
1010 //     for (j = 0; j < y_bindings[i].size(); j++)
1011 //       delete bindings[i][j];
1012 //   }
1013   delete [] buttons;
1014 }
1015
1016
1017 \f
1018 ////////////////////////////////////////////////////////////////////////
1019 // Implementation of FGInput::mouse
1020 ////////////////////////////////////////////////////////////////////////
1021
1022 FGInput::mouse::mouse ()
1023   : x(-1),
1024     y(-1),
1025     nModes(1),
1026     current_mode(0),
1027     modes(0)
1028 {
1029 }
1030
1031 FGInput::mouse::~mouse ()
1032 {
1033   delete [] modes;
1034 }
1035
1036 ////////////////////////////////////////////////////////////////////////
1037 // Implementation of OS callbacks.
1038 ////////////////////////////////////////////////////////////////////////
1039
1040 void keyHandler(int key, int keymod, int mousex, int mousey)
1041 {
1042     if((keymod & KEYMOD_RELEASED) == 0)
1043         if(puKeyboard(key, PU_DOWN))
1044             return;
1045
1046     if(default_input)
1047         default_input->doKey(key, keymod, mousex, mousey);
1048 }
1049
1050 void mouseClickHandler(int button, int updown, int x, int y)
1051 {
1052     if(default_input)
1053         default_input->doMouseClick(button, updown, x, y);
1054 }
1055
1056 void mouseMotionHandler(int x, int y)
1057 {
1058     if (default_input != 0)
1059         default_input->doMouseMotion(x, y);
1060 }