avail/avail.stacks.scanner/StacksScanner

StacksScanner

class StacksScanner(commentToken: A_Token, moduleName: String) : AbstractStacksScanner

A scanner for Stacks comments.

Author

Richard Arriaga

Parameters

commentToken

The comment token to be scanned and tokenized.

moduleName

The name of the module the comment is in.

Constructors

StacksScanner

constructor(commentToken: A_Token, moduleName: String)

Construct a new StacksScanner.

Types

Companion

object Companion

Properties

filePosition

var filePosition: Int

The start position of the comment in the file.

lineNumber

var lineNumber: Int

The line number of the start of the token currently being parsed.

moduleLeafName

val moduleLeafName: String

The module file name without the path.

outputTokens

var outputTokens: MutableList<AbstractStacksToken>

The tokens that have been parsed so far.

position

var position: Int

The current position in the input string.

tokenString

var tokenString: String

The comment token text that has been lexed as one long token.

Functions

addedParagraphHTMLTag

fun addedParagraphHTMLTag(): Boolean

addedParagraphHTMLTagFalse

fun addedParagraphHTMLTagFalse()

set the hasHTMLTag to false

addedParagraphHTMLTagTrue

fun addedParagraphHTMLTagTrue()

set the hasHTMLTag to true

addHTMLTokens

fun addHTMLTokens(htmlTags: String)

Insert HTML tags in tokenized comments.

beingTokenized

fun beingTokenized(): StringBuilder

decrementNewLineCount

fun decrementNewLineCount()

decrement new line

hasHTMLTag

fun hasHTMLTag(): Boolean

hasHTMLTagFalse

fun hasHTMLTagFalse()

set the hasHTMLTag to false

hasHTMLTagTrue

fun hasHTMLTagTrue()

set the hasHTMLTag to true

incrementNewlineCount

fun incrementNewlineCount()

Increment new line

newlineCount

fun newlineCount(): Int

operator fun next(): Char

Extract the current character and increment the position.

obtainModuleSimpleName

fun obtainModuleSimpleName(): String

From the full directory path of a module name, obtain the leaf portion that represents the file name in the directory.

resetBeingTokenized

fun resetBeingTokenized()

resetNewlineCount

fun resetNewlineCount()

Set the newlineCount to 0;

scan

fun scan()

Scan the already-specified String to produce tokens.