/*
 * Strawberry Music Player
 * This file was part of Clementine.
 * Copyright 2010, David Sansome <me@davidsansome.com>
 * Copyright 2018-2021, Jonas Kvinge <jonas@jkvinge.net>
 *
 * Strawberry 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 3 of the License, or
 * (at your option) any later version.
 *
 * Strawberry 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 Strawberry.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef PLAYLISTLISTMODEL_H
#define PLAYLISTLISTMODEL_H

#include "config.h"

#include <QObject>
#include <QStandardItemModel>
#include <QMap>
#include <QIcon>
#include <QVariant>
#include <QString>

class QMimeData;
class QModelIndex;

class PlaylistListModel : public QStandardItemModel {
  Q_OBJECT

 public:
  explicit PlaylistListModel(QObject *parent = nullptr);

  enum Types {
    Type_Folder,
    Type_Playlist
  };

  enum Roles {
    Role_Type = Qt::UserRole,
    Role_PlaylistId
  };

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

  // These icons will be used for newly created playlists and folders.
  // The caller will need to set these icons on existing items if there are any.
  void SetIcons(const QIcon &playlist_icon, const QIcon &folder_icon);
  const QIcon &playlist_icon() const { return playlist_icon_; }
  const QIcon &folder_icon() const { return folder_icon_; }

  // Walks from the given item to the root, returning the / separated path of
  // all the parent folders.  The path includes this item if it is a folder.
  static QString ItemPath(const QStandardItem *item);

  // Finds the playlist with the given ID, returns 0 if it doesn't exist.
  QStandardItem *PlaylistById(const int id) const;

  // Finds the folder with the given path, creating it (and its parents) if they
  // do not exist.  Returns invisibleRootItem() if path is empty.
  QStandardItem *FolderByPath(const QString &path);

  // Returns a new folder item with the given name.  The item isn't added to
  // the model yet.
  QStandardItem *NewFolder(const QString &name) const;

  // Returns a new playlist item with the given name and ID.  The item isn't
  // added to the model yet.
  QStandardItem *NewPlaylist(const QString &name, const int id) const;

  // QStandardItemModel
  bool setData(const QModelIndex &idx, const QVariant &value, int role) override;

 signals:
  void PlaylistPathChanged(const int id, const QString &new_path);
  void PlaylistRenamed(const int id, const QString &new_name);

 private slots:
  void RowsChanged(const QModelIndex &begin, const QModelIndex &end);
  void RowsAboutToBeRemoved(const QModelIndex &parent, const int start, const int end);
  void RowsInserted(const QModelIndex &parent, const int start, const int end);

 private:
  void AddRowMappings(const QModelIndex &begin, const QModelIndex &end);
  void AddRowItem(QStandardItem *item, const QString &parent_path);
  void UpdatePathsRecursive(const QModelIndex &parent);

 private:
  bool dropping_rows_;

  QIcon playlist_icon_;
  QIcon folder_icon_;

  QMap<int, QStandardItem*> playlists_by_id_;
  QMap<QString, QStandardItem*> folders_by_path_;
};

#endif  // PLAYLISTLISTMODEL_H