This repository has been archived by the owner on Feb 16, 2018. It is now read-only.
/
ConsoleDispatcher.cs
521 lines (446 loc) · 15.2 KB
/
ConsoleDispatcher.cs
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Media;
using Microsoft.VisualStudio.Text;
using NuGet;
namespace NuGetConsole.Implementation.Console
{
internal interface IPrivateConsoleDispatcher : IConsoleDispatcher, IDisposable
{
event EventHandler<EventArgs<Tuple<SnapshotSpan, bool>>> ExecuteInputLine;
void PostInputLine(InputLine inputLine);
void PostKey(VsKeyInfo key);
void CancelWaitKey();
}
/// <summary>
/// This class handles input line posting and command line dispatching/execution.
/// </summary>
internal class ConsoleDispatcher : IPrivateConsoleDispatcher
{
private readonly BlockingCollection<VsKeyInfo> _keyBuffer = new BlockingCollection<VsKeyInfo>();
private CancellationTokenSource _cancelWaitKeySource;
private bool _isExecutingReadKey;
/// <summary>
/// The IPrivateWpfConsole instance this dispatcher works with.
/// </summary>
private IPrivateWpfConsole WpfConsole { get; set; }
/// <summary>
/// Child dispatcher based on host type. Its creation is postponed to Start(), so that
/// a WpfConsole's dispatcher can be accessed while inside a host construction.
/// </summary>
private Dispatcher _dispatcher;
private readonly object _lockObj = new object();
public event EventHandler StartCompleted;
public event EventHandler StartWaitingKey;
public ConsoleDispatcher(IPrivateWpfConsole wpfConsole)
{
UtilityMethods.ThrowIfArgumentNull(wpfConsole);
this.WpfConsole = wpfConsole;
}
public bool IsExecutingCommand
{
get
{
return (_dispatcher != null) && _dispatcher.IsExecuting;
}
}
public void PostKey(VsKeyInfo key)
{
if (key == null)
{
throw new ArgumentNullException("key");
}
_keyBuffer.Add(key);
}
public bool IsExecutingReadKey
{
get { return _isExecutingReadKey; }
}
public bool IsKeyAvailable
{
get
{
// In our BlockingCollection<T> producer/consumer this is
// not critical so no need for locking.
return _keyBuffer.Count > 0;
}
}
public void CancelWaitKey()
{
if (_isExecutingReadKey && !_cancelWaitKeySource.IsCancellationRequested)
{
_cancelWaitKeySource.Cancel();
}
}
public void AcceptKeyInput()
{
Debug.Assert(_dispatcher != null);
if (_dispatcher != null && WpfConsole != null)
{
WpfConsole.BeginInputLine();
}
}
public VsKeyInfo WaitKey()
{
try
{
// raise the StartWaitingKey event on main thread
RaiseEventSafe(StartWaitingKey);
// set/reset the cancellation token
_cancelWaitKeySource = new CancellationTokenSource();
_isExecutingReadKey = true;
// blocking call
VsKeyInfo key = _keyBuffer.Take(_cancelWaitKeySource.Token);
return key;
}
catch (OperationCanceledException)
{
return null;
}
finally
{
_isExecutingReadKey = false;
}
}
private void RaiseEventSafe(EventHandler handler)
{
if (handler != null)
{
Microsoft.VisualStudio.Shell.ThreadHelper.Generic.Invoke(() => handler(this, EventArgs.Empty));
}
}
public bool IsStartCompleted { get; private set; }
#region IConsoleDispatcher
public void Start()
{
// Only Start once
lock (_lockObj)
{
if (_dispatcher == null)
{
IHost host = WpfConsole.Host;
if (host == null)
{
throw new InvalidOperationException("Can't start Console dispatcher. Host is null.");
}
if (host is IAsyncHost)
{
_dispatcher = new AsyncHostConsoleDispatcher(this);
}
else
{
_dispatcher = new SyncHostConsoleDispatcher(this);
}
Task.Factory.StartNew(
// gives the host a chance to do initialization works before the console starts accepting user inputs
() => host.Initialize(WpfConsole)
).ContinueWith(
task =>
{
if (task.IsFaulted)
{
var exception = ExceptionUtility.Unwrap(task.Exception);
WriteError(exception.Message);
}
if (host.IsCommandEnabled)
{
Microsoft.VisualStudio.Shell.ThreadHelper.Generic.Invoke(_dispatcher.Start);
}
RaiseEventSafe(StartCompleted);
IsStartCompleted = true;
},
TaskContinuationOptions.NotOnCanceled
);
}
}
}
private void WriteError(string message)
{
if (WpfConsole != null)
{
WpfConsole.Write(message + Environment.NewLine, Colors.Red, null);
}
}
public void ClearConsole()
{
Debug.Assert(_dispatcher != null);
if (_dispatcher != null)
{
_dispatcher.ClearConsole();
}
}
#endregion
#region IPrivateConsoleDispatcher
public event EventHandler<EventArgs<Tuple<SnapshotSpan, bool>>> ExecuteInputLine;
void OnExecute(SnapshotSpan inputLineSpan, bool isComplete)
{
ExecuteInputLine.Raise(this, Tuple.Create(inputLineSpan, isComplete));
}
public void PostInputLine(InputLine inputLine)
{
Debug.Assert(_dispatcher != null);
if (_dispatcher != null)
{
_dispatcher.PostInputLine(inputLine);
}
}
#endregion
private abstract class Dispatcher
{
protected ConsoleDispatcher ParentDispatcher { get; private set; }
protected IPrivateWpfConsole WpfConsole { get; private set; }
private bool _isExecuting;
public bool IsExecuting
{
get
{
return _isExecuting;
}
protected set
{
_isExecuting = value;
WpfConsole.SetExecutionMode(_isExecuting);
}
}
protected Dispatcher(ConsoleDispatcher parentDispatcher)
{
ParentDispatcher = parentDispatcher;
WpfConsole = parentDispatcher.WpfConsole;
}
/// <summary>
/// Process a input line.
/// </summary>
/// <param name="inputLine"></param>
protected Tuple<bool, bool> Process(InputLine inputLine)
{
SnapshotSpan inputSpan = inputLine.SnapshotSpan;
if (inputLine.Flags.HasFlag(InputLineFlag.Echo))
{
WpfConsole.BeginInputLine();
if (inputLine.Flags.HasFlag(InputLineFlag.Execute))
{
WpfConsole.WriteLine(inputLine.Text);
inputSpan = WpfConsole.EndInputLine(true).Value;
}
else
{
WpfConsole.Write(inputLine.Text);
}
}
if (inputLine.Flags.HasFlag(InputLineFlag.Execute))
{
string command = inputLine.Text;
bool isExecuted = WpfConsole.Host.Execute(WpfConsole, command, null);
WpfConsole.InputHistory.Add(command);
ParentDispatcher.OnExecute(inputSpan, isExecuted);
return Tuple.Create(true, isExecuted);
}
return Tuple.Create(false, false);
}
public void PromptNewLine()
{
WpfConsole.Write(WpfConsole.Host.Prompt + (char)32); // 32 is the space
WpfConsole.BeginInputLine();
}
public void ClearConsole()
{
// When inputting commands
if (WpfConsole.InputLineStart != null)
{
WpfConsole.Host.Abort(); // Clear constructing multi-line command
WpfConsole.Clear();
PromptNewLine();
}
else
{
WpfConsole.Clear();
}
}
public abstract void Start();
public abstract void PostInputLine(InputLine inputLine);
}
/// <summary>
/// This class dispatches inputs for synchronous hosts.
/// </summary>
private class SyncHostConsoleDispatcher : Dispatcher
{
public SyncHostConsoleDispatcher(ConsoleDispatcher parentDispatcher)
: base(parentDispatcher)
{
}
public override void Start()
{
PromptNewLine();
}
public override void PostInputLine(InputLine inputLine)
{
IsExecuting = true;
try
{
if (Process(inputLine).Item1)
{
PromptNewLine();
}
}
finally
{
IsExecuting = false;
}
}
}
/// <summary>
/// This class dispatches inputs for asynchronous hosts.
/// </summary>
private class AsyncHostConsoleDispatcher : Dispatcher
{
private Queue<InputLine> _buffer;
private Marshaler _marshaler;
public AsyncHostConsoleDispatcher(ConsoleDispatcher parentDispatcher)
: base(parentDispatcher)
{
_marshaler = new Marshaler(this);
}
private bool IsStarted
{
get
{
return _buffer != null;
}
}
public override void Start()
{
if (IsStarted)
{
// Can only start once... ConsoleDispatcher is already protecting this.
throw new InvalidOperationException();
}
_buffer = new Queue<InputLine>();
IAsyncHost asyncHost = WpfConsole.Host as IAsyncHost;
if (asyncHost == null)
{
// ConsoleDispatcher is already checking this.
throw new InvalidOperationException();
}
asyncHost.ExecuteEnd += _marshaler.AsyncHost_ExecuteEnd;
PromptNewLine();
}
public override void PostInputLine(InputLine inputLine)
{
// The editor should be completely readonly unless started.
Debug.Assert(IsStarted);
if (IsStarted)
{
_buffer.Enqueue(inputLine);
ProcessInputs();
}
}
private void ProcessInputs()
{
if (IsExecuting)
{
return;
}
if (_buffer.Count > 0)
{
InputLine inputLine = _buffer.Dequeue();
Tuple<bool, bool> executeState = Process(inputLine);
if (executeState.Item1)
{
IsExecuting = true;
if (!executeState.Item2)
{
// If NOT really executed, processing the same as ExecuteEnd event
OnExecuteEnd();
}
}
}
}
private void OnExecuteEnd()
{
if (IsStarted)
{
// Filter out noise. A host could execute private commands.
Debug.Assert(IsExecuting);
IsExecuting = false;
PromptNewLine();
ProcessInputs();
}
}
/// <summary>
/// This private Marshaler marshals async host event to main thread so that the dispatcher
/// doesn't need to worry about threading.
/// </summary>
private class Marshaler : Marshaler<AsyncHostConsoleDispatcher>
{
public Marshaler(AsyncHostConsoleDispatcher impl)
: base(impl)
{
}
public void AsyncHost_ExecuteEnd(object sender, EventArgs e)
{
Invoke(() => _impl.OnExecuteEnd());
}
}
}
protected virtual void Dispose(bool disposing)
{
if (disposing)
{
if (_keyBuffer != null)
{
_keyBuffer.Dispose();
}
if (_cancelWaitKeySource != null)
{
_cancelWaitKeySource.Dispose();
}
}
}
void IDisposable.Dispose()
{
try
{
Dispose(true);
}
finally
{
GC.SuppressFinalize(this);
}
}
~ConsoleDispatcher()
{
Dispose(false);
}
}
[Flags]
internal enum InputLineFlag
{
Echo = 1,
Execute = 2
}
internal class InputLine
{
public SnapshotSpan SnapshotSpan { get; private set; }
public string Text { get; private set; }
public InputLineFlag Flags { get; private set; }
public InputLine(string text, bool execute)
{
this.Text = text;
this.Flags = InputLineFlag.Echo;
if (execute)
{
this.Flags |= InputLineFlag.Execute;
}
}
public InputLine(SnapshotSpan snapshotSpan)
{
this.SnapshotSpan = snapshotSpan;
this.Text = snapshotSpan.GetText();
this.Flags = InputLineFlag.Execute;
}
}
}