// Aseprite
// Copyright (C) 2019-2025  Igara Studio S.A.
// Copyright (C) 2001-2018  David Capello
//
// This program is distributed under the terms of
// the End-User License Agreement for Aseprite.

#ifdef HAVE_CONFIG_H
  #include "config.h"
#endif

#include "app/ui/editor/tool_loop_impl.h"

#include "app/app.h"
#include "app/cmd/add_slice.h"
#include "app/cmd/set_last_point.h"
#include "app/cmd/set_mask.h"
#include "app/color.h"
#include "app/color_utils.h"
#include "app/console.h"
#include "app/context.h"
#include "app/context_access.h"
#include "app/doc_undo.h"
#include "app/i18n/strings.h"
#include "app/modules/gui.h"
#include "app/modules/palettes.h"
#include "app/pref/preferences.h"
#include "app/tools/controller.h"
#include "app/tools/freehand_algorithm.h"
#include "app/tools/ink.h"
#include "app/tools/intertwine.h"
#include "app/tools/point_shape.h"
#include "app/tools/symmetry.h"
#include "app/tools/tool.h"
#include "app/tools/tool_box.h"
#include "app/tools/tool_loop.h"
#include "app/tx.h"
#include "app/ui/color_bar.h"
#include "app/ui/context_bar.h"
#include "app/ui/editor/editor.h"
#include "app/ui/editor/editor_observer.h"
#include "app/ui/main_window.h"
#include "app/ui/optional_alert.h"
#include "app/ui/status_bar.h"
#include "app/ui_context.h"
#include "app/util/expand_cel_canvas.h"
#include "app/util/layer_utils.h"
#include "app/util/slice_utils.h"
#include "doc/brush.h"
#include "doc/cel.h"
#include "doc/image.h"
#include "doc/layer.h"
#include "doc/mask.h"
#include "doc/palette.h"
#include "doc/palette_picks.h"
#include "doc/remap.h"
#include "doc/slice.h"
#include "doc/sprite.h"
#include "fmt/format.h"
#include "render/dithering.h"
#include "render/rasterize.h"
#include "render/render.h"
#include "ui/ui.h"

#include <algorithm>
#include <memory>

namespace app {

using namespace ui;

static void fill_toolloop_params_from_tool_preferences(ToolLoopParams& params)
{
  ToolPreferences& toolPref = Preferences::instance().tool(params.tool);

  params.inkType = toolPref.ink();
  params.opacity = toolPref.opacity();
  params.tolerance = toolPref.tolerance();
  params.contiguous = toolPref.contiguous();
  params.freehandAlgorithm = toolPref.freehandAlgorithm();
}

//////////////////////////////////////////////////////////////////////
// Common properties between drawing/preview ToolLoop impl

class ToolLoopBase : public tools::ToolLoop {
protected:
  Editor* m_editor;
  tools::Tool* m_tool;
  BrushRef m_brush;
  BrushRef m_origBrush;
  gfx::Point m_oldPatternOrigin;
  Doc* m_document;
  Sprite* m_sprite;
  Layer* m_layer;
  frame_t m_frame;
  TilesetMode m_tilesetMode;
  RgbMap* m_rgbMap;
  DocumentPreferences& m_docPref;
  ToolPreferences& m_toolPref;
  int m_opacity;
  int m_tolerance;
  bool m_contiguous;
  bool m_snapToGrid;
  bool m_isSelectingTiles;
  doc::Grid m_grid;
  gfx::Rect m_gridBounds;
  gfx::Point m_celOrigin;
  gfx::Point m_mainTilePos;
  gfx::Point m_speed;
  tools::ToolLoop::Button m_button;
  std::unique_ptr<tools::Ink> m_ink;
  tools::Controller* m_controller;
  tools::PointShape* m_pointShape;
  tools::Intertwine* m_intertwine;
  tools::TracePolicy m_tracePolicy;
  std::unique_ptr<tools::Symmetry> m_symmetry;
  Shade m_shade;
  std::unique_ptr<doc::Remap> m_shadingRemap;
  bool m_tilesMode;
  app::ColorTarget m_colorTarget;
  doc::color_t m_fgColor;
  doc::color_t m_bgColor;
  doc::color_t m_primaryColor;
  doc::color_t m_secondaryColor;
  tools::DynamicsOptions m_dynamics;

  // Modifiers that can be used with scripts
  tools::ToolLoopModifiers m_staticToolModifiers;

  // Visible region (on the screen) of the all editors showing the
  // given document.
  gfx::Region m_allVisibleRgn;

