/*
 * MaritimeDefenderPhaseQueue.cs
 * Authors: August Zinsser, Adam Nabinger
 * Copyright (c) 2007-2008 Cornell University

 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 2
 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, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

using System.Collections.Generic;
namespace MaritimeDefender
{
	/// <summary>
	/// All phases used in Maritime Defender
	/// </summary>
	public class MaritimeDefenderPhases
	{
		#region Constants

		/// <summary>
		/// String representing the dot coherence phase
		/// </summary>
		public const string DotTest = "DotTest";

		/// <summary>
		/// String representing the identity test phase
		/// </summary>
		public const string IdentityTest = "IdentityTest";

		/// <summary>
		/// String representing the shooter phase
		/// </summary>
		public const string Shooter = "Shooter";

		/// <summary>
		/// String representing the boss phase
		/// </summary>
		public const string Boss = "Boss";

		/// <summary>
		/// String representing the transition phase from the dot coherence phase to the shooter phase
		/// </summary>
		public const string DotTest2ShooterTransition = "DotTest2ShooterTransition";

		/// <summary>
		/// String representing the transition phase from the shooter phase to the dot coherence phase
		/// </summary>
		public const string Shooter2DotTestTransition = "Shooter2DotTestTransition";

		/// <summary>
		/// String representing the transition phase from the shooter phase to the boss phase
		/// </summary>
		public const string Shooter2BossTransition = "Shooter2BossTransition";

		#endregion

		#region Contains

		/// <summary>
		/// Checks if the phaseName exists in this minigame..
		/// .. just hardcoded.. for some reason..
		/// </summary>
		/// <param name="phaseName">The name of the phase to check for</param>
		/// <returns>Whether or not the given phase name was part of the Maritime Defender Phases phases</returns>
		public bool Contains(string phaseName)
		{
			return phaseName == DotTest ||
				   phaseName == IdentityTest ||
				   phaseName == Shooter ||
				   phaseName == Boss ||
				   phaseName == DotTest2ShooterTransition ||
				   phaseName == Shooter2DotTestTransition;
		}

		#endregion
	}

	/// <summary>
	/// Tests the phase queue to make sure it's phases are valid for Maritime Defender
	/// </summary>
	public class MaritimeDefenderTest
	{
		/// <summary>
		/// Name of this test
		/// </summary>
		public string PhaseName;

		/// <summary>
		/// Trials for this test
		/// </summary>
		public int Trials;

		/// <summary>
		/// Parsed by specific minigames
		/// </summary>
		public List<string> SpecificParameters;

		/// <summary>
		/// Must be assigned to a specific phase set in each derived class
		/// </summary>
		protected MaritimeDefenderPhases mPhases;

		/// <summary>
		/// Converts a generic test into a Maritime Defender test
		/// </summary>
		public MaritimeDefenderTest(string phaseName, int trials, List<string> specificParameters)
        {
            PhaseName = phaseName;
            Trials = trials;
            SpecificParameters = specificParameters ?? new List<string>();

			// Validate the input from the config file
			mPhases = new MaritimeDefenderPhases();
			if (!mPhases.Contains(phaseName))
			{
				System.Windows.Forms.MessageBox.Show(
					"Unrecognized test phase name " + phaseName + ". Try reinstalling this program.",
					"Fatal Error",
					System.Windows.Forms.MessageBoxButtons.OK,
					System.Windows.Forms.MessageBoxIcon.Error
				);
			}
		}
	}
}