---

Composite.h

Go to the documentation of this file.

/* SimData: Data Infrastructure for Simulations
 * Copyright (C) 2002, 2003 Mark Rose <tm2@stm.lbl.gov>
 * 
 * This file is part of SimData.
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */


#ifndef __SIMDATA_COMPOSITE_H__
#define __SIMDATA_COMPOSITE_H__

#include <iostream>
#include <cstdio>
#include <vector>
#include <SimData/Ref.h>
#include <SimData/Log.h>


NAMESPACE_SIMDATA


template<class V>
class Visitable;

#define SIMDATA_VISITOR(__visitor) \
        typedef SIMDATA(Ref)<__visitor> Ref; \
        using SIMDATA(Visitor)<__visitor>::apply

#define SIMDATA_VISITABLE(__visitor) \
        virtual SIMDATA(Ref)<__visitor> accept(SIMDATA(Ref)<__visitor> v) { \
                v->apply(*this); \
                return v; \
        }

template<class N>
class CompositeBase;


class VisitorBase: public virtual Referenced { };


template <class N>
class VisitorCore: public VisitorBase {
public:
        typedef enum { 
                TRAVERSE_NONE,     //< Act on only the current node.
                TRAVERSE_CHILDREN, //< Act on the current node and all children
                TRAVERSE_PARENTS   //< Act on the current node and all parents
        } TraversalMode;

        TraversalMode getTraversalMode() const { return _traversal_mode; }

        typedef CompositeBase<N> Node;

        virtual void apply(Node &node) { traverse(node); }

        VisitorCore(TraversalMode mode = TRAVERSE_CHILDREN): 
                _traversal_mode(mode) {}

protected:
        void traverse(Node &node) {
                if (_traversal_mode == TRAVERSE_CHILDREN) {
                        descend(node);
                } else
                if (_traversal_mode == TRAVERSE_PARENTS) {
                        ascend(node);
                }
        }

        void setTraversalMode(TraversalMode mode) { _traversal_mode = mode; }

private:
        TraversalMode _traversal_mode;

        inline void ascend(Node &node);

        inline void descend(Node &node);

};


template <class N>
class CompositeBase: public virtual Referenced {
        friend class VisitorCore<N>;
protected:
        virtual void descend(VisitorBase *v) = 0;

        virtual void ascend(VisitorBase *v) = 0;
};


template <class V> 
class Composite: public Visitable<V>, public CompositeBase< Visitable<V> > {
public:
        typedef Composite Node;
        typedef Ref<Node> NodeRef;
        typedef Ref<V> VisitorRef;

        typedef std::vector< NodeRef > ChildList;
        
        typedef std::vector< Node* > ParentList;

        virtual VisitorRef accept(VisitorRef v)=0;

        virtual bool addChild(Node *node) {
                if (!isContainer()) {
                        SIMDATA_LOG(LOG_ALL, LOG_WARNING, "simdata::Composite<>::addChild() to non-container.");
                        return false;
                }
                if (!node) {
                        SIMDATA_LOG(LOG_ALL, LOG_WARNING, "simdata::Composite<>::addChild() null node.");
                        return false;
                }
                if (!node->canBeAdded()) {
                        SIMDATA_LOG(LOG_ALL, LOG_WARNING, "simdata::Composite<>::addChild() cannot be added.");
                        return false;
                }
                if (containsNode(node)) {
                        SIMDATA_LOG(LOG_ALL, LOG_WARNING, "simdata::Composite<>::addChild() duplicate node.");
                        return false;
                }
                _children.push_back(node);
                node->addParent(this);
                return true;
        }

        virtual bool removeChild(Node *node) {
                return removeChild(getChildIndex(node));
        }

        virtual bool removeChild(unsigned int pos, unsigned int count=1) {
                if (pos >= _children.size() || count == 0) return false;
                unsigned int end = pos + count;
                if (end > _children.size()) {
                        SIMDATA_LOG(LOG_ALL, LOG_WARNING, "simdata::Composite<>::removeChild() index range truncated.");
                        end = _children.size();
                }
                for (unsigned int i = pos; i < end; ++i) {
                        _children[i]->removeParent(this);
                }
                _children.erase(_children.begin()+pos,_children.begin()+end);
                return true;
        }