  app::TiledModeHelper m_tiledModeHelper;

public:
  ToolLoopBase(Editor* editor, Site& site, const doc::Grid& grid, ToolLoopParams& params)
    : m_editor(editor)
    , m_tool(params.tool)
    , m_brush(params.brush)
    , m_origBrush(params.brush)
    , m_oldPatternOrigin(m_brush->patternOrigin())
    , m_document(site.document())
    , m_sprite(site.sprite())
    , m_layer(site.layer())
    , m_frame(site.frame())
    , m_tilesetMode(site.tilesetMode())
    , m_rgbMap(nullptr)
    , m_docPref(Preferences::instance().document(m_document))
    , m_toolPref(Preferences::instance().tool(m_tool))
    , m_opacity(params.opacity)
    , m_tolerance(params.tolerance)
    , m_contiguous(params.contiguous)
    , m_snapToGrid(m_docPref.grid.snap())
    , m_isSelectingTiles(false)
    , m_grid(grid)
    , m_gridBounds(grid.origin(), grid.tileSize())
    , m_mainTilePos(editor ? -editor->mainTilePosition() : gfx::Point(0, 0))
    , m_button(params.button)
    , m_ink(params.ink->clone())
    , m_controller(params.controller)
    , m_pointShape(m_tool->getPointShape(m_button))
    , m_intertwine(m_tool->getIntertwine(m_button))
    , m_tracePolicy(m_tool->getTracePolicy(m_button))
    , m_symmetry(nullptr)
    , m_tilesMode(site.tilemapMode() == TilemapMode::Tiles)
    , m_colorTarget(m_tilesMode ? ColorTarget(ColorTarget::BackgroundLayer, IMAGE_TILEMAP, 0) :
                    m_layer     ? ColorTarget(m_layer) :
                                  ColorTarget(ColorTarget::BackgroundLayer,
                                          m_sprite->pixelFormat(),
                                          m_sprite->transparentColor()))
    , m_fgColor(color_utils::color_for_target_mask(params.fg, m_colorTarget))
    , m_bgColor(color_utils::color_for_target_mask(params.bg, m_colorTarget))
    , m_primaryColor(m_button == tools::ToolLoop::Left ? m_fgColor : m_bgColor)
    , m_secondaryColor(m_button == tools::ToolLoop::Left ? m_bgColor : m_fgColor)
    , m_staticToolModifiers(params.modifiers)
    , m_tiledModeHelper(m_docPref.tiled.mode(), m_sprite)
  {
    ASSERT(m_tool);
    ASSERT(m_ink);
    ASSERT(m_controller);

    // If the user right-clicks with a custom/image brush we change
    // the image's colors of the brush to the background color.
    //
    // This is different from SwitchColors that makes a new brush
    // switching fg <-> bg colors, so here we have some extra
    // functionality with custom brushes (quickly convert the custom
    // brush with a plain color, or in other words, replace the custom
    // brush area with the background color).
    if (m_brush->type() == kImageBrushType && m_button == Right) {
      // We've to recalculate the background color to use for the
      // brush using the specific brush image pixel format/color mode,
      // as we cannot use m_primaryColor or m_bgColor here because
      // those are in the sprite pixel format/color mode.
      const color_t brushColor = color_utils::color_for_target_mask(
        Preferences::instance().colorBar.bgColor(),
        ColorTarget(ColorTarget::TransparentLayer, m_brush->image()->pixelFormat(), -1));

      // Clone the brush with new images to avoid modifying the
      // current brush used in left-click / brush preview.
      BrushRef newBrush = m_brush->cloneWithNewImages();
      newBrush->setImageColor(Brush::ImageColor::BothColors, brushColor);
      m_brush = newBrush;
    }

    if (m_tilesMode) {
      // Use FloodFillPointShape or TilePointShape in tiles mode
      if (!m_pointShape->isFloodFill()) {
        m_pointShape = App::instance()->toolBox()->getPointShapeById(
          tools::WellKnownPointShapes::Tile);
      }

      // In selection ink, we need the Pixels tilemap mode so
      // ExpandCelCanvas uses the whole canvas for the selection
      // preview.
      //
      // TODO in the future we could improve this, using 1) a special
      //      tilemap layer to preview the selection, or 2) using a
      //      path to show the selection (so there is no preview layer
      //      at all and nor ExpandCelCanvas)
      if (m_ink->isSelection() || m_ink->isSlice())
        site.tilemapMode(TilemapMode::Pixels);
    }

    if (m_controller->isFreehand() && !m_pointShape->isFloodFill() &&
        // TODO add dynamics support when UI is not enabled
        App::instance()->contextBar()) {
      m_dynamics = App::instance()->contextBar()->getDynamics();
    }

    if (m_tracePolicy == tools::TracePolicy::Accumulate) {
      tools::ToolBox* toolbox = App::instance()->toolBox();

      switch (params.freehandAlgorithm) {
        case tools::FreehandAlgorithm::DEFAULT:
          m_intertwine = toolbox->getIntertwinerById(tools::WellKnownIntertwiners::AsLines);
          break;
        case tools::FreehandAlgorithm::PIXEL_PERFECT:
          m_intertwine = toolbox->getIntertwinerById(tools::WellKnownIntertwiners::AsPixelPerfect);
          break;
        case tools::FreehandAlgorithm::DOTS:
          m_intertwine = toolbox->getIntertwinerById(tools::WellKnownIntertwiners::None);
          break;
      }

      // Use overlap trace policy for dynamic gradient
      if (m_dynamics.isDynamic() && m_dynamics.gradient != tools::DynamicSensor::Static &&
          m_controller->isFreehand() && !m_ink->isEraser()) {
        // Use overlap trace policy to accumulate changes of colors
        // between stroke points.
        //
        // TODO this is connected with a condition in tools::PaintInk::prepareInk()
        m_tracePolicy = tools::TracePolicy::Overlap;
      }
    }

    // Symmetry mode
    if (Preferences::instance().symmetryMode.enabled()) {
      if (m_docPref.symmetry.mode() != gen::SymmetryMode::NONE)
        m_symmetry.reset(new tools::Symmetry(m_docPref.symmetry.mode(),
                                             m_docPref.symmetry.xAxis(),
                                             m_docPref.symmetry.yAxis()));
    }

    // Ignore opacity for these inks
    if (!tools::inkHasOpacity(params.inkType) && m_brush->type() != kImageBrushType &&
        !m_ink->isEffect()) {
      m_opacity = 255;
    }

    if (params.inkType == tools::InkType::SHADING) {
      // TODO add shading support when UI is not enabled
      m_shade = App::instance()->contextBar()->getShade();
      m_shadingRemap.reset(
        App::instance()->contextBar()->createShadeRemap(m_button == tools::ToolLoop::Left));
    }

    updateAllVisibleRegion();
  }

