// Copyright (c) 2007 Omer Rauchwerger (a.k.a rauchy) (omer@rauchy.net)
// All rights reserved.
//
// This file is part of Regionerate.
// 
// This program 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.
//
// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

namespace Rauchy.Regionerate.Shared.Components
{
    /// <summary>
    /// Provides quick access for user interface notifications.
    /// </summary>
    public static class Output
    {
        #region Enums (1) 

        /// <summary>
        /// Describes the severity of a warning.
        /// </summary>
        public enum WarningLevel
        {
            /// <summary>
            /// Indicates that an action that was chosen to perform might lead to undesirable results.
            /// </summary>
            NonCritical = 0,

            /// <summary>
            /// Indicates that an action failed to perform, which might lead to corrupt or lost code.
            /// </summary>
            Critical
        }

        #endregion Enums 

        #region Delegates and Events (9) 

        // Delegates (3) 

// [rgn] Delegates (3)
        /// <summary>
        /// Occurs when new information is submitted.
        /// </summary>
        /// <param name="text">The new information text.</param>
        public delegate void InformationSubmitted( string text );

        /// <summary>
        /// Occurs when an operation's progress is increased.
        /// </summary>
        /// <param name="value">The current progress value.</param>
        /// <param name="targetValue">The maximum value that represents a complete operation.</param>
        public delegate void ProgressChanged( long value, long targetValue );

        /// <summary>
        /// Occurs when a new warning is submitted.
        /// </summary>
        /// <param name="text">The new warning text.</param>
        /// <param name="level">The level of warning (critical, non-critical etc.)</param>
        public delegate void WarningSubmitted( string text, WarningLevel level );

        // Events (6) 

        // [rgn] Events (6)
        private static event InformationSubmitted _onInformationSubmitted;

        private static event ProgressChanged _onProgressChanged;

        private static event WarningSubmitted _onWarningSubmitted;

        /// <summary>
        /// Occurs when new information is submitted.
        /// </summary>
        public static event InformationSubmitted OnInformationSubmitted
        {
            add
            {
                _onInformationSubmitted += value;
            }
            remove
            {
                _onInformationSubmitted -= value;
            }
        }

        /// <summary>
        /// Occurs when an operation's progress is increased.
        /// </summary>
        public static event ProgressChanged OnProgressChanged
        {
            add
            {
                _onProgressChanged += value;
            }
            remove
            {
                _onProgressChanged -= value;
            }
        }

        /// <summary>
        /// Occurs when a new warning is submitted.
        /// </summary>
        public static event WarningSubmitted OnWarningSubmitted
        {
            add
            {
                _onWarningSubmitted += value;
            }
            remove
            {
                _onWarningSubmitted -= value;
            }
        }

        #endregion Delegates and Events 

        #region Methods (4) 

        // Public Methods (4) 

        // [rgn] Public Methods (4)
        /// <summary>
        /// Disconnects all registered event handlers.
        /// </summary>
        public static void Disconnect()
        {
            _onInformationSubmitted = null;
            _onWarningSubmitted = null;
            _onProgressChanged = null;
        }

        /// <summary>
        /// Informs about the specified text.
        /// </summary>
        /// <param name="text">The text.</param>
        /// <param name="parameters">The parameters to include in the formatted information text.</param>
        public static void Inform( string text, params string[] parameters )
        {
            if ( _onInformationSubmitted != null )
            {
                string formattedText = string.Format( text, parameters );
                _onInformationSubmitted( formattedText );
            }
        }

        /// <summary>
        /// Sets the progress of an operation.
        /// </summary>
        /// <param name="value">The value.</param>
        /// <param name="targetValue">The target value.</param>
        public static void SetProgress( long value, long targetValue )
        {
            if ( _onProgressChanged != null )
            {
                _onProgressChanged( value, targetValue );
            }
        }

        /// <summary>
        /// Warns about the specified text.
        /// </summary>
        /// <param name="text">The text.</param>
        /// <param name="level">The warning level.</param>
        /// <param name="parameters">The parameters to include in the formatted warning text.</param>
        public static void Warn( string text, WarningLevel level, params string[] parameters )
        {
            if ( _onWarningSubmitted != null )
            {
                string formattedText = string.Format( text, parameters );
                _onWarningSubmitted( formattedText, level );
            }
        }

        #endregion Methods 
    }
}