scala.tools.nsc.ast.parser.Scanners

SourceFileScanner

class SourceFileScanner extends Scanner

A scanner for a given source file not necessarily attached to a compilation unit. Useful for looking inside source files that aren not currently compiled to see what's there

Source
Scanners.scala
Linear Supertypes
Scanner, Scanners.ScannerCommon, TokenData, Scanners.CommonTokenData, CharArrayReader, AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SourceFileScanner
  2. Scanner
  3. ScannerCommon
  4. TokenData
  5. CommonTokenData
  6. CharArrayReader
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SourceFileScanner(source: SourceFile)

Type Members

  1. class CharArrayLookaheadReader extends CharArrayReader

    Definition Classes
    CharArrayReader

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

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

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. 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.

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

    Definition Classes
    Scanner
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. var base: Int

    the base of a number

    the base of a number

    Definition Classes
    TokenData
  11. val buf: Array[Char]

    Definition Classes
    SourceFileScannerCharArrayReader
  12. def buildDocs: Boolean

    Should doc comments be built?

    Should doc comments be built?

    Definition Classes
    Scanner
  13. val cbuf: collection.mutable.StringBuilder

    A character buffer for literals

    A character buffer for literals

    Definition Classes
    Scanner
  14. var ch: Char

    the last read character

    the last read character

    Definition Classes
    CharArrayReader
  15. 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

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

    Definition Classes
    Scanner
  16. var charOffset: Int

    The offset one past the last read character

    The offset one past the last read character

    Definition Classes
    CharArrayReader
  17. def charVal: Char

    Convert current strVal to char value

    Convert current strVal to char value

    Definition Classes
    Scanner
  18. def checkNoLetter(): Unit

    Definition Classes
    Scanner
  19. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  20. def copyFrom(td: TokenData): Unit

    Definition Classes
    TokenData
  21. val decodeUni: Boolean

    Definition Classes
    SourceFileScannerCharArrayReader
  22. def deprecationWarning(off: Offset, msg: String): Unit

    Definition Classes
    SourceFileScannerScannerCommon
  23. def deprecationWarning(msg: String): Unit

    Definition Classes
    Scanner
  24. var docBuffer: StringBuilder

    buffer for the documentation comment

    buffer for the documentation comment

    Definition Classes
    Scanner
  25. var docPos: Global.Position

    Definition Classes
    Scanner
  26. def ensuring(cond: (SourceFileScanner) ⇒ Boolean, msg: ⇒ Any): SourceFileScanner

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

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

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

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

    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  32. var errOffset: Offset

    the last error offset

    the last error offset

    Definition Classes
    Scanner
  33. def error(off: Offset, msg: String): Unit

    An error routine to call on bad unicode escapes \\uxxxx.

    An error routine to call on bad unicode escapes \\uxxxx.

    Definition Classes
    SourceFileScannerScannerCommonCharArrayReader
  34. final def fetchToken(): Unit

    read next token, filling TokenData fields of Scanner.

    read next token, filling TokenData fields of Scanner.

    Attributes
    protected
    Definition Classes
    Scanner
  35. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  36. def floatVal: Double

    Definition Classes
    Scanner
  37. def floatVal(negated: Boolean): Double

    Convert current strVal, base to double value

    Convert current strVal, base to double value

    Definition Classes
    Scanner
  38. def flush: Scanner

    Definition Classes
    Scanner
  39. def flushDoc: Global.DocComment

    Return current docBuffer and set docBuffer to null

    Return current docBuffer and set docBuffer to null

    Definition Classes
    Scanner
  40. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from SourceFileScanner to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  41. def foundComment(value: String, start: Int, end: Int): Unit

    Attributes
    protected
    Definition Classes
    Scanner
  42. def foundDocComment(value: String, start: Int, end: Int): Unit

    Attributes
    protected
    Definition Classes
    Scanner
  43. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  44. 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
    Definition Classes
    Scanner
  45. 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
    Definition Classes
    Scanner
  46. def getNumber(): Unit

    Read a number into strVal and set base

    Read a number into strVal and set base

    Attributes
    protected
    Definition Classes
    Scanner
  47. def hashCode(): Int

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

    overridden in UnitScanners

    overridden in UnitScanners

    Definition Classes
    Scanner
  49. def inFirstOfStat(token: Int): Boolean

    Can token start a statement?

    Can token start a statement?

    Definition Classes
    Scanner
  50. def inLastOfStat(token: Int): Boolean

    Can token end a statement?

    Can token end a statement?

    Definition Classes
    Scanner
  51. def incompleteInputError(off: Offset, msg: String): Unit

    Definition Classes
    SourceFileScannerScannerCommon
  52. def incompleteInputError(msg: String): Unit

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

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

    Definition Classes
    Scanner
  53. def init(): Unit

    Initialization method: read first char, then first token

    Initialization method: read first char, then first token

    Definition Classes
    Scanner
  54. def intVal: Long

    Definition Classes
    Scanner
  55. def intVal(negated: Boolean): Long

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

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

    Definition Classes
    Scanner
  56. def invalidEscape(): Unit

    Attributes
    protected
    Definition Classes
    Scanner
  57. def isAtEnd: Boolean

    Definition Classes
    Scanner
  58. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  59. def isUnicodeEscape: Boolean

    Is last character a unicode escape \\uxxxx?

    Is last character a unicode escape \\uxxxx?

    Definition Classes
    CharArrayReader
  60. 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
    CharArrayReader
  61. var lastOffset: 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
  62. var lineStartOffset: Int

    The start offset of the current line

    The start offset of the current line

    Definition Classes
    CharArrayReader
  63. 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
  64. var name: Global.TermName

    the name of an identifier

    the name of an identifier

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

    Definition Classes
    AnyRef
  66. val next: TokenData

    we need one token lookahead and one token history

    we need one token lookahead and one token history

    Definition Classes
    Scanner
  67. 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
  68. 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
  69. def nextToken(): Unit

    Produce next token, filling TokenData fields of Scanner.

    Produce next token, filling TokenData fields of Scanner.

    Definition Classes
    Scanner
  70. def nextTokenAllow(name: Global.Name): Unit

    Get next token, and allow the otherwise deprecated ident name

    Get next token, and allow the otherwise deprecated ident name

    Definition Classes
    Scanner
  71. final def notify(): Unit

    Definition Classes
    AnyRef
  72. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  73. var offset: Offset

    the offset of the first character of the current token

    the offset of the first character of the current token

    Definition Classes
    TokenData
  74. def parenBalance(token: Int): Int

    overridden in UnitScanners

    overridden in UnitScanners

    Definition Classes
    Scanner
  75. val prev: TokenData

    Definition Classes
    Scanner
  76. def putChar(c: Char): Unit

    append Unicode character to "cbuf" buffer

    append Unicode character to "cbuf" buffer

    Attributes
    protected
    Definition Classes
    Scanner
  77. def putDocChar(c: Char): Unit

    add the given character to the documentation buffer

    add the given character to the documentation buffer

    Attributes
    protected
    Definition Classes
    Scanner
  78. def resume(lastCode: Int): Unit

    Definition Classes
    Scanner
  79. var sepRegions: List[Int]

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

    Definition Classes
    Scanner
  80. def skipToken(): Offset

    read next token and return last offset

    read next token and return last offset

    Definition Classes
    Scanner
  81. val source: SourceFile

  82. var strVal: String

    the string value of a literal

    the string value of a literal

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

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

    generate an error at the current token offset

    generate an error at the current token offset

    Definition Classes
    Scanner
  85. def syntaxError(off: Offset, msg: String): Unit

    generate an error at the given offset

    generate an error at the given offset

    Definition Classes
    Scanner
  86. def toString(): String

    Definition Classes
    Scanner → AnyRef → Any
  87. var token: Int

    the next token

    the next token

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  91. def warning(off: Offset, msg: String): Unit

    Definition Classes
    SourceFileScannerScannerCommon
  92. def [B](y: B): (SourceFileScanner, B)

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

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from SourceFileScanner to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sourceFileScanner: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from SourceFileScanner to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sourceFileScanner: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: SourceFileScanner

    Implicit information
    This member is added by an implicit conversion from SourceFileScanner to ArrowAssoc[SourceFileScanner] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sourceFileScanner: ArrowAssoc[SourceFileScanner]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: SourceFileScanner

    Implicit information
    This member is added by an implicit conversion from SourceFileScanner to Ensuring[SourceFileScanner] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sourceFileScanner: Ensuring[SourceFileScanner]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Scanner

Inherited from Scanners.ScannerCommon

Inherited from TokenData

Inherited from Scanners.CommonTokenData

Inherited from CharArrayReader

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SourceFileScanner to StringAdd

Inherited by implicit conversion any2stringfmt from SourceFileScanner to StringFormat

Inherited by implicit conversion any2ArrowAssoc from SourceFileScanner to ArrowAssoc[SourceFileScanner]

Inherited by implicit conversion any2Ensuring from SourceFileScanner to Ensuring[SourceFileScanner]

Ungrouped