Allow user scripts to operate on selected files

GitUI/CommandsDialogs/FormBrowse.cs

@@ -325,10 +325,10 @@ internal FormBrowse(GitUICommands commands, BrowseArguments args, ISettingsSourc
             _aheadBehindDataProvider = new AheadBehindDataProvider(() => Module.GitExecutable);
             toolStripButtonPush.Initialize(_aheadBehindDataProvider);
             repoObjectsTree.Initialize(_aheadBehindDataProvider, filterRevisionGridBySpaceSeparatedRefs: ToolStripFilters.SetBranchFilter, refsSource: RevisionGrid, revisionGridInfo: RevisionGrid, scriptRunner: RevisionGrid);
-            revisionDiff.Bind(revisionGridInfo: RevisionGrid, revisionGridUpdate: RevisionGrid, revisionFileTree: fileTree, () => RevisionGrid.CurrentFilter.PathFilter, RefreshGitStatusMonitor);
+            revisionDiff.Bind(revisionGridInfo: RevisionGrid, revisionGridUpdate: RevisionGrid, revisionFileTree: fileTree, () => RevisionGrid.CurrentFilter.PathFilter, RefreshGitStatusMonitor, scriptRunner: RevisionGrid);
 
             // Show blame by default if not started from command line
-            fileTree.Bind(revisionGridInfo: RevisionGrid, revisionGridUpdate: RevisionGrid, RefreshGitStatusMonitor, _isFileBlameHistory);
+            fileTree.Bind(revisionGridInfo: RevisionGrid, revisionGridUpdate: RevisionGrid, RefreshGitStatusMonitor, _isFileBlameHistory, scriptRunner: RevisionGrid);
             RevisionGrid.ResumeRefreshRevisions();
 
             // Application is init, the repo related operations are triggered in OnLoad()
@@ -1025,7 +1025,7 @@ void LoadUserMenu()
 
                     button.Click += delegate
                     {
-                        if (ScriptRunner.RunScript(this, Module, script.Name, UICommands, RevisionGrid).NeedsGridRefresh)
+                        if (ScriptRunner.RunScript(this, Module, script.Name, UICommands, RevisionGrid, null).NeedsGridRefresh)
                         {
                             RefreshRevisions();
                         }

GitUI/CommandsDialogs/FormCommit.cs

@@ -28,7 +28,7 @@
 
 namespace GitUI.CommandsDialogs
 {
-    public sealed partial class FormCommit : GitModuleForm
+    public sealed partial class FormCommit : GitModuleForm, IRunScript.IFileListSource
     {
         #region Translation
 
@@ -184,6 +184,8 @@ public sealed partial class FormCommit : GitModuleForm
         private IReadOnlyList<GitItemStatus>? _currentSelection;
         private int _alreadyLoadedTemplatesCount = -1;
         private EventHandler? _branchNameLabelOnClick;
+        private IRunScript.IFileListSource _unstagedFileListSource;
+        private IRunScript.IFileListSource _stagedFileListSource;
 
         private CommitKind CommitKind
         {
@@ -220,6 +222,8 @@ public FormCommit(GitUICommands commands, CommitKind commitKind = CommitKind.Nor
             ThreadHelper.ThrowIfNotOnUIThread();
 
             _editedCommit = editedCommit;
+            _unstagedFileListSource = new RunScriptFileListSource(this, false);
+            _stagedFileListSource = new RunScriptFileListSource(this, true);
 
             InitializeComponent();
 
@@ -1660,6 +1664,8 @@ private void UnstagedFileContext_Opening(object sender, System.ComponentModel.Ca
             openWithToolStripMenuItem.Enabled = !isAnyDeleted;
             deleteFileToolStripMenuItem.Enabled = !isAnyDeleted;
             openContainingFolderToolStripMenuItem.Enabled = !isAnyDeleted;
+
+            UnstagedFileContext.AddUserScripts(runScriptToolStripMenuItem, ExecuteScriptUnstaged, (script) => script.OnEvent == ScriptEvent.ShowInFileList);
         }
 
         private void StagedFileContext_Opening(object sender, System.ComponentModel.CancelEventArgs e)
@@ -1679,6 +1685,8 @@ private void StagedFileContext_Opening(object sender, System.ComponentModel.Canc
             stagedOpenToolStripMenuItem7.Enabled = !isAnyDeleted;
             stagedOpenWithToolStripMenuItem8.Enabled = !isAnyDeleted;
             stagedOpenFolderToolStripMenuItem10.Enabled = !isAnyDeleted;
+
+            StagedFileContext.AddUserScripts(stagedRunScriptToolStripMenuItem, ExecuteScriptStaged, (script) => script.OnEvent == ScriptEvent.ShowInFileList);
         }
 
         private void UnstagedSubmoduleContext_Opening(object sender, System.ComponentModel.CancelEventArgs e)
@@ -3317,6 +3325,73 @@ private void UpdateButtonStates()
                 : TranslatedStrings.ButtonPush;
         }
 
+        private class RunScriptFileListSource : IRunScript.IFileListSource
+        {
+            private FormCommit _formCommit;
+            private bool _staged;
+
+            public RunScriptFileListSource(FormCommit formCommit, bool staged)
+            {
+                _formCommit = formCommit;
+                _staged = staged;
+            }
+
+            List<string> IRunScript.IFileListSource.GetFiles()
+            {
+                IReadOnlyList<FileStatusItem> selectedItems = (_staged ? _formCommit.Staged : _formCommit.Unstaged).SelectedItems.ToList();
+
+                if (!selectedItems.Any())
+                {
+                    return null;
+                }
+
+                return selectedItems.Select(item => _formCommit._fullPathResolver.Resolve(item.Item.Name)).ToList();
+            }
+
+            int? IRunScript.IFileListSource.GetLineNumber()
+            {
+                return _formCommit.SelectedDiff.CurrentFileLine;
+            }
+        }
+
+        private void ExecuteScriptUnstaged(string name)
+        {
+            if (ScriptRunner.RunScript(this, Module, name, UICommands, null, _unstagedFileListSource).NeedsGridRefresh)
+            {
+                RescanChanges();
+            }
+        }
+
+        private void ExecuteScriptStaged(string name)
+        {
+            if (ScriptRunner.RunScript(this, Module, name, UICommands, null, _stagedFileListSource).NeedsGridRefresh)
+            {
+                RescanChanges();
+            }
+        }
+
+        List<string> IRunScript.IFileListSource.GetFiles()
+        {
+            if (_currentFilesList is null)
+            {
+                return null;
+            }
+
+            IReadOnlyList<FileStatusItem> selectedItems = _currentFilesList.SelectedItems.ToList();
+
+            if (!selectedItems.Any())
+            {
+                return null;
+            }
+
+            return selectedItems.Select(item => _fullPathResolver.Resolve(item.Item.Name)).ToList();
+        }
+
+        int? IRunScript.IFileListSource.GetLineNumber()
+        {
+            return SelectedDiff.CurrentFileLine;
+        }
+
         internal TestAccessor GetTestAccessor()
             => new(this);
 

GitUI/CommandsDialogs/RevisionDiffControl.cs

@@ -7,6 +7,7 @@
 using GitUI.CommandsDialogs.BrowseDialog;
 using GitUI.HelperDialogs;
 using GitUI.Hotkey;
+using GitUI.Script;
 using GitUI.UserControls;
 using GitUI.UserControls.RevisionGrid;
 using GitUIPluginInterfaces;
@@ -16,7 +17,7 @@
 
 namespace GitUI.CommandsDialogs
 {
-    public partial class RevisionDiffControl : GitModuleControl
+    public partial class RevisionDiffControl : GitModuleControl, IRunScript.IFileListSource
     {
         private readonly TranslationString _saveFileFilterCurrentFormat = new("Current format");
         private readonly TranslationString _saveFileFilterAllFiles = new("All files");
@@ -50,6 +51,7 @@ public partial class RevisionDiffControl : GitModuleControl
         private string? _fallbackFollowedFile;
         private FileStatusItem? _lastExplicitlySelectedItem;
         private bool _isImplicitListSelection = false;
+        private IRunScript _scriptRunner;
 
         public RevisionDiffControl()
         {
@@ -306,13 +308,14 @@ private async Task SetDiffsAsync(IReadOnlyList<GitRevision> revisions)
             }
         }
 
-        public void Bind(IRevisionGridInfo revisionGridInfo, IRevisionGridUpdate revisionGridUpdate, RevisionFileTreeControl revisionFileTree, Func<string>? pathFilter, Action? refreshGitStatus)
+        public void Bind(IRevisionGridInfo revisionGridInfo, IRevisionGridUpdate revisionGridUpdate, RevisionFileTreeControl revisionFileTree, Func<string>? pathFilter, Action? refreshGitStatus, IRunScript scriptRunner)
         {
             _revisionGridInfo = revisionGridInfo;
             _revisionGridUpdate = revisionGridUpdate;
             _revisionFileTree = revisionFileTree;
             _pathFilter = pathFilter;
             _refreshGitStatus = refreshGitStatus;
+            _scriptRunner = scriptRunner;
             DiffFiles.Bind(objectId => DescribeRevision(objectId), _revisionGridInfo.GetActualRevision);
         }
 
@@ -748,6 +751,8 @@ private void UpdateStatusOfMenuItems()
             {
                 blameToolStripMenuItem.Checked = false;
             }
+
+            DiffContextMenu.AddUserScripts(runScriptToolStripMenuItem, Execute, (script) => script.OnEvent == ScriptEvent.ShowInFileList);
         }
 
         private void DiffContextMenu_Opening(object sender, CancelEventArgs e)
@@ -1453,6 +1458,28 @@ private void ResetSelectedItemsWithConfirmation(bool resetToParent)
 
         private static bool RenamedIndexItem(FileStatusItem item) => item.Item.IsRenamed && item.Item.Staged == StagedStatus.Index;
 
+        List<string> IRunScript.IFileListSource.GetFiles()
+        {
+            IReadOnlyList<FileStatusItem> selectedItems = DiffFiles.SelectedItems.ToList();
+
+            if (!selectedItems.Any())
+            {
+                return null;
+            }
+
+            return selectedItems.Select(item => _fullPathResolver.Resolve(item.Item.Name)).ToList();
+        }
+
+        int? IRunScript.IFileListSource.GetLineNumber()
+        {
+            return BlameControl.Visible ? BlameControl.CurrentFileLine : DiffText.CurrentFileLine;
+        }
+
+        private void Execute(string name)
+        {
+            _scriptRunner.Execute(name, this);
+        }
+
         internal void RegisterGitHostingPluginInBlameControl()
         {
             BlameControl.ConfigureRepositoryHostPlugin(PluginRegistry.TryGetGitHosterForModule(Module));