Fix duplicate shortcut key configuration items in Keyboard shortcuts (fix #4387) #4453

Gasparoken · 2024-05-06T19:50:05Z

aseprite-bot

clang-tidy made some suggestions

aseprite-bot · 2024-05-06T19:53:22Z

src/app/commands/cmd_keyboard_shortcuts.cpp

@@ -586,6 +586,21 @@ class KeyboardShortcutsWindow : public app::gen::KeyboardShortcuts {
    deleteList(dragActions());
  }

+  void removeRepeatedItems(ListBox* listBox) {


warning: method 'removeRepeatedItems' can be made static [readability-convert-member-functions-to-static]

Suggested change

void removeRepeatedItems(ListBox* listBox) {

static void removeRepeatedItems(ListBox* listBox) {

aseprite-bot · 2024-05-06T19:53:22Z

src/app/commands/cmd_keyboard_shortcuts.cpp

@@ -586,6 +586,21 @@
    deleteList(dragActions());
  }

+  void removeRepeatedItems(ListBox* listBox) {


warning: pointer parameter 'listBox' can be pointer to const [readability-non-const-parameter]

Suggested change

void removeRepeatedItems(ListBox* listBox) {

void removeRepeatedItems(const ListBox* listBox) {

aseprite-bot

clang-tidy made some suggestions

src/app/commands/cmd_keyboard_shortcuts.cpp

martincapello

I haven't tested this, but seems that it should work because it removes duplicates. I'm just concerned about the underlaying cause of the duplicates. Maybe we could try to avoid duplicates in the first place?

Gasparoken · 2024-05-16T17:36:16Z

I haven't tested this, but seems that it should work because it removes duplicates. I'm just concerned about the underlaying cause of the duplicates. Maybe we could try to avoid duplicates in the first place?

Most duplicates appear because some commands have "params" and their "friendlyString" does not concatenate those specific parameters.
For example TiledMode has:

TiledMode::NONE
TiledMode::X_AXIS
TiledMode::Y_AXIS
TiledMode::BOTH

But in the command list box is showed:

Tiled Mode
Tiled Mode
Tiled Mode
Tiled Mode
Tiled Mode

Other duplicates I still don't know why they are duplicated (one of them is TiledMode::NONE which appears twice)

So, I'll concatenate the param string to the base command.

The following commands has duplicates:

Change Color Mode: Indexed
Contract Selection
Export Sprite Sheet
Flip Canvas Horizontally
Frame Properties
Go to Next Frame
Go to Previous Frame
Launch
Layer Properties
Load Palette
Open Browser
Open Sprite
Playback Speed 1x
Run Script: …
Save Palette
Select Used Colors
Set Loop Selection
Set Palette Entry Size
Take & Open Screenshot (sRGB Color Profile
Tiled Mode
Tileset Mode: Auto
Zoom 600%
Zoom 800%
Zoom 1600%

aseprite-bot

clang-tidy made some suggestions

aseprite-bot · 2024-05-17T21:49:52Z

src/app/commands/cmd_keyboard_shortcuts.cpp

@@ -586,6 +586,25 @@ class KeyboardShortcutsWindow : public app::gen::KeyboardShortcuts {
    deleteList(dragActions());
  }

+  bool skipCommand(KeyItem* keyItem) {


warning: method 'skipCommand' can be made static [readability-convert-member-functions-to-static]

Suggested change

bool skipCommand(KeyItem* keyItem) {

static bool skipCommand(KeyItem* keyItem) {

aseprite-bot · 2024-05-17T21:49:52Z

src/app/commands/cmd_keyboard_shortcuts.cpp

+         keyItem->text() == Strings::commands_SavePalette() ||
+        (keyItem->text() == toIndexed && keyItem->key()->params().size() > 1) ||
+        (keyItem->text() == Strings::commands_RunScript() && keyItem->key()->params().empty()))
+      return true;


warning: redundant boolean literal in conditional return statement [readability-simplify-boolean-expr]

src/app/commands/cmd_keyboard_shortcuts.cpp:593:

- if ((keyItem->text() == Strings::commands_OpenFile() || - keyItem->text() == Strings::commands_Flip_Horizontally() || - keyItem->text() == Strings::commands_ExportSpriteSheet() || - keyItem->text() == Strings::commands_ExportSpriteSheet()) && !keyItem->key()->params().empty() || - keyItem->text() == Strings::commands_Launch() || - keyItem->text() == Strings::commands_OpenBrowser() || - keyItem->text() == Strings::commands_SavePalette() || - (keyItem->text() == toIndexed && keyItem->key()->params().size() > 1) || - (keyItem->text() == Strings::commands_RunScript() && keyItem->key()->params().empty())) - return true; - else - return false; + return (keyItem->text() == Strings::commands_OpenFile() || + keyItem->text() == Strings::commands_Flip_Horizontally() || + keyItem->text() == Strings::commands_ExportSpriteSheet() || + keyItem->text() == Strings::commands_ExportSpriteSheet()) && !keyItem->key()->params().empty() || + keyItem->text() == Strings::commands_Launch() || + keyItem->text() == Strings::commands_OpenBrowser() || + keyItem->text() == Strings::commands_SavePalette() || + (keyItem->text() == toIndexed && keyItem->key()->params().size() > 1) || + (keyItem->text() == Strings::commands_RunScript() && keyItem->key()->params().empty());

aseprite-bot · 2024-05-17T21:49:52Z

src/app/commands/cmd_keyboard_shortcuts.cpp

+        (keyItem->text() == toIndexed && keyItem->key()->params().size() > 1) ||
+        (keyItem->text() == Strings::commands_RunScript() && keyItem->key()->params().empty()))
+      return true;
+    else


warning: do not use 'else' after 'return' [readability-else-after-return]

else ^

this fix will not be applied because it overlaps with another fix

aseprite-bot · 2024-05-17T21:49:52Z

src/app/commands/cmd_tiled_mode.cpp

@@ -64,6 +68,17 @@ void TiledModeCommand::onExecute(Context* ctx)
  Preferences::instance().document(doc).tiled.mode(m_mode);
 }

+std::string TiledModeCommand::onGetFriendlyName() const {
+  std::string mode;


warning: variable 'mode' of type 'std::string' (aka 'basic_string') can be declared 'const' [misc-const-correctness]

Suggested change

std::string mode;

std::string const mode;

aseprite-bot · 2024-05-17T21:49:52Z

src/app/commands/cmd_tiled_mode.cpp

+std::string TiledModeCommand::onGetFriendlyName() const {
+  std::string mode;
+  switch (m_mode) {
+    case filters::TiledMode::NONE: mode = Strings::main_menu_view_tiled_mode_none(); break;


warning: switch has 4 consecutive identical branches [bugprone-branch-clone]

case filters::TiledMode::NONE: mode = Strings::main_menu_view_tiled_mode_none(); break; ^

Additional context

src/app/commands/cmd_tiled_mode.cpp:76: last of these clones ends here

case filters::TiledMode::Y_AXIS: mode = Strings::main_menu_view_tiled_mode_y(); break; ^

Gasparoken · 2024-05-17T22:10:40Z

@martincapello What do you think about this approach?
Pending duplicates:

Contract Selection
Frame Properties
Go to Next Frame
Go to Previous Frame
Layer Properties
Load Palette
Playback Speed 1x
Select Used Colors
Set Loop Selection
Set Palette Entry Size
Take  Open Screenshot (sRGB Color Profile
Tileset Mode: Auto

Another possible approach:
Perhaps it would be better to calculate the "skipCommand" before the "new KeyElement".
And it would be nice to have some additional function in the "Command" class to determine the correct string in the ListBox.

…Window (fix aseprite#4387) Introduced Key::isSkipListing() and Command::isSkipListing() to skip keyItem creation on Keyboard shortcut List Box. Removed commands: 'Launch' 'OpenBrowser' And removed unnecessary commands: 'Change Color Mode: Indexed' 'Contract Selection' 'Export Sprite Sheet' 'Flip Canvas Horizontally' 'Frame Properties' 'Load Palette' 'Open Sprite' 'Playback Speed 1x' 'Run Script' 'Save Palette' 'Select Used Colors' 'Set Palette Entry Size' 'Tileset Mode: Auto'

… box.

Before this fix, the following items were repeated in the list box: 'Zoom 600%' 'Zoom 800%' 'Zoom 1600%'

aseprite-bot

clang-tidy made some suggestions

aseprite-bot · 2024-05-22T16:26:47Z

src/app/commands/cmd_export_sprite_sheet.h

@@ -64,6 +64,9 @@ class ExportSpriteSheetCommand : public CommandWithNewParams<ExportSpriteSheetPa
 protected:
  bool onEnabled(Context* context) override;
  void onExecute(Context* context) override;
+  const bool isSkipListing(const Params& params) const override {


warning: return type 'const bool' is 'const'-qualified at the top level, which may reduce code readability without improving const correctness [readability-const-return-type]

Suggested change

const bool isSkipListing(const Params& params) const override {

bool isSkipListing(const Params& params) const override {

aseprite-bot · 2024-05-22T16:26:47Z

src/app/commands/cmd_export_sprite_sheet.h

@@ -64,6 +64,9 @@
 protected:
  bool onEnabled(Context* context) override;
  void onExecute(Context* context) override;
+  const bool isSkipListing(const Params& params) const override {


warning: method 'isSkipListing' can be made static [readability-convert-member-functions-to-static]

Suggested change

const bool isSkipListing(const Params& params) const override {

static const bool isSkipListing(const Params& params) override {

aseprite-bot · 2024-05-22T16:26:48Z

src/app/commands/cmd_launch.cpp

@@ -20,6 +20,7 @@ namespace app {
 class LaunchCommand : public Command {
 public:
  LaunchCommand();
+  const bool isSkipListing(const Params& params) const override { return true; }


warning: parameter 'params' is unused [misc-unused-parameters]

Suggested change

const bool isSkipListing(const Params& params) const override { return true; }

const bool isSkipListing(const Params& /*params*/) const override { return true; }

aseprite-bot · 2024-05-22T16:26:48Z

src/app/commands/cmd_modify_selection.cpp

@@ -46,6 +46,9 @@ class ModifySelectionCommand : public Command {
  bool onEnabled(Context* context) override;
  void onExecute(Context* context) override;
  std::string onGetFriendlyName() const override;
+  const bool isSkipListing(const Params& params) const override {


warning: parameter 'params' is unused [misc-unused-parameters]

Suggested change

const bool isSkipListing(const Params& params) const override {

const bool isSkipListing(const Params& /*params*/) const override {

aseprite-bot · 2024-05-22T16:26:48Z

src/app/commands/cmd_open_browser.cpp

@@ -23,6 +24,7 @@ class OpenBrowserCommand : public Command {
 protected:
  void onLoadParams(const Params& params) override;
  void onExecute(Context* context) override;
+  const bool isSkipListing(const Params& params) const override { return true; }


warning: parameter 'params' is unused [misc-unused-parameters]

Suggested change

const bool isSkipListing(const Params& params) const override { return true; }

const bool isSkipListing(const Params& /*params*/) const override { return true; }

aseprite-bot · 2024-05-22T16:26:48Z

src/app/commands/cmd_tiled_mode.cpp

+std::string TiledModeCommand::onGetFriendlyName() const {
+  std::string mode;
+  switch (m_mode) {
+    case filters::TiledMode::NONE: mode = Strings::main_menu_view_tiled_mode_none(); break;


warning: switch has 4 consecutive identical branches [bugprone-branch-clone]

case filters::TiledMode::NONE: mode = Strings::main_menu_view_tiled_mode_none(); break; ^

Additional context

src/app/commands/cmd_tiled_mode.cpp:79: last of these clones ends here

case filters::TiledMode::Y_AXIS: mode = Strings::main_menu_view_tiled_mode_y(); break; ^

aseprite-bot · 2024-05-22T16:26:48Z

src/app/commands/command.h

+    // Not all Commands must be listed on KeyBoard Shortcut list, so
+    // this function returns if a key command should be listed or not.
+    // Used on 'cmd_keyboard_shorcuts.cpp'.
+    virtual const bool isSkipListing(const Params& params) const {


warning: return type 'const bool' is 'const'-qualified at the top level, which may reduce code readability without improving const correctness [readability-const-return-type]

virtual const bool isSkipListing(const Params& params) const { ^

aseprite-bot · 2024-05-22T16:26:48Z

src/app/commands/command.h

+    // Not all Commands must be listed on KeyBoard Shortcut list, so
+    // this function returns if a key command should be listed or not.
+    // Used on 'cmd_keyboard_shorcuts.cpp'.
+    virtual const bool isSkipListing(const Params& params) const {


warning: parameter 'params' is unused [misc-unused-parameters]

Suggested change

virtual const bool isSkipListing(const Params& params) const {

virtual const bool isSkipListing(const Params& /*params*/) const {

aseprite-bot · 2024-05-22T16:26:48Z

src/app/commands/set_playback_speed.cpp

@@ -26,6 +26,9 @@ class SetPlaybackSpeedCommand : public CommandWithNewParams<SetPlaybackSpeedPara
  bool onChecked(Context* ctx) override;
  void onExecute(Context* ctx) override;
  std::string onGetFriendlyName() const override;
+  const bool isSkipListing(const Params& params) const override {


warning: return type 'const bool' is 'const'-qualified at the top level, which may reduce code readability without improving const correctness [readability-const-return-type]

Suggested change

const bool isSkipListing(const Params& params) const override {

bool isSkipListing(const Params& params) const override {

aseprite-bot · 2024-05-22T16:26:48Z

src/app/commands/set_playback_speed.cpp

@@ -26,6 +26,9 @@
  bool onChecked(Context* ctx) override;
  void onExecute(Context* ctx) override;
  std::string onGetFriendlyName() const override;
+  const bool isSkipListing(const Params& params) const override {


warning: method 'isSkipListing' can be made static [readability-convert-member-functions-to-static]

Suggested change

const bool isSkipListing(const Params& params) const override {

static const bool isSkipListing(const Params& params) override {

Gasparoken · 2024-05-22T16:30:39Z

New approach to review. ~~This will compile if aseprite/laf#88 is implemented first.~~ (EDIT: moved the removeEscapeCharText() function from laf/base/string to ui/intern)

Pending:
There are 4 items that depend on 'keyContext', i.e. the difference between key Items are only the context:
Set Loop Section
Go to Next Frame
Go to Previous Frame
Layer Properties (in this case by default, there are 2 key board shortcuts for the same command 'F2' and 'Shift+P')

To go ahead I need to know if this approach is OK.

dacap · 2024-05-22T16:34:09Z

I'll review this later.

Gasparoken · 2024-05-22T17:22:14Z

I'll review this later.

Ok, I will just push-force the last movement of the removeEscapeCharFromText() function from 'laf/base/string' to 'ui/intern'

…ui/intern'

aseprite-bot

clang-tidy made some suggestions

aseprite-bot · 2024-05-22T17:29:21Z

src/app/commands/cmd_tiled_mode.cpp

+std::string TiledModeCommand::onGetFriendlyName() const {
+  std::string mode;
+  switch (m_mode) {
+    case filters::TiledMode::NONE: mode = Strings::main_menu_view_tiled_mode_none(); break;


warning: switch has 4 consecutive identical branches [bugprone-branch-clone]

case filters::TiledMode::NONE: mode = Strings::main_menu_view_tiled_mode_none(); break; ^

Additional context

src/app/commands/cmd_tiled_mode.cpp:80: last of these clones ends here

case filters::TiledMode::Y_AXIS: mode = Strings::main_menu_view_tiled_mode_y(); break; ^

aseprite-bot · 2024-05-22T17:29:21Z

src/ui/intern.cpp

+  while (int chr = decode.next()) {
+    if (chr == escapeChar) {
+      chr = decode.next();
+      if (!chr)


warning: implicit conversion 'int' -> bool [readability-implicit-bool-conversion]

Suggested change

if (!chr)

if (chr == 0)

aseprite-bot · 2024-05-22T17:29:22Z

src/ui/intern.h

@@ -34,6 +35,9 @@ namespace ui {
    void reinitThemeForAllWidgets();
    int old_guiscale();

+    std::string removeEscapeCharFromText(const std::string& original,


warning: use of undeclared identifier 'std' [clang-diagnostic-error]

std::string removeEscapeCharFromText(const std::string& original, ^

aseprite-bot · 2024-05-22T17:29:22Z

src/ui/intern.h

@@ -34,6 +35,9 @@
    void reinitThemeForAllWidgets();
    int old_guiscale();

+    std::string removeEscapeCharFromText(const std::string& original,


warning: use of undeclared identifier 'std' [clang-diagnostic-error]

std::string removeEscapeCharFromText(const std::string& original, ^

Gasparoken assigned martincapello May 6, 2024

Gasparoken requested a review from dacap as a code owner May 6, 2024 19:50

aseprite-bot reviewed May 6, 2024

View reviewed changes

Gasparoken force-pushed the fix-commands-shortcuts branch from fb29555 to 409ee21 Compare May 6, 2024 20:03

aseprite-bot reviewed May 6, 2024

View reviewed changes

src/app/commands/cmd_keyboard_shortcuts.cpp Outdated Show resolved Hide resolved

martincapello reviewed May 10, 2024

View reviewed changes

Gasparoken assigned Gasparoken and unassigned martincapello May 10, 2024

Gasparoken force-pushed the fix-commands-shortcuts branch from 409ee21 to 0a79626 Compare May 17, 2024 21:46

aseprite-bot reviewed May 17, 2024

View reviewed changes

Gasparoken assigned martincapello and unassigned Gasparoken May 17, 2024

Gasparoken assigned Gasparoken and unassigned martincapello May 21, 2024

Gasparoken added 3 commits May 21, 2024 17:39

Fix duplicate 'Tile Mode' items within the shortcut key settings list…

fe786c7

… box.

Fix duplicate 'Zoom' items within the shortcut key settings list box.

4276729

Before this fix, the following items were repeated in the list box: 'Zoom 600%' 'Zoom 800%' 'Zoom 1600%'

Gasparoken mentioned this pull request May 22, 2024

Add removeEscapeCharFromText() function to 'base::string' aseprite/laf#88

Closed

Gasparoken force-pushed the fix-commands-shortcuts branch from c917d68 to 4276729 Compare May 22, 2024 16:21

aseprite-bot reviewed May 22, 2024

View reviewed changes

dacap self-assigned this May 22, 2024

Moved removeEscapeCharFromText() function from 'laf/base/string' to '…

94909e8

…ui/intern'

aseprite-bot reviewed May 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix duplicate shortcut key configuration items in Keyboard shortcuts (fix #4387) #4453

Fix duplicate shortcut key configuration items in Keyboard shortcuts (fix #4387) #4453

Gasparoken commented May 6, 2024

aseprite-bot left a comment

aseprite-bot May 6, 2024

aseprite-bot May 6, 2024

aseprite-bot left a comment

martincapello left a comment

Gasparoken commented May 16, 2024

aseprite-bot left a comment

aseprite-bot May 17, 2024

aseprite-bot May 17, 2024

aseprite-bot May 17, 2024

aseprite-bot May 17, 2024

aseprite-bot May 17, 2024

Gasparoken commented May 17, 2024 •

edited

aseprite-bot left a comment

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

Gasparoken commented May 22, 2024 •

edited

dacap commented May 22, 2024 •

edited

Gasparoken commented May 22, 2024

aseprite-bot left a comment

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

aseprite-bot May 22, 2024

	void removeRepeatedItems(ListBox* listBox) {
	static void removeRepeatedItems(ListBox* listBox) {

	void removeRepeatedItems(ListBox* listBox) {
	void removeRepeatedItems(const ListBox* listBox) {

	bool skipCommand(KeyItem* keyItem) {
	static bool skipCommand(KeyItem* keyItem) {

	const bool isSkipListing(const Params& params) const override {
	bool isSkipListing(const Params& params) const override {

	const bool isSkipListing(const Params& params) const override {
	static const bool isSkipListing(const Params& params) override {

	const bool isSkipListing(const Params& params) const override { return true; }
	const bool isSkipListing(const Params& /params/) const override { return true; }

	virtual const bool isSkipListing(const Params& params) const {
	virtual const bool isSkipListing(const Params& /params/) const {

Fix duplicate shortcut key configuration items in Keyboard shortcuts (fix #4387) #4453

Are you sure you want to change the base?

Fix duplicate shortcut key configuration items in Keyboard shortcuts (fix #4387) #4453

Conversation

Gasparoken commented May 6, 2024

aseprite-bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aseprite-bot left a comment

Choose a reason for hiding this comment

martincapello left a comment

Choose a reason for hiding this comment

Gasparoken commented May 16, 2024

aseprite-bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Gasparoken commented May 17, 2024 • edited

aseprite-bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Gasparoken commented May 22, 2024 • edited

dacap commented May 22, 2024 • edited

Gasparoken commented May 22, 2024

aseprite-bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Gasparoken commented May 17, 2024 •

edited

Gasparoken commented May 22, 2024 •

edited

dacap commented May 22, 2024 •

edited