// 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;
using System.Collections.Generic;

namespace Noddybox.Emulation.Keyboard.Schema
{
    /// <summary>
    /// Provides the schema for the keyboard definition.
    /// </summary>
    public class KeyboardDefinition
    {
        #region Version

        private const string magic = "KEYBDEF1.0";

        #endregion

        #region Properties

        /// <summary>
        /// Get the list of keyboard key defintiions.
        /// </summary>
        public List<KeyboardKey> Definitions {get; private set;}

        #endregion

        #region Load/Save

        /// <summary>
        /// Save this keybaord definition to the stream.
        /// </summary>
        /// <param name="stream">The stream to write to.</param>
        public void Save(BinaryWriter stream)
        {
            stream.Write(magic);
            stream.Write(Definitions.Count);
            
            foreach (KeyboardKey k in Definitions)
            {
                k.Save(stream);
            }
        }

        /// <summary>
        /// Load a keyboard definition from the passed stream.
        /// </summary>
        /// <param name="stream">The stream to read from.</param>
        /// <returns>The KeyboardDefinition object.</returns>
        public static KeyboardDefinition Load(BinaryReader stream)
        {
            if (stream.ReadString() != magic)
            {
                throw new ArgumentException("Stream has wrong magic");
            }

            KeyboardDefinition keyboard = new KeyboardDefinition();

            int count = stream.ReadInt32();

            for(int f = 0; f < count ; f++)
            {
                keyboard.Definitions.Add(KeyboardKey.Load(stream));
            }

            return keyboard;
        }

        #endregion

        #region Constructors

        public KeyboardDefinition()
        {
            Definitions = new List<KeyboardKey>();
        }

        #endregion
    }
}