Allow accessing selection in all commands

Also makes selections more consistent and safer.

The downside is that this potentially breaks some existing scripts.

Fixes hluk/copyq-commands#97

docs/scripting-api.rst

@@ -873,16 +873,14 @@ unlike in GUI, where row numbers start from 1 by default.
 
    Returns tab that was selected when script was executed.
 
-   :returns: Currently selected tab name, empty if called outside the main
-             window context (see `Selected Items`_).
+   :returns: Currently selected tab name (see `Selected Items`_).
    :rtype: string
 
 .. js:function:: selectedItems()
 
    Returns selected rows in current tab.
 
-   :returns: Currently selected rows, empty if called outside the main
-             window context (see `Selected Items`_).
+   :returns: Currently selected rows (see `Selected Items`_).
    :rtype: array of ints
 
 .. js:function:: selectedItemData(index)
@@ -892,8 +890,7 @@ unlike in GUI, where row numbers start from 1 by default.
    The data can empty if the item was removed during execution of the
    script.
 
-   :returns: Currently selected items, empty if called outside the main
-             window context (see `Selected Items`_).
+   :returns: Currently selected items (see `Selected Items`_).
    :rtype: array of :js:class:`Item`
 
 .. js:function:: setSelectedItemData(index, Item)
@@ -915,8 +912,7 @@ unlike in GUI, where row numbers start from 1 by default.
    Some data can be empty if the item was removed during execution of the
    script.
 
-   :returns: Currently selected item data, empty if called outside the main
-             window context (see `Selected Items`_).
+   :returns: Currently selected item data (see `Selected Items`_).
    :rtype: array of :js:class:`Item`
 
 .. js:function:: setSelectedItemsData(Item[])
@@ -935,8 +931,7 @@ unlike in GUI, where row numbers start from 1 by default.
 
    See `Selected Items`_.
 
-   :returns: Current row, ``-1`` if called outside the main
-             window context (see `Selected Items`_).
+   :returns: Current row (see `Selected Items`_).
    :rtype: int
 
 .. js:function:: escapeHtml(text)
@@ -2247,12 +2242,27 @@ These MIME types values are assigned to global variables prefixed with
 Selected Items
 --------------
 
-Functions that get and set data for selected items and current tab are
-only available if called from Action dialog or from a command which is
-in menu.
+The internal state for currently evaluated script/command stores references
+(not rows or item data) to the current and selected items and it do not change
+after the state is retrieved from GUI.
 
-Selected items are indexed from top to bottom as they appeared in the
-current tab at the time the command is executed.
+The state is retrieved before the script/command starts if it is invoked from
+the application with a shortcut, from menu, toolbar or the Action dialog.
+Otherwise, the state is retrieved when needed (for example the first
+``selectedItems()`` call) for scripts/commands run externally (for example from
+command line or from automatic commands on clipboard content change).
+
+If a selected or current item is moved, script functions will return the new
+rows. For example ``selectedItems()`` returning ``[0,1]`` will return ``[1,0]``
+after the items are swapped. Same goes for selected item data.
+
+If a selected or current item is removed, their references in the internal
+state are invalidated. These references will return -1 for row and empty object
+for item data. For example ``selectedItems()`` returning ``[0,1]`` will return
+``[0,-1]`` after the item on the second row is removed.
+
+If tab is renamed, all references to current and selected items are invalidated
+because the tab data need to be initiated again.
 
 Linux Mouse Selection
 ---------------------

src/gui/mainwindow.cpp

@@ -37,6 +37,7 @@
 #include "gui/logdialog.h"
 #include "gui/notification.h"
 #include "gui/notificationdaemon.h"
+#include "gui/selectiondata.h"
 #include "gui/tabdialog.h"
 #include "gui/tabicons.h"
 #include "gui/tabwidget.h"
@@ -180,54 +181,6 @@ void disableActionWhenTabGroupSelected(WidgetOrAction *action, MainWindow *windo
                       action, &WidgetOrAction::setDisabled );
 }
 
