1 // fg_commands.cxx - internal FGFS commands.
3 #include <string.h> // strcmp()
5 #include <simgear/compiler.h>
6 #include <simgear/misc/exception.hxx>
11 #include <simgear/debug/logstream.hxx>
12 #include <simgear/misc/commands.hxx>
13 #include <simgear/misc/props.hxx>
14 #include <simgear/sg_inlines.h>
16 #include <Cockpit/panel.hxx>
17 #include <Cockpit/panel_io.hxx>
18 #include <FDM/flight.hxx>
20 #include <GUI/new_gui.hxx>
21 #include <GUI/dialog.hxx>
22 #include <Scenery/tilemgr.hxx>
23 #if defined(HAVE_PLIB_PSL)
24 #include <Scripting/scriptmgr.hxx>
26 #include <Time/tmp.hxx>
28 #include "fg_init.hxx"
29 #include "fg_commands.hxx"
32 SG_USING_STD(ifstream);
33 SG_USING_STD(ofstream);
35 #include "fg_props.hxx"
37 #include "globals.hxx"
38 #include "viewmgr.hxx"
42 ////////////////////////////////////////////////////////////////////////
43 // Static helper functions.
44 ////////////////////////////////////////////////////////////////////////
47 static inline SGPropertyNode *
48 get_prop (const SGPropertyNode * arg)
50 return fgGetNode(arg->getStringValue("property[0]", "/null"), true);
53 static inline SGPropertyNode *
54 get_prop2 (const SGPropertyNode * arg)
56 return fgGetNode(arg->getStringValue("property[1]", "/null"), true);
61 * Get a double value and split it as required.
64 split_value (double full_value, const char * mask,
65 double * unmodifiable, double * modifiable)
67 if (!strcmp("integer", mask)) {
68 *modifiable = (full_value < 0 ? ceil(full_value) : floor (full_value));
69 *unmodifiable = full_value - *modifiable;
70 } else if (!strcmp("decimal", mask)) {
71 *unmodifiable = (full_value < 0 ? ceil(full_value) : floor(full_value));
72 *modifiable = full_value - *unmodifiable;
74 if (strcmp("all", mask))
75 SG_LOG(SG_GENERAL, SG_ALERT, "Bad value " << mask << " for mask;"
76 << " assuming 'all'");
78 *modifiable = full_value;
84 * Clamp or wrap a value as specified.
87 limit_value (double * value, const SGPropertyNode * arg)
89 const SGPropertyNode * min_node = arg->getChild("min");
90 const SGPropertyNode * max_node = arg->getChild("max");
92 bool wrap = arg->getBoolValue("wrap");
94 if (min_node == 0 || max_node == 0)
97 if (wrap) { // wrap such that min <= x < max
98 double min_val = min_node->getDoubleValue();
99 double max_val = max_node->getDoubleValue();
100 double resolution = arg->getDoubleValue("resolution");
101 if (resolution > 0.0) {
102 // snap to (min + N*resolution), taking special care to handle imprecision
103 int n = (int)floor((*value - min_val) / resolution + 0.5);
104 int steps = (int)floor((max_val - min_val) / resolution + 0.5);
105 SG_NORMALIZE_RANGE(n, 0, steps);
106 *value = min_val + resolution * n;
108 // plain circular wrapping
109 SG_NORMALIZE_RANGE(*value, min_val, max_val);
111 } else { // clamp such that min <= x <= max
112 if ((min_node != 0) && (*value < min_node->getDoubleValue()))
113 *value = min_node->getDoubleValue();
114 else if ((max_node != 0) && (*value > max_node->getDoubleValue()))
115 *value = max_node->getDoubleValue();
120 compare_values (SGPropertyNode * value1, SGPropertyNode * value2)
122 switch (value1->getType()) {
123 case SGPropertyNode::BOOL:
124 return (value1->getBoolValue() == value2->getBoolValue());
125 case SGPropertyNode::INT:
126 return (value1->getIntValue() == value2->getIntValue());
127 case SGPropertyNode::LONG:
128 return (value1->getLongValue() == value2->getLongValue());
129 case SGPropertyNode::FLOAT:
130 return (value1->getFloatValue() == value2->getFloatValue());
131 case SGPropertyNode::DOUBLE:
132 return (value1->getDoubleValue() == value2->getDoubleValue());
134 return !strcmp(value1->getStringValue(), value2->getStringValue());
140 ////////////////////////////////////////////////////////////////////////
141 // Command implementations.
142 ////////////////////////////////////////////////////////////////////////
146 * Built-in command: do nothing.
149 do_null (const SGPropertyNode * arg)
154 #if defined(HAVE_PLIB_PSL)
156 * Built-in command: run a PSL script.
159 do_script (const SGPropertyNode * arg)
161 FGScriptMgr * mgr = (FGScriptMgr *)globals->get_subsystem("scripting");
162 return mgr->run(arg->getStringValue("script"));
164 #endif // HAVE_PLIB_PSL
168 * Built-in command: exit FlightGear.
170 * TODO: show a confirm dialog.
173 do_exit (const SGPropertyNode * arg)
175 SG_LOG(SG_INPUT, SG_ALERT, "Program exit requested.");
182 * Built-in command: load flight.
184 * file (optional): the name of the file to load (relative to current
185 * directory). Defaults to "fgfs.sav".
188 do_load (const SGPropertyNode * arg)
190 const string &file = arg->getStringValue("file", "fgfs.sav");
191 ifstream input(file.c_str());
192 if (input.good() && fgLoadFlight(input)) {
194 SG_LOG(SG_INPUT, SG_INFO, "Restored flight from " << file);
197 SG_LOG(SG_INPUT, SG_ALERT, "Cannot load flight from " << file);
204 * Built-in command: save flight.
206 * file (optional): the name of the file to save (relative to the
207 * current directory). Defaults to "fgfs.sav".
210 do_save (const SGPropertyNode * arg)
212 const string &file = arg->getStringValue("file", "fgfs.sav");
213 bool write_all = arg->getBoolValue("write-all", false);
214 SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
215 ofstream output(file.c_str());
216 if (output.good() && fgSaveFlight(output, write_all)) {
218 SG_LOG(SG_INPUT, SG_INFO, "Saved flight to " << file);
221 SG_LOG(SG_INPUT, SG_ALERT, "Cannot save flight to " << file);
228 * Built-in command: (re)load the panel.
230 * path (optional): the file name to load the panel from
231 * (relative to FG_ROOT). Defaults to the value of /sim/panel/path,
232 * and if that's unspecified, to "Panels/Default/default.xml".
235 do_panel_load (const SGPropertyNode * arg)
238 arg->getStringValue("path",
239 fgGetString("/sim/panel/path",
240 "Panels/Default/default.xml"));
241 FGPanel * new_panel = fgReadPanel(panel_path);
242 if (new_panel == 0) {
243 SG_LOG(SG_INPUT, SG_ALERT,
244 "Error reading new panel from " << panel_path);
247 SG_LOG(SG_INPUT, SG_INFO, "Loaded new panel from " << panel_path);
248 current_panel->unbind();
249 delete current_panel;
250 current_panel = new_panel;
251 current_panel->bind();
257 * Built-in command: pass a mouse click to the panel.
259 * button: the mouse button number, zero-based.
260 * is-down: true if the button is down, false if it is up.
261 * x-pos: the x position of the mouse click.
262 * y-pos: the y position of the mouse click.
265 do_panel_mouse_click (const SGPropertyNode * arg)
267 if (current_panel != 0)
269 ->doMouseAction(arg->getIntValue("button"),
270 arg->getBoolValue("is-down") ? PU_DOWN : PU_UP,
271 arg->getIntValue("x-pos"),
272 arg->getIntValue("y-pos"));
279 * Built-in command: (re)load preferences.
281 * path (optional): the file name to load the panel from (relative
282 * to FG_ROOT). Defaults to "preferences.xml".
285 do_preferences_load (const SGPropertyNode * arg)
288 fgLoadProps(arg->getStringValue("path", "preferences.xml"),
289 globals->get_props());
290 } catch (const sg_exception &e) {
291 guiErrorMessage("Error reading global preferences: ", e);
294 SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
302 if ( !strcmp(fgGetString("/sim/flight-model"), "ada") ) {
303 globals->get_props()->setBoolValue( "/sim/hud/visibility", true );
304 if ( globals->get_viewmgr()->get_current() == 1 ) {
305 globals->get_props()->setBoolValue( "/sim/hud/visibility", false );
313 globals->get_current_view()->setHeadingOffset_deg(0.0);
314 globals->get_viewmgr()->next_view();
315 fix_hud_visibility();
316 globals->get_tile_mgr()->refresh_view_timestamps();
322 globals->get_current_view()->setHeadingOffset_deg(0.0);
323 globals->get_viewmgr()->prev_view();
324 fix_hud_visibility();
325 globals->get_tile_mgr()->refresh_view_timestamps();
329 * Built-in command: cycle view.
332 do_view_cycle (const SGPropertyNode * arg)
334 globals->get_current_view()->setHeadingOffset_deg(0.0);
335 globals->get_viewmgr()->next_view();
336 fix_hud_visibility();
337 globals->get_tile_mgr()->refresh_view_timestamps();
338 // fgReshape(fgGetInt("/sim/startup/xsize"), fgGetInt("/sim/startup/ysize"));
343 * Built-in command: capture screen.
346 do_screen_capture (const SGPropertyNode * arg)
354 * Reload the tile cache.
357 do_tile_cache_reload (const SGPropertyNode * arg)
359 static const SGPropertyNode *master_freeze
360 = fgGetNode("/sim/freeze/master");
361 bool freeze = master_freeze->getBoolValue();
362 SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
364 fgSetBool("/sim/freeze/master", true);
367 if ( globals->get_tile_mgr()->init() ) {
368 // Load the local scenery data
369 double visibility_meters = fgGetDouble("/environment/visibility-m");
370 globals->get_tile_mgr()->update( visibility_meters );
372 SG_LOG( SG_GENERAL, SG_ALERT,
373 "Error in Tile Manager initialization!" );
378 fgSetBool("/sim/freeze/master", false);
385 * Update the lighting manually.
388 do_lighting_update (const SGPropertyNode * arg)
390 fgUpdateSkyAndLightingParams();
396 * Built-in command: toggle a bool property value.
398 * property: The name of the property to toggle.
401 do_property_toggle (const SGPropertyNode * arg)
403 SGPropertyNode * prop = get_prop(arg);
404 return prop->setBoolValue(!prop->getBoolValue());
409 * Built-in command: assign a value to a property.
411 * property: the name of the property to assign.
412 * value: the value to assign; or
413 * property[1]: the property to copy from.
416 do_property_assign (const SGPropertyNode * arg)
418 SGPropertyNode * prop = get_prop(arg);
419 const SGPropertyNode * prop2 = get_prop2(arg);
420 const SGPropertyNode * value = arg->getNode("value");
423 return prop->setUnspecifiedValue(value->getStringValue());
425 return prop->setUnspecifiedValue(prop2->getStringValue());
432 * Built-in command: increment or decrement a property value.
434 * If the 'step' argument is present, it will be used; otherwise,
435 * the command uses 'offset' and 'factor', usually from the mouse.
437 * property: the name of the property to increment or decrement.
438 * step: the amount of the increment or decrement (default: 0).
439 * offset: offset from the current setting (used for the mouse; multiplied
441 * factor: scaling amount for the offset (defaults to 1).
442 * min: the minimum allowed value (default: no minimum).
443 * max: the maximum allowed value (default: no maximum).
444 * mask: 'integer' to apply only to the left of the decimal point,
445 * 'decimal' to apply only to the right of the decimal point,
446 * or 'all' to apply to the whole number (the default).
447 * wrap: true if the value should be wrapped when it passes min or max;
448 * both min and max must be present for this to work (default:
452 do_property_adjust (const SGPropertyNode * arg)
454 SGPropertyNode * prop = get_prop(arg);
457 if (arg->hasValue("step"))
458 amount = arg->getDoubleValue("step");
460 amount = (arg->getDoubleValue("factor", 1)
461 * arg->getDoubleValue("offset"));
463 double unmodifiable, modifiable;
464 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
465 &unmodifiable, &modifiable);
466 modifiable += amount;
467 limit_value(&modifiable, arg);
469 prop->setDoubleValue(unmodifiable + modifiable);
476 * Built-in command: multiply a property value.
478 * property: the name of the property to multiply.
479 * factor: the amount by which to multiply.
480 * min: the minimum allowed value (default: no minimum).
481 * max: the maximum allowed value (default: no maximum).
482 * mask: 'integer' to apply only to the left of the decimal point,
483 * 'decimal' to apply only to the right of the decimal point,
484 * or 'all' to apply to the whole number (the default).
485 * wrap: true if the value should be wrapped when it passes min or max;
486 * both min and max must be present for this to work (default:
490 do_property_multiply (const SGPropertyNode * arg)
492 SGPropertyNode * prop = get_prop(arg);
493 double factor = arg->getDoubleValue("factor", 1);
495 double unmodifiable, modifiable;
496 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
497 &unmodifiable, &modifiable);
498 modifiable *= factor;
499 limit_value(&modifiable, arg);
501 prop->setDoubleValue(unmodifiable + modifiable);
508 * Built-in command: swap two property values.
510 * property[0]: the name of the first property.
511 * property[1]: the name of the second property.
514 do_property_swap (const SGPropertyNode * arg)
516 SGPropertyNode * prop1 = get_prop(arg);
517 SGPropertyNode * prop2 = get_prop2(arg);
519 // FIXME: inefficient
520 const string & tmp = prop1->getStringValue();
521 return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
522 prop2->setUnspecifiedValue(tmp.c_str()));
527 * Built-in command: Set a property to an axis or other moving input.
529 * property: the name of the property to set.
530 * setting: the current input setting, usually between -1.0 and 1.0.
531 * offset: the offset to shift by, before applying the factor.
532 * factor: the factor to multiply by (use negative to reverse).
535 do_property_scale (const SGPropertyNode * arg)
537 SGPropertyNode * prop = get_prop(arg);
538 double setting = arg->getDoubleValue("setting");
539 double offset = arg->getDoubleValue("offset", 0.0);
540 double factor = arg->getDoubleValue("factor", 1.0);
541 bool squared = arg->getBoolValue("squared", false);
544 setting = (setting < 0 ? -1 : 1) * setting * setting;
546 return prop->setDoubleValue((setting + offset) * factor);
551 * Built-in command: cycle a property through a set of values.
553 * If the current value isn't in the list, the cycle will
554 * (re)start from the beginning.
556 * property: the name of the property to cycle.
557 * value[*]: the list of values to cycle through.
560 do_property_cycle (const SGPropertyNode * arg)
562 SGPropertyNode * prop = get_prop(arg);
563 vector<SGPropertyNode_ptr> values = arg->getChildren("value");
565 int nSelections = values.size();
567 if (nSelections < 1) {
568 SG_LOG(SG_GENERAL, SG_ALERT, "No values for property-cycle");
572 // Try to find the current selection
573 for (int i = 0; i < nSelections; i++) {
574 if (compare_values(prop, values[i])) {
580 // Default or wrap to the first selection
581 if (selection < 0 || selection >= nSelections)
584 prop->setUnspecifiedValue(values[selection]->getStringValue());
590 * Built-in command: Show an XML-configured dialog.
592 * dialog-name: the name of the GUI dialog to display.
595 do_dialog_show (const SGPropertyNode * arg)
597 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
598 gui->showDialog(arg->getStringValue("dialog-name"));
604 * Built-in Command: Hide the active XML-configured dialog.
607 do_dialog_close (const SGPropertyNode * arg)
609 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
610 gui->closeActiveDialog();
615 * Update a value in the active XML-configured dialog.
617 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
620 do_dialog_update (const SGPropertyNode * arg)
622 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
623 FGDialog * dialog = gui->getActiveDialog();
625 if (arg->hasValue("object-name")) {
626 dialog->updateValue(arg->getStringValue("object-name"));
628 dialog->updateValues();
638 * Apply a value in the active XML-configured dialog.
640 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
643 do_dialog_apply (const SGPropertyNode * arg)
645 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
646 FGDialog * dialog = gui->getActiveDialog();
648 if (arg->hasValue("object-name")) {
649 const char * name = arg->getStringValue("object-name");
650 dialog->applyValue(name);
651 dialog->updateValue(name);
653 dialog->applyValues();
654 dialog->updateValues();
664 * Built-in command: commit presets (read from in /sim/presets/)
667 do_presets_commit (const SGPropertyNode * arg)
669 // unbind the current fdm state so property changes
670 // don't get lost when we subsequently delete this fdm
671 // and create a new one.
672 cur_fdm_state->unbind();
674 // set position from presets
678 fgReInitSubsystems();
680 globals->get_tile_mgr()->update( fgGetDouble("/environment/visibility-m") );
682 if ( ! fgGetBool("/sim/presets/onground") ) {
683 fgSetBool( "/sim/freeze/master", true );
684 fgSetBool( "/sim/freeze/clock", true );
692 ////////////////////////////////////////////////////////////////////////
694 ////////////////////////////////////////////////////////////////////////
698 * Table of built-in commands.
700 * New commands do not have to be added here; any module in the application
701 * can add a new command using globals->get_commands()->addCommand(...).
705 SGCommandMgr::command_t command;
708 #if defined(HAVE_PLIB_PSL)
709 { "script", do_script },
710 #endif // HAVE_PLIB_PSL
714 { "panel-load", do_panel_load },
715 { "panel-mouse-click", do_panel_mouse_click },
716 { "preferences-load", do_preferences_load },
717 { "view-cycle", do_view_cycle },
718 { "screen-capture", do_screen_capture },
719 { "tile-cache-reload", do_tile_cache_reload },
720 { "lighting-update", do_lighting_update },
721 { "property-toggle", do_property_toggle },
722 { "property-assign", do_property_assign },
723 { "property-adjust", do_property_adjust },
724 { "property-multiply", do_property_multiply },
725 { "property-swap", do_property_swap },
726 { "property-scale", do_property_scale },
727 { "property-cycle", do_property_cycle },
728 { "dialog-show", do_dialog_show },
729 { "dialog-close", do_dialog_close },
730 { "dialog-show", do_dialog_show },
731 { "dialog-update", do_dialog_update },
732 { "dialog-apply", do_dialog_apply },
733 { "presets-commit", do_presets_commit },
734 { 0, 0 } // zero-terminated
739 * Initialize the default built-in commands.
741 * Other commands may be added by other parts of the application.
746 SG_LOG(SG_GENERAL, SG_INFO, "Initializing basic built-in commands:");
747 for (int i = 0; built_ins[i].name != 0; i++) {
748 SG_LOG(SG_GENERAL, SG_INFO, " " << built_ins[i].name);
749 globals->get_commands()->addCommand(built_ins[i].name,
750 built_ins[i].command);
753 typedef bool (*dummy)();
754 fgTie( "/command/view/next", dummy(0), do_view_next );
755 fgTie( "/command/view/prev", dummy(0), do_view_prev );
758 // end of fg_commands.cxx