operatorsmodel.h

/*************************************************************************************
 *  Copyright (C) 2007 by Aleix Pol <aleixpol@kde.org>                               *
 *                                                                                   *
 *  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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA   *
 *************************************************************************************/

#ifndef OPERATORSMODEL_H
#define OPERATORSMODEL_H

#include <QAbstractTableModel>
#include <QSharedPointer>
#include "analitzaguiexport.h"

namespace Analitza
{
class Variables;
class Operator;
}

//TODO: get in the namespace
/** Operators model is a model class that has a relation of all operators string with their OperatorType. */
class ANALITZAGUI_EXPORT OperatorsModel : public QAbstractTableModel
{
    Q_OBJECT
    public:
        enum Roles {
            IsVariableRole = Qt::UserRole + 1,
            DescriptionRole
        };

        /** Constructor. Creates a new Operator Model. */
        explicit OperatorsModel(QObject *parent=nullptr);
        
        /** Returns the description of the @p o operator. */
        static QString description(const Analitza::Operator& o);
        
        /** Returns the description of the @p o operator. */
        static QString sample(const Analitza::Operator& o);
        
        static QString example(const Analitza::Operator& o);
        
        QHash<int, QByteArray> roleNames() const override;

        /** Adds an entry to the model. */
    //     void addEntry(int i, const QString&, const QString&, const QString& ex=QString());
        
        /** Updates the variables information */
        void updateInformation();
        
        QVariant data( const QModelIndex &index, int role=Qt::DisplayRole) const override;
        QVariant headerData(int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override;
        int rowCount(const QModelIndex &parent=QModelIndex()) const override;
        int columnCount(const QModelIndex &parent=QModelIndex()) const override;
        
        void setVariables(const QSharedPointer<Analitza::Variables> &v) { m_vars=v; }
        QModelIndex indexForOperatorName(const QString& id) const;
        QString parameterHelp(const QModelIndex& idx, int param, bool inbounds) const;
        static QString standardFunctionCallHelp(const QString& funcname, int param, int paramcount, bool inbounds, bool isbounded);
        
        Q_SCRIPTABLE static QString lastWord(int pos, const QString &exp);
        
    private:
        QSharedPointer<Analitza::Variables> m_vars;
};


#endif