configuration/include/configurationnode.h

/***************************************************************************
 *   Copyright (C) 2008 by Tomassino Ferrauto                              *
 *   t_ferrauto@yahoo.it                                                   *
 *                                                                         *
 *   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 CONFIGURATION_NODE_H
#define CONFIGURATION_NODE_H

#include "configurationconfig.h"
#include <QMap>
#include <QString>
#include <QStringList>

namespace farsa {

class ParameterSettable;

enum ObjectCreationStatus {
    ObjectNotCreated, 
    CreatingObject, 
    ObjectCreatedNotConfigured, 
    ConfiguringObject, 
    CreatingAndConfiguringObject, 
    ObjectCreatedAndConfigured 
};

class FARSA_CONF_API ConfigurationNode
{
public:
    struct ObjectAndStatus
    {
        ObjectAndStatus() :
            object(NULL),
            objectStatus(ObjectNotCreated)
        {
        }

        ObjectAndStatus(const ObjectAndStatus& other) :
            object(other.object),
            objectStatus(other.objectStatus)
        {
        }

        ObjectAndStatus& operator=(const ObjectAndStatus& other)
        {
            if (this == &other) {
                return *this;
            }

            object = other.object;
            objectStatus = other.objectStatus;

            return *this;
        }

        ParameterSettable *object;

        ObjectCreationStatus objectStatus;
    };

public:
    ConfigurationNode(ConfigurationNode *parent, QString name = QString(), bool caseSensitive = false);

    ~ConfigurationNode();

    const ConfigurationNode* getParent() const
    {
        return m_parent;
    }

    QList<const ConfigurationNode*> getAncestors() const;

    QStringList getAncestorsNames() const;

    QString getName() const
    {
        return m_name;
    }

    QString getFullName() const;

    bool isNull() const
    {
        return m_name.isNull();
    }

    bool isCaseSensitive() const
    {
        return m_caseSensitive;
    }

    ConfigurationNode* addNode(QString name);

    ConfigurationNode* getNode(QString path);

    const ConfigurationNode* getNode(QString path) const;

    bool deleteNode(QString name);

    bool renameNode(QString oldName, QString newName);

    QList<ConfigurationNode*> getChildrenNodesList();

    QStringList getChildrenList() const;

    QStringList getFilteredChildrenList(QRegExp filter) const;

    bool setObjectForNode(QString path, ParameterSettable* object, ObjectCreationStatus status = ObjectCreatedAndConfigured);

    void resetObject();

    ObjectAndStatus getObjectForNode(QString path) const;

    bool addParameter(QString name);

    QString getValue(QString path, bool alsoMatchParents = false) const;

    ObjectAndStatus getObject(QString path, bool alsoMatchParents = false) const;

    bool setValue(QString path, QString value);

    bool setValue(QString path, ParameterSettable* object);

    bool deleteParameter(QString name);

    QStringList getParametersList() const;

    QStringList getFilteredParametersList(QRegExp filter) const;

    QStringList getObjectParametersList() const;

    QStringList getFilteredObjectParametersList(QRegExp filter) const;

    void clearAll();

private:
    ConfigurationNode *const m_parent;

    const bool m_caseSensitive;

    const QString m_name;

    mutable ConfigurationNode* m_nullNode;

    mutable QString m_nullValue;

    ObjectAndStatus m_object;

    QMap<QString, ConfigurationNode*> m_children;
    
    QStringList m_childrenkeys;

    QMap<QString, QString> m_parameters;

    QStringList m_parameterskeys;

    QMap<QString, ObjectAndStatus> m_objectParameters;

    ConfigurationNode(const ConfigurationNode &);

    ConfigurationNode& operator=(const ConfigurationNode &);
};

} // end namespace farsa

#endif