scala3-compiler-bootstrapped
DocsAPI
Generated with
Copyright (c) 2002-2024, LAMP/EPFL
Copyright (c) 2002-2024, LAMP/EPFL
scala3-compiler-bootstrapped/dotty.tools/dotty.tools.dotc/dotty.tools.dotc.printing/OutlinePrinter

OutlinePrinter

dotty.tools.dotc.printing.OutlinePrinter
See theOutlinePrinter companion object
class OutlinePrinter extends RefinedPrinter

A printer that elides known standard tree forms from the rhs of def and val. Typically used for printing Java trees which elide the rhs. Note that there may still be some differences if you compare before and after pickling.

Attributes

Companion
object
Graph
Supertypes
class PlainPrinter
class Printer
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def isElidableExpr[T <: Untyped](tree: Tree[T]): Boolean
override def paramsText[T <: Untyped](params: ParamClause[T]): Text

Attributes

Definition Classes
def shouldShowInfo(tsym: Symbol): Boolean

print the symbol infos of type params for the fake java constructor

print the symbol infos of type params for the fake java constructor

Attributes

Inherited methods

def Str(str: String, lineRange: LineRange): Str

Attributes

Inherited from:
PlainPrinter
def addParamssText[T <: Untyped](leading: Text, paramss: List[ParamClause[T]]): Text

Attributes

Inherited from:
RefinedPrinter
override def annotText(annot: Annotation): Text

Usual target for Annotation#toText, overridden in RefinedPrinter

Usual target for Annotation#toText, overridden in RefinedPrinter

Attributes

Definition Classes
Inherited from:
RefinedPrinter
def annotsText(sym: Symbol): Text

Attributes

Inherited from:
PlainPrinter
def atPrec(prec: Precedence)(op: => Text): Text

Generate text using op, assuming a given precedence level prec.

Generate text using op, assuming a given precedence level prec.

atPrec vs changePrec

This is to be used when changing precedence inside some sort of parentheses: for instance, to print T[A] use toText(T) ~ '[' ~ atPrec(GlobalPrec) { toText(A) } ~ ']'.

If the presence of the parentheses depends on precedence, inserting them manually is most certainly a bug. Use changePrec instead to generate them exactly when needed.

Attributes

Inherited from:
Printer
def changePrec(prec: Precedence)(op: => Text): Text

Generate text using op, assuming a given precedence level prec. If new level prec is lower than previous level, put text in parentheses.

Generate text using op, assuming a given precedence level prec. If new level prec is lower than previous level, put text in parentheses.

atPrec vs changePrec

To pretty-print A op B, you need something like changePrec(parsing.precedence(op, isType)) { toText(a) ~ op ~ toText(b) } // BUGGY that will insert parentheses around A op B if, for instance, the preceding operator has higher precedence.

But that does not handle infix operators with left- or right- associativity.

