ddcObject.h

Go to the documentation of this file.

//-*- Mode: C++ -*-
//  DDC originally by Alexey Sokirko
//  Changes and modifications 2011-2015 by Bryan Jurish
//
//  This file is part of DDC.
// 
//  DDC is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
// 
//  DDC 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 Lesser General Public License for more details.
// 
//  You should have received a copy of the GNU Lesser General Public License
//  along with DDC.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef DDC_OBJECT_H
#define DDC_OBJECT_H

#include "utilit.h"
#include "ddcString.h"
#include <list>

class ddcObject;                         //-- forward decl
typedef list<ddcObject*> ddcObjectList;  //-- for child- and descendant-lists

//-- visitor struct for ddcObject::Descendants() method
struct ddcObjectDescendantsVisitor
{
    ddcObjectList m_Descendants;
    inline bool operator()(const ddcObject *obj) {
        m_Descendants.push_back((ddcObject*)obj);
        return false;
    };
};

//======================================================================
// CQFilter

class ddcObject {
public:
    //------------------------------------------------------------

    void *m_User;

public:
    //------------------------------------------------------------

    ddcObject()
        : m_User(NULL)
    {};

    virtual ~ddcObject()
    {};

    //------------------------------------------------------------

    virtual ddcObjectList Children() const
    { return ddcObjectList(); };

    virtual void DisownChildren()
    {};

    template<typename Visit>
    ddcObject* Traverse(Visit& visit)
    {
        ddcObject* retval=NULL;
        ddcObjectList stack(1,(ddcObject*)this);
        while (!stack.empty()) {
            ddcObject *optr = stack.front();
            stack.pop_front();
            if ( visit(optr) ) {
                retval = optr;
                break;
            }
            if (optr != NULL) {
                ddcObjectList kids(optr->Children());
                stack.splice(stack.begin(), kids);
            }
        }
        return retval;
    };

    template<typename Visit>
    ddcObject* Traverse(Visit& visit) const
    {
        ddcObject* retval=NULL;
        ddcObjectList stack(1,(ddcObject*)this);
        while (!stack.empty()) {
            ddcObject *optr = stack.front();
            stack.pop_front();
            if ( visit(optr) ) {
                retval = optr;
                break;
            }
            if (optr != NULL) {
                ddcObjectList kids(optr->Children());
                stack.splice(stack.begin(), kids);
            }
        }
        return retval;
    };

    template<typename Visit>
    ddcObject* TraverseR(Visit& visit)
    {
        ddcObject* retval=NULL;
        ddcObjectList stack(1,this);
        while (!stack.empty()) {
            ddcObject *optr = stack.front();
            ddcObjectList kids;
            if (optr != NULL)
                kids = optr->Children();
            stack.pop_front();
            if ( visit(optr) ) {
                retval = optr;
                break;
            }
            stack.splice(stack.begin(), kids);
        }
        return retval;
    };

    template<typename Visit>
    ddcObject* TraverseR(Visit& visit) const
    {
        ddcObject* retval=NULL;
        ddcObjectList stack(1,(ddcObject*)this);
        while (!stack.empty()) {
            ddcObject *optr = stack.front();
            ddcObjectList kids;
            if (optr != NULL)
                kids = optr->Children();
            stack.pop_front();
            if ( visit(optr) ) {
                retval = optr;
                break;
            }
            stack.splice(stack.begin(), kids);
        }
        return retval;
    };

    virtual ddcObjectList Descendants() const
    {
        ddcObjectDescendantsVisitor visitor;
        this->Traverse(visitor);
        return visitor.m_Descendants;
    };

    //------------------------------------------------------------

    virtual string toString()
    { return Format("%s=%p", typeid(*this).name(), this); };

    virtual string toJson()
    { return string("{\"class\":")+jsonStr(this->jsonClass())+","+this->jsonData()+"}"; };

    virtual string jsonClass()
    { string cls(typeid(*this).name()); return cls; };

    virtual string jsonData()
    { return "\"NODATA\":1"; };
};

inline string jsonStr(ddcObject *o)
{ return o==NULL ? "null" : o->toJson(); };


#endif /* DDC_OBJECT_H */

/*--- emacs style variables ---
 * Local Variables:
 *  mode: C++
 *  c-file-style: "ellemtel"
 *  c-basic-offset: 4
 *  tab-width: 8
 *  indent-tabs-mode: nil
 * End:
 */