ParameterFileModel.h

Go to the documentation of this file.

/*  Copyright (C) 2009 Jens-Malte Gottfried

    This file is part of Tuchulcha.

    Tuchulcha 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.

    Tuchulcha 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 Tuchulcha.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef PARAMETERFILEMODEL_H_
#define PARAMETERFILEMODEL_H_

#include <QAbstractTableModel>
#include <QStringList>

class QParameterFile;
class QMutex;
class MetaData;
class PrefixValidator;

class ParameterFileModel: public QAbstractTableModel {
    Q_OBJECT
    Q_PROPERTY(QString _fileName    READ fileName       WRITE setFileName)
    Q_PROPERTY(QString _prefix      READ prefix         WRITE setPrefix)
    Q_PROPERTY(bool _useMetaInfo    READ useMetaInfo    WRITE setUseMetaInfo)
    Q_PROPERTY(bool _onlyParams     READ onlyParams     WRITE setOnlyParams)
    Q_PROPERTY(int _minPriority     READ minPriority    WRITE setMinPriority)

public:

    ParameterFileModel(
            QString fileName = "", QObject* parent = 0, QString metaFile = "");

    virtual ~ParameterFileModel();

    //  \{


    virtual int rowCount(const QModelIndex& parent = QModelIndex()) const;


    virtual int columnCount(const QModelIndex& parent = QModelIndex()) const;


    virtual QVariant data(
            const QModelIndex& index, int role = Qt::DisplayRole) const;


    virtual bool setData (
            const QModelIndex& index, const QVariant& value,
            int role = Qt::EditRole);


    virtual Qt::ItemFlags flags (const QModelIndex& index) const;


    virtual QVariant headerData (
            int section, Qt::Orientation orientation,
            int role = Qt::DisplayRole) const;


    virtual bool insertRows (
            int row, int count,
            const QModelIndex& parent = QModelIndex());


    virtual bool removeRows (
            int row, int count,
            const QModelIndex& parent = QModelIndex());

    virtual Qt::DropActions supportedDropActions() const;

    virtual QStringList mimeTypes() const;

    virtual bool dropMimeData(const QMimeData *data, Qt::DropAction action,
        int row, int column, const QModelIndex &parent);

    // \} // model/view interface

    void reactivatePreviousPlugins();

    void deactivate();

    void reactivate();

    bool active() const;

    QString fileName() const;

    QString prefix() const;

    bool useMetaInfo() const;

    bool onlyParams() const;

    int minPriority() const;

    const QParameterFile& parameterFile() const;

    bool prefixValid() const;

    // \{
    bool metaInfoValid() const;

    QStringList getClasses() const;


    QString getClass(QString objName, bool fixCase = false) const;


    QString getType(QString parName, bool applyTmplType = true) const;

    QString getDefault(QString parName) const;

    QString getDoc(QString parName) const;


    QStringList getInputs(QString objName) const;


    QStringList getInputDisplayNames(QString objName) const;


    QStringList getOutputs(QString objName) const;


    QStringList getOutputDisplayNames(QString objName) const;


    QStringList getParameters(QString objName) const;


    bool isParameter(QString name) const;


    bool isInputSlot(QString name) const;


    bool isOutputSlot(QString name) const;


    bool isMultiSlot(QString name) const;
    // \}

    // \{

    QString getValue(QString parName) const;


    void setValue(QString parName, QString value);

    bool isSet(QString parName) const;


    void erase(QString parName);


    bool rename(QString oldPrefix, QString newPrefix);
    // \}

signals:

    void fileNameChanged(QString fileName);


    void prefixChanged(const QString& prefix);


    void metaInfoChanged(bool valid);


    void useMetaInfoChanged(bool value);


    void onlyParamsChanged(bool value);


    void minPriorityChanged(int value);


    void statusMessage(const QString& msg);

    void modified(bool val );

    void commentChanged(QString comment);

    void dynamicUpdate();

public slots:

    virtual void setFileName(const QString& fileName);


    virtual QString setPrefix(const QString& prefix);

    void setHandleDynamics(bool);


    virtual void loadMetaInfo(const QString& fileName);


    void setUseMetaInfo(bool value);


    void setOnlyParams(bool value);


    void setMinPriority(int value);


    virtual bool load(const QString& fName = "");

    virtual void clear();


    virtual void save(const QString& fileName = "");

protected slots:

    virtual bool _load();

    virtual void _update();

    virtual void _updatePriority(const QModelIndex &topLeft,
        const QModelIndex &bottomRight);

protected:
    QMutex* _resetMutex;

private:
    QParameterFile* _parameterFile;

    QStringList _keys;

    QString _fileName;

    QString _prefix;

    const MetaData* _metaInfos;

    QMap<QString,QString> _classCaseMap;

    bool _useMetaInfo;

    bool _onlyParams;

    int _minPriority;

    bool _handleDynamics;

    void _updateDynamics();


    QStringList _collectObjects(QStringList list) const;


    QStringList _prefixFilter(QStringList list) const;


    QStringList _paramFilter(QStringList list) const;


    QStringList _priorityTagFilter(QStringList list) const;


    QStringList _priorityFilter(QStringList list) const;

    QString _getDynamicMetaFile(QString objName) const;
};

#endif /* PARAMETERFILEMODEL_H_ */