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 GLUT_H
  41
  42 #include <plib/pu.h>
  43
  44 #include <simgear/compiler.h>
  45
  46 #include <simgear/constants.h>
  47 #include <simgear/debug/logstream.hxx>
  48 #include <simgear/misc/props.hxx>
  49
  50 #include <Aircraft/aircraft.hxx>
  51 #include <Autopilot/auto_gui.hxx>
  52 #include <Autopilot/newauto.hxx>
  53 #include <Cockpit/hud.hxx>
  54 #include <Cockpit/panel.hxx>
  55 #include <Cockpit/panel_io.hxx>
  56 #include <GUI/gui.h>
  57 #include <Model/panelnode.hxx>
  58
  59 #include <Main/globals.hxx>
  60 #include <Main/fg_props.hxx>
  61
  62 #include "input.hxx"
  63
  64 SG_USING_STD(ifstream);
  65 SG_USING_STD(string);
  66 SG_USING_STD(vector);
  67
  68
  69 \f
  70 ////////////////////////////////////////////////////////////////////////
  71 // Local variables.
  72 ////////////////////////////////////////////////////////////////////////
  73
  74 static FGInput * default_input = 0;
  75
  76
  77 \f
  78 ////////////////////////////////////////////////////////////////////////
  79 // Implementation of FGBinding.
  80 ////////////////////////////////////////////////////////////////////////
  81
  82 FGBinding::FGBinding ()
  83   : _command(0),
  84     _arg(new SGPropertyNode),
  85     _setting(0)
  86 {
  87 }
  88
  89 FGBinding::FGBinding (const SGPropertyNode * node)
  90   : _command(0),
  91     _arg(0),
  92     _setting(0)
  93 {
  94   read(node);
  95 }
  96
  97 FGBinding::~FGBinding ()
  98 {
  99   delete _arg;                       // Delete the saved arguments
 100 }
 101
 102 void
 103 FGBinding::read (const SGPropertyNode * node)
 104 {
 105   const SGPropertyNode * conditionNode = node->getChild("condition");
 106   if (conditionNode != 0)
 107     setCondition(fgReadCondition(conditionNode));
 108
 109   _command_name = node->getStringValue("command", "");
 110   if (_command_name.empty()) {
 111     SG_LOG(SG_INPUT, SG_WARN, "No command supplied for binding.");
 112     _command = 0;
 113     return;
 114   }
 115
 116   _command = globals->get_commands()->getCommand(_command_name);
 117   if (_command == 0) {
 118     SG_LOG(SG_INPUT, SG_ALERT, "Command " << _command_name << " is undefined");
 119     _arg = 0;
 120     return;
 121   }
 122
 123   delete _arg;
 124   _arg = new SGPropertyNode;
 125   _setting = 0;
 126   copyProperties(node, _arg);  // FIXME: don't use whole node!!!
 127 }
 128
 129 void
 130 FGBinding::fire () const
 131 {
 132   if (test()) {
 133     if (_command == 0) {
 134       SG_LOG(SG_INPUT, SG_WARN, "No command attached to binding");
 135     } else if (!(*_command)(_arg)) {
 136       SG_LOG(SG_INPUT, SG_ALERT, "Failed to execute command "
 137              << _command_name);
 138     }
 139   }
 140 }
 141
 142 void
 143 FGBinding::fire (double offset, double max) const
 144 {
 145   if (test()) {
 146     _arg->setDoubleValue("offset", offset/max);
 147     fire();
 148   }
 149 }
 150
 151 void
 152 FGBinding::fire (double setting) const
 153 {
 154   if (test()) {
 155                                 // A value is automatically added to
 156                                 // the args
 157     if (_setting == 0)          // save the setting node for efficiency
 158       _setting = _arg->getChild("setting", 0, true);
 159     _setting->setDoubleValue(setting);
 160     fire();
 161   }
 162 }
 163
 164
 165 \f
 166 ////////////////////////////////////////////////////////////////////////
 167 // Implementation of FGInput.
 168 ////////////////////////////////////////////////////////////////////////
 169
 170                                 // From main.cxx
 171 extern void fgReshape( int width, int height );
 172
 173
 174 FGInput::FGInput ()
 175 {
 176     if (default_input == 0)
 177         default_input = this;
 178 }
 179
 180 FGInput::~FGInput ()
 181 {
 182     if (default_input == this)
 183         default_input = 0;
 184 }
 185
 186 void
 187 FGInput::init ()
 188 {
 189   _init_keyboard();
 190   _init_joystick();
 191   _init_mouse();
 192
 193   glutKeyboardFunc(GLUTkey);
 194   glutKeyboardUpFunc(GLUTkeyup);
 195   glutSpecialFunc(GLUTspecialkey);
 196   glutSpecialUpFunc(GLUTspecialkeyup);
 197   glutMouseFunc (GLUTmouse);
 198   glutMotionFunc (GLUTmotion);
 199   glutPassiveMotionFunc (GLUTmotion);
 200 }
 201
 202 void
 203 FGInput::bind ()
 204 {
 205   // no op
 206 }
 207
 208 void
 209 FGInput::unbind ()
 210 {
 211   // no op
 212 }
 213
 214 void
 215 FGInput::update (double dt)
 216 {
 217   _update_keyboard();
 218   _update_joystick();
 219   _update_mouse();
 220 }
 221
 222 void
 223 FGInput::makeDefault (bool status)
 224 {
 225     if (status)
 226         default_input = this;
 227     else if (default_input == this)
 228         default_input = 0;
 229 }
 230
 231 void
 232 FGInput::doKey (int k, int modifiers, int x, int y)
 233 {
 234                                 // Sanity check.
 235   if (k < 0 || k >= MAX_KEYS) {
 236     SG_LOG(SG_INPUT, SG_WARN, "Key value " << k << " out of range");
 237     return;
 238   }
 239
 240   button &b = _key_bindings[k];
 241
 242                                 // Key pressed.
 243   if (modifiers&FG_MOD_UP == 0) {
 244     SG_LOG( SG_INPUT, SG_DEBUG, "User pressed key " << k
 245             << " with modifiers " << modifiers );
 246     if (!b.last_state || b.is_repeatable) {
 247       const binding_list_t &bindings =
 248         _find_key_bindings(k, modifiers);
 249       int max = bindings.size();
 250       if (max > 0) {
 251         for (int i = 0; i < max; i++)
 252           bindings[i]->fire();
 253         return;
 254       }
 255     }
 256   }
 257
 258                                 // Key released.
 259   else {
 260     SG_LOG(SG_INPUT, SG_DEBUG, "User released key " << k
 261            << " with modifiers " << modifiers);
 262     if (b.last_state) {
 263       const binding_list_t &bindings =
 264         _find_key_bindings(k, modifiers);
 265       int max = bindings.size();
 266       if (max > 0) {
 267         for (int i = 0; i < max; i++)
 268           bindings[i]->fire();
 269         return;
 270       }
 271     }
 272   }
 273
 274
 275                                 // Use the old, default actions.
 276   SG_LOG( SG_INPUT, SG_DEBUG, "(No user binding.)" );
 277   if (modifiers&FG_MOD_UP)
 278     return;
 279
 280   // everything after here will be removed sooner or later...
 281
 282   if (modifiers & FG_MOD_SHIFT) {
 283
 284         switch (k) {
 285         case 72: // H key
 286             HUD_brightkey( true );
 287             return;
 288         case 73: // I key
 289             // Minimal Hud
 290             fgHUDInit2(&current_aircraft);
 291             return;
 292         }
 293
 294
 295     } else {
 296         SG_LOG( SG_INPUT, SG_DEBUG, "" );
 297         switch (k) {
 298         case 104: // h key
 299             HUD_masterswitch( true );
 300             return;
 301         case 105: // i key
 302             fgHUDInit(&current_aircraft);  // normal HUD
 303             return;
 304
 305 // START SPECIALS
 306
 307         case 256+GLUT_KEY_F6: // F6 toggles Autopilot target location
 308             if ( globals->get_autopilot()->get_HeadingMode() !=
 309                  FGAutopilot::FG_HEADING_WAYPOINT ) {
 310                 globals->get_autopilot()->set_HeadingMode(
 311                     FGAutopilot::FG_HEADING_WAYPOINT );
 312                 globals->get_autopilot()->set_HeadingEnabled( true );
 313             } else {
 314                 globals->get_autopilot()->set_HeadingMode(
 315                     FGAutopilot::FG_TC_HEADING_LOCK );
 316             }
 317             return;
 318         case 256+GLUT_KEY_F8: {// F8 toggles fog ... off fastest nicest...
 319             const string &fog = fgGetString("/sim/rendering/fog");
 320             if (fog == "disabled") {
 321               fgSetString("/sim/rendering/fog", "fastest");
 322               SG_LOG(SG_INPUT, SG_INFO, "Fog enabled, hint=fastest");
 323             } else if (fog == "fastest") {
 324               fgSetString("/sim/rendering/fog", "nicest");
 325               SG_LOG(SG_INPUT, SG_INFO, "Fog enabled, hint=nicest");
 326             } else if (fog == "nicest") {
 327               fgSetString("/sim/rendering/fog", "disabled");
 328               SG_LOG(SG_INPUT, SG_INFO, "Fog disabled");
 329             } else {
 330               fgSetString("/sim/rendering/fog", "disabled");
 331               SG_LOG(SG_INPUT, SG_ALERT, "Unrecognized fog type "
 332                      << fog << ", changed to 'disabled'");
 333             }
 334             return;
 335         }
 336         case 256+GLUT_KEY_F10: // F10 toggles menu on and off...
 337             SG_LOG(SG_INPUT, SG_INFO, "Invoking call back function");
 338             guiToggleMenu();
 339             return;
 340         case 256+GLUT_KEY_F11: // F11 Altitude Dialog.
 341             SG_LOG(SG_INPUT, SG_INFO, "Invoking Altitude call back function");
 342             NewAltitude( NULL );
 343             return;
 344         case 256+GLUT_KEY_F12: // F12 Heading Dialog...
 345             SG_LOG(SG_INPUT, SG_INFO, "Invoking Heading call back function");
 346             NewHeading( NULL );
 347             return;
 348         }
 349
 350 // END SPECIALS
 351
 352     }
 353 }
 354
 355 void
 356 FGInput::doMouseClick (int b, int updown, int x, int y)
 357 {
 358   int modifiers = FG_MOD_NONE;  // FIXME: any way to get the real ones?
 359
 360   mouse &m = _mouse_bindings[0];
 361   mouse_mode &mode = m.modes[m.current_mode];
 362
 363                                 // Let the property manager know.
 364   if (b >= 0 && b < MAX_MOUSE_BUTTONS)
 365     m.mouse_button_nodes[b]->setBoolValue(updown == GLUT_DOWN);
 366
 367                                 // Pass on to PUI and the panel if
 368                                 // requested, and return if one of
 369                                 // them consumes the event.
 370   if (mode.pass_through) {
 371     if (puMouse(b, updown, x, y))
 372       return;
 373     else if ((current_panel != 0) &&
 374              current_panel->getVisibility() &&
 375              current_panel->doMouseAction(b, updown, x, y))
 376       return;
 377     else if (fgHandle3DPanelMouseEvent(b, updown, x, y))
 378       return;
 379   }
 380
 381                                 // OK, PUI and the panel didn't want the click
 382   if (b >= MAX_MOUSE_BUTTONS) {
 383     SG_LOG(SG_INPUT, SG_ALERT, "Mouse button " << b
 384            << " where only " << MAX_MOUSE_BUTTONS << " expected");
 385     return;
 386   }
 387
 388   _update_button(m.modes[m.current_mode].buttons[b], modifiers, 0 != updown, x, y);
 389 }
 390
 391 void
 392 FGInput::doMouseMotion (int x, int y)
 393 {
 394   int modifiers = FG_MOD_NONE;  // FIXME: any way to get the real ones?
 395
 396   int xsize = fgGetInt("/sim/startup/xsize", 800);
 397   int ysize = fgGetInt("/sim/startup/ysize", 600);
 398   mouse &m = _mouse_bindings[0];
 399   if (m.current_mode < 0 || m.current_mode >= m.nModes)
 400     return;
 401   mouse_mode &mode = m.modes[m.current_mode];
 402
 403                                 // Pass on to PUI if requested, and return
 404                                 // if PUI consumed the event.
 405   if (mode.pass_through && puMouse(x, y))
 406     return;
 407
 408                                 // OK, PUI didn't want the event,
 409                                 // so we can play with it.
 410   if (x != m.x) {
 411     int delta = x - m.x;
 412     for (unsigned int i = 0; i < mode.x_bindings[modifiers].size(); i++)
 413       mode.x_bindings[modifiers][i]->fire(double(delta), double(xsize));
 414   }
 415   if (y != m.y) {
 416     int delta = y - m.y;
 417     for (unsigned int i = 0; i < mode.y_bindings[modifiers].size(); i++)
 418       mode.y_bindings[modifiers][i]->fire(double(delta), double(ysize));
 419   }
 420
 421                                 // Constrain the mouse if requested
 422   if (mode.constrained) {
 423     bool need_warp = false;
 424     if (x <= 0) {
 425       x = xsize - 2;
 426       need_warp = true;
 427     } else if (x >= (xsize-1)) {
 428       x = 1;
 429       need_warp = true;
 430     }
 431
 432     if (y <= 0) {
 433       y = ysize - 2;
 434       need_warp = true;
 435     } else if (y >= (ysize-1)) {
 436       y = 1;
 437       need_warp = true;
 438     }
 439
 440     if (need_warp)
 441       glutWarpPointer(x, y);
 442   }
 443   m.x = x;
 444   m.y = y;
 445 }
 446
 447 void
 448 FGInput::_init_keyboard ()
 449 {
 450                                 // TODO: zero the old bindings first.
 451   SG_LOG(SG_INPUT, SG_DEBUG, "Initializing key bindings");
 452   SGPropertyNode * key_nodes = fgGetNode("/input/keyboard");
 453   if (key_nodes == 0) {
 454     SG_LOG(SG_INPUT, SG_WARN, "No key bindings (/input/keyboard)!!");
 455     key_nodes = fgGetNode("/input/keyboard", true);
 456   }
 457
 458   vector<SGPropertyNode_ptr> keys = key_nodes->getChildren("key");
 459   for (unsigned int i = 0; i < keys.size(); i++) {
 460     int index = keys[i]->getIndex();
 461     SG_LOG(SG_INPUT, SG_DEBUG, "Binding key " << index);
 462     _key_bindings[index].is_repeatable = keys[i]->getBoolValue("repeatable");
 463     _read_bindings(keys[i], _key_bindings[index].bindings, FG_MOD_NONE);
 464   }
 465 }
 466
 467
 468 void
 469 FGInput::_init_joystick ()
 470 {
 471                                 // TODO: zero the old bindings first.
 472   SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick bindings");
 473   SGPropertyNode * js_nodes = fgGetNode("/input/joysticks");
 474   if (js_nodes == 0) {
 475     SG_LOG(SG_INPUT, SG_WARN, "No joystick bindings (/input/joysticks)!!");
 476     js_nodes = fgGetNode("/input/joysticks", true);
 477   }
 478
 479   for (int i = 0; i < MAX_JOYSTICKS; i++) {
 480     SGPropertyNode_ptr js_node = js_nodes->getChild("js", i);
 481     if (js_node == 0) {
 482       SG_LOG(SG_INPUT, SG_DEBUG, "No bindings for joystick " << i);
 483       js_node = js_nodes->getChild("js", i, true);
 484     }
 485     jsJoystick * js = new jsJoystick(i);
 486     _joystick_bindings[i].js = js;
 487     if (js->notWorking()) {
 488       SG_LOG(SG_INPUT, SG_WARN, "Joystick " << i << " not found");
 489       continue;
 490     } else {
 491 #ifdef FG_PLIB_JOYSTICK_GETNAME
 492       bool found_js = false;
 493       const char * name = js->getName();
 494       SG_LOG(SG_INPUT, SG_INFO, "Looking for bindings for joystick \""
 495              << name << '"');
 496       vector<SGPropertyNode_ptr> nodes = js_nodes->getChildren("js-named");
 497       for (unsigned int i = 0; i < nodes.size(); i++) {
 498         SGPropertyNode_ptr node = nodes[i];
 499         vector<SGPropertyNode_ptr> name_nodes = node->getChildren("name");
 500         for (unsigned int j = 0; j < name_nodes.size(); j++) {
 501             const char * js_name = name_nodes[j]->getStringValue();
 502             SG_LOG(SG_INPUT, SG_INFO, "  Trying \"" << js_name << '"');
 503             if (!strcmp(js_name, name)) {
 504                 SG_LOG(SG_INPUT, SG_INFO, "  Found bindings");
 505                 js_node = node;
 506                 found_js = true;
 507                 break;
 508             }
 509         }
 510         if (found_js)
 511             break;
 512       }
 513 #endif
 514     }
 515 #ifdef WIN32
 516     JOYCAPS jsCaps ;
 517     joyGetDevCaps( i, &jsCaps, sizeof(jsCaps) );
 518     int nbuttons = jsCaps.wNumButtons;
 519     if (nbuttons > MAX_JOYSTICK_BUTTONS) nbuttons = MAX_JOYSTICK_BUTTONS;
 520 #else
 521     int nbuttons = MAX_JOYSTICK_BUTTONS;
 522 #endif
 523
 524     int naxes = js->getNumAxes();
 525     if (naxes > MAX_JOYSTICK_AXES) naxes = MAX_JOYSTICK_AXES;
 526     _joystick_bindings[i].naxes = naxes;
 527     _joystick_bindings[i].nbuttons = nbuttons;
 528
 529     SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick " << i);
 530
 531                                 // Set up range arrays
 532     float minRange[MAX_JOYSTICK_AXES];
 533     float maxRange[MAX_JOYSTICK_AXES];
 534     float center[MAX_JOYSTICK_AXES];
 535
 536                                 // Initialize with default values
 537     js->getMinRange(minRange);
 538     js->getMaxRange(maxRange);
 539     js->getCenter(center);
 540
 541                                 // Allocate axes and buttons
 542     _joystick_bindings[i].axes = new axis[naxes];
 543     _joystick_bindings[i].buttons = new button[nbuttons];
 544
 545
 546     //
 547     // Initialize the axes.
 548     //
 549     int j;
 550     for (j = 0; j < naxes; j++) {
 551       const SGPropertyNode * axis_node = js_node->getChild("axis", j);
 552       if (axis_node == 0) {
 553         SG_LOG(SG_INPUT, SG_DEBUG, "No bindings for axis " << j);
 554         axis_node = js_node->getChild("axis", j, true);
 555       }
 556
 557       axis &a = _joystick_bindings[i].axes[j];
 558
 559       js->setDeadBand(j, axis_node->getDoubleValue("dead-band", 0.0));
 560
 561       a.tolerance = axis_node->getDoubleValue("tolerance", 0.002);
 562       minRange[j] = axis_node->getDoubleValue("min-range", minRange[j]);
 563       maxRange[j] = axis_node->getDoubleValue("max-range", maxRange[j]);
 564       center[j] = axis_node->getDoubleValue("center", center[j]);
 565
 566       _read_bindings(axis_node, a.bindings, FG_MOD_NONE);
 567
 568       // Initialize the virtual axis buttons.
 569       _init_button(axis_node->getChild("low"), a.low, "low");
 570       a.low_threshold = axis_node->getDoubleValue("low-threshold", -0.9);
 571
 572       _init_button(axis_node->getChild("high"), a.high, "high");
 573       a.high_threshold = axis_node->getDoubleValue("high-threshold", 0.9);
 574     }
 575
 576     //
 577     // Initialize the buttons.
 578     //
 579     char buf[32];
 580     for (j = 0; j < nbuttons; j++) {
 581       sprintf(buf, "%d", j);
 582       SG_LOG(SG_INPUT, SG_DEBUG, "Initializing button " << j);
 583       _init_button(js_node->getChild("button", j),
 584                    _joystick_bindings[i].buttons[j],
 585                    buf);
 586
 587     }
 588
 589     js->setMinRange(minRange);
 590     js->setMaxRange(maxRange);
 591     js->setCenter(center);
 592   }
 593 }
 594
 595 //
 596 // Map of all known GLUT cursor names
 597 //
 598 struct {
 599   const char * name;
 600   int cursor;
 601 } mouse_cursor_map[] = {
 602   { "right-arrow", GLUT_CURSOR_RIGHT_ARROW },
 603   { "left-arrow", GLUT_CURSOR_LEFT_ARROW },
 604   { "info", GLUT_CURSOR_INFO },
 605   { "destroy", GLUT_CURSOR_DESTROY },
 606   { "help", GLUT_CURSOR_HELP },
 607   { "cycle", GLUT_CURSOR_CYCLE },
 608   { "spray", GLUT_CURSOR_SPRAY },
 609   { "wait", GLUT_CURSOR_WAIT },
 610   { "text", GLUT_CURSOR_TEXT },
 611   { "crosshair", GLUT_CURSOR_CROSSHAIR },
 612   { "up-down", GLUT_CURSOR_UP_DOWN },
 613   { "left-right", GLUT_CURSOR_LEFT_RIGHT },
 614   { "top-side", GLUT_CURSOR_TOP_SIDE },
 615   { "bottom-side", GLUT_CURSOR_BOTTOM_SIDE },
 616   { "left-side", GLUT_CURSOR_LEFT_SIDE },
 617   { "right-side", GLUT_CURSOR_RIGHT_SIDE },
 618   { "top-left-corner", GLUT_CURSOR_TOP_LEFT_CORNER },
 619   { "top-right-corner", GLUT_CURSOR_TOP_RIGHT_CORNER },
 620   { "bottom-right-corner", GLUT_CURSOR_BOTTOM_RIGHT_CORNER },
 621   { "bottom-left-corner", GLUT_CURSOR_BOTTOM_LEFT_CORNER },
 622   { "inherit", GLUT_CURSOR_INHERIT },
 623   { "none", GLUT_CURSOR_NONE },
 624   { "full-crosshair", GLUT_CURSOR_FULL_CROSSHAIR },
 625   { 0, 0 }
 626 };
 627
 628
 629
 630 void
 631 FGInput::_init_mouse ()
 632 {
 633   SG_LOG(SG_INPUT, SG_DEBUG, "Initializing mouse bindings");
 634
 635   SGPropertyNode * mouse_nodes = fgGetNode("/input/mice");
 636   if (mouse_nodes == 0) {
 637     SG_LOG(SG_INPUT, SG_WARN, "No mouse bindings (/input/mice)!!");
 638     mouse_nodes = fgGetNode("/input/mice", true);
 639   }
 640
 641   int j;
 642   for (int i = 0; i < MAX_MICE; i++) {
 643     SGPropertyNode * mouse_node = mouse_nodes->getChild("mouse", i, true);
 644     mouse &m = _mouse_bindings[i];
 645
 646                                 // Grab node pointers
 647     char buf[64];
 648     sprintf(buf, "/devices/status/mice/mouse[%d]/mode", i);
 649     m.mode_node = fgGetNode(buf, true);
 650     m.mode_node->setIntValue(0);
 651     for (j = 0; j < MAX_MOUSE_BUTTONS; j++) {
 652       sprintf(buf, "/devices/status/mice/mouse[%d]/button[%d]", i, j);
 653       m.mouse_button_nodes[j] = fgGetNode(buf, true);
 654       m.mouse_button_nodes[j]->setBoolValue(false);
 655     }
 656
 657                                 // Read all the modes
 658     m.nModes = mouse_node->getIntValue("mode-count", 1);
 659     m.modes = new mouse_mode[m.nModes];
 660
 661     for (int j = 0; j < m.nModes; j++) {
 662       int k;
 663
 664                                 // Read the mouse cursor for this mode
 665       SGPropertyNode * mode_node = mouse_node->getChild("mode", j, true);
 666       const char * cursor_name =
 667         mode_node->getStringValue("cursor", "inherit");
 668       m.modes[j].cursor = GLUT_CURSOR_INHERIT;
 669       for (k = 0; mouse_cursor_map[k].name != 0; k++) {
 670         if (!strcmp(mouse_cursor_map[k].name, cursor_name)) {
 671           m.modes[j].cursor = mouse_cursor_map[k].cursor;
 672           break;
 673         }
 674       }
 675
 676                                 // Read other properties for this mode
 677       m.modes[j].constrained = mode_node->getBoolValue("constrained", false);
 678       m.modes[j].pass_through = mode_node->getBoolValue("pass-through", false);
 679
 680                                 // Read the button bindings for this mode
 681       m.modes[j].buttons = new button[MAX_MOUSE_BUTTONS];
 682       char buf[32];
 683       for (k = 0; k < MAX_MOUSE_BUTTONS; k++) {
 684         sprintf(buf, "mouse button %d", k);
 685         SG_LOG(SG_INPUT, SG_DEBUG, "Initializing mouse button " << k);
 686         _init_button(mode_node->getChild("button", k),
 687                      m.modes[j].buttons[k],
 688                      buf);
 689       }
 690
 691                                 // Read the axis bindings for this mode
 692       _read_bindings(mode_node->getChild("x-axis", 0, true),
 693                      m.modes[j].x_bindings,
 694                      FG_MOD_NONE);
 695       _read_bindings(mode_node->getChild("y-axis", 0, true),
 696                      m.modes[j].y_bindings,
 697                      FG_MOD_NONE);
 698     }
 699   }
 700 }
 701
 702
 703 void
 704 FGInput::_init_button (const SGPropertyNode * node,
 705                        button &b,
 706                        const string name)
 707 {
 708   if (node == 0) {
 709     SG_LOG(SG_INPUT, SG_DEBUG, "No bindings for button " << name);
 710   } else {
 711     b.is_repeatable = node->getBoolValue("repeatable", b.is_repeatable);
 712
 713                 // Get the bindings for the button
 714     _read_bindings(node, b.bindings, FG_MOD_NONE);
 715   }
 716 }
 717
 718
 719 void
 720 FGInput::_update_keyboard ()
 721 {
 722   // no-op
 723 }
 724
 725
 726 void
 727 FGInput::_update_joystick ()
 728 {
 729   int modifiers = FG_MOD_NONE;  // FIXME: any way to get the real ones?
 730   int buttons;
 731   // float js_val, diff;
 732   float axis_values[MAX_JOYSTICK_AXES];
 733
 734   int i;
 735   int j;
 736
 737   for ( i = 0; i < MAX_JOYSTICKS; i++) {
 738
 739     jsJoystick * js = _joystick_bindings[i].js;
 740     if (js == 0 || js->notWorking())
 741       continue;
 742
 743     js->read(&buttons, axis_values);
 744
 745
 746                                 // Fire bindings for the axes.
 747     for ( j = 0; j < _joystick_bindings[i].naxes; j++) {
 748       axis &a = _joystick_bindings[i].axes[j];
 749
 750                                 // Do nothing if the axis position
 751                                 // is unchanged; only a change in
 752                                 // position fires the bindings.
 753       if (fabs(axis_values[j] - a.last_value) > a.tolerance) {
 754 //      SG_LOG(SG_INPUT, SG_DEBUG, "Axis " << j << " has moved");
 755         SGPropertyNode node;
 756         a.last_value = axis_values[j];
 757 //      SG_LOG(SG_INPUT, SG_DEBUG, "There are "
 758 //             << a.bindings[modifiers].size() << " bindings");
 759         for (unsigned int k = 0; k < a.bindings[modifiers].size(); k++)
 760           a.bindings[modifiers][k]->fire(axis_values[j]);
 761       }
 762
 763                                 // do we have to emulate axis buttons?
 764       if (a.low.bindings[modifiers].size())
 765         _update_button(_joystick_bindings[i].axes[j].low,
 766                        modifiers,
 767                        axis_values[j] < a.low_threshold,
 768                        -1, -1);
 769
 770       if (a.high.bindings[modifiers].size())
 771         _update_button(_joystick_bindings[i].axes[j].high,
 772                        modifiers,
 773                        axis_values[j] > a.high_threshold,
 774                        -1, -1);
 775     }
 776
 777                                 // Fire bindings for the buttons.
 778     for (j = 0; j < _joystick_bindings[i].nbuttons; j++) {
 779       _update_button(_joystick_bindings[i].buttons[j],
 780                      modifiers,
 781                      (buttons & (1 << j)) > 0,
 782                      -1, -1);
 783     }
 784   }
 785 }
 786
 787 void
 788 FGInput::_update_mouse ()
 789 {
 790   mouse &m = _mouse_bindings[0];
 791   int mode =  m.mode_node->getIntValue();
 792   if (mode != m.current_mode) {
 793     m.current_mode = mode;
 794     if (mode >= 0 && mode < m.nModes) {
 795       glutSetCursor(m.modes[mode].cursor);
 796       m.x = fgGetInt("/sim/startup/xsize", 800) / 2;
 797       m.y = fgGetInt("/sim/startup/ysize", 600) / 2;
 798       glutWarpPointer(m.x, m.y);
 799     } else {
 800       SG_LOG(SG_INPUT, SG_DEBUG, "Mouse mode " << mode << " out of range");
 801       glutSetCursor(GLUT_CURSOR_INHERIT);
 802     }
 803   }
 804 }
 805
 806 void
 807 FGInput::_update_button (button &b, int modifiers, bool pressed,
 808                          int x, int y)
 809 {
 810   if (pressed) {
 811                                 // The press event may be repeated.
 812     if (!b.last_state || b.is_repeatable) {
 813       SG_LOG( SG_INPUT, SG_DEBUG, "Button has been pressed" );
 814       for (unsigned int k = 0; k < b.bindings[modifiers].size(); k++)
 815         b.bindings[modifiers][k]->fire(x, y);
 816     }
 817   } else {
 818                                 // The release event is never repeated.
 819     if (b.last_state) {
 820       SG_LOG( SG_INPUT, SG_DEBUG, "Button has been released" );
 821       for (unsigned int k = 0; k < b.bindings[modifiers|FG_MOD_UP].size(); k++)
 822         b.bindings[modifiers|FG_MOD_UP][k]->fire(x, y);
 823     }
 824   }
 825
 826   b.last_state = pressed;
 827 }
 828
 829
 830 void
 831 FGInput::_read_bindings (const SGPropertyNode * node,
 832                          binding_list_t * binding_list,
 833                          int modifiers)
 834 {
 835   SG_LOG(SG_INPUT, SG_DEBUG, "Reading all bindings");
 836   vector<SGPropertyNode_ptr> bindings = node->getChildren("binding");
 837   for (unsigned int i = 0; i < bindings.size(); i++) {
 838     SG_LOG(SG_INPUT, SG_DEBUG, "Reading binding "
 839            << bindings[i]->getStringValue("command"));
 840     binding_list[modifiers].push_back(new FGBinding(bindings[i]));
 841   }
 842
 843                                 // Read nested bindings for modifiers
 844   if (node->getChild("mod-up") != 0)
 845     _read_bindings(node->getChild("mod-up"), binding_list,
 846                    modifiers|FG_MOD_UP);
 847
 848   if (node->getChild("mod-shift") != 0)
 849     _read_bindings(node->getChild("mod-shift"), binding_list,
 850                    modifiers|FG_MOD_SHIFT);
 851
 852   if (node->getChild("mod-ctrl") != 0)
 853     _read_bindings(node->getChild("mod-ctrl"), binding_list,
 854                    modifiers|FG_MOD_CTRL);
 855
 856   if (node->getChild("mod-alt") != 0)
 857     _read_bindings(node->getChild("mod-alt"), binding_list,
 858                    modifiers|FG_MOD_ALT);
 859 }
 860
 861
 862 const vector<FGBinding *> &
 863 FGInput::_find_key_bindings (unsigned int k, int modifiers)
 864 {
 865   button &b = _key_bindings[k];
 866
 867                                 // Try it straight, first.
 868   if (b.bindings[modifiers].size() > 0)
 869     return b.bindings[modifiers];
 870
 871                                 // Try removing the control modifier
 872                                 // for control keys.
 873   else if ((modifiers&FG_MOD_CTRL) && iscntrl(k))
 874     return _find_key_bindings(k, modifiers&~FG_MOD_CTRL);
 875
 876                                 // Try removing shift modifier
 877                                 // for upper case or any punctuation
 878                                 // (since different keyboards will
 879                                 // shift different punctuation types)
 880   else if ((modifiers&FG_MOD_SHIFT) && (isupper(k) || ispunct(k)))
 881     return _find_key_bindings(k, modifiers&~FG_MOD_SHIFT);
 882
 883                                 // Try removing alt modifier for
 884                                 // high-bit characters.
 885   else if ((modifiers&FG_MOD_ALT) && k >= 128 && k < 256)
 886     return _find_key_bindings(k, modifiers&~FG_MOD_ALT);
 887
 888                                 // Give up and return the empty vector.
 889   else
 890     return b.bindings[modifiers];
 891 }
 892
 893
 894 \f
 895 ////////////////////////////////////////////////////////////////////////
 896 // Implementation of FGInput::button.
 897 ////////////////////////////////////////////////////////////////////////
 898
 899 FGInput::button::button ()
 900   : is_repeatable(false),
 901     last_state(-1)
 902 {
 903 }
 904
 905 FGInput::button::~button ()
 906 {
 907                                 // FIXME: memory leak
 908 //   for (int i = 0; i < FG_MOD_MAX; i++)
 909 //     for (int j = 0; i < bindings[i].size(); j++)
 910 //       delete bindings[i][j];
 911 }
 912
 913
 914 \f
 915 ////////////////////////////////////////////////////////////////////////
 916 // Implementation of FGInput::axis.
 917 ////////////////////////////////////////////////////////////////////////
 918
 919 FGInput::axis::axis ()
 920   : last_value(9999999),
 921     tolerance(0.002),
 922     low_threshold(-0.9),
 923     high_threshold(0.9)
 924 {
 925 }
 926
 927 FGInput::axis::~axis ()
 928 {
 929 //   for (int i = 0; i < FG_MOD_MAX; i++)
 930 //     for (int j = 0; i < bindings[i].size(); j++)
 931 //       delete bindings[i][j];
 932 }
 933
 934
 935 \f
 936 ////////////////////////////////////////////////////////////////////////
 937 // Implementation of FGInput::joystick.
 938 ////////////////////////////////////////////////////////////////////////
 939
 940 FGInput::joystick::joystick ()
 941 {
 942 }
 943
 944 FGInput::joystick::~joystick ()
 945 {
 946 //   delete js;
 947   delete[] axes;
 948   delete[] buttons;
 949 }
 950
 951
 952 \f
 953 ////////////////////////////////////////////////////////////////////////
 954 // Implementation of FGInput::mouse_mode
 955 ////////////////////////////////////////////////////////////////////////
 956
 957 FGInput::mouse_mode::mouse_mode ()
 958   : cursor(GLUT_CURSOR_INHERIT),
 959     constrained(false),
 960     pass_through(false),
 961     buttons(0)
 962 {
 963 }
 964
 965 FGInput::mouse_mode::~mouse_mode ()
 966 {
 967                                 // FIXME: memory leak
 968 //   for (int i = 0; i < FG_MOD_MAX; i++) {
 969 //     int j;
 970 //     for (j = 0; i < x_bindings[i].size(); j++)
 971 //       delete bindings[i][j];
 972 //     for (j = 0; j < y_bindings[i].size(); j++)
 973 //       delete bindings[i][j];
 974 //   }
 975   delete [] buttons;
 976 }
 977
 978
 979 \f
 980 ////////////////////////////////////////////////////////////////////////
 981 // Implementation of FGInput::mouse
 982 ////////////////////////////////////////////////////////////////////////
 983
 984 FGInput::mouse::mouse ()
 985   : x(-1),
 986     y(-1),
 987     nModes(1),
 988     current_mode(0),
 989     modes(0)
 990 {
 991 }
 992
 993 FGInput::mouse::~mouse ()
 994 {
 995   delete [] modes;
 996 }
 997
 998
 999 \f
1000 ////////////////////////////////////////////////////////////////////////
1001 // Implementation of GLUT callbacks.
1002 ////////////////////////////////////////////////////////////////////////
1003
1004
1005 /**
1006  * Construct the modifiers.
1007  */
1008 static inline int get_mods ()
1009 {
1010   int glut_modifiers = glutGetModifiers();
1011   int modifiers = 0;
1012
1013   if (glut_modifiers & GLUT_ACTIVE_SHIFT)
1014     modifiers |= FGInput::FG_MOD_SHIFT;
1015   if (glut_modifiers & GLUT_ACTIVE_CTRL)
1016     modifiers |= FGInput::FG_MOD_CTRL;
1017   if (glut_modifiers & GLUT_ACTIVE_ALT)
1018     modifiers |= FGInput::FG_MOD_ALT;
1019
1020   return modifiers;
1021 }
1022
1023
1024 \f
1025 ////////////////////////////////////////////////////////////////////////
1026 // GLUT C callbacks.
1027 ////////////////////////////////////////////////////////////////////////
1028
1029 void
1030 GLUTkey(unsigned char k, int x, int y)
1031 {
1032                                 // Give PUI a chance to grab it first.
1033     if (!puKeyboard(k, PU_DOWN)) {
1034       if (default_input != 0)
1035           default_input->doKey(k, get_mods(), x, y);
1036     }
1037 }
1038
1039 void
1040 GLUTkeyup(unsigned char k, int x, int y)
1041 {
1042     if (default_input != 0)
1043         default_input->doKey(k, get_mods()|FGInput::FG_MOD_UP, x, y);
1044 }
1045
1046 void
1047 GLUTspecialkey(int k, int x, int y)
1048 {
1049                                 // Give PUI a chance to grab it first.
1050     if (!puKeyboard(k + PU_KEY_GLUT_SPECIAL_OFFSET, PU_DOWN)) {
1051         if (default_input != 0)
1052             default_input->doKey(k + 256, get_mods(), x, y);
1053     }
1054 }
1055
1056 void
1057 GLUTspecialkeyup(int k, int x, int y)
1058 {
1059     if (default_input != 0)
1060         default_input->doKey(k + 256, get_mods()|FGInput::FG_MOD_UP, x, y);
1061 }
1062
1063 void
1064 GLUTmouse (int button, int updown, int x, int y)
1065 {
1066     if (default_input != 0)
1067         default_input->doMouseClick(button, updown, x, y);
1068 }
1069
1070 void
1071 GLUTmotion (int x, int y)
1072 {
1073     if (default_input != 0)
1074         default_input->doMouseMotion(x, y);
1075 }
1076
1077 // end of input.cxx