using System;
using System.Text;

namespace Framework.Input {

  /// <summary>Analogue axis on a joystick</summary>
  public struct JoystickAxis {

    /// <summary>Initializes a new joystick axis</summary>
    /// <param name="axisName">Name of the axis as set in Unity's input manager</param>
    /// <param name="isNegative">Whether to use the negative side of this axis</param>
    public JoystickAxis(string axisName, bool isNegative) {
      this.AxisName = axisName;
      this.IsNegative = isNegative;
    }

    /// <summary>Name of the axis to use for the binding</summary>
    public string AxisName;
    /// <summary>Whether to use the negative side of this axis for the binding</summary>
    public bool IsNegative;

    /// <summary>Checks whether two joystick bindings are identical</summary>
    /// <param name="left">Binding that will be compared on the left side</param>
    /// <param name="right">Binding that will be comapred on the right side</param>
    /// <returns>True if the two bindings are identical</returns>
    public static bool operator ==(JoystickAxis left, JoystickAxis right) {
      return (left.AxisName == right.AxisName) && (left.IsNegative== right.IsNegative);
    }

    /// <summary>Checks whether two joystick bindings are not identical</summary>
    /// <param name="left">Binding that will be compared on the left side</param>
    /// <param name="right">Binding that will be comapred on the right side</param>
    /// <returns>True if the two bindings are not identical</returns>
    public static bool operator !=(JoystickAxis left, JoystickAxis right) {
      return (left.AxisName != right.AxisName) || (left.IsNegative!= right.IsNegative);
    }

    /// <summary>Obtains a hash code that is the same for identical instances</summary>
    /// <returns>The instance's hash code</returns>
    public override int GetHashCode() {
      return this.AxisName.GetHashCode() ^ this.IsNegative.GetHashCode();
    }

    /// <summary>Checks whether another object is equal to this instance</summary>
    /// <param name="otherObject">Other object that will be compared</param>
    /// <returns>True if the other object is equal, false otherwise</returns>
    public override bool Equals(object otherObject) {
      if(otherObject is JoystickAxis) {
        var other = (JoystickAxis)otherObject;
        return (this.AxisName == other.AxisName) && (this.IsNegative== other.IsNegative);
      } else {
        return false;
      }
    }

    /// <summary>Returns a describing string for this instance</summary>
    /// <returns>A string describing the instance's identity</returns>
    public override string ToString() {
      var builder = new StringBuilder(18 + this.AxisName.Length);

      builder.Append("{Axis ");
      builder.Append(this.AxisName);
      if(this.IsNegative) {
        builder.Append(" (negative)}");
      } else {
        builder.Append(" (positive)}");
      }

      return builder.ToString();
    }

  }

} // namespace Framework.Input