#ifndef __FG_PROPS_HXX
#define __FG_PROPS_HXX 1
-#include <simgear/debug/logstream.hxx>
-#include <simgear/misc/props.hxx>
-#include "globals.hxx"
+#include <iosfwd>
+
+#include <simgear/structure/subsystem_mgr.hxx>
+#include <simgear/math/SGMath.hxx>
+
+#include <Main/globals.hxx>
-\f
////////////////////////////////////////////////////////////////////////
// Property management.
////////////////////////////////////////////////////////////////////////
+class FGProperties : public SGSubsystem
+{
+public:
+ FGProperties ();
+ virtual ~FGProperties ();
-/**
- * Initialize the default FlightGear properties.
- *
- * These are mostly properties that haven't been claimed by a
- * specific module yet. This function should be invoked once,
- * while the program is starting (and after the global property
- * tree has been created).
- */
-extern void fgInitProps (); // fixme: how are they untied?
-
-
-/**
- * Update the default FlightGear properties.
- *
- * This function should be invoked once in each loop to update all
- * of the default properties.
- */
-extern void fgUpdateProps ();
+ void init ();
+ void bind ();
+ void unbind ();
+ void update (double dt);
+};
/**
* so that the current flight can be restored later.
*
* @param output The output stream to write the XML save file to.
+ * @param write_all If true, write all properties rather than
+ * just the ones flagged as archivable.
* @return true if the flight was saved successfully.
*/
-extern bool fgSaveFlight (ostream &output);
+extern bool fgSaveFlight (std::ostream &output, bool write_all = false);
/**
* @param input The input stream to read the XML from.
* @return true if the flight was restored successfully.
*/
-extern bool fgLoadFlight (istream &input);
+extern bool fgLoadFlight (std::istream &input);
+
+
+/**
+ * Load properties from a file.
+ *
+ * @param file The relative or absolute filename.
+ * @param props The property node to load the properties into.
+ * @param in_fg_root If true, look for the file relative to
+ * $FG_ROOT; otherwise, look for the file relative to the
+ * current working directory.
+ * @return true if the properties loaded successfully, false
+ * otherwise.
+ */
+extern bool fgLoadProps (const char * path, SGPropertyNode * props,
+ bool in_fg_root = true, int default_mode = 0);
\f
// Convenience functions for getting property values.
////////////////////////////////////////////////////////////////////////
-
/**
* Get a property node.
*
* @param create true to create the node if it doesn't exist.
* @return The node, or 0 if none exists and none was created.
*/
-inline SGPropertyNode *
-fgGetNode (const string &path, bool create = false)
-{
- return globals->get_props()->getNode(path, create);
-}
+extern SGPropertyNode * fgGetNode (const char * path, bool create = false);
+
+
+/**
+ * Get a property node with separate index.
+ *
+ * This method separates the index from the path string, to make it
+ * easier to iterate through multiple components without using sprintf
+ * to add indices. For example, fgGetNode("foo[1]/bar", 3) will
+ * return the same result as fgGetNode("foo[1]/bar[3]").
+ *
+ * @param path The path of the node, relative to root.
+ * @param index The index for the last member of the path (overrides
+ * any given in the string).
+ * @param create true to create the node if it doesn't exist.
+ * @return The node, or 0 if none exists and none was created.
+ */
+extern SGPropertyNode * fgGetNode (const char * path,
+ int index, bool create = false);
/**
* @param path The path of the node, relative to root.
* @return true if the node exists, false otherwise.
*/
-inline bool
-fgHasNode (const string &path)
-{
- return (fgGetNode(path, false) != 0);
-}
+extern bool fgHasNode (const char * path);
+
+
+/**
+ * Add a listener to a node.
+ *
+ * @param listener The listener to add to the node.
+ * @param path The path of the node, relative to root.
+ * @param index The index for the last member of the path (overrides
+ * any given in the string).
+ */
+extern void fgAddChangeListener (SGPropertyChangeListener * listener,
+ const char * path);
+
+
+/**
+ * Add a listener to a node.
+ *
+ * @param listener The listener to add to the node.
+ * @param path The path of the node, relative to root.
+ * @param index The index for the last member of the path (overrides
+ * any given in the string).
+ */
+extern void fgAddChangeListener (SGPropertyChangeListener * listener,
+ const char * path, int index);
/**
* does not exist.
* @return The property's value as a bool, or the default value provided.
*/
-inline bool fgGetBool (const string &name, bool defaultValue = false)
-{
- return globals->get_props()->getBoolValue(name, defaultValue);
-}
+extern bool fgGetBool (const char * name, bool defaultValue = false);
/**
* does not exist.
* @return The property's value as an int, or the default value provided.
*/
-inline int fgGetInt (const string &name, int defaultValue = 0)
-{
- return globals->get_props()->getIntValue(name, defaultValue);
-}
+extern int fgGetInt (const char * name, int defaultValue = 0);
/**
* does not exist.
* @return The property's value as a long, or the default value provided.
*/
-inline int fgGetLong (const string &name, long defaultValue = 0L)
-{
- return globals->get_props()->getLongValue(name, defaultValue);
-}
+extern int fgGetLong (const char * name, long defaultValue = 0L);
/**
* does not exist.
* @return The property's value as a float, or the default value provided.
*/
-inline float fgGetFloat (const string &name, float defaultValue = 0.0)
-{
- return globals->get_props()->getFloatValue(name, defaultValue);
-}
+extern float fgGetFloat (const char * name, float defaultValue = 0.0);
/**
* does not exist.
* @return The property's value as a double, or the default value provided.
*/
-inline double fgGetDouble (const string &name, double defaultValue = 0.0)
-{
- return globals->get_props()->getDoubleValue(name, defaultValue);
-}
+extern double fgGetDouble (const char * name, double defaultValue = 0.0);
/**
* does not exist.
* @return The property's value as a string, or the default value provided.
*/
-inline string fgGetString (const string &name, string defaultValue = "")
-{
- return globals->get_props()->getStringValue(name, defaultValue);
-}
+extern const char * fgGetString (const char * name,
+ const char * defaultValue = "");
/**
* @param val The new value for the property.
* @return true if the assignment succeeded, false otherwise.
*/
-inline bool fgSetBool (const string &name, bool val)
-{
- return globals->get_props()->setBoolValue(name, val);
-}
+extern bool fgSetBool (const char * name, bool val);
/**
* @param val The new value for the property.
* @return true if the assignment succeeded, false otherwise.
*/
-inline bool fgSetInt (const string &name, int val)
-{
- return globals->get_props()->setIntValue(name, val);
-}
+extern bool fgSetInt (const char * name, int val);
/**
* @param val The new value for the property.
* @return true if the assignment succeeded, false otherwise.
*/
-inline bool fgSetLong (const string &name, long val)
-{
- return globals->get_props()->setLongValue(name, val);
-}
+extern bool fgSetLong (const char * name, long val);
/**
* @param val The new value for the property.
* @return true if the assignment succeeded, false otherwise.
*/
-inline bool fgSetFloat (const string &name, float val)
-{
- return globals->get_props()->setFloatValue(name, val);
-}
+extern bool fgSetFloat (const char * name, float val);
/**
* @param val The new value for the property.
* @return true if the assignment succeeded, false otherwise.
*/
-inline bool fgSetDouble (const string &name, double val)
-{
- return globals->get_props()->setDoubleValue(name, val);
-}
+extern bool fgSetDouble (const char * name, double val);
/**
* @param val The new value for the property.
* @return true if the assignment succeeded, false otherwise.
*/
-inline bool fgSetString (const string &name, const string &val)
-{
- return globals->get_props()->setStringValue(name, val);
-}
+extern bool fgSetString (const char * name, const char * val);
\f
* @param name The property name.
* @param state The state of the archive attribute (defaults to true).
*/
-inline void
-fgSetArchivable (const string &name, bool state = true)
-{
- SGPropertyNode * node = globals->get_props()->getNode(name);
- if (node == 0)
- SG_LOG(SG_GENERAL, SG_ALERT,
- "Attempt to set archive flag for non-existant property "
- << name);
- else
- node->setAttribute(SGPropertyNode::ARCHIVE, state);
-}
+extern void fgSetArchivable (const char * name, bool state = true);
/**
* @param name The property name.
* @param state The state of the read attribute (defaults to true).
*/
-inline void
-fgSetReadable (const string &name, bool state = true)
-{
- SGPropertyNode * node = globals->get_props()->getNode(name);
- if (node == 0)
- SG_LOG(SG_GENERAL, SG_ALERT,
- "Attempt to set read flag for non-existant property "
- << name);
- else
- node->setAttribute(SGPropertyNode::READ, state);
-}
+extern void fgSetReadable (const char * name, bool state = true);
/**
* @param name The property name.
* @param state The state of the write attribute (defaults to true).
*/
-inline void
-fgSetWritable (const string &name, bool state = true)
-{
- SGPropertyNode * node = globals->get_props()->getNode(name);
- if (node == 0)
- SG_LOG(SG_GENERAL, SG_ALERT,
- "Attempt to set write flag for non-existant property "
- << name);
- else
- node->setAttribute(SGPropertyNode::WRITE, state);
-}
+extern void fgSetWritable (const char * name, bool state = true);
\f
* Classes should use this function to release control of any
* properties they are managing.
*/
-inline void
-fgUntie (const string &name)
-{
- if (!globals->get_props()->untie(name))
- SG_LOG(SG_GENERAL, SG_WARN, "Failed to untie property " << name);
-}
-
-
- // Templates cause ambiguity here
-
-/**
- * Tie a property to an external bool variable.
- *
- * The property's value will automatically mirror the variable's
- * value, and vice-versa, until the property is untied.
- *
- * @param name The property name to tie (full path).
- * @param pointer A pointer to the variable.
- * @param useDefault true if any existing property value should be
- * copied to the variable; false if the variable should not
- * be modified; defaults to true.
- */
-inline void
-fgTie (const string &name, bool *pointer, bool useDefault = true)
-{
- if (!globals->get_props()->tie(name, SGRawValuePointer<bool>(pointer),
- useDefault))
- SG_LOG(SG_GENERAL, SG_WARN,
- "Failed to tie property " << name << " to a pointer");
-}
-
-
-/**
- * Tie a property to an external int variable.
- *
- * The property's value will automatically mirror the variable's
- * value, and vice-versa, until the property is untied.
- *
- * @param name The property name to tie (full path).
- * @param pointer A pointer to the variable.
- * @param useDefault true if any existing property value should be
- * copied to the variable; false if the variable should not
- * be modified; defaults to true.
- */
-inline void
-fgTie (const string &name, int *pointer, bool useDefault = true)
-{
- if (!globals->get_props()->tie(name, SGRawValuePointer<int>(pointer),
- useDefault))
- SG_LOG(SG_GENERAL, SG_WARN,
- "Failed to tie property " << name << " to a pointer");
-}
-
-
-/**
- * Tie a property to an external long variable.
- *
- * The property's value will automatically mirror the variable's
- * value, and vice-versa, until the property is untied.
- *
- * @param name The property name to tie (full path).
- * @param pointer A pointer to the variable.
- * @param useDefault true if any existing property value should be
- * copied to the variable; false if the variable should not
- * be modified; defaults to true.
- */
-inline void
-fgTie (const string &name, long *pointer, bool useDefault = true)
-{
- if (!globals->get_props()->tie(name, SGRawValuePointer<long>(pointer),
- useDefault))
- SG_LOG(SG_GENERAL, SG_WARN,
- "Failed to tie property " << name << " to a pointer");
-}
-
-
-/**
- * Tie a property to an external float variable.
- *
- * The property's value will automatically mirror the variable's
- * value, and vice-versa, until the property is untied.
- *
- * @param name The property name to tie (full path).
- * @param pointer A pointer to the variable.
- * @param useDefault true if any existing property value should be
- * copied to the variable; false if the variable should not
- * be modified; defaults to true.
- */
-inline void
-fgTie (const string &name, float *pointer, bool useDefault = true)
-{
- if (!globals->get_props()->tie(name, SGRawValuePointer<float>(pointer),
- useDefault))
- SG_LOG(SG_GENERAL, SG_WARN,
- "Failed to tie property " << name << " to a pointer");
-}
-
-
-/**
- * Tie a property to an external double variable.
- *
- * The property's value will automatically mirror the variable's
- * value, and vice-versa, until the property is untied.
- *
- * @param name The property name to tie (full path).
- * @param pointer A pointer to the variable.
- * @param useDefault true if any existing property value should be
- * copied to the variable; false if the variable should not
- * be modified; defaults to true.
- */
-inline void
-fgTie (const string &name, double *pointer, bool useDefault = true)
-{
- if (!globals->get_props()->tie(name, SGRawValuePointer<double>(pointer),
- useDefault))
- SG_LOG(SG_GENERAL, SG_WARN,
- "Failed to tie property " << name << " to a pointer");
-}
-
-
-/**
- * Tie a property to an external string variable.
- *
- * The property's value will automatically mirror the variable's
- * value, and vice-versa, until the property is untied.
- *
- * @param name The property name to tie (full path).
- * @param pointer A pointer to the variable.
- * @param useDefault true if any existing property value should be
- * copied to the variable; false if the variable should not
- * be modified; defaults to true.
- */
-inline void
-fgTie (const string &name, string *pointer, bool useDefault = true)
-{
- if (!globals->get_props()->tie(name, SGRawValuePointer<string>(pointer),
- useDefault))
- SG_LOG(SG_GENERAL, SG_WARN,
- "Failed to tie property " << name << " to a pointer");
-}
+extern void fgUntie (const char * name);
/**
*/
template <class V>
inline void
-fgTie (const string &name, V (*getter)(), void (*setter)(V) = 0,
+fgTie (const char * name, V (*getter)(), void (*setter)(V) = 0,
bool useDefault = true)
{
if (!globals->get_props()->tie(name, SGRawValueFunctions<V>(getter, setter),
*/
template <class V>
inline void
-fgTie (const string &name, int index, V (*getter)(int),
+fgTie (const char * name, int index, V (*getter)(int),
void (*setter)(int, V) = 0, bool useDefault = true)
{
if (!globals->get_props()->tie(name,
*/
template <class T, class V>
inline void
-fgTie (const string &name, T * obj, V (T::*getter)() const,
+fgTie (const char * name, T * obj, V (T::*getter)() const,
void (T::*setter)(V) = 0, bool useDefault = true)
{
if (!globals->get_props()->tie(name,
*/
template <class T, class V>
inline void
-fgTie (const string &name, T * obj, int index,
+fgTie (const char * name, T * obj, int index,
V (T::*getter)(int) const, void (T::*setter)(int, V) = 0,
bool useDefault = true)
{
}
+class FGMakeUpperCase : public SGPropertyChangeListener {
+public:
+ void valueChanged(SGPropertyNode *node) {
+ if (node->getType() != simgear::props::STRING)
+ return;
+
+ char *s = const_cast<char *>(node->getStringValue());
+ for (; *s; s++)
+ *s = toupper(*s);
+ }
+};
+
+
#endif // __FG_PROPS_HXX
projects / flightgear.git / blobdiff