net.emustudio.emulib.runtime.interaction.debugger.DebuggerColumn Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of emulib Show documentation
Run-time library used by emuStudio and plugins
There is a newer version: 12.0.0
/*
 * Run-time library for emuStudio and plugins.
 *
 *     Copyright (C) 2006-2020  Peter Jakubčo
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program.  If not, see .
 */
package net.emustudio.emulib.runtime.interaction.debugger;


/**
 * Column in the debugger table.
 *
 * @see DebuggerTable
 * @param  Java type of this column
 */
@SuppressWarnings("unused")
public interface DebuggerColumn {

    /**
     * Gets class type of the column.
     *
     * @return Java type of this column
     */
    Class getClassType ();

    /**
     * Gets title of the column.
     *
     * @return title of this column
     */
    String getTitle ();

    /**
     * Determines whether this column is editable by user.
     *
     * For example, a "mnemo" column shouldn't be editable, but "breakpoint" column can (and should).
     * Note that the returned value holds to all cells in the column.
     *
     * @return true if the column is editable, false otherwise
     */
    boolean isEditable ();

    /**
     * Set a value to a column cell.
     *
     * It is called by emuStudio when user sets a value to a cell in the debugger table. It is used only if
     * the column is editable (see {@link #isEditable() isEditable} method).
     *
     * NOTE: This method should ensure proper changes in CPU's internal state, if necessary.
     *
     * @param location Cell index (usually memory address). It is not a "row number" in the debugger table.
     * @param value new value assigned to the cell
     * @throws CannotSetDebuggerValueException if the value cannot be assigned, for any reason
     */
    void setValue(int location, Object value) throws CannotSetDebuggerValueException;

    /**
     * Gets a value from the column cell.
     *
     * It is called by emuStudio when rendering the debugger table.
     *
     * @param location Cell index (usually memory address). It is not a "row number" in the debugger table.
     * @return cell value
     */
    T getValue(int location);

    /**
     * Get default width of the column in pixels.
     *
     * If it is not known, this method should return -1.
     *
     * @return default width of the column in pixels or -1 if it is not known
     */
    default int getDefaultWidth() {
        return -1;
    }
}