commonMain.org.antlr.v4.kotlinruntime.TokenFactory.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of antlr-kotlin-runtime-jvm Show documentation

Kotlin multiplatform port of ANTLR

There is a newer version: 0.0.18

Show newest version

/*
 * Copyright (c) 2012-2017 The ANTLR Project. All rights reserved.
 * Use of this file is governed by the BSD 3-clause license that
 * can be found in the LICENSE.txt file in the project root.
 */

package org.antlr.v4.kotlinruntime

/** The default mechanism for creating tokens. It's used by default in Lexer and
 * the error handling strategy (to create missing tokens).  Notifying the parser
 * of a new factory means that it notifies its token source and error strategy.
 */
interface TokenFactory {
    /** This is the method used to create tokens in the lexer and in the
     * error handling strategy. If text!=null, than the start and stop positions
     * are wiped to -1 in the text override is set in the CommonToken.
     */
    fun create(source: Pair, type: Int, text: String?,
               channel: Int, start: Int, stop: Int,
               line: Int, charPositionInLine: Int): Symbol

    /** Generically useful  */
    fun create(type: Int, text: String): Symbol
}