  ~ToolLoopBase() { m_origBrush->setPatternOrigin(m_oldPatternOrigin); }

  void forceSnapToTiles()
  {
    m_snapToGrid = true;
    m_isSelectingTiles = true;
  }

  // IToolLoop interface
  tools::Tool* getTool() override { return m_tool; }
  Brush* getBrush() override { return m_brush.get(); }
  void setBrush(const BrushRef& newBrush) override { m_brush = newBrush; }
  Doc* getDocument() override { return m_document; }
  Sprite* sprite() override { return m_sprite; }
  Layer* getLayer() override { return m_layer; }
  const Cel* getCel() override { return nullptr; }
  bool isTilemapMode() override { return m_tilesMode; };
  bool isManualTilesetMode() const override { return m_tilesetMode == TilesetMode::Manual; }
  frame_t getFrame() override { return m_frame; }
  Palette* getPalette() override { return m_sprite->palette(m_frame); }
  RgbMap* getRgbMap() override
  {
    if (!m_rgbMap) {
      Sprite::RgbMapFor forLayer = (((m_layer && m_layer->isBackground()) ||
                                     (m_sprite->pixelFormat() == IMAGE_RGB)) ?
                                      Sprite::RgbMapFor::OpaqueLayer :
                                      Sprite::RgbMapFor::TransparentLayer);
      m_rgbMap = m_sprite->rgbMap(m_frame, forLayer);
    }
    return m_rgbMap;
  }
  ToolLoop::Button getMouseButton() override { return m_button; }
  doc::color_t getFgColor() override { return m_fgColor; }
  doc::color_t getBgColor() override { return m_bgColor; }
  doc::color_t getPrimaryColor() override { return m_primaryColor; }
  void setPrimaryColor(doc::color_t color) override { m_primaryColor = color; }
  doc::color_t getSecondaryColor() override { return m_secondaryColor; }
  void setSecondaryColor(doc::color_t color) override { m_secondaryColor = color; }
  int getOpacity() override { return m_opacity; }
  int getTolerance() override { return m_tolerance; }
  bool getContiguous() override { return m_contiguous; }
  tools::ToolLoopModifiers getModifiers() override
  {
    return (m_staticToolModifiers == tools::ToolLoopModifiers::kNone && m_editor ?
              m_editor->getToolLoopModifiers() :
              m_staticToolModifiers);
  }
  filters::TiledMode getTiledMode() override { return m_docPref.tiled.mode(); }
  bool getGridVisible() override { return m_docPref.show.grid(); }
  bool getSnapToGrid() override { return m_snapToGrid; }
  bool isSelectingTiles() override { return m_isSelectingTiles; }
  bool getStopAtGrid() override
  {
    switch (m_toolPref.floodfill.stopAtGrid()) {
      case app::gen::StopAtGrid::NEVER:      return false;
      case app::gen::StopAtGrid::IF_VISIBLE: return m_docPref.show.grid();
      case app::gen::StopAtGrid::ALWAYS:     return true;
    }
    return false;
  }

  bool isPixelConnectivityEightConnected() override
  {
    return (m_toolPref.floodfill.pixelConnectivity() ==
            app::gen::PixelConnectivity::EIGHT_CONNECTED);
  }

  bool isPointInsideCanvas(const gfx::Point& point) override
  {
    const int a = ((getTiledMode() == TiledMode::X_AXIS || getTiledMode() == TiledMode::BOTH) ? 3 :
                                                                                                1);
    const int b = ((getTiledMode() == TiledMode::Y_AXIS || getTiledMode() == TiledMode::BOTH) ? 3 :
                                                                                                1);
    return 0 <= point.x && point.x < a * sprite()->size().w && 0 <= point.y &&
           point.y < b * sprite()->size().h;
  }

  const doc::Grid& getGrid() const override { return m_grid; }
  gfx::Rect getGridBounds() override { return m_gridBounds; }
  gfx::Point getCelOrigin() override { return m_celOrigin; }
  bool needsCelCoordinates() override { return m_ink->needsCelCoordinates(); }
  void setSpeed(const gfx::Point& speed) override { m_speed = speed; }
  gfx::Point getSpeed() override { return m_speed; }
  tools::Ink* getInk() override { return m_ink.get(); }
  tools::Controller* getController() override { return m_controller; }
  tools::PointShape* getPointShape() override { return m_pointShape; }
  tools::Intertwine* getIntertwine() override { return m_intertwine; }
  tools::TracePolicy getTracePolicy() override
  {
    if (m_controller->handleTracePolicy())
      return m_controller->getTracePolicy();
    else
      return m_tracePolicy;
  }
  tools::Symmetry* getSymmetry() override { return m_symmetry.get(); }
  const Shade& getShade() override { return m_shade; }
  doc::Remap* getShadingRemap() override { return m_shadingRemap.get(); }

