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/magvar/magvar.hxx>
32 #include <simgear/timing/sg_time.hxx>
33 #include <simgear/misc/sg_path.hxx>
34 #include <simgear/scene/model/particles.hxx>
35 #include <simgear/sound/soundmgr_openal.hxx>
39 #include "globals.hxx"
40 #include "fg_props.hxx"
43 static bool winding_ccw = true; // FIXME: temporary
45 static bool frozen = false; // FIXME: temporary
49 ////////////////////////////////////////////////////////////////////////
50 // Default property bindings (not yet handled by any module).
51 ////////////////////////////////////////////////////////////////////////
53 struct LogClassMapping {
56 LogClassMapping(sgDebugClass cc, string nname) { c = cc; name = nname; }
59 LogClassMapping log_class_mappings [] = {
60 LogClassMapping(SG_NONE, "none"),
61 LogClassMapping(SG_TERRAIN, "terrain"),
62 LogClassMapping(SG_ASTRO, "astro"),
63 LogClassMapping(SG_FLIGHT, "flight"),
64 LogClassMapping(SG_INPUT, "input"),
65 LogClassMapping(SG_GL, "gl"),
66 LogClassMapping(SG_VIEW, "view"),
67 LogClassMapping(SG_COCKPIT, "cockpit"),
68 LogClassMapping(SG_GENERAL, "general"),
69 LogClassMapping(SG_MATH, "math"),
70 LogClassMapping(SG_EVENT, "event"),
71 LogClassMapping(SG_AIRCRAFT, "aircraft"),
72 LogClassMapping(SG_AUTOPILOT, "autopilot"),
73 LogClassMapping(SG_IO, "io"),
74 LogClassMapping(SG_CLIPPER, "clipper"),
75 LogClassMapping(SG_NETWORK, "network"),
76 LogClassMapping(SG_INSTR, "instrumentation"),
77 LogClassMapping(SG_ATC, "atc"),
78 LogClassMapping(SG_NASAL, "nasal"),
79 LogClassMapping(SG_SYSTEMS, "systems"),
80 LogClassMapping(SG_AI, "ai"),
81 LogClassMapping(SG_ENVIRONMENT, "environment"),
82 LogClassMapping(SG_SOUND, "sound"),
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 = logbuf::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 = logbuf::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 logbuf::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 logbuf::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 logbuf::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 (logbuf::get_log_priority()) {
185 SG_LOG(SG_GENERAL, SG_WARN, "Internal: Unknown logging priority number: "
186 << logbuf::get_log_priority());
193 * Set the logging priority.
196 setLoggingPriority (const char * p)
201 if (priority == "bulk") {
202 logbuf::set_log_priority(SG_BULK);
203 } else if (priority == "debug") {
204 logbuf::set_log_priority(SG_DEBUG);
205 } else if (priority.empty() || priority == "info") { // default
206 logbuf::set_log_priority(SG_INFO);
207 } else if (priority == "warn") {
208 logbuf::set_log_priority(SG_WARN);
209 } else if (priority == "alert") {
210 logbuf::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 magnetic variation
348 return globals->get_mag()->get_magvar() * SGD_RADIANS_TO_DEGREES;
353 * Return the magnetic dip
358 return globals->get_mag()->get_magdip() * SGD_RADIANS_TO_DEGREES;
363 * Return the current heading in degrees.
368 double magheading = fgGetDouble("/orientation/heading-deg") - getMagVar();
369 return SGMiscd::normalizePeriodic(0, 360, magheading );
373 * Return the current track in degrees.
378 double magtrack = fgGetDouble("/orientation/track-deg") - getMagVar();
379 return SGMiscd::normalizePeriodic(0, 360, magtrack );
389 setWindingCCW (bool state)
393 glFrontFace ( GL_CCW );
395 glFrontFace ( GL_CW );
399 getLongitudeString ()
401 static SGConstPropertyNode_ptr n = fgGetNode("/position/longitude-deg", true);
402 static SGConstPropertyNode_ptr f = fgGetNode("/sim/lon-lat-format", true);
404 double d = n->getDoubleValue();
405 int format = f->getIntValue();
406 char c = d < 0.0 ? 'W' : 'E';
409 snprintf(buf, 32, "%3.6f%c", d, c);
411 } else if (format == 1) {
412 // dd mm.mmm' (DMM-Format) -- uses a round-off factor tailored to the
413 // required precision of the minutes field (three decimal places),
414 // preventing minute values of 60.
415 double deg = fabs(d) + 5.0E-4 / 60.0;
416 double min = fabs(deg - int(deg)) * 60.0 - 4.999E-4;
417 snprintf(buf, 32, "%d*%06.3f%c", int(d < 0.0 ? -deg : deg), min, c);
420 // mm'ss.s'' (DMS-Format) -- uses a round-off factor tailored to the
421 // required precision of the seconds field (one decimal place),
422 // preventing second values of 60.
423 double deg = fabs(d) + 0.05 / 3600.0;
424 double min = (deg - int(deg)) * 60.0;
425 double sec = (min - int(min)) * 60.0 - 0.049;
426 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d < 0.0 ? -deg : deg),
427 int(min), fabs(sec), c);
436 static SGConstPropertyNode_ptr n = fgGetNode("/position/latitude-deg", true);
437 static SGConstPropertyNode_ptr f = fgGetNode("/sim/lon-lat-format", true);
439 double d = n->getDoubleValue();
440 int format = f->getIntValue();
441 char c = d < 0.0 ? 'S' : 'N';
444 snprintf(buf, 32, "%3.6f%c", d, c);
446 } else if (format == 1) {
447 double deg = fabs(d) + 5.0E-4 / 60.0;
448 double min = fabs(deg - int(deg)) * 60.0 - 4.999E-4;
449 snprintf(buf, 32, "%d*%06.3f%c", int(d < 0.0 ? -deg : deg), min, c);
452 double deg = fabs(d) + 0.05 / 3600.0;
453 double min = (deg - int(deg)) * 60.0;
454 double sec = (min - int(min)) * 60.0 - 0.049;
455 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d < 0.0 ? -deg : deg),
456 int(min), fabs(sec), c);
465 ////////////////////////////////////////////////////////////////////////
466 // Tie the properties.
467 ////////////////////////////////////////////////////////////////////////
469 FGProperties::FGProperties ()
473 FGProperties::~FGProperties ()
478 FGProperties::init ()
483 FGProperties::bind ()
485 _tiedProperties.setRoot(globals->get_props());
488 _tiedProperties.Tie("/sim/logging/priority", getLoggingPriority, setLoggingPriority);
489 _tiedProperties.Tie("/sim/logging/classes", getLoggingClasses, setLoggingClasses);
490 _tiedProperties.Tie("/sim/freeze/master", getFreeze, setFreeze);
492 _tiedProperties.Tie("/sim/time/elapsed-sec", getElapsedTime_sec);
493 _tiedProperties.Tie("/sim/time/gmt", getDateString, setDateString);
494 fgSetArchivable("/sim/time/gmt");
495 _tiedProperties.Tie("/sim/time/gmt-string", getGMTString);
498 _tiedProperties.Tie("/position/latitude-string", getLatitudeString);
499 _tiedProperties.Tie("/position/longitude-string", getLongitudeString);
502 _tiedProperties.Tie("/orientation/heading-magnetic-deg", getHeadingMag);
503 _tiedProperties.Tie("/orientation/track-magnetic-deg", getTrackMag);
505 _tiedProperties.Tie("/environment/magnetic-variation-deg", getMagVar);
506 _tiedProperties.Tie("/environment/magnetic-dip-deg", getMagDip);
508 // Misc. Temporary junk.
509 _tiedProperties.Tie("/sim/temp/winding-ccw", getWindingCCW, setWindingCCW, false);
513 FGProperties::unbind ()
515 _tiedProperties.Untie();
519 FGProperties::update (double dt)
521 static SGPropertyNode_ptr offset = fgGetNode("/sim/time/local-offset", true);
522 offset->setIntValue(globals->get_time_params()->get_local_offset());
525 static SGPropertyNode_ptr uyear = fgGetNode("/sim/time/utc/year", true);
526 static SGPropertyNode_ptr umonth = fgGetNode("/sim/time/utc/month", true);
527 static SGPropertyNode_ptr uday = fgGetNode("/sim/time/utc/day", true);
528 static SGPropertyNode_ptr uhour = fgGetNode("/sim/time/utc/hour", true);
529 static SGPropertyNode_ptr umin = fgGetNode("/sim/time/utc/minute", true);
530 static SGPropertyNode_ptr usec = fgGetNode("/sim/time/utc/second", true);
531 static SGPropertyNode_ptr uwday = fgGetNode("/sim/time/utc/weekday", true);
532 static SGPropertyNode_ptr udsec = fgGetNode("/sim/time/utc/day-seconds", true);
534 struct tm *u = globals->get_time_params()->getGmt();
535 uyear->setIntValue(u->tm_year + 1900);
536 umonth->setIntValue(u->tm_mon + 1);
537 uday->setIntValue(u->tm_mday);
538 uhour->setIntValue(u->tm_hour);
539 umin->setIntValue(u->tm_min);
540 usec->setIntValue(u->tm_sec);
541 uwday->setIntValue(u->tm_wday);
543 udsec->setIntValue(u->tm_hour * 3600 + u->tm_min * 60 + u->tm_sec);
546 // real local date/time
547 static SGPropertyNode_ptr ryear = fgGetNode("/sim/time/real/year", true);
548 static SGPropertyNode_ptr rmonth = fgGetNode("/sim/time/real/month", true);
549 static SGPropertyNode_ptr rday = fgGetNode("/sim/time/real/day", true);
550 static SGPropertyNode_ptr rhour = fgGetNode("/sim/time/real/hour", true);
551 static SGPropertyNode_ptr rmin = fgGetNode("/sim/time/real/minute", true);
552 static SGPropertyNode_ptr rsec = fgGetNode("/sim/time/real/second", true);
553 static SGPropertyNode_ptr rwday = fgGetNode("/sim/time/real/weekday", true);
555 time_t real = time(0);
556 struct tm *r = localtime(&real);
557 ryear->setIntValue(r->tm_year + 1900);
558 rmonth->setIntValue(r->tm_mon + 1);
559 rday->setIntValue(r->tm_mday);
560 rhour->setIntValue(r->tm_hour);
561 rmin->setIntValue(r->tm_min);
562 rsec->setIntValue(r->tm_sec);
563 rwday->setIntValue(r->tm_wday);
568 ////////////////////////////////////////////////////////////////////////
570 ////////////////////////////////////////////////////////////////////////
574 * Save the current state of the simulator to a stream.
577 fgSaveFlight (std::ostream &output, bool write_all)
580 fgSetBool("/sim/presets/onground", false);
581 fgSetArchivable("/sim/presets/onground");
582 fgSetBool("/sim/presets/trim", false);
583 fgSetArchivable("/sim/presets/trim");
584 fgSetString("/sim/presets/speed-set", "UVW");
585 fgSetArchivable("/sim/presets/speed-set");
588 writeProperties(output, globals->get_props(), write_all);
589 } catch (const sg_exception &e) {
590 guiErrorMessage("Error saving flight: ", e);
598 * Restore the current state of the simulator from a stream.
601 fgLoadFlight (std::istream &input)
603 SGPropertyNode props;
605 readProperties(input, &props);
606 } catch (const sg_exception &e) {
607 guiErrorMessage("Error reading saved flight: ", e);
611 fgSetBool("/sim/presets/onground", false);
612 fgSetBool("/sim/presets/trim", false);
613 fgSetString("/sim/presets/speed-set", "UVW");
615 copyProperties(&props, globals->get_props());
616 // When loading a flight, make it the
617 // new initial state.
618 globals->saveInitialState();
624 fgLoadProps (const char * path, SGPropertyNode * props, bool in_fg_root, int default_mode)
628 SGPath loadpath(globals->get_fg_root());
629 loadpath.append(path);
630 fullpath = loadpath.str();
636 readProperties(fullpath, props, default_mode);
637 } catch (const sg_exception &e) {
638 guiErrorMessage("Error reading properties: ", e);
646 ////////////////////////////////////////////////////////////////////////
647 // Property convenience functions.
648 ////////////////////////////////////////////////////////////////////////
651 fgGetNode (const char * path, bool create)
653 return globals->get_props()->getNode(path, create);
657 fgGetNode (const char * path, int index, bool create)
659 return globals->get_props()->getNode(path, index, create);
663 fgHasNode (const char * path)
665 return (fgGetNode(path, false) != 0);
669 fgAddChangeListener (SGPropertyChangeListener * listener, const char * path)
671 fgGetNode(path, true)->addChangeListener(listener);
675 fgAddChangeListener (SGPropertyChangeListener * listener,
676 const char * path, int index)
678 fgGetNode(path, index, true)->addChangeListener(listener);
682 fgGetBool (const char * name, bool defaultValue)
684 return globals->get_props()->getBoolValue(name, defaultValue);
688 fgGetInt (const char * name, int defaultValue)
690 return globals->get_props()->getIntValue(name, defaultValue);
694 fgGetLong (const char * name, long defaultValue)
696 return globals->get_props()->getLongValue(name, defaultValue);
700 fgGetFloat (const char * name, float defaultValue)
702 return globals->get_props()->getFloatValue(name, defaultValue);
706 fgGetDouble (const char * name, double defaultValue)
708 return globals->get_props()->getDoubleValue(name, defaultValue);
712 fgGetString (const char * name, const char * defaultValue)
714 return globals->get_props()->getStringValue(name, defaultValue);
718 fgSetBool (const char * name, bool val)
720 return globals->get_props()->setBoolValue(name, val);
724 fgSetInt (const char * name, int val)
726 return globals->get_props()->setIntValue(name, val);
730 fgSetLong (const char * name, long val)
732 return globals->get_props()->setLongValue(name, val);
736 fgSetFloat (const char * name, float val)
738 return globals->get_props()->setFloatValue(name, val);
742 fgSetDouble (const char * name, double val)
744 return globals->get_props()->setDoubleValue(name, val);
748 fgSetString (const char * name, const char * val)
750 return globals->get_props()->setStringValue(name, val);
754 fgSetArchivable (const char * name, bool state)
756 SGPropertyNode * node = globals->get_props()->getNode(name);
758 SG_LOG(SG_GENERAL, SG_DEBUG,
759 "Attempt to set archive flag for non-existant property "
762 node->setAttribute(SGPropertyNode::ARCHIVE, state);
766 fgSetReadable (const char * name, bool state)
768 SGPropertyNode * node = globals->get_props()->getNode(name);
770 SG_LOG(SG_GENERAL, SG_DEBUG,
771 "Attempt to set read flag for non-existant property "
774 node->setAttribute(SGPropertyNode::READ, state);
778 fgSetWritable (const char * name, bool state)
780 SGPropertyNode * node = globals->get_props()->getNode(name);
782 SG_LOG(SG_GENERAL, SG_DEBUG,
783 "Attempt to set write flag for non-existant property "
786 node->setAttribute(SGPropertyNode::WRITE, state);
790 fgUntie(const char * name)
792 SGPropertyNode* node = globals->get_props()->getNode(name);
794 SG_LOG(SG_GENERAL, SG_WARN, "fgUntie: unknown property " << name);
798 if (!node->isTied()) {
802 if (!node->untie()) {
803 SG_LOG(SG_GENERAL, SG_WARN, "Failed to untie property " << name);
808 // end of fg_props.cxx