Skip to content

Navigate the AST within AnnotatedType and ImportType #13834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 29, 2021
Merged

Navigate the AST within AnnotatedType and ImportType #13834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf7b455
Navigate the AST within AnnotatedType and ImportType
tgodzik Oct 27, 2021
0fec780
Add additional test for annotation completions
tgodzik Oct 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion compiler/src/dotty/tools/dotc/ast/NavigateAST.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ import core.Contexts._
import core.Decorators._
import util.Spans._
import Trees.{MemberDef, DefTree, WithLazyField}
import dotty.tools.dotc.core.Annotations.ConcreteAnnotation
import dotty.tools.dotc.core.Types.AnnotatedType
import dotty.tools.dotc.core.Types.ImportType
import dotty.tools.dotc.core.Types.Type

/** Utility functions to go from typed to untyped ASTs */
// TODO: Handle trees with mixed source files
Expand Down Expand Up @@ -86,6 +90,18 @@ object NavigateAST {
}
bestFit
}
/*
* Annotations trees are located in the Type
*/
def unpackAnnotations(t: Type, path: List[Positioned]): List[Positioned] =
t match {
case ann: AnnotatedType =>
unpackAnnotations(ann.parent, childPath(ann.annot.tree.productIterator, path))
case imp: ImportType =>
childPath(imp.expr.productIterator, path)
case other =>
path
}
def singlePath(p: Positioned, path: List[Positioned]): List[Positioned] =
if (p.span.exists && !(skipZeroExtent && p.span.isZeroExtent) && p.span.contains(span)) {
// FIXME: We shouldn't be manually forcing trees here, we should replace
Expand All @@ -98,7 +114,12 @@ object NavigateAST {
}
childPath(p.productIterator, p :: path)
}
else path
else {
p match {
case t: untpd.TypeTree => unpackAnnotations(t.typeOpt, path)
case _ => path
}
}
singlePath(from, Nil)
}
}
51 changes: 51 additions & 0 deletions language-server/test/dotty/tools/languageserver/CompletionTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -895,4 +895,55 @@ class CompletionTest {
@Test def i12465_hkt_alias: Unit =
code"""???.asInstanceOf[Seq].${m1}""".withSource
.completion(m1, Set())

@Test def i13624_annotType: Unit =
code"""|object Foo{
| class MyAnnotation extends annotation.StaticAnnotation
|}
|class MyAnnotation extends annotation.StaticAnnotation
|class Annotation2(a: String) extends annotation.StaticAnnotation
|val x = 1: @MyAnnot${m1}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering how this is going to work in some more complex cases:

  1. If the used annotation is not visible in the current scope e.g.
val x = 1: @Foo.MyAnnot${m1}
  1. If you chain more than one annotations, e.g.
1: @MyAnnotation1 @MyAnnot${m1}

or

type X = Int @MyAnnotation1 @MyAnnot${m1}
  1. If annotations are nested, e.g.
1: @MyAnnotation2("abc": @MyAnnot${m1})

Could you add some tests for that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added! And surprisingly all of them work 😅

|type X = Int @MyAnnot${m2}
|val y = 1: @Foo.MyAnnot${m3}
|val z = 1: @Foo.MyAnnotation @MyAnno${m4}
|type Y = Int @MyAnnotation @Foo.MyAnnota${m5}
|val w = 1: @Annotation2("abc": @Foo.MyAnnot${m6})
|""".withSource
.completion(
m1,
Set(
("MyAnnotation", Class, "MyAnnotation"),
("MyAnnotation", Module, "MyAnnotation")
)
).completion(
m2,
Set(
("MyAnnotation", Class, "MyAnnotation"),
("MyAnnotation", Module, "MyAnnotation")
)
).completion(
m3,
Set(
("MyAnnotation", Class, "Foo.MyAnnotation"),
("MyAnnotation", Module, "Foo.MyAnnotation")
)
).completion(
m4,
Set(
("MyAnnotation", Class, "MyAnnotation"),
("MyAnnotation", Module, "MyAnnotation")
)
).completion(
m5,
Set(
("MyAnnotation", Class, "Foo.MyAnnotation"),
("MyAnnotation", Module, "Foo.MyAnnotation")
)
).completion(
m6,
Set(
("MyAnnotation", Class, "Foo.MyAnnotation"),
("MyAnnotation", Module, "Foo.MyAnnotation")
)
)
}
8 changes: 6 additions & 2 deletions language-server/test/dotty/tools/languageserver/HoverTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ class HoverTest {

@Test def i4678: Unit = {
code"""class Foo {
| val x: Int = (${m1}1:${m2} ${m3}@annot1 @annot2 @annot3 @annot4 @annot5${m4})
| val x: Int = (${m1}1:${m2} ${m3}@annot1${m4} ${m5}@annot2${m6} ${m7}@annot3${m8} ${m9}@annot4${m10} ${m11}@annot5${m12})
|}
|class annot1 extends scala.annotation.Annotation
|class annot2 extends scala.annotation.Annotation
Expand All @@ -186,7 +186,11 @@ class HoverTest {
|class annot5 extends scala.annotation.Annotation
|""".withSource
.hover(m1 to m2, hoverContent("(1 : Int)"))
.hover(m3 to m4, hoverContent("(1 : Int) @annot1 @annot2 @annot3 @annot4 @annot5"))
.hover(m3 to m4, hoverContent("annot1"))
.hover(m5 to m6, hoverContent("annot2"))
.hover(m7 to m8, hoverContent("annot3"))
.hover(m9 to m10, hoverContent("annot4"))
.hover(m11 to m12, hoverContent("annot5"))
}

@Test def unicodeChar: Unit = {
Expand Down