#pragma region CPL License
/*
Nuclex Engine
Copyright (C) 2002-2008 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

#ifndef NUCLEX_MAIN_MAIN_H
#define NUCLEX_MAIN_MAIN_H

#include "Nuclex/Nuclex.h"
#include "Nuclex/Support/String.h"

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

namespace Nuclex {

  /// <summary>Environment information provider</summary>
  /// <remarks>
  ///   Provides informations about the environment in which the application was launched
  ///   (eg. which path, operating system)
  /// </remarks>
  class Environment {

    /// <summary>Operating systems</summary>
    public: enum OperatingSystem {
      /// <summary>Unknown OS</summary>
      OS_UNKNWON = 0,
      /// <summary>Win32</summary>
      OS_WIN32,
      /// <summary>Linux</summary>
      OS_LINUX
    };

    /// <summary>Releases all resources owned by the Environment instance</summary>
    public: virtual ~Environment() {}

    //
    // Environment implementation
    //

    /// <summary>Displays a message box</summary>
    /// <param name="sCaption">Caption the displayed message box will have</param>
    /// <param name="sText">Text that will be displayed to the user</param>
    public: virtual void showMessageBox(const string &sCaption, const string &sText) = 0;

    /// <summary>Displays an error message with Ok / Cancel buttons</summary>
    /// <param name="sCaption">Caption the displayed message box will have</param>
    /// <param name="sText">Text that will be displayed to the user</param>
    /// <returns>True if user has pressed the Ok button</returns>
    public: virtual bool showErrorBox(const string &sCaption, const string &sText) = 0;

    /// <summary>
    ///   Returns the command line arguments with which the application was launched
    /// </summary>
    /// <returns>The command line string</returns>
    public: virtual const string &getCommandLine() const = 0;

    /// <summary>Obtains the path from which the application was launched</summary>
    /// <returns>The application's launch path</summary>
    public: virtual const string &getLaunchPath() const = 0;

    /// <summary>Retrieves the path in which the application's executable resides</summary>
    /// <returns>The application's executable path</returns>
    public: virtual const string &getApplicationPath() const = 0;

    /// <summary>Returns the operating system under which the application runs</summary>
    /// <returns>The operating system the application runs on</returns>
    public: virtual OperatingSystem getOperatingSystem() const = 0;

    /// <summary>Returns the amount of memory installed on the system in megabytes</summary>
    /// <returns>The amount of memory in megabytes/returns>
    public: virtual size_t getMemorySize() const = 0;

  };

} // namespace Nuclex

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

/// <summary>Signature of the program entry point the user has to provide</summary>
/// <param name="Environment">
///   Provides informations about the environment to the application
/// </param>
/// <remarks>
///   This is the method the user has to provide instead of main() or WinMain() when linking
///   with the Nuclex.Main library.
/// </remarks>
extern void NuclexMain(const Nuclex::Environment &Environment);

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

#endif // NUCLEX_MAIN_MAIN_H