osd_message_queue.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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/>.
 *
 */

#ifndef COMMON_OSD_MESSAGE_QUEUE_H
#define COMMON_OSD_MESSAGE_QUEUE_H

#include "common/events.h"
#include "common/singleton.h"
#include "common/str.h"
#include "common/ustr.h"
#include "common/queue.h"
#include "common/mutex.h"

namespace Graphics {
struct Surface;
}

namespace Common {

class OSDMessageQueue : public Singleton<OSDMessageQueue>, public EventSource {
public:
    OSDMessageQueue();
    ~OSDMessageQueue();

    void registerEventSource();

    enum {
        kMinimumDelay = 1000, 
        kIconCleanupDelay = 2 * 1000, 
    };

    void addMessage(const Common::U32String &msg);

    void addImage(const Graphics::Surface *surface);

    bool pollEvent(Common::Event &event) override;

private:
    struct OSDQueueEntry {
        Common::U32String *_text;
        Graphics::Surface *_image;

        OSDQueueEntry(const Common::U32String &msg);
        OSDQueueEntry(const Graphics::Surface *surface);
        ~OSDQueueEntry();
    };

    Mutex _mutex;
    Queue<OSDQueueEntry *> _messages;
    uint32 _lastUpdate;
    bool _iconWasShown;
};

} // End of namespace Common

#endif