using System;

using Framework.Services;
using Framework.Storage.Containers;

namespace Framework.Storage {

  /// <summary>Stores the persistent data of the game</summary>
  /// <remarks>
  ///   <para>
  ///     The recommended usage is to write a game-specific persistent settings accessor
  ///     that will initialize the container types so the game is guaranteed to always have
  ///     the correct container types throughout.
  ///   </para>
  /// </remarks>
  [
    ServiceScope(Scope.Global),
    DefaultBinding(typeof(PersistentSettingsManager))
  ]
  public interface IPersistentSettingsStore {

    /// <summary>Called when the persistent state store has been initialized</summary>
    event Action Initialized;

    /// <summary>Initializes the types that will be used by the store</summary>
    /// <typeparam name="TUserSettings">
    ///   Type that will be used to store user-specific settings such as key bindings,
    ///   mouse speed or language.
    /// </typeparam>
    /// <typeparam name="TMachineSettings">
    ///   Type that will be used to store machine-specific settings such as resolution,
    ///   monitor and detail levels.
    /// </typeparam>
    /// <typeparam name="TAchievements">
    ///   Type that will be used to store global unlocks and achievements
    /// </typeparam>
    /// <remarks>
    ///   The default implementation of the persistent store requires this method to be called
    ///   before any of the other properties and methods of the persistent store will work.
    ///   It will load the game's current settings from their default locations if available
    ///   and create new default instances if no saved settings exist.
    /// </remarks>
    void Initialize<
      TMachineSettings,
      TUserSettings,
      TAchievements
    >(
      IPersistentStateSerializer<TMachineSettings> machineSettingsSerializer = null,
      IPersistentStateSerializer<TUserSettings> userSettingsSerializer = null,
      IPersistentStateSerializer<TAchievements> achievementSerializer = null
    )
      where TMachineSettings : class, IMachineSettings, new()
      where TUserSettings : class, IUserSettings, new()
      where TAchievements : class, IAchievements, new();

    /// <summary>Whether the persistent data store has been initialized already</summary>
    bool IsInitialized { get; }

    /// <summary>Container for machine-specific settings such as display parameters</summary>
    IPersistentContainer<IMachineSettings> MachineSettings { get; }

    /// <summary>Container for user-specific settings such as key bindings</summary>
    IPersistentContainer<IUserSettings> UserSettings { get; }

    /// <summary>Container for global unlocks and achievements</summary>
    IVerifiedPersistentContainer<IAchievements> Achievements { get; }

    /// <summary>Loads all persistent settings from the current serialized state</summary>
    void LoadAllSettings();

    /// <summary>Saves all persistent settings into their respective files</summary>
    void SaveAllSettings();

/*
    /// <summary>Resets all persistent settings to their defaults</summary>
    void ResetAllSettings();

    /// <summary>Resets the achievements container to its defaults</summary>
    void ResetAchievements();
*/

  }

} // namespace Framework.Storage