diff --git a/.github/workflows/ci-test.yml b/.github/workflows/ci-test.yml index b20a0ce..830729c 100644 --- a/.github/workflows/ci-test.yml +++ b/.github/workflows/ci-test.yml @@ -34,7 +34,7 @@ jobs: - name: Build and test shell: pwsh - run: Invoke-Build -Configuration Release Build, Package + run: Invoke-Build -Configuration Release Build, Test, Package - name: Upload module if: always() diff --git a/.gitignore b/.gitignore index 80046ed..c88f4ef 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,12 @@ bin/ obj/ publish/ *.sln + +# IDE support (keep locally, don't track) +/.vs/ +*.user +*.suo +*.sln.DotSettings +Properties/launchSettings.json +nuget.local.config +GraphicalTools.Dev.slnx diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..a3ae239 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,7 @@ +{ + "recommendations": [ + "ms-dotnettools.csdevkit", + "ms-dotnettools.csharp", + "ms-vscode.powershell" + ] +} diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..19408eb --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,40 @@ +{ + // Single debug profile that prompts for a sample command at launch. + // Add new scenarios by appending an option to the "sampleCommand" input below. + "version": "0.2.0", + "inputs": [ + { + "id": "sampleCommand", + "type": "pickString", + "description": "Sample command to run after importing the module", + "default": "Get-Process | Out-ConsoleGridView -Debug", + "options": [ + "Get-Process | Out-ConsoleGridView -Debug", + "Get-Process | Select-Object ProcessName, Id, CPU | Out-ConsoleGridView -Debug -Filter com", + "Get-Process | Out-ConsoleGridView -MinUi", + "Get-Process | Select-Object ProcessName, Id, Handles, NPM, PM, WS, CPU | Out-ConsoleGridView", + "Get-ChildItem | Out-ConsoleGridView -OutputMode Single", + "Get-Process | Show-ObjectTree" + ] + } + ], + "configurations": [ + { + "name": "ConsoleGuiTools", + "type": "coreclr", + "request": "launch", + "preLaunchTask": "build", + "program": "pwsh", + "args": [ + "-NoProfile", + "-NoLogo", + "-NoExit", + "-Command", + "Import-Module ${workspaceFolder}/module/Microsoft.PowerShell.ConsoleGuiTools.psd1; ${input:sampleCommand}" + ], + "cwd": "${workspaceFolder}", + "console": "integratedTerminal", + "stopAtEntry": false + } + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..23830fb --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "git.ignoreLimitWarning": true +} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..ff8628d --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,60 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "build", + "detail": "Build module via Invoke-Build (copies to ./module/)", + "type": "process", + "command": "pwsh", + "args": [ + "-NoProfile", + "-Command", + "Invoke-Build Build" + ], + "options": { + "cwd": "${workspaceFolder}" + }, + "group": { + "kind": "build", + "isDefault": true + }, + "presentation": { + "reveal": "silent", + "panel": "shared", + "clear": true + }, + "problemMatcher": "$msCompile" + }, + { + "label": "test", + "detail": "Run xunit tests via dotnet test (resolves GraphicalTools.slnx)", + "type": "process", + "command": "dotnet", + "args": [ + "test" + ], + "options": { + "cwd": "${workspaceFolder}" + }, + "group": { + "kind": "test", + "isDefault": true + }, + "problemMatcher": "$msCompile" + }, + { + "label": "clean", + "type": "process", + "command": "pwsh", + "args": [ + "-NoProfile", + "-Command", + "Invoke-Build Clean" + ], + "options": { + "cwd": "${workspaceFolder}" + }, + "problemMatcher": [] + } + ] +} diff --git a/ConsoleGuiTools.Common.props b/ConsoleGuiTools.Common.props index 390d688..7db7c9b 100644 --- a/ConsoleGuiTools.Common.props +++ b/ConsoleGuiTools.Common.props @@ -1,6 +1,6 @@ - 0.7.7 + 1.0.0 Microsoft © Microsoft Corporation. diff --git a/ConsoleGuiTools.build.ps1 b/ConsoleGuiTools.build.ps1 index 3fa225b..e33e413 100644 --- a/ConsoleGuiTools.build.ps1 +++ b/ConsoleGuiTools.build.ps1 @@ -23,15 +23,18 @@ task Build { Push-Location src/Microsoft.PowerShell.ConsoleGuiTools Invoke-BuildExec { & dotnet publish --configuration $Configuration --output publish } - $Assets = $( - "./publish/Microsoft.PowerShell.ConsoleGuiTools.dll", - "./publish/Microsoft.PowerShell.ConsoleGuiTools.psd1", - "./publish/Microsoft.PowerShell.OutGridView.Models.dll", - "./publish/Terminal.Gui.dll", - "./publish/NStack.dll") - $Assets | ForEach-Object { - Copy-Item -Force -Path $_ -Destination ../../module + + # Copy all DLLs except PowerShell SDK dependencies (those are provided by PowerShell itself) + Get-ChildItem "./publish/*.dll" | Where-Object { + $_.Name -notlike "System.Management.Automation.dll" -and + $_.Name -notlike "Microsoft.PowerShell.Commands.Diagnostics.dll" -and + $_.Name -notlike "Microsoft.Management.Infrastructure.CimCmdlets.dll" + } | ForEach-Object { + Copy-Item -Force -Path $_.FullName -Destination ../../module } + + # Copy the module manifest + Copy-Item -Force -Path "./publish/Microsoft.PowerShell.ConsoleGuiTools.psd1" -Destination ../../module Pop-Location $Assets = $( @@ -45,6 +48,10 @@ task Build { New-ExternalHelp -Path docs/Microsoft.PowerShell.ConsoleGuiTools -OutputPath module/en-US -Force } +task Test { + Invoke-BuildExec { & dotnet test GraphicalTools.slnx --configuration $Configuration } +} + task Package { New-Item -ItemType Directory -Force ./out | Out-Null if (-Not (Get-PSResourceRepository -Name ConsoleGuiTools -ErrorAction SilentlyContinue)) { @@ -53,4 +60,4 @@ task Package { Publish-PSResource -Path ./module -Repository ConsoleGuiTools -Verbose } -task . Clean, Build +task . Clean, Build, Test diff --git a/Directory.Build.props b/Directory.Build.props index 1932808..0f11888 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -1,5 +1,8 @@ true + + $(MSBuildThisFileDirectory)nuget.local.config diff --git a/Directory.Packages.props b/Directory.Packages.props index be0590b..a10e43c 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -1,8 +1,13 @@ - - - - + + + + + + + + + - + \ No newline at end of file diff --git a/GraphicalTools.slnx b/GraphicalTools.slnx new file mode 100644 index 0000000..b4c8b8f --- /dev/null +++ b/GraphicalTools.slnx @@ -0,0 +1,5 @@ + + + + + diff --git a/README.md b/README.md index 71bf677..538333c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # ConsoleGuiTools - `Out-ConsoleGridView` and `Show-ObjectTree` -This repo contains the `Out-ConsoleGridView` -PowerShell Cmdlet providing console-based GUI experiences based on +This repo contains the `Out-ConsoleGridView` and `Show-ObjectTree` +PowerShell Cmdlets providing console-based GUI experiences based on [Terminal.Gui (gui.cs)](https://github.com/gui-cs/Terminal.Gui). _Note:_ A module named `Microsoft.PowerShell.GraphicalTools` used to be built and published out of this repo, but per [#101](https://github.com/PowerShell/ConsoleGuiTools/issues/101) it is deprecated and unmaintained until such time that it can be rewritten on top of [.NET MAUI](https://devblogs.microsoft.com/dotnet/introducing-net-multi-platform-app-ui/). @@ -14,7 +14,7 @@ Install-Module Microsoft.PowerShell.ConsoleGuiTools ## Features -* [`Out-ConsoleGridview`](docs/Microsoft.PowerShell.ConsoleGuiTools/Out-ConsoleGridView.md) - Send objects to a grid view window for interactive filtering and sorting. +* [`Out-ConsoleGridView`](docs/Microsoft.PowerShell.ConsoleGuiTools/Out-ConsoleGridView.md) - Send objects to an interactive table view with column headers, horizontal scrolling, streaming, sorting, and native multi-selection. * [`Show-ObjectTree`](docs/Microsoft.PowerShell.ConsoleGuiTools/Show-ObjectTree.md) - Send objects to a tree view window for interactive filtering and sorting. * Cross-platform - Works on any platform that supports PowerShell 7.2+. @@ -122,18 +122,34 @@ Whatever was typed on the command line prior to hitting `F7` or `Shift-F7` will ### Example 8: Output processes to a tree view ```PowerShell -PS C:\> Get-Process | Show-ObjectTree +Get-Process | Show-ObjectTree ``` This command gets the processes running on the local computer and sends them to a tree view window. Use right arrow when a row has a `+` symbol to expand the tree. Left arrow will collapse the tree. +### Example 9: Output processes to a grid view with streaming + +```PowerShell +Get-Process | Out-ConsoleGridView +``` + +This command gets the processes running on the local computer and sends them to an interactive table with column headers. The table appears as soon as the first object arrives — rows stream in as the pipeline executes. + +### Example 10: Search for a specific row in the grid view + +```PowerShell +Get-Service | ocgv -Search "wuauserv" -Focus Filter +``` + +This command displays all services in a grid view, positions the cursor on the first row matching "wuauserv", and starts with focus in the filter field. + ## Development -### 1. Install PowerShell 7.2+ +### 1. Install PowerShell 7.6+ -Install PowerShell 7.2+ with [these instructions](https://github.com/PowerShell/PowerShell#get-powershell). +Install PowerShell 7.6+ with [these instructions](https://github.com/PowerShell/PowerShell#get-powershell). ### 2. Clone the GitHub repository @@ -203,7 +219,7 @@ to learn more. `ConsoleGuiTools` consists of 2 .NET Projects: -* ConsoleGuiTools - Cmdlet implementation for Out-ConsoleGridView +* ConsoleGuiTools - Cmdlet implementation for Out-ConsoleGridView and Show-ObjectTree * OutGridView.Models - Contains data contracts between the GUI & Cmdlet _Note:_ Previously, this repo included `Microsoft.PowerShell.GraphicalTools` which included the Avalonia-based `Out-GridView` (implemented in `.\Microsoft.PowerShell.GraphicalTools` and `.\OutGridView.Gui`). These components have been deprecated (see note above). diff --git a/docs/Microsoft.PowerShell.ConsoleGuiTools/Out-ConsoleGridView.md b/docs/Microsoft.PowerShell.ConsoleGuiTools/Out-ConsoleGridView.md index 895bce4..6805c04 100644 --- a/docs/Microsoft.PowerShell.ConsoleGuiTools/Out-ConsoleGridView.md +++ b/docs/Microsoft.PowerShell.ConsoleGuiTools/Out-ConsoleGridView.md @@ -3,7 +3,7 @@ external help file: ConsoleGuiToolsModule.dll-Help.xml keywords: powershell,cmdlet locale: en-us Module Name: Microsoft.PowerShell.ConsoleGuiTools -ms.date: 08/24/2022 +ms.date: 05/04/2026 schema: 2.0.0 title: Out-ConsoleGridView --- @@ -12,42 +12,41 @@ title: Out-ConsoleGridView ## SYNOPSIS -Sends output to an interactive table in the same console window. +Sends output to an interactive table view with column headers, horizontal scrolling, sorting, and streaming support. ## SYNTAX ```PowerShell Out-ConsoleGridView [-InputObject ] [-Title ] [-OutputMode {None | Single | - Multiple}] [-Filter ] [-MinUi] [] + Multiple}] [-Filter ] [-Search ] [-Focus {Table | Filter}] [-MinUI] + [-FullScreen] [-Driver ] [] ``` ## DESCRIPTION -The **Out-ConsoleGridView** cmdlet sends the output from a command to a grid view window where the output is displayed in an interactive table. +The **Out-ConsoleGridView** cmdlet sends the output from a command to a grid view window where the output is displayed in an interactive table with column headers, column sizing, horizontal scrolling, and column sorting. -You can use the following features of the table to examine your data: +Use the Filter box at the top of the window to search the text in the table using regular expressions. Unlike the Filter, the `-Search` parameter positions the cursor on the first matching row without hiding non-matching rows. -- Quick Filter. Use the Filter box at the top of the window to search the text in the table. You can search for text in a particular column, search for literals, and search for multiple words. You can use the `-Filter` command to pre-populate the Filter box. The filter uses regular expressions. +Objects are streamed into the table as they arrive from the pipeline — the UI appears immediately and rows are added incrementally. A spinner in the status bar indicates loading is in progress. -For instructions for using these features, type `Get-Help Out-ConsoleGridView -Full` and see How to Use the Grid View Window Features in the Notes section. - -To send items from the interactive window down the pipeline, click to select the items (either the the mouse in terminals that support mouse or the `SPACE` key) and then press `ENTER`. `ESC` cancels. +To send items from the interactive window down the pipeline, select rows (use arrow keys and `SPACE` or click with the mouse) and then press `ENTER`. Press `ESC` to cancel without output. Use `Ctrl+A` to select all rows, or `Ctrl+D` to deselect all. Click column headers to sort. ## EXAMPLES ### Example 1: Output processes to a grid view ```PowerShell -PS C:\> Get-Process | Out-ConsoleGridView +Get-Process | Out-ConsoleGridView ``` -This command gets the processes running on the local computer and sends them to a grid view window. +This command gets the processes running on the local computer and sends them to a grid view window with column headers for each property. The table appears as soon as the first object arrives — rows stream in as the pipeline executes. ### Example 2: Use a variable to output processes to a grid view ```PowerShell -PS C:\> $P = Get-Process -PS C:\> $P | Out-ConsoleGridView -OutputMode Single +$P = Get-Process +$P | Out-ConsoleGridView -OutputMode Single ``` This command also gets the processes running on the local computer and sends them to a grid view window. @@ -56,12 +55,12 @@ The first command uses the Get-Process cmdlet to get the processes on the comput The second command uses a pipeline operator to send the $P variable to **Out-ConsoleGridView**. -By specifying `-OutputMode Single` the grid view window will be restricted to a single selection, ensuring now more than a single object is returned. +By specifying `-OutputMode Single` the grid view window will be restricted to a single selection, ensuring no more than a single object is returned. ### Example 3: Display a formatted table in a grid view ```PowerShell -PS C:\> Get-Process | Select-Object -Property Name, WorkingSet, PeakWorkingSet | Sort-Object -Property WorkingSet -Descending | Out-ConsoleGridView +Get-Process | Select-Object -Property Name, WorkingSet, PeakWorkingSet | Sort-Object -Property WorkingSet -Descending | Out-ConsoleGridView ``` This command displays a formatted table in a grid view window. @@ -80,7 +79,7 @@ You can now use the features of the grid view to search, sort, and filter the da ### Example 4: Save output to a variable, and then output a grid view ```PowerShell -PS C:\> ($A = Get-ChildItem -Path $pshome -Recurse) | Out-ConsoleGridView +($A = Get-ChildItem -Path $pshome -Recurse) | Out-ConsoleGridView ``` This command saves its output in a variable and sends it to **Out-ConsoleGridView**. @@ -96,7 +95,7 @@ As a result, the output from the Get-ChildItem command is saved in the $A variab ### Example 5: Output processes for a specified computer to a grid view ```PowerShell -PS C:\> Get-Process -ComputerName "Server01" | ocgv -Title "Processes - Server01" +Get-Process -ComputerName "Server01" | ocgv -Title "Processes - Server01" ``` This command displays the processes that are running on the Server01 computer in a grid view window. @@ -106,24 +105,23 @@ The command uses `ocgv`, which is the built-in alias for the **Out-ConsoleGridVi ### Example 6: Define a function to kill processes using a graphical chooser ```PowerShell -PS C:\> function killp { Get-Process | Out-ConsoleGridView -OutputMode Single -Filter $args[0] | Stop-Process -Id {$_.Id} } -PS C:\> killp note +function killp { Get-Process | Out-ConsoleGridView -OutputMode Single -Filter $args[0] | Stop-Process -Id {$_.Id} } +killp note ``` This example shows defining a function named `killp` that shows a grid view of all running processes and allows the user to select one to kill it. -The example uses the `-Filter` paramter to filter for all proceses with a name that includes `note` (thus highlighting `Notepad` if it were running. Selecting an item in the grid view and pressing `ENTER` will kill that process. +The example uses the `-Filter` parameter to filter for all processes with a name that includes `note` (thus highlighting `Notepad` if it were running). Selecting an item in the grid view and pressing `ENTER` will kill that process. ### Example 7: Pass multiple items through Out-ConsoleGridView ```PowerShell -PS C:\> Get-Process | Out-ConsoleGridView -PassThru | Export-Csv -Path .\ProcessLog.csv +Get-Process | Out-ConsoleGridView -OutputMode Multiple | Export-Csv -Path .\ProcessLog.csv ``` This command lets you select multiple processes from the **Out-ConsoleGridView** window. The processes that you select are passed to the **Export-Csv** command and written to the ProcessLog.csv file. -The command uses the *PassThru* parameter of **Out-ConsoleGridView**, which lets you send multiple items down the pipeline. -The *PassThru* parameter is equivalent to using the Multiple value of the *OutputMode* parameter. +By default, `-OutputMode` is `Multiple`, which lets you send multiple items down the pipeline. ### Example 8: Use F7 as "Show Command History" @@ -133,14 +131,46 @@ Press `F7` to see the history for the current PowerShell instance Press `Shift-F7` to see the history for all PowerShell instances. -Whatever you select within `Out-ConsoleGridView` will be inserted on your command line. +Whatever you select within `Out-ConsoleGridView` will be inserted on your command line. Whatever was typed on the command line prior to hitting `F7` or `Shift-F7` will be used as a filter. +### Example 9: Search for a row without filtering + +```PowerShell +Get-Service | ocgv -Search "wuauserv" +``` + +This command displays all services but positions the cursor on the first row matching "wuauserv". Unlike `-Filter`, all rows remain visible. + +### Example 10: Start with focus on the filter field + +```PowerShell +Get-ChildItem | ocgv -Focus Filter +``` + +This command opens the grid view with the cursor in the filter text field, ready to type a filter immediately. Pressing `ENTER` while in the filter field accepts the currently selected item(s). + +### Example 11: Full screen mode with a custom title + +```PowerShell +Get-Process | ocgv -FullScreen -Title "Process Monitor" +``` + +This command runs the grid view in full-screen mode using the alternate screen buffer, with a custom window title. + +### Example 12: Minimal UI for scripting + +```PowerShell +Get-Process | ocgv -MinUI -OutputMode Single +``` + +This command shows the grid view with no window frame, filter box, or status bar — just the table. Useful for quick selection in scripts. + ## PARAMETERS ### -Filter -Pre-populates the Filter edit box, allowing filtering to be specified on the command line. +Pre-populates the Filter edit box, hiding rows that do not match the regular expression pattern. ```yaml Type: String @@ -154,12 +184,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Search +Positions the cursor on the first row matching this regular expression pattern. Unlike `-Filter`, non-matching rows remain visible. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Focus +Specifies which UI element receives initial focus. + +- **Table** (default): The table view receives focus. Use arrow keys to navigate immediately. +- **Filter**: The filter text field receives focus. Start typing to filter. Press `ENTER` to accept the selected item(s). + +```yaml +Type: FocusTarget +Parameter Sets: (All) +Aliases: +Accepted values: Table, Filter + +Required: False +Position: Named +Default value: Table +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject Specifies that the cmdlet accepts input for **Out-ConsoleGridView**. When you use the **InputObject** parameter to send a collection of objects to **Out-ConsoleGridView**, **Out-ConsoleGridView** treats the collection as one collection object, and it displays one row that represents the collection. -To display the each object in the collection, use a pipeline operator (|) to send objects to **Out-ConsoleGridView**. +To display each object in the collection, use a pipeline operator (|) to send objects to **Out-ConsoleGridView**. ```yaml Type: PSObject @@ -177,13 +241,13 @@ Accept wildcard characters: False Specifies the items that the interactive window sends down the pipeline as input to other commands. By default, this cmdlet generates zero, one, or many items. -To send items from the interactive window down the pipeline, click to select the items (either the the mouse in terminals that support mouse or the `SPACE` key) and then press `ENTER`. `ESC` cancels. +To send items from the interactive window down the pipeline, select items and press `ENTER`. `ESC` cancels. The values of this parameter determine how many items you can send down the pipeline. -- None. No items. -- Single. Zero items or one item. Use this value when the next command can take only one input object. -- Multiple. Zero, one, or many items. Use this value when the next command can take multiple input objects. This is the default value. +- None. No items. +- Single. Zero items or one item. Use this value when the next command can take only one input object. +- Multiple. Zero, one, or many items. Use this value when the next command can take multiple input objects. This is the default value. ```yaml Type: OutputModeOption @@ -215,8 +279,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinUi -If specified no window frame, filter box, or status bar will be displayed in the **Out-ConsoleGridView** window. +### -MinUI +If specified, no window frame, filter box, or status bar will be displayed. The table is shown without chrome. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Driver +Sets the Terminal.Gui driver to use. Valid values are `ansi`, `windows`, or `unix`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForceDriver + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullScreen +If specified, the application runs in full-screen mode using the alternate screen buffer. By default, the application renders inline in the current terminal. ```yaml Type: SwitchParameter @@ -231,30 +325,40 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject -You can send any object to this cmdlet. +You can send any object to this cmdlet. Objects are streamed — the UI appears as soon as the first object arrives. ## OUTPUTS ### System.Object -By default `Out-ConsoleGridView` returns objects representing the selected rows to the pipeline. Use `-OutputMode` to change this behavior. +By default **Out-ConsoleGridView** returns objects representing the selected rows to the pipeline. Use `-OutputMode` to change this behavior. ## NOTES -* The command output that you send to **Out-ConsoleGridView** should not be formatted, such as by using the Format-Table or Format-Wide cmdlets. To select properties, use the Select-Object cmdlet. +* **Out-ConsoleGridView** uses Terminal.Gui's `TableView` control which provides column headers, column sizing, horizontal scrolling, column sorting, and native multi-row selection. -* Deserialized output from remote commands might not be formatted correctly in the grid view window. +* The alias for **Out-ConsoleGridView** is `ocgv`. -## RELATED LINKS +* Objects are streamed into the table as they arrive from the pipeline. The UI appears immediately on the first object and rows are added incrementally. A spinner in the status bar indicates loading is in progress. + +* The command output that you send to **Out-ConsoleGridView** should not be formatted, such as by using the Format-Table or Format-Wide cmdlets. To select properties, use the Select-Object cmdlet. -[Out-File](Out-File.md) +* Keyboard shortcuts: + - `ENTER` — Accept selection and close + - `ESC` — Cancel and close + - `Ctrl+A` — Select all rows (when OutputMode is Multiple) + - `Ctrl+D` — Deselect all rows (when OutputMode is Multiple) + - `Home`/`End` — Jump to first/last row + - Arrow keys — Navigate rows and columns + - `Tab` — Move focus between filter and table + - Click column headers — Sort by that column -[Out-Printer](Out-Printer.md) +## RELATED LINKS -[Out-String](Out-String.md) +[Show-ObjectTree](Show-ObjectTree.md) diff --git a/docs/Microsoft.PowerShell.ConsoleGuiTools/Show-ObjectTree.md b/docs/Microsoft.PowerShell.ConsoleGuiTools/Show-ObjectTree.md index d7bde95..87b9aa1 100644 --- a/docs/Microsoft.PowerShell.ConsoleGuiTools/Show-ObjectTree.md +++ b/docs/Microsoft.PowerShell.ConsoleGuiTools/Show-ObjectTree.md @@ -17,16 +17,14 @@ Sends output to an interactive tree in the same console window. ## SYNTAX ```PowerShell -Show-ObjectTree [-InputObject ] [-Title ] [-Filter ] [-MinUi] [-UseNetDriver] [] +Show-ObjectTree [-InputObject ] [-Title ] [-Filter ] [-MinUi] [-Driver ] [-FullScreen] [] ``` ## DESCRIPTION The **Show-ObjectTree** cmdlet sends the output from a command to a tree view window where the output is displayed in an interactive tree. -You can use the following features of the tree to examine your data: - -- Quick Filter. Use the Filter box at the top of the window to search the text in the tree. You can search for literals or multiple words. You can use the `-Filter` command to pre-populate the Filter box. The filter uses regular expressions. +Use the Filter box at the top of the window to search the text in the tree including literals or multiple words. Use the `-Filter` parameter to pre-populate the Filter box. The filter uses regular expressions. For instructions for using these features, type `Get-Help Show-ObjectTree -Full` and see How to Use the Tree View Window Features in the Notes section. @@ -35,7 +33,7 @@ For instructions for using these features, type `Get-Help Show-ObjectTree -Full` ### Example 1: Output processes to a tree view ```PowerShell -PS C:\> Get-Process | Show-ObjectTree +Get-Process | Show-ObjectTree ``` This command gets the processes running on the local computer and sends them to a tree view window. @@ -43,12 +41,13 @@ This command gets the processes running on the local computer and sends them to ### Example 2: Save output to a variable, and then output a tree view ```PowerShell -PS C:\> ($A = Get-ChildItem -Path $pshome -Recurse) | shot +($A = Get-ChildItem -Path $pshome -Recurse) | shot ``` This command saves its output in a variable and sends it to **Show-ObjectTree**. The command uses the Get-ChildItem cmdlet to get the files in the Windows PowerShell installation directory and its subdirectories. + The path to the installation directory is saved in the $pshome automatic variable. The command uses the assignment operator (=) to save the output in the $A variable and the pipeline operator (|) to send the output to **Show-ObjectTree**. @@ -76,7 +75,7 @@ Accept wildcard characters: False ### -InputObject Specifies that the cmdlet accepts input for **Show-ObjectTree**. -When you use the **InputObject** parameter to send a collection of objects to **Show-ObjectTree**, **Show-ObjectTree** treats the collection as one collection object, and it displays one row that represents the collection. +The **InputObject** parameter enables sending a collection of objects to **Show-ObjectTree**, **Show-ObjectTree** treats the collection as one collection object, and it displays one row that represents the collection. To display the each object in the collection, use a pipeline operator (|) to send objects to **Show-ObjectTree**. @@ -110,7 +109,37 @@ Accept wildcard characters: False ``` ### -MinUi -If specified no window frame, filter box, or status bar will be displayed in the **Show-ObjectTree** window. +If specified no title or status bar will be displayed in the **Show-ObjectTree** window. The filter will only be displayed if `-Filter` is specified. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Driver +Specifies the Terminal.Gui driver to use. Valid values are `ansi`, `windows`, or `unix`. The default is `ansi`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: ansi +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullScreen +If specified, the application runs in full-screen mode using the alternate screen buffer. By default, the application renders inline. ```yaml Type: SwitchParameter @@ -141,7 +170,7 @@ You can send any object to this cmdlet. ## NOTES -* The command output that you send to **Show-ObjectTree** should not be formatted, such as by using the Format-Table or Format-Wide cmdlets. To select properties, use the Select-Object cmdlet. +* The command output sent to **Show-ObjectTree** should not be formatted, such as by using the Format-Table or Format-Wide cmdlets. To select properties, use the Select-Object cmdlet. * Deserialized output from remote commands might not be formatted correctly in the tree view window. diff --git a/global.json b/global.json index 19e4d7e..a1ce647 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "8.0.405", + "version": "10.0.101", "rollForward": "latestFeature", "allowPrerelease": false } diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/CachedMemberResult.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/CachedMemberResult.cs new file mode 100644 index 0000000..14534c5 --- /dev/null +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/CachedMemberResult.cs @@ -0,0 +1,152 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Linq; +using System.Reflection; + +namespace Microsoft.PowerShell.ConsoleGuiTools; + +/// +/// Represents a cached reflection result for a property or field member, including its value and collection details. +/// +internal sealed class CachedMemberResult +{ + #region Fields + + private readonly string? _representation; + private List? _valueAsList; + + #endregion + + #region Properties + + /// + /// Gets or sets the member information (property or field) that was accessed. + /// + public MemberInfo Member { get; set; } + + /// + /// Gets or sets the value retrieved from the member. + /// + public object? Value { get; set; } + + /// + /// Gets or sets the parent object that contains this member. + /// + public object Parent { get; set; } + + /// + /// Gets a value indicating whether this member's value is a collection. + /// + public bool IsCollection => _valueAsList != null; + + /// + /// Gets the collection elements if this member's value is a collection; otherwise, . + /// + public IReadOnlyCollection? Elements => _valueAsList?.AsReadOnly(); + + #endregion + + #region Constructor + + /// + /// Initializes a new instance of the class by reflecting on the specified member. + /// + /// The parent object containing the member. + /// The member information to retrieve the value from. + public CachedMemberResult(object parent, MemberInfo mem) + { + Parent = parent; + Member = mem; + + try + { + if (mem is PropertyInfo p) + Value = p.GetValue(parent); + else if (mem is FieldInfo f) + Value = f.GetValue(parent); + else + throw new NotSupportedException($"Unknown {nameof(MemberInfo)} Type"); + + _representation = ValueToString(); + } + catch (Exception) + { + Value = _representation = "Unavailable"; + } + } + + #endregion + + #region Overrides + + /// + /// Returns a string representation of this member in the format "MemberName: value". + /// + /// A formatted string showing the member name and value. + public override string ToString() => Member.Name + ": " + _representation; + + #endregion + + #region Private Methods + + /// + /// Converts the member's value to a string representation, detecting collections and formatting them appropriately. + /// + /// A string representation of the value. + private string? ValueToString() + { + if (Value == null) + return "Null"; + + try + { + if (IsCollectionOfKnownTypeAndSize(out var elementType, out var size)) + return $"{elementType!.Name}[{size}]"; + } + catch (Exception) + { + return Value?.ToString(); + } + + return Value?.ToString(); + } + + /// + /// Determines whether the value is a collection of a known type and caches the collection elements. + /// + /// When this method returns, contains the element type if the value is a homogeneous collection; otherwise, . + /// When this method returns, contains the size of the collection if applicable; otherwise, 0. + /// if the value is a collection of a single known type; otherwise, . + private bool IsCollectionOfKnownTypeAndSize(out Type? elementType, out int size) + { + elementType = null; + size = 0; + + if (Value is null or string) + return false; + + if (Value is IEnumerable enumerable) + { + var list = enumerable.Cast().ToList(); + + var types = list.Where(v => v != null).Select(v => v!.GetType()).Distinct().ToArray(); + + if (types.Length == 1) + { + elementType = types[0]; + size = list.Count; + + _valueAsList = list.Select((e, i) => new CachedMemberResultElement(e, i)).ToList(); + return true; + } + } + + return false; + } + + #endregion +} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/CachedMemberResultElement.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/CachedMemberResultElement.cs new file mode 100644 index 0000000..7efa001 --- /dev/null +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/CachedMemberResultElement.cs @@ -0,0 +1,62 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System; + +namespace Microsoft.PowerShell.ConsoleGuiTools; + +/// +/// Represents an element within a collection member result, providing indexed access to collection items. +/// +internal sealed class CachedMemberResultElement +{ + #region Fields + + /// + /// The index of this element within the collection. + /// + public int Index; + + /// + /// The value of this collection element. + /// + public object? Value; + + private readonly string _representation; + + #endregion + + #region Constructor + + /// + /// Initializes a new instance of the class with the specified value and index. + /// + /// The value of the collection element. + /// The zero-based index of this element within the collection. + public CachedMemberResultElement(object? value, int index) + { + Index = index; + Value = value; + + try + { + _representation = Value?.ToString() ?? "Null"; + } + catch (Exception) + { + Value = _representation = "Unavailable"; + } + } + + #endregion + + #region Overrides + + /// + /// Returns a string representation of this collection element in the format "[index]: value". + /// + /// A formatted string showing the index and value. + public override string ToString() => $"[{Index}]: {_representation}]"; + + #endregion +} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/ConsoleGui.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/ConsoleGui.cs deleted file mode 100644 index e4385e1..0000000 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/ConsoleGui.cs +++ /dev/null @@ -1,443 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using System; -using System.Collections.Generic; -using System.Diagnostics; -using System.Linq; -using System.Reflection; -using System.Text; - -using OutGridView.Models; - -using Terminal.Gui; - -namespace OutGridView.Cmdlet -{ - internal sealed class ConsoleGui : IDisposable - { - private const string FILTER_LABEL = "Filter"; - // This adjusts the left margin of all controls - private const int MARGIN_LEFT = 1; - // Width of Terminal.Gui ListView selection/check UI elements (old == 4, new == 2) - private const int CHECK_WIDTH = 2; - private bool _cancelled; - private Label _filterLabel; - private TextField _filterField; - private ListView _listView; - // _inputSource contains the full set of Input data and tracks any items the user - // marks. When the cmdlet exits, any marked items are returned. When a filter is - // active, the list view shows a copy of _inputSource that includes both the items - // matching the filter AND any items previously marked. - private GridViewDataSource _inputSource; - - // _listViewSource is a filtered copy of _inputSource that ListView.Source is set to. - // Changes to IsMarked are propogated back to _inputSource. - private GridViewDataSource _listViewSource; - private ApplicationData _applicationData; - private GridViewDetails _gridViewDetails; - - public HashSet Start(ApplicationData applicationData) - { - _applicationData = applicationData; - // Note, in Terminal.Gui v2, this property is renamed to Application.UseNetDriver, hence - // using that terminology here. - Application.UseSystemConsole = _applicationData.UseNetDriver; - Application.Init(); - _gridViewDetails = new GridViewDetails - { - // If OutputMode is Single or Multiple, then we make items selectable. If we make them selectable, - // 2 columns are required for the check/selection indicator and space. - ListViewOffset = _applicationData.OutputMode != OutputModeOption.None ? MARGIN_LEFT + CHECK_WIDTH : MARGIN_LEFT - }; - - Window win = CreateTopLevelWindow(); - - // Create the headers and calculate column widths based on the DataTable - List gridHeaders = _applicationData.DataTable.DataColumns.Select((c) => c.Label).ToList(); - CalculateColumnWidths(gridHeaders); - - // Copy the input DataTable into our master ListView source list; upon exit any items - // that are IsMarked are returned (if Outputmode is set) - _inputSource = LoadData(); - - if (!_applicationData.MinUI) - { - // Add Filter UI - AddFilter(win); - // Add Header UI - AddHeaders(win, gridHeaders); - } - - // Add ListView - AddListView(win); - - // Status bar is where our key-bindings are handled - AddStatusBar(!_applicationData.MinUI); - - // We *always* apply a filter, even if the -Filter parameter is not set or Filtering is not - // available. The ListView always shows a fitlered version of _inputSource even if there is no - // actual fitler. - ApplyFilter(); - - _listView.SetFocus(); - - // Run the GUI. - Application.Run(); - Application.Shutdown(); - - // Return results of selection if required. - HashSet selectedIndexes = new HashSet(); - if (_cancelled) - { - return selectedIndexes; - } - - // Return any items that were selected. - foreach (GridViewRow gvr in _inputSource.GridViewRowList) - { - if (gvr.IsMarked) - { - selectedIndexes.Add(gvr.OriginalIndex); - } - } - - return selectedIndexes; - } - - private GridViewDataSource LoadData() - { - var items = new List(); - int newIndex = 0; - for (int i = 0; i < _applicationData.DataTable.Data.Count; i++) - { - var dataTableRow = _applicationData.DataTable.Data[i]; - var valueList = new List(); - foreach (var dataTableColumn in _applicationData.DataTable.DataColumns) - { - string dataValue = dataTableRow.Values[dataTableColumn.ToString()].DisplayValue; - valueList.Add(dataValue); - } - - string displayString = GridViewHelpers.GetPaddedString(valueList, 0, _gridViewDetails.ListViewColumnWidths); - - items.Add(new GridViewRow - { - DisplayString = displayString, - // We use this to keep _inputSource up to date when a filter is applied - OriginalIndex = i - }); - - newIndex++; - } - - return new GridViewDataSource(items); - } - - private void ApplyFilter() - { - // The ListView is always filled with a (filtered) copy of _inputSource. - // We listen for `MarkChanged` events on this filtered list and apply those changes up to _inputSource. - - if (_listViewSource != null) - { - _listViewSource.MarkChanged -= ListViewSource_MarkChanged; - _listViewSource = null; - } - - _listViewSource = new GridViewDataSource(GridViewHelpers.FilterData(_inputSource.GridViewRowList, _applicationData.Filter ?? string.Empty)); - _listViewSource.MarkChanged += ListViewSource_MarkChanged; - _listView.Source = _listViewSource; - } - - private void ListViewSource_MarkChanged(object s, GridViewDataSource.RowMarkedEventArgs a) - { - _inputSource.GridViewRowList[a.Row.OriginalIndex].IsMarked = a.Row.IsMarked; - } - - private static void Accept() - { - Application.RequestStop(); - } - - private void Close() - { - _cancelled = true; - Application.RequestStop(); - } - - private Window CreateTopLevelWindow() - { - // Creates the top-level window to show - var win = new Window(_applicationData.Title) - { - X = _applicationData.MinUI ? -1 : 0, - Y = _applicationData.MinUI ? -1 : 0, - - // By using Dim.Fill(), it will automatically resize without manual intervention - Width = Dim.Fill(_applicationData.MinUI ? -1 : 0), - Height = Dim.Fill(_applicationData.MinUI ? -1 : 1) - }; - - if (_applicationData.MinUI) - { - win.Border.BorderStyle = BorderStyle.None; - } - - Application.Top.Add(win); - return win; - } - - private void AddStatusBar(bool visible) - { - var statusItems = new List(); - 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) - { - // 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 && - _inputSource.GridViewRowList.Find(i => i.IsMarked) == null) - { - _listView.MarkUnmarkRow(); - } - Accept(); - } - else if (Application.Top.MostFocused == _filterField) - { - _listView.SetFocus(); - } - })); - } - - statusItems.Add(new StatusItem(Key.Esc, "~ESC~ Close", () => Close())); - if (_applicationData.Verbose || _applicationData.Debug) - { - statusItems.Add(new StatusItem(Key.Null, $" v{_applicationData.ModuleVersion}", null)); - statusItems.Add(new StatusItem(Key.Null, - $"{Application.Driver} v{FileVersionInfo.GetVersionInfo(Assembly.GetAssembly(typeof(Application)).Location).ProductVersion}", null)); - } - - var statusBar = new StatusBar(statusItems.ToArray()); - statusBar.Visible = visible; - Application.Top.Add(statusBar); - } - - private void CalculateColumnWidths(List gridHeaders) - { - _gridViewDetails.ListViewColumnWidths = new int[gridHeaders.Count]; - var listViewColumnWidths = _gridViewDetails.ListViewColumnWidths; - - for (int i = 0; i < gridHeaders.Count; i++) - { - listViewColumnWidths[i] = gridHeaders[i].Length; - } - - // calculate the width of each column based on longest string in each column for each row - foreach (var row in _applicationData.DataTable.Data) - { - int index = 0; - - // use half of the visible buffer height for the number of objects to inspect to calculate widths - foreach (var col in row.Values.Take(Application.Top.Frame.Height / 2)) - { - var len = col.Value.DisplayValue.Length; - if (len > listViewColumnWidths[index]) - { - listViewColumnWidths[index] = len; - } - index++; - } - } - - // if the total width is wider than the usable width, remove 1 from widest column until it fits - _gridViewDetails.UsableWidth = Application.Top.Frame.Width - MARGIN_LEFT - listViewColumnWidths.Length - _gridViewDetails.ListViewOffset; - int columnWidthsSum = listViewColumnWidths.Sum(); - while (columnWidthsSum >= _gridViewDetails.UsableWidth) - { - int maxWidth = 0; - int maxIndex = 0; - for (int i = 0; i < listViewColumnWidths.Length; i++) - { - if (listViewColumnWidths[i] > maxWidth) - { - maxWidth = listViewColumnWidths[i]; - maxIndex = i; - } - } - - listViewColumnWidths[maxIndex]--; - columnWidthsSum--; - } - } - - private void AddFilter(Window win) - { - _filterLabel = new Label(FILTER_LABEL) - { - X = MARGIN_LEFT, - Y = 0 - }; - - _filterField = new TextField(_applicationData.Filter ?? string.Empty) - { - X = Pos.Right(_filterLabel) + 1, - Y = Pos.Top(_filterLabel), - CanFocus = true, - Width = Dim.Fill() - 1 - }; - - // 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, - Y = Pos.Top(_filterLabel) + 1, - ColorScheme = Colors.Base, - Width = Dim.Fill() - _filterLabel.Text.Length - }; - - _filterField.TextChanged += (str) => - { - // str is the OLD value - string filterText = _filterField.Text?.ToString(); - try - { - filterErrorLabel.Text = " "; - filterErrorLabel.ColorScheme = Colors.Base; - filterErrorLabel.Redraw(filterErrorLabel.Bounds); - _applicationData.Filter = filterText; - ApplyFilter(); - - } - catch (Exception ex) - { - filterErrorLabel.Text = ex.Message; - filterErrorLabel.ColorScheme = Colors.Error; - filterErrorLabel.Redraw(filterErrorLabel.Bounds); - } - }; - - win.Add(_filterLabel, _filterField, filterErrorLabel); - - _filterField.Text = _applicationData.Filter ?? string.Empty; - _filterField.CursorPosition = _filterField.Text.Length; - } - - private void AddHeaders(Window win, List gridHeaders) - { - var header = new Label(GridViewHelpers.GetPaddedString( - gridHeaders, - _gridViewDetails.ListViewOffset, - _gridViewDetails.ListViewColumnWidths)); - header.X = 0; - if (_applicationData.MinUI) - { - header.Y = 0; - } - else - { - header.Y = 2; - } - win.Add(header); - - // This renders dashes under the header to make it more clear what is header and what is data - var headerLineText = new StringBuilder(); - foreach (char c in header.Text) - { - if (c.Equals(' ')) - { - headerLineText.Append(' '); - } - else - { - // When gui.cs supports text decorations, should replace this with just underlining the header - headerLineText.Append('-'); - } - } - - if (!_applicationData.MinUI) - { - var headerLine = new Label(headerLineText.ToString()) - { - X = 0, - Y = Pos.Bottom(header) - }; - win.Add(headerLine); - } - } - - private void AddListView(Window win) - { - _listView = new ListView(_inputSource); - _listView.X = MARGIN_LEFT; - 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 - } - _listView.Width = Dim.Fill(1); - _listView.Height = Dim.Fill(); - _listView.AllowsMarking = _applicationData.OutputMode != OutputModeOption.None; - _listView.AllowsMultipleSelection = _applicationData.OutputMode == OutputModeOption.Multiple; - _listView.AddKeyBinding(Key.Space, Command.ToggleChecked, Command.LineDown); - - win.Add(_listView); - } - - public void Dispose() - { - if (!Console.IsInputRedirected) - { - // By emitting this, we fix two issues: - // 1. An issue where arrow keys don't work in the console because .NET - // requires application mode to support Arrow key escape sequences. - // Esc[?1h sets the cursor key to application mode - // See http://ascii-table.com/ansi-escape-sequences-vt-100.php - // 2. An issue where moving the mouse causes characters to show up because - // mouse tracking is still on. Esc[?1003l turns it off. - // See https://www.xfree86.org/current/ctlseqs.html#Mouse%20Tracking - Console.Write("\u001b[?1h\u001b[?1003l"); - } - } - } -} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDataSource.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDataSource.cs deleted file mode 100644 index 4d6724a..0000000 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDataSource.cs +++ /dev/null @@ -1,83 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using System; -using System.Collections; -using System.Collections.Generic; - -using NStack; - -using Terminal.Gui; - -namespace OutGridView.Cmdlet -{ - internal sealed class GridViewDataSource : IListDataSource - { - public List GridViewRowList { get; set; } - - public int Count => GridViewRowList.Count; - - public GridViewDataSource(List itemList) - { - GridViewRowList = itemList; - } - - public int Length { get; } - - public void Render(ListView container, ConsoleDriver driver, bool selected, int item, int col, int line, int width, int start) - { - container.Move(col, line); - RenderUstr(driver, GridViewRowList[item].DisplayString, col, line, width); - } - - public bool IsMarked(int item) => GridViewRowList[item].IsMarked; - - public void SetMark(int item, bool value) - { - var oldValue = GridViewRowList[item].IsMarked; - GridViewRowList[item].IsMarked = value; - var args = new RowMarkedEventArgs() - { - Row = GridViewRowList[item], - OldValue = oldValue - }; - MarkChanged?.Invoke(this, args); - } - - public sealed class RowMarkedEventArgs : EventArgs - { - public GridViewRow Row { get; set; } - public bool OldValue { get; set; } - - } - - public event EventHandler MarkChanged; - - public IList ToList() - { - return GridViewRowList; - } - - // A slightly adapted method from gui.cs: https://github.com/migueldeicaza/gui.cs/blob/fc1faba7452ccbdf49028ac49f0c9f0f42bbae91/Terminal.Gui/Views/ListView.cs#L433-L461 - private static void RenderUstr(ConsoleDriver driver, ustring ustr, int col, int line, int width) - { - int used = 0; - int index = 0; - while (index < ustr.Length) - { - (var rune, var size) = Utf8.DecodeRune(ustr, index, index - ustr.Length); - var count = Rune.ColumnWidth(rune); - if (used + count > width) break; - driver.AddRune(rune); - used += count; - index += size; - } - - while (used < width) - { - driver.AddRune(' '); - used++; - } - } - } -} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDetails.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDetails.cs deleted file mode 100644 index 7c660f9..0000000 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDetails.cs +++ /dev/null @@ -1,19 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -namespace OutGridView.Cmdlet -{ - internal sealed class GridViewDetails - { - // Contains the width of each column in the grid view. - public int[] ListViewColumnWidths { get; set; } - - // Dictates where the header should actually start considering - // some offset is needed to factor in the checkboxes - public int ListViewOffset { get; set; } - - // The width that is actually useable on the screen after - // subtracting space needed for a clean UI (spaces between columns, etc). - public int UsableWidth { get; set; } - } -} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewHelpers.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewHelpers.cs deleted file mode 100644 index 482fe1d..0000000 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewHelpers.cs +++ /dev/null @@ -1,66 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Text.RegularExpressions; - -namespace OutGridView.Cmdlet -{ - internal sealed class GridViewHelpers - { - // Add all items already selected plus any that match the filter - // The selected items should be at the top of the list, in their original order - public static List FilterData(List listToFilter, string filter) - { - var filteredList = new List(); - if (string.IsNullOrEmpty(filter)) - { - return listToFilter; - } - - filteredList.AddRange(listToFilter.Where(gvr => gvr.IsMarked)); - filteredList.AddRange(listToFilter.Where(gvr => !gvr.IsMarked && Regex.IsMatch(gvr.DisplayString, filter, RegexOptions.IgnoreCase))); - - return filteredList; - } - - public static string GetPaddedString(List strings, int offset, int[] listViewColumnWidths) - { - var builder = new StringBuilder(); - if (offset > 0) - { - builder.Append(string.Empty.PadRight(offset)); - } - - for (int i = 0; i < strings.Count; i++) - { - if (i > 0) - { - // Add a space between columns - builder.Append(' '); - } - - // Replace any newlines with encoded newline/linefeed (`n or `r) - // Note we can't use Environment.Newline because we don't know that the - // Command honors that. - strings[i] = strings[i].Replace("\r", "`r"); - strings[i] = strings[i].Replace("\n", "`n"); - - // If the string won't fit in the column, append an ellipsis. - if (strings[i].Length > listViewColumnWidths[i]) - { - builder.Append(strings[i], 0, listViewColumnWidths[i] - 3); - builder.Append("..."); - } - else - { - builder.Append(strings[i].PadRight(listViewColumnWidths[i])); - } - } - - return builder.ToString(); - } - } -} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewRow.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewRow.cs deleted file mode 100644 index 2ecc80e..0000000 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewRow.cs +++ /dev/null @@ -1,13 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -namespace OutGridView.Cmdlet -{ - public class GridViewRow - { - public string DisplayString { get; set; } - public bool IsMarked { get; set; } - public int OriginalIndex { get; set; } - public override string ToString() => DisplayString; - } -} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.csproj b/src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.csproj index ed25247..758e80e 100644 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.csproj +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.csproj @@ -1,7 +1,9 @@ - + - net8.0 + net10.0 + preview + enable @@ -11,26 +13,37 @@ - Add ';https://api.nuget.org/v3/index.json' to the end of the RestoreSources property group below - Uncomment the RestoreSources property group below --> - + - - + + + + - + + + + + true true Recommended + + + true + diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.psd1 b/src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.psd1 index 80c0fe8..1c452c1 100644 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.psd1 +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.psd1 @@ -9,7 +9,7 @@ RootModule = 'Microsoft.PowerShell.ConsoleGuiTools.dll' # Version number of this module. -ModuleVersion = '0.7.7' +ModuleVersion = '1.0.0' # Supported PSEditions CompatiblePSEditions = @( 'Core' ) diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridView.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridView.cs new file mode 100644 index 0000000..f557914 --- /dev/null +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridView.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System; +using System.Collections.Generic; +using System.Management.Automation; +using System.Threading; +using Microsoft.PowerShell.OutGridView.Models; +using Terminal.Gui.App; +using Terminal.Gui.Configuration; + +namespace Microsoft.PowerShell.ConsoleGuiTools; + +/// +/// Provides the main orchestration for Out-ConsoleGridView, managing the Terminal.Gui +/// application lifecycle. Supports both batch (all objects upfront) and streaming +/// (objects arrive incrementally from the pipeline) modes. +/// +internal sealed class OutConsoleGridView : IDisposable +{ + private readonly List _psObjects = []; + private readonly TypeGetter _typeGetter = new(); + private readonly ManualResetEventSlim _uiRunning = new(false); + private IApplication? _app; + private ApplicationData? _applicationData; + private List? _columns; + private OutGridViewDataSource? _dataSource; + private int _objectIndex; + private int _pendingNotify; // 0 = no pending UI update, 1 = scheduled + private HashSet? _result; + private Thread? _uiThread; + private OutGridViewWindow? _window; + + public void Dispose() + { + _uiRunning.Dispose(); + } + + /// + /// Initializes the streaming session. Call this once before feeding objects. + /// + public void Initialize(ApplicationData applicationData) + { + _applicationData = applicationData; + } + + /// + /// Adds an object from the pipeline. On the first object, starts the UI on a background thread. + /// + public void AddObject(PSObject psObject) + { + _psObjects.Add(psObject); + + if (_columns == null) + { + // First object: determine columns, add first row, then start UI + _columns = _typeGetter.GetDataColumnsForObject(psObject); + _dataSource = new OutGridViewDataSource(_columns); + var row = TypeGetter.CastObjectToDataTableRow(psObject, _columns, _objectIndex++); + _dataSource.AddRow(row); + StartUi(); + _uiRunning.Wait(); + } + else + { + var row = TypeGetter.CastObjectToDataTableRow(psObject, _columns, _objectIndex++); + _dataSource!.AddRow(row); + } + + // Coalesce UI notifications: only schedule one Invoke at a time. + // When it fires it picks up ALL rows added since the last notification. + if (Interlocked.CompareExchange(ref _pendingNotify, 1, 0) == 0) + _app?.Invoke(() => + { + Interlocked.Exchange(ref _pendingNotify, 0); + _window?.OnDataChanged(); + }); + } + + /// + /// Signals that the pipeline is complete and waits for the UI to finish. + /// Returns the selected indexes. + /// + public HashSet Complete() + { + if (_window == null) + return []; + + _app?.Invoke(() => _window.OnPipelineComplete()); + _uiThread?.Join(); + return _result ?? []; + } + + /// + /// Gets the PSObject at the given original index (for output). + /// + public PSObject GetObject(int index) + { + return _psObjects[index]; + } + + private void StartUi() + { + _uiThread = new Thread(() => + { + ConfigurationManager.AppName = "Out-ConsoleGridView"; + ConfigurationManager.Enable(ConfigLocations.All); + + _window = new OutGridViewWindow(_applicationData!, _dataSource!) + { + OnRunning = () => _uiRunning.Set() + }; + _app = Application.Create(); + _app.AppModel = _applicationData!.FullScreen ? AppModel.FullScreen : AppModel.Inline; + _app.Init(_applicationData.Driver); + _result = _app.Run(_window) as HashSet; + _window.Dispose(); + _app.Dispose(); + }) + { + IsBackground = true, + Name = "OutConsoleGridView-UI" + }; + _uiThread.Start(); + } +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridViewCmdletCommand.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridViewCmdletCommand.cs new file mode 100644 index 0000000..b34e519 --- /dev/null +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridViewCmdletCommand.cs @@ -0,0 +1,205 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Management.Automation; +using System.Management.Automation.Internal; +using Microsoft.PowerShell.OutGridView.Models; + +namespace Microsoft.PowerShell.ConsoleGuiTools; + +/// +/// Sends output to an interactive table using Terminal.Gui's TableView. +/// Renders with native column headers, sizing, horizontal scrolling, and streaming support. +/// +[Cmdlet(VerbsData.Out, "ConsoleGridView")] +[Alias("ocgv")] +public class OutConsoleGridViewCmdletCommand : PSCmdlet, IDisposable +{ + #region Properties + + private const string DATA_NOT_QUALIFIED_FOR_GRID_VIEW = nameof(DATA_NOT_QUALIFIED_FOR_GRID_VIEW); + private const string ENVIRONMENT_NOT_SUPPORTED_FOR_GRID_VIEW = nameof(ENVIRONMENT_NOT_SUPPORTED_FOR_GRID_VIEW); + + private readonly OutConsoleGridView _outConsoleGridView = new(); + private bool _initialized; + + #endregion Properties + + #region Input Parameters + + /// + /// Gets or sets the current pipeline object. + /// + [Parameter(ValueFromPipeline = true, HelpMessage = "Specifies the input pipeline object")] + public PSObject InputObject { get; set; } = AutomationNull.Value; + + /// + /// Gets or sets the title of the Out-ConsoleGridView window. + /// + [Parameter(HelpMessage = + "Specifies the text that appears in the title bar of the Out-ConsoleGridView window. By default, the title bar displays the command that invokes Out-ConsoleGridView.")] + [ValidateNotNullOrEmpty] + public string? Title { get; set; } + + /// + /// Gets or sets a value indicating whether the selected items should be written to the pipeline + /// and if it should be possible to select multiple or single list items. + /// + [Parameter(HelpMessage = + "Determines whether a single item (Single), multiple items (Multiple; default), or no items (None) will be written to the pipeline. Also determines selection behavior in the TUI.")] + public OutputModeOption OutputMode { set; get; } = OutputModeOption.Multiple; + + /// + /// Gets or sets the initial value for the filter in the TUI. + /// + [Parameter(HelpMessage = + "Pre-populates the Filter edit box, allowing filtering to be specified on the command line. The filter uses regular expressions.")] + public string? Filter { set; get; } + + /// + /// Gets or sets a value indicating whether "minimum UI" mode will be enabled. + /// + [Parameter(HelpMessage = "If specified no window frame, filter box, or status bar will be displayed in the TUI.")] + public SwitchParameter MinUI { set; get; } + + /// + /// Gets or sets a value indicating whether the TUI should run in full screen mode. + /// + [Parameter(HelpMessage = "If specified the TUI will run in full screen mode instead of inline.")] + public SwitchParameter FullScreen { set; get; } + + /// + /// Gets or sets which UI element should receive initial focus (Table or Filter). + /// + [Parameter(HelpMessage = "Specifies which UI element receives initial focus. Valid values are 'Table' (default) and 'Filter'.")] + public FocusTarget Focus { set; get; } = FocusTarget.Table; + + /// + /// Gets or sets a search string that positions the cursor on the first matching row. + /// + [Parameter(HelpMessage = "Positions the cursor on the first row matching this regex pattern. Unlike -Filter, non-matching rows remain visible.")] + public string? Search { set; get; } + + /// + /// Gets or sets the Terminal.Gui driver to use. + /// + [Parameter(HelpMessage = + "Sets the Terminal.Gui driver to use. Valid values are 'ansi', 'windows', or 'unix'.")] + [Alias("ForceDriver")] + public string? Driver { set; get; } + + /// + /// Gets a value indicating whether the Verbose switch is present. + /// + public bool Verbose => MyInvocation.BoundParameters.ContainsKey("Verbose"); + + /// + /// Gets a value indicating whether the Debug switch is present. + /// + public bool Debug => MyInvocation.BoundParameters.ContainsKey("Debug"); + + #endregion Input Parameters + + /// + /// Validates that the environment supports the grid view. + /// + protected override void BeginProcessing() + { + if (Console.IsInputRedirected) + { + var error = new ErrorRecord( + new PSNotSupportedException("Not supported in this environment (when input is redirected)."), + ENVIRONMENT_NOT_SUPPORTED_FOR_GRID_VIEW, + ErrorCategory.NotImplemented, + null); + + ThrowTerminatingError(error); + } + } + + /// + /// Processes each input object received from the pipeline. + /// + protected override void ProcessRecord() + { + if (Equals(InputObject, AutomationNull.Value)) return; + + if (InputObject.BaseObject is IDictionary dictionary) + // Dictionaries should be enumerated through because the pipeline does not enumerate through them. + foreach (DictionaryEntry entry in dictionary) + ProcessObject(PSObject.AsPSObject(entry)); + else + ProcessObject(InputObject); + } + + private void ProcessObject(PSObject input) + { + var baseObject = input.BaseObject; + + // Throw a terminating error for types that are not supported. + if (baseObject is ScriptBlock || + baseObject is SwitchParameter || + baseObject is PSReference || + baseObject is PSObject) + { + var error = new ErrorRecord( + new FormatException("Invalid data type for Out-ConsoleGridView"), + DATA_NOT_QUALIFIED_FOR_GRID_VIEW, + ErrorCategory.InvalidType, + null); + + ThrowTerminatingError(error); + } + + if (!_initialized) + { + _initialized = true; + var applicationData = new ApplicationData + { + Title = Title, + OutputMode = OutputMode, + Filter = Filter, + MinUI = MinUI, + FullScreen = FullScreen, + Focus = Focus, + Search = Search, + Driver = Driver, + Verbose = Verbose, + Debug = Debug, + ModuleVersion = MyInvocation.MyCommand.Version.ToString() + }; + _outConsoleGridView.Initialize(applicationData); + } + + _outConsoleGridView.AddObject(input); + } + + /// + /// Performs final processing after all pipeline objects have been received. + /// Signals the UI that loading is complete and writes selected objects to the pipeline. + /// + protected override void EndProcessing() + { + base.EndProcessing(); + + if (!_initialized) return; + + HashSet selectedIndexes = _outConsoleGridView.Complete(); + foreach (var idx in selectedIndexes) + { + WriteObject(_outConsoleGridView.GetObject(idx), false); + } + } + + /// + /// Releases all resources. + /// + public void Dispose() + { + _outConsoleGridView.Dispose(); + GC.SuppressFinalize(this); + } +} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridviewCmdletCommand.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridviewCmdletCommand.cs deleted file mode 100644 index 94bb7e1..0000000 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridviewCmdletCommand.cs +++ /dev/null @@ -1,187 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Management.Automation; -using System.Management.Automation.Internal; - -using OutGridView.Models; - -namespace OutGridView.Cmdlet -{ - [Cmdlet(VerbsData.Out, "ConsoleGridView")] - [Alias("ocgv")] - public class OutConsoleGridViewCmdletCommand : PSCmdlet, IDisposable - { - #region Properties - - private const string DataNotQualifiedForGridView = nameof(DataNotQualifiedForGridView); - private const string EnvironmentNotSupportedForGridView = nameof(EnvironmentNotSupportedForGridView); - - private List _psObjects = new List(); - private ConsoleGui _consoleGui = new ConsoleGui(); - - #endregion Properties - - #region Input Parameters - - /// - /// This parameter specifies the current pipeline object. - /// - [Parameter(ValueFromPipeline = true, HelpMessage = "Specifies the input pipeline object")] - public PSObject InputObject { get; set; } = AutomationNull.Value; - - /// - /// Gets/sets the title of the Out-GridView window. - /// - [Parameter(HelpMessage = "Specifies the text that appears in the title bar of the Out-ConsoleGridView window. y default, the title bar displays the command that invokes Out-ConsoleGridView.")] - [ValidateNotNullOrEmpty] - public string Title { get; set; } - - /// - /// Get or sets a value indicating whether the selected items should be written to the pipeline - /// and if it should be possible to select multiple or single list items. - /// - [Parameter(HelpMessage = "Determines whether a single item (Single), multiple items (Multiple; default), or no items (None) will be written to the pipeline. Also determines selection behavior in the GUI.")] - public OutputModeOption OutputMode { set; get; } = OutputModeOption.Multiple; - - /// - /// gets or sets the initial value for the filter in the GUI - /// - [Parameter(HelpMessage = "Pre-populates the Filter edit box, allowing filtering to be specified on the command line. The filter uses regular expressions.")] - public string Filter { set; get; } - - /// - /// gets or sets the whether "minimum UI" mode will be enabled - /// - [Parameter(HelpMessage = "If specified no window frame, filter box, or status bar will be displayed in the GUI.")] - public SwitchParameter MinUI { set; get; } - - /// - /// gets or sets the whether the Terminal.Gui System.Net.Console-based ConsoleDriver will be used instead of the - /// default platform-specific (Windows or Curses) ConsoleDriver. - /// - [Parameter(HelpMessage = "If specified the Terminal.Gui System.Net.Console-based ConsoleDriver (NetDriver) will be used.")] - public SwitchParameter UseNetDriver { set; get; } - - /// - /// For the -Verbose switch - /// - public bool Verbose => MyInvocation.BoundParameters.TryGetValue("Verbose", out var o); - - /// - /// For the -Debug switch - /// - public bool Debug => MyInvocation.BoundParameters.TryGetValue("Debug", out var o); - - #endregion Input Parameters - - // This method gets called once for each cmdlet in the pipeline when the pipeline starts executing - protected override void BeginProcessing() - { - if (Console.IsInputRedirected) - { - ErrorRecord error = new ErrorRecord( - new PSNotSupportedException("Not supported in this environment (when input is redirected)."), - EnvironmentNotSupportedForGridView, - ErrorCategory.NotImplemented, - null); - - ThrowTerminatingError(error); - } - } - - // This method will be called for each input received from the pipeline to this cmdlet; if no input is received, this method is not called - protected override void ProcessRecord() - { - if (InputObject == null || InputObject == AutomationNull.Value) - { - return; - } - - if (InputObject.BaseObject is IDictionary dictionary) - { - // Dictionaries should be enumerated through because the pipeline does not enumerate through them. - foreach (DictionaryEntry entry in dictionary) - { - ProcessObject(PSObject.AsPSObject(entry)); - } - } - else - { - ProcessObject(InputObject); - } - } - - private void ProcessObject(PSObject input) - { - - object baseObject = input.BaseObject; - - // Throw a terminating error for types that are not supported. - if (baseObject is ScriptBlock || - baseObject is SwitchParameter || - baseObject is PSReference || - baseObject is PSObject) - { - ErrorRecord error = new ErrorRecord( - new FormatException("Invalid data type for Out-ConsoleGridView"), - DataNotQualifiedForGridView, - ErrorCategory.InvalidType, - null); - - ThrowTerminatingError(error); - } - - _psObjects.Add(input); - } - - // This method will be called once at the end of pipeline execution; if no input is received, this method is not called - protected override void EndProcessing() - { - base.EndProcessing(); - - //Return if no objects - if (_psObjects.Count == 0) - { - return; - } - - var TG = new TypeGetter(this); - - var dataTable = TG.CastObjectsToTableView(_psObjects); - var applicationData = new ApplicationData - { - Title = Title ?? "Out-ConsoleGridView", - OutputMode = OutputMode, - Filter = Filter, - MinUI = MinUI, - DataTable = dataTable, - UseNetDriver = UseNetDriver, - Verbose = Verbose, - Debug = Debug, - ModuleVersion = MyInvocation.MyCommand.Version.ToString() - }; - - - var selectedIndexes = _consoleGui.Start(applicationData); - foreach (int idx in selectedIndexes) - { - var selectedObject = _psObjects[idx]; - if (selectedObject == null) - { - continue; - } - WriteObject(selectedObject, false); - } - } - - public void Dispose() - { - _consoleGui.Dispose(); - GC.SuppressFinalize(this); - } - } -} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/OutGridViewDataSource.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/OutGridViewDataSource.cs new file mode 100644 index 0000000..86d0cb8 --- /dev/null +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/OutGridViewDataSource.cs @@ -0,0 +1,187 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text.RegularExpressions; +using System.Threading; +using Microsoft.PowerShell.OutGridView.Models; +using Terminal.Gui.Views; + +namespace Microsoft.PowerShell.ConsoleGuiTools; + +/// +/// An implementation that wraps the OutGridView model. +/// Supports thread-safe row addition for streaming pipeline support (Issue #209). +/// +internal sealed class OutGridViewDataSource : ITableSource +{ + private readonly List _columns; + private readonly Lock _lock = new(); + private readonly List _rows; + + /// + /// Creates an empty data source with the specified columns. + /// + public OutGridViewDataSource(List columns) + { + _columns = columns; + ColumnNames = columns.Select(c => c.Label).ToArray(); + _rows = new List(); + } + + /// + /// Creates a data source with pre-populated rows. + /// + public OutGridViewDataSource(List columns, List rows) + { + _columns = columns; + ColumnNames = columns.Select(c => c.Label).ToArray(); + _rows = new List(rows); + } + + /// + public string[] ColumnNames { get; } + + /// + public int Columns => _columns.Count; + + /// + public int Rows + { + get + { + lock (_lock) + { + return _rows.Count; + } + } + } + + /// + public object this[int row, int col] + { + get + { + lock (_lock) + { + if (row < 0 || row >= _rows.Count || col < 0 || col >= _columns.Count) + return string.Empty; + + var dataRow = _rows[row]; + var columnKey = _columns[col].ToString(); + return dataRow.Values.TryGetValue(columnKey, out var value) + ? value.DisplayValue + : string.Empty; + } + } + } + + /// + /// Thread-safely adds a row to the data source. + /// + public void AddRow(DataTableRow row) + { + lock (_lock) + { + _rows.Add(row); + } + } + + /// + /// Gets the original object index for the specified row. + /// + public int GetOriginalObjectIndex(int row) + { + lock (_lock) + { + return row >= 0 && row < _rows.Count ? _rows[row].OriginalObjectIndex : -1; + } + } + + /// + /// Gets the column definitions. + /// + public List GetColumns() + { + return _columns; + } + + /// + /// Creates a new filtered data source containing only rows matching the regex pattern. + /// Returns itself if the pattern is empty (no copy needed). + /// + public OutGridViewDataSource Filter(string pattern) + { + if (string.IsNullOrEmpty(pattern)) + return this; + + var regex = new Regex(pattern, RegexOptions.IgnoreCase | RegexOptions.Compiled); + + List allRows; + lock (_lock) + { + allRows = new List(_rows); + } + + var result = allRows.Where(r => RowMatchesFilter(r, regex, _columns)).ToList(); + + return new OutGridViewDataSource(_columns, result); + } + + /// + /// Creates a new data source with rows sorted by the specified column. + /// The sorted column header is decorated with ▲ (ascending) or ▼ (descending). + /// + public OutGridViewDataSource Sort(int columnIndex, bool descending) + { + if (columnIndex < 0 || columnIndex >= _columns.Count) + return this; + + List allRows; + lock (_lock) + { + allRows = new List(_rows); + } + + var columnKey = _columns[columnIndex].ToString(); + + var sorted = descending + ? allRows.OrderByDescending(r => GetSortValue(r, columnKey)) + : allRows.OrderBy(r => GetSortValue(r, columnKey)); + + var result = new OutGridViewDataSource(_columns, sorted.ToList()); + + // Decorate the sorted column header with a direction glyph + string glyph = descending ? " ▼" : " ▲"; + result.ColumnNames[columnIndex] = _columns[columnIndex].Label + glyph; + + return result; + } + + private static IComparable GetSortValue(DataTableRow row, string columnKey) + { + if (!row.Values.TryGetValue(columnKey, out var value)) + return string.Empty; + + // Try numeric sort first + if (double.TryParse(value.DisplayValue, out var numericValue)) + return numericValue; + + return value.DisplayValue; + } + + private static bool RowMatchesFilter(DataTableRow row, Regex regex, List columns) + { + foreach (var column in columns) + { + var columnKey = column.ToString(); + if (row.Values.TryGetValue(columnKey, out var value) && + regex.IsMatch(value.DisplayValue)) + return true; + } + + return false; + } +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/OutGridViewWindow.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/OutGridViewWindow.cs new file mode 100644 index 0000000..00123de --- /dev/null +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/OutGridViewWindow.cs @@ -0,0 +1,454 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Reflection; +using System.Text.RegularExpressions; +using Microsoft.PowerShell.OutGridView.Models; +using Terminal.Gui.App; +using Terminal.Gui.Configuration; +using Terminal.Gui.Drawing; +using Terminal.Gui.Input; +using Terminal.Gui.ViewBase; +using Terminal.Gui.Views; + +namespace Microsoft.PowerShell.ConsoleGuiTools; + +/// +/// Provides the Terminal.Gui Window implementation for displaying tabular data using +/// with filtering, marking, and streaming support. +/// +internal sealed class OutGridViewWindow : Runnable> +{ + private const string FILTER_LABEL = "_Filter:"; + + private readonly ApplicationData _applicationData; + private readonly OutGridViewDataSource _masterDataSource; + + private OutGridViewDataSource? _filteredDataSource; + private View? _filterErrorView; + private TextField? _filterField; + private Label? _filterLabel; + private bool _isLoading = true; + private int _sortColumn = -1; + private bool _sortDescending; + + private StatusBar? _statusBar; + private TableView? _tableView; + + /// + /// Initializes a new instance of the class. + /// + /// The configuration and data to display. + /// The data source (may grow during streaming). + public OutGridViewWindow(ApplicationData applicationData, OutGridViewDataSource dataSource) + { + _applicationData = applicationData; + _masterDataSource = dataSource; + + Title = _applicationData.Title ?? "Out-ConsoleGridView"; + SchemeName = SchemeManager.SchemesToSchemeName(Schemes.Base); + BorderStyle = FrameView.DefaultBorderStyle; + + switch (_applicationData.MinUI) + { + case true: + //BorderStyle = LineStyle.None; + Border.Thickness = new Thickness(0, string.IsNullOrEmpty(_applicationData.Title) ? 0 : 1, 0, 0); + if (!string.IsNullOrEmpty(_applicationData.Filter)) AddFilter(); + break; + case false: + Border.Thickness = new Thickness(0, 2, 0, 0); + AddFilter(); + break; + } + + AddStatusBar(); + AddTableView(); + ApplyFilter(); + } + + /// + /// Optional callback invoked when the window starts running (UI is ready for interaction). + /// + internal Action? OnRunning { get; set; } + + private int _maxHeight; + private bool _laidOut; + + protected override void OnIsRunningChanged(bool newIsRunning) + { + base.OnIsRunningChanged(newIsRunning); + if (!newIsRunning) return; + + App?.LayoutAndDrawComplete += (_, _) => + { + _maxHeight = !_laidOut ? Frame.Height : Math.Max(_maxHeight, Frame.Height); + _laidOut = true; + }; + + if (App?.AppModel == AppModel.Inline && Height.Has(out DimFill _)) + { + // If starting inline and height is Dim.Fill, change to Dim.Auto to avoid full screen + Height = Dim.Auto(); + + _tableView!.Height = Dim.Auto( + minimumContentDim: + Dim.Func(_ => Math.Max( + _filteredDataSource?.Rows ?? 0, + _maxHeight - ((_tableView.FrameToScreen().Top + _tableView.GetAdornmentsThickness().Vertical) + + (_statusBar?.Frame.Height ?? 0) + Border.Thickness.Bottom))), + maximumContentDim: + Dim.Func(_ => + App?.Driver?.Screen.Height - + ((_tableView.FrameToScreen().Top + _tableView.GetAdornmentsThickness().Vertical) + + (_statusBar?.Frame.Height ?? 0) + Border.Thickness.Bottom) ?? 0)); + } + + OnRunning?.Invoke(); + + if (_applicationData.Focus == FocusTarget.Filter && _filterField != null) + _filterField.SetFocus(); + else + _tableView?.SetFocus(); + } + + /// + /// Called (via Application.Invoke) when new rows have been added to the master data source during streaming. + /// + public void OnDataChanged() + { + if (string.IsNullOrEmpty(_applicationData.Filter)) + { + // No filter active — just point the table at the master source directly (no copy) + if (_filteredDataSource != _masterDataSource) + { + _filteredDataSource = _masterDataSource; + _tableView!.Table = _filteredDataSource; + } + _tableView?.Update(); + } + else + { + ApplyFilter(); + } + + if (_isLoading) + _rowsShortcut.Text = $"{_masterDataSource.Rows} rows"; + } + + /// + /// Called (via Application.Invoke) when the pipeline has finished sending objects. + /// + public void OnPipelineComplete() + { + _isLoading = false; + OnLoadingComplete(); + ApplySearch(); + } + + /// + /// Gets the original indexes of all selected rows using TableView's native multi-selection. + /// + public HashSet GetSelectedIndexes() + { + if (_tableView == null || _filteredDataSource == null) + return []; + + var selectedRows = new HashSet(); + foreach (var cell in _tableView.GetAllSelectedCells()) + { + var origIdx = _filteredDataSource.GetOriginalObjectIndex(cell.Y); + if (origIdx >= 0) + selectedRows.Add(origIdx); + } + + return selectedRows; + } + + #region User Actions + + private void Accept() + { + Result = GetSelectedIndexes(); + App?.RequestStop(); + } + + #endregion + + #region Filtering + + private void ApplyFilter() + { + // Save the currently selected row's original index so we can restore position + int? selectedOriginalIndex = null; + if (_filteredDataSource != null && _tableView is { Value.Cursor.Y: >= 0 } && + _tableView.Value.Cursor.Y < _filteredDataSource.Rows) + selectedOriginalIndex = _filteredDataSource.GetOriginalObjectIndex(_tableView.Value.Cursor.Y); + + try + { + if (_filterErrorView != null) _filterErrorView.Text = string.Empty; + _filteredDataSource = _masterDataSource.Filter(_applicationData.Filter ?? string.Empty); + } + catch (RegexParseException ex) + { + if (_filterErrorView != null) _filterErrorView.Text = ex.Message; + return; + } + + RebuildTableSource(); + + // Restore selection position + if (selectedOriginalIndex.HasValue && _filteredDataSource != null && _tableView != null) + for (var i = 0; i < _filteredDataSource.Rows; i++) + if (_filteredDataSource.GetOriginalObjectIndex(i) == selectedOriginalIndex.Value) + { + _tableView.SetSelection(0, i, false); + break; + } + + _tableView?.Update(); + } + + private void RebuildTableSource() + { + if (_filteredDataSource == null || _tableView == null) return; + _tableView.Table = _filteredDataSource; + } + + private void ApplySortAndFilter() + { + // Apply filter first, then sort + ApplyFilter(); + + if (_sortColumn < 0 || _filteredDataSource == null || _tableView == null) + return; + + _filteredDataSource = _filteredDataSource.Sort(_sortColumn, _sortDescending); + _tableView.Table = _filteredDataSource; + _tableView?.Update(); + } + + private void ApplySearch() + { + if (string.IsNullOrEmpty(_applicationData.Search) || _filteredDataSource == null || _tableView == null) + return; + + try + { + var regex = new Regex(_applicationData.Search, RegexOptions.IgnoreCase); + for (var row = 0; row < _filteredDataSource.Rows; row++) + { + for (var col = 0; col < _filteredDataSource.Columns; col++) + { + var cellValue = _filteredDataSource[row, col].ToString() ?? string.Empty; + if (regex.IsMatch(cellValue)) + { + _tableView.SetSelection(0, row, false); + return; + } + } + } + } + catch (RegexParseException) + { + // Invalid regex — silently ignore + } + } + + #endregion + + #region UI Construction + + private void AddFilter() + { + _filterLabel = new Label + { + Text = FILTER_LABEL, + X = 0, + Y = 0 + }; + + _filterField = new TextField + { + Text = _applicationData.Filter ?? string.Empty, + X = Pos.Right(_filterLabel) + 1, + Y = Pos.Top(_filterLabel), + CanFocus = true, + Width = Dim.Fill() - 1 + }; + + _filterField.KeyBindings.Remove(Key.A.WithCtrl); + + _filterField.Accepted += (_, _) => + { + if (_applicationData.OutputMode != OutputModeOption.None) + Accept(); + }; + + _filterErrorView = new View + { + Text = string.Empty, + X = Pos.Right(_filterLabel) + 1, + Y = Pos.Top(_filterLabel) + 1, + Width = Dim.Fill() - _filterLabel.Text.Length, + Height = Dim.Auto(DimAutoStyle.Text), + SchemeName = SchemeManager.SchemesToSchemeName(Schemes.Error) + }; + + _filterField.TextChanged += (_, _) => + { + try + { + _filterErrorView?.Text = string.Empty; + _applicationData.Filter = _filterField.Text; + ApplyFilter(); + } + catch (Exception ex) + { + _filterErrorView?.Text = ex.Message; + } + }; + + Add(_filterLabel, _filterField, _filterErrorView); + _filterField.Text = _applicationData.Filter ?? string.Empty; + _filterField.InsertionPoint = _filterField.Text.Length; + } + + private void AddTableView() + { + _tableView = new TableView + { + X = 0, + Y = _filterErrorView is not null ? Pos.Bottom(_filterErrorView) : 0, + Width = Dim.Fill(), + Height = _statusBar is not null ? Dim.Fill(_statusBar) : Dim.Fill(), + FullRowSelect = true, + MultiSelect = _applicationData.OutputMode == OutputModeOption.Multiple, + Style = new TableStyle + { + ShowHeaders = true, + AlwaysShowHeaders = true, + ExpandLastColumn = true, + ShowHorizontalHeaderUnderline = false, + ShowVerticalHeaderLines = false, + ShowHorizontalHeaderOverline = false, + ShowVerticalCellLines = false, + SmoothHorizontalScrolling = true + }, + ViewportSettings = ViewportSettingsFlags.HasScrollBars + }; + + // TableView typically is a grid where nav keys are biased for moving left/right. + _tableView.KeyBindings.Remove(Key.Home); + _tableView.KeyBindings.Add(Key.Home, Command.Start); + _tableView.KeyBindings.Remove(Key.End); + _tableView.KeyBindings.Add(Key.End, Command.End); + + // Enter key activates selection + if (_applicationData.OutputMode != OutputModeOption.None) _tableView.Accepted += (_, _) => Accept(); + + // Column header click sorts + _tableView.Activating += (_, e) => + { + if (e.Context?.Binding is not MouseBinding { MouseEvent: { } mouse }) + return; + + if (!mouse.Flags.HasFlag(MouseFlags.LeftButtonClicked)) + return; + + _tableView.ScreenToCell(mouse.Position!.Value, out int? clickedCol); + if (clickedCol == null) + return; + + // Toggle direction if clicking same column, otherwise sort ascending + if (clickedCol.Value == _sortColumn) + _sortDescending = !_sortDescending; + else + { + _sortColumn = clickedCol.Value; + _sortDescending = false; + } + + ApplySortAndFilter(); + }; + + Add(_tableView); + } + + private SpinnerView? _spinnerView; + + private readonly Shortcut _rowsShortcut = new() + { + Text = "Rows:", + CanFocus = false, + MouseHighlightStates = MouseState.None + }; + + private void AddStatusBar() + { + if (_applicationData.MinUI) return; + + var shortcuts = new List(); + + // Spinner as 1st item while loading (streaming or reloading) + _spinnerView = new() { Style = new SpinnerStyle.Aesthetic(), Width = 8 }; + _spinnerView.AutoSpin = _isLoading; + _rowsShortcut.CommandView = _spinnerView; + shortcuts.Add(_rowsShortcut); + + if (_applicationData.OutputMode != OutputModeOption.None) + shortcuts.Add(new Shortcut(Key.Enter, "Accept", null)); + + if (_applicationData.OutputMode == OutputModeOption.Multiple) + { + shortcuts.Add(new Shortcut(Key.A.WithCtrl, "Sel. All", () => _tableView?.SelectAll())); + shortcuts.Add(new Shortcut(Key.D.WithCtrl, "Desel. All", () => + { + _tableView?.MultiSelectedRegions.Clear(); + _tableView?.SetNeedsDraw(); + })); + } + + shortcuts.Add(new Shortcut(Key.Esc, "Close", RequestStop)); + + if (_applicationData.Verbose || _applicationData.Debug) + { + shortcuts.Add(new Shortcut(Key.Empty, $" v{_applicationData.ModuleVersion}", null)); + var tgFileVersionInfo = + FileVersionInfo.GetVersionInfo(Assembly.GetAssembly(typeof(Application))!.Location); + var tgVersion = tgFileVersionInfo.FileVersion ?? "no version found"; + { + tgVersion = tgFileVersionInfo.ProductVersion?[..tgFileVersionInfo.ProductVersion.IndexOf('+')] ?? + tgVersion; + } + shortcuts.Add(new Shortcut(Key.Empty, $"{App?.Driver?.GetName()} v{tgVersion}", null)); + } + + _statusBar = new StatusBar(shortcuts); + Add(_statusBar); + MoveSubViewToEnd(_statusBar); + } + + private void OnLoadingComplete() + { + if (_applicationData.MinUI) return; + if (_statusBar == null) return; + + // Stop spinner and replace with final row count + // Setting CommandView disposes the old view + _spinnerView = null; + _rowsShortcut.CommandView = new View(){ + Width = Dim.Auto(), + Height = Dim.Fill() + }; + + _rowsShortcut.Title = $"{_masterDataSource.Rows}"; + _rowsShortcut.Text = "Rows: "; + } + + #endregion +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/Properties/launchSettings.json b/src/Microsoft.PowerShell.ConsoleGuiTools/Properties/launchSettings.json new file mode 100644 index 0000000..01981e1 --- /dev/null +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/Properties/launchSettings.json @@ -0,0 +1,46 @@ +{ + "profiles": { + "OCGV": { + "commandName": "Executable", + "executablePath": "C:\\Program Files\\PowerShell\\7-preview\\pwsh.exe", + "commandLineArgs": "-NoProfile -NoLogo -NoExit -Command \"& { Import-Module '$(TargetPath)'; Get-Process | Select-Object ProcessName, Id,\r\n @{Name='CPU(s)'; Expression={[math]::Round($_.CPU,2)}},\r\n @{Name='WorkingSet(MB)'; Expression={[math]::Round($_.WorkingSet64/1MB,2)}},\r\n @{Name='Private(MB)'; Expression={[math]::Round($_.PrivateMemorySize64/1MB,2)}}\r\n | Out-ConsoleGridView -Debug }\"", + "workingDirectory": "$(TargetDir)" + }, + "OCGV -Filter": { + "commandName": "Executable", + "executablePath": "C:\\Program Files\\PowerShell\\7-preview\\pwsh.exe", + "commandLineArgs": "-NoProfile -NoLogo -NoExit -Command \"& { Import-Module '$(TargetPath)'; Get-Process | Select-Object ProcessName, Id,\r\n @{Name='CPU(s)'; Expression={[math]::Round($_.CPU,2)}},\r\n @{Name='WorkingSet(MB)'; Expression={[math]::Round($_.WorkingSet64/1MB,2)}},\r\n @{Name='Private(MB)'; Expression={[math]::Round($_.PrivateMemorySize64/1MB,2)}}\r\n | Out-ConsoleGridView -Debug -Filter com }\"", + "workingDirectory": "$(TargetDir)" + }, + "OCGV -MinUi": { + "commandName": "Executable", + "executablePath": "C:\\Program Files\\PowerShell\\7-preview\\pwsh.exe", + "commandLineArgs": "-NoProfile -NoLogo -NoExit -Command \"& { Import-Module '$(TargetPath)'; Get-Process | Select-Object ProcessName, Id,\r\n @{Name='CPU(s)'; Expression={[math]::Round($_.CPU,2)}},\r\n @{Name='WorkingSet(MB)'; Expression={[math]::Round($_.WorkingSet64/1MB,2)}},\r\n @{Name='Private(MB)'; Expression={[math]::Round($_.PrivateMemorySize64/1MB,2)}}\r\n | Out-ConsoleGridView -MinUi -Filter pas }\"", + "workingDirectory": "$(TargetDir)" + }, + "gci | OCGV": { + "commandName": "Executable", + "executablePath": "C:\\Program Files\\PowerShell\\7-preview\\pwsh.exe", + "commandLineArgs": "-NoProfile -NoLogo -NoExit -Command \"& { Import-Module '$(TargetPath)'; gci | Out-ConsoleGridView -OutputMode: Single }\"", + "workingDirectory": "$(TargetDir)" + }, + "SHOT": { + "commandName": "Executable", + "executablePath": "C:\\Program Files\\PowerShell\\7-preview\\pwsh.exe", + "commandLineArgs": "-NoProfile -NoLogo -NoExit -Command \"& { Import-Module '$(TargetPath)'; Get-Process | Show-ObjectTree -MinUI -filter con }\"", + "workingDirectory": "$(TargetDir)" + }, + "OCGV": { + "commandName": "Executable", + "executablePath": "C:\\Program Files\\PowerShell\\7-preview\\pwsh.exe", + "commandLineArgs": "-NoProfile -NoLogo -NoExit -Command \"& { Import-Module '$(TargetPath)'; Get-Process | Select-Object ProcessName, Id,\r\n @{Name='CPU(s)'; Expression={[math]::Round($_.CPU,2)}},\r\n @{Name='WorkingSet(MB)'; Expression={[math]::Round($_.WorkingSet64/1MB,2)}},\r\n @{Name='Private(MB)'; Expression={[math]::Round($_.PrivateMemorySize64/1MB,2)}}\r\n | Out-ConsoleGridView -Debug -Title \"processes\" }\"", + "workingDirectory": "$(TargetDir)" + }, + "OCGV Slow": { + "commandName": "Executable", + "executablePath": "C:\\Program Files\\PowerShell\\7-preview\\pwsh.exe", + "commandLineArgs": "-NoProfile -NoLogo -NoExit -Command \"& { Import-Module '$(TargetPath)'; 1..50 | ForEach-Object { Start-Sleep -Milliseconds 50; [PSCustomObject]@{ Index = $_; Time = (Get-Date -Format 'HH:mm:ss.fff'); Square = $_ * $_ } } | Out-ConsoleGridView -Debug }\"", + "workingDirectory": "$(TargetDir)" + } + } +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/RegexTreeViewTextFilter.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/RegexTreeViewTextFilter.cs new file mode 100644 index 0000000..a7574dd --- /dev/null +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/RegexTreeViewTextFilter.cs @@ -0,0 +1,81 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System; +using System.Text.RegularExpressions; +using Terminal.Gui.Views; + +namespace Microsoft.PowerShell.ConsoleGuiTools; + +/// +/// Provides regex-based filtering for a TreeView, allowing users to filter tree nodes by matching their display text against a regular expression pattern. +/// +/// The parent ShowObjectTreeView that owns this filter. +/// The TreeView to apply filtering to. +internal sealed class RegexTreeViewTextFilter(ShowObjectTreeWindow parent, TreeView forTree) : ITreeViewFilter +{ + #region Fields + + private readonly TreeView _forTree = forTree ?? throw new ArgumentNullException(nameof(forTree)); + private string _text = string.Empty; + + #endregion + + #region Properties + + /// + /// Gets or sets the regex pattern text used for filtering. + /// + public string Text + { + get => _text; + set + { + _text = value; + RefreshTreeView(); + } + } + + #endregion + + #region ITreeViewFilter Implementation + + /// + /// Determines whether the specified model object matches the current filter criteria. + /// + /// The model object to test against the filter. + /// if the object matches the filter or no filter is set; otherwise, . + public bool IsMatch(object model) + { + if (string.IsNullOrWhiteSpace(Text)) + return true; + + var modelText = _forTree.AspectGetter(model); + try + { + var isMatch = Regex.IsMatch(modelText ?? string.Empty, Text, RegexOptions.IgnoreCase); + parent.SetRegexError(string.Empty); + return isMatch; + } + catch (RegexParseException e) + { + parent.SetRegexError(e.Message); + return false; + } + } + + #endregion + + #region Private Methods + + /// + /// Refreshes the tree view to apply the updated filter. + /// + private void RefreshTreeView() + { + _forTree.InvalidateLineMap(); + _forTree.SetNeedsDraw(); + } + + #endregion +} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs index 5b2f95d..46b3d75 100644 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs @@ -4,153 +4,169 @@ using System; using System.Collections; using System.Collections.Generic; +using System.Linq; using System.Management.Automation; using System.Management.Automation.Internal; - -using OutGridView.Models; - -namespace OutGridView.Cmdlet +using Microsoft.PowerShell.OutGridView.Models; + +namespace Microsoft.PowerShell.ConsoleGuiTools; + +/// +/// Displays objects in a hierarchical tree view in a separate console window. This class is invoked by PowerShell when +/// the +/// Show-ObjectTree cmdlet is called. +/// +[Cmdlet("Show", "ObjectTree")] +[Alias("shot")] +public class ShowObjectTreeCmdletCommand : PSCmdlet, IDisposable { - [Cmdlet("Show", "ObjectTree")] - [Alias("shot")] - public class ShowObjectTreeCmdletCommand : PSCmdlet, IDisposable + #region Properties + + private const string DATA_NOT_QUALIFIED_FOR_SHOW_OBJECT_TREE = nameof(DATA_NOT_QUALIFIED_FOR_SHOW_OBJECT_TREE); + + private const string ENVIRONMENT_NOT_SUPPORTED_FOR_SHOW_OBJECT_TREE = + nameof(ENVIRONMENT_NOT_SUPPORTED_FOR_SHOW_OBJECT_TREE); + + private readonly List _psObjects = []; + + #endregion Properties + + #region Input Parameters + + /// + /// Gets or sets the current pipeline object. + /// + [Parameter(ValueFromPipeline = true, HelpMessage = "Specifies the input pipeline object")] + public PSObject InputObject { get; set; } = AutomationNull.Value; + + /// + /// Gets or sets the title of the Show-ObjectTree window. + /// + [Parameter(HelpMessage = + "Specifies the text that appears in the title. By default, the title bar displays Show-ObjectTree.")] + [ValidateNotNullOrEmpty] + public string? Title { get; set; } + + /// + /// Gets or sets the initial value for the filter in the GUI. + /// + [Parameter(HelpMessage = + "Pre-populates the Filter edit box, allowing filtering to be specified on the command line. The filter uses regular expressions.")] + public string? Filter { set; get; } + + /// + /// Gets or sets a value indicating whether "minimum UI" mode will be enabled. + /// + [Parameter(HelpMessage = "If specified no title or status bar will be displayed in the TUI. The filter will only be displayed if -Filter is specified.")] + public SwitchParameter MinUI { set; get; } + + /// + /// Gets or sets the Terminal.Gui driver to use. + /// + [Parameter(HelpMessage = + "Specifies the Terminal.Gui driver to use. Valid values are 'ansi', 'windows', or 'unix'. The default is `ansi`")] + public string? Driver { set; get; } + + /// + /// Gets or sets a value indicating whether the application should run in full-screen mode + /// using the alternate screen buffer. By default, the application renders inline. + /// + [Parameter(HelpMessage = + "If specified, the application runs in full-screen mode using the alternate screen buffer. By default, the application renders inline.")] + public SwitchParameter FullScreen { set; get; } + + /// + /// Gets a value indicating whether the Debug switch is present. + /// + public bool Debug => MyInvocation.BoundParameters.ContainsKey("Debug"); + + #endregion Input Parameters + + /// + /// Performs initialization of command execution. Validates that the environment supports object tree view. + /// + protected override void BeginProcessing() { - #region Properties - - private const string DataNotQualifiedForShowObjectTree = nameof(DataNotQualifiedForShowObjectTree); - private const string EnvironmentNotSupportedForShowObjectTree = nameof(EnvironmentNotSupportedForShowObjectTree); - - private List _psObjects = new List(); - - #endregion Properties - - #region Input Parameters - - /// - /// This parameter specifies the current pipeline object. - /// - [Parameter(ValueFromPipeline = true, HelpMessage = "Specifies the input pipeline object")] - public PSObject InputObject { get; set; } = AutomationNull.Value; - - /// - /// Gets/sets the title of the Out-GridView window. - /// - [Parameter(HelpMessage = "Specifies the text that appears in the title bar of the Out-ConsoleGridView window. y default, the title bar displays the command that invokes Out-ConsoleGridView.")] - [ValidateNotNullOrEmpty] - public string Title { get; set; } - - /// - /// gets or sets the initial value for the filter in the GUI - /// - [Parameter(HelpMessage = "Pre-populates the Filter edit box, allowing filtering to be specified on the command line. The filter uses regular expressions.")] - public string Filter { set; get; } - - /// - /// gets or sets the whether "minimum UI" mode will be enabled - /// - [Parameter(HelpMessage = "If specified no window frame, filter box, or status bar will be displayed in the GUI.")] - public SwitchParameter MinUI { set; get; } - /// - /// gets or sets the whether the Terminal.Gui System.Net.Console-based ConsoleDriver will be used instead of the - /// default platform-specific (Windows or Curses) ConsoleDriver. - /// - [Parameter(HelpMessage = "If specified the Terminal.Gui System.Net.Console-based ConsoleDriver (NetDriver) will be used.")] - public SwitchParameter UseNetDriver { set; get; } - - /// - /// For the -Debug switch - /// - public bool Debug => MyInvocation.BoundParameters.TryGetValue("Debug", out var o); - - #endregion Input Parameters - - // This method gets called once for each cmdlet in the pipeline when the pipeline starts executing - protected override void BeginProcessing() + if (Console.IsInputRedirected) { - if (Console.IsInputRedirected) - { - ErrorRecord error = new ErrorRecord( - new PSNotSupportedException("Not supported in this environment (when input is redirected)."), - EnvironmentNotSupportedForShowObjectTree, - ErrorCategory.NotImplemented, - null); - - ThrowTerminatingError(error); - } - } + var error = new ErrorRecord( + new PSNotSupportedException("Not supported in this environment (when input is redirected)."), + ENVIRONMENT_NOT_SUPPORTED_FOR_SHOW_OBJECT_TREE, + ErrorCategory.NotImplemented, + null); - // This method will be called for each input received from the pipeline to this cmdlet; if no input is received, this method is not called - protected override void ProcessRecord() - { - if (InputObject == null || InputObject == AutomationNull.Value) - { - return; - } - - if (InputObject.BaseObject is IDictionary dictionary) - { - // Dictionaries should be enumerated through because the pipeline does not enumerate through them. - foreach (DictionaryEntry entry in dictionary) - { - ProcessObject(PSObject.AsPSObject(entry)); - } - } - else - { - ProcessObject(InputObject); - } + ThrowTerminatingError(error); } + } + + /// + /// Processes each input object received from the pipeline. + /// + protected override void ProcessRecord() + { + if (Equals(InputObject, AutomationNull.Value)) return; + + if (InputObject.BaseObject is IDictionary dictionary) + // Dictionaries should be enumerated through because the pipeline does not enumerate through them. + foreach (DictionaryEntry entry in dictionary) + ProcessObject(PSObject.AsPSObject(entry)); + else + ProcessObject(InputObject); + } + + private void ProcessObject(PSObject input) + { + var baseObject = input.BaseObject; - private void ProcessObject(PSObject input) + // Throw a terminating error for types that are not supported. + if (baseObject is ScriptBlock || + baseObject is SwitchParameter || + baseObject is PSReference || + baseObject is PSObject) { + var error = new ErrorRecord( + new FormatException("Invalid data type for Show-ObjectTree"), + DATA_NOT_QUALIFIED_FOR_SHOW_OBJECT_TREE, + ErrorCategory.InvalidType, + null); - object baseObject = input.BaseObject; + ThrowTerminatingError(error); + } - // Throw a terminating error for types that are not supported. - if (baseObject is ScriptBlock || - baseObject is SwitchParameter || - baseObject is PSReference || - baseObject is PSObject) - { - ErrorRecord error = new ErrorRecord( - new FormatException("Invalid data type for Show-ObjectTree"), - DataNotQualifiedForShowObjectTree, - ErrorCategory.InvalidType, - null); + _psObjects.Add(input); + } - ThrowTerminatingError(error); - } + /// + /// Performs final processing after all pipeline objects have been received. + /// Displays the object tree view with all collected objects. + /// + protected override void EndProcessing() + { + base.EndProcessing(); - _psObjects.Add(input); - } + // Return if no objects + if (_psObjects.Count == 0) return; - // This method will be called once at the end of pipeline execution; if no input is received, this method is not called - protected override void EndProcessing() + var applicationData = new ApplicationData { - base.EndProcessing(); - - //Return if no objects - if (_psObjects.Count == 0) - { - return; - } - - var applicationData = new ApplicationData - { - Title = Title ?? "Show-ObjectTree", - Filter = Filter, - MinUI = MinUI, - UseNetDriver = UseNetDriver, - Debug = Debug, - ModuleVersion = MyInvocation.MyCommand.Version.ToString() - }; - - ShowObjectView.Run(_psObjects, applicationData); - } + PSObjects = _psObjects.Cast().ToList(), + Title = Title ?? "Show-ObjectTree", + Filter = Filter, + MinUI = MinUI, + Driver = Driver, + FullScreen = FullScreen, + Debug = Debug, + ModuleVersion = MyInvocation.MyCommand.Version.ToString() + }; + + ShowObjectView.Run(applicationData); + } - public void Dispose() - { - GC.SuppressFinalize(this); - } + /// + /// Releases all resources used by the . + /// + public void Dispose() + { + GC.SuppressFinalize(this); } -} +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeWindow.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeWindow.cs new file mode 100644 index 0000000..7eb3c7f --- /dev/null +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeWindow.cs @@ -0,0 +1,418 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Reflection; +using System.Text.RegularExpressions; +using System.IO; +using System.Linq; +using System.Management.Automation; +using Terminal.Gui.App; +using Terminal.Gui.ViewBase; +using Terminal.Gui.Views; +using Terminal.Gui.Drawing; +using Terminal.Gui.Input; +using Terminal.Gui.Configuration; +using Microsoft.PowerShell.OutGridView.Models; + +namespace Microsoft.PowerShell.ConsoleGuiTools; + +/// +/// Provides the Terminal.Gui Window implementation for displaying object hierarchies in a tree view with filtering capabilities. +/// +internal sealed class ShowObjectTreeWindow : Window, ITreeBuilder +{ + private const string FILTER_LABEL = "_Filter:"; + + private readonly TreeView? _tree; + private Shortcut? _selectedShortcut; + private StatusBar? _statusBar; + private readonly ApplicationData _applicationData; + + private View? _filterErrorView; + private TextField? _filterField; + private Label? _filterLabel; + + /// + /// Gets a value indicating whether this tree builder supports the CanExpand operation. + /// + public bool SupportsCanExpand => true; + + /// + /// Initializes a new instance of the class with the specified application data. + /// + /// The configuration and PSObjects to display. + public ShowObjectTreeWindow(ApplicationData applicationData) + { + _applicationData = applicationData; + Title = _applicationData.Title ?? "Show-ObjectView"; + + SchemeName = SchemeManager.SchemesToSchemeName(Schemes.Base); + BorderStyle = FrameView.DefaultBorderStyle; + + switch (_applicationData.MinUI) + { + case true: + BorderStyle = LineStyle.None; + if (!string.IsNullOrEmpty(_applicationData.Filter)) AddFilter(); + break; + case false: + Border.Thickness = new Thickness(0, 2, 0, 0); + AddFilter(); + break; + } + + // Extract root objects from PSObjects + var rootObjects = _applicationData.PSObjects?.Select(p => + { + if (p is PSObject pso) + return pso.BaseObject; + return p; + }).ToList() ?? []; + + _tree = new TreeView + { + Y = _filterErrorView is not null ? Pos.Bottom(_filterErrorView) : 0, + Width = Dim.Fill(), + Height = Dim.Fill(), + TreeBuilder = this, + Style = new TreeStyle() { HighlightModelTextOnly = true }, + AspectGetter = AspectGetter! + }; + + var regexFilter = new RegexTreeViewTextFilter(this, _tree!) + { + Text = _applicationData.Filter ?? string.Empty + }; + _tree?.Filter = regexFilter; + + if (rootObjects.Count > 0) + _tree?.AddObjects(rootObjects); + else + _tree?.AddObject("No Objects"); + + Add(_tree); + } + + /// + /// Adds the filter text field and error display to the window. + /// + private void AddFilter() + { + _filterLabel = new Label + { + Text = FILTER_LABEL + }; + + _filterField = new TextField + { + Text = _applicationData.Filter ?? string.Empty, + X = Pos.Right(_filterLabel) + 1, + Y = Pos.Top(_filterLabel), + CanFocus = true, + Width = Dim.Fill() - 1 + }; + + _filterField.KeyBindings.Remove(Key.A.WithCtrl); + _filterField.KeyBindings.Remove(Key.D.WithCtrl); + + _filterErrorView = new View + { + Text = string.Empty, + X = Pos.Right(_filterLabel) + 1, + Y = Pos.Top(_filterLabel) + 1, + Width = Dim.Fill() - _filterLabel.Text.Length, + Height = Dim.Auto(DimAutoStyle.Text), + SchemeName = SchemeManager.SchemesToSchemeName(Schemes.Error) + }; + + _filterField.TextChanged += (_, _) => + { + var filterText = _filterField.Text; + try + { + _filterErrorView?.Text = string.Empty; + _applicationData.Filter = filterText; + _filterField?.TextChanged += (sender, _) => OnFilterTextChanged(sender, ((RegexTreeViewTextFilter)_tree?.Filter)); + } + catch (Exception ex) + { + _filterErrorView?.Text = ex.Message; + } + }; + + Add(_filterLabel, _filterField, _filterErrorView); + + _filterField.Text = _applicationData.Filter ?? string.Empty; + _filterField.InsertionPoint = _filterField.Text.Length; + } + + + /// + /// Adds the status bar with keyboard shortcuts to the window. + /// + private void AddStatusBar() + { + if (_tree is { Objects: not null }) + { + var shortcuts = CreateShortcuts(_tree.Objects.ToList()); + + if (_applicationData.Verbose || _applicationData.Debug) + { + shortcuts.Add(new Shortcut(Key.Empty, $" v{_applicationData.ModuleVersion}", null)); + var tgFileVersionInfo = FileVersionInfo.GetVersionInfo(Assembly.GetAssembly(typeof(Application))!.Location); + var tgVersion = tgFileVersionInfo.FileVersion ?? "no version found"; + //if (tgFileVersionInfo is { IsPreRelease: true }) + { + tgVersion = tgFileVersionInfo.ProductVersion?[..tgFileVersionInfo.ProductVersion.IndexOf('+')] ?? + tgVersion; + } + shortcuts.Add(new Shortcut(Key.Empty, $"{App?.Driver?.GetName()} v{tgVersion}", null)); + } + + _statusBar = new StatusBar(shortcuts); + } + + Add(_statusBar); + } + + #region Event Handlers + + private int _maxHeight; + private bool _laidOut; + + protected override void OnIsRunningChanged(bool newIsRunning) + { + base.OnIsRunningChanged(newIsRunning); + if (!newIsRunning) return; + + App?.LayoutAndDrawComplete += (_, _) => + { + _maxHeight = !_laidOut ? Frame.Height : Math.Max(_maxHeight, Frame.Height); + _laidOut = true; + }; + + if (App?.AppModel == AppModel.Inline && Height.Has(out DimFill _) && _tree != null) + { + // If starting inline and height is Dim.Fill, change to Dim.Auto to avoid full screen + Height = Dim.Auto(); + + _tree.Height = Dim.Auto( + minimumContentDim: + Dim.Func(_ => Math.Max( + _tree.GetSize().Height, + _maxHeight - (_tree.FrameToScreen().Top + _tree.GetAdornmentsThickness().Vertical + (_statusBar?.Frame.Height ?? 0) + Border.Thickness.Bottom))), + maximumContentDim: + Dim.Func(_ => + App?.Driver?.Screen.Height - + (_tree.FrameToScreen().Top + _tree.GetAdornmentsThickness().Vertical + (_statusBar?.Frame.Height ?? 0) + Border.Thickness.Bottom) ?? 0)); + } + + // We do this here, because _statusBar requires the Application to be running to + // access the driver information. + if (!_applicationData.MinUI) AddStatusBar(); + + _tree?.SetFocus(); + } + + private int GetEpxandedRows() + { + int count = 0; + + return count; + } + + /// + /// Handles filter text changes and applies the regex filter. + /// + /// The text field that triggered the event. + /// The regex filter to update. + private void OnFilterTextChanged(object? sender, RegexTreeViewTextFilter regexFilter) + { + if (sender is not TextField textField) return; + + // Test that the regex is valid before applying it + try + { + _ = new Regex(textField.Text, RegexOptions.IgnoreCase); + } + catch (RegexParseException ex) + { + _filterErrorView?.Text = ex.Message; + return; + } + + _filterErrorView?.Text = string.Empty; + regexFilter.Text = textField.Text; + } + + /// + /// Handles selection changes in the tree view and updates the status bar. + /// + /// The tree view that triggered the event. + /// The selection changed event arguments. + private void SelectionChanged(object? sender, SelectionChangedEventArgs e) + { + var selectedValue = e.NewValue; + + if (selectedValue is CachedMemberResult cmr) + selectedValue = cmr.Value; + + _selectedShortcut?.Title = selectedValue != null ? selectedValue.GetType().Name : string.Empty; + + _statusBar?.SetNeedsDraw(); + } + + #endregion + + #region Public Methods + + /// + /// Sets the regex error message displayed in the filter error view. + /// + /// The error message to display. + internal void SetRegexError(string error) + { + if (string.Equals(error, _filterErrorView?.Text, StringComparison.Ordinal)) return; + _filterErrorView?.Text = error; + } + + #endregion + + #region ITreeBuilder Implementation + + /// + /// Determines whether the specified object can be expanded to show children. + /// + /// The object to check for expansion capability. + /// if the object can be expanded; otherwise, . + public bool CanExpand(object toExpand) + { + if (toExpand is CachedMemberResult p) return IsBasicType(p.Value); + + return IsBasicType(toExpand); + } + + /// + /// Gets the child objects for the specified parent object. + /// + /// The parent object to get children for. + /// An enumerable collection of child objects. + public IEnumerable GetChildren(object? forObject) + { + while (true) + { + if (forObject == null || !CanExpand(forObject)) return []; + + switch (forObject) + { + case CachedMemberResult { IsCollection: true } p: + return p.Elements ?? Enumerable.Empty(); + case CachedMemberResult p: + forObject = p.Value; + continue; + case CachedMemberResultElement e: + forObject = e.Value; + continue; + } + + var children = new List(); + + foreach (var member in forObject.GetType().GetMembers(BindingFlags.Instance | BindingFlags.Public) + .OrderBy(m => m.Name)) + { + if (member is PropertyInfo prop) + children.Add(new CachedMemberResult(forObject, prop)); + + if (member is FieldInfo field) + children.Add(new CachedMemberResult(forObject, field)); + } + + try + { + children.AddRange(GetExtraChildren(forObject)); + } + catch (Exception) + { + // Extra children unavailable, possibly security or IO exceptions enumerating children etc + } + + return children; + } + } + + #endregion + + #region Helper Methods + + /// + /// Gets the display text for an object in the tree view. + /// + /// The object to get display text for. + /// The display text for the object. + private string? AspectGetter(object? toRender) + { + return toRender switch + { + Process p => p.ProcessName, + null => "Null", + FileSystemInfo fsi when !IsRootObject(fsi) => fsi.Name, + _ => toRender.ToString() + }; + } + + /// + /// Determines whether the specified object is a root object in the tree. + /// + /// The object to check. + /// if the object is a root object; otherwise, . + private bool IsRootObject(object o) => _tree is { Objects: not null } && _tree.Objects.Contains(o); + + /// + /// Determines whether the specified value is a basic (non-primitive, non-string) type that can be expanded. + /// + /// The value to check. + /// if the value is a basic type; otherwise, . + private static bool IsBasicType(object? value) => + value != null && value is not string && !value.GetType().IsValueType; + + /// + /// Gets additional child objects for special types like DirectoryInfo. + /// + /// The object to get extra children for. + /// An enumerable collection of additional child objects. + private static IEnumerable GetExtraChildren(object forObject) + { + if (forObject is DirectoryInfo dir) + foreach (var c in dir.EnumerateFileSystemInfos()) + yield return c; + } + + /// + /// Creates the keyboard shortcuts for the status bar. + /// + /// The root objects being displayed. + /// A list of shortcuts for the status bar. + private List CreateShortcuts(List rootObjects) + { + var shortcuts = new List(); + + var elementDescription = "objects"; + var types = rootObjects.Select(o => o.GetType()).Distinct().ToArray(); + if (types.Length == 1) + elementDescription = types[0].Name; + + shortcuts.Add(new Shortcut(Key.Esc, "Close", () => App?.RequestStop())); + + var countShortcut = new Shortcut(Key.Empty, $"{rootObjects.Count} {elementDescription}", null); + _selectedShortcut = new Shortcut(Key.Empty, string.Empty, null); + shortcuts.Add(countShortcut); + shortcuts.Add(_selectedShortcut); + + return shortcuts; + } + + #endregion +} diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectView.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectView.cs index 989cab1..2f63622 100644 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectView.cs +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectView.cs @@ -2,461 +2,58 @@ // Licensed under the MIT License. using System; -using System.Collections; using System.Collections.Generic; -using System.Diagnostics; -using System.IO; using System.Linq; using System.Management.Automation; -using System.Reflection; -using System.Text.RegularExpressions; - -using OutGridView.Models; - -using Terminal.Gui; -using Terminal.Gui.Trees; - -namespace OutGridView.Cmdlet +using Microsoft.PowerShell.OutGridView.Models; +using Terminal.Gui.App; + +namespace Microsoft.PowerShell.ConsoleGuiTools; + +/// +/// Provides the main orchestration for the Show-ObjectTree cmdlet, managing the Terminal.Gui application lifecycle +/// and coordinating between the application data and the tree view window. +/// +/// +/// This class serves as a facade that initializes the Terminal.Gui framework, creates and runs the tree view window, +/// and handles cleanup operations. It delegates the actual UI rendering and user interaction to the class. +/// +internal sealed class ShowObjectView : IDisposable { - internal sealed class ShowObjectView : Window, ITreeBuilder + /// + /// Runs the Show-ObjectView Terminal.Gui Application with the specified configuration. + /// + /// The application configuration containing the PSObjects and display options. + /// + /// + /// This method initializes the Terminal.Gui framework, creates a instance, + /// and runs it until the user closes the window. The method handles the complete application lifecycle + /// including initialization, execution, and shutdown. + /// + /// + internal static void Run(ApplicationData applicationData) { - private readonly TreeView tree; - private readonly RegexTreeViewTextFilter filter; - private readonly Label filterErrorLabel; - - public bool SupportsCanExpand => true; - private StatusItem selectedStatusBarItem; - private StatusBar statusBar; - - public ShowObjectView(List rootObjects, ApplicationData applicationData) - { - Title = applicationData.Title; - Width = Dim.Fill(); - Height = Dim.Fill(1); - Modal = false; - - - if (applicationData.MinUI) - { - Border.BorderStyle = BorderStyle.None; - Title = string.Empty; - X = -1; - Height = Dim.Fill(); - } - - tree = new TreeView - { - Y = applicationData.MinUI ? 0 : 2, - Width = Dim.Fill(), - Height = Dim.Fill(), - }; - tree.TreeBuilder = this; - tree.AspectGetter = this.AspectGetter; - tree.SelectionChanged += this.SelectionChanged; - - tree.ClearKeybinding(Command.ExpandAll); - - this.filter = new RegexTreeViewTextFilter(this, tree); - this.filter.Text = applicationData.Filter ?? string.Empty; - tree.Filter = this.filter; - - if (rootObjects.Count > 0) - { - tree.AddObjects(rootObjects); - } - else - { - tree.AddObject("No Objects"); - } - statusBar = new StatusBar(); - - string elementDescription = "objects"; - - var types = rootObjects.Select(o => o.GetType()).Distinct().ToArray(); - if (types.Length == 1) - { - elementDescription = types[0].Name; - } - - var lblFilter = new Label() - { - Text = "Filter:", - X = 1, - }; - var tbFilter = new TextField() - { - X = Pos.Right(lblFilter), - Width = Dim.Fill(1), - Text = applicationData.Filter ?? string.Empty - }; - tbFilter.CursorPosition = tbFilter.Text.Length; - - tbFilter.TextChanged += (_) => - { - filter.Text = tbFilter.Text.ToString(); - }; - - - filterErrorLabel = new Label(string.Empty) - { - X = Pos.Right(lblFilter) + 1, - Y = Pos.Top(lblFilter) + 1, - ColorScheme = Colors.Base, - Width = Dim.Fill() - lblFilter.Text.Length - }; - - if (!applicationData.MinUI) - { - Add(lblFilter); - Add(tbFilter); - Add(filterErrorLabel); - } - - int pos = 0; - statusBar.AddItemAt(pos++, new StatusItem(Key.Esc, "~ESC~ Close", () => Application.RequestStop())); - - var siCount = new StatusItem(Key.Null, $"{rootObjects.Count} {elementDescription}", null); - selectedStatusBarItem = new StatusItem(Key.Null, string.Empty, null); - statusBar.AddItemAt(pos++, siCount); - statusBar.AddItemAt(pos++, selectedStatusBarItem); - - if (applicationData.Debug) - { - statusBar.AddItemAt(pos++, new StatusItem(Key.Null, $" v{applicationData.ModuleVersion}", null)); - statusBar.AddItemAt(pos++, new StatusItem(Key.Null, - $"{Application.Driver} v{FileVersionInfo.GetVersionInfo(Assembly.GetAssembly(typeof(Application)).Location).ProductVersion}", null)); - } - - statusBar.Visible = !applicationData.MinUI; - Application.Top.Add(statusBar); - - Add(tree); - } - private void SetRegexError(string error) - { - if (string.Equals(error, filterErrorLabel.Text.ToString(), StringComparison.Ordinal)) - { - return; - } - filterErrorLabel.Text = error; - filterErrorLabel.ColorScheme = Colors.Error; - filterErrorLabel.Redraw(filterErrorLabel.Bounds); - } - - private void SelectionChanged(object sender, SelectionChangedEventArgs e) - { - var selectedValue = e.NewValue; - - if (selectedValue is CachedMemberResult cmr) - { - selectedValue = cmr.Value; - } - - if (selectedValue != null && selectedStatusBarItem != null) - { - selectedStatusBarItem.Title = selectedValue.GetType().Name; - } - else - { - selectedStatusBarItem.Title = string.Empty; - } - - statusBar.SetNeedsDisplay(); - } - - private string AspectGetter(object toRender) - { - if (toRender is Process p) - { - return p.ProcessName; - } - if (toRender is null) - { - return "Null"; - } - if (toRender is FileSystemInfo fsi && !IsRootObject(fsi)) - { - return fsi.Name; - } - - return toRender.ToString(); - } - - private bool IsRootObject(object o) - { - return tree.Objects.Contains(o); - } - - public bool CanExpand(object toExpand) - { - if (toExpand is CachedMemberResult p) - { - return IsBasicType(p?.Value); - } - - // Any complex object type can be expanded to reveal properties - return IsBasicType(toExpand); - } - - private static bool IsBasicType(object value) - { - return value != null && value is not string && !value.GetType().IsValueType; - } - - public IEnumerable GetChildren(object forObject) - { - if (forObject == null || !this.CanExpand(forObject)) - { - return Enumerable.Empty(); - } - - if (forObject is CachedMemberResult p) - { - if (p.IsCollection) - { - return p.Elements; - } - - return GetChildren(p.Value); - } - - if (forObject is CachedMemberResultElement e) - { - return GetChildren(e.Value); - } - - List children = new List(); - - foreach (var member in forObject.GetType().GetMembers(BindingFlags.Instance | BindingFlags.Public).OrderBy(m => m.Name)) - { - if (member is PropertyInfo prop) - { - children.Add(new CachedMemberResult(forObject, prop)); - } - if (member is FieldInfo field) - { - children.Add(new CachedMemberResult(forObject, field)); - } - } - - try - { - children.AddRange(GetExtraChildren(forObject)); - } - catch (Exception) - { - // Extra children unavailable, possibly security or IO exceptions enumerating children etc - } - - return children; - } - - private static IEnumerable GetExtraChildren(object forObject) - { - if (forObject is DirectoryInfo dir) - { - foreach (var c in dir.EnumerateFileSystemInfos()) - { - yield return c; - } - } - } - - internal static void Run(List objects, ApplicationData applicationData) - { - // Note, in Terminal.Gui v2, this property is renamed to Application.UseNetDriver, hence - // using that terminology here. - Application.UseSystemConsole = applicationData.UseNetDriver; - Application.Init(); - Window window = null; - - try - { - window = new ShowObjectView(objects.Select(p => p.BaseObject).ToList(), applicationData); - Application.Top.Add(window); - Application.Run(); - } - finally - { - Application.Shutdown(); - window?.Dispose(); - } - } - - sealed class CachedMemberResultElement - { - public int Index; - public object Value; - - private string representation; - - public CachedMemberResultElement(object value, int index) - { - Index = index; - Value = value; - - try - { - representation = Value?.ToString() ?? "Null"; - } - catch (Exception) - { - Value = representation = "Unavailable"; - } - } - public override string ToString() - { - return $"[{Index}]: {representation}]"; - } - } - - sealed class CachedMemberResult - { - public MemberInfo Member; - public object Value; - public object Parent; - private string representation; - private List valueAsList; - - - public bool IsCollection => valueAsList != null; - public IReadOnlyCollection Elements => valueAsList?.AsReadOnly(); - - public CachedMemberResult(object parent, MemberInfo mem) - { - Parent = parent; - Member = mem; - - try - { - if (mem is PropertyInfo p) - { - Value = p.GetValue(parent); - } - else if (mem is FieldInfo f) - { - Value = f.GetValue(parent); - } - else - { - throw new NotSupportedException($"Unknown {nameof(MemberInfo)} Type"); - } - - representation = ValueToString(); - - } - catch (Exception) - { - Value = representation = "Unavailable"; - } - } - - private string ValueToString() - { - if (Value == null) - { - return "Null"; - } - try - { - if (IsCollectionOfKnownTypeAndSize(out Type elementType, out int size)) - { - return $"{elementType.Name}[{size}]"; - } - } - catch (Exception) - { - return Value?.ToString(); - } - - - return Value?.ToString(); - } - - private bool IsCollectionOfKnownTypeAndSize(out Type elementType, out int size) - { - elementType = null; - size = 0; - - if (Value == null || Value is string) - { - - return false; - } - - if (Value is IEnumerable ienumerable) - { - var list = ienumerable.Cast().ToList(); - - var types = list.Where(v => v != null).Select(v => v.GetType()).Distinct().ToArray(); - - if (types.Length == 1) - { - elementType = types[0]; - size = list.Count; - - valueAsList = list.Select((e, i) => new CachedMemberResultElement(e, i)).ToList(); - return true; - } - } - - return false; - } - - public override string ToString() - { - return Member.Name + ": " + representation; - } - } - private sealed class RegexTreeViewTextFilter : ITreeViewFilter - { - private readonly ShowObjectView parent; - readonly TreeView _forTree; - - public RegexTreeViewTextFilter(ShowObjectView parent, TreeView forTree) - { - this.parent = parent; - _forTree = forTree ?? throw new ArgumentNullException(nameof(forTree)); - } - - private string text; - - public string Text - { - get { return text; } - set - { - text = value; - RefreshTreeView(); - } - } - - private void RefreshTreeView() - { - _forTree.InvalidateLineMap(); - _forTree.SetNeedsDisplay(); - } - - public bool IsMatch(object model) - { - if (string.IsNullOrWhiteSpace(Text)) - { - return true; - } - - parent.SetRegexError(string.Empty); + Terminal.Gui.Configuration.ConfigurationManager.Enable(Terminal.Gui.Configuration.ConfigLocations.All); + + ShowObjectTreeWindow window = new(applicationData); + IApplication app = Application.Create(); + app.AppModel = applicationData.FullScreen ? AppModel.FullScreen : AppModel.Inline; + app.ForceInlinePosition = new(0, 10); + app.Init(driverName: applicationData.Driver); + app.Run(window); + window.Dispose(); + app.Dispose(); + } - var modelText = _forTree.AspectGetter(model); - try - { - return Regex.IsMatch(modelText, text, RegexOptions.IgnoreCase); - } - catch (RegexParseException e) - { - parent.SetRegexError(e.Message); - return true; - } - } - } + /// + /// Releases resources used by the . + /// + /// + /// Currently, there are no resources to dispose. This method is provided for future extensibility + /// and to follow the standard IDisposable pattern. + /// + public void Dispose() + { + // No resources to dispose currently } -} +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/TypeGetter.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/TypeGetter.cs index 6f3f643..3f36372 100644 --- a/src/Microsoft.PowerShell.ConsoleGuiTools/TypeGetter.cs +++ b/src/Microsoft.PowerShell.ConsoleGuiTools/TypeGetter.cs @@ -1,198 +1,370 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - using System; using System.Collections.Generic; using System.Globalization; using System.Linq; using System.Management.Automation; -using System.Management.Automation.Internal; - -using Microsoft.PowerShell.Commands; +using System.Text.RegularExpressions; +using Microsoft.PowerShell.OutGridView.Models; -using OutGridView.Models; +namespace Microsoft.PowerShell.ConsoleGuiTools; -namespace OutGridView.Cmdlet +/// +/// Provides methods to retrieve type information and convert PowerShell objects into data table structures for display +/// in the grid view using PowerShell's native formatting infrastructure. +/// +public class TypeGetter { - public class TypeGetter + /// + /// Regex pattern to match ANSI escape sequences. + /// + private static readonly Regex AnsiEscapeRegex = new(@"\x1b\[[0-9;]*m", RegexOptions.Compiled); + + /// + /// Types that are considered primitives to PowerShell but not to C#. + /// + private static readonly List ADDITIONAL_PRIMITIVE_TYPES = + [ + "System.String", + "System.Decimal", + "System.IntPtr", + "System.Security.SecureString", + "System.Numerics.BigInteger" + ]; + + private readonly Dictionary _formatCache = new(); + + /// + /// Strips ANSI escape sequences from a string. + /// + /// The string potentially containing ANSI codes. + /// The string with ANSI codes removed. + private static string StripAnsiCodes(string value) + { + if (string.IsNullOrEmpty(value)) return value; + return AnsiEscapeRegex.Replace(value, string.Empty); + } + + /// + /// Gets the format view definition for the specified type name, using a cache to avoid redundant lookups. + /// + /// The full type name to get the format view definition for. + /// The format view definition if found; otherwise, . + private FormatViewDefinition? GetFormatViewDefinitionForType(string typeName) { - private PSCmdlet _cmdlet; + if (_formatCache.TryGetValue(typeName, out var cached)) return cached; - public TypeGetter(PSCmdlet cmdlet) + try { - _cmdlet = cmdlet; + // Use the current runspace to access format data from loaded modules + // This is critical for CIM instances (like Get-NetAdapter) which have format data + // defined in their respective modules' .ps1xml files + using var ps = System.Management.Automation.PowerShell.Create(RunspaceMode.CurrentRunspace); + ps.AddCommand("Get-FormatData").AddParameter("TypeName", typeName); + + var results = ps.Invoke(); + + FormatViewDefinition? result = null; + if (results.Count > 0) + { + var extendedTypeDefinition = results[0].BaseObject as ExtendedTypeDefinition; + result = extendedTypeDefinition?.FormatViewDefinition.FirstOrDefault(v => v.Control is TableControl); + } + + _formatCache[typeName] = result; + return result; } - public FormatViewDefinition GetFormatViewDefinitionForObject(PSObject obj) + catch { - var typeName = obj.BaseObject.GetType().FullName; + // If we can't get format data (e.g., not running in a runspace context), + // cache null and continue with fallback logic + _formatCache[typeName] = null; + return null; + } + } - var types = _cmdlet.InvokeCommand.InvokeScript(@"Microsoft.PowerShell.Utility\Get-FormatData " + typeName).ToList(); + /// + /// Gets the format view definition for the specified PowerShell object. + /// + /// The PowerShell object to get the format view definition for. + /// The format view definition if found; otherwise, . + private FormatViewDefinition? GetFormatViewDefinitionForObject(PSObject obj) + { + // PSObject has a TypeNames collection that includes PowerShell-specific type names + // These are what the format system uses, not the .NET type name + // For example, Get-NetAdapter returns objects with TypeName like "Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter" - //No custom type definitions found - try the PowerShell specific format data - if (types == null || types.Count == 0) - { - types = _cmdlet.InvokeCommand - .InvokeScript(@"Microsoft.PowerShell.Utility\Get-FormatData -PowerShellVersion $PSVersionTable.PSVersion " + typeName).ToList(); + foreach (var typeName in obj.TypeNames) + { + if (_formatCache.TryGetValue(typeName, out var cached)) + return cached; - if (types == null || types.Count == 0) - { - return null; - } - } + var fvd = GetFormatViewDefinitionForType(typeName); + if (fvd != null) return fvd; + } - var extendedTypeDefinition = types[0].BaseObject as ExtendedTypeDefinition; + // Fallback to base object type name + var baseTypeName = obj.BaseObject.GetType().FullName; + if (baseTypeName is not null) + { + if (_formatCache.TryGetValue(baseTypeName, out var cached)) + return cached; - return extendedTypeDefinition.FormatViewDefinition[0]; + return GetFormatViewDefinitionForType(baseTypeName); } - public static DataTableRow CastObjectToDataTableRow(PSObject ps, List dataColumns, int objectIndex) + return null; + } + + /// + /// Gets the default display property set (TableContent) for a PowerShell object. + /// This represents the subset of properties that PowerShell displays by default. + /// + /// The PowerShell object to examine. + /// A list of property names to display, or null if no default display set is defined. + private static List? GetDefaultDisplayPropertySet(PSObject obj) + { + try { - Dictionary valuePairs = new Dictionary(); + // For CIM instances and other objects, PowerShell adds PSStandardMembers + // through the Extended Type System (ETS), not always as instance members + + // First check instance members (for objects with runtime-added members) + var standardMembers = obj.Members["PSStandardMembers"]?.Value as PSMemberSet; + var defaultDisplayProperty = standardMembers?.Members["DefaultDisplayPropertySet"]?.Value as PSPropertySet; + + if (defaultDisplayProperty?.ReferencedPropertyNames is { Count: > 0 }) + return defaultDisplayProperty.ReferencedPropertyNames.ToList(); - foreach (var dataColumn in dataColumns) + // Second, check PSObject.Properties for DefaultDisplayPropertySet + // Some objects have this defined through type adapters + var psStandardMembers = obj.Properties["PSStandardMembers"]; + if (psStandardMembers?.Value is PSMemberSet memberSet) { - var expression = new PSPropertyExpression(ScriptBlock.Create(dataColumn.PropertyScriptAccessor)); + var displayPropSet = memberSet.Members["DefaultDisplayPropertySet"] as PSPropertySet; + if (displayPropSet?.ReferencedPropertyNames is { Count: > 0 }) + return displayPropSet.ReferencedPropertyNames.ToList(); + } + } + catch + { + // If we can't get the default display property set, return null + } + + return null; + } - var result = expression.GetValues(ps).FirstOrDefault().Result; + /// + /// Retrieves the column definitions for the specified PowerShell objects based on their format view definitions or + /// properties. + /// + /// The list of PowerShell objects to analyze. + /// A distinct list of data table columns. + private List GetDataColumnsForObject(List psObjects) + { + if (psObjects.Count == 0) return []; + return GetDataColumnsForObject(psObjects[0]); + } - var stringValue = result?.ToString() ?? String.Empty; + /// + /// Determines the data columns from a single PSObject (using format view definitions, DefaultDisplayPropertySet, or + /// all properties). + /// + internal List GetDataColumnsForObject(PSObject firstObject) + { + var dataColumns = new List(); - var isDecimal = decimal.TryParse(stringValue, NumberStyles.Any, CultureInfo.InvariantCulture.NumberFormat, out var decimalValue); + List labels; + List propertyAccessors; - if (isDecimal) - { - valuePairs[dataColumn.ToString()] = new DecimalValue { DisplayValue = stringValue, SortValue = decimalValue }; - } - else - { - var stringDecorated = new StringDecorated(stringValue); - valuePairs[dataColumn.ToString()] = new StringValue { DisplayValue = stringDecorated.ToString(OutputRendering.PlainText) }; - } - } + // Priority order: + // 1. Format view definition (from .ps1xml files) - what cmdlets like Get-NetAdapter use + // 2. DefaultDisplayPropertySet (TableContent) - used by custom objects + // 3. All properties (fallback) - return new DataTableRow(valuePairs, objectIndex); - } + var fvd = GetFormatViewDefinitionForObject(firstObject); + var defaultDisplayProps = GetDefaultDisplayPropertySet(firstObject); - private static void SetTypesOnDataColumns(List dataTableRows, List dataTableColumns) + if (fvd?.Control is TableControl tableControl) { - var dataRows = dataTableRows.Select(x => x.Values); - - foreach (var dataColumn in dataTableColumns) - { - dataColumn.StringType = typeof(decimal).FullName; - } + // Use the table format definition (THIS IS WHAT GET-NETADAPTER USES) + var definedColumnLabels = tableControl.Headers.Select(h => h.Label).ToList(); + var displayEntries = tableControl.Rows[0].Columns.Select(c => c.DisplayEntry).ToArray(); + var propertyLabels = displayEntries.Select(de => de.Value).ToList(); - //If every value in a column could be a decimal, assume that it is supposed to be a decimal - foreach (var dataRow in dataRows) + // Use the TypeDefinition Label if available otherwise just use the property name as a label + labels = definedColumnLabels.Zip(propertyLabels, (definedLabel, propLabel) => { - foreach (var dataColumn in dataTableColumns) - { - if (!(dataRow[dataColumn.ToString()] is DecimalValue)) - { - dataColumn.StringType = typeof(string).FullName; - } - } - } + if (string.IsNullOrEmpty(definedLabel)) return propLabel; + return definedLabel; + }).ToList(); + + propertyAccessors = displayEntries.Select(de => + de.ValueType == DisplayEntryValueType.Property + ? $"$_.\"{de.Value}\"" + : de.Value // ScriptBlock + ).ToList(); } - private List GetDataColumnsForObject(List psObjects) + else if (defaultDisplayProps is { Count: > 0 }) { - var dataColumns = new List(); + // Use the DefaultDisplayPropertySet (for custom objects) + labels = defaultDisplayProps; + propertyAccessors = defaultDisplayProps.Select(p => $"$_.\"{p}\"").ToList(); + } + else if (PsObjectIsPrimitive(firstObject)) + { + // Handle primitive types + labels = [firstObject.BaseObject.GetType().Name]; + propertyAccessors = ["$_"]; + } + else + { + // Fallback to all properties + labels = firstObject.Properties.Select(p => p.Name).ToList(); + propertyAccessors = firstObject.Properties.Select(p => $"$_.\"{p.Name}\"").ToList(); + } + + for (var i = 0; i < labels.Count; i++) + { + var column = new DataTableColumn(labels[i], propertyAccessors[i]); + dataColumns.Add(column); + } + return dataColumns.Distinct().ToList(); + } + /// + /// Determines whether the specified PowerShell object represents a primitive type. + /// + private static bool PsObjectIsPrimitive(PSObject ps) + { + var psBaseType = ps.BaseObject.GetType(); + return psBaseType.IsPrimitive || psBaseType.IsEnum || + ADDITIONAL_PRIMITIVE_TYPES.Contains(psBaseType.FullName!); + } - foreach (PSObject obj in psObjects) - { - var labels = new List(); + /// + /// Converts a PowerShell object to a data table row using PSPropertyExpression to evaluate property accessors. + /// + public static DataTableRow CastObjectToDataTableRow(PSObject psObject, List dataTableColumns, + int objectIndex) + { + var valuePairs = new Dictionary(); - FormatViewDefinition fvd = GetFormatViewDefinitionForObject(obj); + foreach (var column in dataTableColumns) + { + object? result; - var propertyAccessors = new List(); + try + { + // PSPropertyExpression constructor takes a ScriptBlock for script expressions + // For simple properties, we need to extract just the property name + var accessor = column.PropertyScriptAccessor; - if (fvd == null) +#pragma warning disable CA1310 + if (accessor.StartsWith("$_.\"") && accessor.EndsWith("\"")) +#pragma warning restore CA1310 { - if (PSObjectIsPrimitive(obj)) - { - labels = new List { obj.BaseObject.GetType().Name }; - propertyAccessors = new List { "$_" }; - } - else - { - labels = obj.Properties.Select(x => x.Name).ToList(); - propertyAccessors = obj.Properties.Select(x => $"$_.\"{x.Name}\"").ToList(); - } + // Extract property name from "$_."PropertyName"" format + var propertyName = accessor.Substring(4, accessor.Length - 5); + var property = psObject.Properties[propertyName]; + result = property?.Value; + + // Unwrap PSObject if needed to get the base value + if (result is PSObject psObjResult) result = psObjResult.BaseObject; } - else + else if (accessor == "$_") { - var tableControl = fvd.Control as TableControl; - - var definedColumnLabels = tableControl.Headers.Select(x => x.Label); - - var displayEntries = tableControl.Rows[0].Columns.Select(x => x.DisplayEntry); - - var propertyLabels = displayEntries.Select(x => x.Value); - - //Use the TypeDefinition Label if availble otherwise just use the property name as a label - labels = definedColumnLabels.Zip(propertyLabels, (definedColumnLabel, propertyLabel) => - { - if (String.IsNullOrEmpty(definedColumnLabel)) - { - return propertyLabel; - } - return definedColumnLabel; - }).ToList(); - - - propertyAccessors = displayEntries.Select(x => - { - //If it's a propety access directly - if (x.ValueType == DisplayEntryValueType.Property) - { - return $"$_.\"{x.Value}\""; - } - //Otherwise return access script - return x.Value; - }).ToList(); + // The whole object + result = psObject.BaseObject; } - - for (var i = 0; i < labels.Count; i++) + else { - dataColumns.Add(new DataTableColumn(labels[i], propertyAccessors[i])); + // It's a script block - create and invoke it + var scriptBlock = ScriptBlock.Create(accessor); + var results = scriptBlock.InvokeWithContext(null, [new("_", psObject)]); + result = results.FirstOrDefault(); + + // Unwrap PSObject if needed + if (result is PSObject psScriptResult) result = psScriptResult.BaseObject; } } - return dataColumns.Distinct().ToList(); - } + catch (Exception _) + { + // If evaluation fails, use null + result = null; + } - public DataTable CastObjectsToTableView(List psObjects) - { - List objectFormats = psObjects.Select(GetFormatViewDefinitionForObject).ToList(); + // Convert to string and strip ANSI codes + var displayValue = result?.ToString() ?? string.Empty; + displayValue = StripAnsiCodes(displayValue); + + // Determine if this is a numeric value for sorting + var isNumeric = result is decimal or int or long or short or byte or double or float or uint or ulong + or ushort or sbyte; - var dataTableColumns = GetDataColumnsForObject(psObjects); + var columnKey = column.ToString(); - List dataTableRows = new List(); - for (var i = 0; i < objectFormats.Count; i++) + if (isNumeric) { - var dataTableRow = CastObjectToDataTableRow(psObjects[i], dataTableColumns, i); - dataTableRows.Add(dataTableRow); + var decimalValue = Convert.ToDecimal(result, CultureInfo.InvariantCulture); + valuePairs[columnKey] = new DecimalValue + { + DisplayValue = displayValue, + SortValue = decimalValue + }; } + else + { + valuePairs[columnKey] = new StringValue + { + DisplayValue = displayValue, + RawValue = result + }; + } + } - SetTypesOnDataColumns(dataTableRows, dataTableColumns); + return new DataTableRow(valuePairs, objectIndex); + } - return new DataTable(dataTableColumns, dataTableRows); - } + /// + /// Sets the data type on each column based on the values in the data rows. + /// + private static void SetTypesOnDataColumns(List dataTableRows, List dataTableColumns) + { + var dataRows = dataTableRows.Select(x => x.Values); + foreach (var dataColumn in dataTableColumns) + dataColumn.StringType = typeof(decimal).FullName; - //Types that are condisidered primitives to PowerShell but not C# - private readonly static List additionalPrimitiveTypes = new List { "System.String", - "System.Decimal", - "System.IntPtr", - "System.Security.SecureString", - "System.Numerics.BigInteger" - }; - private static bool PSObjectIsPrimitive(PSObject ps) - { - var psBaseType = ps.BaseObject.GetType(); + // If every value in a column could be a decimal, assume that it is supposed to be a decimal + foreach (var dataRow in dataRows) + foreach (var dataColumn in dataTableColumns) + if (dataRow[dataColumn.ToString()] is not DecimalValue) + dataColumn.StringType = typeof(string).FullName; + } - return psBaseType.IsPrimitive || psBaseType.IsEnum || additionalPrimitiveTypes.Contains(psBaseType.FullName); + /// + /// Converts a list of PowerShell objects into a data table structure suitable for display in the grid view. + /// + /// The list of PowerShell objects to convert. + public static DataTable CastObjectsToTableView(List psObjects) + { + if (psObjects.Count == 0) return new DataTable([], []); + + // Get the columns using format view definitions + var typeGetter = new TypeGetter(); + var dataTableColumns = typeGetter.GetDataColumnsForObject(psObjects).ToList(); + + // Convert each object to a row + var dataTableRows = new List(); + for (var i = 0; i < psObjects.Count; i++) + { + var dataTableRow = CastObjectToDataTableRow(psObjects[i], dataTableColumns, i); + dataTableRows.Add(dataTableRow); } + + SetTypesOnDataColumns(dataTableRows, dataTableColumns); + + return new DataTable(dataTableColumns, dataTableRows); } -} +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.OutGridView.Models/ApplicationData.cs b/src/Microsoft.PowerShell.OutGridView.Models/ApplicationData.cs index 84959f5..c50cf99 100644 --- a/src/Microsoft.PowerShell.OutGridView.Models/ApplicationData.cs +++ b/src/Microsoft.PowerShell.OutGridView.Models/ApplicationData.cs @@ -1,24 +1,73 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -using System; using System.Collections.Generic; -namespace OutGridView.Models +namespace Microsoft.PowerShell.OutGridView.Models; + +/// +/// Represents the application configuration and state data for the Out-ConsoleGridView component. +/// +public class ApplicationData { - public class ApplicationData - { - public string Title { get; set; } - public OutputModeOption OutputMode { get; set; } - public bool PassThru { get; set; } - public string Filter { get; set; } - public bool MinUI { get; set; } - public DataTable DataTable { get; set; } - - public bool UseNetDriver { get; set; } - public bool Verbose { get; set; } - public bool Debug { get; set; } - - public string ModuleVersion { get; set; } - } -} + /// + /// Gets or sets the PowerShell objects to display. + /// + public List? PSObjects { get; set; } + + /// + /// Gets or sets the output mode that determines how items can be selected and returned. + /// + public OutputModeOption OutputMode { get; set; } + + /// + /// Gets or sets the title displayed in the Out-GridView window. + /// + public string? Title { get; set; } + + /// + /// Gets or sets the filter text to apply to the data. + /// + public string? Filter { get; set; } + + /// + /// Gets or sets a value indicating whether to use minimal UI mode. + /// + public bool MinUI { get; set; } + + /// + /// Gets or sets the Terminal.Gui driver to use for rendering. + /// + public string? Driver { get; set; } + + /// + /// Gets or sets a value indicating whether verbose output is enabled. + /// + public bool Verbose { get; set; } + + /// + /// Gets or sets a value indicating whether debug output is enabled. + /// + public bool Debug { get; set; } + + /// + /// Gets or sets a value indicating whether the application should run in full-screen mode + /// using the alternate screen buffer. When false (default), the application renders inline. + /// + public bool FullScreen { get; set; } + + /// + /// Gets or sets the version of the module. + /// + public string? ModuleVersion { get; set; } + + /// + /// Gets or sets which UI element should receive initial focus. + /// + public FocusTarget Focus { get; set; } = FocusTarget.Table; + + /// + /// Gets or sets a search pattern that positions the cursor on the first matching row. + /// + public string? Search { get; set; } +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.OutGridView.Models/DataTable.cs b/src/Microsoft.PowerShell.OutGridView.Models/DataTable.cs index 950a7e5..3260700 100644 --- a/src/Microsoft.PowerShell.OutGridView.Models/DataTable.cs +++ b/src/Microsoft.PowerShell.OutGridView.Models/DataTable.cs @@ -2,18 +2,32 @@ // Licensed under the MIT License. using System.Collections.Generic; -using System.Collections.ObjectModel; -namespace OutGridView.Models + +namespace Microsoft.PowerShell.OutGridView.Models; + +/// +/// Represents a data table containing rows and columns for display in the grid view. +/// +public class DataTable { - public class DataTable - { - public List Data { get; set; } - public List DataColumns { get; set; } - public DataTable(List columns, List data) - { - DataColumns = columns; + /// + /// Gets or sets the list of data rows in the table. + /// + public List Data { get; set; } - Data = data; - } + /// + /// Gets or sets the list of column definitions for the table. + /// + public List DataColumns { get; set; } + + /// + /// Initializes a new instance of the class with the specified columns and data. + /// + /// The list of column definitions for the table. + /// The list of data rows for the table. + public DataTable(List columns, List data) + { + DataColumns = columns; + Data = data; } -} +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.OutGridView.Models/DataTableColumn.cs b/src/Microsoft.PowerShell.OutGridView.Models/DataTableColumn.cs index 0390dc4..a2e70a3 100644 --- a/src/Microsoft.PowerShell.OutGridView.Models/DataTableColumn.cs +++ b/src/Microsoft.PowerShell.OutGridView.Models/DataTableColumn.cs @@ -2,39 +2,114 @@ // Licensed under the MIT License. using System; -using Newtonsoft.Json; using System.Text; +using Newtonsoft.Json; + +// TODO: switch to System.Text.Json -namespace OutGridView.Models +namespace Microsoft.PowerShell.OutGridView.Models; + +/// +/// Represents a column in a data table with metadata about its label, type, and property accessor. +/// +/// The display label for the column. +/// The script accessor used to retrieve the property value. +public class DataTableColumn(string label, string propertyScriptAccessor) { - public class DataTableColumn + /// + /// Gets the runtime type of the column based on the property. + /// + [JsonIgnore] + public Type? Type => System.Type.GetType(StringType!); + + /// + /// Gets the display label for the column. + /// + public string Label { get; } = label; + + /// + /// Gets or sets the serializable string representation of the column's type. + /// + public string? StringType { get; set; } + + /// + /// Gets or sets the format string used to format values in this column. + /// This follows PowerShell/. NET composite formatting conventions (e.g., "N0" for numbers, "G" for DateTime). + /// + public string? FormatString { get; set; } + + /// + /// Gets the script accessor used to retrieve the property value for this column. + /// + public string PropertyScriptAccessor { get; } = propertyScriptAccessor; + + /// + /// Formats a value according to this column's format specification. + /// + /// The value to format. + /// A formatted string representation of the value. + public string FormatValue(object? value) { - [JsonIgnore] - public Type Type => Type.GetType(StringType); - public string Label { get; set; } - //Serializable Version of Type - public string StringType { get; set; } - public string PropertyScriptAccessor { get; set; } - public DataTableColumn(string label, string propertyScriptAccessor) - { - Label = label; - PropertyScriptAccessor = propertyScriptAccessor; - } + if (value == null) return string.Empty; - //Distinct column defined by Label, Prop Accessor - public override bool Equals(object obj) + // If we have a format string, try to use it + if (!string.IsNullOrEmpty(FormatString) && value is IFormattable formattable) { - DataTableColumn b = obj as DataTableColumn; - return b.Label == Label && b.PropertyScriptAccessor == PropertyScriptAccessor; + try + { + return formattable.ToString(FormatString, System.Globalization.CultureInfo.CurrentCulture); + } + catch + { + // Fall through to default formatting if format string is invalid + } } - public override int GetHashCode() + + // If FormatString is explicitly null, use simple ToString for most types + // (this prevents unwanted formatting of identifier integers like ProcessId) + if (FormatString == null) { - return Label.GetHashCode() + PropertyScriptAccessor.GetHashCode(); + return value.ToString() ?? string.Empty; } - public override string ToString() + + // Default formatting based on type (only when FormatString is empty but not null) + return value switch { - //Needs to be encoded to embed safely in xaml - return Convert.ToBase64String(Encoding.UTF8.GetBytes(Label + PropertyScriptAccessor)); - } + DateTime dt => dt.ToString("G", System.Globalization.CultureInfo.CurrentCulture), + decimal d => d.ToString("N0", System.Globalization.CultureInfo.CurrentCulture), + double db => db.ToString("N2", System.Globalization.CultureInfo.CurrentCulture), + float f => f.ToString("N2", System.Globalization.CultureInfo.CurrentCulture), + int or long or short or byte => string.Format(System.Globalization.CultureInfo.CurrentCulture, "{0:N0}", value), + _ => value.ToString() ?? string.Empty + }; } -} + + /// + /// Determines whether the specified object is equal to the current column. + /// Two columns are considered equal if they have the same label and property script accessor. + /// + /// The object to compare with the current column. + /// + /// if the specified object is equal to the current column; otherwise, + /// . + /// + public override bool Equals(object? obj) + { + var b = obj as DataTableColumn; + return b?.Label == Label && b.PropertyScriptAccessor == PropertyScriptAccessor; + } + + /// + /// Returns the hash code for this column based on its label and property script accessor. + /// + /// A hash code for the current column. + public override int GetHashCode() => Label.GetHashCode() + PropertyScriptAccessor.GetHashCode(); + + /// + /// Returns a Base64-encoded string representation of the column for safe embedding in XAML. + /// + /// A Base64-encoded string containing the label and property script accessor. + public override string ToString() => + // Needs to be encoded to embed safely in XAML + Convert.ToBase64String(Encoding.UTF8.GetBytes(Label + PropertyScriptAccessor)); +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.OutGridView.Models/DataTableRow.cs b/src/Microsoft.PowerShell.OutGridView.Models/DataTableRow.cs index 3888691..5eb958d 100644 --- a/src/Microsoft.PowerShell.OutGridView.Models/DataTableRow.cs +++ b/src/Microsoft.PowerShell.OutGridView.Models/DataTableRow.cs @@ -4,44 +4,118 @@ using System; using System.Collections.Generic; -namespace OutGridView.Models +namespace Microsoft.PowerShell.OutGridView.Models; + +/// +/// Represents a value that can be displayed and compared in a data table. +/// +public interface IValue : IComparable { - public interface IValue : IComparable - { - string DisplayValue { get; set; } - } - public class DecimalValue : IValue - { - public string DisplayValue { get; set; } - public decimal SortValue { get; set; } - - public int CompareTo(object obj) - { - DecimalValue otherDecimalValue = obj as DecimalValue; - if (otherDecimalValue == null) return 1; - return Decimal.Compare(SortValue, otherDecimalValue.SortValue); - } - } - public class StringValue : IValue - { - public string DisplayValue { get; set; } - public int CompareTo(object obj) - { - StringValue otherStringValue = obj as StringValue; - if (otherStringValue == null) return 1; - return DisplayValue.CompareTo(otherStringValue.DisplayValue); - } - } - public class DataTableRow + /// + /// Gets or sets the string representation of the value for display purposes. + /// + string DisplayValue { get; set; } + + /// + /// Gets the original object value before formatting. + /// + object? OriginalValue { get; } +} + +/// +/// Represents a decimal value in a data table with support for numeric sorting. +/// +public class DecimalValue : IValue +{ + /// + /// Gets or sets the string representation of the decimal value for display purposes. + /// + public required string DisplayValue { get; set; } + + /// + /// Gets or sets the decimal value used for sorting. + /// + public decimal SortValue { get; set; } + + /// + /// Gets the original decimal value. + /// + public object? OriginalValue => SortValue; + + /// + /// Compares the current instance with another object of the same type. + /// + /// An object to compare with this instance. + /// + /// A value that indicates the relative order of the objects being compared. + /// Less than zero if this instance precedes , + /// zero if they are equal, or greater than zero if this instance follows . + /// Returns 1 if is not a . + /// + public int CompareTo(object? obj) => obj is not DecimalValue otherDecimalValue + ? 1 + : decimal.Compare(SortValue, otherDecimalValue.SortValue); +} + +/// +/// Represents a string value in a data table with support for string sorting. +/// +public class StringValue : IValue +{ + /// + /// Gets or sets the string value for display and sorting purposes. + /// + public required string DisplayValue { get; set; } + + /// + /// Gets or sets the original object value before conversion to string. + /// + public object? RawValue { get; set; } + + /// + /// Gets the original object value. + /// + public object? OriginalValue => RawValue ?? DisplayValue; + + /// + /// Compares the current instance with another object of the same type. + /// + /// An object to compare with this instance. + /// + /// A value that indicates the relative order of the objects being compared. + /// Less than zero if this instance precedes , + /// zero if they are equal, or greater than zero if this instance follows . + /// Returns 1 if is not a . + /// + public int CompareTo(object? obj) => obj is not StringValue otherStringValue + ? 1 + : string.Compare(DisplayValue, otherStringValue.DisplayValue, StringComparison.Ordinal); +} + +/// +/// Represents a single row in a data table with values mapped to column identifiers. +/// +public class DataTableRow +{ + /// + /// Gets or sets the dictionary of values for this row, keyed by the column identifier. + /// The key is the data column hash code serialized as a string for JSON compatibility. + /// + public Dictionary Values { get; set; } + + /// + /// Gets or sets the original index of the object in the source collection before any transformations. + /// + public int OriginalObjectIndex { get; set; } + + /// + /// Initializes a new instance of the class with the specified values and original index. + /// + /// The dictionary of values for this row, keyed by column identifier. + /// The original index of the object in the source collection. + public DataTableRow(Dictionary data, int originalObjectIndex) { - //key is datacolumn hash code - //have to do it this way because JSON can't serialize objects as keys - public Dictionary Values { get; set; } - public int OriginalObjectIndex { get; set; } - public DataTableRow(Dictionary data, int originalObjectIndex) - { - Values = data; - OriginalObjectIndex = originalObjectIndex; - } + Values = data; + OriginalObjectIndex = originalObjectIndex; } -} +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.OutGridView.Models/FocusTarget.cs b/src/Microsoft.PowerShell.OutGridView.Models/FocusTarget.cs new file mode 100644 index 0000000..7850a45 --- /dev/null +++ b/src/Microsoft.PowerShell.OutGridView.Models/FocusTarget.cs @@ -0,0 +1,20 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +namespace Microsoft.PowerShell.OutGridView.Models; + +/// +/// Specifies which UI element should receive initial focus. +/// +public enum FocusTarget +{ + /// + /// The table/grid view receives initial focus (default). + /// + Table, + + /// + /// The filter text field receives initial focus. + /// + Filter +} diff --git a/src/Microsoft.PowerShell.OutGridView.Models/Microsoft.PowerShell.OutGridView.Models.csproj b/src/Microsoft.PowerShell.OutGridView.Models/Microsoft.PowerShell.OutGridView.Models.csproj index a4f10f5..f532b00 100644 --- a/src/Microsoft.PowerShell.OutGridView.Models/Microsoft.PowerShell.OutGridView.Models.csproj +++ b/src/Microsoft.PowerShell.OutGridView.Models/Microsoft.PowerShell.OutGridView.Models.csproj @@ -1,9 +1,15 @@ - net8.0 + net10.0 + latest + enable + + + + diff --git a/src/Microsoft.PowerShell.OutGridView.Models/OutputModeOptions.cs b/src/Microsoft.PowerShell.OutGridView.Models/OutputModeOptions.cs index 3170c98..bc499b8 100644 --- a/src/Microsoft.PowerShell.OutGridView.Models/OutputModeOptions.cs +++ b/src/Microsoft.PowerShell.OutGridView.Models/OutputModeOptions.cs @@ -1,23 +1,24 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -namespace OutGridView.Models +namespace Microsoft.PowerShell.OutGridView.Models; + +public enum OutputModeOption { - public enum OutputModeOption - { - /// - /// None is the default and it means OK and Cancel will not be present - /// and no objects will be written to the pipeline. - /// The selectionMode of the actual list will still be multiple. - /// - None, - /// - /// Allow selection of one single item to be written to the pipeline. - /// - Single, - /// - ///Allow select of multiple items to be written to the pipeline. - /// - Multiple - } -} + /// + /// None is the default, and it means OK and Cancel will not be present + /// and no objects will be written to the pipeline. + /// The selectionMode of the actual list will still be multiple. + /// + None, + + /// + /// Allow selection of one single item to be written to the pipeline. + /// + Single, + + /// + /// Allow select of multiple items to be written to the pipeline. + /// + Multiple +} \ No newline at end of file diff --git a/src/Microsoft.PowerShell.OutGridView.Models/Serializers.cs b/src/Microsoft.PowerShell.OutGridView.Models/Serializers.cs index 6165c23..f5f8a53 100644 --- a/src/Microsoft.PowerShell.OutGridView.Models/Serializers.cs +++ b/src/Microsoft.PowerShell.OutGridView.Models/Serializers.cs @@ -1,32 +1,33 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -using Newtonsoft.Json; using System; using System.Text; -using System.Collections.Generic; -//TODO: swich to JSON.NET +using Newtonsoft.Json; + +// TODO: switch to JSON.NET +// BUGBUG: This appears to be unused code. Consider removing it. -namespace OutGridView.Models +namespace Microsoft.PowerShell.OutGridView.Models { public class Serializers { - private readonly static JsonSerializerSettings jsonSerializerSettings = new JsonSerializerSettings() + private static readonly JsonSerializerSettings JSON_SERIALIZER_SETTINGS = new JsonSerializerSettings() { TypeNameHandling = TypeNameHandling.All }; public static string ObjectToJson(T obj) { - var jsonString = JsonConvert.SerializeObject(obj, jsonSerializerSettings); + var jsonString = JsonConvert.SerializeObject(obj, JSON_SERIALIZER_SETTINGS); return ToBase64String(jsonString); } - public static T ObjectFromJson(string base64Json) + public static T? ObjectFromJson(string base64Json) { var jsonString = FromBase64String(base64Json); - return JsonConvert.DeserializeObject(jsonString, jsonSerializerSettings); + return JsonConvert.DeserializeObject(jsonString, JSON_SERIALIZER_SETTINGS); } diff --git a/test/Microsoft.PowerShell.ConsoleGuiTools.Tests.ps1 b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests.ps1 new file mode 100644 index 0000000..e334055 --- /dev/null +++ b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests.ps1 @@ -0,0 +1,101 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. + +Describe 'Microsoft.PowerShell.ConsoleGuiTools Module' { + + BeforeAll { + $modulePath = Join-Path $PSScriptRoot '..' 'module' 'Microsoft.PowerShell.ConsoleGuiTools.psd1' + if (-not (Test-Path $modulePath)) { + $modulePath = Join-Path $PSScriptRoot '..' 'src' 'Microsoft.PowerShell.ConsoleGuiTools' 'publish' 'Microsoft.PowerShell.ConsoleGuiTools.psd1' + } + if (Test-Path $modulePath) { + Import-Module $modulePath -Force -ErrorAction Stop + } else { + throw "Module not found. Build the project first with 'Invoke-Build Build'." + } + } + + Context 'Module loads correctly' { + It 'Should import without errors' { + $module = Get-Module -Name Microsoft.PowerShell.ConsoleGuiTools + $module | Should -Not -BeNullOrEmpty + } + + It 'Should export Out-ConsoleGridView command' { + $cmd = Get-Command -Name Out-ConsoleGridView -Module Microsoft.PowerShell.ConsoleGuiTools -ErrorAction SilentlyContinue + $cmd | Should -Not -BeNullOrEmpty + } + + It 'Should export Show-ObjectTree command' { + $cmd = Get-Command -Name Show-ObjectTree -Module Microsoft.PowerShell.ConsoleGuiTools -ErrorAction SilentlyContinue + $cmd | Should -Not -BeNullOrEmpty + } + } + + Context 'Aliases' { + It 'Should register ocgv alias for Out-ConsoleGridView' { + $alias = Get-Alias -Name ocgv -ErrorAction SilentlyContinue + $alias | Should -Not -BeNullOrEmpty + $alias.Definition | Should -Be 'Out-ConsoleGridView' + } + + It 'Should register shot alias for Show-ObjectTree' { + $alias = Get-Alias -Name shot -ErrorAction SilentlyContinue + $alias | Should -Not -BeNullOrEmpty + $alias.Definition | Should -Be 'Show-ObjectTree' + } + } + + Context 'Out-ConsoleGridView parameters' { + It 'Should have InputObject parameter' { + $cmd = Get-Command Out-ConsoleGridView + $cmd.Parameters.Keys | Should -Contain 'InputObject' + } + + It 'Should have Title parameter' { + $cmd = Get-Command Out-ConsoleGridView + $cmd.Parameters.Keys | Should -Contain 'Title' + } + + It 'Should have OutputMode parameter' { + $cmd = Get-Command Out-ConsoleGridView + $cmd.Parameters.Keys | Should -Contain 'OutputMode' + } + + It 'Should have Filter parameter' { + $cmd = Get-Command Out-ConsoleGridView + $cmd.Parameters.Keys | Should -Contain 'Filter' + } + + It 'Should have MinUI parameter' { + $cmd = Get-Command Out-ConsoleGridView + $cmd.Parameters.Keys | Should -Contain 'MinUI' + } + } + + Context 'Show-ObjectTree parameters' { + It 'Should have InputObject parameter' { + $cmd = Get-Command Show-ObjectTree + $cmd.Parameters.Keys | Should -Contain 'InputObject' + } + + It 'Should have Title parameter' { + $cmd = Get-Command Show-ObjectTree + $cmd.Parameters.Keys | Should -Contain 'Title' + } + + It 'Should have Filter parameter' { + $cmd = Get-Command Show-ObjectTree + $cmd.Parameters.Keys | Should -Contain 'Filter' + } + + It 'Should have MinUI parameter' { + $cmd = Get-Command Show-ObjectTree + $cmd.Parameters.Keys | Should -Contain 'MinUI' + } + } + + AfterAll { + Remove-Module -Name Microsoft.PowerShell.ConsoleGuiTools -Force -ErrorAction SilentlyContinue + } +} diff --git a/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/DataTableColumnTests.cs b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/DataTableColumnTests.cs new file mode 100644 index 0000000..381f11c --- /dev/null +++ b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/DataTableColumnTests.cs @@ -0,0 +1,160 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Globalization; +using Microsoft.PowerShell.OutGridView.Models; +using Xunit; + +namespace Microsoft.PowerShell.ConsoleGuiTools.Tests; + +public class DataTableColumnTests +{ + [Fact] + public void FormatValue_NullValue_ReturnsEmptyString() + { + var column = new DataTableColumn("Test", "$_.Test"); + Assert.Equal(string.Empty, column.FormatValue(null)); + } + + [Fact] + public void FormatValue_WithFormatString_UsesFormatString() + { + var column = new DataTableColumn("Test", "$_.Test") { FormatString = "N2" }; + var result = column.FormatValue(123.456m); + // Should format as decimal with 2 decimal places + Assert.Contains("123", result); + } + + [Fact] + public void FormatValue_NullFormatString_UsesToString() + { + // When FormatString is explicitly null, use plain ToString (no default formatting) + var column = new DataTableColumn("Id", "$_.Id") { FormatString = null }; + var result = column.FormatValue(1234); + // Should NOT have thousands separator — plain ToString + Assert.Equal("1234", result); + } + + [Fact] + public void FormatValue_EmptyFormatString_UsesDefaultTypeFormatting() + { + // When FormatString is empty string (not null), use type-based defaults + var column = new DataTableColumn("Size", "$_.Size") { FormatString = "" }; + var result = column.FormatValue(1234); + // int with empty FormatString should use N0 formatting (thousands separator) + var expected = 1234.ToString("N0", CultureInfo.CurrentCulture); + Assert.Equal(expected, result); + } + + [Fact] + public void FormatValue_DateTime_WithEmptyFormatString_UsesGeneralFormat() + { + var column = new DataTableColumn("Date", "$_.Date") { FormatString = "" }; + var dt = new DateTime(2024, 6, 15, 14, 30, 0); + var result = column.FormatValue(dt); + var expected = dt.ToString("G", CultureInfo.CurrentCulture); + Assert.Equal(expected, result); + } + + [Fact] + public void FormatValue_Decimal_WithEmptyFormatString_UsesN0() + { + var column = new DataTableColumn("Amount", "$_.Amount") { FormatString = "" }; + var result = column.FormatValue(1234567.89m); + var expected = 1234567.89m.ToString("N0", CultureInfo.CurrentCulture); + Assert.Equal(expected, result); + } + + [Fact] + public void FormatValue_Double_WithEmptyFormatString_UsesN2() + { + var column = new DataTableColumn("Value", "$_.Value") { FormatString = "" }; + var result = column.FormatValue(3.14159); + var expected = 3.14159.ToString("N2", CultureInfo.CurrentCulture); + Assert.Equal(expected, result); + } + + [Fact] + public void FormatValue_String_ReturnsStringValue() + { + var column = new DataTableColumn("Name", "$_.Name"); + Assert.Equal("hello", column.FormatValue("hello")); + } + + [Fact] + public void FormatValue_InvalidFormatString_FallsThrough() + { + var column = new DataTableColumn("Test", "$_.Test") { FormatString = "ZZZZ_INVALID" }; + // An invalid format string should not throw — it should fall through + var result = column.FormatValue(42); + Assert.NotNull(result); + } + + [Fact] + public void Equals_SameLabelAndAccessor_ReturnsTrue() + { + var a = new DataTableColumn("Name", "$_.Name"); + var b = new DataTableColumn("Name", "$_.Name"); + Assert.True(a.Equals(b)); + } + + [Fact] + public void Equals_DifferentLabel_ReturnsFalse() + { + var a = new DataTableColumn("Name", "$_.Name"); + var b = new DataTableColumn("Id", "$_.Name"); + Assert.False(a.Equals(b)); + } + + [Fact] + public void Equals_DifferentAccessor_ReturnsFalse() + { + var a = new DataTableColumn("Name", "$_.Name"); + var b = new DataTableColumn("Name", "$_.Id"); + Assert.False(a.Equals(b)); + } + + [Fact] + public void Equals_Null_ReturnsFalse() + { + var a = new DataTableColumn("Name", "$_.Name"); + Assert.False(a.Equals(null)); + } + + [Fact] + public void GetHashCode_EqualColumns_SameHashCode() + { + var a = new DataTableColumn("Name", "$_.Name"); + var b = new DataTableColumn("Name", "$_.Name"); + Assert.Equal(a.GetHashCode(), b.GetHashCode()); + } + + [Fact] + public void ToString_ReturnsBase64EncodedString() + { + var column = new DataTableColumn("Name", "$_.Name"); + var result = column.ToString(); + // Should decode to "Name" + "$_.Name" + var decoded = System.Text.Encoding.UTF8.GetString(Convert.FromBase64String(result)); + Assert.Equal("Name$_.Name", decoded); + } + + [Fact] + public void Type_ValidStringType_ReturnsCorrectType() + { + var column = new DataTableColumn("Test", "$_.Test") + { + StringType = typeof(decimal).FullName + }; + Assert.Equal(typeof(decimal), column.Type); + } + + [Fact] + public void Type_NullStringType_ThrowsOnAccess() + { + var column = new DataTableColumn("Test", "$_.Test"); + // StringType is null by default; Type.GetType(null) throws ArgumentNullException + Assert.Throws(() => column.Type); + } +} diff --git a/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/DataTableRowTests.cs b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/DataTableRowTests.cs new file mode 100644 index 0000000..12d975f --- /dev/null +++ b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/DataTableRowTests.cs @@ -0,0 +1,130 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Collections.Generic; +using Microsoft.PowerShell.OutGridView.Models; +using Xunit; + +namespace Microsoft.PowerShell.ConsoleGuiTools.Tests; + +public class DataTableRowTests +{ + [Fact] + public void DecimalValue_CompareTo_LessThan() + { + var a = new DecimalValue { DisplayValue = "1", SortValue = 1m }; + var b = new DecimalValue { DisplayValue = "2", SortValue = 2m }; + Assert.True(a.CompareTo(b) < 0); + } + + [Fact] + public void DecimalValue_CompareTo_GreaterThan() + { + var a = new DecimalValue { DisplayValue = "2", SortValue = 2m }; + var b = new DecimalValue { DisplayValue = "1", SortValue = 1m }; + Assert.True(a.CompareTo(b) > 0); + } + + [Fact] + public void DecimalValue_CompareTo_Equal() + { + var a = new DecimalValue { DisplayValue = "1", SortValue = 1m }; + var b = new DecimalValue { DisplayValue = "1", SortValue = 1m }; + Assert.Equal(0, a.CompareTo(b)); + } + + [Fact] + public void DecimalValue_CompareTo_NonDecimalValue_Returns1() + { + var a = new DecimalValue { DisplayValue = "1", SortValue = 1m }; + Assert.Equal(1, a.CompareTo("not a decimal value")); + } + + [Fact] + public void DecimalValue_CompareTo_Null_Returns1() + { + var a = new DecimalValue { DisplayValue = "1", SortValue = 1m }; + Assert.Equal(1, a.CompareTo(null)); + } + + [Fact] + public void DecimalValue_OriginalValue_ReturnsSortValue() + { + var v = new DecimalValue { DisplayValue = "42", SortValue = 42m }; + Assert.Equal(42m, v.OriginalValue); + } + + [Fact] + public void StringValue_CompareTo_LessThan() + { + var a = new StringValue { DisplayValue = "apple" }; + var b = new StringValue { DisplayValue = "banana" }; + Assert.True(a.CompareTo(b) < 0); + } + + [Fact] + public void StringValue_CompareTo_GreaterThan() + { + var a = new StringValue { DisplayValue = "banana" }; + var b = new StringValue { DisplayValue = "apple" }; + Assert.True(a.CompareTo(b) > 0); + } + + [Fact] + public void StringValue_CompareTo_Equal() + { + var a = new StringValue { DisplayValue = "same" }; + var b = new StringValue { DisplayValue = "same" }; + Assert.Equal(0, a.CompareTo(b)); + } + + [Fact] + public void StringValue_CompareTo_NonStringValue_Returns1() + { + var a = new StringValue { DisplayValue = "test" }; + Assert.Equal(1, a.CompareTo(42)); + } + + [Fact] + public void StringValue_OriginalValue_WithRawValue_ReturnsRawValue() + { + var raw = new object(); + var v = new StringValue { DisplayValue = "display", RawValue = raw }; + Assert.Same(raw, v.OriginalValue); + } + + [Fact] + public void StringValue_OriginalValue_WithoutRawValue_ReturnsDisplayValue() + { + var v = new StringValue { DisplayValue = "display" }; + Assert.Equal("display", v.OriginalValue); + } + + [Fact] + public void DataTableRow_Constructor_SetsProperties() + { + var values = new Dictionary + { + ["col1"] = new StringValue { DisplayValue = "value1" } + }; + var row = new DataTableRow(values, 5); + + Assert.Same(values, row.Values); + Assert.Equal(5, row.OriginalObjectIndex); + } + + [Fact] + public void DataTable_Constructor_SetsProperties() + { + var columns = new List + { + new DataTableColumn("Name", "$_.Name") + }; + var rows = new List(); + var table = new DataTable(columns, rows); + + Assert.Same(columns, table.DataColumns); + Assert.Same(rows, table.Data); + } +} diff --git a/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/Microsoft.PowerShell.ConsoleGuiTools.Tests.csproj b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/Microsoft.PowerShell.ConsoleGuiTools.Tests.csproj new file mode 100644 index 0000000..64613f3 --- /dev/null +++ b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/Microsoft.PowerShell.ConsoleGuiTools.Tests.csproj @@ -0,0 +1,22 @@ + + + + net10.0 + preview + enable + false + true + + + + + + + + + + + + + + diff --git a/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/OutGridViewDataSourceTests.cs b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/OutGridViewDataSourceTests.cs new file mode 100644 index 0000000..1a76d57 --- /dev/null +++ b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/OutGridViewDataSourceTests.cs @@ -0,0 +1,374 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.PowerShell.OutGridView.Models; +using Xunit; + +namespace Microsoft.PowerShell.ConsoleGuiTools.Tests; + +/// +/// Unit tests for covering filtering, sorting, +/// thread-safe row addition, and index tracking. +/// +public class OutGridViewDataSourceTests +{ + #region Helpers + + private static List CreateColumns(params string[] names) + { + var columns = new List(); + foreach (var name in names) + columns.Add(new DataTableColumn(name, name)); + return columns; + } + + private static DataTableRow CreateRow(List columns, int originalIndex, params string[] values) + { + var dict = new Dictionary(); + for (int i = 0; i < columns.Count && i < values.Length; i++) + dict[columns[i].ToString()] = new StringValue { DisplayValue = values[i] }; + return new DataTableRow(dict, originalIndex); + } + + private static OutGridViewDataSource CreateTestDataSource() + { + var columns = CreateColumns("Name", "Id"); + var ds = new OutGridViewDataSource(columns); + ds.AddRow(CreateRow(columns, 0, "Charlie", "3")); + ds.AddRow(CreateRow(columns, 1, "Alice", "1")); + ds.AddRow(CreateRow(columns, 2, "Bob", "2")); + return ds; + } + + #endregion + + #region Construction and Basic Properties + + [Fact] + public void Constructor_EmptyDataSource_HasZeroRows() + { + var columns = CreateColumns("Name", "Id"); + var ds = new OutGridViewDataSource(columns); + + Assert.Equal(0, ds.Rows); + Assert.Equal(2, ds.Columns); + } + + [Fact] + public void Constructor_WithRows_HasCorrectRowCount() + { + var columns = CreateColumns("Name"); + var rows = new List + { + CreateRow(columns, 0, "A"), + CreateRow(columns, 1, "B") + }; + var ds = new OutGridViewDataSource(columns, rows); + + Assert.Equal(2, ds.Rows); + } + + [Fact] + public void ColumnNames_ReturnsLabels() + { + var columns = CreateColumns("Name", "Id", "Status"); + var ds = new OutGridViewDataSource(columns); + + Assert.Equal(new[] { "Name", "Id", "Status" }, ds.ColumnNames); + } + + [Fact] + public void Indexer_ReturnsCorrectCellValue() + { + var ds = CreateTestDataSource(); + + Assert.Equal("Charlie", ds[0, 0]); + Assert.Equal("3", ds[0, 1]); + Assert.Equal("Alice", ds[1, 0]); + Assert.Equal("1", ds[1, 1]); + } + + [Fact] + public void Indexer_OutOfBounds_ReturnsEmptyString() + { + var ds = CreateTestDataSource(); + + Assert.Equal(string.Empty, ds[-1, 0]); + Assert.Equal(string.Empty, ds[99, 0]); + Assert.Equal(string.Empty, ds[0, -1]); + Assert.Equal(string.Empty, ds[0, 99]); + } + + #endregion + + #region AddRow + + [Fact] + public void AddRow_IncreasesRowCount() + { + var columns = CreateColumns("Name"); + var ds = new OutGridViewDataSource(columns); + + ds.AddRow(CreateRow(columns, 0, "First")); + Assert.Equal(1, ds.Rows); + + ds.AddRow(CreateRow(columns, 1, "Second")); + Assert.Equal(2, ds.Rows); + } + + [Fact] + public async Task AddRow_ThreadSafe_ConcurrentAdds() + { + var columns = CreateColumns("Name"); + var ds = new OutGridViewDataSource(columns); + const int threadCount = 10; + const int rowsPerThread = 100; + + var barrier = new Barrier(threadCount); + var tasks = new Task[threadCount]; + + for (int t = 0; t < threadCount; t++) + { + int threadId = t; + tasks[t] = Task.Run(() => + { + barrier.SignalAndWait(); + for (int i = 0; i < rowsPerThread; i++) + ds.AddRow(CreateRow(columns, threadId * rowsPerThread + i, $"Row_{threadId}_{i}")); + }); + } + + await Task.WhenAll(tasks); + Assert.Equal(threadCount * rowsPerThread, ds.Rows); + } + + #endregion + + #region GetOriginalObjectIndex + + [Fact] + public void GetOriginalObjectIndex_ReturnsCorrectIndex() + { + var ds = CreateTestDataSource(); + + Assert.Equal(0, ds.GetOriginalObjectIndex(0)); + Assert.Equal(1, ds.GetOriginalObjectIndex(1)); + Assert.Equal(2, ds.GetOriginalObjectIndex(2)); + } + + [Fact] + public void GetOriginalObjectIndex_OutOfBounds_ReturnsNegativeOne() + { + var ds = CreateTestDataSource(); + + Assert.Equal(-1, ds.GetOriginalObjectIndex(-1)); + Assert.Equal(-1, ds.GetOriginalObjectIndex(99)); + } + + #endregion + + #region Filter + + [Fact] + public void Filter_EmptyPattern_ReturnsSelf() + { + var ds = CreateTestDataSource(); + + var filtered = ds.Filter(""); + Assert.Same(ds, filtered); + } + + [Fact] + public void Filter_NullPattern_ReturnsSelf() + { + var ds = CreateTestDataSource(); + + var filtered = ds.Filter(null!); + Assert.Same(ds, filtered); + } + + [Fact] + public void Filter_MatchesSubstring_ReturnsMatchingRows() + { + var ds = CreateTestDataSource(); + + var filtered = ds.Filter("Ali"); + Assert.Equal(1, filtered.Rows); + Assert.Equal("Alice", filtered[0, 0]); + } + + [Fact] + public void Filter_CaseInsensitive() + { + var ds = CreateTestDataSource(); + + var filtered = ds.Filter("alice"); + Assert.Equal(1, filtered.Rows); + Assert.Equal("Alice", filtered[0, 0]); + } + + [Fact] + public void Filter_Regex_MatchesPattern() + { + var ds = CreateTestDataSource(); + + var filtered = ds.Filter("^[AB]"); + Assert.Equal(2, filtered.Rows); + } + + [Fact] + public void Filter_NoMatch_ReturnsEmpty() + { + var ds = CreateTestDataSource(); + + var filtered = ds.Filter("ZZZ"); + Assert.Equal(0, filtered.Rows); + } + + [Fact] + public void Filter_MatchesAnyColumn() + { + var ds = CreateTestDataSource(); + + // "3" is in the Id column of Charlie's row + var filtered = ds.Filter("^3$"); + Assert.Equal(1, filtered.Rows); + Assert.Equal("Charlie", filtered[0, 0]); + } + + [Fact] + public void Filter_PreservesOriginalObjectIndex() + { + var ds = CreateTestDataSource(); + + var filtered = ds.Filter("Bob"); + Assert.Equal(1, filtered.Rows); + Assert.Equal(2, filtered.GetOriginalObjectIndex(0)); // Bob was at index 2 + } + + [Fact] + public void Filter_InvalidRegex_ThrowsRegexParseException() + { + var ds = CreateTestDataSource(); + + Assert.ThrowsAny(() => ds.Filter("[invalid")); + } + + #endregion + + #region Sort + + [Fact] + public void Sort_Ascending_ByName() + { + var ds = CreateTestDataSource(); // Charlie, Alice, Bob + + var sorted = ds.Sort(0, descending: false); + + Assert.Equal("Alice", sorted[0, 0]); + Assert.Equal("Bob", sorted[1, 0]); + Assert.Equal("Charlie", sorted[2, 0]); + } + + [Fact] + public void Sort_Descending_ByName() + { + var ds = CreateTestDataSource(); + + var sorted = ds.Sort(0, descending: true); + + Assert.Equal("Charlie", sorted[0, 0]); + Assert.Equal("Bob", sorted[1, 0]); + Assert.Equal("Alice", sorted[2, 0]); + } + + [Fact] + public void Sort_NumericAware_ById() + { + var columns = CreateColumns("Name", "Id"); + var ds = new OutGridViewDataSource(columns); + ds.AddRow(CreateRow(columns, 0, "A", "10")); + ds.AddRow(CreateRow(columns, 1, "B", "2")); + ds.AddRow(CreateRow(columns, 2, "C", "1")); + + var sorted = ds.Sort(1, descending: false); + + // Numeric sort: 1, 2, 10 (not lexicographic: 1, 10, 2) + Assert.Equal("1", sorted[0, 1]); + Assert.Equal("2", sorted[1, 1]); + Assert.Equal("10", sorted[2, 1]); + } + + [Fact] + public void Sort_PreservesOriginalObjectIndex() + { + var ds = CreateTestDataSource(); // Charlie(0), Alice(1), Bob(2) + + var sorted = ds.Sort(0, descending: false); // Alice, Bob, Charlie + + Assert.Equal(1, sorted.GetOriginalObjectIndex(0)); // Alice was index 1 + Assert.Equal(2, sorted.GetOriginalObjectIndex(1)); // Bob was index 2 + Assert.Equal(0, sorted.GetOriginalObjectIndex(2)); // Charlie was index 0 + } + + [Fact] + public void Sort_AddsAscendingGlyph() + { + var ds = CreateTestDataSource(); + + var sorted = ds.Sort(0, descending: false); + + Assert.Equal("Name ▲", sorted.ColumnNames[0]); + Assert.Equal("Id", sorted.ColumnNames[1]); // Other columns unchanged + } + + [Fact] + public void Sort_AddsDescendingGlyph() + { + var ds = CreateTestDataSource(); + + var sorted = ds.Sort(0, descending: true); + + Assert.Equal("Name ▼", sorted.ColumnNames[0]); + } + + [Fact] + public void Sort_InvalidColumnIndex_ReturnsSelf() + { + var ds = CreateTestDataSource(); + + Assert.Same(ds, ds.Sort(-1, false)); + Assert.Same(ds, ds.Sort(99, false)); + } + + [Fact] + public void Sort_DoesNotMutateOriginal() + { + var ds = CreateTestDataSource(); + + var sorted = ds.Sort(0, descending: false); + + // Original still has Charlie first + Assert.Equal("Charlie", ds[0, 0]); + // Sorted has Alice first + Assert.Equal("Alice", sorted[0, 0]); + } + + #endregion + + #region GetColumns + + [Fact] + public void GetColumns_ReturnsSameColumnList() + { + var columns = CreateColumns("A", "B"); + var ds = new OutGridViewDataSource(columns); + + Assert.Same(columns, ds.GetColumns()); + } + + #endregion +} diff --git a/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/OutGridViewWindowIntegrationTests.cs b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/OutGridViewWindowIntegrationTests.cs new file mode 100644 index 0000000..aedbf38 --- /dev/null +++ b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/OutGridViewWindowIntegrationTests.cs @@ -0,0 +1,240 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Collections.Generic; +using System.Linq; +using System.Management.Automation; +using Microsoft.PowerShell.OutGridView.Models; +using Terminal.Gui.App; +using Terminal.Gui.Input; +using Terminal.Gui.Time; +using Xunit; + +namespace Microsoft.PowerShell.ConsoleGuiTools.Tests; + +/// +/// Integration tests for OutGridViewWindow that exercise the full Terminal.Gui lifecycle +/// using the headless ANSI driver and VirtualTimeProvider. +/// +public class OutGridViewWindowIntegrationTests +{ + #region Helpers + + private static PSObject CreatePSObject(string name, int id) + { + var obj = new PSObject(); + obj.Properties.Add(new PSNoteProperty("Name", name)); + obj.Properties.Add(new PSNoteProperty("Id", id)); + return obj; + } + + private static ApplicationData CreateApplicationData( + OutputModeOption outputMode = OutputModeOption.Multiple, + bool minUI = false, + string? filter = null) + { + var psObjects = new List + { + CreatePSObject("Process1", 1), + CreatePSObject("Process2", 2), + CreatePSObject("Process3", 3) + }; + + return new ApplicationData + { + PSObjects = psObjects, + Title = "Test Grid", + OutputMode = outputMode, + Filter = filter, + MinUI = minUI, + Driver = null + }; + } + + /// + /// Sets up Terminal.Gui in headless mode, creates and begins the window, + /// invokes the test action, then tears down. + /// + private static void RunWithWindow( + ApplicationData appData, + Action testAction) + { + Terminal.Gui.Configuration.ConfigurationManager.Enable( + Terminal.Gui.Configuration.ConfigLocations.All); + + // Build data source from PSObjects in appData + var typeGetter = new TypeGetter(); + var psObjects = appData.PSObjects.Cast().ToList(); + var columns = typeGetter.GetDataColumnsForObject(psObjects[0]); + var dataSource = new OutGridViewDataSource(columns); + for (int i = 0; i < psObjects.Count; i++) + { + dataSource.AddRow(TypeGetter.CastObjectToDataTableRow(psObjects[i], columns, i)); + } + + using OutGridViewWindow window = new(appData, dataSource); + using IApplication app = Application.Create(new VirtualTimeProvider()) + .Init(driverName: "ansi"); + + SessionToken? token = app.Begin(window); + app.LayoutAndDraw(forceRedraw: true); + + try + { + testAction(app, window); + } + finally + { + if (token is not null) + { + app.End(token); + } + } + } + + #endregion + + #region ESC / Close Tests + + [Fact] + public void Esc_ClosesWindow_ResultIsNull() + { + var appData = CreateApplicationData(); + + RunWithWindow(appData, (app, window) => + { + // Verify data is rendered + string screen = app.Driver!.ToString(); + Assert.Contains("Process1", screen); + Assert.Contains("Process2", screen); + Assert.Contains("Process3", screen); + + // Simulate ESC + app.Keyboard.RaiseKeyDownEvent(Key.Esc); + + // ESC triggers Close() which sets Result = null + Assert.Null(window.Result); + }); + } + + #endregion + + #region Accept / Selection Tests + + [Fact] + public void Enter_WithMarkedItems_ReturnsSelectedIndexes() + { + var appData = CreateApplicationData(outputMode: OutputModeOption.Multiple); + + RunWithWindow(appData, (app, window) => + { + // Mark first item + app.Keyboard.RaiseKeyDownEvent(Key.Space); + app.LayoutAndDraw(); + + // Move down and mark second item + app.Keyboard.RaiseKeyDownEvent(Key.CursorDown); + app.LayoutAndDraw(); + app.Keyboard.RaiseKeyDownEvent(Key.Space); + app.LayoutAndDraw(); + + // Accept + app.Keyboard.RaiseKeyDownEvent(Key.Enter); + + Assert.NotNull(window.Result); + var result = (HashSet)window.Result; + Assert.Contains(0, result); + Assert.Contains(1, result); + Assert.DoesNotContain(2, result); + }); + } + + [Fact] + public void Enter_WithNoMarkedItems_ReturnsCurrentRow() + { + var appData = CreateApplicationData(outputMode: OutputModeOption.Multiple); + + RunWithWindow(appData, (app, window) => + { + // With no explicitly marked items, Enter returns the currently-focused row + app.Keyboard.RaiseKeyDownEvent(Key.Enter); + + Assert.NotNull(window.Result); + var result = (HashSet)window.Result; + Assert.Single(result); + Assert.Contains(0, result); + }); + } + + #endregion + + #region Rendering Tests + + [Fact] + public void Render_ShowsColumnHeadersAndData() + { + var appData = CreateApplicationData(); + + RunWithWindow(appData, (app, window) => + { + string screen = app.Driver!.ToString(); + + Assert.Contains("Name", screen); + Assert.Contains("Id", screen); + Assert.Contains("Process1", screen); + Assert.Contains("Process2", screen); + Assert.Contains("Process3", screen); + + app.Keyboard.RaiseKeyDownEvent(Key.Esc); + }); + } + + [Fact] + public void Render_WithFilter_ShowsOnlyMatchingRows() + { + var appData = CreateApplicationData(filter: "Process1"); + + RunWithWindow(appData, (app, window) => + { + string screen = app.Driver!.ToString(); + Assert.Contains("Process1", screen); + + app.Keyboard.RaiseKeyDownEvent(Key.Esc); + }); + } + + [Fact] + public void Render_MinUI_DoesNotShowFilterLabel() + { + var appData = CreateApplicationData(minUI: true); + + RunWithWindow(appData, (app, window) => + { + string screen = app.Driver!.ToString(); + + Assert.Contains("Process1", screen); + Assert.DoesNotContain("Filter:", screen); + + app.Keyboard.RaiseKeyDownEvent(Key.Esc); + }); + } + + #endregion + + #region OutputMode Tests + + [Fact] + public void OutputModeNone_EscClosesWithNullResult() + { + var appData = CreateApplicationData(outputMode: OutputModeOption.None); + + RunWithWindow(appData, (app, window) => + { + app.Keyboard.RaiseKeyDownEvent(Key.Esc); + Assert.Null(window.Result); + }); + } + + #endregion +} diff --git a/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/SerializersTests.cs b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/SerializersTests.cs new file mode 100644 index 0000000..c192307 --- /dev/null +++ b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/SerializersTests.cs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using Microsoft.PowerShell.OutGridView.Models; +using Xunit; + +namespace Microsoft.PowerShell.ConsoleGuiTools.Tests; + +public class SerializersTests +{ + [Fact] + public void RoundTrip_String() + { + var original = "Hello, World!"; + var json = Serializers.ObjectToJson(original); + var result = Serializers.ObjectFromJson(json); + Assert.Equal(original, result); + } + + [Fact] + public void RoundTrip_Integer() + { + var original = 42; + var json = Serializers.ObjectToJson(original); + var result = Serializers.ObjectFromJson(json); + Assert.Equal(original, result); + } + + [Fact] + public void RoundTrip_ComplexObject() + { + var original = new ApplicationData + { + Title = "Test", + OutputMode = OutputModeOption.Multiple, + Filter = "*.txt", + MinUI = true + }; + var json = Serializers.ObjectToJson(original); + var result = Serializers.ObjectFromJson(json); + + Assert.NotNull(result); + Assert.Equal("Test", result.Title); + Assert.Equal(OutputModeOption.Multiple, result.OutputMode); + Assert.Equal("*.txt", result.Filter); + Assert.True(result.MinUI); + } + + [Fact] + public void ObjectToJson_ReturnsBase64EncodedString() + { + var json = Serializers.ObjectToJson("test"); + // Should be valid base64 + var bytes = System.Convert.FromBase64String(json); + Assert.NotEmpty(bytes); + } + + [Fact] + public void RoundTrip_Null() + { + var json = Serializers.ObjectToJson(null); + var result = Serializers.ObjectFromJson(json); + Assert.Null(result); + } +} diff --git a/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/TypeGetterTests.cs b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/TypeGetterTests.cs new file mode 100644 index 0000000..6e9f5b3 --- /dev/null +++ b/test/Microsoft.PowerShell.ConsoleGuiTools.Tests/TypeGetterTests.cs @@ -0,0 +1,234 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System.Collections.Generic; +using System.Management.Automation; +using Microsoft.PowerShell.OutGridView.Models; +using Xunit; + +namespace Microsoft.PowerShell.ConsoleGuiTools.Tests; + +public class TypeGetterTests +{ + [Fact] + public void CastObjectsToTableView_EmptyList_ReturnsEmptyTable() + { + var result = TypeGetter.CastObjectsToTableView([]); + + Assert.Empty(result.DataColumns); + Assert.Empty(result.Data); + } + + [Fact] + public void CastObjectsToTableView_PrimitiveStrings_SingleColumn() + { + var objects = new List + { + new PSObject("hello"), + new PSObject("world") + }; + + var result = TypeGetter.CastObjectsToTableView(objects); + + Assert.Single(result.DataColumns); + Assert.Equal("String", result.DataColumns[0].Label); + Assert.Equal(2, result.Data.Count); + } + + [Fact] + public void CastObjectsToTableView_IntegersAsProperties_CreatesDecimalColumn() + { + var obj1 = new PSObject(); + obj1.Properties.Add(new PSNoteProperty("Id", 42)); + var obj2 = new PSObject(); + obj2.Properties.Add(new PSNoteProperty("Id", 99)); + + var result = TypeGetter.CastObjectsToTableView(new List { obj1, obj2 }); + + Assert.Single(result.DataColumns); + Assert.Equal("Id", result.DataColumns[0].Label); + Assert.Equal(2, result.Data.Count); + // All values numeric, so column type should be decimal + Assert.Equal(typeof(decimal).FullName, result.DataColumns[0].StringType); + } + + [Fact] + public void CastObjectsToTableView_ObjectWithProperties_CreatesColumns() + { + var obj = new PSObject(); + obj.Properties.Add(new PSNoteProperty("Name", "Test")); + obj.Properties.Add(new PSNoteProperty("Value", 42)); + + var result = TypeGetter.CastObjectsToTableView(new List { obj }); + + Assert.Equal(2, result.DataColumns.Count); + Assert.Contains(result.DataColumns, c => c.Label == "Name"); + Assert.Contains(result.DataColumns, c => c.Label == "Value"); + Assert.Single(result.Data); + } + + [Fact] + public void CastObjectToDataTableRow_SimpleProperty_ExtractsValue() + { + var obj = new PSObject(); + obj.Properties.Add(new PSNoteProperty("Name", "TestValue")); + + var columns = new List + { + new DataTableColumn("Name", "$_.\"Name\"") + }; + + var row = TypeGetter.CastObjectToDataTableRow(obj, columns, 0); + + Assert.Equal(0, row.OriginalObjectIndex); + var columnKey = columns[0].ToString(); + Assert.True(row.Values.ContainsKey(columnKey)); + Assert.Equal("TestValue", row.Values[columnKey].DisplayValue); + } + + [Fact] + public void CastObjectToDataTableRow_NumericProperty_CreatesDecimalValue() + { + var obj = new PSObject(); + obj.Properties.Add(new PSNoteProperty("Count", 42)); + + var columns = new List + { + new DataTableColumn("Count", "$_.\"Count\"") + }; + + var row = TypeGetter.CastObjectToDataTableRow(obj, columns, 0); + + var columnKey = columns[0].ToString(); + Assert.IsType(row.Values[columnKey]); + Assert.Equal(42m, ((DecimalValue)row.Values[columnKey]).SortValue); + } + + [Fact] + public void CastObjectToDataTableRow_StringProperty_CreatesStringValue() + { + var obj = new PSObject(); + obj.Properties.Add(new PSNoteProperty("Name", "hello")); + + var columns = new List + { + new DataTableColumn("Name", "$_.\"Name\"") + }; + + var row = TypeGetter.CastObjectToDataTableRow(obj, columns, 0); + + var columnKey = columns[0].ToString(); + Assert.IsType(row.Values[columnKey]); + } + + [Fact] + public void CastObjectToDataTableRow_NullProperty_ReturnsEmptyDisplayValue() + { + var obj = new PSObject(); + obj.Properties.Add(new PSNoteProperty("Name", null)); + + var columns = new List + { + new DataTableColumn("Name", "$_.\"Name\"") + }; + + var row = TypeGetter.CastObjectToDataTableRow(obj, columns, 0); + + var columnKey = columns[0].ToString(); + Assert.Equal(string.Empty, row.Values[columnKey].DisplayValue); + } + + [Fact] + public void CastObjectToDataTableRow_MissingProperty_ReturnsEmptyDisplayValue() + { + var obj = new PSObject(); + obj.Properties.Add(new PSNoteProperty("Other", "value")); + + var columns = new List + { + new DataTableColumn("Missing", "$_.\"Missing\"") + }; + + var row = TypeGetter.CastObjectToDataTableRow(obj, columns, 0); + + var columnKey = columns[0].ToString(); + Assert.Equal(string.Empty, row.Values[columnKey].DisplayValue); + } + + [Fact] + public void CastObjectToDataTableRow_PrimitiveAccessor_ExtractsWholeObject() + { + var obj = new PSObject("hello world"); + + var columns = new List + { + new DataTableColumn("String", "$_") + }; + + var row = TypeGetter.CastObjectToDataTableRow(obj, columns, 0); + + var columnKey = columns[0].ToString(); + Assert.Equal("hello world", row.Values[columnKey].DisplayValue); + } + + [Fact] + public void CastObjectToDataTableRow_AnsiCodes_AreStripped() + { + var obj = new PSObject(); + obj.Properties.Add(new PSNoteProperty("Name", "\x1b[31mRed\x1b[0m")); + + var columns = new List + { + new DataTableColumn("Name", "$_.\"Name\"") + }; + + var row = TypeGetter.CastObjectToDataTableRow(obj, columns, 0); + + var columnKey = columns[0].ToString(); + Assert.Equal("Red", row.Values[columnKey].DisplayValue); + } + + [Fact] + public void CastObjectsToTableView_SetsColumnTypes() + { + var obj1 = new PSObject(); + obj1.Properties.Add(new PSNoteProperty("Count", 10)); + obj1.Properties.Add(new PSNoteProperty("Name", "test")); + + var obj2 = new PSObject(); + obj2.Properties.Add(new PSNoteProperty("Count", 20)); + obj2.Properties.Add(new PSNoteProperty("Name", "test2")); + + var result = TypeGetter.CastObjectsToTableView(new List { obj1, obj2 }); + + var countColumn = result.DataColumns.Find(c => c.Label == "Count"); + var nameColumn = result.DataColumns.Find(c => c.Label == "Name"); + + Assert.NotNull(countColumn); + Assert.NotNull(nameColumn); + // Count column should be decimal type (all values are numeric) + Assert.Equal(typeof(decimal).FullName, countColumn.StringType); + // Name column should be string type + Assert.Equal(typeof(string).FullName, nameColumn.StringType); + } + + [Fact] + public void CastObjectsToTableView_MultipleObjects_PreservesOrder() + { + var objects = new List(); + for (int i = 0; i < 5; i++) + { + var obj = new PSObject(); + obj.Properties.Add(new PSNoteProperty("Index", i)); + objects.Add(obj); + } + + var result = TypeGetter.CastObjectsToTableView(objects); + + Assert.Equal(5, result.Data.Count); + for (int i = 0; i < 5; i++) + { + Assert.Equal(i, result.Data[i].OriginalObjectIndex); + } + } +}