commonMain.org.antlr.v4.kotlinruntime.atn.LexerChannelAction.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

Runtime for ANTLR Kotlin

The newest version!

// Copyright 2017-present Strumenta and contributors, licensed under Apache 2.0.
// Copyright 2024-present Strumenta and contributors, licensed under BSD 3-Clause.

package org.antlr.v4.kotlinruntime.atn

import org.antlr.v4.kotlinruntime.Lexer
import org.antlr.v4.kotlinruntime.misc.MurmurHash

/**
 * Implements the `channel` lexer action by setting [Lexer.channel]
 * with the assigned channel.
 *
 * @param channel The channel value to assign to [Lexer.channel]
 *
 * @author Sam Harwell
 * @since 4.2
 */
public class LexerChannelAction(public val channel: Int) : LexerAction {
  /**
   * Set to [LexerActionType.CHANNEL] by default.
   */
  override val actionType: LexerActionType =
    LexerActionType.CHANNEL

  /**
   * Set to `false` by default.
   */
  override val isPositionDependent: Boolean =
    false

  /**
   * This action is implemented by assigning [Lexer.channel] with the
   * value provided by [channel].
   */
  override fun execute(lexer: Lexer) {
    lexer.channel = channel
  }

  override fun hashCode(): Int {
    var hash = MurmurHash.initialize()
    hash = MurmurHash.update(hash, actionType.ordinal)
    hash = MurmurHash.update(hash, channel)
    return MurmurHash.finish(hash, 2)
  }

  override fun equals(other: Any?): Boolean {
    if (other === this) {
      return true
    }

    if (other !is LexerChannelAction) {
      return false
    }

    return channel == other.channel
  }

  override fun toString(): String =
    "channel($channel)"
}