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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
|
//
// CodeCompletionSession.cs
//
// Author:
// Lluis Sanchez <llsan@microsoft.com>
//
// Copyright (c) 2017 Microsoft
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using Gdk;
using Gtk;
using MonoDevelop.Ide.Editor.Extension;
using Xwt.Drawing;
using MonoDevelop.Core;
using MonoDevelop.Ide.Editor;
namespace MonoDevelop.Ide.CodeCompletion
{
/// <summary>
/// This is the controller of the code completion window.
/// The controller takes code completion data and keystrokes as input, and shows the
/// results in the code completion view.
/// </summary>
[Obsolete]
class CompletionController : IDisposable, IListDataProvider, ICompletionViewEventSink
{
ICompletionView view;
ICompletionDataList dataList;
/// <summary>
/// A list that contains the indices of the dataList items that will be shown in the completion window,
/// and in the order they need to be shown.
/// </summary>
List<int> filteredItems = new List<int> ();
/// <summary>
/// List of categories referenced in dataList. For each category there is a list of item indices,
/// which are the items to be shown for each category.
/// </summary>
List<CategorizedCompletionItems> filteredCategories = new List<CategorizedCompletionItems> ();
/// <summary>
/// Text typed so far
/// </summary>
string completionString;
/// <summary>
/// Front end for the completion window
/// </summary>
CompletionListWindow listWindow;
/// <summary>
/// The widget for which the completion window is shown
/// </summary>
ICompletionWidget completionWidget;
/// <summary>
/// A cache that keeps a list of the most recently used completion items
/// </summary>
internal MruCache cache = new MruCache ();
/// <summary>
/// If the completion data list is mutable, this contains the reference to the interface that handles mutability
/// </summary>
IMutableCompletionDataList mutableList;
int initialWordLength;
bool currentVisible;
TooltipInformationWindow declarationViewWindow;
CompletionData currentData;
CancellationTokenSource declarationViewCancelSource;
bool declarationViewHidden = true;
uint declarationViewTimer;
bool usingPreviewEntry;
string previewCompletionEntryText;
public CompletionController (CompletionListWindow listWindow, ICompletionView view)
{
this.listWindow = listWindow;
this.view = view;
AutoSelect = true;
DefaultCompletionString = "";
currentVisible = false;
}
/// <summary>
/// Initializes the code completion session. After this method is called, the controller is ready to start
/// keeping track of keystrokes. When ShowListWindow is called, the controller will take into account
/// what has been typed since InitializeSession.
/// </summary>
public void InitializeSession (ICompletionWidget completionWidget, CodeCompletionContext completionContext)
{
if (completionWidget == null)
throw new ArgumentNullException (nameof (completionWidget));
if (completionContext == null)
throw new ArgumentNullException (nameof (completionContext));
view.Initialize (this, this);
if (mutableList != null) {
mutableList.Changing -= OnCompletionDataChanging;
mutableList.Changed -= OnCompletionDataChanged;
view.HideLoadingMessage();
}
ResetState ();
HideDeclarationView ();
CompletionWidget = completionWidget;
CodeCompletionContext = completionContext;
string text = CompletionWidget.GetCompletionText (CodeCompletionContext);
initialWordLength = CompletionWidget.SelectedLength > 0 ? 0 : text.Length;
StartOffset = CompletionWidget.CaretOffset - initialWordLength;
NotifyVisibilityChange ();
}
public bool ShowListWindow (ICompletionDataList list, CodeCompletionContext completionContext)
{
if (list == null)
throw new ArgumentNullException (nameof (list));
CodeCompletionContext = completionContext;
dataList = list;
ResetState ();
EndOffset = CompletionWidget.CaretOffset;
if (dataList.CompletionSelectionMode == CompletionSelectionMode.OwnTextField) {
view.ShowPreviewCompletionEntry ();
usingPreviewEntry = true;
previewCompletionEntryText = "";
}
mutableList = dataList as IMutableCompletionDataList;
if (mutableList != null) {
mutableList.Changing += OnCompletionDataChanging;
mutableList.Changed += OnCompletionDataChanged;
if (mutableList.IsChanging)
OnCompletionDataChanging (null, null);
}
// If completion data list is changing we always want to show the completion window
// to inform the user that information is being generated
if (dataList.Count == 0 && !IsChanging) {
HideWindow ();
return false;
}
var position = CodeCompletionContext.GetCoordinatesAsync ().WaitAndGetResult (default(CancellationToken));
view.Reposition (position.x, position.y, position.textHeight, true);
// Initialize the completion window behavior options
AutoSelect = list.AutoSelect;
AutoCompleteEmptyMatch = list.AutoCompleteEmptyMatch;
AutoCompleteEmptyMatchOnCurlyBrace = list.AutoCompleteEmptyMatchOnCurlyBrace;
CloseOnSquareBrackets = list.CloseOnSquareBrackets;
DefaultCompletionString = dataList.DefaultCompletionString ?? "";
// Makes control-space in midle of words to work
string text = CompletionWidget.GetCompletionText (CodeCompletionContext);
if (text.Length == 0) {
initialWordLength = 0;
StartOffset = CodeCompletionContext.TriggerOffset;
ResetSizes ();
ShowWindow ();
UpdateWordSelection ();
UpdateDeclarationView ();
// If there is only one matching result we take it by default
if (dataList.AutoCompleteUniqueMatch && IsUniqueMatch && !IsChanging) {
CompleteWord ();
HideWindow ();
return false;
}
return true;
}
initialWordLength = CompletionWidget.SelectedLength > 0 ? 0 : text.Length;
StartOffset = CompletionWidget.CaretOffset - initialWordLength;
ResetSizes ();
UpdateWordSelection ();
// If there is only one matching result we take it by default
if (dataList.AutoCompleteUniqueMatch && IsUniqueMatch && !IsChanging) {
CompleteWord ();
HideWindow ();
return false;
}
ShowWindow ();
UpdateDeclarationView ();
return true;
}
public void HideWindow ()
{
if (CompletionWidget is ICompletionWidget2 widget2)
widget2.NotifyCompletionWindowClosed ();
HideDeclarationView ();
view.Hide ();
ReleaseObjects ();
NotifyVisibilityChange ();
}
public void ShowWindow ()
{
view.Show ();
NotifyVisibilityChange ();
}
public bool Visible {
get {
// Even if ShowWindow has not been called, the window can
// already process key input, so we consider it to be "visible".
if (dataList == null)
return CodeCompletionContext != null; // The session is initialized
else
return view.Visible;
}
}
void NotifyVisibilityChange ()
{
if (currentVisible != Visible) {
currentVisible = Visible;
VisibleChanged?.Invoke (this, EventArgs.Empty);
}
}
void ResetState ()
{
usingPreviewEntry = false;
previewCompletionEntryText = "";
SelectedItemCompletionText = null;
ResetViewState();
}
void UpdateDeclarationView ()
{
if (dataList == null || SelectedItem == null) {
HideDeclarationView ();
return;
}
if (!view.Visible)
return;
RemoveDeclarationViewTimer ();
// no selection, try to find a selection
if (SelectedItemIndex < 0 || SelectedItemIndex >= dataList.Count) {
CompletionString = PartialWord;
SelectEntry (CompletionString);
}
// no success, hide declaration view
if (SelectedItemIndex < 0 || SelectedItemIndex >= dataList.Count) {
HideDeclarationView ();
return;
}
var data = dataList [SelectedItemIndex];
if (data != currentData) {
HideDeclarationView ();
} else {
if (declarationViewWindow != null && declarationViewWindow.Visible && currentData == data)
return; // current data is up to date
}
declarationViewTimer = GLib.Timeout.Add (150, DelayedTooltipShow);
}
void HideDeclarationView ()
{
if (declarationViewCancelSource != null) {
declarationViewCancelSource.Cancel ();
declarationViewCancelSource = null;
}
RemoveDeclarationViewTimer ();
if (declarationViewWindow != null) {
declarationViewWindow.Hide ();
}
declarationViewHidden = true;
}
void RemoveDeclarationViewTimer ()
{
if (declarationViewTimer != 0) {
GLib.Source.Remove (declarationViewTimer);
declarationViewTimer = 0;
}
}
bool DelayedTooltipShow ()
{
DelayedTooltipShowAsync ();
return false;
}
async void DelayedTooltipShowAsync ()
{
try {
var selectedItem = SelectedItemIndex;
if (selectedItem < 0 || selectedItem >= dataList.Count)
return;
var data = dataList [selectedItem];
IEnumerable<CompletionData> filteredOverloads;
if (data.HasOverloads) {
filteredOverloads = data.OverloadedData;
} else {
filteredOverloads = new CompletionData [] { data };
}
EnsureDeclarationViewWindow ();
if (data != currentData) {
declarationViewWindow.Clear ();
currentData = data;
var cs = new CancellationTokenSource ();
declarationViewCancelSource = cs;
var overloads = new List<CompletionData> (filteredOverloads);
overloads.Sort (MonoDevelop.Ide.CodeCompletion.CompletionDataList.overloadComparer);
foreach (var overload in overloads) {
await declarationViewWindow.AddOverload ((CompletionData)overload, cs.Token);
}
if (cs.IsCancellationRequested)
return;
if (declarationViewCancelSource == cs)
declarationViewCancelSource = null;
if (data.HasOverloads) {
for (int i = 0; i < overloads.Count; i++) {
if (!overloads [i].DisplayFlags.HasFlag (DisplayFlags.Obsolete)) {
declarationViewWindow.CurrentOverload = i;
break;
}
}
}
}
if (declarationViewWindow.Overloads == 0) {
HideDeclarationView ();
return;
}
if (declarationViewHidden && view.Visible) {
RepositionDeclarationViewWindow ();
}
declarationViewTimer = 0;
} catch (Exception ex) {
LoggingService.LogInternalError (ex);
}
}
void EnsureDeclarationViewWindow ()
{
if (declarationViewWindow == null) {
declarationViewWindow = new TooltipInformationWindow ();
declarationViewWindow.LabelMaxWidth = 380;
} else {
declarationViewWindow.SetDefaultScheme ();
}
declarationViewWindow.Theme.SetBackgroundColor (Gui.Styles.CodeCompletion.BackgroundColor);
}
void RepositionDeclarationViewWindow ()
{
if (!view.Visible)
return;
EnsureDeclarationViewWindow ();
if (declarationViewWindow.Overloads == 0)
return;
var selectedItem = SelectedItemIndex;
declarationViewWindow.ShowArrow = true;
if (view.RepositionDeclarationViewWindow (declarationViewWindow, selectedItem))
declarationViewHidden = false;
}
void OnCompletionDataChanged (object sender, EventArgs e)
{
if (!object.ReferenceEquals (sender, mutableList))
return;
// Only hide the footer if it's finished changing
if (!mutableList.IsChanging)
view.HideLoadingMessage ();
// Try to capture full selection state so as not to interrupt user
// SelectedItemCompletionText is updated on every selection change
// so doesn't depend on the current state of the list, which changed
// immediately before this event was fired
string lastSelection = AutoSelect ? SelectedItemCompletionText : null;
var selectState = AutoSelect;
// Clear the current filter state before doing anything else
// because most other things depend on it
ResetState ();
// This sets List.CompletionString, which refilters it
ResetSizes ();
AutoSelect = selectState;
// Try to select the last selected item
var match = CompletionSelectionStatus.Empty;
if (lastSelection != null)
match = FindMatchedEntry (lastSelection);
// If that fails, use the partial word
if (match.Index < 0)
match = FindMatchedEntry (PartialWord);
SelectEntry (match);
}
void OnCompletionDataChanging (object sender, EventArgs e)
{
if (!object.ReferenceEquals (sender, mutableList))
return;
view.ShowLoadingMessage ();
}
public void Dispose ()
{
if (mutableList != null) {
mutableList.Changing -= OnCompletionDataChanging;
mutableList.Changed -= OnCompletionDataChanged;
mutableList = null;
}
if (dataList != null) {
if (dataList is IDisposable)
((IDisposable)dataList).Dispose ();
CloseCompletionList ();
dataList = null;
}
HideDeclarationView ();
if (declarationViewWindow != null) {
declarationViewWindow.Destroy ();
declarationViewWindow = null;
}
ReleaseObjects ();
view.Destroy ();
}
void ReleaseObjects ()
{
CompletionWidget = null;
dataList = null;
CodeCompletionContext = null;
currentData = null;
Extension = null;
view.ResetState ();
}
public List<int> FilteredItems {
get {
return filteredItems;
}
}
public string CompletionString {
get { return completionString; }
set {
if (completionString != value) {
var oldCompletionString = completionString;
completionString = value;
FilterItems (oldCompletionString);
UpdateViewSelectionEnabled ();
}
}
}
public int InitialWordLength {
get { return initialWordLength; }
}
public CompletionTextEditorExtension Extension {
get;
set;
}
/// <summary>
/// Gets or sets a value indicating that shift was pressed during enter.
/// </summary>
/// <value>
/// <c>true</c> if was shift pressed; otherwise, <c>false</c>.
/// </value>
public bool WasShiftPressed {
get;
private set;
}
/// <summary>
/// Occurs when the selected item in completion window changes
/// </summary>
public event EventHandler SelectionChanged;
void OnSelectionChanged ()
{
SelectedItemCompletionText = SelectedItemIndex >= 0 ? dataList [SelectedItemIndex].DisplayText : null;
SelectionChanged?.Invoke (this, EventArgs.Empty);
}
/// <summary>
/// Occurs when the selected code completion item is committed
/// </summary>
public event EventHandler<CodeCompletionContextEventArgs> WordCompleted;
void OnWordCompleted (CodeCompletionContextEventArgs e)
{
WordCompleted?.Invoke (this, e);
if (usingPreviewEntry)
Dispose ();
}
/// <summary>
/// Occurs when the Visible property changes
/// </summary>
public event EventHandler VisibleChanged;
void ResetViewState ()
{
filteredItems.Clear ();
completionString = null;
AutoSelect = false;
view.ResetState();
}
public ICompletionDataList CompletionDataList => dataList;
public ICompletionWidget CompletionWidget {
get {
return completionWidget;
}
set {
completionWidget = value;
}
}
bool autoCompleteEmptyMatch;
public bool AutoCompleteEmptyMatch {
get {
return autoCompleteEmptyMatch;
}
set {
autoCompleteEmptyMatch = value;
UpdateViewSelectionEnabled ();
}
}
public bool AutoCompleteEmptyMatchOnCurlyBrace {
get;
set;
}
public bool SelectionEnabled {
get {
// If this condition changes, UpdateViewSelectionEnabled may require additional calls
return AutoSelect && (AutoCompleteEmptyMatch || !IsEmptyMatch (CompletionString));
}
}
public bool IsUniqueMatch {
get {
return filteredItems.Count == 1;
}
}
bool IsChanging {
get { return mutableList != null && mutableList.IsChanging; }
}
static bool IsEmptyMatch (string completionString)
{
if (string.IsNullOrEmpty (completionString))
return true;
var ch = completionString [0];
return char.IsDigit (ch);
}
bool autoSelect;
public bool AutoSelect {
get { return autoSelect; }
set {
autoSelect = value;
UpdateViewSelectionEnabled ();
}
}
bool showCategories;
public bool ShowCategories {
get { return showCategories && filteredCategories.Count > 1; }
set {
if (value != showCategories) {
showCategories = value;
UpdateCategoryMode ();
}
}
}
public bool InCategoryMode {
get { return showCategories && filteredCategories.Count > 1; }
}
string CurrentCompletionText {
get {
if (SelectedItemIndex != -1 && AutoSelect)
return ((CompletionData)dataList [SelectedItemIndex]).CompletionText;
return null;
}
}
/// <summary>
/// Item currently selected in the code completion window
/// </summary>
public CompletionData SelectedItem {
get {
return SelectedItemIndex >= 0 ? dataList [SelectedItemIndex] : null;
}
}
int ViewIndexToItemIndex (int viewIndex)
{
if (viewIndex < 0 || viewIndex >= filteredItems.Count)
return -1;
if (InCategoryMode) {
foreach (var c in filteredCategories) {
if (viewIndex < c.Items.Count)
return c.Items [viewIndex];
viewIndex -= c.Items.Count;
}
return -1;
} else {
return filteredItems [viewIndex];
}
}
/// <summary>
/// Gets or sets the index inside CompletionDataList of the currently selected item
/// </summary>
/// <value>The index of the selected item.</value>
public int SelectedItemIndex {
get => view.SelectedItemIndex;
set => view.SelectedItemIndex = value;
}
// This is precalculated instead of calling DataProvider.GetCompletionText (SelectedItemIndex)
// it's called from CompletionListWindow.OnChanged after the list changes and the existing index no longer applies
string SelectedItemCompletionText { get; set; }
public string PartialWord {
get {
if (usingPreviewEntry)
return previewCompletionEntryText;
if (completionWidget == null)
return "";
return completionWidget.GetText (StartOffset, EndOffset);
}
}
public string CurrentPartialWord {
get {
return !string.IsNullOrEmpty (PartialWord) ? PartialWord : DefaultCompletionString;
}
}
public string DefaultCompletionString {
get;
set;
}
public bool CloseOnSquareBrackets {
get;
set;
}
internal int StartOffset { get; set; }
public int EndOffset {
get;
set;
}
void UpdateViewSelectionEnabled ()
{
if (SelectionEnabled != view.SelectionEnabled)
view.SelectionEnabled = SelectionEnabled;
}
public void ClearMruCache ()
{
cache.Clear ();
}
CompletionCharacters CompletionCharacters {
get {
var ext = Extension;
if (ext == null) // May happen in unit tests.
return MonoDevelop.Ide.CodeCompletion.CompletionCharacters.FallbackCompletionCharacters;
return MonoDevelop.Ide.CodeCompletion.CompletionCharacters.Get (ext.CompletionLanguage);
}
}
/// <summary>
/// Filters and sorts the list of items to be shown to the user
/// </summary>
/// <param name="oldCompletionString">Old completion string value before current one was set.</param>
void FilterItems (string oldCompletionString)
{
if (dataList == null)
return;
Counters.ProcessCodeCompletion.Trace ("Begin filtering and sorting completion data");
var filterResult = dataList.FilterCompletionList (new CompletionListFilterInput (dataList, filteredItems, oldCompletionString, completionString));
// If the data list doesn't have a custom filter method, use the default one
if (filterResult == null)
filterResult = MonoDevelop.Ide.CodeCompletion.CompletionDataList.DefaultFilterItems (dataList, filteredItems, oldCompletionString, completionString);
filteredItems = filterResult.FilteredItems;
filteredCategories = filterResult.CategorizedItems;
Counters.ProcessCodeCompletion.Trace ("End filtering and sorting completion data");
// Show the filtered items in the view
view.ShowFilteredItems (filterResult);
// If the previously selected item is not visible anymore, select the first item in the view
if (SelectedItemIndex == -1 && filteredItems.Count > 0)
SelectedItemIndex = filteredItems [0];
if (declarationViewWindow == null || !declarationViewWindow.Visible || currentData != SelectedItem)
RepositionDeclarationViewWindow ();
// InCategoryMode can change if the new results include new categories
if (view.InCategoryMode != InCategoryMode)
view.InCategoryMode = InCategoryMode;
}
public bool PreProcessKeyEvent (KeyDescriptor descriptor)
{
if (descriptor.SpecialKey == SpecialKey.Escape) {
HideWindow ();
return true;
}
KeyActions ka = KeyActions.None;
bool keyHandled = false;
if (dataList != null) {
// Give a chance to completion key handlers to pre-process the key
foreach (ICompletionKeyHandler handler in dataList.KeyHandler) {
if (handler.PreProcessKey (listWindow, descriptor, out ka)) {
keyHandled = true;
break;
}
}
}
// If a handler did not pre-process the key, do it now
if (!keyHandled)
ka = PreProcessKey (descriptor);
if ((ka & KeyActions.Complete) != 0)
CompleteWord (ref ka, descriptor);
if ((ka & KeyActions.CloseWindow) != 0) {
HideWindow ();
}
if ((ka & KeyActions.Ignore) != 0)
return true;
if ((ka & KeyActions.Process) != 0) {
if (descriptor.SpecialKey == SpecialKey.Left || descriptor.SpecialKey == SpecialKey.Right) {
// Close if there's a modifier active EXCEPT lock keys and Modifiers
// Makes an exception for Mod1Mask (usually alt), shift, control, meta and super
// This prevents the window from closing if the num/scroll/caps lock are active
// FIXME: modifier mappings depend on X server settings
// if ((modifier & ~(Gdk.ModifierType.LockMask | (Gdk.ModifierType.ModifierMask & ~(Gdk.ModifierType.ShiftMask | Gdk.ModifierType.Mod1Mask | Gdk.ModifierType.ControlMask | Gdk.ModifierType.MetaMask | Gdk.ModifierType.SuperMask)))) != 0) {
// this version doesn't work for my system - seems that I've a modifier active
// that gdk doesn't know about. How about the 2nd version - should close on left/rigt + shift/mod1/control/meta/super
if ((descriptor.ModifierKeys & (ModifierKeys.Shift | ModifierKeys.Alt | ModifierKeys.Control | ModifierKeys.Command)) != 0) {
HideWindow ();
return false;
}
if (declarationViewWindow != null && declarationViewWindow.Multiple) {
if (descriptor.SpecialKey == SpecialKey.Left)
declarationViewWindow.OverloadLeft ();
else
declarationViewWindow.OverloadRight ();
} else {
HideWindow ();
return false;
}
return true;
}
if (dataList != null && dataList.CompletionSelectionMode == CompletionSelectionMode.OwnTextField)
return true;
}
return false;
}
public KeyActions PreProcessKey (KeyDescriptor descriptor)
{
switch (descriptor.SpecialKey) {
case SpecialKey.Home:
if ((descriptor.ModifierKeys & ModifierKeys.Shift) == ModifierKeys.Shift)
return KeyActions.Process;
SelectedItemIndex = ViewIndexToItemIndex (0);
return KeyActions.Ignore;
case SpecialKey.End:
if ((descriptor.ModifierKeys & ModifierKeys.Shift) == ModifierKeys.Shift)
return KeyActions.Process;
SelectedItemIndex = ViewIndexToItemIndex (filteredItems.Count - 1);
return KeyActions.Ignore;
case SpecialKey.Up:
if ((descriptor.ModifierKeys & ModifierKeys.Shift) == ModifierKeys.Shift) {
if (!SelectionEnabled /*&& !CompletionWindowManager.ForceSuggestionMode*/)
AutoCompleteEmptyMatch = AutoSelect = true;
if (!InCategoryMode) {
IdeApp.Preferences.EnableCompletionCategoryMode.Set (true);
return KeyActions.Ignore;
}
MoveToCategory (-1);
return KeyActions.Ignore;
}
if (SelectionEnabled && filteredItems.Count < 1)
return KeyActions.CloseWindow | KeyActions.Process;
if (!SelectionEnabled /*&& !CompletionWindowManager.ForceSuggestionMode*/) {
AutoCompleteEmptyMatch = AutoSelect = true;
} else {
view.MoveCursor (-1);
}
return KeyActions.Ignore;
case SpecialKey.Tab:
//tab always completes current item even if selection is disabled
if (!AutoSelect)
AutoSelect = true;
if (!AutoCompleteEmptyMatch)
AutoCompleteEmptyMatch = true;
goto case SpecialKey.Return;
case SpecialKey.Return:
if (descriptor.ModifierKeys != ModifierKeys.None && descriptor.ModifierKeys != ModifierKeys.Shift)
return KeyActions.CloseWindow;
if (dataList == null || dataList.Count == 0 || !listWindow.SelectionEnabled)
return KeyActions.CloseWindow;
WasShiftPressed = (descriptor.ModifierKeys & ModifierKeys.Shift) == ModifierKeys.Shift;
if (SelectedItem != null) {
switch (SelectedItem.Rules.EnterKeyRule) {
case Microsoft.CodeAnalysis.Completion.EnterKeyRule.Always:
return KeyActions.Complete | KeyActions.Process | KeyActions.CloseWindow;
case Microsoft.CodeAnalysis.Completion.EnterKeyRule.AfterFullyTypedWord:
if (PartialWord.Length == SelectedItem.CompletionText.Length)
return KeyActions.Complete | KeyActions.Ignore | KeyActions.CloseWindow;
return KeyActions.Complete | KeyActions.Process | KeyActions.CloseWindow;
case Microsoft.CodeAnalysis.Completion.EnterKeyRule.Never:
case Microsoft.CodeAnalysis.Completion.EnterKeyRule.Default:
default:
return KeyActions.Complete | KeyActions.Ignore | KeyActions.CloseWindow;
}
}
return KeyActions.Complete | KeyActions.Ignore | KeyActions.CloseWindow;
case SpecialKey.Down:
if ((descriptor.ModifierKeys & ModifierKeys.Shift) == ModifierKeys.Shift) {
if (!SelectionEnabled /*&& !CompletionWindowManager.ForceSuggestionMode*/)
AutoCompleteEmptyMatch = AutoSelect = true;
if (!InCategoryMode) {
IdeApp.Preferences.EnableCompletionCategoryMode.Set (true);
return KeyActions.Ignore;
}
MoveToCategory (1);
return KeyActions.Ignore;
}
if (SelectionEnabled && filteredItems.Count < 1)
return KeyActions.CloseWindow | KeyActions.Process;
if (!SelectionEnabled /*&& !CompletionWindowManager.ForceSuggestionMode*/) {
AutoCompleteEmptyMatch = AutoSelect = true;
} else {
view.MoveCursor (1);
}
return KeyActions.Ignore;
case SpecialKey.PageUp:
if ((descriptor.ModifierKeys & ModifierKeys.Shift) == ModifierKeys.Shift)
return KeyActions.Process;
if (filteredItems.Count < 2)
return KeyActions.CloseWindow | KeyActions.Process;
view.PageUp ();
return KeyActions.Ignore;
case SpecialKey.PageDown:
if ((descriptor.ModifierKeys & ModifierKeys.Shift) == ModifierKeys.Shift)
return KeyActions.Process;
if (filteredItems.Count < 2)
return KeyActions.CloseWindow | KeyActions.Process;
view.PageDown ();
return KeyActions.Ignore;
case SpecialKey.Left:
//if (curPos == 0) return KeyActions.CloseWindow | KeyActions.Process;
//curPos--;
return KeyActions.Process;
case SpecialKey.Right:
//if (curPos == word.Length) return KeyActions.CloseWindow | KeyActions.Process;
//curPos++;
return KeyActions.Process;
// case Gdk.Key.Caps_Lock:
// case Gdk.Key.Num_Lock:
// case Gdk.Key.Scroll_Lock:
// return KeyActions.Ignore;
//
// case Gdk.Key.Control_L:
// case Gdk.Key.Control_R:
// case Gdk.Key.Alt_L:
// case Gdk.Key.Alt_R:
// case Gdk.Key.Shift_L:
// case Gdk.Key.Shift_R:
// case Gdk.Key.ISO_Level3_Shift:
// // AltGr
// return KeyActions.Process;
}
var data = SelectedItem;
if (descriptor.KeyChar == '\0')
return KeyActions.Process;
if (descriptor.KeyChar == ' ' && (descriptor.ModifierKeys & ModifierKeys.Shift) == ModifierKeys.Shift)
return KeyActions.CloseWindow | KeyActions.Process;
if (char.IsDigit (descriptor.KeyChar) && string.IsNullOrEmpty (CurrentCompletionText))
return KeyActions.CloseWindow | KeyActions.Process;
if (data != null && data.MuteCharacter (descriptor.KeyChar, PartialWord)) {
if (data.IsCommitCharacter (descriptor.KeyChar, PartialWord)) {
return KeyActions.CloseWindow | KeyActions.Ignore | KeyActions.Complete;
}
return KeyActions.CloseWindow | KeyActions.Ignore;
}
// Special case end with punctuation like 'param:' -> don't input double punctuation, otherwise we would end up with 'param::'
if (char.IsPunctuation (descriptor.KeyChar) && descriptor.KeyChar != '_') {
if (descriptor.KeyChar == ':') {
foreach (var item in filteredItems) {
if (dataList [item].DisplayText.EndsWith (descriptor.KeyChar.ToString (), StringComparison.Ordinal)) {
SelectedItemIndex = item;
return KeyActions.Complete | KeyActions.CloseWindow | KeyActions.Ignore;
}
}
} else {
var selectedItem = SelectedItemIndex;
if (selectedItem < 0 || (dataList != null && selectedItem >= dataList.Count)) {
return KeyActions.CloseWindow;
}
var displayText = dataList[selectedItem].DisplayText;
// Workaround for Json bug https://devdiv.visualstudio.com/DevDiv/_workitems/edit/634581
// If the completion item is " " or { } or [ ] and the char is " or { or [ then don't commit
if ((displayText == "\" \"" || displayText == "{ }" || displayText == "[ ]") && (descriptor.KeyChar == '"' || descriptor.KeyChar == '{' || descriptor.KeyChar == '[')) {
return KeyActions.CloseWindow | KeyActions.Process;
} else if (displayText.EndsWith (descriptor.KeyChar.ToString (), StringComparison.Ordinal)) {
return KeyActions.Complete | KeyActions.CloseWindow | KeyActions.Ignore;
}
}
}
if (data != null && data.IsCommitCharacter (descriptor.KeyChar, PartialWord)) {
var curword = PartialWord;
var match = FindMatchedEntry (curword).Index;
if (match >= 0 && System.Char.IsPunctuation (descriptor.KeyChar)) {
string text = ((CompletionData)dataList [filteredItems [match]]).CompletionText;
if (!text.StartsWith (curword, StringComparison.OrdinalIgnoreCase))
match = -1;
}
if (SelectionEnabled && CompletionCharacters.CompleteOn (descriptor.KeyChar)) {
if (descriptor.KeyChar == '{' && !AutoCompleteEmptyMatchOnCurlyBrace && string.IsNullOrEmpty (CompletionString))
return KeyActions.CloseWindow | KeyActions.Process;
return KeyActions.Complete | KeyActions.Process | KeyActions.CloseWindow;
}
return KeyActions.CloseWindow | KeyActions.Process;
}
if ((char.IsWhiteSpace (descriptor.KeyChar) || char.IsPunctuation (descriptor.KeyChar) || descriptor.KeyChar == '(' || descriptor.KeyChar == '<' || descriptor.KeyChar == '[') && SelectedItem == null)
return KeyActions.CloseWindow | KeyActions.Process;
return KeyActions.Process;
}
public void PostProcessKeyEvent (KeyDescriptor descriptor)
{
if (dataList == null)
return;
KeyActions ka = KeyActions.None;
bool keyHandled = false;
foreach (var handler in dataList.KeyHandler) {
if (handler.PostProcessKey (listWindow, descriptor, out ka)) {
keyHandled = true;
break;
}
}
if (!keyHandled)
ka = PostProcessKey (descriptor);
if ((ka & KeyActions.Complete) != 0)
CompleteWord (ref ka, descriptor);
UpdateLastWordChar ();
if ((ka & KeyActions.CloseWindow) != 0) {
HideWindow ();
}
}
public KeyActions PostProcessKey (KeyDescriptor descriptor)
{
if (CompletionWidget == null) {// CompletionWidget == null may happen in unit tests.
return KeyActions.CloseWindow | KeyActions.Process;
}
switch (descriptor.SpecialKey) {
case SpecialKey.BackSpace:
ResetSizes ();
UpdateWordSelection ();
return KeyActions.Process;
}
var keyChar = descriptor.KeyChar;
if (keyChar == '[' && CloseOnSquareBrackets) {
return KeyActions.Process | KeyActions.CloseWindow;
}
if (char.IsLetterOrDigit (keyChar) || keyChar == '_') {
ResetSizes ();
UpdateWordSelection ();
return KeyActions.Process;
}
if (SelectedItemIndex < 0) {
return KeyActions.Process;
}
var data = dataList [SelectedItemIndex];
if (descriptor.KeyChar == ':') {
foreach (var item in filteredItems) {
if (dataList [item].DisplayText.EndsWith (descriptor.KeyChar.ToString (), StringComparison.Ordinal)) {
SelectedItemIndex = item;
return KeyActions.Complete | KeyActions.CloseWindow | KeyActions.Ignore;
}
}
}
if (descriptor.SpecialKey == SpecialKey.None) {
ResetSizes ();
UpdateWordSelection ();
}
if (!char.IsLetterOrDigit(descriptor.KeyChar)) {
var selectedItem = SelectedItemIndex;
if (selectedItem < 0 || selectedItem >= dataList.Count)
return KeyActions.CloseWindow | KeyActions.Process;
}
return KeyActions.Process;
}
public bool CompleteWord ()
{
KeyActions ka = KeyActions.None;
return CompleteWord (ref ka, KeyDescriptor.Tab);
}
internal bool IsInCompletion { get; set; }
public CodeCompletionContext CodeCompletionContext { get; set; }
public bool CompleteWord (ref KeyActions ka, KeyDescriptor descriptor)
{
if (SelectedItemIndex == -1 || dataList == null)
return false;
var item = dataList [SelectedItemIndex];
if (item == null)
return false;
IsInCompletion = true;
try {
// first close the completion list, then insert the text.
// this is required because that's the logical event chain, otherwise things could be messed up
CloseCompletionList ();
/* var cdItem = (CompletionData)item;
cdItem.InsertCompletionText (this, ref ka, closeChar, keyChar, modifier);
AddWordToHistory (PartialWord, cdItem.CompletionText);
OnWordCompleted (new CodeCompletionContextEventArgs (CompletionWidget, CodeCompletionContext, cdItem.CompletionText));
*/
if (item.HasOverloads && declarationViewWindow != null && declarationViewWindow.CurrentOverload >= 0 && declarationViewWindow.CurrentOverload < item.OverloadedData.Count) {
item.OverloadedData [declarationViewWindow.CurrentOverload].InsertCompletionText (listWindow, ref ka, descriptor);
} else {
item.InsertCompletionText (listWindow, ref ka, descriptor);
}
cache.CommitCompletionData (item);
OnWordCompleted (new CodeCompletionContextEventArgs (completionWidget, item.DisplayText));
} finally {
IsInCompletion = false;
HideWindow ();
}
return true;
}
CompletionSelectionStatus FindMatchedEntry (string partialWord)
{
if (dataList == null)
return CompletionSelectionStatus.Empty;
return dataList.FindMatchedEntry (dataList, cache, partialWord, filteredItems);
}
public void UpdateWordSelection ()
{
UpdateLastWordChar ();
SelectEntry (CurrentPartialWord);
}
void UpdateLastWordChar ()
{
if (CompletionWidget != null)
EndOffset = Math.Max (StartOffset, CompletionWidget.CaretOffset);
}
void SelectEntry (string s)
{
var match = FindMatchedEntry (s);
SelectEntry (match);
}
void SelectEntry (CompletionSelectionStatus match)
{
if (match.IsSelected.HasValue)
AutoSelect = match.IsSelected.Value;
if (match.Index >= 0)
// Don't use ViewIndexToItemIndex() to convert from match index to item index.
// Indices in 'match' are always relative to the filteredItems list.
SelectedItemIndex = filteredItems [match.Index];
UpdateDeclarationView ();
}
bool completionListClosed;
void CloseCompletionList ()
{
if (!completionListClosed) {
dataList.OnCompletionListClosed (EventArgs.Empty);
completionListClosed = true;
}
}
public void ResetSizes ()
{
UpdateLastWordChar ();
CompletionString = PartialWord;
view.ResetSizes ();
}
public void ToggleCategoryMode ()
{
IdeApp.Preferences.EnableCompletionCategoryMode.Set (!IdeApp.Preferences.EnableCompletionCategoryMode.Value);
ResetSizes ();
}
void UpdateCategoryMode ()
{
if (view.InCategoryMode != InCategoryMode) {
view.InCategoryMode = InCategoryMode;
if (InCategoryMode) {
// Select the first item in the first category
if (string.IsNullOrEmpty (CompletionString) && IdeApp.Preferences.EnableCompletionCategoryMode)
SelectedItemIndex = filteredCategories.First ().Items.First ();
}
}
}
void MoveToCategory (int relative)
{
var currentCategory = SelectedItem?.CompletionCategory;
int current = filteredCategories.FindIndex (c => c.CompletionCategory == currentCategory);
int next = Math.Min (filteredCategories.Count - 1, Math.Max (0, current + relative));
if (next < 0 || next >= filteredCategories.Count)
return;
CategorizedCompletionItems newCategory = filteredCategories[next];
SelectedItemIndex = newCategory.Items[0];
}
#region IListDataProvider
int IListDataProvider.ItemCount {
get { return dataList != null ? dataList.Count : 0; }
}
string IListDataProvider.GetText (int n)
{
return dataList [n].DisplayText;
}
int [] IListDataProvider.GetHighlightedTextIndices (int n)
{
return dataList.GetHighlightedIndices (dataList [n], CompletionString);
}
string IListDataProvider.GetDescription (int n, bool isSelected)
{
return ((CompletionData)dataList [n]).GetDisplayDescription (isSelected);
}
string IListDataProvider.GetRightSideDescription (int n, bool isSelected)
{
return ((CompletionData)dataList [n]).GetRightSideDescription (isSelected);
}
bool IListDataProvider.HasMarkup (int n)
{
return true;
}
//NOTE: we only ever return markup for items marked as obsolete
string IListDataProvider.GetMarkup (int n)
{
var completionData = dataList [n];
return completionData.GetDisplayTextMarkup ();
}
string IListDataProvider.GetCompletionText (int n)
{
return ((CompletionData)dataList [n]).CompletionText;
}
CompletionData IListDataProvider.GetCompletionData (int n)
{
return dataList [n];
}
int IListDataProvider.CompareTo (int n, int m)
{
return MonoDevelop.Ide.CodeCompletion.CompletionDataList.CompareTo (dataList, n, m);
}
Xwt.Drawing.Image IListDataProvider.GetIcon (int n)
{
string iconName = ((CompletionData)dataList [n]).Icon;
if (string.IsNullOrEmpty (iconName))
return null;
return ImageService.GetIcon (iconName, Gtk.IconSize.Menu);
}
#endregion
void ICompletionViewEventSink.OnDoubleClick ()
{
CompleteWord ();
HideWindow ();
}
void ICompletionViewEventSink.OnListScrolled ()
{
HideDeclarationView ();
UpdateDeclarationView ();
}
void ICompletionViewEventSink.OnPreviewCompletionEntryChanged (string text)
{
CompletionString = previewCompletionEntryText = text;
UpdateWordSelection ();
}
void ICompletionViewEventSink.OnPreviewCompletionEntryActivated ()
{
CompleteWord ();
}
void ICompletionViewEventSink.OnPreviewCompletionEntryLostFocus ()
{
Dispose ();
}
bool ICompletionViewEventSink.OnPreProcessPreviewCompletionEntryKey (KeyDescriptor descriptor)
{
var keyAction = PreProcessKey (descriptor);
if (keyAction.HasFlag (KeyActions.Complete))
CompleteWord ();
if (keyAction.HasFlag (KeyActions.CloseWindow)) {
Dispose ();
}
return keyAction.HasFlag (KeyActions.Process);
}
void ICompletionViewEventSink.OnAllocationChanged ()
{
UpdateDeclarationView ();
}
void ICompletionViewEventSink.OnSelectedItemChanged ()
{
OnSelectionChanged ();
UpdateDeclarationView ();
}
}
}
|