/**
 *    Help.java
 *    Copyright (C) 2010 New Zealand Digital Library, http://expeditee.org
 *
 *    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 <http://www.gnu.org/licenses/>.
 */

package org.expeditee.actions;

import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedList;
import java.util.List;

import org.expeditee.gio.EcosystemManager;
import org.expeditee.gui.DisplayController;
import org.expeditee.gui.Frame;
import org.expeditee.items.Item;
import org.expeditee.items.Text;

public class Help {
	/**
	 * Return a list of actions. TODO show the params they take. TODO link the
	 * actions to their help pages.
	 * 
	 * @return
	 */
	public static Collection<Item> getActions(String start, String end) {
		return getItemList(Actions.getActions(), start, end);

	}

	public static Collection<Item> getActions(String start) {
		return getItemList(Actions.getActions(), start, null);

	}

	public static Collection<Item> getActions() {
		return getItemList(Actions.getActions(), null, null);

	}

	public static Collection<Item> getAgents(String start, String end) {
		return getItemList(Actions.getAgents(), start, end);

	}

	public static Collection<Item> getAgents(String start) {
		return getItemList(Actions.getAgents(), start, null);

	}

	public static Collection<Item> getAgents() {
		return getItemList(Actions.getAgents(), null, null);
	}

	private static Collection<Item> getItemList(List<String> stringList,
			String start, String end) {
		Collection<Item> actions = new LinkedList<Item>();

		Collections.sort(stringList, new Comparator<String>() {
			public int compare(String a, String b) {
				return String.CASE_INSENSITIVE_ORDER.compare(a, b);
			}
		});

		Frame current = DisplayController.getCurrentFrame();
		float x = DisplayController.getFloatMouseX();
		float y = DisplayController.getFloatMouseY();

		// Do case sensitive comparison
		if (start != null)
			start = start.toLowerCase();
		if (end != null)
			end = end.toLowerCase();

		for (String s : stringList) {
			String lower = s.toLowerCase();
			if (start != null) {
				if (end != null) {
					if (lower.compareToIgnoreCase(start) < 0)
						continue;
					if (lower.compareToIgnoreCase(end) > 0)
						break;
				} else if (!lower.matches(start) && !lower.startsWith(start)) {
					continue;
				}
			}

			Text t = current.createNewText(s);
			t.setWidth(1000);
			t.setPosition(x, y);
			y += t.getBoundsHeight();
			actions.add(t);
		}

		return actions;
	}
}