  void limitDirtyAreaToViewport(gfx::Region& rgn) override { rgn &= m_allVisibleRgn; }

  void updateDirtyArea(const gfx::Region& dirtyArea) override
  {
    if (!m_editor)
      return;

    // This is necessary here so the "on sprite crosshair" is hidden,
    // we update screen pixels with the new sprite, and then we show
    // the crosshair saving the updated pixels. It fixes problems with
    // filled shape tools when we release the button, or paint-bucket
    // when we press the button.
    HideBrushPreview hide(m_editor->brushPreview());

    m_document->notifySpritePixelsModified(m_sprite, dirtyArea, m_frame);
  }

  void updateStatusBar(const char* text) override
  {
    if (auto statusBar = StatusBar::instance())
      statusBar->setStatusText(0, text);
  }

  gfx::Point statusBarPositionOffset() override { return m_mainTilePos; }

  render::DitheringMatrix getDitheringMatrix() override
  {
    // TODO add support when UI is not enabled
    return App::instance()->contextBar()->ditheringMatrix();
  }

  render::DitheringAlgorithmBase* getDitheringAlgorithm() override
  {
    // TODO add support when UI is not enabled
    return App::instance()->contextBar()->ditheringAlgorithm();
  }

  render::GradientType getGradientType() override
  {
    // TODO add support when UI is not enabled
    return App::instance()->contextBar()->gradientType();
  }

  tools::DynamicsOptions getDynamics() override { return m_dynamics; }

  void onSliceRect(const gfx::Rect& bounds) override {}

  const app::TiledModeHelper& getTiledModeHelper() override { return m_tiledModeHelper; }

  // Used by selection tools
  bool isSelectionToolLoop() const override { return false; }
  void addSelectionToolPoint(const gfx::Rect& rc) override {};
  void clearSelectionToolMask(const bool finalStep) override {};

