simgear/props/props_io.hxx

   1 /**
   2  * \file props_io.hxx
   3  * Interface definition for property list io.
   4  * Started Fall 2000 by David Megginson, david@megginson.com
   5  * This code is released into the Public Domain.
   6  *
   7  * See props.html for documentation [replace with URL when available].
   8  *
   9  * $Id$
  10  */
  11
  12 #ifndef __PROPS_IO_HXX
  13 #define __PROPS_IO_HXX
  14
  15 #include <simgear/compiler.h>
  16 #include <simgear/props/props.hxx>
  17
  18 #include <stdio.h>
  19
  20 #include <string>
  21 #include <vector>
  22 #include <map>
  23 #include <iosfwd>
  24
  25 /**
  26  * Read properties from an XML input stream.
  27  */
  28 void readProperties (std::istream &input, SGPropertyNode * start_node,
  29                      const std::string &base = "", int default_mode = 0,
  30                      bool extended = false);
  31
  32
  33 /**
  34  * Read properties from an XML file.
  35  */
  36 void readProperties (const std::string &file, SGPropertyNode * start_node,
  37                      int default_mode = 0, bool extended = false);
  38
  39
  40 /**
  41  * Read properties from an in-memory buffer.
  42  */
  43 void readProperties (const char *buf, const int size,
  44                      SGPropertyNode * start_node, int default_mode = 0,
  45                      bool extended = false);
  46
  47
  48 /**
  49  * Write properties to an XML output stream.
  50  */
  51 void writeProperties (std::ostream &output, const SGPropertyNode * start_node,
  52                       bool write_all = false,
  53                       SGPropertyNode::Attribute archive_flag = SGPropertyNode::ARCHIVE);
  54
  55
  56 /**
  57  * Write properties to an XML file.
  58  */
  59 void writeProperties (const std::string &file,
  60                       const SGPropertyNode * start_node,
  61                       bool write_all = false,
  62                       SGPropertyNode::Attribute archive_flag = SGPropertyNode::ARCHIVE);
  63
  64
  65 /**
  66  * Copy properties from one node to another.
  67  */
  68 bool copyProperties (const SGPropertyNode *in, SGPropertyNode *out);
  69
  70
  71 #endif // __PROPS_IO_HXX
  72
  73 // end of props_io.hxx