eventqueue.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#ifndef INCLUDED_SLIDESHOW_SOURCE_INC_EVENTQUEUE_HXX
#define INCLUDED_SLIDESHOW_SOURCE_INC_EVENTQUEUE_HXX
 
#include <canvas/elapsedtime.hxx>
 
#include "event.hxx"
 
#include <mutex>
#include <queue>
#include <utility>
#include <vector>
 
 
/* Definition of ActivitiesQueue class */
 
namespace slideshow::internal
    {
        class EventQueue
        {
        public:
            EventQueue(
                std::shared_ptr< ::canvas::tools::ElapsedTime > pPresTimer );
 
            ~EventQueue();
 
            EventQueue(const EventQueue&) = delete;
            EventQueue& operator=(const EventQueue&) = delete;
 
            bool addEvent( const EventSharedPtr& event );
 
            bool addEventForNextRound( const EventSharedPtr& event );
 
            bool addEventWhenQueueIsEmpty (const EventSharedPtr& rpEvent);
 
            void process();
 
            bool isEmpty() const;
 
            double nextTimeout() const;
 
            void clear();
 
            void forceEmpty();
 
            std::shared_ptr< ::canvas::tools::ElapsedTime > const &
            getTimer() const { return mpTimer; }
 
        private:
            mutable std::mutex      maMutex;
 
            struct EventEntry
            {
                EventSharedPtr  pEvent;
                double          nTime;
 
                bool operator<( const EventEntry& ) const; // to leverage priority_queue's default compare
 
                EventEntry( EventSharedPtr p, double t )
                    : pEvent(std::move(p)), nTime(t) {}
            };
 
            typedef ::std::priority_queue< EventEntry > ImplQueueType;
            ImplQueueType                   maEvents;
            typedef ::std::vector<EventEntry> EventEntryVector;
            EventEntryVector                maNextEvents;
            ImplQueueType                   maNextNextEvents;
            void process_( bool bFireAllEvents );
 
            // perform timing of events via relative time
            // measurements. The world time starts, when the
            // EventQueue object is created
            std::shared_ptr< ::canvas::tools::ElapsedTime > mpTimer;
        };
 
}
#endif // INCLUDED_SLIDESHOW_SOURCE_INC_EVENTQUEUE_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */