1 // fg_commands.cxx - internal FGFS commands.
3 #include <simgear/compiler.h>
4 #include <simgear/misc/exception.hxx>
9 #include <simgear/debug/logstream.hxx>
10 #include <simgear/misc/commands.hxx>
11 #include <simgear/misc/props.hxx>
14 #include <Cockpit/panel.hxx>
15 #include <Cockpit/panel_io.hxx>
16 #include <Scenery/tilemgr.hxx>
17 #include <Time/tmp.hxx>
19 #include "fg_commands.hxx"
22 #if !defined(SG_HAVE_NATIVE_SGI_COMPILERS)
23 SG_USING_STD(ifstream);
24 SG_USING_STD(ofstream);
27 #include "fg_props.hxx"
29 #include "globals.hxx"
30 #include "viewmgr.hxx"
34 ////////////////////////////////////////////////////////////////////////
35 // Saved command states.
36 ////////////////////////////////////////////////////////////////////////
40 * Base saved state for property commands.
42 * Since this class isn't publicly visible, it is simply an aggregate
43 * of all the stuff any property command needs.
45 class PropertyCommandState : public SGCommandState
48 PropertyCommandState (const SGPropertyNode * arg);
49 virtual SGPropertyNode * getProp () const { return _prop; }
50 virtual SGPropertyNode * getProp2 () const { return _prop2; }
51 virtual const SGPropertyNode * getValue () const
52 { return _value ? _value : &_dummy_0; }
53 virtual const SGPropertyNode * getStep () const
54 { return _step ? _step : &_dummy_0; }
55 virtual const SGPropertyNode * getMin () const { return _min; }
56 virtual const SGPropertyNode * getMax () const { return _max; }
57 virtual const SGPropertyNode * getWrap () const
58 { return _wrap ? _wrap : &_dummy_0; }
59 virtual const SGPropertyNode * getFactor () const
60 { return _factor ? _factor : &_dummy_1; }
61 virtual const SGPropertyNode * getSetting () const
62 { return _setting ? _setting : &_dummy_0; }
63 virtual const SGPropertyNode * getOffset () const
64 { return _offset ? _offset : &_dummy_0; }
66 static SGPropertyNode _dummy_0;
67 static SGPropertyNode _dummy_1;
68 mutable SGPropertyNode * _prop;
69 mutable SGPropertyNode * _prop2;
70 const SGPropertyNode * _value;
71 const SGPropertyNode * _step;
72 const SGPropertyNode * _min;
73 const SGPropertyNode * _max;
74 const SGPropertyNode * _wrap;
75 const SGPropertyNode * _factor;
76 const SGPropertyNode * _setting;
77 const SGPropertyNode * _offset;
80 SGPropertyNode PropertyCommandState::_dummy_0;
81 SGPropertyNode PropertyCommandState::_dummy_1;
83 PropertyCommandState::PropertyCommandState (const SGPropertyNode * arg)
84 : SGCommandState(arg),
85 _prop(fgGetNode(arg->getStringValue("property[0]", "/null"), true)),
86 _prop2(fgGetNode(arg->getStringValue("property[1]", "/null"), true)),
87 _value(arg->getNode("value")),
88 _step(arg->getNode("step")),
89 _min(arg->getNode("min")),
90 _max(arg->getNode("max")),
91 _wrap(arg->getNode("wrap")),
92 _factor(arg->getNode("factor")),
93 _setting(arg->getNode("setting")),
94 _offset(arg->getNode("offset"))
96 // It would be better not to do this
97 // every time, but it's not that big
98 // a deal. I don't know enough about
99 // C++ static initialization to fix it.
100 _dummy_1.setDoubleValue(1.0);
106 ////////////////////////////////////////////////////////////////////////
107 // Command implementations.
108 ////////////////////////////////////////////////////////////////////////
112 * Built-in command: do nothing.
115 do_null (const SGPropertyNode * arg, SGCommandState ** state)
122 * Built-in command: exit FlightGear.
124 * TODO: show a confirm dialog.
127 do_exit (const SGPropertyNode * arg, SGCommandState ** state)
129 SG_LOG(SG_INPUT, SG_ALERT, "Program exit requested.");
136 * Built-in command: load flight.
138 * file (optional): the name of the file to load (relative to current
139 * directory). Defaults to "fgfs.sav".
142 do_load (const SGPropertyNode * arg, SGCommandState ** state)
144 const string &file = arg->getStringValue("file", "fgfs.sav");
145 ifstream input(file.c_str());
146 if (input.good() && fgLoadFlight(input)) {
148 SG_LOG(SG_INPUT, SG_INFO, "Restored flight from " << file);
151 SG_LOG(SG_INPUT, SG_ALERT, "Cannot load flight from " << file);
158 * Built-in command: save flight.
160 * file (optional): the name of the file to save (relative to the
161 * current directory). Defaults to "fgfs.sav".
164 do_save (const SGPropertyNode * arg, SGCommandState ** state)
166 const string &file = arg->getStringValue("file", "fgfs.sav");
167 SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
168 ofstream output(file.c_str());
169 if (output.good() && fgSaveFlight(output)) {
171 SG_LOG(SG_INPUT, SG_INFO, "Saved flight to " << file);
174 SG_LOG(SG_INPUT, SG_ALERT, "Cannot save flight to " << file);
181 * Built-in command: (re)load the panel.
183 * path (optional): the file name to load the panel from
184 * (relative to FG_ROOT). Defaults to the value of /sim/panel/path,
185 * and if that's unspecified, to "Panels/Default/default.xml".
188 do_panel_load (const SGPropertyNode * arg, SGCommandState ** state)
191 arg->getStringValue("path",
192 fgGetString("/sim/panel/path",
193 "Panels/Default/default.xml"));
194 FGPanel * new_panel = fgReadPanel(panel_path);
195 if (new_panel == 0) {
196 SG_LOG(SG_INPUT, SG_ALERT,
197 "Error reading new panel from " << panel_path);
200 SG_LOG(SG_INPUT, SG_INFO, "Loaded new panel from " << panel_path);
201 current_panel->unbind();
202 delete current_panel;
203 current_panel = new_panel;
204 current_panel->bind();
210 * Built-in command: (re)load preferences.
212 * path (optional): the file name to load the panel from (relative
213 * to FG_ROOT). Defaults to "preferences.xml".
216 do_preferences_load (const SGPropertyNode * arg, SGCommandState ** state)
218 const string &path = arg->getStringValue("path", "preferences.xml");
219 SGPath props_path(globals->get_fg_root());
220 props_path.append(path);
221 SG_LOG(SG_INPUT, SG_INFO, "Reading global preferences from "
222 << props_path.str());
224 readProperties(props_path.str(), globals->get_props());
225 } catch (const sg_exception &e) {
226 guiErrorMessage("Error reading global preferences: ", e);
229 SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
235 * Built-in command: cycle view.
238 do_view_cycle (const SGPropertyNode * arg, SGCommandState ** state)
240 globals->get_current_view()->set_view_offset(0.0);
241 globals->set_current_view(globals->get_viewmgr()->next_view());
242 // fgReshape(fgGetInt("/sim/startup/xsize"), fgGetInt("/sim/startup/ysize"));
248 * Built-in command: capture screen.
251 do_screen_capture (const SGPropertyNode * arg, SGCommandState ** state)
259 * Reload the tile cache.
262 do_tile_cache_reload (const SGPropertyNode * arg, SGCommandState ** state)
264 bool freeze = globals->get_freeze();
265 SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
267 globals->set_freeze( true );
269 if ( global_tile_mgr.init() ) {
270 // Load the local scenery data
271 global_tile_mgr.update(fgGetDouble("/position/longitude-deg"),
272 fgGetDouble("/position/latitude-deg"));
274 SG_LOG( SG_GENERAL, SG_ALERT,
275 "Error in Tile Manager initialization!" );
280 globals->set_freeze( false );
286 * Update the lighting manually.
289 do_lighting_update (const SGPropertyNode * arg, SGCommandState ** state)
291 fgUpdateSkyAndLightingParams();
297 * Built-in command: toggle a bool property value.
299 * property: The name of the property to toggle.
302 do_property_toggle (const SGPropertyNode * arg, SGCommandState ** state)
305 *state = new PropertyCommandState(arg);
306 SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
307 return prop->setBoolValue(!prop->getBoolValue());
312 * Built-in command: assign a value to a property.
314 * property: the name of the property to assign.
315 * value: the value to assign.
318 do_property_assign (const SGPropertyNode * arg, SGCommandState ** state)
321 *state = new PropertyCommandState(arg);
322 SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
323 const SGPropertyNode * value =
324 ((PropertyCommandState *)(*state))->getValue();
326 switch (prop->getType()) {
327 case SGPropertyNode::BOOL:
328 return prop->setBoolValue(value->getBoolValue());
329 case SGPropertyNode::INT:
330 return prop->setIntValue(value->getIntValue());
331 case SGPropertyNode::LONG:
332 return prop->setLongValue(value->getLongValue());
333 case SGPropertyNode::FLOAT:
334 return prop->setFloatValue(value->getFloatValue());
335 case SGPropertyNode::DOUBLE:
336 return prop->setDoubleValue(value->getDoubleValue());
337 case SGPropertyNode::STRING:
338 return prop->setStringValue(value->getStringValue());
340 return prop->setUnspecifiedValue(value->getStringValue());
346 * Built-in command: increment or decrement a property value.
348 * property: the name of the property to increment or decrement.
349 * step: the amount of the increment or decrement (default: 0).
350 * min: the minimum allowed value (default: no minimum).
351 * max: the maximum allowed value (default: no maximum).
352 * wrap: true if the value should be wrapped when it passes min or max;
353 * both min and max must be present for this to work (default:
357 do_property_adjust (const SGPropertyNode * arg, SGCommandState ** state)
360 *state = new PropertyCommandState(arg);
361 SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
362 const SGPropertyNode * step = ((PropertyCommandState *)(*state))->getStep();
363 const SGPropertyNode * min = ((PropertyCommandState *)(*state))->getMin();
364 const SGPropertyNode * max = ((PropertyCommandState *)(*state))->getMax();
365 bool wrap = ((PropertyCommandState *)(*state))->getWrap()->getBoolValue();
367 switch (prop->getType()) {
368 case SGPropertyNode::BOOL:
369 if (step->getBoolValue())
370 return prop->setBoolValue(!prop->getBoolValue());
373 case SGPropertyNode::INT: {
374 int value = prop->getIntValue() + step->getIntValue();
375 if (min && (value < min->getIntValue())) {
377 value = max->getIntValue();
379 value = min->getIntValue();
381 if (max && value > max->getIntValue()) {
383 value = min->getIntValue();
385 value = max->getIntValue();
387 return prop->setIntValue(value);
389 case SGPropertyNode::LONG: {
390 long value = prop->getLongValue() + step->getLongValue();
391 if (min && (value < min->getLongValue())) {
393 value = max->getLongValue();
395 value = min->getLongValue();
397 if (max && value > max->getLongValue()) {
399 value = min->getLongValue();
401 value = max->getLongValue();
403 return prop->setLongValue(value);
405 case SGPropertyNode::FLOAT: {
406 float value = prop->getFloatValue() + step->getFloatValue();
407 if (min && (value < min->getFloatValue())) {
409 value = max->getFloatValue();
411 value = min->getFloatValue();
413 if (max && value > max->getFloatValue()) {
415 value = min->getFloatValue();
417 value = max->getFloatValue();
419 return prop->setFloatValue(value);
421 case SGPropertyNode::DOUBLE:
422 case SGPropertyNode::UNSPECIFIED:
423 case SGPropertyNode::NONE: {
424 double value = prop->getDoubleValue() + step->getDoubleValue();
425 if (min && (value < min->getDoubleValue())) {
427 value = max->getDoubleValue();
429 value = min->getDoubleValue();
431 if (max && value > max->getDoubleValue()) {
433 value = min->getDoubleValue();
435 value = max->getDoubleValue();
437 return prop->setDoubleValue(value);
439 case SGPropertyNode::STRING: // doesn't make sense with strings
440 SG_LOG(SG_INPUT, SG_ALERT, "Cannot adjust a string value");
443 SG_LOG(SG_INPUT, SG_ALERT, "Unknown value type");
450 * Built-in command: multiply a property value.
452 * property: the name of the property to multiply.
453 * factor: the amount by which to multiply.
456 do_property_multiply (const SGPropertyNode * arg, SGCommandState ** state)
459 *state = new PropertyCommandState(arg);
460 SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
461 const SGPropertyNode * factor =
462 ((PropertyCommandState *)(*state))->getFactor();
464 switch (prop->getType()) {
465 case SGPropertyNode::BOOL:
466 return prop->setBoolValue(prop->getBoolValue() &&
467 factor->getBoolValue());
468 case SGPropertyNode::INT:
469 return prop->setIntValue(int(prop->getIntValue()
470 * factor->getDoubleValue()));
471 case SGPropertyNode::LONG:
472 return prop->setLongValue(long(prop->getLongValue()
473 * factor->getDoubleValue()));
474 case SGPropertyNode::FLOAT:
475 return prop->setFloatValue(float(prop->getFloatValue()
476 * factor->getDoubleValue()));
477 case SGPropertyNode::DOUBLE:
478 case SGPropertyNode::UNSPECIFIED:
479 case SGPropertyNode::NONE:
480 return prop->setDoubleValue(prop->getDoubleValue()
481 * factor->getDoubleValue());
482 default: // doesn't make sense with strings
489 * Built-in command: swap two property values.
491 * property[0]: the name of the first property.
492 * property[1]: the name of the second property.
495 do_property_swap (const SGPropertyNode * arg, SGCommandState ** state)
498 *state = new PropertyCommandState(arg);
499 SGPropertyNode * prop1 = ((PropertyCommandState *)(*state))->getProp();
500 SGPropertyNode * prop2 = ((PropertyCommandState *)(*state))->getProp2();
502 // FIXME: inefficient
503 const string & tmp = prop1->getStringValue();
504 return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
505 prop2->setUnspecifiedValue(tmp));
510 * Set a property to an axis or other moving input.
512 * property: the name of the property to set.
513 * setting: the current input setting, usually between -1.0 and 1.0.
514 * offset: the offset to shift by, before applying the factor.
515 * factor: the factor to multiply by (use negative to reverse).
518 do_property_scale (const SGPropertyNode * arg, SGCommandState ** state)
521 *state = new PropertyCommandState(arg);
522 SGPropertyNode * prop = ((PropertyCommandState *)(*state))->getProp();
524 ((PropertyCommandState *)(*state))->getSetting()->getDoubleValue();
526 ((PropertyCommandState *)(*state))->getOffset()->getDoubleValue();
528 ((PropertyCommandState *)(*state))->getFactor()->getDoubleValue();
530 return prop->setDoubleValue((setting + offset) * factor);
535 ////////////////////////////////////////////////////////////////////////
537 ////////////////////////////////////////////////////////////////////////
541 * Table of built-in commands.
543 * New commands do not have to be added here; any module in the application
544 * can add a new command using globals->get_commands()->addCommand(...).
548 SGCommandMgr::command_t command;
554 { "panel-load", do_panel_load },
555 { "preferences-load", do_preferences_load },
556 { "view-cycle", do_view_cycle },
557 { "screen-capture", do_screen_capture },
558 { "tile-cache-reload", do_tile_cache_reload },
559 { "lighting-update", do_lighting_update },
560 { "property-toggle", do_property_toggle },
561 { "property-assign", do_property_assign },
562 { "property-adjust", do_property_adjust },
563 { "property-multiply", do_property_multiply },
564 { "property-swap", do_property_swap },
565 { "property-scale", do_property_scale },
566 { 0, 0 } // zero-terminated
571 * Initialize the default built-in commands.
573 * Other commands may be added by other parts of the application.
578 SG_LOG(SG_GENERAL, SG_INFO, "Initializing basic built-in commands:");
579 for (int i = 0; built_ins[i].name != 0; i++) {
580 SG_LOG(SG_GENERAL, SG_INFO, " " << built_ins[i].name);
581 globals->get_commands()->addCommand(built_ins[i].name,
582 built_ins[i].command);
586 // end of fg_commands.hxx