OutputListener.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:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

#ifndef _OutputListener_H__
#define _OutputListener_H__

#include "util/UtilPrereqs.h"

#include <vector>

#include "OutputDefinitions.h"

namespace orxonox
{
    //  See below the class declaration for a more detailed description.
    class _UtilExport OutputListener
    {
        public:
            OutputListener(bool bRegister = true);
            virtual ~OutputListener();

            void registerListener(AdditionalContextListener* listener);
            void unregisterListener(AdditionalContextListener* listener);

            void setLevelMax(OutputLevel max);
            void setLevelRange(OutputLevel min, OutputLevel max);
            void setLevelMask(OutputLevel mask);

            void setAdditionalContextsLevelMax(OutputLevel max);
            void setAdditionalContextsLevelRange(OutputLevel min, OutputLevel max);
            void setAdditionalContextsLevelMask(OutputLevel mask);

            virtual void setAdditionalContextsMask(OutputContextMask mask);

            inline OutputLevel getLevelMask() const
                { return this->levelMask_; }
            inline OutputContextMask getAdditionalContextsMask() const
                { return this->additionalContextsMask_; }
            inline OutputLevel getAdditionalContextsLevelMask() const
                { return this->additionalContextsLevelMask_; }

            virtual bool acceptsOutput(OutputLevel level, const OutputContextContainer& context) const;

            virtual void unfilteredOutput(OutputLevel level, const OutputContextContainer& context, const std::vector<std::string>& lines)
                { if (this->acceptsOutput(level, context)) this->output(level, context, lines); }

        protected:
            virtual void output(OutputLevel level, const OutputContextContainer& context, const std::vector<std::string>& lines) = 0;

            inline const std::vector<AdditionalContextListener*>& getListeners() const
                { return this->listeners_; }

        private:
            std::vector<AdditionalContextListener*> listeners_; 

            OutputLevel       levelMask_;                       
            OutputContextMask additionalContextsMask_;          
            OutputLevel       additionalContextsLevelMask_;     
    };

}

#endif /* _OutputListener_H__ */