-void addSelectionData(
-        QVariantMap *result,
-        const QList<QPersistentModelIndex> &selectedIndexes)
-{
-    result->insert(mimeSelectedItems, QVariant::fromValue(selectedIndexes));
-}
-
-void addSelectionData(
-        QVariantMap *result,
-        const QModelIndexList &selectedIndexes)
-{
-    QList<QPersistentModelIndex> selected;
-    selected.reserve(selectedIndexes.size());
-    for (const auto &index : selectedIndexes)
-        selected.append(index);
-    std::sort(selected.begin(), selected.end());
-    addSelectionData(result, selected);
-}
-
-/// Adds information about current tab and selection if command is triggered by user.
-QVariantMap addSelectionData(
-        const ClipboardBrowser &c,
-        const QModelIndex &currentIndex,
-        const QModelIndexList &selectedIndexes)
-{
-    auto result = c.copyIndexes(selectedIndexes);
-
-    result.insert(mimeCurrentTab, c.tabName());
-
-    if ( currentIndex.isValid() ) {
-        const QPersistentModelIndex current = currentIndex;
-        result.insert(mimeCurrentItem, QVariant::fromValue(current));
-    }
-
-    if ( !selectedIndexes.isEmpty() ) {
-        addSelectionData(&result, selectedIndexes);
-    }
-
-    return result;
-}
-
-QVariantMap addSelectionData(const ClipboardBrowser &c)
-{
-    const QModelIndexList selectedIndexes = c.selectionModel()->selectedIndexes();
-    const auto current = c.selectionModel()->currentIndex();
-    return addSelectionData(c, current, selectedIndexes);
-}
-
 QMenu *findSubMenu(const QString &name, const QMenu &menu)
 {
     for (auto action : menu.actions()) {
@@ -1118,13 +1071,13 @@ void MainWindow::onItemCommandActionTriggered(CommandAction *commandAction, cons
     if ( !command.cmd.isEmpty() ) {
         if (command.transform) {
             for (const auto &index : selected) {
-                auto actionData = addSelectionData(*c, index, {index});
+                auto actionData = selectionData(*c, index, {index});
                 if ( !triggeredShortcut.isEmpty() )
                     actionData.insert(mimeShortcut, triggeredShortcut);
                 action(actionData, command, index);
             }
         } else {
-            auto actionData = addSelectionData(*c);
+            auto actionData = selectionData(*c);
             if ( !triggeredShortcut.isEmpty() )
                 actionData.insert(mimeShortcut, triggeredShortcut);
             action(actionData, command, QModelIndex());
@@ -1580,7 +1533,7 @@ void MainWindow::addCommandsToItemMenu(ClipboardBrowser *c)
         return;
     }
 
-    auto data = addSelectionData(*c);
+    auto data = selectionData(*c);
     const auto commands = commandsForMenu(data, c->tabName(), m_menuCommands);
 
     for (const auto &command : commands) {
@@ -3692,7 +3645,7 @@ ActionDialog *MainWindow::openActionDialog(const QVariantMap &data)
 void MainWindow::openActionDialog()
 {
     auto c = browser();
-    const auto data = c ? addSelectionData(*c) : QVariantMap();
+    const auto data = c ? selectionData(*c) : QVariantMap();
     openActionDialog(data);
 }
 

src/gui/selectiondata.cpp

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+#include "selectiondata.h"
+
+#include "common/mimetypes.h"
+#include "gui/clipboardbrowser.h"
+
+void addSelectionData(
+        QVariantMap *result,
+        const QList<QPersistentModelIndex> &selectedIndexes)
+{
+    result->insert(mimeSelectedItems, QVariant::fromValue(selectedIndexes));
+}
+
+void addSelectionData(
+        QVariantMap *result,
+        const QModelIndexList &selectedIndexes)
+{
+    QList<QPersistentModelIndex> selected;
+    selected.reserve(selectedIndexes.size());
+    for (const auto &index : selectedIndexes)
+        selected.append(index);
+    std::sort(selected.begin(), selected.end());
+    addSelectionData(result, selected);
+}
+
+/// Adds information about current tab and selection if command is triggered by user.
+QVariantMap selectionData(
+        const ClipboardBrowser &c,
+        const QModelIndex &currentIndex,
+        const QModelIndexList &selectedIndexes)
+{
+    auto result = c.copyIndexes(selectedIndexes);
+
+    result.insert(mimeCurrentTab, c.tabName());
+
+    if ( currentIndex.isValid() ) {
+        const QPersistentModelIndex current = currentIndex;
+        result.insert(mimeCurrentItem, QVariant::fromValue(current));
+    }
+
+    if ( !selectedIndexes.isEmpty() ) {
+        addSelectionData(&result, selectedIndexes);
+    }
+
+    return result;
+}
+
+QVariantMap selectionData(const ClipboardBrowser &c)
+{
+    const QModelIndexList selectedIndexes = c.selectionModel()->selectedIndexes();
+    const auto current = c.selectionModel()->currentIndex();
+    return selectionData(c, current, selectedIndexes);
+}

src/gui/selectiondata.h

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+#pragma once
+
+#include <QModelIndexList>
+#include <QVariantMap>
+#include <QtContainerFwd>
+
+class ClipboardBrowser;
+
+void addSelectionData(
+        QVariantMap *result,
+        const QList<QPersistentModelIndex> &selectedIndexes);
+
+void addSelectionData(
+        QVariantMap *result,
+        const QModelIndexList &selectedIndexes);
+
+/// Adds information about current tab and selection if command is triggered by user.
+QVariantMap selectionData(
+        const ClipboardBrowser &c,
+        const QModelIndex &currentIndex,
+        const QModelIndexList &selectedIndexes);
+
+QVariantMap selectionData(const ClipboardBrowser &c);

src/scriptable/scriptable.cpp

@@ -1780,7 +1780,7 @@ QJSValue Scriptable::selectItems()
 QJSValue Scriptable::selectedTab()
 {
     m_skipArguments = 0;
-    return m_data.value(mimeCurrentTab).toString();
+    return m_proxy->selectedTab();
 }
 
 QJSValue Scriptable::selectedItems()