#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2013 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library 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
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#ifndef NUCLEX_INPUT_DEVICES_INPUTDEVICE_H
#define NUCLEX_INPUT_DEVICES_INPUTDEVICE_H

#include <string>

// --------------------------------------------------------------------------------------------- //

namespace Nuclex { namespace Input {

  class InputManager;

}} // namespace Nuclex::Input

namespace Nuclex { namespace Input { namespace Devices {

  // ------------------------------------------------------------------------------------------- //

  /// <summary>Device through which the user can send input to a game</summary>
  /// <typeparam name="TState">Type of states returned by this input device</typeparam>
  template <typename TState>
  class InputDevice {
    friend InputManager; // only the service may trigger snapshots on devices

    /// <summary>Initializes a new input device</summary>
    protected: InputDevice() {}
    /// <summary>Destroys the input device</summary>
    public: virtual ~InputDevice() {}

    /// <summary>Whether the input device is currently attached</summary>
    /// <returns>True if the input device is attached, otherwise false</returns>
    public: virtual bool IsAttached() const = 0;

    /// <summary>Retrieves the human-readable name of the input device</summary>
    /// <returns>The human-readable name of the input device</returns>
    public: virtual const std::string &GetName() const = 0;

    /// <summary>Retrieves the current state of the input device</summary>
    /// <returns>The input device's current state</returns>
    public: virtual const TState &GetState() const = 0;

    /// <summary>Updates the state of the input device</summary>
    protected: virtual void Update() = 0;

    /// <summary>Takes a snapshot of the input device's current state</summary>
    protected: virtual void TakeSnapshot() = 0;

    /// <summary>Removes all snapshots the device has taken</summary>
    protected: virtual void ClearSnapshots() = 0;

    private: InputDevice(const InputDevice &);
    private: InputDevice &operator =(const InputDevice &);

  };

  // ------------------------------------------------------------------------------------------- //

}}} // namespace Nuclex::Input::Devices

#endif // NUCLEX_INPUT_DEVICES_INPUTDEVICE_H