using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace UnrealBuildTool
{
	/// <summary>
	/// Represents a case-insensitive name in the filesystem
	/// </summary>
	public class FileSystemName
	{
		/// <summary>
		/// Name as it should be displayed
		/// </summary>
		public readonly string DisplayName;

		/// <summary>
		/// The canonical form of the name
		/// </summary>
		public readonly string CanonicalName;

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="DisplayName">The display name</param>
		public FileSystemName(string DisplayName)
		{
			this.DisplayName = DisplayName;
			CanonicalName = DisplayName.ToLowerInvariant();
		}

		/// <summary>
		/// Compares two filesystem object names for equality. Uses the canonical name representation, not the display name representation.
		/// </summary>
		/// <param name="A">First object to compare.</param>
		/// <param name="B">Second object to compare.</param>
		/// <returns>True if the names represent the same object, false otherwise</returns>
		public static bool operator ==(FileSystemName A, FileSystemName B)
		{
			if ((object)A == null)
			{
				return (object)B == null;
			}
			else
			{
				return (object)B != null && A.CanonicalName == B.CanonicalName;
			}
		}

		/// <summary>
		/// Compares two filesystem object names for inequality. Uses the canonical name representation, not the display name representation.
		/// </summary>
		/// <param name="A">First object to compare.</param>
		/// <param name="B">Second object to compare.</param>
		/// <returns>False if the names represent the same object, true otherwise</returns>
		public static bool operator !=(FileSystemName A, FileSystemName B)
		{
			return !(A == B);
		}

		/// <summary>
		/// Compares against another object for equality.
		/// </summary>
		/// <param name="Obj">other instance to compare.</param>
		/// <returns>True if the names represent the same object, false otherwise</returns>
		public override bool Equals(object Obj)
		{
			return (Obj is FileSystemName) && ((FileSystemName)Obj) == this;
		}

		/// <summary>
		/// Returns a hash code for this object
		/// </summary>
		/// <returns>Hash code for this object</returns>
		public override int GetHashCode()
		{
			return base.GetHashCode();
		}

		/// <summary>
		/// Returns the display name
		/// </summary>
		/// <returns>The display name</returns>
		public override string ToString()
		{
			return DisplayName;
		}
	}
}