CompletionPosition

Type Members

1. case class Arg(ident: MetalsGlobal.Ident, apply: MetalsGlobal.Apply, pos: MetalsGlobal.Position, text: String, completions: MetalsGlobal.CompletionResult) extends MetalsGlobal.CompletionPosition with Product with Serializable

   

2. case class CaseKeyword(selector: MetalsGlobal.Tree, editRange: org.eclipse.lsp4j.Range, pos: MetalsGlobal.Position, text: String, parent: MetalsGlobal.Tree) extends MetalsGlobal.CompletionPosition with Product with Serializable

   

   A case completion showing the valid subtypes of the type being deconstructed.

   A case completion showing the valid subtypes of the type being deconstructed.

   selector

   the match expression being deconstructed or EmptyTree when not in a match expression (for example List(1).foreach { case@@ }.

   editRange

   the range in the original source file enclosing the case keyword being completed. Used as the position of the main text edit of the completion.

   pos

   the position of the completion in the instrumented source file with _CURSOR_ instrumentation.

   text

   the text of the original source file without _CURSOR_.

   parent

   the parent tree node of the pattern match, for example Apply(_, _) when in List(1).foreach { cas@@ }, used as fallback to compute the type of the selector when it's EmptyTree.

3. case class CasePattern(isTyped: Boolean, c: MetalsGlobal.CaseDef, m: MetalsGlobal.Match) extends MetalsGlobal.CompletionPosition with Product with Serializable

   

4. case class Filename(toplevel: MetalsGlobal.DefTree, pkg: MetalsGlobal.PackageDef, pos: MetalsGlobal.Position, editRange: org.eclipse.lsp4j.Range) extends MetalsGlobal.CompletionPosition with Product with Serializable

   

   Completion for the name of a toplevel class, trait or object matching the filename.

   Completion for the name of a toplevel class, trait or object matching the filename.

   Example:

   // src/main/scala/app/UserDatabaseService.scala
   class User@@ // completes "UserDatabaseService"

   toplevel

   the toplevel class, trait or object definition.

   pkg

   the enclosing package definition.

   pos

   the completion position.

   editRange

   the range to replace in the completion.

5. case class InterpolatorScope(lit: MetalsGlobal.Literal, pos: MetalsGlobal.Position, interpolator: MetalsGlobal.InterpolationSplice, text: String) extends MetalsGlobal.CompletionPosition with Product with Serializable

   

   A completion to convert a string literal into a string literal, example "Hello $na@@".

   A completion to convert a string literal into a string literal, example "Hello $na@@".

   When converting a string literal into an interpolator we need to ensure a few cases:

   - escape existing $ characters into $$, which are printed as $$ in order to escape the TextMate snippet syntax. - wrap completed name in curly braces s"Hello ${name}_ when the trailing character can be treated as an identifier part. - insert the leading s interpolator. - place the cursor at the end of the completed name using TextMate $0 snippet syntax.

   lit

   The string literal, includes an instrumented _CURSOR_ that we need to handle.

   pos

   The offset position of the cursor, right below @@_CURSOR_.

   interpolator

   Metadata about this interpolation, the location of the leading dollar character and whether the completed name needs to be wrapped in curly braces.

   text

   The text of the original source code without the instrumented _CURSOR_.

6. case class InterpolatorType(query: String, ident: MetalsGlobal.Ident, literalPart: MetalsGlobal.Literal, cursor: MetalsGlobal.Position, text: String) extends MetalsGlobal.CompletionPosition with Product with Serializable

   

   A completion to select type members inside string interpolators.

   A completion to select type members inside string interpolators.

   Example:

   // before
   s"Hello $name.len@@!"
   // after
   s"Hello ${name.length()$0}"

   query

   the member query, "len" in the example above.

   ident

   the identifier from where we select a member from, "name" above.

   literalPart

   the string literal part of the interpolator trailing the identifier including cursor instrumentation, "len_CURSOR_!" in the example above.

   cursor

   the cursor position where the completion is triggered, @@ in the example above.

   text

   the text of the original source file without _CURSOR_ instrumentation.

7. case class MatchKeyword(prefix: MetalsGlobal.Type, editRange: org.eclipse.lsp4j.Range, pos: MetalsGlobal.Position, text: String) extends MetalsGlobal.CompletionPosition with Product with Serializable

   

   A match keyword completion to generate an exhaustive pattern match for sealed types.

   A match keyword completion to generate an exhaustive pattern match for sealed types.

   prefix

   the type of the qualifier being matched.

8. case class Override(name: MetalsGlobal.Name, t: MetalsGlobal.Template, pos: MetalsGlobal.Position, text: String, start: Int, isCandidate: (MetalsGlobal.Symbol) ⇒ Boolean) extends MetalsGlobal.CompletionPosition with Product with Serializable

   

   An override def completion to implement methods from the supertype.

   An override def completion to implement methods from the supertype.

   name

   the name of the method being completed including the _CURSOR_ suffix.

   t

   the enclosing template for the class/object/trait we are implementing.

   pos

   the position of the completion request, points to _CURSOR_.

   text

   the text of the original source code without _CURSOR_.