SquirrelJME/SquirrelJME

// -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
// ---------------------------------------------------------------------------
// Multi-Phasic Applications: SquirrelJME
//     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
// ---------------------------------------------------------------------------
// SquirrelJME is under the Mozilla Public License Version 2.0.
// See license.mkd for licensing and copyright information.
// ---------------------------------------------------------------------------

package cc.squirreljme.debugger;

import cc.squirreljme.jdwp.JDWPId;
import net.multiphasicapps.classfile.MethodDescriptor;
import net.multiphasicapps.classfile.MethodFlags;
import net.multiphasicapps.classfile.MethodName;
import net.multiphasicapps.classfile.Pool;

/**
 * The type of information stored.
 *
 * @since 2024/01/20
 */
public enum InfoKind
{
    /** Thread frame. */
    FRAME("Frame", "Frames")
    {
        /**
         * {@inheritDoc}
         * @since 2024/01/25
         */
        @Override
        protected Info seed(DebuggerState __state, JDWPId __id,
            Object... __extra)
        {
            InfoThread thread = (InfoThread)__extra[0];
            FrameLocation location = (FrameLocation)__extra[1];
            
            return new InfoFrame(__state, __id, thread, location);
        }
    },
    
    /** A thread. */
    THREAD("Thread", "Threads")
    {
        /**
         * {@inheritDoc}
         * @since 2024/01/20
         */
        @Override
        protected Info seed(DebuggerState __state, JDWPId __id,
            Object... __extra)
        {
            return new InfoThread(__state, __id);
        }
    },
    
    /* Class type. */
    CLASS("Class", "Classes")
    {
        /**
         * {@inheritDoc}
         * @since 2024/01/22
         */
        @Override
        protected Info seed(DebuggerState __state, JDWPId __id,
            Object... __extra)
        {
            return new InfoClass(__state, __id);
        }
    },
    
    /** Method. */
    METHOD("Method", "Methods")
    {
        /**
         * {@inheritDoc}
         * @since 2024/01/22
         */
        @Override
        protected Info seed(DebuggerState __state, JDWPId __id,
            Object... __extra)
        {
            InfoClass inClass = (InfoClass)__extra[0];
            MethodName name = (MethodName)__extra[1];
            MethodDescriptor type = (MethodDescriptor)__extra[2];
            MethodFlags flags = (MethodFlags)__extra[3];
            
            return new InfoMethod(__state, __id, inClass, name, type, flags);
        }
    },
    
    /** Method byte code. */
    BYTE_CODE("Bytecode", "Bytecode")
    {
        /**
         * {@inheritDoc}
         * @since 2024/01/24
         */
        @Override
        protected Info seed(DebuggerState __state, JDWPId __id,
            Object... __extra)
        {
            InfoMethod method = (InfoMethod)__extra[0];
            KnownValue<Pool> constantPool = (KnownValue<Pool>)__extra[1];
            byte[] byteCode = (byte[])__extra[2];
            
            return new InfoByteCode(__state, __id,
                method, constantPool, byteCode);
        }
    },
    
    /* End. */
    ;
    
    /** Singular description. */
    public final String singular;
    
    /** Plural description. */
    public final String plural;
    
    /**
     * The description of this item. 
     *
     * @param __singular Singular.
     * @since 2024/01/20
     */
    InfoKind(String __singular, String __plural)
    {
        this.singular = __singular;
        this.plural = __plural;
    }
    
    /**
     * Seeds an item with the given ID.
     *
     * @param __state The state of the debugger.
     * @param __id The ID of the item.
     * @param __extra Extra values used by the seed, as some require the
     * type to have such information.
     * @return The resultant item.
     * @since 2024/01/20
     */
    protected abstract Info seed(DebuggerState __state, JDWPId __id,
        Object... __extra);
    
    /**
     * Is this information forgettable?
     *
     * @return If the information is forgettable.
     * @since 2024/01/25
     */
    public final boolean isForgettable()
    {
        return false;
    }
    
    /**
     * {@inheritDoc}
     * @since 2024/01/20
     */
    @Override
    public String toString()
    {
        return this.singular;
    }
}