/*
 * Copyright (c) 2008 Tom Parker <thpr@users.sourceforge.net>
 * 
 * This program 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 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 Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
package pcgen.cdom.choiceset;

import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import pcgen.cdom.base.PrimitiveChoiceSet;
import pcgen.cdom.content.CNAbilityFactory;
import pcgen.cdom.enumeration.GroupingState;
import pcgen.cdom.enumeration.Nature;
import pcgen.cdom.helper.CNAbilitySelection;
import pcgen.cdom.inst.PCClassLevel;
import pcgen.cdom.reference.CDOMSingleRef;
import pcgen.core.Ability;
import pcgen.core.AbilityCategory;
import pcgen.core.PCClass;
import pcgen.core.PlayerCharacter;

/**
 * An AbilityFromClassChoiceSet is a PrimitiveChoiceSet that draws Abilities
 * from a specific PCClass. These Ability objects are previously selected
 * Ability objects; thus AbilityFromClassChoiceSet is intended to be used during
 * object removal from a PlayerCharacter, not object addition.
 * 
 * In particular, AbilityFromClassChoiceSet is designed to handle
 * REMOVE:FEAT|Class.???
 */
public class AbilityFromClassChoiceSet implements
		PrimitiveChoiceSet<CNAbilitySelection>
{

	/**
	 * The underlying class from which this AbilityFromClassChoiceSet can draw
	 * Abilities
	 */
	private final CDOMSingleRef<PCClass> classRef;

	/**
	 * Constructs a new AbilityFromClassChoiceSet which refers to the PCClass
	 * provided in the given CDOMSingleRef.
	 * 
	 * @param pcc
	 *            A reference to the PCClass this AbilityFromClassChoiceSet can
	 *            draw Abilities from
	 */
	public AbilityFromClassChoiceSet(CDOMSingleRef<PCClass> pcc)
	{
		classRef = pcc;
	}

	/**
	 * Returns a representation of this AbilityFromClassChoiceSet, suitable for
	 * storing in an LST file.
	 * 
	 * @param useAny
	 *            use "ANY" for the global "ALL" reference when creating the LST
	 *            format
	 * @return A representation of this AbilityFromClassChoiceSet, suitable for
	 *         storing in an LST file.
	 */
	@Override
	public String getLSTformat(boolean useAny)
	{
		return "CLASS." + classRef.getLSTformat(useAny);
	}

	/**
	 * Returns true if this AbilityFromClassChoiceSet is equal to the given
	 * Object. Equality is defined as being another AbilityFromClassChoiceSet
	 * object with equal Class represented by the reference provided during
	 * construction of the AbilityFromClassChoiceSets
	 * 
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public boolean equals(Object obj)
	{
		if (obj instanceof AbilityFromClassChoiceSet)
		{
			AbilityFromClassChoiceSet other = (AbilityFromClassChoiceSet) obj;
			return classRef.equals(other.classRef);
		}
		return false;
	}

	/**
	 * Returns the consistent-with-equals hashCode for this
	 * AbilityFromClassChoiceSet
	 * 
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public int hashCode()
	{
		return classRef.hashCode();
	}

	/**
	 * Returns the Class contained within this AbilityFromClassChoiceSet
	 * 
	 * @return the Class contained within this AbilityFromClassChoiceSet
	 */
	@Override
	public Class<? super CNAbilitySelection> getChoiceClass()
	{
		return CNAbilitySelection.class;
	}

	/**
	 * Returns a Set containing the Objects which this AbilityFromClassChoiceSet
	 * contains.
	 * 
	 * This method is value-semantic, meaning that ownership of the Set returned
	 * by this method will be transferred to the calling object. Modification of
	 * the returned Set will not modify the AbilityFromClassChoiceSet, and
	 * modifying the AbilityFromClassChoiceSet after the Set is returned will
	 * not modify the Set.
	 * 
	 * @param pc
	 *            The PlayerCharacter for which the choices in this
	 *            AbilityFromClassChoiceSet should be returned.
	 * @return A Set containing the Objects which this AbilityFromClassChoiceSet
	 *         contains.
	 */
	@Override
	public Set<CNAbilitySelection> getSet(PlayerCharacter pc)
	{
		PCClass aClass = pc.getClassKeyed(classRef.get().getKeyName());
		Set<CNAbilitySelection> set = new HashSet<>();
		if (aClass != null)
		{
			//TODO This is a bug -> it was not properly gathering before
			List<Ability> abilityList = Collections.emptyList();
			if (abilityList != null)
			{
				for (Ability aFeat : abilityList)
				{
					set.add(new CNAbilitySelection(CNAbilityFactory.getCNAbility(
						AbilityCategory.FEAT, Nature.VIRTUAL, aFeat)));
				}
			}
			for (int lvl = 0; lvl < pc.getLevel(aClass); lvl++)
			{
				PCClassLevel pcl = pc.getActiveClassLevel(aClass, lvl);
				//TODO This is a bug -> it was not properly gathering before
				abilityList = Collections.emptyList();
				if (abilityList != null)
				{
					for (Ability aFeat : abilityList)
					{
						set.add(new CNAbilitySelection(CNAbilityFactory.getCNAbility(
							AbilityCategory.FEAT, Nature.VIRTUAL, aFeat)));
					}
				}
			}
		}
		return null;
	}

	/**
	 * Returns the GroupingState for this AbilityFromClassChoiceSet. The
	 * GroupingState indicates how this AbilityFromClassChoiceSet can be
	 * combined with other PrimitiveChoiceSets.
	 * 
	 * @return The GroupingState for this AbilityFromClassChoiceSet.
	 */
	@Override
	public GroupingState getGroupingState()
	{
		return GroupingState.ANY;
	}
}