NotificationListener.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   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 2
 *   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, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Damian 'Mozork' Frick
 *   Co-authors:
 *      ...
 *
 */

#ifndef _NotificationListener_H__
#define _NotificationListener_H__

#include "OrxonoxPrereqs.h"

#include <ctime>
#include <set>
#include <string>

#include "util/StringUtils.h"

#include "core/class/OrxonoxInterface.h"

namespace orxonox
{
    // TODO: Document.
    enum class NotificationMessageType {
        info,
        important
    };
    
    enum class NotificationSendMode {
        local,
        network,
        broadcast
    };
    
    enum class NotificationCommand {
        none,
        clear
    };

    // TODO: Update doc.
    class _OrxonoxExport NotificationListener : virtual public OrxonoxInterface
    {
        public:
            NotificationListener();
            virtual ~NotificationListener() {}

            static void sendNotification(const std::string& message, const std::string& sender = NotificationListener::NONE, NotificationMessageType messageType = NotificationMessageType::info, NotificationSendMode sendMode = NotificationSendMode::local, unsigned int clientId = 0)
                { NotificationListener::sendNetworkHelper(message, sender, sendMode, clientId, false, messageType); }
            static void sendCommand(const std::string& command, const std::string& sender = NotificationListener::NONE, NotificationSendMode sendMode = NotificationSendMode::local, unsigned int clientId = 0)
                { NotificationListener::sendNetworkHelper(command, sender, sendMode, clientId, true); }

            static void sendHelper(const std::string& message, const std::string& sender, bool isCommand, NotificationMessageType type); // Helper method to register a notification/execute a command with all NotificationListeners after it has been sent over the network.

            //TODO: Make protected?
            
            virtual bool registerNotification(const std::string& message, const std::string& sender, NotificationMessageType type)
                { return false; }
            virtual bool executeCommand(NotificationCommand command, const std::string& sender) { return false; }

        public:
            
            static const std::string ALL; 
            static const std::string NONE; 
            
            static const std::string COMMAND_CLEAR;
            static const std::string COMMAND_NONE;
            
        protected:
            static void sendNetworkHelper(const std::string& message, const std::string& sender, NotificationSendMode sendMode, unsigned int clientId, bool isCommand = false, NotificationMessageType messageType = NotificationMessageType::info); // Helper method to send both notifications and commands over the network.

            static NotificationCommand str2Command(const std::string& string); // Helper method. Converts a string into the enum for a command.
            static const std::string& command2Str(NotificationCommand command); // Helper method. Converts a command enum into its corresponding string.
    };
}

#endif /* _NotificationListener_H__ */