Microsoft.PowerShell.Utility.ArgumentCompleters.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311

#
# Reading the registry for progids takes > 500ms, so we do it just once
#
function InitClassIdTable
{
    $progIds = [Microsoft.Win32.Registry]::ClassesRoot.GetSubKeyNames()
    $versionedProgIds = new-object System.Collections.Generic.List[string]

    function AddProgId($progId)
    {
        $subKey = [Microsoft.Win32.Registry]::ClassesRoot.OpenSubKey($progId)
        foreach ($clsidSubkey in $subKey.GetSubKeyNames())
        {
            if ($clsidSubkey -eq 'CLSID')
            {
                $description = $subKey.GetValue('')
                $result[$progId] = $description
                break
            }
        }
    }

    $result = [ordered]@{}
    foreach ($progId in $progIds)
    {
        # Skip versioned progIds (ends in digits) for now - we'll make a second pass
        # and add those if there is no version indepent progId.
        if ($progId -match '^(\w+\.\w+)\.[\d]+(\.\d+)?$')
        {
            $versionedProgIds.Add($progId)
            continue
        }

        # Check if it really is a progId - does it have a CLSID underneath
        AddProgId $progId
    }

    foreach ($progId in $versionedProgIds)
    {
        $null = $progId -match '^(\w+\.\w+)\.[\d]+(\.\d+)?$'
        if (!$result[$matches[1]])
        {
            AddProgId $progId
        }
    }

    return $result
}

#
# .SYNOPSIS
#
# Complete -ComObject arguments
#
function NewComObjectCompletion
{
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    $allProgIds = Get-CompletionPrivateData -Key New-Object_ComObject
    if (!$allProgIds)
    {
        $allProgIds = InitClassIdTable
        Set-CompletionPrivateData -Key New-Object_ComObject -Value $allProgIds
    }

    # TODO - is sorting from intialization good enough? This completion is pretty slow
    # as is if $wordToComplete is empty.
    $allProgIds.GetEnumerator() |
        Where-Object Key -like "$wordToComplete*" |
        ForEach-Object {
            $progId = $_.Key
            $tooltip = $_.Value
            New-CompletionResult $progId $tooltip }
}


#
# .SYNOPSIS
#
# Complete event name arguments
#
function EventNameCompletion
{
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    $inputObject = $fakeBoundParameter["InputObject"]
    if ($null -ne $inputObject)
    {
        $inputObject.GetType().GetEvents("Public,Instance").Name |
            Where-Object { $_ -like "$wordToComplete*" } |
            Sort-Object |
            ForEach-Object {
                New-CompletionResult $_ "Event $_"
            }
    }
}


#
# .SYNOPSIS
#
# Complete the -Name argument to Out-Printer
#
function OutPrinterNameArgumentCompletion
{
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    Get-WmiObject -Class Win32_Printer |
        Where-Object Name -like "$wordToComplete*" |
        Sort-Object Name |
        ForEach-Object {
            New-CompletionResult $_.Name $_.Location
        }
}


#
# .SYNOPSIS
#
# Complete arguments that take ps1xml files for the Update-[Type|Format]Data commands.
#
function AddTypePathArgumentCompletion
{
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    Get-CompletionWithExtension $lastWord ('.dll', '.cs', '.vb', '.js')
}


#
# .SYNOPSIS
#
# Complete arguments that take ps1xml files for the Update-[Type|Format]Data commands.
#
function Ps1xmlPathArgumentCompletion
{
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    Get-CompletionWithExtension $lastWord '.ps1xml'
}


#
# .SYNOPSIS
#
# Complete the -SerializationMethod argument to Update-TypeData
#
function UpdateTypeDataSerializationMethodCompleter
{
   param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

   $sm = [PSObject].Assembly.GetType('System.Management.Automation.SerializationMethod')
   [System.Enum]::GetNames($sm) | Where-Object {$_ -like "*$wordToComplete*"} | Sort-Object | Foreach-Object {
    New-CompletionResult $_ $_
   }
}


#
# .SYNOPSIS
#
# Complete the SourceIdentifier argument to Register-EngineEvent
#
function EventNameCompletion
{
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    [System.Management.Automation.PsEngineEvent].GetFields() | ForEach-Object { $_.GetValue($null) } | Sort-Object | Where-Object {$_ -like "*$wordToComplete*"} | ForEach-Object {
        New-CompletionResult  $_ $_
    }
}


#
# .SYNOPSIS
#
# Complete the TypeName argument to Update-TypeData
#
function UpdateTypeTypeNameCompleter
{
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    [System.Management.Automation.CompletionCompleters]::CompleteType($wordToComplete)
}


