/****************************************************************************
 *   Copyright (C) 2013-2016 by Savoir-faire Linux                          *
 *   Author : Emmanuel Lepage Vallee <emmanuel.lepage@savoirfairelinux.com> *
 *                                                                          *
 *   This library 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 2.1 of the License, or (at your option) any later version.     *
 *                                                                          *
 *   This library 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 General Public License      *
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/
#pragma once

#include "typedefs.h"

//Qt
#include <QtCore/QString>
#include <QtCore/QAbstractTableModel>

#include <presencestatus.h>
class CollectionInterface;
class PresenceStatusModelPrivate;

/**
 * This model present the **published** presence status. A published presence
 * status is used to notify other users of your status. This is done by sending
 * a string of text. This implementation also allow a name to describe each
 * string. This is better from an user point of view, as it take less room
 * in the GUI. The message is either selected from a list or set by hand.
 */
class LIB_EXPORT PresenceStatusModel : public QAbstractTableModel, public CollectionManagerInterface<PresenceStatus>
{
    #pragma GCC diagnostic push
    #pragma GCC diagnostic ignored "-Wzero-as-null-pointer-constant"
    Q_OBJECT
    #pragma GCC diagnostic pop
public:

    //Table columns
    enum class Columns {
        Name    = 0,
        Message = 1,
        Color   = 2,
        Status  = 3,
        Default = 4,
    };

    //Properties
    Q_PROPERTY( QString     customMessage     READ customMessage    WRITE  setCustomMessage              NOTIFY customMessageChanged(QString)     )
    Q_PROPERTY( bool        useCustomStatus   READ useCustomStatus  WRITE  setUseCustomStatus            NOTIFY useCustomStatusChanged(bool)      )
    Q_PROPERTY( bool        customStatus      READ customStatus     WRITE  setCustomStatus               NOTIFY customStatusChanged(bool)         )
    Q_PROPERTY( bool        currentStatus     READ currentStatus    NOTIFY currentStatusChanged(bool)                                             )
    Q_PROPERTY( QString     currentMessage    READ currentMessage   NOTIFY currentMessageChanged(QString)                                         )
    Q_PROPERTY( QModelIndex defaultStatus     READ defaultStatus    WRITE  setDefaultStatus              NOTIFY defaultStatusChanged(QModelIndex) )
    Q_PROPERTY( QString     currentName       READ currentName      NOTIFY currentNameChanged(QString)                                            )

    //Constructor
    explicit PresenceStatusModel(QObject* parent = nullptr);
    virtual ~PresenceStatusModel();

    //Abstract model members
    virtual QVariant      data       (const QModelIndex& index, int role = Qt::DisplayRole                 ) const override;
    virtual int           rowCount   (const QModelIndex& parent = QModelIndex()                            ) const override;
    virtual int           columnCount(const QModelIndex& parent = QModelIndex()                            ) const override;
    virtual Qt::ItemFlags flags      (const QModelIndex& index                                             ) const override;
    virtual bool          setData    (const QModelIndex& index, const QVariant &value, int role            )       override;
    virtual QVariant      headerData (int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;
    virtual QHash<int,QByteArray> roleNames() const override;

    //Singleton
    static PresenceStatusModel& instance();

    //Setters
    void setDefaultStatus( const QModelIndex& idx );
    void setAutoTracked(CollectionInterface* backend, bool tracked) const;

    //Getters
    QString     customMessage   () const;
    bool        useCustomStatus () const;
    bool        customStatus    () const;
    bool        currentStatus   () const;
    QString     currentMessage  () const;
    QString     currentName     () const;
    QModelIndex defaultStatus   () const;
    bool        isAutoTracked(CollectionInterface* backend) const;

private:
    QScopedPointer<PresenceStatusModelPrivate> d_ptr;

    virtual bool addItemCallback(const PresenceStatus* item) override;
    virtual bool removeItemCallback(const PresenceStatus* item) override;

public Q_SLOTS:
   void addRow            (                          );
   void removeRow         ( const QModelIndex& index );
   void save              (                          );
   void moveUp            ( const QModelIndex& index );
   void moveDown          ( const QModelIndex& index );
   void setUseCustomStatus( bool useCustom           );
   void setCustomStatus   ( bool status              );
   void setCurrentIndex   ( const QModelIndex& index );
   void setCustomMessage  ( const QString& message   );

Q_SIGNALS:
   ///The current presence status has changed
   void currentIndexChanged   ( const QModelIndex& current   );
   ///The current presence status name string changed
   void currentNameChanged    ( const QString&     name      );
   ///The model now use custom strings instead of predefined ones
   void useCustomStatusChanged( bool               useCustom );
   ///The current (custom) presence message changed
   void customMessageChanged  ( const QString&     message   );
   ///The current (custom) presence status changed
   void customStatusChanged   ( bool               status    );
   ///The default presence status changed
   void defaultStatusChanged  ( const QModelIndex& def       );
   ///The current presence message changed
   void currentMessageChanged ( const QString&     message   );
   ///The current presence status changed
   void currentStatusChanged  ( bool               status    );

};

Q_DECLARE_METATYPE( PresenceStatusModel* )

