adolphenom
65 lines
2.5 KiB
Java
65 lines
2.5 KiB
Java
package mars.tools;
|
|
|
|
/*
|
|
Copyright (c) 2003-2006, Pete Sanderson and Kenneth Vollmar
|
|
|
|
Developed by Pete Sanderson (psanderson@otterbein.edu)
|
|
and Kenneth Vollmar (kenvollmar@missouristate.edu)
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining
|
|
a copy of this software and associated documentation files (the
|
|
"Software"), to deal in the Software without restriction, including
|
|
without limitation the rights to use, copy, modify, merge, publish,
|
|
distribute, sublicense, and/or sell copies of the Software, and to
|
|
permit persons to whom the Software is furnished to do so, subject
|
|
to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be
|
|
included in all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
|
|
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
|
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
(MIT license, http://www.opensource.org/licenses/mit-license.html)
|
|
*/
|
|
|
|
|
|
/**
|
|
* Interface for any tool that interacts with an executing MIPS program.
|
|
* A qualifying tool must be a class in the Tools package that
|
|
* implements the MarsTool interface, must be compiled into a .class file,
|
|
* and its .class file must be in the same Tools folder as MarsTool.class.
|
|
* Mars will detect a qualifying tool upon startup, create an instance
|
|
* using its no-argument constructor and add it to its Tools menu.
|
|
* When its menu item is selected, the action() method will be invoked.
|
|
*
|
|
* <p>A tool may receive communication from MIPS system resources
|
|
* (registers or memory) by registering as an Observer with
|
|
* Mars.Memory and/or Mars.Register objects.
|
|
*
|
|
* It may also
|
|
* communicate directly with those resources through their
|
|
* published methods PROVIDED any such communication is
|
|
* wrapped inside a block synchronized on the
|
|
* Mars.Globals.memoryAndRegistersLock object.
|
|
*/
|
|
|
|
public interface MarsTool {
|
|
/**
|
|
* Return a name you have chosen for this tool. It will appear as the
|
|
* menu item.
|
|
*/
|
|
public abstract String getName();
|
|
|
|
/**
|
|
* Performs tool functions. It will be invoked when the tool is selected
|
|
* from the Tools menu.
|
|
*/
|
|
|
|
public abstract void action();
|
|
} |