#
# .SYNOPSIS
#
# Complete the Id argument for Disable-PSBreakPoint
#
function DisablePSBreakpointIdCompleter
{
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    Microsoft.PowerShell.Utility\Get-PSBreakpoint | 
        Where-Object { $_.Enabled -and $_.Id -like "*$wordToComplete*" } |
        ForEach-Object {
            $toolTip = "Script: {0} Type: {1}" -f $_.Script, $_.GetType().Name
            New-CompletionResult $_.Id $toolTip
        }
}


#
# .SYNOPSIS
#
# Complete the Id argument for Disable-PSBreakPoint
#
function RemovePSBreakpointIdCompleter
{
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    Microsoft.PowerShell.Utility\Get-PSBreakpoint | 
        Where-Object { $_.Id -like "*$wordToComplete*" } |
        ForEach-Object {
            $toolTip = "Script: {0} Type: {1}" -f $_.Script, $_.GetType().Name
            New-CompletionResult $_.Id $toolTip
        }
}


Register-ArgumentCompleter `
    -Command 'New-Object' `
    -Parameter 'ComObject' `
    -Description 'Complete com object class ids for New-Object -ComObject <TAB>' `
    -ScriptBlock $function:NewComObjectCompletion


Register-ArgumentCompleter `
    -Command 'Register-ObjectEvent' `
    -Parameter 'EventName' `
    -Description @'
Complete the -EventName argument for Register-ObjectEvent, for example:

    $timer = new-object System.Timers.Timer
    Register-ObjectEvent -InputObject $timer -EventName <TAB>
'@
 `
    -ScriptBlock $function:EventNameCompletion


Register-ArgumentCompleter `
    -Command 'Out-Printer' `
    -Parameter 'Name' `
    -Description 'Complete printer names for Out-Printer' `
    -ScriptBlock $function:OutPrinterNameArgumentCompletion


Register-ArgumentCompleter `
    -Command 'Add-Type' `
    -Parameter 'Path' `
    -Description 'Complete source code and dlls for Add-Type -Path' `
    -ScriptBlock $function:AddTypePathArgumentCompletion


Register-ArgumentCompleter `
    -Command 'Add-Type' `
    -Parameter 'LiteralPath' `
    -Description 'Complete source code and dlls for Add-Type -LiteralPath' `
    -ScriptBlock $function:AddTypePathArgumentCompletion


Register-ArgumentCompleter `
    -Command ('Update-TypeData', 'Update-FormatData') `
    -Parameter 'AppendPath' `
    -Description 'Complete ps1xml files for -AppendPath' `
    -ScriptBlock $function:Ps1xmlPathArgumentCompletion


Register-ArgumentCompleter `
    -Command ('Update-TypeData', 'Update-FormatData') `
    -Parameter 'PrependPath' `
    -Description 'Complete ps1xml files for -PrependPath' `
    -ScriptBlock $function:Ps1xmlPathArgumentCompletion


Register-ArgumentCompleter `
    -Command 'Update-TypeData' `
    -Parameter 'SerializationMethod' `
    -Description 'Complete the -SerializationMethod argument to Update-TypeData. For example: Update-TypeData -SerializationMethod <TAB>' `
    -ScriptBlock $function:UpdateTypeDataSerializationMethodCompleter


Register-ArgumentCompleter `
    -Command 'Register-EngineEvent' `
    -Parameter 'SourceIdentifier' `
    -Description 'Complete the -SourceIdentifier argument for Register-ObjectEvent, for example: Register-EngineEvent -SourceIdentifier <TAB>' `
    -ScriptBlock $function:EventNameCompletion


Register-ArgumentCompleter `
    -Command ('Get-TypeData','Remove-TypeData','Update-TypeData') `
    -Parameter 'TypeName' `
    -Description 'Complete names of types: Update-TypeData -TypeName <TAB>' `
    -ScriptBlock $function:UpdateTypeTypeNameCompleter


Register-ArgumentCompleter `
    -Command ('Disable-PSBreakpoint') `
    -Parameter 'Id' `
    -Description 'Complete Id parameter: Disable-PSBreakpoint -Id <TAB>' `
    -ScriptBlock $function:DisablePSBreakpointIdCompleter


Register-ArgumentCompleter `
    -Command ('Remove-PSBreakpoint') `
    -Parameter 'Id' `
    -Description 'Complete Id parameter: Remove-PSBreakpoint -Id <TAB>' `
    -ScriptBlock $function:RemovePSBreakpointIdCompleter