/*
   Copyright 2018 - 2019 Volker Berlin (i-net software)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

*/
package de.inetsoftware.jwebassembly.module;

import java.io.IOException;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import de.inetsoftware.jwebassembly.wasm.AnyType;

/**
 * Base class of all WasmInstruction.
 * 
 * @author Volker Berlin
 *
 */
abstract class WasmInstruction {

    /**
     * Type of instruction to faster differ as with instanceof.
     */
    static enum Type {
        Const, Convert, Local, Global, Table, Block, Numeric, Nop, Call, CallIndirect, Array, Struct, DupThis;
    }

    private int       javaCodePos;

    private final int lineNumber;

    /**
     * Create a new instance of an instruction
     * 
     * @param javaCodePos
     *            the code position/offset in the Java method
     * @param lineNumber
     *            the line number in the Java source code
     */
    WasmInstruction( int javaCodePos, int lineNumber ) {
        this.javaCodePos = javaCodePos;
        this.lineNumber = lineNumber;
    }

    /**
     * Get the type of instruction
     * 
     * @return the type
     */
    @Nonnull
    abstract Type getType();

    /**
     * Write this instruction to the WASM module.
     * 
     * @param writer
     *            the target writer
     * @throws IOException
     *             if any I/O error occur
     */
    abstract void writeTo( @Nonnull ModuleWriter writer ) throws IOException;

    /**
     * Get current code position in Java method.
     * 
     * @return the position
     */
    int getCodePosition() {
        return javaCodePos;
    }

    /**
     * Get the line number in the Java source file
     * 
     * @return the line number
     */
    int getLineNumber() {
        return lineNumber;
    }

    /**
     * Set a new code position after reorganize the order
     * 
     * @param newPos
     *            new position
     */
    void setCodePosition( int newPos ) {
        this.javaCodePos = newPos;
    }

    /**
     * Get the ValueType if this instruction push a value on the stack.
     * 
     * @return the ValueType or null if no value is push
     */
    @Nullable
    abstract AnyType getPushValueType();

    /**
     * Get the count of values that are removed from the stack.
     * 
     * @return the count
     */
    abstract int getPopCount();
}