abstract class Scanner extends CharArrayReader with TokenData with ScannerData with ScannerCommon
- Alphabetic
- By Inheritance
- Scanner
- ScannerCommon
- ScannerData
- TokenData
- CommonTokenData
- CharArrayReader
- CharArrayReaderData
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
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): 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
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Scanner, B)
-
final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
-
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
Cast the receiver object to be of type
T0
.Cast the receiver object to be of type
T0
.Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression
1.asInstanceOf[String]
will throw aClassCastException
at runtime, while the expressionList(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
-
var
base: Int
the base of a number
the base of a number
- Definition Classes
- TokenData
-
val
cbuf: collection.mutable.StringBuilder
A character buffer for literals
-
var
ch: Char
the last read character
the last read character
- Definition Classes
- CharArrayReaderData
-
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
-
var
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
-
def
clone(): AnyRef
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the
clone
method is platform dependent.- returns
a copy of the receiver object.
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- Note
not specified by SLS as a member of AnyRef
-
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
decodeUni: Boolean
- Definition Classes
- CharArrayReader
- 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.
-
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
orthen
, 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
Tests whether the argument (
that
) is a reference to the receiver object (this
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
final
def
fetchToken(): Unit
read next token, filling TokenData fields of Scanner.
read next token, filling TokenData fields of Scanner.
- Attributes
- protected
-
def
finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the
finalize
method is invoked, as well as the interaction betweenfinalize
and non-local returns and exceptions, are all platform dependent.- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
- def floatVal: Double
-
def
floatVal(negated: Boolean): Double
Convert current strVal, base to double value
- def flushDoc(): Global.DocComment
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
- Definition Classes
- AnyRef → Any
-
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.
- Attributes
- protected
-
def
getNumber(): Unit
Read a number into strVal.
Read a number into strVal.
The
base
can be 8, 10 or 16, where base 8 flags a leading zero. For ints, base 8 is legal only for the case of exactly one zero.- Attributes
- protected
-
def
hashCode(): Int
The hashCode method for reference types.
-
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
-
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 10 and 16 are supported. As a permanent migration path, attempts to write base 8 literals except
0
emit a verbose error. -
def
invalidEscape(): Unit
- Attributes
- protected
- def isAtEnd: Boolean
-
final
def
isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is
T0
.Test whether the dynamic type of the receiver object is
T0
.Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression
1.isInstanceOf[String]
will returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
-
def
isUnicodeEscape: Boolean
Is last character a unicode escape \\uxxxx?
Is last character a unicode escape \\uxxxx?
- Definition Classes
- CharArrayReader
-
var
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
-
var
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
-
var
lastUnicodeOffset: Int
- Attributes
- protected
- Definition Classes
- CharArrayReaderData
-
var
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
-
var
name: Global.TermName
the name of an identifier
the name of an identifier
- Definition Classes
- TokenData → CommonTokenData
-
final
def
ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
.- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- 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.
-
def
nextTokenAllow(name: Global.Name): Unit
Get next token, and allow the otherwise deprecated ident
name
-
final
def
notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Note
not specified by SLS as a member of AnyRef
-
final
def
notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Note
not specified by SLS as a member of AnyRef
-
var
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
-
val
prev: TokenData
- Definition Classes
- ScannerData
-
def
putChar(c: Char): Unit
append Unicode character to "cbuf" buffer
append Unicode character to "cbuf" buffer
- Attributes
- protected
-
def
putCommentChar(): Unit
- Attributes
- protected
- 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 skipBlockComment(): Unit
- def skipComment(): Boolean
- def skipDocComment(): Unit
-
final
def
skipNestedComments(): Unit
- Annotations
- @tailrec()
-
def
skipToken(): Scanners.Offset
read next token and return last offset
-
var
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
Creates a String representation of this object.
-
var
token: Scanners.Token
the next token
the next token
- Definition Classes
- TokenData → CommonTokenData
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def →[B](y: B): (Scanner, B)
The Scala compiler API.
The following resources are useful for Scala plugin/compiler development: