dumpobj.hpp

Go to the documentation of this file.

// See ../license.txt for license information.
//
// dumpobj.hpp
//
// 21-Jul-2003  phamilton  Created
//

#ifndef incPERSIST_DUMP_OBJECT
#define incPERSIST_DUMP_OBJECT

// forwards
#include <iostream>
#include <string>
#include <map>
#include "../common/persistable_object.hpp"
#include "config.hpp"

namespace ph {
namespace persist {

class PERSIST_DECL dumpobj : public ph::common::object_writer
/**
        A concrete subclass of object_writer which dumps an object.

        We write the objects like this:
        
        object ::=  
                object-start
                        sub-object-list
                object-end
                
        object-start ::=
                TAGNAME ["(" attr-list ")"] "{" 

        object-end ::=
                "}"

        sub-object-list ::=
                (data-object | object)*

        data-object ::=
                TAGNAME "=" data
                 
        attr-list ::= 
                [attr-pair ([", " attr-pair])*]
                                
        attr-pair ::=
                name "=" value
                
        And a typical tree might be:
        
        root(name=root)
        {
                x=1
                foos
                {
                        foo(name=foo_1)
                        {
                                x=1
                                y=2.1
                                z=true
                        }
                        foo(name=foo_2)
                        {
                          x=4
                          y=10
                          z=false
                        }
                }
        }
*/
{
public:
        dumpobj(std::ostream *stream, std::ostream *console) :
                _stream(stream), _console(console), 
                _tabs(0), _tagname(""), _data("")
                        {};
        
        // ph::common::object_writer overrides
        virtual bool start(const std::string &tagname);
        virtual bool attr(const std::string &name, const std::string &value);
        virtual bool data(const std::string &d);
        virtual bool end(const std::string &tagname);
        
private:
        std::ostream *_stream;
        std::ostream *_console;
        int           _tabs;
        std::string   _tagname;
        std::map<std::string, std::string> _attrs;
        std::string   _data;
        
        void object_start();
        void object_end();
        void data_object();
        void tabs();
        void cr();
};

}; // persist
}; // ph

#endif // incPERSIST_DUMP_OBJECT

---