  ExpandCelCanvas* expandCelCanvas() const override { return nullptr; }

protected:
  void updateAllVisibleRegion()
  {
    m_allVisibleRgn.clear();
    // TODO use the context given to the ToolLoopImpl ctor
    for (auto e : UIContext::instance()->getAllEditorsIncludingPreview(m_document)) {
      gfx::Region viewportRegion;
      e->getDrawableRegion(viewportRegion, Widget::kCutTopWindows);
      for (auto rc : viewportRegion) {
        gfx::Region subrgn(e->screenToEditor(rc));
        e->collapseRegionByTiledMode(subrgn);
        m_allVisibleRgn |= subrgn;
      }
    }
  }
};

//////////////////////////////////////////////////////////////////////
// Common properties between drawing/selection ToolLoop impl

class PaintToolLoopBase : public ToolLoopBase,
                          public EditorObserver {
protected:
  Context* m_context;
  Mask* m_mask;
  gfx::Point m_maskOrigin;
  bool m_internalCancel = false;
  Tx m_tx;
  Image* m_floodfillSrcImage;
  bool m_saveLastPoint;

public:
  PaintToolLoopBase(Editor* editor,
                    Site& site,
                    const doc::Grid& grid,
                    Context* context,
                    ToolLoopParams& params,
                    const bool saveLastPoint)
    : ToolLoopBase(editor, site, grid, params)
    , m_context(context)
    , m_tx(Tx::DontLockDoc,
           m_context,
           m_context->activeDocument(),
           m_tool->getText().c_str(),
           ((m_ink->isSelection() || m_ink->isEyedropper() || m_ink->isScrollMovement() ||
             m_ink->isSlice() || m_ink->isZoom()) ?
              DoesntModifyDocument :
              ModifyDocument))
    , m_floodfillSrcImage(nullptr)
    , m_saveLastPoint(saveLastPoint)
  {
  }

  ~PaintToolLoopBase()
  {
    if (m_editor)
      m_editor->remove_observer(this);
  }

  void constructor_prologue()
  {
    if (m_pointShape->isFloodFill()) {
      if (m_tilesMode && !isSelectionToolLoop()) {
        // This will be set later to getSrcImage()
        m_floodfillSrcImage = nullptr;
      }
      // Prepare a special image for floodfill when it's configured to
      // stop using all visible layers.
      else if (m_toolPref.floodfill.referTo() == gen::FillReferTo::ALL_LAYERS) {
        m_floodfillSrcImage =
          Image::create(m_sprite->pixelFormat(), m_sprite->width(), m_sprite->height());

        m_floodfillSrcImage->clear(m_sprite->transparentColor());

        render::Render render;
        render.setNewBlend(Preferences::instance().experimental.newBlend());
        render.renderSprite(m_floodfillSrcImage, m_sprite, m_frame, gfx::Clip(m_sprite->bounds()));
      }
      else if (Cel* cel = m_layer->cel(m_frame)) {
        m_floodfillSrcImage = render::rasterize_with_sprite_bounds(cel);
      }
      else if (isSelectionToolLoop() && !m_layer->cel(m_frame)) {
        m_floodfillSrcImage =
          Image::create(m_sprite->pixelFormat(), m_sprite->width(), m_sprite->height());

        m_floodfillSrcImage->clear(m_sprite->transparentColor());
      }
    }
  }

  void constructor_epilogue()
  {
    m_mask = m_document->mask();
    m_maskOrigin = (!m_mask->isEmpty() ? gfx::Point(m_mask->bounds().x - m_celOrigin.x,
                                                    m_mask->bounds().y - m_celOrigin.y) :
                                         gfx::Point(0, 0));

    if (m_editor)
      m_editor->add_observer(this);
  }

  // IToolLoop interface
  bool needsCelCoordinates() override
  {
    if (m_tilesMode) {
      // When we are painting with tiles, we don't need to adjust the
      // coordinates by the cel position in PointShape (points will be
      // in tiles position relative to the tilemap origin already).
      return false;
    }
    else
      return ToolLoopBase::needsCelCoordinates();
  }

  const Image* getFloodFillSrcImage() override { return m_floodfillSrcImage; }
  Mask* getMask() override { return m_mask; }
  void setMask(Mask* newMask) override { m_tx(new cmd::SetMask(m_document, newMask)); }
  gfx::Point getMaskOrigin() override { return m_maskOrigin; }

  void onSliceRect(const gfx::Rect& bounds) override
  {
    // TODO add support for slice tool from batch scripts without UI?
    if (m_editor && getMouseButton() == ToolLoop::Left) {
      // Try to select slices, but if it returns false, it means that
      // there are no slices in the box to be selected, so we show a
      // popup menu to create a new one.
      if (!m_editor->selectSliceBox(bounds) && (bounds.w > 1 || bounds.h > 1)) {
        Slice* slice = new Slice;
        slice->setName(get_unique_slice_name(m_sprite));

        const frame_t keyFrame = (Preferences::instance().slices.useKeys() ? getFrame() : 0);

        SliceKey key(bounds);
        slice->insert(keyFrame, key);

        auto color = Preferences::instance().slices.defaultColor();
        slice->userData().setColor(
          doc::rgba(color.getRed(), color.getGreen(), color.getBlue(), color.getAlpha()));

        m_tx(new cmd::AddSlice(m_sprite, slice));
        return;
      }
    }

    // Cancel the operation (do not create a new transaction for this
    // no-op, e.g. just change the set of selected slices).
    m_internalCancel = true;
  }

private:
  // EditorObserver impl
  void onScrollChanged(Editor* editor) override { updateAllVisibleRegion(); }
  void onZoomChanged(Editor* editor) override { updateAllVisibleRegion(); }
};

//////////////////////////////////////////////////////////////////////
// For drawing

class ToolLoopImpl final : public PaintToolLoopBase {
public:
  ToolLoopImpl(Editor* editor,
               Site& site,
               const doc::Grid& grid,
               Context* context,
               ToolLoopParams& params,
               const bool saveLastPoint)
    : PaintToolLoopBase(editor, site, grid, context, params, saveLastPoint)
  {
    constructor_prologue();

    // 'isSelectionPreview = true' if the intention is to show a preview
    // of Selection tools or Slice tool.
    const bool isSelectionPreview = m_ink->isSelection() || m_ink->isSlice();
    m_expandCelCanvas.reset(new ExpandCelCanvas(
      site,
      m_layer,
      m_docPref.tiled.mode(),
      m_tx,
      ExpandCelCanvas::Flags(
        ExpandCelCanvas::NeedsSource |
        (m_layer->isTilemap() && (!m_tilesMode || isSelectionPreview) ?
           ExpandCelCanvas::PixelsBounds :
           ExpandCelCanvas::None) |
        (m_layer->isTilemap() && site.tilemapMode() == TilemapMode::Pixels &&
             site.tilesetMode() == TilesetMode::Manual && !isSelectionPreview ?
           ExpandCelCanvas::TilesetPreview :
           ExpandCelCanvas::None) |
        (isSelectionPreview ? ExpandCelCanvas::SelectionPreview : ExpandCelCanvas::None))));

    if (!m_floodfillSrcImage)
      m_floodfillSrcImage = const_cast<Image*>(getSrcImage());

    // Settings
    switch (m_tool->getFill(m_button)) {
      case tools::FillNone:     m_filled = false; break;
      case tools::FillAlways:   m_filled = true; break;
      case tools::FillOptional: m_filled = m_toolPref.filled(); break;
    }

    m_previewFilled = m_toolPref.filledPreview();
    m_sprayWidth = m_toolPref.spray.width();
    m_spraySpeed = m_toolPref.spray.speed();

    if (isSelectionPreview) {
      m_useMask = false;
    }
    else {
      m_useMask = m_document->isMaskVisible();
    }

    // Start with an empty mask if the user is selecting with "default selection mode"
    if (isSelectionPreview &&
        (!m_document->isMaskVisible() ||
         (int(getModifiers()) & int(tools::ToolLoopModifiers::kReplaceSelection)) != 0)) {
      Mask emptyMask;
      m_tx(new cmd::SetMask(m_document, &emptyMask));
    }

    // Setup the new grid of ExpandCelCanvas which can be displaced to
    // match the new temporal cel position (m_celOrigin).
    m_grid = m_expandCelCanvas->getGrid();
    m_celOrigin = m_expandCelCanvas->getCelOrigin();

    constructor_epilogue();
  }

  ~ToolLoopImpl()
  {
    // getSrcImage() is a virtual member function but ToolLoopImpl is
    // marked as final to avoid not calling a derived version from
    // this destructor.
    if (m_floodfillSrcImage != getSrcImage())
      delete m_floodfillSrcImage;
  }

