Packages

abstract class Scanner extends CharArrayReader with TokenData with ScannerData with ScannerCommon with DocScanner

Source
Scanners.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Scanner
  2. DocScanner
  3. ScannerCommon
  4. ScannerData
  5. TokenData
  6. CommonTokenData
  7. CharArrayReader
  8. CharArrayReaderData
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Scanner()

Type Members

  1. class CharArrayLookaheadReader extends CharArrayReader
    Definition Classes
    CharArrayReader

Abstract Value Members

  1. abstract val buf: Array[Char]
    Definition Classes
    CharArrayReader
  2. abstract def deprecationWarning(off: Scanners.Offset, msg: String, since: String): Unit
    Definition Classes
    ScannerCommon
  3. abstract def error(off: Scanners.Offset, msg: String): Unit
    Definition Classes
    ScannerCommon
  4. abstract def incompleteInputError(off: Scanners.Offset, msg: String): Unit
    Definition Classes
    ScannerCommon
  5. abstract def warning(off: Scanners.Offset, msg: String, category: WarningCategory): Unit
    Definition Classes
    ScannerCommon

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Scanner toany2stringadd[Scanner] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Scanner, B)
    Implicit
    This member is added by an implicit conversion from Scanner toArrowAssoc[Scanner] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def adjustSepRegions(lastToken: Scanners.Token): Unit
  7. def applyBracePatch(): Boolean

    overridden in UnitScanners: apply brace patch if one exists for this offset return true if subsequent end of line handling should be suppressed.

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val base: Int

    the base of a number

    the base of a number

    Definition Classes
    TokenData
  10. def beginDocComment(prefix: String): Unit
    Attributes
    protected
    Definition Classes
    DocScanner
  11. val cbuf: java.lang.StringBuilder

    A character buffer for literals

  12. val ch: Char

    the last read character

    the last read character

    Definition Classes
    CharArrayReaderData
  13. def charLitOr(op: () => Unit): Unit

    Parse character literal if current character is followed by \', or follow with given op and return a symbol literal token

  14. val charOffset: Int

    The offset one past the last read character

    The offset one past the last read character

    Definition Classes
    CharArrayReaderData
  15. def charVal: Char

    Convert current strVal to char value.

  16. def checkNoLetter(): Unit
    Annotations
    @inline()
  17. def checkNoTrailingSeparator(): Unit
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  19. def copyFrom(sd: ScannerData): Scanner.this.type
    Definition Classes
    ScannerData
  20. def copyFrom(td: TokenData): Scanner.this.type
    Definition Classes
    TokenData
  21. def copyFrom(cd: CharArrayReaderData): Scanner.this.type
    Definition Classes
    CharArrayReaderData
  22. def deprecationWarning(msg: String, since: String): Unit
  23. def discardDocBuffer(): Unit

    To prevent doc comments attached to expressions from leaking out of scope onto the next documentable entity, they are discarded upon passing a right brace, bracket, or parenthesis.

    To prevent doc comments attached to expressions from leaking out of scope onto the next documentable entity, they are discarded upon passing a right brace, bracket, or parenthesis.

    Definition Classes
    DocScanner
  24. def doubleVal: Double
    Annotations
    @inline()
  25. def doubleVal(negated: Boolean): Double

    Convert current strVal, base to double value.

  26. def emitIdentifierDeprecationWarnings: Boolean

    Determines whether this scanner should emit identifier deprecation warnings, e.g.

    Determines whether this scanner should emit identifier deprecation warnings, e.g. when seeing macro or then, which are planned to become keywords in future versions of Scala.

    Attributes
    protected
  27. def ensuring(cond: (Scanner) => Boolean, msg: => Any): Scanner
    Implicit
    This member is added by an implicit conversion from Scanner toEnsuring[Scanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: (Scanner) => Boolean): Scanner
    Implicit
    This member is added by an implicit conversion from Scanner toEnsuring[Scanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: Boolean, msg: => Any): Scanner
    Implicit
    This member is added by an implicit conversion from Scanner toEnsuring[Scanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. def ensuring(cond: Boolean): Scanner
    Implicit
    This member is added by an implicit conversion from Scanner toEnsuring[Scanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  33. final def fetchToken(): Unit

    read next token, filling TokenData fields of Scanner.

    read next token, filling TokenData fields of Scanner.

    Attributes
    protected
    Annotations
    @tailrec()
  34. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  35. def finishDocComment(): Unit
    Attributes
    protected
    Definition Classes
    DocScanner
  36. def floatVal: Float
    Annotations
    @inline()
  37. def floatVal(negated: Boolean): Float

    Convert current strVal, base to float value.

  38. def flushDoc(): Global.DocComment
    Definition Classes
    DocScanner
  39. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. def getFraction(): Unit

    read fractional part and exponent of floating point number if one is present.

    read fractional part and exponent of floating point number if one is present.

    Attributes
    protected
  41. def getLitChar(): Unit

    Copy current character into cbuf, interpreting any escape sequences, and advance to next character.

    Copy current character into cbuf, interpreting any escape sequences, and advance to next character. Surrogate pairs are consumed (see check at fetchSingleQuote), but orphan surrogate is allowed.

    Attributes
    protected
  42. def getNumber(): Unit

    Read a number into strVal.

    Read a number into strVal.

    The base can be 2, 10 or 16.

    Attributes
    protected
  43. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def healBraces(): List[BracePatch]

    overridden in UnitScanners

  45. def inFirstOfStat(token: Scanners.Token): Boolean

    Can token start a statement?

  46. def inLastOfStat(token: Scanners.Token): Boolean

    Can token end a statement?

  47. def incompleteInputError(msg: String): Unit

    signal an error where the input ended in the middle of a token

  48. def init(): Unit

    Initialization method: read first char, then first token

  49. def intVal: Long
    Annotations
    @inline()
  50. def intVal(negated: Boolean): Long

    Convert current strVal, base to long value.

    Convert current strVal, base to long value. This is tricky because of max negative value.

    Conversions in base 2, 10 and 16 are supported. Number separators are skipped on the fly.

  51. def invalidEscape(): Unit
    Attributes
    protected
  52. def invalidUnicodeEscape(n: Int): Unit
    Attributes
    protected
  53. def isAtEnd: Boolean
  54. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  55. def isTrailingComma(right: Scanners.Token): Boolean
  56. val lastLineStartOffset: Int

    The start offset of the line before the current one

    The start offset of the line before the current one

    Definition Classes
    CharArrayReaderData
  57. val lastOffset: Scanners.Offset

    the offset of the character following the token preceding this one

    the offset of the character following the token preceding this one

    Definition Classes
    TokenData
  58. val lineStartOffset: Int

    The start offset of the current line

    The start offset of the current line

    Definition Classes
    CharArrayReaderData
  59. def lookaheadReader: CharArrayLookaheadReader

    A new reader that takes off at the current character position

    A new reader that takes off at the current character position

    Definition Classes
    CharArrayReader
  60. def lookingAhead[A](body: => A): A
  61. val name: Global.TermName

    the name of an identifier

    the name of an identifier

    Definition Classes
    TokenDataCommonTokenData
  62. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  63. val next: TokenData

    we need one token lookahead and one token history

    we need one token lookahead and one token history

    Definition Classes
    ScannerData
  64. final def nextChar(): Unit

    Advance one character; reducing CR;LF pairs to just LF

    Advance one character; reducing CR;LF pairs to just LF

    Definition Classes
    CharArrayReader
  65. final def nextRawChar(): Unit

    Advance one character, leaving CR;LF pairs intact.

    Advance one character, leaving CR;LF pairs intact. This is for use in multi-line strings, so there are no "potential line ends" here.

    Definition Classes
    CharArrayReader
  66. def nextToken(): Unit

    Produce next token, filling TokenData fields of Scanner.

    Produce next token, filling TokenData fields of Scanner.

    Definition Classes
    ScannerScannerCommon
  67. def nextTokenAllow(name: Global.Name): Unit

    Get next token, and allow the otherwise deprecated ident name

  68. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  69. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  70. val offset: Scanners.Offset

    the offset of the first character of the current token

    the offset of the first character of the current token

    Definition Classes
    TokenData
  71. def parenBalance(token: Scanners.Token): Int

    overridden in UnitScanners

  72. def postProcessToken(): Unit
  73. val prev: TokenData
    Definition Classes
    ScannerData
  74. def processCommentChar(): Unit
    Attributes
    protected
    Definition Classes
    DocScanner
  75. def putChar(c: Char): Unit

    append Unicode character to "cbuf" buffer

    append Unicode character to "cbuf" buffer

    Attributes
    protected
  76. final def putCommentChar(): Unit
    Attributes
    protected
  77. def registerDocComment(raw: String, pos: Global.Position): Unit
    Definition Classes
    DocScanner
  78. def resume(lastCode: Scanners.Token): Unit
  79. var sepRegions: List[Scanners.Token]

    a stack of tokens which indicates whether line-ends can be statement separators also used for keeping track of nesting levels.

    a stack of tokens which indicates whether line-ends can be statement separators also used for keeping track of nesting levels. We keep track of the closing symbol of a region. This can be RPAREN if region starts with '(' RBRACKET if region starts with '[' RBRACE if region starts with '{' ARROW if region starts with 'case' STRINGLIT if region is a string interpolation expression starting with '${' (the STRINGLIT appears twice in succession on the stack iff the expression is a multiline string literal).

  80. def skipCASE(): Unit

    Advance beyond a case token without marking the CASE in sepRegions.

    Advance beyond a case token without marking the CASE in sepRegions. This method should be called to skip beyond CASE tokens that are not part of matches, i.e. no ARROW is expected after them.

  81. final def skipComment(): Boolean

    Returns true if a comment was skipped.

    Returns true if a comment was skipped.

    Note

    Pre-condition: ch == '/'

  82. final def skipNestedComments(): Unit
    Annotations
    @tailrec()
  83. def skipToken(): Scanners.Offset

    read next token and return last offset

  84. def skipTrailingComma(right: Scanners.Token): Boolean
    Definition Classes
    ScannerScannerCommon
  85. val strVal: String

    the string value of a literal

    the string value of a literal

    Definition Classes
    TokenData
  86. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  87. def syntaxError(msg: String): Unit

    generate an error at the current token offset

  88. def syntaxError(off: Scanners.Offset, msg: String): Unit

    generate an error at the given offset

  89. def toString(): String
    Definition Classes
    Scanner → AnyRef → Any
  90. val token: Scanners.Token

    the next token

    the next token

    Definition Classes
    TokenDataCommonTokenData
  91. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  92. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  93. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Scanner toStringFormat[Scanner] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def [B](y: B): (Scanner, B)
    Implicit
    This member is added by an implicit conversion from Scanner toArrowAssoc[Scanner] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Scanners.DocScanner

Inherited from Scanners.ScannerCommon

Inherited from ScannerData

Inherited from TokenData

Inherited from CharArrayReader

Inherited from CharArrayReaderData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromScanner to any2stringadd[Scanner]

Inherited by implicit conversion StringFormat fromScanner to StringFormat[Scanner]

Inherited by implicit conversion Ensuring fromScanner to Ensuring[Scanner]

Inherited by implicit conversion ArrowAssoc fromScanner to ArrowAssoc[Scanner]

Ungrouped