/*
 * Copyright 2008 (C) Tom Parker <thpr@users.sourceforge.net>
 * Derived from Ability.java and Skill.java
 * Copyright 2001 (C) Bryan McRoberts <merton_monk@yahoo.com>
 * 
 * This library 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 library 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.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
package pcgen.core.analysis;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import pcgen.base.lang.StringUtil;
import pcgen.cdom.base.ChooseInformation;
import pcgen.cdom.content.CNAbility;
import pcgen.cdom.enumeration.ObjectKey;
import pcgen.core.Ability;
import pcgen.core.AbilityUtilities;
import pcgen.core.PlayerCharacter;
import pcgen.core.Skill;

public class QualifiedName
{

	/**
	 * This method generates a name for this Ability which includes any choices
	 * made and a count of how many times it has been applied.
	 * 
	 * @param pc
	 *            TODO
	 * 
	 * @return The name of the full Ability, plus any sub-choices made for this
	 *         character. Starts with the name of the ability, and then (for
	 *         types other than weapon proficiencies), either appends a count of
	 *         the times the ability is applied e.g. " (3x)", or a list of the
	 *         sub-choices e.g. " (Sub1, Sub2, ...)".
	 */
	public static String qualifiedName(PlayerCharacter pc, List<CNAbility> list)
	{
		Ability a = AbilityUtilities.validateCNAList(list);
		String outputName = OutputNameFormatting.getOutputName(a);
		if ("[BASE]".equalsIgnoreCase(outputName))
		{
			return a.getDisplayName();
		}
		// start with the name of the ability
		// don't do for Weapon Profs
		final StringBuilder aStrBuf = new StringBuilder(outputName);
		
		ChooseInformation<?> chooseInfo = a.get(ObjectKey.CHOOSE_INFO);
		if (chooseInfo != null)
		{
			processChooseInfo(aStrBuf, pc, chooseInfo, list);
		}
		return aStrBuf.toString();
	}

	private static <T> void processChooseInfo(StringBuilder aStrBuf, PlayerCharacter pc, 
		ChooseInformation<T> chooseInfo, List<CNAbility> list)
	{
		List<T> allSelections = new ArrayList<>();
		for (CNAbility cna : list)
		{
			if (pc.hasAssociations(cna))
			{
				List<? extends T> selections =
						(List<? extends T>) pc.getDetailedAssociations(cna);
				allSelections.addAll(selections);
			}
		}
		String choiceInfo = chooseInfo.composeDisplay(allSelections).toString();
		if (!choiceInfo.isEmpty())
		{
			aStrBuf.append(" (");
			aStrBuf.append(choiceInfo);
			aStrBuf.append(")");
		}
	}

	public static String qualifiedName(PlayerCharacter pc, Skill s)
	{
		String outputName = OutputNameFormatting.getOutputName(s);
		if (!pc.hasAssociations(s))
		{
			return outputName;
		}

		final StringBuilder buffer = new StringBuilder(50);
		buffer.append(outputName).append("(");
		List<String> associationList = pc.getAssociationList(s);
		Collections.sort(associationList);
		buffer.append(StringUtil.joinToStringBuilder(associationList, ", "));
		buffer.append(")");

		return buffer.toString();
	}

}