XMLLoadSave Class Reference
#include <XMLLoadSave.h>
Inheritance diagram for XMLLoadSave:
Detailed Description
XMLLoadSave adds functions for XML format serialization, although if you write binary LoadSave functions as well, you can do either.
Definition at line 20 of file XMLLoadSave.h.
Public Member Functions | |
| XMLLoadSave () | |
| constructor | |
| XMLLoadSave (const XMLLoadSave &xls) | |
| copy constructor | |
| XMLLoadSave & | operator= (const XMLLoadSave &xls) |
| assignment operator | |
| virtual | ~XMLLoadSave () |
| destructor | |
| virtual void | loadXML (xmlNode *node)=0 |
| This is called when the subclass needs to update its values from those values in the parse tree. | |
| virtual void | saveXML (xmlNode *node) const =0 |
| This is called when XMLLoadSave needs to have the subclass update values in the tree currently in memory -- may already be filled out by previous contents. | |
| virtual unsigned int | getBinSize () const |
| Calculates space needed to save - if you can't precisely add up the size, just make sure to overestimate and things will still work. | |
| virtual unsigned int | loadBuffer (const char buf[], unsigned int len) |
| Load from a saved buffer in memory. | |
| virtual unsigned int | saveBuffer (char buf[], unsigned int len) const |
| Save to a given buffer in memory. | |
| virtual unsigned int | loadFile (const char *filename) |
| initiate opening of the specified file and loading/saving of all appropriate information. | |
| virtual unsigned int | saveFile (const char *filename) const |
| initiate opening of the specified file and loading/saving of all appropriate information. | |
| virtual unsigned int | loadFileStream (FILE *f) |
| Used recursively on member objects once a file is already open - DON'T CLOSE the file in your overridden functions. | |
| virtual unsigned int | saveFileStream (FILE *f) const |
| Used recursively on member objects once a file is already open - DON'T CLOSE the file in your overridden functions. | |
| virtual void | clearParseTree () |
| resets the parse tree currently in memory so that a future save will write a "fresh" copy from scratch. | |
| virtual void | setParseTree (xmlDoc *doc) const |
| assigns a parse tree which you have obtained from some other source | |
| virtual xmlDoc * | getParseTree () const |
| returns the current parse tree, either from a previous Load, Save, or setParseTree() | |
| virtual void | readParseTree () |
| calls loadXML with the root of the current parse tree | |
| virtual void | writeParseTree () |
| calls saveXML with the root of the current parse tree | |
| virtual void | setCompression (int level) |
| allows you to set the compression level used by libxml2 -- this corresponds to the compression level setting of zlib, i.e. 0-9 | |
| virtual int | getCompression () const |
| returns the current compression level setting used by libxml2 (via zlib) | |
Protected Member Functions | |
| virtual xmlNode * | FindRootXMLElement (xmlDoc *doc) const |
| returns the root element of the xml document | |
| void | reportError (const std::string &context, const bad_format &err) const |
| cleans up after an error occurs and sends a message to cerr | |
Static Protected Member Functions | |
| static int | fileReadCallback (void *f, char *buf, int len) |
| called by libxml2 when it's ready for more data to be read from the source (in this case, a file) | |
| static int | fileCloseCallback (void *f) |
| called by libxml2 when it's done reading data | |
| static xmlNode * | skipToElement (xmlNode *cur) |
| returns the next element following cur | |
| static xmlNode * | skipToElement (xmlNode *cur, std::string &comment) |
| returns the next element following cur; comment is set to the concatination of any comments is encountered in the interim | |
Protected Attributes | |
| xmlDoc * | xmldocument |
| the cached xml parse tree -- contains additional formatting information such as white space and comments | |
| int | compressionLevel |
| the current compression level, or level to be used for the next save | |
| bool | autoFormat |
| if true, the saved document will use automatic indenting and formatting | |
| XMLLoadSave::AutoInit | libxmlInit |
| allows automatic (de)initialization of libxml when the first or last XMLLoadSave class is created or destroyed allows tracking of libxml usage so the library can be initialized and destructed automatically | |
Classes | |
| class | AutoInit |
| allows automatic (de)initialization of libxml when the first or last XMLLoadSave class is created or destroyed More... | |
| class | bad_format |
| an exception to be thrown when a bad XML file is parsed, allows file position information to be passed to the user More... | |
Member Function Documentation
| void XMLLoadSave::clearParseTree | ( | ) | [virtual] |
resets the parse tree currently in memory so that a future save will write a "fresh" copy from scratch.
You may also want to call this in order to save memory after a Load so that the parse tree information isn't retained in memory if you don't care about retaining the file formatting
Definition at line 266 of file XMLLoadSave.cc.
Referenced by operator=(), and ~XMLLoadSave().
| unsigned int XMLLoadSave::getBinSize | ( | ) | const [virtual] |
Calculates space needed to save - if you can't precisely add up the size, just make sure to overestimate and things will still work.
getBinSize is used for reserving buffers during serialization, but does not necessarily determine the actual size of what is written -- the return value of saveBuffer() specifies that after the data actually has been written. If getBinSize overestimates, the extra memory allocation is only temporary, no extra filler bytes are actually stored.
- Returns:
- number of bytes read/written, 0 if error (or empty)
Implements LoadSave.
Reimplemented in EventBase, LocomotionEvent, LookoutPointAtEvent, LookoutIREvent, PitchEvent, TextMsgEvent, TimerEvent, and VisionObjectEvent.
Definition at line 64 of file XMLLoadSave.cc.
Referenced by EventBase::getBinSize().
| unsigned int XMLLoadSave::loadBuffer | ( | const char | buf[], | |
| unsigned int | len | |||
| ) | [virtual] |
Load from a saved buffer in memory.
- Parameters:
-
buf pointer to the memory where you should begin loading len length of buf available (this isn't necessarily all yours, there might be other things following your data)
- Returns:
- the number of bytes actually used
Implements LoadSave.
Reimplemented in EventBase, and Config.
Definition at line 82 of file XMLLoadSave.cc.
Referenced by plist::loadBuffer(), EventBase::loadBuffer(), and Config::loadBuffer().
| unsigned int XMLLoadSave::loadFile | ( | const char * | filename | ) | [virtual] |
initiate opening of the specified file and loading/saving of all appropriate information.
- Parameters:
-
filename the file to load/save
- Returns:
- number of bytes read/written, 0 if error (or empty)
Reimplemented from LoadSave.
Reimplemented in EventBase, and Config.
Definition at line 148 of file XMLLoadSave.cc.
Referenced by plist::loadFile(), EventBase::loadFile(), Config::loadFile(), and ConfigurationEditor::LoadSettings::selectedFile().
| unsigned int XMLLoadSave::loadFileStream | ( | FILE * | f | ) | [virtual] |
Used recursively on member objects once a file is already open - DON'T CLOSE the file in your overridden functions.
- Parameters:
-
f a pointer to the file to load
- Returns:
- number of bytes read, 0 if error (or empty)
Reimplemented from LoadSave.
Reimplemented in EventBase, and Config.
Definition at line 214 of file XMLLoadSave.cc.
Referenced by EventBase::loadFileStream(), and Config::loadFileStream().
| virtual void XMLLoadSave::loadXML | ( | xmlNode * | node | ) | [pure virtual] |
This is called when the subclass needs to update its values from those values in the parse tree.
node is the current node in the tree -- it may be the root, but it may also be a subnode within the tree if a recursive structure is used
Implemented in EventBase, LocomotionEvent, LookoutPointAtEvent, LookoutIREvent, PitchEvent, TextMsgEvent, TimerEvent, VisionObjectEvent, plist::PolymorphicLoader, plist::ObjectBase, plist::ObjectBase, plist::Dictionary, plist::ArrayBase, plist::Primitive< char >, plist::Primitive< unsigned char >, plist::Primitive< std::string >, plist::NamedEnumeration< T >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< encoding_t >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, and plist::NamedEnumeration< shutter_speeds >.
Referenced by loadBuffer(), loadFile(), loadFileStream(), and readParseTree().
| unsigned int XMLLoadSave::saveBuffer | ( | char | buf[], | |
| unsigned int | len | |||
| ) | const [virtual] |
Save to a given buffer in memory.
- Parameters:
-
buf pointer to the memory where you should begin writing len length of buf available. (this isn't necessarily all yours, constrain yourself to what you returned in getBinSize() )
- Returns:
- the number of bytes actually used
Implements LoadSave.
Reimplemented in EventBase.
Definition at line 124 of file XMLLoadSave.cc.
Referenced by EventBase::saveBuffer().
| unsigned int XMLLoadSave::saveFile | ( | const char * | filename | ) | const [virtual] |
initiate opening of the specified file and loading/saving of all appropriate information.
- Parameters:
-
filename the file to load/save
- Returns:
- number of bytes read/written, 0 if error (or empty)
Reimplemented from LoadSave.
Reimplemented in EventBase.
Definition at line 193 of file XMLLoadSave.cc.
Referenced by EventBase::saveFile(), and ConfigurationEditor::SaveSettings::selectedFile().
| unsigned int XMLLoadSave::saveFileStream | ( | FILE * | f | ) | const [virtual] |
Used recursively on member objects once a file is already open - DON'T CLOSE the file in your overridden functions.
- Parameters:
-
f a pointer to the file to save
- Returns:
- number of bytes written, 0 if error (or empty)
Reimplemented from LoadSave.
Reimplemented in EventBase.
Definition at line 248 of file XMLLoadSave.cc.
Referenced by EventBase::saveFileStream().
| virtual void XMLLoadSave::saveXML | ( | xmlNode * | node | ) | const [pure virtual] |
This is called when XMLLoadSave needs to have the subclass update values in the tree currently in memory -- may already be filled out by previous contents.
node is the current node in the tree -- it may be the root, but it may also be a subnode within the tree if a recursive structure is used
Implemented in EventBase, LocomotionEvent, LookoutPointAtEvent, LookoutIREvent, PitchEvent, TextMsgEvent, TimerEvent, VisionObjectEvent, plist::PolymorphicLoader, plist::ObjectBase, plist::Dictionary, plist::ArrayBase, plist::Primitive< char >, plist::Primitive< unsigned char >, plist::Primitive< std::string >, plist::NamedEnumeration< T >, plist::NamedEnumeration< J_DCT_METHOD >, plist::NamedEnumeration< Config::transports >, plist::NamedEnumeration< gain_levels >, plist::NamedEnumeration< volume_levels >, plist::NamedEnumeration< encoding_t >, plist::NamedEnumeration< compression_t >, plist::NamedEnumeration< white_balance_levels >, plist::NamedEnumeration< consoleMode_t >, and plist::NamedEnumeration< shutter_speeds >.
Referenced by getBinSize(), saveBuffer(), saveFile(), saveFileStream(), and writeParseTree().
| void XMLLoadSave::setParseTree | ( | xmlDoc * | doc | ) | const [virtual] |
assigns a parse tree which you have obtained from some other source
This doesn't update the contents of the subclass's values. The values in doc will be overwritten by those in the subclass on the next Save. If you wish to have the subclass's values updated from doc, call readParseTree() after calling this.
Reimplemented in plist::ObjectBase.
Definition at line 270 of file XMLLoadSave.cc.
Referenced by getBinSize(), operator=(), saveBuffer(), saveFile(), saveFileStream(), plist::ObjectBase::setParseTree(), and writeParseTree().
returns the next element following cur; comment is set to the concatination of any comments is encountered in the interim
You should call this with node->next, otherwise you'll just keep getting the same node back again
Definition at line 332 of file XMLLoadSave.cc.
returns the next element following cur
You should call this with node->next, otherwise you'll just keep getting the same node back again
Definition at line 326 of file XMLLoadSave.cc.
Referenced by VisionObjectEvent::loadXML(), TimerEvent::loadXML(), TextMsgEvent::loadXML(), plist::ArrayBase::loadXML(), plist::Dictionary::loadXML(), PitchEvent::loadXML(), LookoutIREvent::loadXML(), LookoutPointAtEvent::loadXML(), LocomotionEvent::loadXML(), plist::Dictionary::saveOverXMLNode(), VisionObjectEvent::saveXML(), TimerEvent::saveXML(), TextMsgEvent::saveXML(), plist::ArrayBase::saveXML(), plist::Dictionary::saveXML(), PitchEvent::saveXML(), LookoutIREvent::saveXML(), LookoutPointAtEvent::saveXML(), and LocomotionEvent::saveXML().
The documentation for this class was generated from the following files:
