object_visitor.hpp

Go to the documentation of this file.

// See ../license.txt for license information.
//
// object_visitor.hpp
//
// 4-Jul-2003  phamilton  Created
//

#ifndef incREFLECT_OBJECT_VISITOR
#define incREFLECT_OBJECT_VISITOR

// forwards
#include <vector>
#include <string>
#include "../common/object.hpp"
#include "../common/visitable_object.hpp"
#include "config.hpp"

namespace ph {
namespace reflect {

class REFLECT_DECL get_composite_object_visitor : public ph::common::object_name_visitor
/**
        Concrete subclass of object_visitor used to dump the value of a member.
*/
{
public:
        get_composite_object_visitor(const std::string &name) :
                _name(name), _obj(0)
                        {};
                        
        ph::common::object_base *obj() { return _obj; }
        
        // const_object_visitor ovverides.
        virtual bool visit(const ph::common::object_base *obj, const ph::common::nameable_object_base *name)
                { return true; }
        virtual bool visit_composite(const ph::common::object_base *obj, const ph::common::nameable_object_base *name);
        
private:
        std::string _name;
        ph::common::object_base *_obj;
};

class REFLECT_DECL get_object_visitor : public ph::common::object_name_visitor
/**
        Concrete subclass of object_visitor used to search for an object given the name.
*/
{
public:
        get_object_visitor(const std::string &name, bool recurse=false) :
                _name(name), _recurse(recurse), _obj(0)
                        {};
                        
        ph::common::object_base *obj() { return _obj; }
        
        // const_object_visitor ovverides.
        virtual bool recurse() { return _recurse; }
        virtual bool visit(const ph::common::object_base *obj, const ph::common::nameable_object_base *name);
        virtual bool visit_composite(const ph::common::object_base *obj, const ph::common::nameable_object_base *name)
                { return true; }
        
private:
        std::string _name;
        bool        _recurse;
        ph::common::object_base *_obj;
};

class REFLECT_DECL get_object_with_type_visitor : public ph::common::object_name_visitor
/**
        Concrete subclass of object_visitor used to search for an object given the name
        and type.
*/
{
public:
        get_object_with_type_visitor(const std::string &type, 
                const std::string &name, bool recurse=false) :
                _type(type), _name(name), _recurse(recurse), _obj(0)
                        {};
                        
        ph::common::object_base *obj() { return _obj; }
        
        // const_object_visitor ovverides.
        virtual bool recurse() { return _recurse; }
        virtual bool visit(const ph::common::object_base *obj, const ph::common::nameable_object_base *name);
        virtual bool visit_composite(const ph::common::object_base *obj, const ph::common::nameable_object_base *name)
                { return true; }
        
private:
        std::string _type;
        std::string _name;
        bool        _recurse;
        ph::common::object_base *_obj;
};

class REFLECT_DECL get_nth_object_visitor : public ph::common::object_name_visitor
/**
        Concrete subclass of object_visitor used to dump the value of a member.
        
        This visitor is 0 based.
*/
{
public:
        get_nth_object_visitor(long index) :
                _index(index), _obj(0)
                        {};
                        
        ph::common::object_base *obj() { return _obj; }
        
        // const_object_visitor ovverides.
        virtual bool visit(const ph::common::object_base *obj, const ph::common::nameable_object_base *name);
        virtual bool visit_composite(const ph::common::object_base *obj, const ph::common::nameable_object_base *name)
                { return true; }
        
private:
        int _index;
        ph::common::object_base *_obj;
};

class REFLECT_DECL dump_object_visitor : public ph::common::const_object_visitor
/**
        Concrete subclass of object_visitor used to dump the value of a member.
*/
{
public:
        dump_object_visitor(std::ostream *stream, bool debug=false) :
                _stream(stream), _debug(debug), _indent(0)
                        {};
        ~dump_object_visitor();
                
        // object_visitor ovverides.
        virtual bool recurse() { return true; }
        virtual bool visit(const ph::common::object_base *obj);
        virtual bool visit_composite(const ph::common::object_base *obj);
        
private:
        std::ostream              *_stream;
        bool                       _debug;
        int                        _indent;
        std::vector<const ph::common::object_base *> _stack;

        void calc_indent(const ph::common::object_base *obj);
        void indent();
        void close_stack();
        void obj_out(const std::string &msg, const ph::common::object_base *obj);
};

}; // reflect
}; // ph

#endif // incREFLECT_OBJECT_VISITOR

---