/* BSD 2-Clause License - see OPAL/LICENSE for details. */
package org.opalj
package br
package instructions

/**
 * An instruction to create a new array.
 *
 * @author Michael Eichberg
 */
abstract class CreateNewArrayInstruction
    extends Instruction
    with ConstantLengthInstruction
    with NoLabels {

    override final def asCreateNewArrayInstruction: this.type = this

    override final def isIsomorphic(thisPC: PC, otherPC: PC)(implicit code: Code): Boolean = {
        val other = code.instructions(otherPC)
        (this eq other) || (this == other)
    }

    override final def jvmExceptions: List[ClassType] = {
        CreateNewArrayInstruction.jvmExceptionsAndErrors
    }

    final def mayThrowExceptions: Boolean = true

    override final def nextInstructions(
        currentPC:             PC,
        regularSuccessorsOnly: Boolean
    )(
        implicit
        code:           Code,
        classHierarchy: ClassHierarchy = ClassHierarchy.PreInitializedClassHierarchy
    ): List[PC] = {
        if (regularSuccessorsOnly)
            List(indexOfNextInstruction(currentPC))
        else
            Instruction.nextInstructionOrExceptionHandlers(
                this,
                currentPC,
                CreateNewArrayInstruction.jvmExceptionsAndErrors
            )
    }

    override final def expressionResult: Stack.type = Stack

    override final def toString(currentPC: Int): String = toString()

    def arrayType: ArrayType
}

object CreateNewArrayInstruction {

    val jvmExceptions: List[ClassType] = List(ClassType.NegativeArraySizeException)

    val jvmExceptionsAndErrors: List[ClassType] = ClassType.OutOfMemoryError :: jvmExceptions

}