        inline unsigned int getNumChildren() const { return _children.size(); }

        virtual bool setChild(unsigned int i, Node* node) { 
                if (i >= _children.size() || !node) return false; 
                NodeRef original = _children[i];
                original->removeParent(this);
                _children[i] = node;
                node->addParent(this);
                return true;
        }

        inline Node* getChild(unsigned int i) { 
                if (i >= _children.size()) return 0;
                return _children[i].get(); 
        }

        inline const Node* getChild(unsigned int i) const { 
                if (i >= _children.size()) return 0;
                return _children[i].get(); 
        }

        inline ChildList const &getChildren() const { return _children; }

        inline bool containsNode(Node const *node) const {
                if (!node) return false;
                return std::find(_children.begin(), _children.end(), node) != _children.end();
        }

        inline unsigned int getChildIndex(Node const *node) const { 
                for (unsigned int idx = 0; idx < _children.size(); ++idx) {
                        if (_children[idx] == node) return idx;
                }
                return _children.size(); // not found
        }

        inline const ParentList &getParents() const { return _parents; }

        inline Node* getParent(unsigned int i)  { 
                if (i >= _parents.size()) return 0;
                return _parents[i]; 
        }

        inline const Node* getParent(unsigned int i) const  { 
                if (i >= _parents.size()) return 0;
                return _parents[i]; 
        }

        inline unsigned int getNumParents() const { return _parents.size(); }

        virtual bool isContainer() const { return true; }
        virtual bool canBeAdded() const { return true; }

protected:
        inline ParentList getParents() { return _parents; }

        class AcceptOp {
                typename Composite::VisitorRef _visitor;
        public:
                AcceptOp(VisitorBase *visitor) { _visitor = visitor; }
                void operator()(NodeRef node) { node->accept(_visitor); }
        };

        void descend(VisitorBase *visitor) {
                std::for_each(_children.begin(), _children.end(), AcceptOp(visitor));
        }

        void ascend(VisitorBase *visitor) {
                std::for_each(_parents.begin(), _parents.end(), AcceptOp(visitor));
        }

private:
        void addParent(Node *node) {
                _parents.push_back(node);
        }

        void removeParent(Node *node) {
                typename ParentList::iterator iter;
                iter = std::find(_parents.begin(), _parents.end(), node);
                if (iter != _parents.end()) _parents.erase(iter);
        }

        ChildList _children;

        ParentList _parents;
};


template <class N>
void VisitorCore<N>::descend(CompositeBase<N> &node) {
        node.descend(this);
};


template <class N>
void VisitorCore<N>::ascend(CompositeBase<N> &node) {
        node.ascend(this);
};


template <class V>
class Visitable: public virtual Referenced {
public:
        virtual Ref<V> accept(Ref<V> v)=0;
};


template <class V>
class Visitor: public VisitorCore< Visitable<V> > {};


template <class N, class V>
class FindVisitor: public V {
public:
        virtual bool match(N &node) = 0;

        void apply(N &node) {
                if (_node.valid()) return;
                if (match(node)) {
                        _node = &node;
                        setTraversalMode(TRAVERSE_NONE);
                } else {
                        traverse(node);
                }
        }

        simdata::Ref<N> getNode() const { return _node; }
private:
        simdata::Ref<N> _node;
};


template <class N, class V>
class FindAllVisitor: public V {
public:
        typedef std::vector< simdata::Ref<N> > NodeList;

        virtual bool match(N &node) = 0;

        void apply(N &node) {
                if (match(node)) {
                        _nodes.push_back(&node);
                } 
                traverse(node);
        }
        NodeList getNodes() const { return _nodes; }
private:
        NodeList _nodes;
};


NAMESPACE_SIMDATA_END

#endif // __SIMDATA_COMPOSITE_H__

---

SimData version pre-0.4.0. For more information on SimData, visit the SimData Homepage. Generated on Tue Oct 14 12:06:38 2003, using Doxygen 1.2.18.