resonant-induction/archive/java/resonantinduction/old/api/coding/ProgramHelper.java

package resonantinduction.old.api.coding;

import java.util.HashMap;

import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.world.World;
import resonantinduction.old.api.coding.IProcessTask.ProcessReturn;
import universalelectricity.api.vector.Vector3;

/**
 * Basic class to handle a machine like programs for any object that uses the IProgramable
 * interface. Doesn't actually do much then tell the program to function, and stores the programs
 * active run time memory.
 * 
 * @author DarkGuardsman
 */
public class ProgramHelper
{
	/** Current Program */
	protected IProgram program;
	protected IProgrammableMachine bot;
	/** Current task in program */
	protected ITask currentTask;
	/** Do we have a memory to store values */
	boolean hasMemory = false;
	boolean hasTaskBeenCalled = false, nextTask = false;
	/** Max memorySize */
	protected int memorySize = 0;
	/** Array of values to remember between commands */
	protected HashMap<String, Object> taskMemory = new HashMap<String, Object>();

	public ProgramHelper(IProgrammableMachine bot)
	{
		this.bot = bot;
	}

	/**
	 * Needs to be called by the armbot per tick.
	 * 
	 * @return true if it is doing something
	 */
	public ProcessReturn onUpdate(World world, Vector3 botLocation)
	{
		ProcessReturn re = ProcessReturn.DONE;
		if (program != null)
		{
			if (this.currentTask == null || this.nextTask)
			{
				this.nextTask();
			}
			if (this.currentTask != null)
			{
				if (!this.hasTaskBeenCalled)
				{
					this.hasTaskBeenCalled = true;
					if (this.currentTask instanceof IProcessTask)
					{
						re = ((IProcessTask) this.currentTask).onMethodCalled();
						if (re == ProcessReturn.DONE)
						{
							this.nextTask = true;
						}
						else if (re != ProcessReturn.CONTINUE)
						{
							return re;
						}
					}
				}
				if (this.currentTask instanceof IProcessTask)
				{
					re = ((IProcessTask) this.currentTask).onUpdate();
					if (re == ProcessReturn.DONE)
					{
						this.nextTask = true;
					}
				}
				else
				{
					re = ProcessReturn.CONTINUE;
				}
				return re;
			}
		}
		return re;
	}

	/** Gets the next task from the program */
	public void nextTask()
	{
		this.hasTaskBeenCalled = false;
		this.nextTask = false;
		this.currentTask = program.getNextTask();
	}

	public ProgramHelper setMemoryLimit(int varableLimit)
	{
		if (varableLimit > 0)
		{
			this.memorySize = varableLimit;
			this.hasMemory = true;
		}
		else
		{
			this.taskMemory = null;
		}
		return this;
	}

	public ProgramHelper setProgram(IProgram program)
	{
		this.program = program;
		this.onProgramChanged();
		return this;
	}

	public IProgram getProgram()
	{
		return this.program;
	}

	public void onProgramChanged()
	{
		this.taskMemory.clear();
		if (this.program != null)
		{
			HashMap<String, Object> memory = this.program.getDeclairedVarables();
			if (memory.size() <= memorySize)
			{
				// TODO load in memory and throw error stopping machine if there is not enough
			}
			this.program.init(this.bot);
		}
	}

	/** Gets the memory location */
	public Object getMemoryLocation(String var)
	{
		return this.taskMemory.get(var);
	}

	/** Sets the memory location at the give spot. */
	public boolean setMemoryLocation(String var, Object object)
	{
		if (var != null)
		{
			if (this.taskMemory.containsKey(var))
			{
				if (object == null)
				{
					this.taskMemory.remove(var);
				}
				return this.addMemory(var, object);

			}
			else if (object != null && this.taskMemory.size() < this.memorySize)
			{
				return this.addMemory(var, object);
			}
		}
		return false;
	}

	protected boolean addMemory(String var, Object object)
	{
		// We don't want cheat methods to bypass the variable memory limit
		if (!(object instanceof java.util.Arrays && object instanceof java.util.ArrayList && object instanceof java.util.List && object instanceof java.util.Set))
		{
			return this.taskMemory.put(var, object) != null;
		}
		return false;
	}

	public NBTTagCompound save(NBTTagCompound nbt)
	{
		return nbt;
	}

	public void load(NBTTagCompound nbt)
	{

	}
}