// This file is part of the Noddybox.Emulation C# suite.
//
// Noddybox.Emulation 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 3 of the License, or
// (at your option) any later version.
//
// Noddybox.Emulation 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 Noddybox.Emulation.  If not, see <http://www.gnu.org/licenses/>.
//
// Copyright (c) 2012 Ian Cowburn
//
using System;
using System.IO;

namespace Noddybox.Emulation.Keyboard.Schema
{
    /// <summary>
    /// Provides an element for the keyboard definition.
    /// </summary>
    public class KeyboardKey
    {
        #region Properties

        /// <summary>
        /// The symbol the key will be represented by in an enumerated type.
        /// Type checking will only be performed by the actual keyboard implementation
        /// where the value will be used as a key (the other sort).
        /// </summary>
        public string KeySymbol {get; set;}

        /// <summary>
        /// The X-offset of the hit box
        /// </summary>
        public int X { get; set; }

        /// <summary>
        /// The Y-offset of the hit box
        /// </summary>
        public int Y { get; set; }

        /// <summary>
        /// The width of the hit box
        /// </summary>
        public int Width { get; set; }

        /// <summary>
        /// The height of the hit box
        /// </summary>
        public int Height { get; set; }

        /// <summary>
        /// Whether the key is sticky (stays pressed until pressed again).
        /// </summary>
        public bool Sticky { get; set; }

        #endregion

        #region Load/Save

        /// <summary>
        /// Save this object to a stream.
        /// </summary>
        /// <param name="stream">The stream to write to.</param>
        public void Save(BinaryWriter stream)
        {
            stream.Write(KeySymbol);
            stream.Write(X);
            stream.Write(Y);
            stream.Write(Width);
            stream.Write(Height);
            stream.Write(Sticky);
        }

        /// <summary>
        /// Create an instance of this object from a stream.
        /// </summary>
        /// <param name="stream">The stream to read from.</param>
        /// <returns>The KeyboardKey object.</returns>
        public static KeyboardKey Load(BinaryReader stream)
        {
            KeyboardKey key = new KeyboardKey();

            key.KeySymbol = stream.ReadString();
            key.X = stream.ReadInt32();
            key.Y = stream.ReadInt32();
            key.Width = stream.ReadInt32();
            key.Height = stream.ReadInt32();
            key.Sticky = stream.ReadBoolean();

            return key;
        }

        #endregion

        #region Object overrides

        public override string ToString()
        {
            return KeySymbol;
        }

        #endregion
    }
}