abstract class Scanner extends CharArrayReader with TokenData with ScannerData with ScannerCommon with DocScanner
- Alphabetic
- By Inheritance
- Scanner
- DocScanner
- ScannerCommon
- ScannerData
- TokenData
- CommonTokenData
- CharArrayReader
- CharArrayReaderData
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Scanner()
Type Members
- class CharArrayLookaheadReader extends CharArrayReader
- Definition Classes
- CharArrayReader
Abstract Value Members
- abstract val buf: Array[Char]
- Definition Classes
- CharArrayReader
- abstract def deprecationWarning(off: Scanners.Offset, msg: String, since: String, actions: List[CodeAction] = Nil): Unit
- Definition Classes
- ScannerCommon
- abstract def error(off: Scanners.Offset, msg: String): Unit
- Definition Classes
- ScannerCommon
- abstract def incompleteInputError(off: Scanners.Offset, msg: String): Unit
- Definition Classes
- ScannerCommon
- abstract def unit: Global.CompilationUnit
- abstract def warning(off: Scanners.Offset, msg: String, category: WarningCategory): Unit
- Definition Classes
- ScannerCommon
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Scanner, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def adjustSepRegions(lastToken: Scanners.Token): Unit
- 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.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val base: Int
the base of a number
the base of a number
- Definition Classes
- TokenData
- def beginDocComment(prefix: String): Unit
- Attributes
- protected
- Definition Classes
- DocScanner
- val bidiChars: ListBuffer[(Int, Int)]
- Definition Classes
- CharArrayReader
- val cbuf: java.lang.StringBuilder
A character buffer for literals
- val ch: Char
the last read character
the last read character
- Definition Classes
- CharArrayReaderData
- val charOffset: Int
The offset one past the last read character
The offset one past the last read character
- Definition Classes
- CharArrayReaderData
- def charVal: Char
Convert current strVal to char value.
- def checkNoLetter(): Unit
- Annotations
- @inline()
- def checkNoTrailingSeparator(): Unit
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def copyFrom(sd: ScannerData): Scanner.this.type
- Definition Classes
- ScannerData
- def copyFrom(td: TokenData): Scanner.this.type
- Definition Classes
- TokenData
- def copyFrom(cd: CharArrayReaderData): Scanner.this.type
- Definition Classes
- CharArrayReaderData
- def deprecationWarning(msg: String, since: String, actions: List[CodeAction]): Unit
- def deprecationWarning(msg: String, since: String): Unit
- 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
- def doubleVal: Double
- Annotations
- @inline()
- def doubleVal(negated: Boolean): Double
Convert current strVal, base to double value.
- 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
macroorthen, which are planned to become keywords in future versions of Scala.- Attributes
- protected
- def ensuring(cond: (Scanner) => Boolean, msg: => Any): Scanner
- def ensuring(cond: (Scanner) => Boolean): Scanner
- def ensuring(cond: Boolean, msg: => Any): Scanner
- def ensuring(cond: Boolean): Scanner
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def fetchToken(): Unit
read next token, filling TokenData fields of Scanner.
read next token, filling TokenData fields of Scanner.
- Attributes
- protected
- Annotations
- @tailrec()
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def finishDocComment(): Unit
- Attributes
- protected
- Definition Classes
- DocScanner
- def floatVal: Float
- Annotations
- @inline()
- def floatVal(negated: Boolean): Float
Convert current strVal, base to float value.
- def flushDoc(): Global.DocComment
- Definition Classes
- DocScanner
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- 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
- def getNumber(): Unit
Read a number into strVal.
Read a number into strVal.
The
basecan be 2, 10 or 16.- Attributes
- protected
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def healBraces(): List[BracePatch]
overridden in UnitScanners
- def inFirstOfStat(token: Scanners.Token): Boolean
Can token start a statement?
- def inLastOfStat(token: Scanners.Token): Boolean
Can token end a statement?
- def incompleteInputError(msg: String): Unit
signal an error where the input ended in the middle of a token
- def init(): Unit
Initialization method: read first char, then first token
- def intVal: Long
- Annotations
- @inline()
- 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.
- def invalidEscape(): Unit
- Attributes
- protected
- def invalidUnicodeEscape(n: Int): Unit
- Attributes
- protected
- def isAtEnd: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isTrailingComma(right: Scanners.Token): Boolean
- 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
- 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
- val lineStartOffset: Int
The start offset of the current line
The start offset of the current line
- Definition Classes
- CharArrayReaderData
- 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
- def lookingAhead[A](body: => A): A
- val name: Global.TermName
the name of an identifier
the name of an identifier
- Definition Classes
- TokenData → CommonTokenData
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val next: TokenData
we need one token lookahead and one token history
we need one token lookahead and one token history
- Definition Classes
- ScannerData
- 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
- 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
- def nextToken(): Unit
Produce next token, filling TokenData fields of Scanner.
Produce next token, filling TokenData fields of Scanner.
- Definition Classes
- Scanner → ScannerCommon
- def nextTokenAllow(name: Global.Name): Unit
Get next token, and allow the otherwise deprecated ident
name - final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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
- def parenBalance(token: Scanners.Token): Int
overridden in UnitScanners
- def postProcessToken(): Unit
- val prev: TokenData
- Definition Classes
- ScannerData
- def processCommentChar(): Unit
- Attributes
- protected
- Definition Classes
- DocScanner
- def putChar(c: Char): Unit
append Unicode character to "cbuf" buffer
append Unicode character to "cbuf" buffer
- Attributes
- protected
- final def putCommentChar(): Unit
- Attributes
- protected
- def registerDocComment(raw: String, pos: Global.Position): Unit
- Definition Classes
- DocScanner
- def resume(lastCode: Scanners.Token): Unit
- 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).
- 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.
- final def skipComment(): Boolean
Returns true if a comment was skipped.
Returns true if a comment was skipped.
- Note
Pre-condition: ch == '/'
- final def skipNestedComments(): Unit
- Annotations
- @tailrec()
- def skipToken(): Scanners.Offset
read next token and return last offset
- def skipTrailingComma(right: Scanners.Token): Boolean
- Definition Classes
- Scanner → ScannerCommon
- val strVal: String
the string value of a literal
the string value of a literal
- Definition Classes
- TokenData
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def syntaxError(msg: String): Unit
generate an error at the current token offset
- def syntaxError(off: Scanners.Offset, msg: String): Unit
generate an error at the given offset
- def toString(): String
- Definition Classes
- Scanner → AnyRef → Any
- val token: Scanners.Token
the next token
the next token
- Definition Classes
- TokenData → CommonTokenData
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.
The Scala compiler and reflection APIs.