xref: /AOO41X/main/slideshow/source/inc/interruptabledelayevent.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef INCLUDED_SLIDESHOW_INTERRUPTABLEDELAYEVENT_HXX
#define INCLUDED_SLIDESHOW_INTERRUPTABLEDELAYEVENT_HXX

#include "delayevent.hxx"

namespace slideshow
{
    namespace internal
    {
        /** Event, which delays calling passed Event's fire() method
            the given amount of time.

            This is actually a facade around the passed event object,
            that passes on all calls to that object, and the sole
            contribution of itself is the delay.
        */
        class DelayFacade : public Event
        {
        public:
            DelayFacade( const EventSharedPtr& 	rEvent,
                         double					nTimeout	) :
#if OSL_DEBUG_LEVEL > 1
                Event(::rtl::OUString::createFromAscii("DelayFacade")),
#endif
                mpEvent( rEvent ),
                mnTimeout( nTimeout )
            {
            }

            virtual bool fire()
            {
                if( mpEvent && isCharged() )
                {
                    // pass on directly - we're supposed to be called
                    // from EventQueue here, anyway - and if not,
                    // we're only keeping that incorrect transitively.
                    return mpEvent->fire();
                }

                return false;
            }

            virtual bool isCharged() const
            {
                // pass on to wrappee - this ensures that we return
                // false on isCharged(), even if the other event has
                // been fired outside our own fire() method
                return !mpEvent ? false : mpEvent->isCharged();
            }

            virtual double getActivationTime( double nCurrentTime ) const
            {
                // enforce _our_ timeout to our clients (this
                // overrides any timeout possibly set at the wrappee!)
                return nCurrentTime + mnTimeout;
            }

            virtual void dispose()
            {
                mpEvent.reset();
            }

        private:
            EventSharedPtr	mpEvent;
            double			mnTimeout;
        };

        /// Return value for makeInterruptableDelay()
        struct InterruptableEventPair
        {
            /** This member contains a pointer to the timeout
                event. When enqueued, this event will fire the
                requested action only after the specified timeout.
             */
            EventSharedPtr	mpTimeoutEvent;

            /** This member contains a pointer to the interruption
                event. When enqueued, this event will fire
                immediately, interrupting a potentially waiting
                timeout event.
             */
            EventSharedPtr	mpImmediateEvent;
        };

        /** Generate an interruptable delay event.

        	This function generates a pair of events, that are
        	especially tailored to achieve the following behaviour: By
        	default, the given functor is called after the specified
        	timeout (after insertion of the event into the EventQueue,
        	of course). But optionally, when the interruption event
        	InterruptableEventPair::mpImmediateEvent is fired, the
        	given functor is called <em>at once</em>, and the delay is
        	ignored (that means, the given functor is guaranteed to be
        	called at utmost once, and never twice. Furthermore, it is
        	ensured that both events return false on isCharged(), once
        	anyone of them has been fired already).

        	@param rFunctor
            Functor to call when the event fires.

            @param nTimeout
            Timeout in seconds, to wait until functor is called.

			@returns a pair of events, where the first one waits the
			specified amount of time, and the other fires the given
			functor immediately.
         */
        template< typename Functor > InterruptableEventPair makeInterruptableDelay( const Functor& 	rFunctor,
                                                                                    double			nTimeout	)
        {
            InterruptableEventPair aRes;

            aRes.mpImmediateEvent = makeEvent( rFunctor, "makeInterruptableDelay");
            aRes.mpTimeoutEvent.reset( new DelayFacade( aRes.mpImmediateEvent,
                                                        nTimeout ) );

            return aRes;
        }
    }
}

#endif /* INCLUDED_SLIDESHOW_INTERRUPTABLEDELAYEVENT_HXX */