Log.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of FRAPPER
research.animationsinstitut.de
sourceforge.net/projects/frapper

Copyright (c) 2008-2009 Filmakademie Baden-Wuerttemberg, Institute of Animation 

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; version 2.1 of the License.

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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
-----------------------------------------------------------------------------
*/


#ifndef LOG_H
#define LOG_H

#include "FrapperPrerequisites.h"
#include <QtGui/QTableView>
#include <QtGui/QStandardItemModel>
#include <QtGui/QSortFilterProxyModel>
#include <QtGui/QIcon>

namespace Frapper {

class FRAPPER_CORE_EXPORT Log
{

public: // nested enumerations

    enum MessageType {
        MT_Info = 1,
        MT_Warning = 2,
        MT_Error = 4,
        MT_Debug = 8,
        MT_Qt = 16,
        MT_Ogre = 32
    };

private: // type definitions

    typedef QMap<int, QStandardItemModel *> MessageModelMap;

    typedef QMap<int, QSortFilterProxyModel *> ProxyModelMap;

    typedef QMap<Log::MessageType, bool> MessageFilters;

    typedef QPair<bool, MessageFilters> FilterSettings;

    typedef QMap<QTableView *, FilterSettings> TableViewMap;

public: // static functions

    static void initialize ( bool useStandardStreams );

    static void finalize ();

    static void loadIcons ();

    static void registerView ( QTableView *tableView );

    static void unregisterView ( QTableView *tableView );

    static void info ( const QString &message, const QString &function = "" );

    static void warning ( const QString &message, const QString &function = "" );

    static void error ( const QString &message, const QString &function = "" );

    static void debug ( const QString &message, const QString &function = "" );

    static void na ( const QString &function = "" );

    static void addQtLogMessage ( QtMsgType qtMessageType, const char *qtMessage );

    static void addOgreLogMessage ( const QString &message, const QString &logMessageLevel );

    static void setFilterEnabled ( QTableView *tableView, bool enabled );

    static void filter ( QTableView *tableView, MessageType type, bool visible );

    static void filter ( QTableView *tableView, const QString &searchText);

    static void clear ();

    static QString getMessage ( QStandardItemModel *model, int row );

private: // static functions

    static void addMessage ( MessageType messageType, const QString &message, const QString &function = "" );

    static void updateModel ( QTableView *tableView );

    static void printToStandardOutput ( const QString &header, const QString &message, const QString &function );

    static void printToStandardError ( const QString &header, const QString &message, const QString &function );

private: // static data

    static bool s_useStandardStreams;

    static bool s_initialized;

    static QStringList s_headerLabels;

    static MessageModelMap s_messageModels;

    static ProxyModelMap s_proxyModels;

    static TableViewMap s_tableViews;

    static QMap<MessageType, QIcon> s_messageIcons;

};

} // end namespace Frapper

#endif