class ScaladocUnitScanner extends UnitScanner with ScaladocScanner
- Source
- ScaladocAnalyzer.scala
- Alphabetic
- By Inheritance
- ScaladocUnitScanner
- ScaladocScanner
- UnitScanner
- SourceFileScanner
- Scanner
- DocScanner
- 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 ScaladocUnitScanner(unit0: G.CompilationUnit, patches0: List[BracePatch])
Type Members
-
class
CharArrayLookaheadReader extends CharArrayReader
- Definition Classes
- CharArrayReader
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
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
- ScaladocScanner → DocScanner
-
val
buf: Array[Char]
- Definition Classes
- SourceFileScanner → CharArrayReader
-
val
cbuf: collection.mutable.StringBuilder
A character buffer for literals
A character buffer for literals
- Definition Classes
- Scanner
-
val
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
Parse character literal if current character is followed by \', or follow with given op and return a symbol literal token
- Definition Classes
- Scanner
-
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
Convert current strVal to char value
- Definition Classes
- Scanner
-
def
checkNoLetter(): Unit
- Definition Classes
- Scanner
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
copyFrom(sd: ScaladocSyntaxAnalyzer.ScannerData): ScaladocUnitScanner.this.type
- Definition Classes
- ScannerData
-
def
copyFrom(td: ScaladocSyntaxAnalyzer.TokenData): ScaladocUnitScanner.this.type
- Definition Classes
- TokenData
-
def
copyFrom(cd: CharArrayReaderData): ScaladocUnitScanner.this.type
- Definition Classes
- CharArrayReaderData
-
val
decodeUni: Boolean
- Definition Classes
- SourceFileScanner → CharArrayReader
-
def
deprecationWarning(off: ScaladocSyntaxAnalyzer.Offset, msg: String, since: String): Unit
- Definition Classes
- UnitScanner → SourceFileScanner → ScannerCommon
-
def
deprecationWarning(msg: String, since: String): Unit
- Definition Classes
- Scanner
-
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] Martinwill not trigger a warning. By omission, tags forsee,todo,noteandexampleare ignored.- Definition Classes
- ScaladocUnitScanner → DocScanner
-
def
docPosition: G.Position
- Attributes
- protected
- Definition Classes
- ScaladocUnitScanner → ScaladocScanner
-
def
doubleVal: Double
- Definition Classes
- Scanner
-
def
doubleVal(negated: Boolean): Double
Convert current strVal, base to double value.
Convert current strVal, base to double value.
- Definition Classes
- Scanner
-
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
- Definition Classes
- Scanner
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
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
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
finishDocComment(): Unit
- Attributes
- protected
- Definition Classes
- ScaladocScanner → DocScanner
-
def
floatVal: Float
- Definition Classes
- Scanner
-
def
floatVal(negated: Boolean): Float
Convert current strVal, base to float value.
Convert current strVal, base to float value.
- Definition Classes
- Scanner
-
def
flushDoc(): G.DocComment
- Definition Classes
- DocScanner
-
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
- @inline()
-
final
def
getClass(): Class[_]
- 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
- Definition Classes
- Scanner
-
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
-
def
getNumber(): Unit
Read a number into strVal.
Read a number into strVal.
The
basecan 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
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
healBraces(): List[BracePatch]
overridden in UnitScanners
overridden in UnitScanners
- Definition Classes
- UnitScanner → Scanner
-
def
inFirstOfStat(token: ScaladocSyntaxAnalyzer.Token): Boolean
Can token start a statement?
Can token start a statement?
- Definition Classes
- Scanner
-
def
inLastOfStat(token: ScaladocSyntaxAnalyzer.Token): Boolean
Can token end a statement?
Can token end a statement?
- Definition Classes
- Scanner
-
def
incompleteInputError(off: ScaladocSyntaxAnalyzer.Offset, msg: String): Unit
- Definition Classes
- UnitScanner → SourceFileScanner → ScannerCommon
-
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
-
def
init(): Unit
Initialization method: read first char, then first token
Initialization method: read first char, then first token
- Definition Classes
- Scanner
-
def
intVal: Long
- Definition Classes
- Scanner
-
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
0emit a verbose error.- Definition Classes
- Scanner
-
def
invalidEscape(): Unit
- Attributes
- protected
- Definition Classes
- Scanner
-
def
isAtEnd: Boolean
- Definition Classes
- Scanner
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isUnicodeEscape: Boolean
Is last character a unicode escape \\uxxxx?
Is last character a unicode escape \\uxxxx?
- Definition Classes
- CharArrayReader
-
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: 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
-
val
lastUnicodeOffset: Int
- Attributes
- protected
- Definition Classes
- CharArrayReaderData
-
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
-
val
name: G.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: ScaladocSyntaxAnalyzer.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
-
def
nextTokenAllow(name: G.Name): Unit
Get next token, and allow the otherwise deprecated ident
nameGet next token, and allow the otherwise deprecated ident
name- Definition Classes
- Scanner
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
-
def
parenBalance(token: ScaladocSyntaxAnalyzer.Token): Int
overridden in UnitScanners
overridden in UnitScanners
- Definition Classes
- UnitScanner → Scanner
-
lazy val
parensAnalyzer: ScaladocSyntaxAnalyzer.ParensAnalyzer
- Definition Classes
- UnitScanner
-
val
prev: ScaladocSyntaxAnalyzer.TokenData
- Definition Classes
- ScannerData
-
def
processCommentChar(): Unit
- Attributes
- protected
- Definition Classes
- ScaladocScanner → DocScanner
-
def
putChar(c: Char): Unit
append Unicode character to "cbuf" buffer
append Unicode character to "cbuf" buffer
- Attributes
- protected
- Definition Classes
- Scanner
-
final
def
putCommentChar(): Unit
- Attributes
- protected
- Definition Classes
- Scanner
-
def
registerDocComment(raw: String, pos: G.Position): Unit
- Definition Classes
- DocScanner
-
def
resume(lastCode: ScaladocSyntaxAnalyzer.Token): Unit
- Definition Classes
- Scanner
-
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
-
final
def
skipComment(): Boolean
- Definition Classes
- Scanner
-
final
def
skipNestedComments(): Unit
- Definition Classes
- Scanner
- Annotations
- @tailrec()
-
def
skipToken(): ScaladocSyntaxAnalyzer.Offset
read next token and return last offset
read next token and return last offset
- Definition Classes
- Scanner
-
val
source: SourceFile
- Definition Classes
- SourceFileScanner
-
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
generate an error at the current token offset
- Definition Classes
- Scanner
-
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
-
def
toString(): String
- Definition Classes
- Scanner → AnyRef → Any
-
val
token: ScaladocSyntaxAnalyzer.Token
the next token
the next token
- Definition Classes
- TokenData → CommonTokenData
-
val
unit: G.CompilationUnit
- Definition Classes
- UnitScanner
-
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( ... ) @native()
-
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
The Scala compiler and reflection APIs.