Refactor getLayerIndexFromSprite into LayerGroup

We don't have an Aseprite.app target in cmake files yet, but we might
add it in a near future.

build.sh

@@ -428,9 +428,17 @@ if [ ! -d "$skia_library_dir" ] ; then
         skia_url=$(bash laf/misc/skia-url.sh $skia_build)
         skia_file=$(basename $skia_url)
         if [ ! -f "$skia_dir/$skia_file" ] ; then
+            if ! command -v curl >/dev/null 2>&1 ; then
+                echo "Error: 'curl' command line tool is not available in PATH"
+                exit 1
+            fi
             curl --ssl-revoke-best-effort -L -o "$skia_dir/$skia_file" "$skia_url"
         fi
         if [ ! -d "$skia_library_dir" ] ; then
+            if ! command -v unzip >/dev/null 2>&1 ; then
+                echo "Error: 'unzip' command line tool is not available in PATH"
+                exit 1
+            fi
             unzip -n -d "$skia_dir" "$skia_dir/$skia_file"
         fi
     else

laf

@@ -1 +1 @@
-Subproject commit a2bb9ec7fb98354279a2c49870a4a47a67a8e86e
+Subproject commit 8ec4b553f1618f7a4b47cdcf4cfc2663266111ac

src/CMakeLists.txt

