File indexing completed on 2024-05-05 05:01:21

 // SPDX-FileCopyrightText: 2022 Tobias Fella <tobias.fella@kde.org>
 // SPDX-License-Identifier: LGPL-2.0-or-later
 
 #pragma once
 
 #include <QConcatenateTablesProxyModel>
 #include <QQmlEngine>
 #include <QSortFilterProxyModel>
 
 #include "roomlistmodel.h"
 
 class CompletionProxyModel;
 class UserListModel;
 class NeoChatRoom;
 class RoomListModel;
 
 /**
  * @class CompletionModel
  *
  * This class defines the model for suggesting completions in chat text.
  *
  * This model is able to select the appropriate completion type for the input text
  * and present a list of options that can be presented to the user.
  */
 class CompletionModel : public QAbstractListModel
 {
     Q_OBJECT
     QML_ELEMENT
 
     /**
      * @brief The current text to search for completions.
      */
     Q_PROPERTY(QString text READ text NOTIFY textChanged)
 
     /**
      * @brief The current room that the model is getting completions for.
      */
     Q_PROPERTY(NeoChatRoom *room READ room WRITE setRoom NOTIFY roomChanged)
 
     /**
      * @brief The current type of completion being done on the entered text.
      *
      * @sa AutoCompletionType
      */
     Q_PROPERTY(AutoCompletionType autoCompletionType READ autoCompletionType NOTIFY autoCompletionTypeChanged)
 
     /**
      * @brief The RoomListModel to be used for room completions.
      */
     Q_PROPERTY(RoomListModel *roomListModel READ roomListModel WRITE setRoomListModel NOTIFY roomListModelChanged)
 
 public:
     /**
      * @brief Defines the different types of completion available.
      */
     enum AutoCompletionType {
         User, /**< A user in the current room. */
         Room, /**< A matrix room. */
         Emoji, /**< An emoji. */
         Command, /**< A / command. */
         None, /**< No available completion for the current text. */
     };
     Q_ENUM(AutoCompletionType)
 
     /**
      * @brief Defines the model roles.
      */
     enum Roles {
         DisplayNameRole = Qt::DisplayRole, /**< The main text to show. */
         SubtitleRole, /**< The subtitle text to show. */
         IconNameRole, /**< The icon to show. */
         ReplacedTextRole, /**< The text to replace the input text with for the completion. */
     };
     Q_ENUM(Roles)
 
     explicit CompletionModel(QObject *parent = nullptr);
 
     /**
      * @brief Get the given role value at the given index.
      *
      * @sa QAbstractItemModel::data
      */
     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
 
     /**
      * @brief Number of rows in the model.
      *
      * @sa  QAbstractItemModel::rowCount
      */
     int rowCount(const QModelIndex &parent = QModelIndex()) const override;
 
     /**
      * @brief Returns a mapping from Role enum values to role names.
      *
      * @sa EventRoles, QAbstractItemModel::roleNames()
      */
     QHash<int, QByteArray> roleNames() const override;
 
     QString text() const;
     void setText(const QString &text, const QString &fullText);
 
     NeoChatRoom *room() const;
     void setRoom(NeoChatRoom *room);
 
     RoomListModel *roomListModel() const;
     void setRoomListModel(RoomListModel *roomListModel);
 
     AutoCompletionType autoCompletionType() const;
     void setAutoCompletionType(AutoCompletionType autoCompletionType);
 
 Q_SIGNALS:
     void textChanged();
     void roomChanged();
     void autoCompletionTypeChanged();
     void roomListModelChanged();
 
 private:
     QString m_text;
     QString m_fullText;
     CompletionProxyModel *m_filterModel;
     NeoChatRoom *m_room = nullptr;
     AutoCompletionType m_autoCompletionType = None;
 
     void updateCompletion();
 
     UserListModel *m_userListModel;
     RoomListModel *m_roomListModel;
     QConcatenateTablesProxyModel *m_emojiModel;
 };
 Q_DECLARE_METATYPE(CompletionModel::AutoCompletionType);