/**
 * Warlock, the open-source cross-platform game client
 *  
 * Copyright 2008, Warlock LLC, and individual contributors as indicated
 * by the @authors tag. 
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
/*
 * Created on Mar 27, 2005
 *
 * TODO To change the template for this generated file go to
 * Window - Preferences - Java - Code Style - Code Templates
 */
package cc.warlock.core.client.settings.macro.internal;

import java.util.ArrayList;
import java.util.Collection;

import cc.warlock.core.client.IWarlockClientViewer;
import cc.warlock.core.client.settings.internal.ClientSetting;
import cc.warlock.core.client.settings.macro.CommandMacroHandler;
import cc.warlock.core.client.settings.macro.IMacro;
import cc.warlock.core.client.settings.macro.IMacroHandler;
import cc.warlock.core.client.settings.macro.IMacroProvider;

public class Macro extends ClientSetting implements IMacro
{
	protected int keycode;
	protected int modifiers;
	protected ArrayList<IMacroHandler> handlers;
	protected Object userData;
	
	public Macro (IMacroProvider provider, int keycode)
	{
		this (provider, keycode, NO_MODIFIERS);
	}
	
	public Macro (IMacroProvider provider, int keycode, int modifiers)
	{
		super(provider);
		
		this.keycode = keycode;
		this.modifiers = modifiers;
		this.handlers = new ArrayList<IMacroHandler>();
	}
	
	public Macro (Macro other) {
		super(other);
		
		this.keycode = other.keycode;
		this.modifiers = other.modifiers;
		this.handlers = new ArrayList<IMacroHandler>();
		
		for (IMacroHandler handler : other.handlers) {
			if (handler instanceof CommandMacroHandler)
			{
				this.handlers.add(new CommandMacroHandler(((CommandMacroHandler)handler).getCommand()));
			}
		}
	}
	
	public int getKeyCode() {
		return this.keycode;
	}
	
	public void setKeyCode(int keycode) {
		if (keycode != this.keycode)
			needsUpdate = true;
		
		this.keycode = keycode;
	}
	
	public int getModifiers() {
		return modifiers;
	}
	
	public void setModifiers(int modifiers) {
		if (modifiers != this.modifiers)
			needsUpdate = true;
		
		this.modifiers = modifiers;
	}
	
	public void addHandler(IMacroHandler handler) {
		needsUpdate = true;
		
		this.handlers.add(handler);
	}
	
	public void removeHandler(IMacroHandler handler) {
		if (this.handlers.remove(handler)) {
			needsUpdate = true;
		}
	}
	
	public Collection<IMacroHandler> getHandlers() {
		return this.handlers;
	}
	
	public void execute(IWarlockClientViewer viewer) {
		for (IMacroHandler handler : handlers)
		{
			handler.handleMacro(this, viewer);
		}
	}
	
	public Object getUserData() {
		return userData;
	}
	
	public void setUserData(Object object) {
		this.userData = object;
	}
	
	@Override
	public String toString() {
		String str = "Macro (keycode="+keycode+",modifiers="+modifiers+",handlers=(";
		for (IMacroHandler handler : handlers)
		{
			str += handler.toString() + ", ";
		}
		
		str += ")";
		return str;
	}
	
	@Override
	public boolean equals(Object obj) {
		if (obj instanceof IMacro) {
			IMacro other = (IMacro)obj;
			
			return (keycode == other.getKeyCode() && modifiers == other.getModifiers());
		}
		return super.equals(obj);
	}
	
	public Macro getOriginalMacro ()
	{
		return (Macro)getOriginalSetting();
	}
}