If op and op' have the same precedence and associativity, A op B op' C parses as (A op B) op' C if op and op' are left-associative, and as A op (B op' C) if they're right-associative, so we need respectively

val prec = parsing.precedence(op)
// either:
changePrec(prec) { toText(a) ~ op ~ atPrec(prec + 1) { toText(b) } } // for left-associative op and op'
// or:
changePrec(prec) { atPrec(prec + 1) { toText(a) } ~ op ~ toText(b) } // for right-associative op and op'

Attributes

Inherited from:
Printer
def currentPrecedence: Precedence

The current precedence level. When pretty-printing arguments of operator op, currentPrecedence must equal op's precedence level, so that pretty-printing expressions using lower-precedence operators can insert parentheses automatically by calling changePrec.

The current precedence level. When pretty-printing arguments of operator op, currentPrecedence must equal op's precedence level, so that pretty-printing expressions using lower-precedence operators can insert parentheses automatically by calling changePrec.

Attributes

Inherited from:
Printer
def dclText(d: SingleDenotation): Text

Textual representation of single denotation's declaration

Textual representation of single denotation's declaration

Attributes

Inherited from:
PlainPrinter
def dclText(sym: Symbol): Text

Textual representation of symbol's declaration

Textual representation of symbol's declaration

Attributes

Inherited from:
PlainPrinter
def dclsText(syms: List[Symbol], sep: String): Text

Textual representation of all symbols in given list, using dclText for displaying each.

Textual representation of all symbols in given list, using dclText for displaying each.

Attributes

Inherited from:
PlainPrinter
def extendedLocationText(sym: Symbol): Text

A description of sym's location

A description of sym's location

Attributes

Inherited from:
PlainPrinter
override def fullNameString(sym: Symbol): String

The fully qualified name of the symbol

The fully qualified name of the symbol

Attributes

Definition Classes
Inherited from:
RefinedPrinter
def homogenize(tp: Type): Type

Attributes

Inherited from:
PlainPrinter
inline def inContextBracket(inline op: Text): Text

Attributes

Inherited from:
RefinedPrinter
def inPattern(op: => Text): Text

Attributes

Inherited from:
RefinedPrinter
override def kindString(sym: Symbol): String

String representation of symbol's kind.

String representation of symbol's kind.

Attributes

Definition Classes
Inherited from:
RefinedPrinter
def locatedText(sym: Symbol): Text

Textual representation of symbol and its location

Textual representation of symbol and its location

Attributes

Inherited from:
PlainPrinter
def locationText(sym: Symbol): Text

If symbol's owner is a printable class C, the text "in C", otherwise ""

If symbol's owner is a printable class C, the text "in C", otherwise ""

Attributes

Inherited from:
PlainPrinter
override def nameString(name: Name): String

The name, possibly with with namespace suffix if debugNames is set: /L for local names, /V for other term names, /T for type names

The name, possibly with with namespace suffix if debugNames is set: /L for local names, /V for other term names, /T for type names

Attributes

Definition Classes
Inherited from:
RefinedPrinter
def nameString(sym: Symbol): String

The name of the given symbol. If !settings.debug, the original name where expansions of operators are translated back to operator symbol. E.g. $eq => =. If settings.uniqid, adds id.

The name of the given symbol. If !settings.debug, the original name where expansions of operators are translated back to operator symbol. E.g. $eq => =. If settings.uniqid, adds id.

Attributes

Inherited from:
PlainPrinter
def optText[T <: Untyped](tree: List[Tree[T]])(encl: Text => Text): Text

Attributes

Inherited from:
RefinedPrinter
def optText[T <: Untyped](tree: Tree[T])(encl: Text => Text): Text

Attributes

Inherited from:
RefinedPrinter
def optText(name: Name)(encl: Text => Text): Text

Attributes

Inherited from:
RefinedPrinter
override def plain: PlainPrinter

A plain printer without any embellishments

A plain printer without any embellishments

Attributes

Definition Classes
Inherited from:
RefinedPrinter
override def printerContext: Context

The context of all public methods in Printer and subclasses. Overridden in RefinedPrinter.

The context of all public methods in Printer and subclasses. Overridden in RefinedPrinter.

Attributes

Definition Classes
Inherited from:
RefinedPrinter
override def toText(denot: Denotation): Text

Textual representation of denotation

Textual representation of denotation

Attributes

Definition Classes
Inherited from:
RefinedPrinter
override def toText(sym: Symbol): Text

Textual representation, including symbol's kind e.g., "class Foo", "method Bar". If hasMeaninglessName is true, uses the owner's name to disambiguate identity.

Textual representation, including symbol's kind e.g., "class Foo", "method Bar". If hasMeaninglessName is true, uses the owner's name to disambiguate identity.

Attributes

Definition Classes
Inherited from:
RefinedPrinter
override def toText[T <: Untyped](tree: Tree[T]): Text

Textual representation of tree

Textual representation of tree

Attributes

Definition Classes
Inherited from:
RefinedPrinter
override def toText(tp: Type): Text

Textual representation of type

Textual representation of type

Attributes

Definition Classes
Inherited from:
RefinedPrinter
def toText(g: GadtConstraint): Text

Textual representation of a GADT constraint

Textual representation of a GADT constraint

Attributes

Inherited from:
PlainPrinter
def toText(c: OrderingConstraint): Text

Textual representation of a constraint

Textual representation of a constraint

Attributes

Inherited from:
PlainPrinter
def toText(importInfo: ImportInfo): Text

Textual representation of info relating to an import clause

Textual representation of info relating to an import clause

Attributes

Inherited from:
PlainPrinter
def toText(result: SearchResult): Text

Textual representation of implicit search result

Textual representation of implicit search result

Attributes

Inherited from:
PlainPrinter
def toText(cand: Candidate): Text

Textual representation of implicit candidates.

Textual representation of implicit candidates.

Attributes

Inherited from:
PlainPrinter
def toText(pos: SourcePosition): Text

Textual representation of source position

Textual representation of source position

Attributes

Inherited from:
PlainPrinter
def toText(sc: Scope): Text

Textual representation of all definitions in a scope using dclText for each

Textual representation of all definitions in a scope using dclText for each

Attributes

Inherited from:
PlainPrinter
def toText(param: LambdaParam): Text

Textual representation of lambda param

Textual representation of lambda param

Attributes

Inherited from:
PlainPrinter
def toText(annot: Annotation): Text

Textual representation of annotation

Textual representation of annotation

Attributes

Inherited from:
PlainPrinter
def toText(const: Constant): Text

Textual representation of constant

Textual representation of constant

Attributes

Inherited from:
PlainPrinter
def toText(name: Name): Text

The name as a text

The name as a text

Attributes

Inherited from:
PlainPrinter
def toText(elems: Iterable[Showable], sep: String): Text

Render elements alternating with sep string

Render elements alternating with sep string

Attributes

Inherited from:
Printer
def toTextCaptureRef(tp: Type): Text

Textual representation of a reference in a capture set

Textual representation of a reference in a capture set

Attributes

Inherited from:
PlainPrinter
def toTextCaptureSet(cs: CaptureSet): Text

Textual representation of a reference in a capture set

Textual representation of a reference in a capture set

Attributes

Inherited from:
PlainPrinter
override def toTextFlags(sym: Symbol): Text

String representation of symbol's flags

String representation of symbol's flags

Attributes

Definition Classes
Inherited from:
RefinedPrinter
def toTextGlobal(elems: Iterable[Showable], sep: String): Text

Render elements within lowest precedence

Render elements within lowest precedence

Attributes

Inherited from:
Printer
def toTextGlobal(elem: Showable): Text

Render element within lowest precedence

Render element within lowest precedence

Attributes

Inherited from:
Printer
def toTextLocal(elems: Iterable[Showable], sep: String): Text

Render elements within highest precedence

Render elements within highest precedence

Attributes

Inherited from:
Printer
def toTextLocal(elem: Showable): Text

Render element within highest precedence

Render element within highest precedence

Attributes

Inherited from:
Printer
override def toTextPrefixOf(tp: NamedType): Text

The string representation of type prefix, including separator

The string representation of type prefix, including separator

Attributes

Definition Classes
Inherited from:
RefinedPrinter
override def toTextRef(tp: SingletonType): Text

The string representation of this type used as a prefix

The string representation of this type used as a prefix

Attributes

Definition Classes
Inherited from:
RefinedPrinter
def toTextSingleton(tp: SingletonType): Text

Attributes

Inherited from:
PlainPrinter
def withEnclosingDef(enclDef: Tree[_])(op: => Text): Text

Attributes

Inherited from:
RefinedPrinter
def withoutPos(op: => Text): Text

Attributes

Inherited from:
RefinedPrinter

Givens

Inherited givens

given stringToText: Conversion[String, Text]

Attributes

Inherited from:
PlainPrinter

Extensions

Inherited extensions

extension (mdef: DefTree)
def mods: Modifiers

Print modifiers from symbols if tree has type, overriding the behavior in Trees.

Print modifiers from symbols if tree has type, overriding the behavior in Trees.

Attributes

Inherited from:
RefinedPrinter
Generated with
Copyright (c) 2002-2024, LAMP/EPFL
Copyright (c) 2002-2024, LAMP/EPFL