Merge branch 'fix_121_filter_input' into merge_tig

tig · tig · commit d21f8c56ed69 · 2022-08-09T09:06:27.000-06:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -6,25 +6,20 @@
     "configurations": [
         {
             "name": ".NET Core Launch (console)",
+            "preLaunchTask": "build ConsoleGuiTools",
             "type": "coreclr",
             "request": "launch",
-            "preLaunchTask": "build",
-            "program": "${workspaceFolder}/Cmdlet/bin/Debug/net6.0/win10-x64/OutGridViewCmdlet.dll",
-            "args": [],
-            "cwd": "${workspaceFolder}/Cmdlet",
-            "console": "internalConsole",
-            "stopAtEntry": false
-        },
-        {
-            "name": ".NET Core Launch (application)",
-            "type": "coreclr",
-            "request": "launch",
-            "preLaunchTask": "build",
-            "program": "${workspaceFolder}/Application/bin/Debug/net6.0/win10-x64/OutGridViewApplication.dll",
-            "args": [],
-            "cwd": "${workspaceFolder}/Application",
-            "console": "internalConsole",
-            "stopAtEntry": false
+            "program": "pwsh",
+            "args": [
+                "-NoExit",
+                "-NoProfile",
+                "-Command",
+                "Import-Module ${workspaceFolder}/module/Microsoft.PowerShell.ConsoleGuiTools"
+            ],
+            "cwd": "${workspaceFolder}",
+            "console": "integratedTerminal",
+            "stopAtEntry": false,
+            "justMyCode": false
         },
         {
             "name": ".NET Core Attach",
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,5 @@
 {
     "files.associations": {
-        "**/.vsts-ci/**/*.yml":"azure-pipelines"
+        "**/.vsts-ci/**/*.yml":"azure-pipelines",
     }
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -1,33 +1,22 @@
-{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    {
     "version": "2.0.0",
     "tasks": [
         {
-            "label": "build",
-            "osx": {
-                "command": "/usr/local/bin/pwsh"
-            },
-            "windows": {
-                "command": "pwsh.exe"
-            },
-            "linux": {
-                "command": "/usr/local/bin/pwsh"
-            },
-            "type": "process",
+            "label": "build ConsoleGuiTools",
+            "command": "Invoke-Build",
+            "type": "shell",
             "args": [
-                "-c",
-                "Invoke-Build",
-                // Build both modules
-                //"Build -ModuleName Microsoft.PowerShell.GraphicalTools, Microsoft.PowerShell.ConsoleGuiTools", 
-                // Build only Out-GridView
-                //"Build -ModuleName Microsoft.PowerShell.GraphicalTools", 
-                // Build only Out-ConsoleGridView
-                "Build -ModuleName Microsoft.PowerShell.ConsoleGuiTools", 
+                "Build",
+                "-Module",
+                "Microsoft.PowerShell.ConsoleGuiTools"
             ],
-            "problemMatcher": "$msCompile",
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            }
+            "group": "build",
+            "presentation": {
+                "reveal": "silent"
+            },
+            "problemMatcher": "$msCompile"
         }
     ]
 }
diff --git a/README.md b/README.md
@@ -25,9 +25,9 @@ to view and filter objects graphically.
 
 ## Development
 
-### 1. Install PowerShell 7.1+
+### 1. Install PowerShell 7.2+
 
-Install PowerShell 7.1+ with [these instructions](https://github.com/PowerShell/PowerShell#get-powershell).
+Install PowerShell 7.2+ with [these instructions](https://github.com/PowerShell/PowerShell#get-powershell).
 
 ### 2. Clone the GitHub repository
 
@@ -72,29 +72,15 @@ PS ./GraphicalTools> code .
 
 Build by hitting `Ctrl-Shift-B` in VS Code.
 
-To debug:
+Set a breakpoint and hit `F5` to start the debugger.
 
-In a PowerShell session in the `./GraphicalTools` directory, run `pwsh` (thus
-nesting PowerShell).
-
-Then do the folowing:
+Click on the VS Code "TERMINAL" tab and type your command that starts `Out-ConsoleGridView`, e.g.
 
 ```powershell
-Import-Module ./module/Microsoft.PowerShell.ConsoleGuiTools
-$pid
+ls | ocgv
 ```
 
-This will import the latest built DLL and output the process ID you'll need
-for debugging. Copy this ID to the clipboard.
-
-In VScode, set your breakpoints, etc. Then hit `F5`. In the VScode search
-box, paste the value printed by `$pid`. You'll see something like `pwsh.exe
-18328`. Click that and the debug session will start.
-
-In the PowerShell session run your commands; breakpoints will be hit, etc.
-
-When done, run `exit` to exit the nested PowerShell and run `pwsh` again.
-This unloads the DLL.  Repeat.
+Your breakpoint should be hit.
 
 ## Contributions Welcome
 
diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/ConsoleGui.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/ConsoleGui.cs
@@ -83,7 +83,10 @@ public HashSet<int> Start(ApplicationData applicationData)
                 return selectedIndexes;
             }
 
-            foreach (GridViewRow gvr in _itemSource.GridViewRowList)
+            // Ensure that only items that are marked AND not filtered out
+            // get returned (See Issue #121)
+            List<GridViewRow> itemList = GridViewHelpers.FilterData(_itemSource.GridViewRowList, _filterField.Text.ToString());
+            foreach (GridViewRow gvr in itemList)
             {
                 if (gvr.IsMarked)
                 {
@@ -122,7 +125,8 @@ private GridViewDataSource LoadData()
             return new GridViewDataSource(items);
         }
 
-        private void ApplyFilter(){
+        private void ApplyFilter()
+        {
             List<GridViewRow> itemList = GridViewHelpers.FilterData(_itemSource.GridViewRowList, _applicationData.Filter ?? string.Empty);
             // Set the ListView to show only the subset defined by the filter
             _listView.Source = new GridViewDataSource(itemList);
@@ -151,50 +155,72 @@ private Window CreateTopLevelWindow()
                 Width = Dim.Fill(_applicationData.MinUI ? -1 : 0),
                 Height = Dim.Fill(_applicationData.MinUI ? -1 : 1)
             };
-            
-            if (_applicationData.MinUI) {
+
+            if (_applicationData.MinUI)
+            {
                 win.Border.BorderStyle = BorderStyle.None;
-            } 
-            
+            }
+
             Application.Top.Add(win);
             return win;
         }
 
         private void AddStatusBar(bool visible)
         {
-            var statusBar = new StatusBar(
-                    _applicationData.OutputMode != OutputModeOption.None
-                    ? new StatusItem[]
+            var statusItems = new List<StatusItem>();
+            if (_applicationData.OutputMode != OutputModeOption.None)
+            {
+                // Use Key.Unknown for SPACE with no delegate because ListView already
+                // handles SPACE
+                statusItems.Add(new StatusItem(Key.Unknown, "~SPACE~ Select Item", null));
+            }
+
+            if (_applicationData.OutputMode == OutputModeOption.Multiple)
+            {
+                statusItems.Add(new StatusItem(Key.A | Key.CtrlMask, "~CTRL-A~ Select All", () =>
+                {
+                    // This selects only the items that match the Filter
+                    var gvds = _listView.Source as GridViewDataSource;
+                    gvds.GridViewRowList.ForEach(i => i.IsMarked = true);
+                    _listView.SetNeedsDisplay();
+                }));
+
+                // Ctrl-D is commonly used in GUIs for select-none 
+                statusItems.Add(new StatusItem(Key.D | Key.CtrlMask, "~CTRL-D~ Select None", () =>
+                {
+                    // This un-selects only the items that match the Filter
+                    var gvds = _listView.Source as GridViewDataSource;
+                    gvds.GridViewRowList.ForEach(i => i.IsMarked = false);
+                    _listView.SetNeedsDisplay();
+                }));
+            }
+
+            if (_applicationData.OutputMode != OutputModeOption.None)
+            {
+                statusItems.Add(new StatusItem(Key.Enter, "~ENTER~ Accept", () =>
+                {
+                    if (Application.Top.MostFocused == _listView)
                     {
-                        // Use Key.Unknown for SPACE with no delegate because ListView already
-                        // handles SPACE
-                        new StatusItem(Key.Unknown, "~SPACE~ Mark Item", null),
-                        new StatusItem(Key.Enter, "~ENTER~ Accept", () =>
+                        // If nothing was explicitly marked, we return the item that was selected
+                        // when ENTER is pressed in Single mode. If something was previously selected
+                        // (using SPACE) then honor that as the single item to return
+                        if (_applicationData.OutputMode == OutputModeOption.Single &&
+                            _itemSource.GridViewRowList.Find(i => i.IsMarked) == null)
                         {
-                            if (Application.Top.MostFocused == _listView)
-                            {
-                                // If nothing was explicitly marked, we return the item that was selected
-                                // when ENTER is pressed in Single mode. If something was previously selected
-                                // (using SPACE) then honor that as the single item to return
-                                if (_applicationData.OutputMode == OutputModeOption.Single &&
-                                    _itemSource.GridViewRowList.Find(i => i.IsMarked) == null)
-                                {
-                                    _listView.MarkUnmarkRow();
-                                }
-                                Accept();
-                            }
-                            else if (Application.Top.MostFocused == _filterField)
-                            {
-                                _listView.SetFocus();
-                            }
-                        }),
-                        new StatusItem(Key.Esc, "~ESC~ Close", () => Close())
+                            _listView.MarkUnmarkRow();
+                        }
+                        Accept();
                     }
-                    : new StatusItem[]
+                    else if (Application.Top.MostFocused == _filterField)
                     {
-                        new StatusItem(Key.Esc, "~ESC~ Close",  () => Close())
+                        _listView.SetFocus();
                     }
-            );
+                }));
+            }
+
+            statusItems.Add(new StatusItem(Key.Esc, "~ESC~ Close", () => Close()));
+
+            var statusBar = new StatusBar(statusItems.ToArray());
             statusBar.Visible = visible;
             Application.Top.Add(statusBar);
         }
@@ -222,7 +248,6 @@ private void CalculateColumnWidths(List<string> gridHeaders)
                     {
                         listViewColumnWidths[index] = len;
                     }
-
                     index++;
                 }
             }
@@ -264,6 +289,13 @@ private void AddFilter(Window win)
                 Width = Dim.Fill() - _filterLabel.Text.Length
             };
 
+            // TextField captures Ctrl-A (select all text) and Ctrl-D (delete backwards)
+            // In OCGV these are used for select-all/none of items. Selecting items is more
+            // common than editing the filter field so we turn them off in the filter textview. 
+            // BACKSPACE still works for delete backwards
+            _filterField.ClearKeybinding(Key.A | Key.CtrlMask);
+            _filterField.ClearKeybinding(Key.D | Key.CtrlMask);
+
             var filterErrorLabel = new Label(string.Empty)
             {
                 X = Pos.Right(_filterLabel) + 1,
@@ -329,7 +361,8 @@ private void AddHeaders(Window win, List<string> gridHeaders)
                 }
             }
 
-            if (!_applicationData.MinUI){
+            if (!_applicationData.MinUI)
+            {
                 var headerLine = new Label(headerLineText.ToString())
                 {
                     X = 0,
@@ -346,7 +379,7 @@ private void AddListView(Window win)
             if (!_applicationData.MinUI)
             {
                 _listView.Y = Pos.Bottom(_filterLabel) + 3; // 1 for space, 1 for header, 1 for header underline
-            } 
+            }
             else
             {
                 _listView.Y = 1; // 1 for space, 1 for header, 1 for header underline

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"files.associations": {`
`3`		`- "/.vsts-ci//*.yml":"azure-pipelines"`
	`3`	`+ "/.vsts-ci//*.yml":"azure-pipelines",`
`4`	`4`	`}`
`5`	`5`	`}`