  // IToolLoop interface
  void commit() override
  {
    bool redraw = false;

    if (!m_internalCancel) {
      // Freehand changes the last point
      if (m_saveLastPoint) {
        m_tx(new cmd::SetLastPoint(m_document, getController()->getLastPoint().toPoint()));
      }

      // Paint ink
      if (m_ink->isPaint()) {
        try {
          ContextReader reader(m_context, 500);
          ContextWriter writer(reader);
          m_expandCelCanvas->commit();
        }
        catch (const LockedDocException& ex) {
          Console::showException(ex);
        }
      }
      // Selection ink
      else if (m_ink->isSelection()) {
        redraw = true;

        // Show selection edges
        if (Preferences::instance().selection.autoShowSelectionEdges())
          m_docPref.show.selectionEdges(true);
      }
      // Slice ink
      else if (m_ink->isSlice()) {
        redraw = true;
      }

      m_tx.commit();
    }
    else {
      rollback();
    }

    if (redraw)
      update_screen_for_document(m_document);
  }

  void rollback() override
  {
    try {
      ContextReader reader(m_context, 500);
      ContextWriter writer(reader);
      m_expandCelCanvas->rollback();
    }
    catch (const LockedDocException& ex) {
      Console::showException(ex);
    }
    update_screen_for_document(m_document);
  }

  const Cel* getCel() override { return m_expandCelCanvas->getCel(); }
  const Image* getSrcImage() override { return m_expandCelCanvas->getSourceCanvas(); }
  Image* getDstImage() override { return m_expandCelCanvas->getDestCanvas(); }
  Tileset* getDstTileset() override { return m_expandCelCanvas->getDestTileset(); }
  void validateSrcImage(const gfx::Region& rgn) override
  {
    m_expandCelCanvas->validateSourceCanvas(rgn);
  }
  void validateDstImage(const gfx::Region& rgn) override
  {
    m_expandCelCanvas->validateDestCanvas(rgn);
  }
  void validateDstTileset(const gfx::Region& rgn) override
  {
    m_expandCelCanvas->validateDestTileset(rgn, getIntertwine()->forceTilemapRegionToValidate());
  }
  void invalidateDstImage() override { m_expandCelCanvas->invalidateDestCanvas(); }
  void invalidateDstImage(const gfx::Region& rgn) override
  {
    m_expandCelCanvas->invalidateDestCanvas(rgn);
  }
  void copyValidDstToSrcImage(const gfx::Region& rgn) override
  {
    m_expandCelCanvas->copyValidDestToSourceCanvas(rgn);
  }

  bool useMask() override { return m_useMask; }
  bool getFilled() override { return m_filled; }
  bool getPreviewFilled() override { return m_previewFilled; }
  int getSprayWidth() override { return m_sprayWidth; }
  int getSpraySpeed() override { return m_spraySpeed; }

  ExpandCelCanvas* expandCelCanvas() const override { return m_expandCelCanvas.get(); }

private:
  bool m_filled;
  bool m_previewFilled;
  int m_sprayWidth;
  int m_spraySpeed;
  bool m_useMask;
  std::unique_ptr<ExpandCelCanvas> m_expandCelCanvas;
};

//////////////////////////////////////////////////////////////////////
// For selection tools

class SelectionToolLoopImpl final : public PaintToolLoopBase {
public:
  SelectionToolLoopImpl(Editor* editor,
                        Site& site,
                        const doc::Grid& grid,
                        Context* context,
                        ToolLoopParams& params,
                        const bool saveLastPoint)
    : PaintToolLoopBase(editor, site, grid, context, params, saveLastPoint)
  {
    constructor_prologue();

    // Start with an empty mask if the user is selecting with "default selection mode"
    if (!m_document->isMaskVisible() ||
        (int(getModifiers()) & int(tools::ToolLoopModifiers::kReplaceSelection)) != 0) {
      Mask emptyMask;
      m_tx(new cmd::SetMask(m_document, &emptyMask));
    }

    m_editor->makeSelectionToolMask();
    constructor_epilogue();
  }

  ~SelectionToolLoopImpl()
  {
    m_editor->deleteSelectionToolMask();
    delete m_floodfillSrcImage;
  }

  // For drawing the selection to second mask
  bool isSelectionToolLoop() const override { return true; }
  void addSelectionToolPoint(const gfx::Rect& rc) override
  {
    if (rc.w >= 1 && rc.h >= 1)
      m_editor->getSelectionToolMask()->add(rc);
  }

  void clearSelectionToolMask(const bool finalStep) override
  {
    if (finalStep || getTracePolicy() == tools::TracePolicy::Last)
      m_editor->getSelectionToolMask()->clear();
  }

  // IToolLoop interface
  void commit() override
  {
    bool redraw = false;

    if (!m_internalCancel) {
      // Freehand changes the last point
      if (m_saveLastPoint) {
        m_tx(new cmd::SetLastPoint(m_document, getController()->getLastPoint().toPoint()));
      }

      // Selection ink
      redraw = true;
      if (m_ink->isSelection() && Preferences::instance().selection.autoShowSelectionEdges()) {
        // Show selection edges
        m_docPref.show.selectionEdges(true);
      }

      m_tx.commit();
    }
    else {
      rollback();
    }

    if (redraw)
      update_screen_for_document(m_document);
  }
  void rollback() override {}

  const Image* getSrcImage() override { return m_floodfillSrcImage; }
  Image* getDstImage() override { return nullptr; }
  Tileset* getDstTileset() override { return nullptr; }
  void validateSrcImage(const gfx::Region& rgn) override {}
  void validateDstImage(const gfx::Region& rgn) override {}
  void validateDstTileset(const gfx::Region& rgn) override {}
  void invalidateDstImage() override {}
  void invalidateDstImage(const gfx::Region& rgn) override {}
  void copyValidDstToSrcImage(const gfx::Region& rgn) override {}

