Tekkotsu: plist.h Source File

00001 //-*-c++-*-
00002 #ifndef INCLUDED_PListSupport_h_
00003 #define INCLUDED_PListSupport_h_
00004 
00005 #include "plistBase.h"
00006 #include "plistPrimitives.h"
00007 #include "plistCollections.h"
00008 
00009 namespace plist {
00010   
00011   //! From the name of @a node, will instantiate a new ObjectBase subclass to load it
00012   /*! The mapping from node names to actual instantiated types is: 
00013    *    - 'array' -> Vector
00014    *    - 'dict' -> Map
00015    *    - 'real' -> Primitive<double>
00016    *    - 'integer' -> Primitive<long>
00017    *    - 'string' -> Primitive<std::string>
00018    *    - 'true', 'false' -> Primitive<bool>
00019    *  
00020    *  If successful, returns a pointer to a newly allocated region, which the caller is
00021    *  responsible for freeing.  If an error occurs, NULL is returned.
00022    */
00023   ObjectBase* loadXML(xmlNode* node);
00024   
00025   //! Attempts to parse the file found at @a file, using plist::loadXML()
00026   ObjectBase* loadFile(const std::string& file);
00027   
00028   //! Attempts to parse the buffer found at @a buf, using plist::loadXML()
00029   ObjectBase* loadBuffer(const char* buf, unsigned int len);
00030   
00031 } //namespace plist
00032 
00033 /*! @file
00034  * @brief Provides the plist namespace, a collection of classes to implement the Propery List data storage format, a XML standard used by Apple and others
00035  * @author Ethan Tira-Thompson (ejt) (Creator)
00036  *
00037  * $Author: ejt $
00038  * $Name: tekkotsu-3_0 $
00039  * $Revision: 1.11 $
00040  * $State: Exp $
00041  * $Date: 2006/09/09 04:33:02 $
00042  */
00043 
00044 #endif