@@ -180,8 +180,8 @@ if(ENABLE_ASEPRITE_EXE)
 
   if(WIN32)
     set(main_resources
-      main/resources_win32.rc
-      main/settings.manifest)
+      main/win/resources_win32.rc
+      main/win/settings.manifest)
   endif()
 
   add_executable(${main_target}

src/app/file/gif_format.cpp

@@ -1095,6 +1095,9 @@ public:
     gifframe_t nframes = totalFrames();
     for (gifframe_t gifFrame = 0; gifFrame < nframes; ++gifFrame) {
       ASSERT(frame_it != frame_end);
+      if (m_fop->isStop())
+        break;
+
       frame_t frame = *frame_it;
       ++frame_it;
 

src/app/resource_finder.cpp

@@ -213,7 +213,7 @@ void ResourceFinder::includeDesktopDir(const char* filename)
 #ifdef _WIN32
 
   std::vector<wchar_t> buf(MAX_PATH);
-  HRESULT hr = SHGetFolderPath(NULL, CSIDL_DESKTOPDIRECTORY, NULL, SHGFP_TYPE_DEFAULT, &buf[0]);
+  HRESULT hr = SHGetFolderPath(NULL, CSIDL_DESKTOP, NULL, SHGFP_TYPE_CURRENT, &buf[0]);
   if (hr == S_OK) {
     addPath(base::join_path(base::to_utf8(&buf[0]), filename));
   }

src/app/script/dialog_class.cpp

@@ -127,12 +127,13 @@ struct Dialog {
   int showRef = LUA_REFNIL;
   lua_State* L = nullptr;
 
-  Dialog(const ui::Window::Type windowType, const std::string& title)
+  Dialog(const ui::Window::Type windowType, const std::string& title, bool sizeable)
     : window(windowType, title)
     , grid(2, false)
     , currentGrid(&grid)
   {
     window.addChild(&grid);
+    window.setSizeable(sizeable);
     all_dialogs.push_back(this);
   }
 
@@ -365,6 +366,7 @@ int Dialog_new(lua_State* L)
   // Get the title and the type of window (with or without title bar)
   ui::Window::Type windowType = ui::Window::WithTitleBar;
   std::string title = "Script";
+  bool sizeable = true;
   if (lua_isstring(L, 1)) {
     title = lua_tostring(L, 1);
   }
@@ -378,9 +380,14 @@ int Dialog_new(lua_State* L)
     if (type != LUA_TNIL && lua_toboolean(L, -1))
       windowType = ui::Window::WithoutTitleBar;
     lua_pop(L, 1);
+
+    type = lua_getfield(L, 1, "resizeable");
+    if (type != LUA_TNIL && !lua_toboolean(L, -1))
+      sizeable = false;
+    lua_pop(L, 1);
   }
 
-  auto dlg = push_new<Dialog>(L, windowType, title);
+  auto dlg = push_new<Dialog>(L, windowType, title, sizeable);
 
   // The uservalue of the dialog userdata will contain a table that
   // stores all the callbacks to handle events. As these callbacks can
@@ -1509,6 +1516,10 @@ int Dialog_modify(lua_State* L)
     type = lua_getfield(L, 2, "text");
     if (const char* s = lua_tostring(L, -1)) {
       widget->setText(s);
+
+      // Re-process mnemonics for buttons
+      if (widget->type() == WidgetType::kButtonWidget)
+        widget->processMnemonicFromText();
       relayout = true;
     }
     lua_pop(L, 1);

src/app/script/plugin_class.cpp

@@ -172,6 +172,7 @@ int Plugin_newCommand(lua_State* L)
       if (!group.empty() && App::instance()->isGui()) { // On CLI menus do not make sense
         if (auto appMenus = AppMenus::instance()) {
           auto menuItem = std::make_unique<AppMenuItem>(title, id);
+          menuItem->processMnemonicFromText();
           appMenus->addMenuItemIntoGroup(group, std::move(menuItem));
         }
       }

src/app/script/site_class.cpp

@@ -13,6 +13,8 @@
 #include "app/console.h"
 #include "app/context.h"
 #include "app/context_observer.h"
+#include "app/doc.h"
+#include "app/doc_undo.h"
 #include "app/script/docobj.h"
 #include "app/script/engine.h"
 #include "app/script/luacpp.h"

src/app/script/sprite_class.cpp

@@ -64,6 +64,7 @@
 #include "doc/tag.h"
 #include "doc/tileset.h"
 #include "doc/tilesets.h"
+#include "undo/undo_state.h"
 
 #include <algorithm>
 
@@ -1029,6 +1030,42 @@ int Sprite_set_useLayerUuids(lua_State* L)
   return 0;
 }
 
+int Sprite_get_undoHistory(lua_State* L)
+{
+  const auto* sprite = get_docobj<Sprite>(L, 1);
+  const auto* doc = static_cast<Doc*>(sprite->document());
+  const auto* history = doc->undoHistory();
+
+  if (!history) {
+    lua_pushnil(L);
+    return 1;
+  }
+
+  const undo::UndoState* currentState = history->currentState();
+  const undo::UndoState* s = history->firstState();
+  const bool canRedo = history->canRedo();
+  bool pastCurrent = !currentState && canRedo;
+
+  int undoSteps = 0;
+  int redoSteps = 0;
+  while (s) {
+    if (pastCurrent && canRedo)
+      redoSteps++;
+    else if (currentState || !canRedo)
+      undoSteps++;
+
+    if (s == currentState || !currentState)
+      pastCurrent = true;
+
+    s = s->next();
+  }
+
+  lua_newtable(L);
+  setfield_integer(L, "undoSteps", undoSteps);
+  setfield_integer(L, "redoSteps", redoSteps);
+  return 1;
+}
+
 const luaL_Reg Sprite_methods[] = {
   { "__eq",              Sprite_eq                },
   { "resize",            Sprite_resize            },
@@ -1094,6 +1131,7 @@ const Property Sprite_properties[] = {
   { "events",               Sprite_get_events,               nullptr                         },
   { "tileManagementPlugin", Sprite_get_tileManagementPlugin, Sprite_set_tileManagementPlugin },
   { "useLayerUuids",        Sprite_get_useLayerUuids,        Sprite_set_useLayerUuids        },
+  { "undoHistory",          Sprite_get_undoHistory,          nullptr                         },
   { nullptr,                nullptr,                         nullptr                         }
 };
 

src/app/ui/editor/editor.cpp

@@ -58,6 +58,7 @@
 #include "app/util/tile_flags_utils.h"
 #include "base/chrono.h"
 #include "base/convert_to.h"
+#include "base/scoped_value.h"
 #include "doc/doc.h"
 #include "doc/mask_boundaries.h"
 #include "doc/slice.h"
@@ -266,6 +267,23 @@ void Editor::setStateInternal(const EditorStatePtr& newState)
 {
   m_brushPreview.hide();
 
+  // Some onLeaveState impls (like the ones from MovingPixelsState,
+  // WritingTextState, MovingSelectionState) might generate a
+  // Tx/Transaction::commit(), which will add a new undo state,
+  // triggering a sprite change scripting event
+  // (SpriteEvents::onAddUndoState). This event could be handled by an
+  // extension and that extension might want to save the current
+  // sprite (e.g. calling Sprite_saveCopyAs, the kind of extension
+  // that takes snapshots after each sprite change). That will be a
+  // new Context::executeCommand() for the save command, generating a
+  // BeforeCommandExecution signal, getting back to onLeaveState
+  // again. In that case, we just ignore the reentry as the first
+  // onLeaveState should handle everything (to avoid an stack
+  // overflow/infinite recursion).
+  if (m_leavingState)
+    return;
+  base::ScopedValue leaving(m_leavingState, true);
+
   // Fire before change state event, set the state, and fire after
   // change state event.
   EditorState::LeaveAction leaveAction = m_state->onLeaveState(this, newState.get());

src/app/ui/editor/editor.h

@@ -1,5 +1,5 @@
 // Aseprite
-// Copyright (C) 2018-2024  Igara Studio S.A.
+// Copyright (C) 2018-2025  Igara Studio S.A.
 // Copyright (C) 2001-2018  David Capello
 //
 // This program is distributed under the terms of
@@ -458,6 +458,13 @@ private:
 
   DocView* m_docView;
 
+  // Special flag to avoid re-entering a new state when we are leaving
+  // the current one. This avoids an infinite onLeaveState() recursion
+  // in some special cases when an extension (third-party code)
+  // creates a new sprite change in the same sprite change scripting
+  // event.
+  bool m_leavingState = false;
+
   // Last known mouse position received by this editor when the
   // mouse button was pressed. Used for auto-scrolling. To get the
   // current mouse position on the editor you can use

src/app/ui/editor/writing_text_state.cpp

@@ -443,12 +443,7 @@ bool WritingTextState::onSetCursor(Editor* editor, const gfx::Point& mouseScreen
   return true;
 }
 
-bool WritingTextState::onKeyDown(Editor*, KeyMessage*)
-{
-  return false;
-}
-
-bool WritingTextState::onKeyUp(Editor*, KeyMessage* msg)
+bool WritingTextState::onKeyDown(Editor*, KeyMessage* msg)
 {
   // Cancel loop pressing Esc key
   if (msg->scancode() == ui::kKeyEsc) {
@@ -457,7 +452,17 @@ bool WritingTextState::onKeyUp(Editor*, KeyMessage* msg)
   // Drop text pressing Enter key
   else if (msg->scancode() == ui::kKeyEnter) {
     drop();
+    return true;
   }
+  return false;
+}
+
+bool WritingTextState::onKeyUp(Editor*, KeyMessage* msg)
+{
+  // Note: We cannot process kKeyEnter key here to drop the text as it
+  // could be received after the Enter key is pressed in the IME
+  // dialog to accept the composition (not to accept the text). So we
+  // process kKeyEnter in onKeyDown().
   return true;
 }
 

src/app/ui/timeline/timeline.cpp

@@ -4576,7 +4576,7 @@ void Timeline::onDrop(ui::DragEvent& e)
 
   // Determine at which frame and layer the content was dropped on.
   frame_t frame = m_frame;
-  layer_t layerIndex = getLayerIndex(m_layer);
+  layer_t layerIndex = m_sprite->root()->getLayerIndex(m_layer);
   InsertionPoint insert = InsertionPoint::BeforeLayer;
   DroppedOn droppedOn = DroppedOn::Unspecified;
   TRACE("m_dropRange.type() %d\n", m_dropRange.type());
@@ -4602,7 +4602,7 @@ void Timeline::onDrop(ui::DragEvent& e)
       break;
     case Range::kLayers:
       droppedOn = DroppedOn::Layer;
-      if (m_dropTarget.vhit != DropTarget::VeryBottom) {
+      if (m_dropTarget.vhit != DropTarget::VeryBottom && !m_dropRange.selectedLayers().empty()) {
         auto* selectedLayer = *m_dropRange.selectedLayers().begin();
         layerIndex = getLayerIndex(selectedLayer);
       }

src/doc/layer.cpp

@@ -597,4 +597,22 @@ void LayerGroup::displaceFrames(frame_t fromThis, frame_t delta)
     layer->displaceFrames(fromThis, delta);
 }
 
+layer_t LayerGroup::getLayerIndex(const Layer* layer, layer_t& index) const
+{
+  for (Layer* child : this->layers()) {
+    if ((child->isGroup() && static_cast<LayerGroup*>(child)->getLayerIndex(layer, index) != -1) ||
+        (child == layer)) {
+      return index;
+    }
+    index++;
+  }
+  return -1;
+}
+
+layer_t LayerGroup::getLayerIndex(const Layer* layer) const
+{
+  layer_t index = 0;
+  return this->getLayerIndex(layer, index);
+}
+
 } // namespace doc

src/doc/layer.h

@@ -236,9 +236,13 @@ public:
 
   bool isBrowsable() const override { return isGroup() && isExpanded() && !m_layers.empty(); }
 
+  layer_t getLayerIndex(const Layer* layer) const;
+
 private:
   void destroyAllLayers();
 
+  layer_t getLayerIndex(const Layer* layer, layer_t& index) const;
+
   LayerList m_layers;
 };
 

src/main/osx/Entitlements.plist

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>com.apple.security.cs.allow-dyld-environment-variables</key>
+    <true/>
+    <key>com.apple.security.cs.disable-library-validation</key>
+    <true/>
+</dict>
+</plist>

src/main/osx/Info.plist

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>CFBundleDocumentTypes</key>
+    <array>
+        <dict>
+            <key>CFBundleTypeExtensions</key>
+            <array>
+                <string>aseprite</string>
+            </array>
+            <key>CFBundleTypeIconFile</key>
+            <string>Document.icns</string>
+            <key>CFBundleTypeName</key>
+            <string>Aseprite Sprite</string>
+            <key>CFBundleTypeRole</key>
+            <string>Editor</string>
+            <key>LSHandlerRank</key>
+            <string>Owner</string>
+        </dict>
+        <dict>
+            <key>CFBundleTypeExtensions</key>
+            <array>
+                <string>ase</string>
+                <string>bmp</string>
+                <string>flc</string>
+                <string>fli</string>
+                <string>gif</string>
+                <string>ico</string>
+                <string>jpeg</string>
+                <string>jpg</string>
+                <string>pcx</string>
+                <string>png</string>
+                <string>tga</string>
+            </array>
+            <key>CFBundleTypeIconFile</key>
+            <string>Document.icns</string>
+            <key>CFBundleTypeName</key>
+            <string>Aseprite Sprite</string>
+            <key>CFBundleTypeRole</key>
+            <string>Editor</string>
+        </dict>
+        <dict>
+            <key>CFBundleTypeExtensions</key>
+            <array>
+                <string>aseprite-extension</string>
+            </array>
+            <key>CFBundleTypeIconFile</key>
+            <string>Extension.icns</string>
+            <key>CFBundleTypeName</key>
+            <string>Aseprite Extension</string>
+            <key>CFBundleTypeRole</key>
+            <string>Editor</string>
+            <key>LSHandlerRank</key>
+            <string>Owner</string>
+        </dict>
+    </array>
+    <key>CFBundleDisplayName</key>
+    <string>Aseprite</string>
+    <key>CFBundleExecutable</key>
+    <string>aseprite</string>
+    <key>CFBundleIdentifier</key>
+    <string>org.aseprite.Aseprite</string>
+    <key>CFBundleName</key>
+    <string>Aseprite</string>
+    <key>CFBundlePackageType</key>
+    <string>APPL</string>
+    <key>CFBundleInfoDictionaryVersion</key>
+    <string>6.0</string>
+    <key>CFBundleShortVersionString</key>
+    <string>1.3</string>
+    <key>CFBundleVersion</key>
+    <string>1.3</string>
+    <key>CFBundleIconFile</key>
+    <string>Aseprite.icns</string>
+    <key>LSApplicationCategoryType</key>
+    <string>public.app-category.graphics-design</string>
+    <key>NSHumanReadableCopyright</key>
+    <string>Copyright © 2001-2025, Igara Studio S.A.
+All rights reserved.</string>
+    <key>NSHighResolutionCapable</key>
+    <true/>
+    <key>NSRequiresAquaSystemAppearance</key>
+    <false/>
+</dict>
+</plist>

src/ui/entry.cpp

@@ -128,6 +128,15 @@ int Entry::lastCaretPos() const
   return int(m_boxes.size() - 1);
 }
 
+gfx::Point Entry::caretPosOnScreen() const
+{
+  const gfx::Point caretPos = getCharBoxBounds(m_caret).point2();
+  const os::Window* nativeWindow = display()->nativeWindow();
+  const gfx::Point pos = nativeWindow->pointToScreen(caretPos + bounds().origin());
+
+  return pos;
+}
+
 void Entry::setCaretPos(const int pos)
 {
   gfx::Size caretSize = theme()->getEntryCaretSize(this);
@@ -160,6 +169,8 @@ void Entry::setCaretPos(const int pos)
     startTimer();
   m_state = true;
 
+  os::System::instance()->setTextInput(true, caretPosOnScreen());
+
   invalidate();
 }
 
@@ -251,7 +262,7 @@ gfx::Rect Entry::getEntryTextBounds() const
   return onGetEntryTextBounds();
 }
 
-gfx::Rect Entry::getCharBoxBounds(const int i)
+gfx::Rect Entry::getCharBoxBounds(const int i) const
 {
   ASSERT(i >= 0 && i < int(m_boxes.size()));
   if (i >= 0 && i < int(m_boxes.size()))
@@ -288,8 +299,9 @@ bool Entry::onProcessMessage(Message* msg)
       }
 
       // Start processing dead keys
-      if (m_translate_dead_keys)
-        os::System::instance()->setTextInput(true);
+      if (m_translate_dead_keys) {
+        os::System::instance()->setTextInput(true, caretPosOnScreen());
+      }
       break;
 
     case kFocusLeaveMessage:

src/ui/entry.h

@@ -43,6 +43,7 @@ public:
 
   int caretPos() const { return m_caret; }
   int lastCaretPos() const;
+  gfx::Point caretPosOnScreen() const;
 
   void setCaretPos(int pos);
   void setCaretToEnd();
@@ -76,7 +77,7 @@ public:
   obs::signal<void()> Change;
 
 protected:
-  gfx::Rect getCharBoxBounds(int i);
+  gfx::Rect getCharBoxBounds(int i) const;
 
   // Events
   bool onProcessMessage(Message* msg) override;

tests/scripts/sprite.lua

@@ -228,3 +228,69 @@ do
   c = app.open(fn)
   assert(c.tileManagementPlugin == nil)
 end
+
+-- Undo History
+
+function test_undo_history()
+  local sprite = Sprite(1, 1)
+
+  assert(sprite.undoHistory.undoSteps == 0)
+  assert(sprite.undoHistory.redoSteps == 0)
+
+  sprite:resize(10, 10)
+
+  assert(sprite.undoHistory.undoSteps == 1)
+  assert(sprite.undoHistory.redoSteps == 0)
+
+  sprite:resize(10, 15)
+
+  assert(sprite.undoHistory.undoSteps == 2)
+  assert(sprite.undoHistory.redoSteps == 0)
+
+  sprite:resize(10, 30)
+
+  assert(sprite.undoHistory.undoSteps == 3)
+  assert(sprite.undoHistory.redoSteps == 0)
+
+  app.undo()
+  assert(sprite.undoHistory.undoSteps == 2)
+  assert(sprite.undoHistory.redoSteps == 1)
+
+  app.undo()
+  assert(sprite.undoHistory.undoSteps == 1)
+  assert(sprite.undoHistory.redoSteps == 2)
+
+  app.redo()
+  assert(sprite.undoHistory.undoSteps == 2)
+  assert(sprite.undoHistory.redoSteps == 1)
+
+  app.undo()
+  app.undo()
+
+  assert(sprite.undoHistory.undoSteps == 0)
+  assert(sprite.undoHistory.redoSteps == 3)
+
+  sprite:resize(10, 30)
+
+  if (app.preferences.undo.allow_nonlinear_history) then
+    assert(sprite.undoHistory.undoSteps == 4)
+    assert(sprite.undoHistory.redoSteps == 0)
+  else
+    assert(sprite.undoHistory.undoSteps == 1)
+    assert(sprite.undoHistory.redoSteps == 0)
+  end
+end
+
+do
+  local prevSetting = app.preferences.undo.allow_nonlinear_history
+  app.preferences.undo.allow_nonlinear_history = true
+  test_undo_history()
+  app.preferences.undo.allow_nonlinear_history = prevSetting
+end
+
+do
+  local prevSetting = app.preferences.undo.allow_nonlinear_history
+  app.preferences.undo.allow_nonlinear_history = false
+  test_undo_history()
+  app.preferences.undo.allow_nonlinear_history = prevSetting
+end