  bool useMask() override { return false; }
  bool getFilled() override { return true; }
  bool getPreviewFilled() override { return getTracePolicy() == tools::TracePolicy::Last; }
  int getSprayWidth() override { return 0; }
  int getSpraySpeed() override { return 0; }
};

//////////////////////////////////////////////////////////////////////
// For user UI painting

// TODO add inks for tilemaps
static void adjust_ink_for_tilemaps(const Site& site, ToolLoopParams& params)
{
  if (!params.ink->isSelection() && !params.ink->isEraser() && !params.ink->isSlice()) {
    params.ink = App::instance()->toolBox()->getInkById(tools::WellKnownInks::PaintCopy);
  }
}

tools::ToolLoop* create_tool_loop(Editor* editor,
                                  Context* context,
                                  const tools::Pointer::Button button,
                                  const bool convertLineToFreehand,
                                  const bool selectTiles)
{
  Site site = editor->getSite();
  doc::Grid grid = site.grid();

  // If the document is read-only.
  if (site.document()->isReadOnly()) {
    StatusBar::instance()->showTip(3000, Strings::statusbar_tips_cannot_modify_readonly_sprite());
    return nullptr;
  }

  ToolLoopParams params;
  params.tool = editor->getCurrentEditorTool();
  params.ink = editor->getCurrentEditorInk();

  if (site.tilemapMode() == TilemapMode::Tiles) {
    adjust_ink_for_tilemaps(site, params);
  }

  if (!params.tool || !params.ink)
    return nullptr;

  if (selectTiles) {
    params.tool = App::instance()->toolBox()->getToolById(
      tools::WellKnownTools::RectangularMarquee);
    params.ink = params.tool->getInk(button == tools::Pointer::Left ? 0 : 1);
  }

  // For selection tools, we can use any layer (even without layers at
  // all), so we specify a nullptr here as the active layer. This is
  // used as a special case by the render::Render class to show the
  // preview image/selection stroke as a xor'd overlay in the render
  // result.
  //
  // Anyway this cannot be used in 'magic wand' tool (isSelection +
  // isFloodFill) because we need the original layer source
  // image/pixels to stop the flood-fill algorithm.
  if (params.ink->isSelection() &&
      !params.tool->getPointShape(button != tools::Pointer::Left ? 1 : 0)->isFloodFill()) {
    // Don't call site.layer(nullptr) because we want to keep the
    // site.layer() to know if we are in a tilemap layer
  }
  else {
    Layer* layer = site.layer();
    if (!layer) {
      StatusBar::instance()->showTip(1000, Strings::statusbar_tips_no_active_layers());
      return nullptr;
    }
    else if (!layer->isVisibleHierarchy()) {
      auto& toolPref = Preferences::instance().tool(params.tool);
      if (toolPref.floodfill.referTo() == app::gen::FillReferTo::ACTIVE_LAYER) {
        StatusBar::instance()->showTip(1000,
                                       Strings::statusbar_tips_layer_x_is_hidden(layer->name()));
        return nullptr;
      }
    }
    // If the active layer is read-only.
    else if (layer_is_locked(editor)) {
      return nullptr;
    }
    // If the active layer is reference.
    else if (layer->isReference()) {
      StatusBar::instance()->showTip(
        1000,
        Strings::statusbar_tips_unmodifiable_reference_layer(layer->name()));
      return nullptr;
    }
  }

  // Get fg/bg colors
  ColorBar* colorbar = ColorBar::instance();
  if (site.tilemapMode() == TilemapMode::Tiles) {
    params.fg = app::Color::fromTile(colorbar->getFgTile());
    params.bg = app::Color::fromTile(colorbar->getBgTile());
  }
  else {
    params.fg = colorbar->getFgColor();
    params.bg = colorbar->getBgColor();
    if (!params.fg.isValid() || !params.bg.isValid()) {
      if (Preferences::instance().colorBar.showInvalidFgBgColorAlert()) {
        OptionalAlert::show(Preferences::instance().colorBar.showInvalidFgBgColorAlert,
                            1,
                            Strings::alerts_invalid_fg_or_bg_colors());
        return nullptr;
      }
    }
  }

  // Create the new tool loop
  try {
    params.button = (button == tools::Pointer::Left ? tools::ToolLoop::Left :
                                                      tools::ToolLoop::Right);

    params.controller = (convertLineToFreehand ? App::instance()->toolBox()->getControllerById(
                                                   tools::WellKnownControllers::LineFreehand) :
                                                 params.tool->getController(params.button));

    const bool saveLastPoint = (params.ink->isPaint() &&
                                (params.controller->isFreehand() || convertLineToFreehand));

    params.brush = App::instance()->contextBar()->activeBrush(params.tool, params.ink);

    fill_toolloop_params_from_tool_preferences(params);

    ASSERT(context->activeDocument() == editor->document());
    if (Preferences::instance().experimental.useSelectionToolLoop() &&
        (params.ink->isSelection() || params.ink->isSlice())) {
      auto* toolLoop =
        new SelectionToolLoopImpl(editor, site, grid, context, params, saveLastPoint);
      if (selectTiles)
        toolLoop->forceSnapToTiles();

      return toolLoop;
    }
    auto* toolLoop = new ToolLoopImpl(editor, site, grid, context, params, saveLastPoint);
    if (selectTiles)
      toolLoop->forceSnapToTiles();

    return toolLoop;
  }
  catch (const std::exception& ex) {
    Console::showException(ex);
    return NULL;
  }
}

//////////////////////////////////////////////////////////////////////
// For scripting

#ifdef ENABLE_SCRIPTING

tools::ToolLoop* create_tool_loop_for_script(Context* context,
                                             const Site& site,
                                             ToolLoopParams& params)
{
  ASSERT(params.tool);
  ASSERT(params.ink);
  if (!site.layer())
    return nullptr;

  try {
    // If we don't have the UI available, we reset the tools
    // preferences, so scripts that are executed in batch mode have a
    // reproducible behavior.
    if (!context->isUIAvailable())
      Preferences::instance().resetToolPreferences(params.tool);

    Site site2(site);
    return new ToolLoopImpl(nullptr, site2, site2.grid(), context, params, false);
  }
  catch (const std::exception& ex) {
    Console::showException(ex);
    return nullptr;
  }
}

#endif // ENABLE_SCRIPTING

//////////////////////////////////////////////////////////////////////
// For UI preview

class PreviewToolLoopImpl final : public ToolLoopBase {
  Image* m_image;

public:
  PreviewToolLoopImpl(Editor* editor,
                      Site& site,
                      ToolLoopParams& params,
                      Image* image,
                      const gfx::Point& celOrigin)
    : ToolLoopBase(editor, site, site.grid(), params)
    , m_image(image)
  {
    m_celOrigin = celOrigin;

    // Avoid preview for spray and flood fill like tools
    if (m_pointShape->isSpray()) {
      m_pointShape = App::instance()->toolBox()->getPointShapeById(
        tools::WellKnownPointShapes::Brush);
    }
    else if (m_pointShape->isFloodFill()) {
      const char* id;
      if (m_tilesMode)
        id = tools::WellKnownPointShapes::Tile;
      else if (m_brush->type() == BrushType::kImageBrushType)
        id = tools::WellKnownPointShapes::Brush;
      else
        id = tools::WellKnownPointShapes::Pixel;
      m_pointShape = App::instance()->toolBox()->getPointShapeById(id);
    }
  }

