Timer.cs

Siirry tämän tiedoston dokumentaatioon.

#region MIT License
/*
 * Copyright (c) 2009 University of Jyväskylä, Department of Mathematical
 * Information Technology.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#endregion

/*
 * Authors: Tero Jäntti, Tomi Karppinen, Janne Nikkanen.
 */

using System;
using System.Collections.Generic;
using System.ComponentModel;

namespace Jypeli
{
    public sealed class Timer
    {
        #region Events

        public event Action Timeout;

        public event Action Stopped;
        protected void OnStopped()
        {
            if (Stopped != null)
            {
                Stopped();
            }
        }

        #endregion

        private static SynchronousList<Timer> timers = new SynchronousList<Timer>();
        private static Dictionary<Action, Timer> limiters = new Dictionary<Action, Timer>();

        private bool _enabled = false;

        private TimeSpan timeToTrigger = TimeSpan.MaxValue;
        private TimeSpan trigInterval = new TimeSpan( 0, 0, 1 );
        private TimeSpan savedTrigger = TimeSpan.Zero;
        
        private TimeSpan timeToCount = TimeSpan.MaxValue;
        private TimeSpan countInterval = TimeSpan.FromMilliseconds( 10 );
        private TimeSpan savedCount = TimeSpan.Zero;

        #region Properties

        public bool Enabled
        {
            get { return _enabled; }
            set
            {
                if ( value == _enabled ) return;
                if ( value )
                    Start();
                else
                    Stop();
            }
        }

        public bool IgnorePause { get; set; }

        public double Interval
        {
            get { return trigInterval.TotalSeconds; }
            set
            {
                if ( value <= 0 ) throw new ArgumentException( "Interval cannot be zero or negative!" );
                trigInterval = TimeSpan.FromSeconds( value );
                if ( Enabled )
                    timeToTrigger = trigInterval;
            }
        }

        public double CurrentTime
        {
            get { return SecondCounter.Value; }
            set { SecondCounter.Value = value; }
        }

        //public TimeSpan StartTime { get; private set; }

        public DoubleMeter SecondCounter { get; private set; }

        public double SecondCounterStep { get; set; }

        public IntMeter Times { get; private set; }

        public bool TimesLimited
        {
            get { return Times.MinValue == 0; }
            set
            {
                Times.MinValue = value ? 0 : 1;
            }
        }

        public object Tag { get; set; }

        #endregion

        #region Public methods

        public Timer()
        {
            SecondCounter = new DoubleMeter( 0 );
            Times = new IntMeter( 1 );
            Times.MinValue = 1;
            Times.MaxValue = 1;
            Enabled = false;
        }

        public static void SingleShot( double seconds, Action onTimeout )
        {
            Timer t = new Timer();
            t.Interval = seconds;
            t.Timeout += onTimeout;
            t.Start( 1 );
        }

        public static void Limit( Action action, double seconds )
        {
            Timer limiter = limiters.ContainsKey( action ) ? limiters[action] : null;

            if ( limiter == null )
            {
                limiter = new Timer() { Interval = seconds };
                limiters.Add( action, limiter );
            }

            if ( !limiter.Enabled )
            {
                action();
                limiter.Start( 1 );
            }
        }
        
        public void Start()
        {
            _enabled = true;
            timeToTrigger = trigInterval;
            timeToCount = countInterval;
            timers.Add( this );
        }

        public void Start( int times )
        {
            _enabled = true;
            LimitTimes( times );
            timeToTrigger = trigInterval - savedTrigger;
            timeToCount = countInterval - savedCount;
            timers.Add( this );
        }

        public void Pause()
        {
            _enabled = false;
            savedTrigger = trigInterval - timeToTrigger;
            savedCount = countInterval - timeToCount;
            timers.Remove( this );
        }

        public void Stop()
        {
            _enabled = false;
            savedTrigger = TimeSpan.Zero;
            savedCount = TimeSpan.Zero;
            timers.Remove( this );
            OnStopped();
        }

        public void Reset()
        {
            SecondCounter.Reset();
            Times.Reset();
            timeToTrigger = trigInterval;
        }

        private void LimitTimes( int numTimes )
        {
            TimesLimited = true;
            Times.DefaultValue = numTimes;
            Times.MaxValue = numTimes;
            Times.Value = numTimes;
        }

        internal static void ClearAll()
        {
            timers.Clear();
        }

        private static void UpdateTimer( Timer timer, TimeSpan dt )
        {
            if ( !timer.Enabled )
                return;

            timer.timeToCount -= dt;

            while ( timer.timeToCount.TotalSeconds <= 0 )
            {
                // Count second counter
                timer.timeToCount += timer.countInterval;
                timer.SecondCounter.Value += timer.countInterval.TotalSeconds;
            }

            if ( timer.Timeout != null || timer.TimesLimited )
            {
                timer.timeToTrigger -= dt;

                while ( timer.timeToTrigger.TotalSeconds <= 0 )
                {
                    // Trigger timeouts
                    timer.timeToTrigger += timer.trigInterval;

                    if ( timer.TimesLimited )
                    {
                        if ( --timer.Times.Value <= 0 )
                        {
                            // The timer has executed its maximum times, stop it
                            timer.Stop();
                        }
                    }

                    if ( timer.Timeout != null )
                        timer.Timeout();
                }
            }
        }

        internal static void UpdateAll( Time time )
        {
            timers.Update( time );
            timers.ForEach( UpdateTimer, time.SinceLastUpdate );
        }

        internal static void UpdateAll( Time time, Predicate<Timer> isUpdated )
        {
            timers.Update( time );

            foreach ( var timer in timers )
            {
                if ( isUpdated( timer ) )
                    UpdateTimer( timer, time.SinceLastUpdate );
            }
        }

        #endregion
    }
}