/*
 * PreAlign.java
 * Copyright 2001 (C) Bryan McRoberts <merton_monk@yahoo.com>
 * Copyright 2003 (C) Chris Ward <frugal@purplewombat.co.uk>
 *
 * 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
 *
 * Created on November 28, 2003
 *
 * Current Ver: $Revision$
 *
 */
package plugin.pretokens.test;

import pcgen.cdom.base.CDOMObject;
import pcgen.cdom.enumeration.ObjectKey;
import pcgen.cdom.reference.CDOMSingleRef;
import pcgen.core.Equipment;
import pcgen.core.Globals;
import pcgen.core.PCAlignment;
import pcgen.core.display.CharacterDisplay;
import pcgen.core.prereq.AbstractDisplayPrereqTest;
import pcgen.core.prereq.Prerequisite;
import pcgen.core.prereq.PrerequisiteException;
import pcgen.core.prereq.PrerequisiteOperator;
import pcgen.core.prereq.PrerequisiteTest;
import pcgen.system.LanguageBundle;
import pcgen.util.Logging;

/**
 * @author wardc
 *
 */
public class PreAlignTester extends AbstractDisplayPrereqTest implements PrerequisiteTest
{

	/* (non-Javadoc)
	 * @see pcgen.core.prereq.PrerequisiteTest#passes(pcgen.core.PlayerCharacter)
	 */
	@Override
	public int passes(final Prerequisite prereq, final Equipment equipment,
		final CharacterDisplay display) throws PrerequisiteException
	{
		if (display == null)
		{
			return 0;
		}
		return passes(prereq, display, equipment);
	}

	@Override
	public int passes(final Prerequisite prereq, final CharacterDisplay display, CDOMObject source) throws PrerequisiteException
	{
		//
		// If game mode doesn't support alignment, then pass the prereq
		//
		int runningTotal = 0;

		if (Globals.getGameModeAlignmentText().isEmpty())
		{
			runningTotal = 1;
		}
		else
		{
			String desiredAlignment = prereq.getKey();
			final PCAlignment charAlignment = display.getPCAlignment();

			if (prereq.getOperator().equals(PrerequisiteOperator.EQ))
			{
				if (alignMatches(display, desiredAlignment, charAlignment))
				{
					runningTotal++;
				}
			}
			else if (prereq.getOperator().equals(PrerequisiteOperator.NEQ))
			{
				if (!alignMatches(display, desiredAlignment, charAlignment))
				{
					runningTotal++;
				}
			}
			else
			{
				throw new PrerequisiteException(
					LanguageBundle
						.getFormattedString(
							"PreAlign.error.invalidComparison", prereq.getOperator().toString(), prereq.toString())); //$NON-NLS-1$
			}
		}

		return countedTotal(prereq, runningTotal);
	}

	/**
     * Check if the character's alignment matches the requirement.
     * 
	 * @param character The character to test
	 * @param desiredAlignment The alignment to be found
	 * @param charAlignment The character's alignment
	 * @return true if the alignment matches, false if not.
	 */
	private static boolean alignMatches(final CharacterDisplay display,
	                                    String desiredAlignment, final PCAlignment charAlignment)
	{
		PCAlignment al = getPCAlignment(desiredAlignment);
		if (al.equals(charAlignment))
		{
			return true;
		}
		else if ((desiredAlignment.equalsIgnoreCase("Deity"))
			&& (display.getDeity() != null))
		{
			final CDOMSingleRef<PCAlignment> deityAlign =
					display.getDeity().get(ObjectKey.ALIGNMENT);
			if ((deityAlign != null) && charAlignment.equals(deityAlign.get()))
			{
				return true;
			}
		}
		return false;
	}

	/**
	 * Get the type of prerequisite handled by this token.
	 * @return the type of prerequisite handled by this token.
	 */
    @Override
	public String kindHandled()
	{
		return "align"; //$NON-NLS-1$
	}

	/* (non-Javadoc)
	 * @see pcgen.core.prereq.PrerequisiteTest#toHtmlString(pcgen.core.prereq.Prerequisite)
	 */
	@Override
	public String toHtmlString(final Prerequisite prereq)
	{
		String alignment = prereq.getKey();
		PCAlignment al = getPCAlignment(alignment);
		return LanguageBundle
			.getFormattedString(
				"PreAlign.toHtml", prereq.getOperator().toDisplayString(), al.getKeyName()); //$NON-NLS-1$
	}

	private static PCAlignment getPCAlignment(String desiredAlignIdentifier)
	{
		PCAlignment desiredAlign =
				Globals
					.getContext()
					.getReferenceContext()
					.silentlyGetConstructedCDOMObject(PCAlignment.class,
						desiredAlignIdentifier);
		if (desiredAlign == null)
		{
			Logging.errorPrint("Unable to find alignment that matches: "
				+ desiredAlignIdentifier);
		}
		return desiredAlign;
	}
}