//
//  mythnotificationcenter.h
//  MythTV
//
//  Created by Jean-Yves Avenard on 25/06/13.
//  Copyright (c) 2013 Bubblestuff Pty Ltd. All rights reserved.
//

#ifndef __MythTV__mythnotifications__
#define __MythTV__mythnotifications__

#include <QList>
#include <QDateTime>
#include <QMutex>

#include "mythuiexp.h"

#include "mythnotification.h"

// .h

class MythScreenType;
class NCPrivate;

class MUI_PUBLIC MythNotificationCenterEvent : public MythEvent
{
public:
    MythNotificationCenterEvent() : MythEvent(kEventType) { }

    static Type kEventType;
};

class MUI_PUBLIC MythNotificationCenter
{
public:
    MythNotificationCenter(void);
    virtual ~MythNotificationCenter();

    /**
     * Queue a notification
     * Queue() is thread-safe and can be called from anywhere.
     * Typical use would be GetNotificationCenter()->Queue(notification)
     */
    bool Queue(const MythNotification &notification);

    /**
     * returns the MythNotificationCenter singleton
     */
    static MythNotificationCenter *GetInstance(void);

    /**
     * An application can register in which case it will be assigned a
     * reusable screen, which can be modified or updated
     * Register takes a pointer of the client registering. This is used
     * to make sure a registered Id can only be used by the client who registered
     * for it.
     * Returns a unique Id that can be provided with a MythNotification
     * Return -1 is case of error
     */
    int  Register(void *from);
    /**
     * Unregister the client.
     * If the notification had set a duration, the screen will be left to
     * laps, unless forcedisconnect is set; in which case the screen will
     * be closed immediately.
     */
    void UnRegister(void *from, int id, bool closeimemdiately = false);

    /*
     * OSD drawing utilities
     */

    /**
     * Return when the given screen is going to expire
     * will return an invalid QDateTime if screen isn't a MythNotificationScreen
     */
    QDateTime ScreenExpiryTime(const MythScreenType *screen);
    /**
     * Return true if \::Create() has been called on screen.
     * will always return true should screen not be a MythNotificationScreen
     */
    bool ScreenCreated(const MythScreenType *screen);
    /**
     * Return the list of notification screens being currently displayed.
     * The list contains pointer of existing screen's copies, with \::Create()
     * not called yet.
     */
    void GetNotificationScreens(QList<MythScreenType*> &screens);
    /**
     * Will call \::doInit() if the screen is a MythNotificationScreen and
     * \::Create() has been called for it already
     */
    void UpdateScreen(MythScreenType *screen);
    /**
     * Returns number of notifications currently displayed
     */
    int DisplayedNotifications(void) const;
    /**
     * Returns number of notifications currently queued
     */
    int QueuedNotifications(void) const;
    /**
     * Will remove the oldest notification from the stack
     * return true if a screen was removed; or false if nothing was done
     */
    bool RemoveFirst(void);
    /**
     * ProcessQueue will be called by the GUI event handler and will process
     * all queued MythNotifications and delete screens marked to be deleted
     * ProcessQueue must be called from GUI thread
     */
    void ProcessQueue(void);

private:
    NCPrivate *d;
};

/**
 * convenience utility to display error message as notification
 */
MUI_PUBLIC void ShowNotificationError(const QString &msg,
                                      const QString &from = QString(),
                                      const QString &detail = QString(),
                                      const VNMask visibility = MythNotification::kAll,
                                      const MythNotification::Priority priority = MythNotification::kDefault);

MUI_PUBLIC void ShowNotification(const QString &msg,
                                 const QString &from = QString(),
                                 const QString &detail = QString(),
                                 const VNMask visibility = MythNotification::kAll,
                                 const MythNotification::Priority priority = MythNotification::kDefault);

MUI_PUBLIC void ShowNotification(bool  error,
                                 const QString &msg,
                                 const QString &origin = QString(),
                                 const QString &detail = QString(),
                                 const QString &image = QString(),
                                 const QString &extra = QString(),
                                 const QString &progress_text = QString(),
                                 float progress = -1.0f,
                                 int   duration = -1,
                                 bool  fullscreen = false,
                                 const VNMask visibility = MythNotification::kAll,
                                 const MythNotification::Priority priority = MythNotification::kDefault,
                                 const QString &style = QString());

MUI_PUBLIC void ShowNotification(MythNotification::Type type,
                                 const QString &msg,
                                 const QString &origin = QString(),
                                 const QString &detail = QString(),
                                 const QString &image = QString(),
                                 const QString &extra = QString(),
                                 const QString &progress_text = QString(),
                                 float progress = -1.0f,
                                 int   duration = -1,
                                 bool  fullscreen = false,
                                 const VNMask visibility = MythNotification::kAll,
                                 const MythNotification::Priority priority = MythNotification::kDefault,
                                 const QString &style = QString());

#endif /* defined(__MythTV__mythnotifications__) */
