internal

Type Members

class BestFirstSearch extends ScalaFmtLogger

Implements best first search to find optimal formatting.
case class Decision(formatToken: FormatToken, splits: Seq[Split]) extends Product with Serializable

The decision made by Router.
The decision made by Router.
Used by Policy to enforce non-local formatting.
sealed trait ExpiresOn extends AnyRef
case class FormatToken(left: Token, right: Token, between: Vector[Whitespace]) extends ScalaFmtLogger with Product with Serializable

Two adjacent non-whitespace tokens.
Two adjacent non-whitespace tokens.
Consider a FormatToken as a node in a search graph and Split are the edges. The format tokens remain unchanged after formatting, while the splits are changed.
left
The left non-whitespace token.
right
The left non-whitespace token.
between
The whitespace tokens between left and right.
case class Indent[T <: Length](length: T, expire: Token, expiresAt: ExpiresOn) extends Product with Serializable
sealed trait Length extends AnyRef
sealed abstract class Modification extends AnyRef
trait NewlineT extends Modification
case class Num(n: Int) extends Length with Product with Serializable
case class Policy(f: PartialFunction[Decision, Decision], expire: Int, noDequeue: Boolean = false)(implicit line: Line) extends Product with Serializable

The decision made by Router.
The decision made by Router.
Used by Policy to enforce non-local formatting.
f
is applied to every decision until expire
expire
The latest token offset.
class PolicySummary extends ScalaFmtLogger
case class Provided(code: String) extends Modification with Product with Serializable
class Router extends ScalaFmtLogger

Assigns splits to format tokens.
trait ScalaFmtLogger extends AnyRef

Debugging utility.
case class Split(modification: Modification, cost: Int, ignoreIf: Boolean = false, indents: Vector[Indent[Length]] = Vector.empty[Indent[Length]], policy: Policy = NoPolicy, penalty: Boolean = false, optimalAt: Option[Token] = None)(implicit line: Line) extends Product with Serializable

A Split is the whitespace between two non-whitespace tokens.
A Split is the whitespace between two non-whitespace tokens.
Consider a split to be an edge in a search graph and FormatToken are the nodes.
modification
Is this a space, no space, newline or 2 newlines?
cost
How good is this output? Lower is better.
indents
Does this add indentation?
policy
How does this split affect other later splits?
penalty
Does this split overflow the column limit?
line
For debugging, to retrace from which case in Router this split originates.
final case class State(cost: Int, policy: PolicySummary, splits: Vector[Split], indentation: Int, pushes: Vector[Indent[Num]], column: Int) extends Ordered[State] with ScalaFmtLogger with Product with Serializable

A partial formatting solution up to splits.length number of tokens.
type TokenHash = Long

For convenience when experimenting with different hashing strategies.

Value Members

object BestFirstSearch extends ScalaFmtLogger
object Debug extends ScalaFmtLogger

(ugly) Utility to collect data about formatter.
(ugly) Utility to collect data about formatter.
Only used during development.
object FormatToken extends ScalaFmtLogger with Serializable
object Left extends ExpiresOn with Product with Serializable
object Newline extends Modification with NewlineT with Product with Serializable
object Newline2x extends Modification with NewlineT with Product with Serializable
object Newline2xNoIndent extends Modification with NewlineT with Product with Serializable
object NoIndentNewline extends Modification with NewlineT with Product with Serializable
val NoPolicy: Policy
object NoSplit extends Modification with Product with Serializable
object Policy extends Serializable
object PolicySummary
object Right extends ExpiresOn with Product with Serializable
object Space extends Modification with Product with Serializable
object State extends ScalaFmtLogger with Serializable
object StateColumn extends Length with Product with Serializable
def childOf(tok: Token, tree: Tree, owners: Map[TokenHash, Tree]): Boolean
final def childOf(child: Tree, tree: Tree): Boolean

Annotations
@tailrec()
def hash(token: Token): TokenHash

Custom hash code for token.
Custom hash code for token.
The default hashCode is slow because it prevents conflicts between tokens from different source files. We only care about getting a unique identifier for the token inside this source file.
The hash code works like this this: Top 8 bits go to privateTag, a unique identifier for the tokens class. Next 28 bits go to the tokens **start** offset byte. Final 28 bits go to the tokens **end** offset byte.
The only chance for collision is if two empty length tokens with the same type lie next to each other. @xeno-by said this should not happen.

Annotations
@inline()
final def parents(tree: Tree, accum: Seq[Tree] = Seq.empty[Tree]): Seq[Tree]

Annotations
@tailrec()

package internal

Type Members

class BestFirstSearch extends ScalaFmtLogger

case class Decision(formatToken: FormatToken, splits: Seq[Split]) extends Product with Serializable

sealed trait ExpiresOn extends AnyRef

case class FormatToken(left: Token, right: Token, between: Vector[Whitespace]) extends ScalaFmtLogger with Product with Serializable

case class Indent[T <: Length](length: T, expire: Token, expiresAt: ExpiresOn) extends Product with Serializable

sealed trait Length extends AnyRef

sealed abstract class Modification extends AnyRef

trait NewlineT extends Modification

case class Num(n: Int) extends Length with Product with Serializable

case class Policy(f: PartialFunction[Decision, Decision], expire: Int, noDequeue: Boolean = false)(implicit line: Line) extends Product with Serializable

class PolicySummary extends ScalaFmtLogger

case class Provided(code: String) extends Modification with Product with Serializable

class Router extends ScalaFmtLogger

trait ScalaFmtLogger extends AnyRef

case class Split(modification: Modification, cost: Int, ignoreIf: Boolean = false, indents: Vector[Indent[Length]] = Vector.empty[Indent[Length]], policy: Policy = NoPolicy, penalty: Boolean = false, optimalAt: Option[Token] = None)(implicit line: Line) extends Product with Serializable

final case class State(cost: Int, policy: PolicySummary, splits: Vector[Split], indentation: Int, pushes: Vector[Indent[Num]], column: Int) extends Ordered[State] with ScalaFmtLogger with Product with Serializable

type TokenHash = Long

Value Members

object BestFirstSearch extends ScalaFmtLogger

object Debug extends ScalaFmtLogger

object FormatToken extends ScalaFmtLogger with Serializable

object Left extends ExpiresOn with Product with Serializable

object Newline extends Modification with NewlineT with Product with Serializable

object Newline2x extends Modification with NewlineT with Product with Serializable

object Newline2xNoIndent extends Modification with NewlineT with Product with Serializable

object NoIndentNewline extends Modification with NewlineT with Product with Serializable

val NoPolicy: Policy

object NoSplit extends Modification with Product with Serializable

object Policy extends Serializable

object PolicySummary

object Right extends ExpiresOn with Product with Serializable

object Space extends Modification with Product with Serializable

object State extends ScalaFmtLogger with Serializable

object StateColumn extends Length with Product with Serializable

def childOf(tok: Token, tree: Tree, owners: Map[TokenHash, Tree]): Boolean

final def childOf(child: Tree, tree: Tree): Boolean

def hash(token: Token): TokenHash

final def parents(tree: Tree, accum: Seq[Tree] = Seq.empty[Tree]): Seq[Tree]

Inherited from AnyRef

Inherited from Any

Ungrouped