/
ModuleAttribute.java
1364 lines (1203 loc) · 59.5 KB
/
ModuleAttribute.java
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
package org.elixir_lang.annonator;
import com.intellij.lang.ASTNode;
import com.intellij.lang.annotation.AnnotationHolder;
import com.intellij.lang.annotation.Annotator;
import com.intellij.openapi.editor.colors.EditorColorsManager;
import com.intellij.openapi.editor.colors.TextAttributesKey;
import com.intellij.openapi.editor.markup.TextAttributes;
import com.intellij.openapi.project.DumbAware;
import com.intellij.openapi.util.TextRange;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiRecursiveElementVisitor;
import com.intellij.psi.tree.TokenSet;
import org.elixir_lang.ElixirSyntaxHighlighter;
import org.elixir_lang.errorreport.Logger;
import org.elixir_lang.psi.*;
import org.elixir_lang.psi.call.Call;
import org.elixir_lang.psi.impl.ElixirPsiImplUtil;
import org.elixir_lang.psi.operation.Infix;
import org.elixir_lang.psi.operation.Match;
import org.elixir_lang.psi.operation.Type;
import org.elixir_lang.psi.operation.When;
import org.jetbrains.annotations.NotNull;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import static org.elixir_lang.psi.call.name.Function.UNQUOTE;
import static org.elixir_lang.psi.call.name.Module.KERNEL;
import static org.elixir_lang.psi.impl.ElixirPsiImplUtil.identifierName;
import static org.elixir_lang.psi.impl.ElixirPsiImplUtil.stripAccessExpression;
import static org.elixir_lang.reference.ModuleAttribute.*;
import static org.elixir_lang.structure_view.element.CallDefinitionHead.stripAllOuterParentheses;
/**
* Annotates module attributes.
*/
public class ModuleAttribute implements Annotator, DumbAware {
/*
* Public Instance Methods
*/
/**
* Annotates the specified PSI element.
* It is guaranteed to be executed in non-reentrant fashion.
* I.e there will be no call of this method for this instance before previous call get completed.
* Multiple instances of the annotator might exist simultaneously, though.
*
* @param element to annotate.
* @param holder the container which receives annotations created by the plugin.
*/
@Override
public void annotate(@NotNull final PsiElement element, @NotNull final AnnotationHolder holder) {
element.accept(
new PsiRecursiveElementVisitor() {
/*
*
* Instance Methods
*
*/
/*
* Public Instance Methods
*/
@Override
public void visitElement(@NotNull final PsiElement element) {
if (element instanceof AtNonNumericOperation) {
visitMaybeUsage((AtNonNumericOperation) element);
} else if (element instanceof AtUnqualifiedNoParenthesesCall) {
visitDeclaration((AtUnqualifiedNoParenthesesCall) element);
}
}
/*
* Private Instance Methods
*/
private void visitDeclaration(@NotNull final AtUnqualifiedNoParenthesesCall atUnqualifiedNoParenthesesCall) {
ElixirAtIdentifier atIdentifier = atUnqualifiedNoParenthesesCall.getAtIdentifier();
TextRange textRange = atIdentifier.getTextRange();
String identifier = identifierName(atIdentifier);
if (isCallbackName(identifier)) {
highlight(textRange, holder, ElixirSyntaxHighlighter.MODULE_ATTRIBUTE);
highlightCallback(atUnqualifiedNoParenthesesCall, holder);
} else if (isDocumentationName(identifier)) {
highlight(textRange, holder, ElixirSyntaxHighlighter.DOCUMENTATION_MODULE_ATTRIBUTE);
highlightDocumentationText(atUnqualifiedNoParenthesesCall, holder);
} else if (isTypeName(identifier)) {
highlight(textRange, holder, ElixirSyntaxHighlighter.MODULE_ATTRIBUTE);
highlightType(atUnqualifiedNoParenthesesCall, holder);
} else if (isSpecificationName(identifier)) {
highlight(textRange, holder, ElixirSyntaxHighlighter.MODULE_ATTRIBUTE);
highlightSpecification(atUnqualifiedNoParenthesesCall, holder);
} else {
highlight(textRange, holder, ElixirSyntaxHighlighter.MODULE_ATTRIBUTE);
}
}
private void visitMaybeUsage(@NotNull final AtNonNumericOperation element) {
PsiElement operand = element.operand();
if (operand != null && !(operand instanceof ElixirAccessExpression)) {
visitUsage(element);
}
}
private void visitUsage(@NotNull final AtNonNumericOperation atNonNumericOperation) {
highlight(
atNonNumericOperation.getTextRange(),
holder,
ElixirSyntaxHighlighter.MODULE_ATTRIBUTE
);
if (!isNonReferencing(atNonNumericOperation) &&
atNonNumericOperation.getReference().resolve() == null) {
holder.createErrorAnnotation(atNonNumericOperation, "Unresolved module attribute");
}
}
}
);
}
/*
* Private Instance Methods
*/
private void cannotHighlightTypes(PsiElement element) {
error("Cannot highlight types", element);
}
private void error(@NotNull String userMessage, PsiElement element) {
Logger.error(this.getClass(), userMessage, element);
}
/**
* Highlights `textRange` with the given `textAttributesKey`.
*
* @param textRange textRange in the document to highlight
* @param annotationHolder the container which receives annotations created by the plugin.
* @param textAttributesKey text attributes to apply to the `node`.
*/
private void highlight(@NotNull final TextRange textRange, @NotNull AnnotationHolder annotationHolder, @NotNull final TextAttributesKey textAttributesKey) {
annotationHolder.createInfoAnnotation(textRange, null).setEnforcedTextAttributes(TextAttributes.ERASE_MARKER);
annotationHolder.createInfoAnnotation(textRange, null).setEnforcedTextAttributes(EditorColorsManager.getInstance().getGlobalScheme().getAttributes(textAttributesKey));
}
private void highlightCallback(@NotNull final AtUnqualifiedNoParenthesesCall atUnqualifiedNoParenthesesCall,
@NotNull final AnnotationHolder annotationHolder) {
highlightSpecification(
atUnqualifiedNoParenthesesCall,
annotationHolder,
ElixirSyntaxHighlighter.CALLBACK,
ElixirSyntaxHighlighter.TYPE
);
}
private void highlightDocumentationText(
@NotNull final AtUnqualifiedNoParenthesesCall atUnqualifiedNoParenthesesCall,
@NotNull final AnnotationHolder holder
) {
PsiElement noParenthesesOneArgument = atUnqualifiedNoParenthesesCall.getNoParenthesesOneArgument();
PsiElement[] grandChildren = noParenthesesOneArgument.getChildren();
if (grandChildren.length == 1) {
PsiElement grandChild = grandChildren[0];
PsiElement[] greatGrandChildren = grandChild.getChildren();
if (greatGrandChildren.length == 1) {
PsiElement greatGrandChild = greatGrandChildren[0];
if (greatGrandChild instanceof ElixirAtomKeyword) {
ElixirAtomKeyword atomKeyword = (ElixirAtomKeyword) greatGrandChild;
String text = atomKeyword.getText();
if (text.equals("false")) {
holder.createWeakWarningAnnotation(
atomKeyword,
"Will make documented invisible to the documentation extraction tools like ExDoc.");
}
} else if (greatGrandChild instanceof Heredoc) {
Heredoc heredoc = (Heredoc) greatGrandChild;
List<HeredocLine> heredocLineList = heredoc.getHeredocLineList();
for (Bodied bodied : heredocLineList) {
Body body = bodied.getBody();
highlightFragments(
heredoc,
body,
holder,
ElixirSyntaxHighlighter.DOCUMENTATION_TEXT
);
}
} else if (greatGrandChild instanceof Line) {
Line line = (Line) greatGrandChild;
Body body = line.getBody();
highlightFragments(
line,
body,
holder,
ElixirSyntaxHighlighter.DOCUMENTATION_TEXT
);
}
}
}
}
/**
* Highlights fragment ASTNodes under `body` that have fragment type from `fragmented.getFragmentType()`.
*
* @param fragmented supplies fragment type
* @param body contains fragments
* @param annotationHolder the container which receives annotations created by the plugin.
* @param textAttributesKey text attributes to apply to the fragments.
*/
private void highlightFragments(@NotNull final Fragmented fragmented,
@NotNull final Body body,
@NotNull AnnotationHolder annotationHolder,
@NotNull final TextAttributesKey textAttributesKey) {
ASTNode bodyNode = body.getNode();
ASTNode[] fragmentNodes = bodyNode.getChildren(
TokenSet.create(fragmented.getFragmentType())
);
for (ASTNode fragmentNode : fragmentNodes) {
highlight(
fragmentNode.getTextRange(),
annotationHolder,
textAttributesKey
);
}
}
/**
* Highlights the function call name as a `ElixirSyntaxHighlighter.SPECIFICATION
*
* @param atUnqualifiedNoParenthesesCall
* @param annotationHolder
*/
private void highlightSpecification(@NotNull final AtUnqualifiedNoParenthesesCall atUnqualifiedNoParenthesesCall,
@NotNull final AnnotationHolder annotationHolder) {
highlightSpecification(
atUnqualifiedNoParenthesesCall,
annotationHolder,
ElixirSyntaxHighlighter.SPECIFICATION,
ElixirSyntaxHighlighter.TYPE
);
}
/**
* Highlights the function name of the declared @type, @typep, or @opaque as an {@link ElixirSyntaxHighlighter.TYPE}
* and the its parameters as {@link ElixirSyntaxHighlighter.TYPE_PARAMETER}.
*/
private void highlightType(@NotNull final AtUnqualifiedNoParenthesesCall atUnqualifiedNoParenthesesCall,
@NotNull final AnnotationHolder annotationHolder) {
PsiElement noParenthesesOneArgument = atUnqualifiedNoParenthesesCall.getNoParenthesesOneArgument();
PsiElement[] grandChildren = noParenthesesOneArgument.getChildren();
if (grandChildren.length == 1) {
PsiElement grandChild = grandChildren[0];
if (grandChild instanceof Match /* Match is invalid. It will be marked by
MatchOperatorInsteadOfTypeOperator inspection as an error */
|| grandChild instanceof Type) {
Infix infix = (Infix) grandChild;
PsiElement leftOperand = infix.leftOperand();
Set<String> typeParameterNameSet = Collections.emptySet();
if (leftOperand instanceof Call) {
Call call = (Call) leftOperand;
PsiElement functionNameElement = call.functionNameElement();
if (functionNameElement != null) {
highlight(
functionNameElement.getTextRange(),
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
if (call instanceof ElixirMatchedUnqualifiedNoArgumentsCall) {
// no arguments, so nothing else to do
} else if (call instanceof ElixirMatchedUnqualifiedParenthesesCall) {
PsiElement[] primaryArguments = call.primaryArguments();
PsiElement[] secondaryArguments = call.secondaryArguments();
/* if there are secondaryArguments, then it is the type parameters as in
`@type quote(type_name)(param1, param2) :: {param1, param2}` */
if (secondaryArguments != null) {
typeParameterNameSet = typeTypeParameterNameSet(secondaryArguments);
highlightTypesAndTypeParameterUsages(
primaryArguments,
/* as stated above, if there are secondary arguments, then the primary arguments are
to quote or some equivalent metaprogramming. */
Collections.<String>emptySet(),
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
highlightTypesAndTypeTypeParameterDeclarations(
secondaryArguments,
typeParameterNameSet,
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
} else if (primaryArguments != null) {
typeParameterNameSet = typeTypeParameterNameSet(primaryArguments);
highlightTypesAndTypeTypeParameterDeclarations(
primaryArguments,
typeParameterNameSet,
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
} else {
cannotHighlightTypes(call);
}
} else {
cannotHighlightTypes(leftOperand);
}
PsiElement rightOperand = infix.rightOperand();
if (rightOperand != null) {
highlightTypesAndTypeParameterUsages(
rightOperand,
typeParameterNameSet,
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
} else if (grandChild instanceof ElixirMatchedUnqualifiedParenthesesCall) {
// seen as `unquote(ast)`, but could also be just the beginning of typing
ElixirMatchedUnqualifiedParenthesesCall matchedUnqualifiedParenthesesCall = (ElixirMatchedUnqualifiedParenthesesCall) grandChild;
if (matchedUnqualifiedParenthesesCall.functionName().equals(UNQUOTE)) {
PsiElement[] secondaryArguments = matchedUnqualifiedParenthesesCall.secondaryArguments();
if (secondaryArguments != null) {
Set<String> typeParameterNameSet = typeTypeParameterNameSet(secondaryArguments);
highlightTypesAndTypeTypeParameterDeclarations(
secondaryArguments,
typeParameterNameSet,
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
} else {
cannotHighlightTypes(matchedUnqualifiedParenthesesCall);
}
} else if (grandChild instanceof QuotableKeywordList) {
QuotableKeywordList quotableKeywordList = (QuotableKeywordList) grandChild;
List<QuotableKeywordPair> quotableKeywordPairList = quotableKeywordList.quotableKeywordPairList();
// occurs when user does `my_type: definition` instead of `my_type :: definition`
if (quotableKeywordPairList.size() == 1) {
QuotableKeywordPair quotableKeywordPair = quotableKeywordPairList.get(0);
Quotable quotableKeywordKey = quotableKeywordPair.getKeywordKey();
if (quotableKeywordKey instanceof ElixirKeywordKey) {
ElixirKeywordKey keywordKey = (ElixirKeywordKey) quotableKeywordKey;
highlight(
keywordKey.getTextRange(),
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
Quotable quotableKeywordValue = quotableKeywordPair.getKeywordValue();
highlightTypesAndTypeParameterUsages(
quotableKeywordValue,
Collections.<String>emptySet(),
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
// Otherwise, allow the normal, non-type highlighting
} else if (grandChild instanceof UnqualifiedNoArgumentsCall) {
// assume it's a type name that is being typed
Call grandChildCall = (Call) grandChild;
PsiElement functionNameElement = grandChildCall.functionNameElement();
if (functionNameElement != null) {
highlight(
functionNameElement.getTextRange(),
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
} else if (grandChild instanceof UnqualifiedNoParenthesesCall) {
/* Pretend that `::` separates the functionNameElement from the arguments, so that
```
@type coefficient non_neg_integer | :qNaN | :sNaN | :inf
```
is retreated like
```
@type coefficient :: non_neg_integer | :qNaN | :sNaN | :inf
```
*/
UnqualifiedNoParenthesesCall unqualifiedNoParenthesesCall = (UnqualifiedNoParenthesesCall) grandChild;
PsiElement functionNameElement = unqualifiedNoParenthesesCall.functionNameElement();
if (functionNameElement != null) {
highlight(
functionNameElement.getTextRange(),
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
highlightTypesAndTypeParameterUsages(
unqualifiedNoParenthesesCall.getNoParenthesesOneArgument(),
Collections.<String>emptySet(),
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
} else {
cannotHighlightTypes(grandChild);
}
}
}
private void highlightTypeError(@NotNull PsiElement element, @NotNull AnnotationHolder annotationHolder, @NotNull String message) {
annotationHolder.createErrorAnnotation(element, message);
}
private void highlightTypesAndTypeTypeParameterDeclarations(ElixirUnmatchedUnqualifiedNoArgumentsCall psiElement,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
String name = psiElement.getText();
TextAttributesKey textAttributesKey;
if (typeParameterNameSet.contains(name)) {
textAttributesKey = ElixirSyntaxHighlighter.TYPE_PARAMETER;
} else {
textAttributesKey = typeTextAttributesKey;
}
highlight(psiElement.getTextRange(), annotationHolder, textAttributesKey);
}
private void highlightTypesAndTypeTypeParameterDeclarations(PsiElement psiElement,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
if (psiElement instanceof ElixirAccessExpression ||
psiElement instanceof ElixirList ||
psiElement instanceof ElixirTuple) {
highlightTypesAndTypeTypeParameterDeclarations(
psiElement.getChildren(),
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof ElixirUnmatchedUnqualifiedNoArgumentsCall) {
highlightTypesAndTypeTypeParameterDeclarations(
(ElixirUnmatchedUnqualifiedNoArgumentsCall) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else {
if (!(psiElement instanceof ElixirAtomKeyword)) {
error("Cannot highlight types and type parameter declarations", psiElement);
}
}
}
private void highlightTypesAndTypeTypeParameterDeclarations(
PsiElement[] psiElements,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
for (PsiElement psiElement : psiElements) {
highlightTypesAndTypeTypeParameterDeclarations(
psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
}
}
/**
* Recursively highlights the types under `atUnqualifiedNoParenthesesCall`.
*
* @param atUnqualifiedNoParenthesesCall
* @param annotationHolder
* @param leftMostFunctionNameTextAttributesKey the {@link ElixirSyntaxHighlighter} {@link TextAttributesKey} for the
* name of the callback, type, or function being declared
* @param leftMostFunctionArgumentsTextAttributesKey the {@link ElixirSyntaxHighlighter} {@link TextAttributesKey} for the
* arguments of the callback, type, or function being declared
*/
private void highlightSpecification(AtUnqualifiedNoParenthesesCall atUnqualifiedNoParenthesesCall,
AnnotationHolder annotationHolder,
TextAttributesKey leftMostFunctionNameTextAttributesKey,
TextAttributesKey leftMostFunctionArgumentsTextAttributesKey) {
PsiElement noParenthesesOneArgument = atUnqualifiedNoParenthesesCall.getNoParenthesesOneArgument();
PsiElement[] grandChildren = noParenthesesOneArgument.getChildren();
if (grandChildren.length == 1) {
PsiElement grandChild = grandChildren[0];
if (grandChild instanceof Type) {
Infix infix = (Infix) grandChild;
PsiElement leftOperand = infix.leftOperand();
if (leftOperand instanceof Call) {
Call call = (Call) leftOperand;
PsiElement functionNameElement = call.functionNameElement();
if (functionNameElement != null) {
highlight(
functionNameElement.getTextRange(),
annotationHolder,
leftMostFunctionNameTextAttributesKey
);
}
PsiElement[] primaryArguments = call.primaryArguments();
if (primaryArguments != null) {
highlightTypesAndTypeParameterUsages(
primaryArguments,
Collections.EMPTY_SET,
annotationHolder,
leftMostFunctionArgumentsTextAttributesKey
);
}
PsiElement[] secondaryArguments = call.secondaryArguments();
if (secondaryArguments != null) {
highlightTypesAndTypeParameterUsages(
secondaryArguments,
Collections.EMPTY_SET,
annotationHolder,
leftMostFunctionArgumentsTextAttributesKey
);
}
}
PsiElement rightOperand = infix.rightOperand();
if (rightOperand != null) {
highlightTypesAndTypeParameterUsages(
rightOperand,
Collections.EMPTY_SET,
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
} else if (grandChild instanceof ElixirMatchedWhenOperation) {
ElixirMatchedWhenOperation matchedWhenOperation = (ElixirMatchedWhenOperation) grandChild;
Set<String> typeParameterNameSet = specificationTypeParameterNameSet(matchedWhenOperation.rightOperand());
PsiElement leftOperand = matchedWhenOperation.leftOperand();
if (leftOperand instanceof Type) {
Type typeOperation = (Type) leftOperand;
PsiElement typeOperationLeftOperand = typeOperation.leftOperand();
PsiElement strippedTypeOperationLeftOperand = null;
if (typeOperationLeftOperand != null) {
strippedTypeOperationLeftOperand = stripAllOuterParentheses(typeOperationLeftOperand);
}
if (strippedTypeOperationLeftOperand instanceof Call) {
Call call = (Call) strippedTypeOperationLeftOperand;
PsiElement functionNameElement = call.functionNameElement();
if (functionNameElement != null) {
highlight(
functionNameElement.getTextRange(),
annotationHolder,
leftMostFunctionNameTextAttributesKey
);
}
PsiElement[] primaryArguments = call.primaryArguments();
if (primaryArguments != null) {
highlightTypesAndTypeParameterUsages(
primaryArguments,
typeParameterNameSet,
annotationHolder,
leftMostFunctionArgumentsTextAttributesKey
);
}
PsiElement[] secondaryArguments = call.secondaryArguments();
if (secondaryArguments != null) {
highlightTypesAndTypeParameterUsages(
secondaryArguments,
typeParameterNameSet,
annotationHolder,
leftMostFunctionArgumentsTextAttributesKey
);
}
} else {
cannotHighlightTypes(strippedTypeOperationLeftOperand);
}
PsiElement matchedTypeOperationRightOperand = typeOperation.rightOperand();
if (matchedTypeOperationRightOperand != null) {
highlightTypesAndTypeParameterUsages(
matchedTypeOperationRightOperand,
typeParameterNameSet,
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
} else {
cannotHighlightTypes(leftOperand);
}
Quotable rightOperand = matchedWhenOperation.rightOperand();
if (rightOperand != null) {
highlightTypesAndSpecificationTypeParameterDeclarations(
rightOperand,
typeParameterNameSet,
annotationHolder,
ElixirSyntaxHighlighter.TYPE
);
}
}
}
}
private void highlightTypesAndSpecificationTypeParameterDeclarations(QuotableKeywordPair quotableKeywordPair,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
PsiElement keywordKey = quotableKeywordPair.getKeywordKey();
if (typeParameterNameSet.contains(keywordKey.getText())) {
highlight(keywordKey.getTextRange(), annotationHolder, ElixirSyntaxHighlighter.TYPE_PARAMETER);
} else {
highlightTypesAndTypeParameterUsages(
keywordKey,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
}
highlightTypesAndTypeParameterUsages(
quotableKeywordPair.getKeywordValue(),
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
}
private void highlightTypesAndSpecificationTypeParameterDeclarations(@NotNull PsiElement psiElement,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
if (psiElement instanceof ElixirAccessExpression ||
psiElement instanceof ElixirKeywords ||
psiElement instanceof ElixirList ||
psiElement instanceof ElixirNoParenthesesKeywords) {
highlightTypesAndSpecificationTypeParameterDeclarations(
psiElement.getChildren(),
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof QuotableKeywordPair) {
highlightTypesAndSpecificationTypeParameterDeclarations(
(QuotableKeywordPair) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof UnqualifiedNoArgumentsCall) {
highlightTypesAndSpecificationTypeParameterDeclarations(
(UnqualifiedNoArgumentsCall) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else {
error("Cannot highlight types and specification type parameter declarations", psiElement);
}
}
private void highlightTypesAndSpecificationTypeParameterDeclarations(PsiElement[] psiElements,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
for (PsiElement psiElement : psiElements) {
highlightTypesAndSpecificationTypeParameterDeclarations(
psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
}
}
private void highlightTypesAndSpecificationTypeParameterDeclarations(
UnqualifiedNoArgumentsCall unqualifiedNoArgumentsCall,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
@SuppressWarnings("unused") TextAttributesKey textAttributesKey) {
if (typeParameterNameSet.contains(unqualifiedNoArgumentsCall.functionName())) {
PsiElement functionNameElement = unqualifiedNoArgumentsCall.functionNameElement();
highlight(
functionNameElement.getTextRange(),
annotationHolder,
ElixirSyntaxHighlighter.TYPE_PARAMETER
);
}
}
private void highlightTypesAndTypeParameterUsages(Arguments arguments,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey textAttributesKey) {
highlightTypesAndTypeParameterUsages(
arguments.arguments(),
typeParameterNameSet,
annotationHolder,
textAttributesKey
);
}
private void highlightTypesAndTypeParameterUsages(ElixirMapOperation mapOperation,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
highlightTypesAndTypeParameterUsages(
mapOperation.getMapArguments(),
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
}
private void highlightTypesAndTypeParameterUsages(@NotNull ElixirMapUpdateArguments mapUpdateArguments,
Set<String> typeParameterNameSet,
@NotNull AnnotationHolder annotationHolder,
@NotNull TextAttributesKey typeTextAttributesKey) {
for (PsiElement child : mapUpdateArguments.getChildren()) {
if (!(child instanceof Operator)) {
highlightTypesAndTypeParameterUsages(
child,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
}
}
}
private void highlightTypesAndTypeParameterUsages(
ElixirStabOperation stabOperation,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
ElixirStabParenthesesSignature stabParenthesesSignature = stabOperation.getStabParenthesesSignature();
if (stabParenthesesSignature != null) {
highlightTypesAndTypeParameterUsages(
stabParenthesesSignature,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else {
ElixirStabNoParenthesesSignature stabNoParenthesesSignatures = stabOperation.getStabNoParenthesesSignature();
if (stabNoParenthesesSignatures != null) {
highlightTypesAndTypeParameterUsages(
stabNoParenthesesSignatures,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
}
}
ElixirStabBody stabBody = stabOperation.getStabBody();
if (stabBody != null) {
highlightTypesAndTypeParameterUsages(
stabBody,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
}
}
private void highlightTypesAndTypeParameterUsages(
ElixirStabParenthesesSignature stabParenthesesSignature,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
PsiElement[] children = stabParenthesesSignature.getChildren();
if (children.length == 1) {
highlightTypesAndTypeParameterUsages(
children[0],
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (children.length == 3) {
highlightTypesAndTypeParameterUsages(
(When) stabParenthesesSignature,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else {
error("Cannot highlight types and type parameter usages", stabParenthesesSignature);
}
}
private void highlightTypesAndTypeParameterUsages(
ElixirStructOperation structOperation,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
highlightTypesAndTypeParameterUsages(
structOperation.getMapArguments(),
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
}
private void highlightTypesAndTypeParameterUsages(
@NotNull Infix infix,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
highlightTypesAndTypeParameterUsages(
infix.leftOperand(),
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
PsiElement rightOperand = infix.rightOperand();
if (rightOperand != null) {
highlightTypesAndTypeParameterUsages(
rightOperand,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
}
}
private void highlightTypesAndTypeParameterUsages(@NotNull PsiElement psiElement,
Set<String> typeParameterNameSet,
AnnotationHolder annotationHolder,
TextAttributesKey typeTextAttributesKey) {
if (psiElement instanceof Arguments) {
highlightTypesAndTypeParameterUsages(
(Arguments) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof AtUnqualifiedNoParenthesesCall) {
/* Occurs in the case of typing a {@code @type name ::} above a {@code @doc <HEREDOC>} and the
{@code @doc <HEREDOC>} is interpreted as the right-operand of {@code ::} */
} else if (psiElement instanceof ElixirAccessExpression ||
psiElement instanceof ElixirAssociationsBase ||
psiElement instanceof ElixirAssociations ||
psiElement instanceof ElixirContainerAssociationOperation ||
psiElement instanceof ElixirKeywordPair ||
psiElement instanceof ElixirKeywords ||
psiElement instanceof ElixirList ||
psiElement instanceof ElixirMapArguments ||
psiElement instanceof ElixirMapConstructionArguments ||
psiElement instanceof ElixirNoParenthesesArguments ||
psiElement instanceof ElixirParentheticalStab ||
psiElement instanceof ElixirStab ||
psiElement instanceof ElixirStabBody ||
psiElement instanceof ElixirStabNoParenthesesSignature ||
psiElement instanceof ElixirTuple) {
highlightTypesAndTypeParameterUsages(
psiElement.getChildren(),
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof BracketOperation ||
psiElement instanceof ElixirAlias ||
psiElement instanceof ElixirAtom ||
psiElement instanceof ElixirAtomKeyword ||
psiElement instanceof ElixirBitString ||
psiElement instanceof ElixirCharToken ||
psiElement instanceof ElixirDecimalWholeNumber ||
psiElement instanceof ElixirKeywordKey ||
/* happens when :: is typed in `@spec` above function clause that uses `do:` */
psiElement instanceof ElixirNoParenthesesKeywords ||
psiElement instanceof ElixirStringLine ||
psiElement instanceof ElixirUnaryNumericOperation ||
psiElement instanceof ElixirVariable) {
// leave normal highlighting
} else if (psiElement instanceof ElixirMapOperation) {
highlightTypesAndTypeParameterUsages(
(ElixirMapOperation) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof ElixirMapUpdateArguments) {
highlightTypesAndTypeParameterUsages(
(ElixirMapUpdateArguments) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof ElixirRelativeIdentifier ||
psiElement instanceof UnqualifiedNoArgumentsCall) {
// highlight entire element
String name = psiElement.getText();
TextAttributesKey textAttributesKey;
if (typeParameterNameSet.contains(name)) {
textAttributesKey = ElixirSyntaxHighlighter.TYPE_PARAMETER;
} else {
textAttributesKey = typeTextAttributesKey;
}
highlight(psiElement.getTextRange(), annotationHolder, textAttributesKey);
} else if (psiElement instanceof ElixirStabParenthesesSignature) {
highlightTypesAndTypeParameterUsages(
(ElixirStabParenthesesSignature) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof ElixirStabOperation) {
highlightTypesAndTypeParameterUsages(
(ElixirStabOperation) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof ElixirStructOperation) {
highlightTypesAndTypeParameterUsages(
(ElixirStructOperation) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof InterpolatedString) {
highlightTypeError(psiElement, annotationHolder, "Strings aren't allowed in types");
} else if (psiElement instanceof When) {
/* NOTE: MUST be before `Infix` as `When` is a subinterface of
`Infix` */
highlightTypesAndTypeParameterUsages(
(When) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof Infix) {
highlightTypesAndTypeParameterUsages(
(Infix) psiElement,
typeParameterNameSet,
annotationHolder,
typeTextAttributesKey
);
} else if (psiElement instanceof QualifiedParenthesesCall) {
highlightTypesAndTypeParameterUsages(
(QualifiedParenthesesCall) psiElement,