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