  // IToolLoop interface
  void commit() override {}
  void rollback() override {}
  const Image* getSrcImage() override { return m_image; }
  const Image* getFloodFillSrcImage() override { return m_image; }
  Image* getDstImage() override { return m_image; }
  Tileset* getDstTileset() override { return nullptr; }
  void validateSrcImage(const gfx::Region& rgn) override {}
  void validateDstImage(const gfx::Region& rgn) override {}
  void validateDstTileset(const gfx::Region& rgn) override {}
  void invalidateDstImage() override {}
  void invalidateDstImage(const gfx::Region& rgn) override {}
  void copyValidDstToSrcImage(const gfx::Region& rgn) override {}

  bool isManualTilesetMode() const override
  {
    // Return false because this is only the preview, so we avoid
    // creating a new tileset
    return false;
  }

  bool useMask() override { return false; }
  Mask* getMask() override { return nullptr; }
  void setMask(Mask* newMask) override {}
  gfx::Point getMaskOrigin() override { return gfx::Point(0, 0); }
  bool getFilled() override { return false; }
  bool getPreviewFilled() override { return false; }
  int getSprayWidth() override { return 0; }
  int getSpraySpeed() override { return 0; }

  tools::DynamicsOptions getDynamics() override
  {
    // Preview without dynamics
    return tools::DynamicsOptions();
  }
};

tools::ToolLoop* create_tool_loop_preview(Editor* editor,
                                          const doc::BrushRef& brush,
                                          Image* image,
                                          const gfx::Point& celOrigin)
{
  Site site = editor->getSite();

  ToolLoopParams params;
  params.tool = editor->getCurrentEditorTool();
  params.ink = editor->getCurrentEditorInk();

  if (site.tilemapMode() == TilemapMode::Tiles && image->pixelFormat() == IMAGE_TILEMAP) {
    adjust_ink_for_tilemaps(site, params);
  }

  if (!params.tool || !params.ink)
    return nullptr;

  Layer* layer = editor->layer();
  if (!layer || !layer->isVisibleHierarchy() || !layer->isEditableHierarchy() ||
      layer->isReference()) {
    return nullptr;
  }

  // Get fg/bg colors
  ColorBar* colorbar = ColorBar::instance();
  if (site.tilemapMode() == TilemapMode::Tiles) {
    params.fg = app::Color::fromTile(colorbar->getFgTile());
    params.bg = app::Color::fromTile(colorbar->getBgTile());
  }
  else {
    params.fg = colorbar->getFgColor();
    params.bg = colorbar->getBgColor();
    if (!params.fg.isValid() || !params.bg.isValid())
      return nullptr;
  }

  params.brush = brush;
  params.button = tools::ToolLoop::Left;
  params.controller = params.tool->getController(params.button);

  // Create the new tool loop
  try {
    fill_toolloop_params_from_tool_preferences(params);

    return new PreviewToolLoopImpl(editor, site, params, image, celOrigin);
  }
  catch (const std::exception& e) {
    LOG(ERROR, e.what());
    return nullptr;
  }
}

//////////////////////////////////////////////////////////////////////

} // namespace app
