src/widgets/resource_model.cpp

/*
 * Copyright (C) 2014-2018 Christopho, Solarus - http://www.solarus-games.org
 *
 * Solarus Quest Editor 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.
 *
 * Solarus Quest Editor 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, see <http://www.gnu.org/licenses/>.
 */
#include "widgets/resource_model.h"
#include "editor_exception.h"
#include "quest.h"
#include "quest_database.h"
#include "sprite_model.h"

namespace SolarusEditor {

/**
 * @brief Creates a resource model.
 * @param quest The quest.
 * @param resource_type Type of resources to show.
 * @param parent The parent object or nullptr.
 */
ResourceModel::ResourceModel(const Quest& quest, ResourceType resource_type, QObject* parent) :
  QStandardItemModel(parent),
  quest(quest),
  resource_type(resource_type),
  items(),
  icons(),
  directory_icon(":/images/icon_folder_open.png"),
  tileset_id() {

  const QuestDatabase& database = get_database();

  const QStringList& ids = database.get_elements(this->resource_type);
  for (const QString& id : ids) {
    add_element(id);
  }

  connect(&database, SIGNAL(element_added(ResourceType, QString, QString)),
          this, SLOT(element_added(ResourceType, QString, QString)));
  connect(&database, SIGNAL(element_removed(ResourceType, QString)),
          this, SLOT(element_removed(ResourceType, QString)));
  connect(&database, SIGNAL(element_renamed(ResourceType, QString, QString)),
          this, SLOT(element_renamed(ResourceType, QString, QString)));
  connect(&database, SIGNAL(element_description_changed(ResourceType, QString, QString)),
          this, SLOT(element_description_changed(ResourceType, QString, QString)));
}

/**
 * @brief Returns the quest.
 * @return The quest.
 */
const Quest& ResourceModel::get_quest() const {
  return quest;
}

/**
 * @brief Returns the resources and files of the quest.
 * @return The quest database.
 */
const QuestDatabase& ResourceModel::get_database() const {
  return quest.get_database();
}

/**
 * @brief Returns the id of the current tileset.
 *
 * This tileset is used for icons of tileset-dependent sprites.
 *
 * @return The current tileset id or an empty string.
 */
QString ResourceModel::get_tileset_id() const {
  return tileset_id;
}

/**
 * @brief Sets the id of the current tileset.
 *
 * This tileset is used for icons of tileset-dependent sprites.
 *
 * @param tileset_id The current tileset id or an empty string to unset it.
 */
void ResourceModel::set_tileset_id(const QString& tileset_id) {

  this->tileset_id = tileset_id;

  if (resource_type == ResourceType::SPRITE ||
      resource_type == ResourceType::ENEMY ||
      resource_type == ResourceType::ITEM) {

    // Icons may change.
    icons.clear();  // Clear the icon cache.
    QVector<int> roles;
    roles << Qt::DecorationRole;
    dataChanged(QModelIndex(), QModelIndex(), roles);
  }
}

/**
 * @brief Returns the index of the specified element.
 * @param element_id Id of a resource element.
 * @return The corresponding index in this model
 * or an invalid index if it does not exist.
 */
QModelIndex ResourceModel::get_element_index(const QString& element_id) const {

  const QStandardItem* item = get_element_item(element_id);
  if (item == nullptr) {
    return QModelIndex();
  }
  return item->index();
}

/**
 * @brief Adds an item for a special value that is not an existing resource element.
 *
 * You can use this function to add a fake item like "None" or "Unchanged".
 *
 * @param id String to identify the item, replacing the resource element id.
 * @param text Text to show in the combo box for this item.
 * @param index Index where to insert the item.
 */
void ResourceModel::add_special_value(
    const QString& id, const QString& text, int index) {

  QStandardItem* item = new QStandardItem(text);
  item->setData(id, Qt::UserRole);
  items.insert(id, item);
  insertRow(index, item);
}

/**
 * @brief Removes from the model the item with the specified id.
 * @param id Id of the resource to remove.
 */
void ResourceModel::remove_id(const QString& id) {

  const QStandardItem* item = get_element_item(id);
  if (item == nullptr) {
    return;
  }
  remove_element(id);
}

/**
 * @brief Adds to the model an item for the specified resource element.
 * @param element_id Id of the resource element to add.
 */
void ResourceModel::add_element(const QString& element_id) {

  QStringList files = element_id.split('/', QString::SkipEmptyParts);
  QStandardItem* parent = invisibleRootItem();
  while (files.size() > 1) {
    parent = find_or_create_dir_item(*parent, files.first());
    files.removeFirst();
  }

  QStandardItem* item = create_element_item(element_id);
  parent->appendRow(item);  // TODO insert at the correct position
}

/**
 * @brief Removes from the model the item of the specified resource element.
 * @param element_id Id of the resource element to remove.
 */
void ResourceModel::remove_element(const QString& element_id) {

  const QModelIndex& index = get_element_index(element_id);
  if (!index.isValid()) {
    return;
  }

  removeRow(index.row(), index.parent());
  items.remove(element_id);
}

/**
 * @brief Creates a new leaf item with the specified element id.
 * @param element_id Id of the element to create.
 * @return The created item.
 */
QStandardItem* ResourceModel::create_element_item(const QString& element_id) {

  QString description = get_database().get_description(
      resource_type, element_id);

  QString text = description;
  if (text.isEmpty()) {
    // No description available: fallback to the last part of the element id.
    text = element_id.section('/', -1, -1);
  }
  QStandardItem* item = new QStandardItem(text);
  item->setData(element_id, Qt::UserRole);
  items.insert(element_id, item);
  return item;
}

/**
 * @brief Returns the leaf item with the specified element id.
 * @param element_id Id of the element to get.
 * @return The item or nullptr if it does not exist.
 */
const QStandardItem* ResourceModel::get_element_item(const QString& element_id) const {

  const auto& it = items.find(element_id);
  if (it == items.end()) {
    return nullptr;
  }

  return it.value();
}

/**
 * @brief Returns the leaf item with the specified element id.
 *
 * Non-const version.
 *
 * @param element_id Id of the element to get.
 * @return The item or nullptr if it does not exist.
 */
QStandardItem* ResourceModel::get_element_item(const QString& element_id) {

  const auto& it = items.find(element_id);
  if (it == items.end()) {
    return nullptr;
  }

  return it.value();
}

/**
 * @brief Returns the item with the specified directory name.
 * @param parent The parent item.
 * @param dir_name Name of the subdirectory to get.
 * @return The child. It is created if it does not exist yet.
 */
QStandardItem* ResourceModel::find_or_create_dir_item(
    QStandardItem& parent, const QString& dir_name) {

  for (int i = 0; i < parent.rowCount(); ++i) {
    QStandardItem* child = parent.child(i, 0);
    QString name = child->data(Qt::DisplayRole).toString();
    if (name == dir_name) {
      return child;
    }

    if (name > dir_name) {
      child = create_dir_item(dir_name);
      parent.insertRow(i, child);
      return child;
    }
  }

  QStandardItem* child = create_dir_item(dir_name);
  parent.appendRow(child);
  return child;
}

/**
 * @brief Creates a new item with the specified directory name.
 * @param dir_name Name of a directory.
 * @return The created item.
 */
QStandardItem* ResourceModel::create_dir_item(const QString& dir_name) {

  QStandardItem* item = new QStandardItem(dir_name);
  item->setSelectable(false);
  return item;
}

/**
 * @brief Returns an icon for the given element.
 * @param element_id Id of a resource element.
 * @return An appropriate icon.
 */
QIcon ResourceModel::create_icon(const QString& element_id) const {

  const Quest& quest = get_quest();
  Q_ASSERT(!element_id.isEmpty());
  Q_ASSERT(quest.get_database().exists(resource_type, element_id));

  try {
    if (resource_type == ResourceType::SPRITE) {
      // Special case of sprites: show the sprite icon.
      if (quest.exists(quest.get_sprite_path(element_id))) {
        SpriteModel sprite(quest, element_id);
        sprite.set_tileset_id(tileset_id);
        const QPixmap& pixmap = sprite.get_icon();
        if (!pixmap.isNull()) {
          return QIcon(pixmap);
        }
      }
    }
    else if (resource_type == ResourceType::ENEMY) {
      // Enemy: show the enemy's sprite.
      QString sprite_id = QString("enemies/%1").arg(element_id);
      SpriteModel sprite(quest, sprite_id);
      sprite.set_tileset_id(tileset_id);
      const QPixmap& pixmap = sprite.get_icon();
      if (!pixmap.isNull()) {
        return QIcon(pixmap);
      }
    }
    else if (resource_type == ResourceType::ITEM) {
      // Item: show the treasure's sprite.
      QString sprite_id = "entities/items";
      SpriteModel sprite(quest, sprite_id);
      sprite.set_tileset_id(tileset_id);
      const QPixmap& pixmap = sprite.get_direction_icon({ element_id, 0 });
      if (!pixmap.isNull()) {
        return QIcon(pixmap);
      }
    }
  }
  catch (const EditorException&) {
    // The sprite is missing: just return the generic
    // icon instead.
  }

  // Return an icon representing the resource type.
  QString resource_type_name = quest.get_database().get_lua_name(resource_type);
  return QIcon(":/images/icon_resource_" + resource_type_name + ".png");
}

/**
 * @brief Slot called when a resource element is added to the quest.
 * @param type A type of resource.
 * @param id Id of the element added.
 * @param description Description of the element added.
 */
void ResourceModel::element_added(
    ResourceType type, const QString& id, const QString& /* description */) {

  if (type != this->resource_type) {
    return;
  }

  // Add an item to the model.
  add_element(id);
}

/**
 * @brief Slot called when a resource element is removed from the quest.
 * @param type A type of resource.
 * @param id Id of the element removed.
 */
void ResourceModel::element_removed(
    ResourceType type, const QString& id) {

  if (type != this->resource_type) {
    return;
  }

  // Remove the item from the model.
  remove_element(id);
}

/**
 * @brief Slot called when a resource element is renamed.
 * @param type A type of resource.
 * @param old_id Id of the element before rename.
 * @param new_id Id of the element after rename.
 */
void ResourceModel::element_renamed(
    ResourceType type, const QString& old_id, const QString& new_id) {

  if (type != this->resource_type) {
    return;
  }

  QStandardItem* item = get_element_item(old_id);
  if (item == nullptr) {
    // Item not found, maybe it has been removed dynamicaly
    // (e.g. in StringsEditor).
    return;
  }

  item->setData(new_id, Qt::UserRole);

  items.remove(old_id);
  items.insert(new_id, item);
  // TODO update the order
}

/**
 * @brief Slot called when the description of a resource element changes.
 * @param type A type of resource.
 * @param id Id of the element.
 * @param new_description The new description.
 */
void ResourceModel::element_description_changed(
    ResourceType type, const QString& id, const QString& new_description) {

  if (type != this->resource_type) {
    return;
  }

  QStandardItem* item = get_element_item(id);
  if (item == nullptr) {
    // Item not found, maybe it has been removed dynamically
    // (e.g. in StringsEditor).
    return;
  }

  item->setData(new_description, Qt::DisplayRole);
}

/**
 * @brief Returns the data of an item.
 *
 * Reimplemented from QStandardItemModel to create sprite icons lazily.
 *
 * @param index Index of the item to get.
 * @param role The wanted role.
 * @return The corresponding data.
 */
QVariant ResourceModel::data(const QModelIndex& index, int role) const {

  // Don't use QStandardItemModel storage features for icons.
  // Load them on-demand instead.
  if (role == Qt::DecorationRole) {

    const QStandardItem* item = itemFromIndex(index);
    if (item == nullptr) {
      // Invalid index;
      return QVariant();
    }

    const QString& element_id = item->data(Qt::UserRole).toString();
    if (element_id.isEmpty()) {
      // Not a resource element: maybe a directory.
      if (rowCount(index) > 0) {
        return directory_icon;  // Directory item.
      }
      return QIcon();
    }

    if (!get_database().exists(resource_type, element_id)) {
      // Special item.
      return QIcon();
    }

    // Resource element item.
    Q_ASSERT(!element_id.isEmpty());
    auto it = icons.find(element_id);
    if (it != icons.end()) {
      // Icon already loaded.
      return it.value();
    }
    else {
      // Icon not loaded yet.
      QIcon icon = create_icon(element_id);
      icons.insert(element_id, icon);
      return icon;
    }
  }

  return QStandardItemModel::data(index, role);
}

}