1 // fg_props.cxx -- support for FlightGear properties.
3 // Written by David Megginson, started 2000.
5 // Copyright (C) 2000, 2001 David Megginson - david@megginson.com
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #include <simgear/compiler.h>
28 #include <simgear/structure/exception.hxx>
29 #include <simgear/props/props_io.hxx>
31 #include <simgear/timing/sg_time.hxx>
32 #include <simgear/misc/sg_path.hxx>
33 #include <simgear/scene/model/particles.hxx>
34 #include <simgear/sound/soundmgr_openal.hxx>
38 #include "globals.hxx"
39 #include "fg_props.hxx"
42 static bool winding_ccw = true; // FIXME: temporary
44 static bool frozen = false; // FIXME: temporary
47 ////////////////////////////////////////////////////////////////////////
48 // Default property bindings (not yet handled by any module).
49 ////////////////////////////////////////////////////////////////////////
51 struct LogClassMapping {
54 LogClassMapping(sgDebugClass cc, string nname) { c = cc; name = nname; }
57 LogClassMapping log_class_mappings [] = {
58 LogClassMapping(SG_NONE, "none"),
59 LogClassMapping(SG_TERRAIN, "terrain"),
60 LogClassMapping(SG_ASTRO, "astro"),
61 LogClassMapping(SG_FLIGHT, "flight"),
62 LogClassMapping(SG_INPUT, "input"),
63 LogClassMapping(SG_GL, "gl"),
64 LogClassMapping(SG_VIEW, "view"),
65 LogClassMapping(SG_COCKPIT, "cockpit"),
66 LogClassMapping(SG_GENERAL, "general"),
67 LogClassMapping(SG_MATH, "math"),
68 LogClassMapping(SG_EVENT, "event"),
69 LogClassMapping(SG_AIRCRAFT, "aircraft"),
70 LogClassMapping(SG_AUTOPILOT, "autopilot"),
71 LogClassMapping(SG_IO, "io"),
72 LogClassMapping(SG_CLIPPER, "clipper"),
73 LogClassMapping(SG_NETWORK, "network"),
74 LogClassMapping(SG_INSTR, "instrumentation"),
75 LogClassMapping(SG_ATC, "atc"),
76 LogClassMapping(SG_NASAL, "nasal"),
77 LogClassMapping(SG_SYSTEMS, "systems"),
78 LogClassMapping(SG_AI, "ai"),
79 LogClassMapping(SG_ENVIRONMENT, "environment"),
80 LogClassMapping(SG_SOUND, "sound"),
81 LogClassMapping(SG_NAVAID, "navaid"),
82 LogClassMapping(SG_GUI, "gui"),
83 LogClassMapping(SG_UNDEFD, "")
88 * Get the logging classes.
90 // XXX Making the result buffer be global is a band-aid that hopefully
91 // delays its destruction 'til after its last use.
100 sgDebugClass classes = sglog().get_log_classes();
101 loggingResult.clear();
102 for (int i = 0; log_class_mappings[i].c != SG_UNDEFD; i++) {
103 if ((classes&log_class_mappings[i].c) > 0) {
104 if (!loggingResult.empty())
105 loggingResult += '|';
106 loggingResult += log_class_mappings[i].name;
109 return loggingResult.c_str();
114 addLoggingClass (const string &name)
116 sgDebugClass classes = sglog().get_log_classes();
117 for (int i = 0; log_class_mappings[i].c != SG_UNDEFD; i++) {
118 if (name == log_class_mappings[i].name) {
119 sglog().set_log_classes(sgDebugClass(classes|log_class_mappings[i].c));
123 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging class: " << name);
128 * Set the logging classes.
131 setLoggingClasses (const char * c)
134 sglog().set_log_classes(SG_NONE);
136 if (classes == "none") {
137 SG_LOG(SG_GENERAL, SG_INFO, "Disabled all logging classes");
141 if (classes.empty() || classes == "all") { // default
142 sglog().set_log_classes(SG_ALL);
143 SG_LOG(SG_GENERAL, SG_INFO, "Enabled all logging classes: "
144 << getLoggingClasses());
148 string rest = classes;
150 string::size_type sep = rest.find('|');
151 if (sep == string::npos)
152 sep = rest.find(',');
153 while (sep != string::npos) {
154 name = rest.substr(0, sep);
155 rest = rest.substr(sep+1);
156 addLoggingClass(name);
157 sep = rest.find('|');
158 if (sep == string::npos)
159 sep = rest.find(',');
161 addLoggingClass(rest);
162 SG_LOG(SG_GENERAL, SG_INFO, "Set logging classes to "
163 << getLoggingClasses());
168 * Get the logging priority.
171 getLoggingPriority ()
173 switch (sglog().get_log_priority()) {
185 SG_LOG(SG_GENERAL, SG_WARN, "Internal: Unknown logging priority number: "
186 << sglog().get_log_priority());
193 * Set the logging priority.
196 setLoggingPriority (const char * p)
201 if (priority == "bulk") {
202 sglog().set_log_priority(SG_BULK);
203 } else if (priority == "debug") {
204 sglog().set_log_priority(SG_DEBUG);
205 } else if (priority.empty() || priority == "info") { // default
206 sglog().set_log_priority(SG_INFO);
207 } else if (priority == "warn") {
208 sglog().set_log_priority(SG_WARN);
209 } else if (priority == "alert") {
210 sglog().set_log_priority(SG_ALERT);
212 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging priority " << priority);
214 SG_LOG(SG_GENERAL, SG_DEBUG, "Logging priority is " << getLoggingPriority());
219 * Return the current frozen state.
229 * Set the current frozen state.
236 // Stop sound on a pause
237 SGSoundMgr *smgr = globals->get_soundmgr();
238 if ( smgr != NULL ) {
241 } else if (fgGetBool("/sim/sound/working")) {
246 // Pause the particle system
247 simgear::Particles::setFrozen(f);
252 * Return the number of milliseconds elapsed since simulation started.
255 getElapsedTime_sec ()
257 return globals->get_sim_time_sec();
262 * Return the current Zulu time.
267 static char buf[64]; // FIXME
269 SGTime * st = globals->get_time_params();
275 struct tm * t = st->getGmt();
276 sprintf(buf, "%.4d-%.2d-%.2dT%.2d:%.2d:%.2d",
277 t->tm_year + 1900, t->tm_mon + 1, t->tm_mday,
278 t->tm_hour, t->tm_min, t->tm_sec);
284 * Set the current Zulu time.
287 setDateString (const char * date_string)
289 SGTime * st = globals->get_time_params();
290 struct tm * current_time = st->getGmt();
293 // Scan for basic ISO format
294 // YYYY-MM-DDTHH:MM:SS
295 int ret = sscanf(date_string, "%d-%d-%dT%d:%d:%d",
296 &(new_time.tm_year), &(new_time.tm_mon),
297 &(new_time.tm_mday), &(new_time.tm_hour),
298 &(new_time.tm_min), &(new_time.tm_sec));
300 // Be pretty picky about this, so
301 // that strange things don't happen
302 // if the save file has been edited
305 SG_LOG(SG_INPUT, SG_WARN, "Date/time string " << date_string
306 << " not in YYYY-MM-DDTHH:MM:SS format; skipped");
310 // OK, it looks like we got six
311 // values, one way or another.
312 new_time.tm_year -= 1900;
313 new_time.tm_mon -= 1;
314 // Now, tell flight gear to use
315 // the new time. This was far
316 // too difficult, by the way.
318 mktime(&new_time) - mktime(current_time) + globals->get_warp();
320 fgSetInt("/sim/time/warp", warp);
324 * Return the GMT as a string.
330 SGTime * st = globals->get_time_params();
336 struct tm *t = st->getGmt();
337 snprintf(buf, 16, "%.2d:%.2d:%.2d",
338 t->tm_hour, t->tm_min, t->tm_sec);
343 * Return the current heading in degrees.
348 double magheading = fgGetDouble("/orientation/heading-deg") -
349 fgGetDouble("/environment/magnetic-variation-deg");
350 return SGMiscd::normalizePeriodic(0, 360, magheading );
354 * Return the current track in degrees.
359 double magtrack = fgGetDouble("/orientation/track-deg") -
360 fgGetDouble("/environment/magnetic-variation-deg");
361 return SGMiscd::normalizePeriodic(0, 360, magtrack );
371 setWindingCCW (bool state)
375 glFrontFace ( GL_CCW );
377 glFrontFace ( GL_CW );
380 ////////////////////////////////////////////////////////////////////////
381 // Tie the properties.
382 ////////////////////////////////////////////////////////////////////////
383 SGConstPropertyNode_ptr FGProperties::_longDeg;
384 SGConstPropertyNode_ptr FGProperties::_latDeg;
385 SGConstPropertyNode_ptr FGProperties::_lonLatformat;
388 FGProperties::getLongitudeString ()
391 double d = _longDeg->getDoubleValue();
392 int format = _lonLatformat->getIntValue();
393 char c = d < 0.0 ? 'W' : 'E';
397 snprintf(buf, 32, "%3.6f%c", d, c);
399 } else if (format == 1) {
400 // dd mm.mmm' (DMM-Format) -- uses a round-off factor tailored to the
401 // required precision of the minutes field (three decimal places),
402 // preventing minute values of 60.
403 double min = (d - int(d)) * 60.0;
404 if (min >= 59.9995) {
408 snprintf(buf, 32, "%d*%06.3f%c", int(d), fabs(min), c);
411 // mm'ss.s'' (DMS-Format) -- uses a round-off factor tailored to the
412 // required precision of the seconds field (one decimal place),
413 // preventing second values of 60.
414 double min = (d - int(d)) * 60.0;
415 double sec = (min - int(min)) * 60.0;
424 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d),
425 int(min), fabs(sec), c);
432 FGProperties::getLatitudeString ()
435 double d = _latDeg->getDoubleValue();
436 int format = _lonLatformat->getIntValue();
437 char c = d < 0.0 ? 'S' : 'N';
441 snprintf(buf, 32, "%3.6f%c", d, c);
443 } else if (format == 1) {
444 double min = (d - int(d)) * 60.0;
445 if (min >= 59.9995) {
449 snprintf(buf, 32, "%d*%06.3f%c", int(d), fabs(min), c);
452 double min = (d - int(d)) * 60.0;
453 double sec = (min - int(min)) * 60.0;
462 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d),
463 int(min), fabs(sec), c);
473 FGProperties::FGProperties ()
477 FGProperties::~FGProperties ()
482 FGProperties::init ()
487 FGProperties::bind ()
489 _longDeg = fgGetNode("/position/longitude-deg", true);
490 _latDeg = fgGetNode("/position/latitude-deg", true);
491 _lonLatformat = fgGetNode("/sim/lon-lat-format", true);
493 _offset = fgGetNode("/sim/time/local-offset", true);
496 _uyear = fgGetNode("/sim/time/utc/year", true);
497 _umonth = fgGetNode("/sim/time/utc/month", true);
498 _uday = fgGetNode("/sim/time/utc/day", true);
499 _uhour = fgGetNode("/sim/time/utc/hour", true);
500 _umin = fgGetNode("/sim/time/utc/minute", true);
501 _usec = fgGetNode("/sim/time/utc/second", true);
502 _uwday = fgGetNode("/sim/time/utc/weekday", true);
503 _udsec = fgGetNode("/sim/time/utc/day-seconds", true);
505 // real local date/time
506 _ryear = fgGetNode("/sim/time/real/year", true);
507 _rmonth = fgGetNode("/sim/time/real/month", true);
508 _rday = fgGetNode("/sim/time/real/day", true);
509 _rhour = fgGetNode("/sim/time/real/hour", true);
510 _rmin = fgGetNode("/sim/time/real/minute", true);
511 _rsec = fgGetNode("/sim/time/real/second", true);
512 _rwday = fgGetNode("/sim/time/real/weekday", true);
514 _tiedProperties.setRoot(globals->get_props());
517 _tiedProperties.Tie("/sim/logging/priority", getLoggingPriority, setLoggingPriority);
518 _tiedProperties.Tie("/sim/logging/classes", getLoggingClasses, setLoggingClasses);
519 _tiedProperties.Tie("/sim/freeze/master", getFreeze, setFreeze);
521 _tiedProperties.Tie("/sim/time/elapsed-sec", getElapsedTime_sec);
522 _tiedProperties.Tie("/sim/time/gmt", getDateString, setDateString);
523 fgSetArchivable("/sim/time/gmt");
524 _tiedProperties.Tie("/sim/time/gmt-string", getGMTString);
527 _tiedProperties.Tie("/position/latitude-string", getLatitudeString);
528 _tiedProperties.Tie("/position/longitude-string", getLongitudeString);
531 _tiedProperties.Tie("/orientation/heading-magnetic-deg", getHeadingMag);
532 _tiedProperties.Tie("/orientation/track-magnetic-deg", getTrackMag);
534 // Misc. Temporary junk.
535 _tiedProperties.Tie("/sim/temp/winding-ccw", getWindingCCW, setWindingCCW, false);
539 FGProperties::unbind ()
541 _tiedProperties.Untie();
543 // drop static references to properties
550 FGProperties::update (double dt)
552 _offset->setIntValue(globals->get_time_params()->get_local_offset());
555 struct tm *u = globals->get_time_params()->getGmt();
556 _uyear->setIntValue(u->tm_year + 1900);
557 _umonth->setIntValue(u->tm_mon + 1);
558 _uday->setIntValue(u->tm_mday);
559 _uhour->setIntValue(u->tm_hour);
560 _umin->setIntValue(u->tm_min);
561 _usec->setIntValue(u->tm_sec);
562 _uwday->setIntValue(u->tm_wday);
563 _udsec->setIntValue(u->tm_hour * 3600 + u->tm_min * 60 + u->tm_sec);
565 // real local date/time
566 time_t real = time(0);
567 struct tm *r = localtime(&real);
568 _ryear->setIntValue(r->tm_year + 1900);
569 _rmonth->setIntValue(r->tm_mon + 1);
570 _rday->setIntValue(r->tm_mday);
571 _rhour->setIntValue(r->tm_hour);
572 _rmin->setIntValue(r->tm_min);
573 _rsec->setIntValue(r->tm_sec);
574 _rwday->setIntValue(r->tm_wday);
579 ////////////////////////////////////////////////////////////////////////
581 ////////////////////////////////////////////////////////////////////////
585 * Save the current state of the simulator to a stream.
588 fgSaveFlight (std::ostream &output, bool write_all)
591 fgSetBool("/sim/presets/onground", false);
592 fgSetArchivable("/sim/presets/onground");
593 fgSetBool("/sim/presets/trim", false);
594 fgSetArchivable("/sim/presets/trim");
595 fgSetString("/sim/presets/speed-set", "UVW");
596 fgSetArchivable("/sim/presets/speed-set");
599 writeProperties(output, globals->get_props(), write_all);
600 } catch (const sg_exception &e) {
601 guiErrorMessage("Error saving flight: ", e);
609 * Restore the current state of the simulator from a stream.
612 fgLoadFlight (std::istream &input)
614 SGPropertyNode props;
616 readProperties(input, &props);
617 } catch (const sg_exception &e) {
618 guiErrorMessage("Error reading saved flight: ", e);
622 fgSetBool("/sim/presets/onground", false);
623 fgSetBool("/sim/presets/trim", false);
624 fgSetString("/sim/presets/speed-set", "UVW");
626 copyProperties(&props, globals->get_props());
633 fgLoadProps (const char * path, SGPropertyNode * props, bool in_fg_root, int default_mode)
637 SGPath loadpath(globals->get_fg_root());
638 loadpath.append(path);
639 fullpath = loadpath.str();
645 readProperties(fullpath, props, default_mode);
646 } catch (const sg_exception &e) {
647 guiErrorMessage("Error reading properties: ", e);
655 ////////////////////////////////////////////////////////////////////////
656 // Property convenience functions.
657 ////////////////////////////////////////////////////////////////////////
660 fgGetNode (const char * path, bool create)
662 return globals->get_props()->getNode(path, create);
666 fgGetNode (const char * path, int index, bool create)
668 return globals->get_props()->getNode(path, index, create);
672 fgHasNode (const char * path)
674 return (fgGetNode(path, false) != 0);
678 fgAddChangeListener (SGPropertyChangeListener * listener, const char * path)
680 fgGetNode(path, true)->addChangeListener(listener);
684 fgAddChangeListener (SGPropertyChangeListener * listener,
685 const char * path, int index)
687 fgGetNode(path, index, true)->addChangeListener(listener);
691 fgGetBool (const char * name, bool defaultValue)
693 return globals->get_props()->getBoolValue(name, defaultValue);
697 fgGetInt (const char * name, int defaultValue)
699 return globals->get_props()->getIntValue(name, defaultValue);
703 fgGetLong (const char * name, long defaultValue)
705 return globals->get_props()->getLongValue(name, defaultValue);
709 fgGetFloat (const char * name, float defaultValue)
711 return globals->get_props()->getFloatValue(name, defaultValue);
715 fgGetDouble (const char * name, double defaultValue)
717 return globals->get_props()->getDoubleValue(name, defaultValue);
721 fgGetString (const char * name, const char * defaultValue)
723 return globals->get_props()->getStringValue(name, defaultValue);
727 fgSetBool (const char * name, bool val)
729 return globals->get_props()->setBoolValue(name, val);
733 fgSetInt (const char * name, int val)
735 return globals->get_props()->setIntValue(name, val);
739 fgSetLong (const char * name, long val)
741 return globals->get_props()->setLongValue(name, val);
745 fgSetFloat (const char * name, float val)
747 return globals->get_props()->setFloatValue(name, val);
751 fgSetDouble (const char * name, double val)
753 return globals->get_props()->setDoubleValue(name, val);
757 fgSetString (const char * name, const char * val)
759 return globals->get_props()->setStringValue(name, val);
763 fgSetArchivable (const char * name, bool state)
765 SGPropertyNode * node = globals->get_props()->getNode(name);
767 SG_LOG(SG_GENERAL, SG_DEBUG,
768 "Attempt to set archive flag for non-existant property "
771 node->setAttribute(SGPropertyNode::ARCHIVE, state);
775 fgSetReadable (const char * name, bool state)
777 SGPropertyNode * node = globals->get_props()->getNode(name);
779 SG_LOG(SG_GENERAL, SG_DEBUG,
780 "Attempt to set read flag for non-existant property "
783 node->setAttribute(SGPropertyNode::READ, state);
787 fgSetWritable (const char * name, bool state)
789 SGPropertyNode * node = globals->get_props()->getNode(name);
791 SG_LOG(SG_GENERAL, SG_DEBUG,
792 "Attempt to set write flag for non-existant property "
795 node->setAttribute(SGPropertyNode::WRITE, state);
799 fgUntie(const char * name)
801 SGPropertyNode* node = globals->get_props()->getNode(name);
803 SG_LOG(SG_GENERAL, SG_WARN, "fgUntie: unknown property " << name);
807 if (!node->isTied()) {
811 if (!node->untie()) {
812 SG_LOG(SG_GENERAL, SG_WARN, "Failed to untie property " << name);
817 // end of fg_props.cxx