class ScaladocUnitScanner extends UnitScanner with ScaladocScanner

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScaladocUnitScanner
  2. ScaladocScanner
  3. UnitScanner
  4. SourceFileScanner
  5. Scanner
  6. DocScanner
  7. ScannerCommon
  8. ScannerData
  9. TokenData
  10. CommonTokenData
  11. CharArrayReader
  12. CharArrayReaderData
  13. AnyRef
  14. 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 ScaladocUnitScanner(unit0: G.CompilationUnit, patches0: List[BracePatch])

Type Members

  1. class CharArrayLookaheadReader extends CharArrayReader
    Definition Classes
    CharArrayReader

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 ScaladocUnitScanner to any2stringadd[ScaladocUnitScanner] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ScaladocUnitScanner, B)
    Implicit
    This member is added by an implicit conversion from ScaladocUnitScanner to ArrowAssoc[ScaladocUnitScanner] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def applyBracePatch(): Boolean

    Insert or delete a brace, if a patch exists for this offset

    Insert or delete a brace, if a patch exists for this offset

    Definition Classes
    UnitScanner → Scanner
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val base: Int

    the base of a number

    the base of a number

    Definition Classes
    TokenData
  9. def beginDocComment(prefix: String): Unit
    Attributes
    protected
    Definition Classes
    ScaladocScanner → DocScanner
  10. val bidiChars: ListBuffer[(Int, Int)]
    Definition Classes
    CharArrayReader
  11. val buf: Array[Char]
    Definition Classes
    SourceFileScanner → CharArrayReader
  12. val cbuf: java.lang.StringBuilder

    A character buffer for literals

    A character buffer for literals

    Definition Classes
    Scanner
  13. val ch: Char

    the last read character

    the last read character

    Definition Classes
    CharArrayReaderData
  14. 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
  15. val charOffset: Int

    The offset one past the last read character

    The offset one past the last read character

    Definition Classes
    CharArrayReaderData
  16. def charVal: Char

    Convert current strVal to char value

    Convert current strVal to char value

    Definition Classes
    Scanner
  17. def checkNoLetter(): Unit
    Definition Classes
    Scanner
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. def copyFrom(sd: ScaladocSyntaxAnalyzer.ScannerData): ScaladocUnitScanner.this.type
    Definition Classes
    ScannerData
  20. def copyFrom(td: ScaladocSyntaxAnalyzer.TokenData): ScaladocUnitScanner.this.type
    Definition Classes
    TokenData
  21. def copyFrom(cd: CharArrayReaderData): ScaladocUnitScanner.this.type
    Definition Classes
    CharArrayReaderData
  22. val decodeUni: Boolean
    Definition Classes
    SourceFileScanner → CharArrayReader
  23. def deprecationWarning(off: ScaladocSyntaxAnalyzer.Offset, msg: String, since: String): Unit
    Definition Classes
    UnitScanner → SourceFileScanner → ScannerCommon
  24. def deprecationWarning(msg: String, since: String): Unit
    Definition Classes
    Scanner
  25. def discardDocBuffer(): Unit

    Warn when discarding buffered doc at the end of a block.

    Warn when discarding buffered doc at the end of a block. This mechanism doesn't warn about arbitrary unmoored doc. Also warn under -Xlint, but otherwise only warn in the presence of suspicious tags that appear to be documenting API. Warnings are suppressed while parsing the local comment so that comments of the form [at] Martin will not trigger a warning. By omission, tags for see, todo, note and example are ignored.

    Definition Classes
    ScaladocUnitScanner → DocScanner
  26. def docPosition: G.Position
    Attributes
    protected
    Definition Classes
    ScaladocUnitScanner → ScaladocScanner
  27. def doubleVal: Double
    Definition Classes
    Scanner
  28. def doubleVal(negated: Boolean): Double

    Convert current strVal, base to double value.

    Convert current strVal, base to double value.

    Definition Classes
    Scanner
  29. 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
    Definition Classes
    Scanner
  30. def ensuring(cond: (ScaladocUnitScanner) ⇒ Boolean, msg: ⇒ Any): ScaladocUnitScanner
    Implicit
    This member is added by an implicit conversion from ScaladocUnitScanner to Ensuring[ScaladocUnitScanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. def ensuring(cond: (ScaladocUnitScanner) ⇒ Boolean): ScaladocUnitScanner
    Implicit
    This member is added by an implicit conversion from ScaladocUnitScanner to Ensuring[ScaladocUnitScanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  32. def ensuring(cond: Boolean, msg: ⇒ Any): ScaladocUnitScanner
    Implicit
    This member is added by an implicit conversion from ScaladocUnitScanner to Ensuring[ScaladocUnitScanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  33. def ensuring(cond: Boolean): ScaladocUnitScanner
    Implicit
    This member is added by an implicit conversion from ScaladocUnitScanner to Ensuring[ScaladocUnitScanner] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  34. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  36. def error(off: ScaladocSyntaxAnalyzer.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
    UnitScanner → SourceFileScanner → ScannerCommon → CharArrayReader
  37. 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
  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. def finishDocComment(): Unit
    Attributes
    protected
    Definition Classes
    ScaladocScanner → DocScanner
  40. def floatVal: Float
    Definition Classes
    Scanner
  41. def floatVal(negated: Boolean): Float

    Convert current strVal, base to float value.

    Convert current strVal, base to float value.

    Definition Classes
    Scanner
  42. def flushDoc(): G.DocComment
    Definition Classes
    DocScanner
  43. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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.

    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
    Definition Classes
    Scanner
  47. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  48. def healBraces(): List[BracePatch]

    overridden in UnitScanners

    overridden in UnitScanners

    Definition Classes
    UnitScanner → Scanner
  49. def inFirstOfStat(token: ScaladocSyntaxAnalyzer.Token): Boolean

    Can token start a statement?

    Can token start a statement?

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

    Can token end a statement?

    Can token end a statement?

    Definition Classes
    Scanner
  51. def incompleteInputError(off: ScaladocSyntaxAnalyzer.Offset, msg: String): Unit
    Definition Classes
    UnitScanner → SourceFileScanner → ScannerCommon
  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.

    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.

    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. 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
  61. val lastOffset: ScaladocSyntaxAnalyzer.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. val lastUnicodeOffset: Int
    Attributes
    protected
    Definition Classes
    CharArrayReaderData
  63. val lineStartOffset: Int

    The start offset of the current line

    The start offset of the current line

    Definition Classes
    CharArrayReaderData
  64. 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
  65. val name: G.TermName

    the name of an identifier

    the name of an identifier

    Definition Classes
    TokenData → CommonTokenData
  66. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  67. val next: ScaladocSyntaxAnalyzer.TokenData

    we need one token lookahead and one token history

    we need one token lookahead and one token history

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

    Produce next token, filling TokenData fields of Scanner.

    Produce next token, filling TokenData fields of Scanner.

    Definition Classes
    Scanner → ScannerCommon
  71. def nextTokenAllow(name: G.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
  72. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  73. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  74. val offset: ScaladocSyntaxAnalyzer.Offset

    the offset of the first character of the current token

    the offset of the first character of the current token

    Definition Classes
    TokenData
  75. def parenBalance(token: ScaladocSyntaxAnalyzer.Token): Int

    overridden in UnitScanners

    overridden in UnitScanners

    Definition Classes
    UnitScanner → Scanner
  76. lazy val parensAnalyzer: ScaladocSyntaxAnalyzer.ParensAnalyzer
    Definition Classes
    UnitScanner
  77. val prev: ScaladocSyntaxAnalyzer.TokenData
    Definition Classes
    ScannerData
  78. def processCommentChar(): Unit
    Attributes
    protected
    Definition Classes
    ScaladocScanner → DocScanner
  79. def putChar(c: Char): Unit

    append Unicode character to "cbuf" buffer

    append Unicode character to "cbuf" buffer

    Attributes
    protected
    Definition Classes
    Scanner
  80. final def putCommentChar(): Unit
    Attributes
    protected
    Definition Classes
    Scanner
  81. def registerDocComment(raw: String, pos: G.Position): Unit
    Definition Classes
    DocScanner
  82. def resume(lastCode: ScaladocSyntaxAnalyzer.Token): Unit
    Definition Classes
    Scanner
  83. var sepRegions: List[ScaladocSyntaxAnalyzer.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).

    Definition Classes
    Scanner
  84. 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.

    Definition Classes
    Scanner
  85. final def skipComment(): Boolean

    Definition Classes
    Scanner
  86. final def skipNestedComments(): Unit
    Definition Classes
    Scanner
    Annotations
    @tailrec()
  87. def skipToken(): ScaladocSyntaxAnalyzer.Offset

    read next token and return last offset

    read next token and return last offset

    Definition Classes
    Scanner
  88. val source: SourceFile
    Definition Classes
    SourceFileScanner
  89. val strVal: String

    the string value of a literal

    the string value of a literal

    Definition Classes
    TokenData
  90. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  91. def syntaxError(msg: String): Unit

    generate an error at the current token offset

    generate an error at the current token offset

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

    generate an error at the given offset

    generate an error at the given offset

    Definition Classes
    Scanner
  93. def toString(): String
    Definition Classes
    Scanner → AnyRef → Any
  94. val token: ScaladocSyntaxAnalyzer.Token

    the next token

    the next token

    Definition Classes
    TokenData → CommonTokenData
  95. val unit: G.CompilationUnit
    Definition Classes
    UnitScanner
  96. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  97. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  98. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  99. def warning(off: ScaladocSyntaxAnalyzer.Offset, msg: String, category: WarningCategory): Unit
    Definition Classes
    UnitScanner → SourceFileScanner → ScannerCommon
  100. def →[B](y: B): (ScaladocUnitScanner, B)
    Implicit
    This member is added by an implicit conversion from ScaladocUnitScanner to ArrowAssoc[ScaladocUnitScanner] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ScaladocUnitScanner to StringFormat[ScaladocUnitScanner] 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.

Inherited from ScaladocScanner

Inherited from ScaladocSyntaxAnalyzer.UnitScanner

Inherited from ScaladocSyntaxAnalyzer.SourceFileScanner

Inherited from ScaladocSyntaxAnalyzer.Scanner

Inherited from ScaladocSyntaxAnalyzer.DocScanner

Inherited from ScaladocSyntaxAnalyzer.ScannerCommon

Inherited from ScaladocSyntaxAnalyzer.ScannerData

Inherited from ScaladocSyntaxAnalyzer.TokenData

Inherited from ScaladocSyntaxAnalyzer.CommonTokenData

Inherited from CharArrayReader

Inherited from CharArrayReaderData

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped