scala3-presentation-compiler
DocsAPI
Generated with
Copyright (c) 2002-2024, LAMP/EPFL
Copyright (c) 2002-2024, LAMP/EPFL
scala3-presentation-compiler/dotty.tools.pc

dotty.tools.pc

package dotty.tools.pc

Members list

Packages

package dotty.tools.pc.buildinfo
package dotty.tools.pc.completions
package dotty.tools.pc.printer
package dotty.tools.pc.utils

Type members

Classlikes

object AutoImports

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final class AutoImportsProvider(search: SymbolSearch, driver: InteractiveDriver, name: String, params: OffsetParams, config: PresentationCompilerConfig, buildTargetIdentifier: String)(using x$7: ReportContext)

Attributes

Supertypes
class Object
trait Matchable
class Any
class CachingDriver(val settings: List[String]) extends InteractiveDriver

CachingDriver is a wrapper class that provides a compilation cache for InteractiveDriver. CachingDriver skips running compilation if

CachingDriver is a wrapper class that provides a compilation cache for InteractiveDriver. CachingDriver skips running compilation if

  • the target URI of run is the same as the previous target URI
  • the content didn't change since the last compilation.

This compilation cache enables Metals to skip compilation and re-use the typed tree under the situation like developers sequentially hover on the symbols in the same file without any changes.

Note: we decided to cache only if the target URI is the same as in the previous run because of InteractiveDriver.currentCtx that should return the context that refers to the last compiled source file. It would be ideal if we could update currentCtx even when we skip the compilation, but we struggled to do that. See the discussion https://github.com/scalameta/metals/pull/4225#discussion_r941138403 To avoid the complexity related to currentCtx, we decided to cache only when the target URI only if the same as the previous run.

Attributes

Supertypes
class InteractiveDriver
class Driver
class Object
trait Matchable
class Any
class CompilerSearchVisitor(visitSymbol: Symbol => Boolean)(using ctx: Context, reports: ReportContext) extends SymbolSearchVisitor

Attributes

Supertypes
class Object
trait Matchable
class Any
object CompletionItemResolver extends ItemResolver

Attributes

Supertypes
trait ItemResolver
class Object
trait Matchable
class Any
Self type
final class ConvertToNamedArgumentsProvider(driver: InteractiveDriver, params: OffsetParams, argIndices: Set[Int])

Attributes

Supertypes
class Object
trait Matchable
class Any
case class DefinitionTree(tree: ValDef, pos: SourcePosition)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EndMarker(symbol: Symbol)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EndMarker

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
EndMarker.type
case class ExtensionParamOccurence(name: Name, pos: SourcePosition, sym: Symbol, methods: List[Tree])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final class ExtractMethodProvider(range: RangeParams, extractionPos: OffsetParams, driver: InteractiveDriver, search: SymbolSearch, noIndent: Boolean)(using x$6: ReportContext) extends ExtractMethodUtils

Attributes

Supertypes
class Object
trait Matchable
class Any
object HoverProvider

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ImplicitConversion

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ImplicitParameters

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait IndexedContext

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Empty
class LazyWrapper
object IndexedContext

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class InferExpectedType(search: SymbolSearch, driver: InteractiveDriver, params: OffsetParams)(implicit rc: ReportContext)

Attributes

Supertypes
class Object
trait Matchable
class Any
object InferredType

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final class InferredTypeProvider(params: OffsetParams, driver: InteractiveDriver, config: PresentationCompilerConfig, symbolSearch: SymbolSearch)(using x$5: ReportContext)

Tries to calculate edits needed to insert the inferred type annotation in all the places that it is possible such as:

Tries to calculate edits needed to insert the inferred type annotation in all the places that it is possible such as:

  • value or variable declaration
  • methods
  • pattern matches
  • for comprehensions
  • lambdas

The provider will not check if the type does not exist, since there is no way to get that data from the presentation compiler. The actual check is being done via scalameta parser in InsertInferredType code action.

Value parameters

config

presentation compielr configuration

driver

Scala 3 interactive compiler driver

params

position and actual source

Attributes

Supertypes
class Object
trait Matchable
class Any
object InterCompletionType

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object MetalsInteractive

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class Occurence(tree: Tree, parent: Option[Tree], pos: SourcePosition)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Params(labels: Seq[String], kind: Kind)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Params

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Params.type
trait PcCollector[T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SimpleCollector[T]
object Collector
Show all
Self type
object PcCollector

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class PcDefinitionProvider(driver: InteractiveDriver, params: OffsetParams, search: SymbolSearch)

Attributes

Supertypes
class Object
trait Matchable
class Any
final class PcDocumentHighlightProvider(driver: InteractiveDriver, params: OffsetParams) extends WithSymbolSearchCollector[DocumentHighlight]

Attributes

Supertypes
class WithSymbolSearchCollector[DocumentHighlight]
trait PcCollector[DocumentHighlight]
class Object
trait Matchable
class Any
Show all
class PcInlayHintsProvider(driver: InteractiveDriver, params: InlayHintsParams, symbolSearch: SymbolSearch)(using x$4: ReportContext)

Attributes

Supertypes
class Object
trait Matchable
class Any
final class PcInlineValueProviderImpl(driver: InteractiveDriver, val params: OffsetParams) extends WithSymbolSearchCollector[Option[Occurence]], InlineValueProvider

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
class PcReferencesProvider(driver: InteractiveDriver, request: ReferencesRequest) extends WithCompilationUnit, PcCollector[Option[(String, Option[Range])]]

Attributes

Supertypes
trait PcCollector[Option[(String, Option[Range])]]
class Object
trait Matchable
class Any
final class PcRenameProvider(driver: InteractiveDriver, params: OffsetParams, name: Option[String]) extends WithSymbolSearchCollector[TextEdit]

Attributes

Supertypes
class WithSymbolSearchCollector[TextEdit]
trait PcCollector[TextEdit]
class Object
trait Matchable
class Any
Show all
final class PcSemanticTokensProvider(driver: InteractiveDriver, params: VirtualFileParams)

Provides semantic tokens of file(@param params) according to the LSP specification.

Provides semantic tokens of file(@param params) according to the LSP specification.

Attributes

Supertypes
class Object
trait Matchable
class Any
trait PcSymbolSearch

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
Self type
object PcSymbolSearch

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class Scala3CompilerAccess(config: PresentationCompilerConfig, sh: Option[ScheduledExecutorService], newCompiler: () => Scala3CompilerWrapper)(using ec: ExecutionContextExecutor, rc: ReportContext) extends CompilerAccess[StoreReporter, InteractiveDriver]

Attributes

Supertypes
class CompilerAccess[StoreReporter, InteractiveDriver]
class Object
trait Matchable
class Any
class Scala3CompilerWrapper(driver: InteractiveDriver) extends CompilerWrapper[StoreReporter, InteractiveDriver]

Attributes

Supertypes
trait CompilerWrapper[StoreReporter, InteractiveDriver]
class Object
trait Matchable
class Any
case class ScalaPresentationCompiler(buildTargetIdentifier: String, buildTargetName: Option[String], classpath: Seq[Path], options: List[String], search: SymbolSearch, ec: ExecutionContextExecutor, sh: Option[ScheduledExecutorService], config: PresentationCompilerConfig, folderPath: Option[Path], reportsLevel: ReportLevel, completionItemPriority: CompletionItemPriority) extends PresentationCompiler

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ScriptFirstImportPosition

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object SelectDynamicExtractor

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
class SelectionRangeProvider(driver: InteractiveDriver, params: List[OffsetParams])

Provides the functionality necessary for the textDocument/selectionRange request.

Provides the functionality necessary for the textDocument/selectionRange request.

Value parameters

compiler

Metals Global presentation compiler wrapper.

params

offset params converted from the selectionRange params.

Attributes

Supertypes
class Object
trait Matchable
class Any
object SemanticdbSymbols

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
class SemanticdbTextDocumentProvider(driver: InteractiveDriver, workspace: Option[Path]) extends WorksheetSemanticdbProvider

Attributes

Supertypes
class Object
trait Matchable
class Any
object SignatureHelpProvider

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
abstract class SimpleCollector[T](driver: InteractiveDriver, params: VirtualFileParams) extends WithCompilationUnit, PcCollector[T]

Attributes

Supertypes
trait PcCollector[T]
class Object
trait Matchable
class Any
Known subtypes
object Collector
class SymbolInformationProvider(using x$1: Context)

Attributes

Supertypes
class Object
trait Matchable
class Any
object SymbolProvider

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object TastyUtils

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
TastyUtils.type
object TypeParameters

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ValueOf

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
ValueOf.type
class WithCompilationUnit(val driver: InteractiveDriver, params: VirtualFileParams)

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SimpleCollector[T]
object Collector
Show all
abstract class WithSymbolSearchCollector[T](driver: InteractiveDriver, params: OffsetParams) extends WithCompilationUnit, PcSymbolSearch, PcCollector[T]

Attributes

Supertypes
trait PcCollector[T]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait WorksheetSemanticdbProvider

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
Generated with
Copyright (c) 2002-2024, LAMP/EPFL
Copyright (c) 2002-2024, LAMP/EPFL