1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_SLIDESHOW_EVENTQUEUE_HXX 25*b1cdbd2cSJim Jagielski #define INCLUDED_SLIDESHOW_EVENTQUEUE_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <canvas/elapsedtime.hxx> 28*b1cdbd2cSJim Jagielski #include <osl/mutex.hxx> 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski #include "event.hxx" 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski #include <boost/noncopyable.hpp> 33*b1cdbd2cSJim Jagielski #include <functional> 34*b1cdbd2cSJim Jagielski #include <queue> 35*b1cdbd2cSJim Jagielski #include <vector> 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski /* Definition of ActivitiesQueue class */ 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski namespace slideshow 41*b1cdbd2cSJim Jagielski { 42*b1cdbd2cSJim Jagielski namespace internal 43*b1cdbd2cSJim Jagielski { 44*b1cdbd2cSJim Jagielski /** This class handles events in a presentation. Events are 45*b1cdbd2cSJim Jagielski time instants where e.g. effects start. 46*b1cdbd2cSJim Jagielski */ 47*b1cdbd2cSJim Jagielski class EventQueue : private ::boost::noncopyable 48*b1cdbd2cSJim Jagielski { 49*b1cdbd2cSJim Jagielski public: 50*b1cdbd2cSJim Jagielski EventQueue( 51*b1cdbd2cSJim Jagielski ::boost::shared_ptr< ::canvas::tools::ElapsedTime > 52*b1cdbd2cSJim Jagielski const & pPresTimer ); 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski ~EventQueue(); 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski /** Add the given event to the queue. The event is fired 57*b1cdbd2cSJim Jagielski at, or shortly after, its Event::getActivationTime instant. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski bool addEvent( const EventSharedPtr& event ); 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski /** Add the given event to the queue. The event is fired 62*b1cdbd2cSJim Jagielski at, or shortly after, its Event::getActivationTime instant. 63*b1cdbd2cSJim Jagielski The difference to addEvent() is that events added during 64*b1cdbd2cSJim Jagielski process() are postponed to next process(). 65*b1cdbd2cSJim Jagielski */ 66*b1cdbd2cSJim Jagielski bool addEventForNextRound( const EventSharedPtr& event ); 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski /** Another way to control the order of asynchronous event 69*b1cdbd2cSJim Jagielski exeqution. Use this method to schedule events that are to 70*b1cdbd2cSJim Jagielski be executed after all regular events that have no delay, 71*b1cdbd2cSJim Jagielski even when they schedule new regular events without delay. 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski bool addEventWhenQueueIsEmpty (const EventSharedPtr& rpEvent); 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** Process the event queue. 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski This method executes all events whose timeout has 78*b1cdbd2cSJim Jagielski expired when calling this method (i.e. all events 79*b1cdbd2cSJim Jagielski whose scheduled time is less or equal the current 80*b1cdbd2cSJim Jagielski time). 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski Check for the next available event's timeout via 83*b1cdbd2cSJim Jagielski nextTimeout(), or whether the queue is empty 84*b1cdbd2cSJim Jagielski altogether via isEmpty(). 85*b1cdbd2cSJim Jagielski */ 86*b1cdbd2cSJim Jagielski void process(); 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski /** Query state of the queue 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski @return false, if queue is empty, true otherwise 91*b1cdbd2cSJim Jagielski */ 92*b1cdbd2cSJim Jagielski bool isEmpty() const; 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski /** Query timeout for the topmost event in the queue. 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski @return Timeout in seconds, until the next event is 97*b1cdbd2cSJim Jagielski ready. The time returned here is relative to the pres 98*b1cdbd2cSJim Jagielski timer (i.e. the timer specified at the EventQueue 99*b1cdbd2cSJim Jagielski constructor). When the queue is empty (i.e. isEmpty() 100*b1cdbd2cSJim Jagielski returns true), the returned value is the highest 101*b1cdbd2cSJim Jagielski representable double value 102*b1cdbd2cSJim Jagielski (::std::numeric_limits<double>::max()). If the topmost 103*b1cdbd2cSJim Jagielski event in the queue is already pending, the timeout 104*b1cdbd2cSJim Jagielski returned here will actually be negative. 105*b1cdbd2cSJim Jagielski */ 106*b1cdbd2cSJim Jagielski double nextTimeout() const; 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski /** Remove all pending events from the queue. 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski void clear(); 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski /** Forces an empty queue, firing all events immediately 113*b1cdbd2cSJim Jagielski without minding any times. 114*b1cdbd2cSJim Jagielski @attention do only call from event loop, this calls process_()! 115*b1cdbd2cSJim Jagielski */ 116*b1cdbd2cSJim Jagielski void forceEmpty(); 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski /** Gets the queue's timer object. 119*b1cdbd2cSJim Jagielski */ 120*b1cdbd2cSJim Jagielski ::boost::shared_ptr< ::canvas::tools::ElapsedTime > const & getTimer() const121*b1cdbd2cSJim Jagielski getTimer() const { return mpTimer; } 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski private: 124*b1cdbd2cSJim Jagielski mutable ::osl::Mutex maMutex; 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski struct EventEntry : public ::std::unary_function<EventEntry, bool> 127*b1cdbd2cSJim Jagielski { 128*b1cdbd2cSJim Jagielski EventSharedPtr pEvent; 129*b1cdbd2cSJim Jagielski double nTime; 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski bool operator<( const EventEntry& ) const; // to leverage priority_queue's default compare 132*b1cdbd2cSJim Jagielski EventEntryslideshow::internal::EventQueue::EventEntry133*b1cdbd2cSJim Jagielski EventEntry( EventSharedPtr const& p, double t ) 134*b1cdbd2cSJim Jagielski : pEvent(p), nTime(t) {} 135*b1cdbd2cSJim Jagielski }; 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski typedef ::std::priority_queue< EventEntry > ImplQueueType; 138*b1cdbd2cSJim Jagielski ImplQueueType maEvents; 139*b1cdbd2cSJim Jagielski typedef ::std::vector<EventEntry> EventEntryVector; 140*b1cdbd2cSJim Jagielski EventEntryVector maNextEvents; 141*b1cdbd2cSJim Jagielski ImplQueueType maNextNextEvents; 142*b1cdbd2cSJim Jagielski void process_( bool bFireAllEvents ); 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski // perform timing of events via relative time 145*b1cdbd2cSJim Jagielski // measurements. The world time starts, when the 146*b1cdbd2cSJim Jagielski // EventQueue object is created 147*b1cdbd2cSJim Jagielski ::boost::shared_ptr< ::canvas::tools::ElapsedTime > mpTimer; 148*b1cdbd2cSJim Jagielski }; 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski } 151*b1cdbd2cSJim Jagielski } 152*b1cdbd2cSJim Jagielski #endif /* INCLUDED_SLIDESHOW_EVENTQUEUE_HXX */ 153