Class

scala.tools.nsc.ast.parser.Scanners

Scanner

Related Doc: package Scanners

Permalink

abstract class Scanner extends CharArrayReader with TokenData with ScannerData with ScannerCommon

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

Instance Constructors

  1. new Scanner()

    Permalink

Type Members

  1. class CharArrayLookaheadReader extends CharArrayReader

    Permalink
    Definition Classes
    CharArrayReader

Abstract Value Members

  1. abstract val buf: Array[Char]

    Permalink
    Definition Classes
    CharArrayReader
  2. abstract def deprecationWarning(off: Scanners.Offset, msg: String): Unit

    Permalink
    Definition Classes
    ScannerCommon
  3. abstract def error(off: Scanners.Offset, msg: String): Unit

    Permalink
    Definition Classes
    ScannerCommon
  4. abstract def incompleteInputError(off: Scanners.Offset, msg: String): Unit

    Permalink
    Definition Classes
    ScannerCommon

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. 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. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scanner to any2stringadd[Scanner] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Scanner, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scanner to ArrowAssoc[Scanner] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    The expression x == that is equivalent to if (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
  6. def applyBracePatch(): Boolean

    Permalink

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

  7. final def asInstanceOf[T0]: T0

    Permalink

    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 a ClassCastException at runtime, while the expression List(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 type T0.

  8. var base: Int

    Permalink

    the base of a number

    the base of a number

    Definition Classes
    TokenData
  9. val cbuf: collection.mutable.StringBuilder

    Permalink

    A character buffer for literals

  10. var ch: Char

    Permalink

    the last read character

    the last read character

    Definition Classes
    CharArrayReaderData
  11. def charLitOr(op: () ⇒ Unit): Unit

    Permalink

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

  12. var charOffset: Int

    Permalink

    The offset one past the last read character

    The offset one past the last read character

    Definition Classes
    CharArrayReaderData
  13. def charVal: Char

    Permalink

    Convert current strVal to char value

  14. def checkNoLetter(): Unit

    Permalink
  15. def clone(): AnyRef

    Permalink

    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

  16. def copyFrom(sd: ScannerData): Scanner.this.type

    Permalink
    Definition Classes
    ScannerData
  17. def copyFrom(td: TokenData): Scanner.this.type

    Permalink
    Definition Classes
    TokenData
  18. def copyFrom(cd: CharArrayReaderData): Scanner.this.type

    Permalink
    Definition Classes
    CharArrayReaderData
  19. def decodeUni: Boolean

    Permalink
    Definition Classes
    CharArrayReader
  20. def deprecationWarning(msg: String): Unit

    Permalink
  21. def discardDocBuffer(): Unit

    Permalink

    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.

  22. def emitIdentifierDeprecationWarnings: Boolean

    Permalink

    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
  23. def ensuring(cond: (Scanner) ⇒ Boolean, msg: ⇒ Any): Scanner

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scanner to Ensuring[Scanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: (Scanner) ⇒ Boolean): Scanner

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scanner to Ensuring[Scanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean, msg: ⇒ Any): Scanner

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scanner to Ensuring[Scanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: Boolean): Scanner

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scanner to Ensuring[Scanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. final def eq(arg0: AnyRef): Boolean

    Permalink

    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 of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode 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
  28. def equals(arg0: Any): Boolean

    Permalink

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  29. final def fetchToken(): Unit

    Permalink

    read next token, filling TokenData fields of Scanner.

    read next token, filling TokenData fields of Scanner.

    Attributes
    protected
  30. def finalize(): Unit

    Permalink

    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 between finalize 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

  31. def floatVal: Double

    Permalink
  32. def floatVal(negated: Boolean): Double

    Permalink

    Convert current strVal, base to double value

  33. def flushDoc(): Global.DocComment

    Permalink
  34. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scanner to StringFormat[Scanner] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  35. final def getClass(): Class[_]

    Permalink

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  36. def getFraction(): Unit

    Permalink

    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
  37. def getLitChar(): Unit

    Permalink

    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
  38. def getNumber(): Unit

    Permalink

    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
  39. def hashCode(): Int

    Permalink

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
  40. def healBraces(): List[BracePatch]

    Permalink

    overridden in UnitScanners

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

    Permalink

    Can token start a statement?

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

    Permalink

    Can token end a statement?

  43. def incompleteInputError(msg: String): Unit

    Permalink

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

  44. def init(): Unit

    Permalink

    Initialization method: read first char, then first token

  45. def intVal: Long

    Permalink
  46. def intVal(negated: Boolean): Long

    Permalink

    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.

  47. def invalidEscape(): Unit

    Permalink
    Attributes
    protected
  48. def isAtEnd: Boolean

    Permalink
  49. final def isInstanceOf[T0]: Boolean

    Permalink

    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 return false, while the expression List(1).isInstanceOf[List[String]] will return true. 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 type T0; false otherwise.

    Definition Classes
    Any
  50. def isUnicodeEscape: Boolean

    Permalink

    Is last character a unicode escape \\uxxxx?

    Is last character a unicode escape \\uxxxx?

    Definition Classes
    CharArrayReader
  51. var lastLineStartOffset: Int

    Permalink

    The start offset of the line before the current one

    The start offset of the line before the current one

    Definition Classes
    CharArrayReaderData
  52. var lastOffset: Scanners.Offset

    Permalink

    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
  53. var lastUnicodeOffset: Int

    Permalink
    Attributes
    protected
    Definition Classes
    CharArrayReaderData
  54. var lineStartOffset: Int

    Permalink

    The start offset of the current line

    The start offset of the current line

    Definition Classes
    CharArrayReaderData
  55. def lookaheadReader: CharArrayLookaheadReader

    Permalink

    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
  56. var name: Global.TermName

    Permalink

    the name of an identifier

    the name of an identifier

    Definition Classes
    TokenDataCommonTokenData
  57. final def ne(arg0: AnyRef): Boolean

    Permalink

    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
  58. val next: TokenData

    Permalink

    we need one token lookahead and one token history

    we need one token lookahead and one token history

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

    Permalink

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

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

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

    Permalink

    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
  61. def nextToken(): Unit

    Permalink

    Produce next token, filling TokenData fields of Scanner.

  62. def nextTokenAllow(name: Global.Name): Unit

    Permalink

    Get next token, and allow the otherwise deprecated ident name

  63. final def notify(): Unit

    Permalink

    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

  64. final def notifyAll(): Unit

    Permalink

    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

  65. var offset: Scanners.Offset

    Permalink

    the offset of the first character of the current token

    the offset of the first character of the current token

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

    Permalink

    overridden in UnitScanners

  67. val prev: TokenData

    Permalink
    Definition Classes
    ScannerData
  68. def putChar(c: Char): Unit

    Permalink

    append Unicode character to "cbuf" buffer

    append Unicode character to "cbuf" buffer

    Attributes
    protected
  69. def putCommentChar(): Unit

    Permalink
    Attributes
    protected
  70. def resume(lastCode: Scanners.Token): Unit

    Permalink
  71. var sepRegions: List[Scanners.Token]

    Permalink

    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).

  72. def skipBlockComment(): Unit

    Permalink
  73. def skipComment(): Boolean

    Permalink

  74. def skipDocComment(): Unit

    Permalink
  75. final def skipNestedComments(): Unit

    Permalink
    Annotations
    @tailrec()
  76. def skipToken(): Scanners.Offset

    Permalink

    read next token and return last offset

  77. var strVal: String

    Permalink

    the string value of a literal

    the string value of a literal

    Definition Classes
    TokenData
  78. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  79. def syntaxError(msg: String): Unit

    Permalink

    generate an error at the current token offset

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

    Permalink

    generate an error at the given offset

  81. def toString(): String

    Permalink

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    Scanner → AnyRef → Any
  82. var token: Scanners.Token

    Permalink

    the next token

    the next token

    Definition Classes
    TokenDataCommonTokenData
  83. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. def [B](y: B): (Scanner, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scanner to ArrowAssoc[Scanner] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Scanners.ScannerCommon

Inherited from ScannerData

Inherited from TokenData

Inherited from Scanners.CommonTokenData

Inherited from CharArrayReader

Inherited from CharArrayReaderData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Scanner to any2stringadd[Scanner]

Inherited by implicit conversion StringFormat from Scanner to StringFormat[Scanner]

Inherited by implicit conversion Ensuring from Scanner to Ensuring[Scanner]

Inherited by implicit conversion ArrowAssoc from Scanner to ArrowAssoc[Scanner]

Ungrouped