mtags

Type Members

1. final class ClasspathLoader extends AnyRef

   

   Utility to load relative paths from a classpath.

   Utility to load relative paths from a classpath.

   Provides similar functionality as URLClassLoader but uses idiomatic Scala data structures like AbsolutePath and Option[T] instead of java.net.URL and nulls.

2. trait GlobalSymbolIndex extends AnyRef

   

   An index to lookup the definition of global symbols.

   An index to lookup the definition of global symbols.

   Only indexes plain Scala and Java source files, no compilation needed.

3. final class Identifier extends AnyRef

   

4. case class IndexError(file: io.AbsolutePath, cause: Throwable) extends Exception with NoStackTrace with Product with Serializable

   

5. case class InvalidJarException(path: io.AbsolutePath, underlying: Throwable) extends Exception with Product with Serializable

   

6. class JavaMtags extends MtagsIndexer

   

7. trait Md5Fingerprints extends AnyRef

   

   Maps MD5 fingerprints to full text contents.

8. final class Mtags extends AnyRef

   

9. trait MtagsEnrichments extends AnyRef

   

10. trait MtagsIndexer extends AnyRef

    

11. final case class OnDemandSymbolIndex(toplevels: TrieMap[String, io.AbsolutePath] = TrieMap.empty, definitions: TrieMap[String, io.AbsolutePath] = TrieMap.empty, onError: PartialFunction[Throwable, Unit] = PartialFunction.empty) extends GlobalSymbolIndex with Product with Serializable

    

    An implementation of GlobalSymbolIndex with fast indexing and low memory usage.

    An implementation of GlobalSymbolIndex with fast indexing and low memory usage.

    Fast indexing is enabled by ScalaToplevelMtags, a custom parser that extracts only toplevel symbols from a Scala source file. Java source files don't need indexing because their file location can be inferred from the symbol with the limitation that it doesn't work for Java source files with multiple package-private top-level classes.

    Low memory usage is enabled by only storing "non-trivial toplevel" symbols. A symbol is "toplevel" when its owner is a package. A symbol is "non-trivial" when it doesn't match the path of the file it's defined in, for example Some# in Option.scala is non-trivial while Option# in Option.scala is trivial.

    toplevels

    keys are non-trivial toplevel symbols and values are the file the symbols are defined in.

    definitions

    keys are global symbols and the values are the files the symbols are defined in. Difference between toplevels and definitions is that toplevels contains only symbols generated by ScalaToplevelMtags while definitions contains only symbols generated by ScalaMtags.

12. final class OpenClassLoader extends URLClassLoader

    

13. final class OverloadDisambiguator extends AnyRef

    

    Utility to generate method symbol disambiguators according to SemanticDB spec.

    Utility to generate method symbol disambiguators according to SemanticDB spec.

    See https://scalameta.org/docs/semanticdb/specification.html#scala-symbol

14. class ScalaMtags extends SimpleTraverser with MtagsIndexer

    

15. class ScalaToplevelMtags extends MtagsIndexer

    

    Custom parser that extracts toplevel members from a Scala source file.

    Custom parser that extracts toplevel members from a Scala source file.

    Example input:

    package com.zoo
    class Animal { class Dog }
    object Park { trait Bench }

    emits the following symbols: com/zoo/Animal# and com/zoo/Park. The inner classes Animal.Dog and Park.Bench are ignored.

    This class exists for performance reasons. The ScalaMtags indexer provides the same functionality but it is much slower. Performance is important because toplevel symbol indexing is on a critical path when users import a new project.

16. final case class SemanticdbClasspath(sourceroot: meta.AbsolutePath, classpath: meta.Classpath = Classpath(Nil), charset: Charset = StandardCharsets.UTF_8, fingerprints: Md5Fingerprints = Md5Fingerprints.empty) extends Semanticdbs with Product with Serializable

    

17. trait Semanticdbs extends AnyRef

    

18. final class Symbol extends AnyRef

    

    Represents a unique definitions such as a Scala val, object, class, or Java field/method.

    Represents a unique definitions such as a Scala val, object, class, or Java field/method.

    Examples:

    "scala/Predef.String#"
    "scala/collection/immutable/`::`#"
    "scala/Option#get()."
    "scala/Option.apply()."

19. case class SymbolDefinition(querySymbol: Symbol, definitionSymbol: Symbol, path: io.AbsolutePath) extends Product with Serializable

    

20. sealed abstract class TextDocumentLookup extends AnyRef