first commit

project/fm_viewer/fav/Logger.h

@@ -0,0 +1,231 @@
+/******************************************************************************
+    QtAV:  Multimedia framework based on Qt and FFmpeg
+    Copyright (C) 2012-2016 Wang Bin <wbsecg1@gmail.com>
+
+*   This file is part of QtAV (from 2013)
+
+    This library 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; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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 library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+******************************************************************************/
+
+/*
+ * Qt Logging Hack
+ * in qmacdefines_mac.h, if qDebug is defined, then if will be defined as QT_NO_QDEBUG_MACRO, don't know why
+ * So you have to include this only as the last #include in cpp file!
+ * DO NOT use qDebug in public header!
+ */
+
+#ifndef QTAV_LOGGER_H
+#define QTAV_LOGGER_H
+
+/*!
+  Environment var
+  QTAV_LOG_TAG: prefix the value to log message
+  QTAV_LOG_LEVEL: set log level, can be "off", "debug", "warning", "critical", "fatal", "all"
+ */
+
+#include <QtDebug> //always include
+
+#ifndef QTAV_NO_LOG_LEVEL
+#include "_fav_constants.h"
+#include <QSharedPointer>
+#ifndef Q_DECL_CONSTEXPR
+#define Q_DECL_CONSTEXPR
+#endif //Q_DECL_CONSTEXPR
+#ifndef Q_DECL_NOTHROW
+#define Q_DECL_NOTHROW
+#endif //Q_DECL_NOTHROW
+#ifndef Q_ATTRIBUTE_FORMAT_PRINTF
+#define Q_ATTRIBUTE_FORMAT_PRINTF(...)
+#endif //Q_ATTRIBUTE_FORMAT_PRINTF
+#ifndef Q_NORETURN
+#define Q_NORETURN
+#endif
+
+#ifndef Q_FUNC_INFO
+#define Q_FUNC_INFO __FUNCTION__
+#endif
+
+namespace FAV {
+namespace Internal {
+
+// internal use when building QtAV library
+class QtAVDebug {
+public:
+    /*!
+     * \brief QtAVDebug
+     * QDebug can be copied from QMessageLogger or others. take the ownership of d
+     * \param d nothing will be logged and t is ignored if null
+     */
+    QtAVDebug(QtMsgType t = QtDebugMsg, QDebug *d = 0);
+    ~QtAVDebug();
+    void setQDebug(QDebug* d);
+    // QDebug api
+    inline QtAVDebug &space() {
+        if (dbg)
+            dbg->space();
+        return *this;
+    }
+    inline QtAVDebug &nospace() {
+        if (dbg)
+            dbg->nospace();
+        return *this;
+    }
+    inline QtAVDebug &maybeSpace() {
+        if (dbg)
+            dbg->maybeSpace();
+        return *this;
+    }
+
+    template<typename T> QtAVDebug &operator<<(T t) {
+        if (!dbg)
+            return *this;
+        const int l = (int)logLevel();
+        if (l <= (int)LogOff)
+            return *this;
+        if (l >= (int)LogAll) {
+            *dbg << t;
+            return *this;
+        }
+        if (l == (int)LogDebug) {
+            *dbg << t;
+            return *this;
+        }
+        if (l == (int)LogWarning) {
+            if ((int)type >= (int)QtWarningMsg)
+                *dbg << t;
+            return *this;
+        }
+        if (l == (int)LogCritical) {
+            if ((int)type >= (int)QtCriticalMsg)
+                *dbg << t;
+            return *this;
+        }
+        if (l == (int)LogFatal) {
+            if ((int)type >= (int)QtFatalMsg)
+                *dbg << t;
+            return *this;
+        }
+        return *this;
+    }
+private:
+    QtMsgType type;
+    // use ptr. otherwise ~QDebug() will print message.
+    QSharedPointer<QDebug> dbg;
+};
+class Logger
+{
+    Q_DISABLE_COPY(Logger)
+public:Q_DECL_CONSTEXPR Logger(const char *file = "unknown", int line = 0, const char *function = "unknown", const char *category = "default")
+        : ctx(file, line, function, category) {}
+    void debug(const char *msg, ...) const Q_ATTRIBUTE_FORMAT_PRINTF(2, 3);
+    void noDebug(const char *, ...) const Q_ATTRIBUTE_FORMAT_PRINTF(2, 3)
+    {}
+    void warning(const char *msg, ...) const Q_ATTRIBUTE_FORMAT_PRINTF(2, 3);
+    void critical(const char *msg, ...) const Q_ATTRIBUTE_FORMAT_PRINTF(2, 3);
+
+    //TODO: QLoggingCategory
+#ifndef Q_CC_MSVC
+    Q_NORETURN
+#endif
+    void fatal(const char *msg, ...) const Q_DECL_NOTHROW Q_ATTRIBUTE_FORMAT_PRINTF(2, 3);
+
+#ifndef QT_NO_DEBUG_STREAM
+    //TODO: QLoggingCategory
+    QtAVDebug debug() const;
+    QtAVDebug warning() const;
+    QtAVDebug critical() const;
+    //QtAVDebug fatal() const;
+    QNoDebug noDebug() const Q_DECL_NOTHROW;
+#endif // QT_NO_DEBUG_STREAM
+#if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
+public: //public can typedef outside
+    class Context {
+        Q_DISABLE_COPY(Context)
+    public:
+        Q_DECL_CONSTEXPR Context(const char *fileName, int lineNumber, const char *functionName, const char *categoryName)
+            : version(1), line(lineNumber), file(fileName), function(functionName), category(categoryName) {}
+#ifndef Q_CC_MSVC
+        Q_NORETURN
+#endif
+        void fatal(const char *msg, ...) const Q_DECL_NOTHROW Q_ATTRIBUTE_FORMAT_PRINTF(2, 3);
+#ifndef QT_NO_DEBUG_STREAM
+        inline QDebug debug() const { return QDebug(QtDebugMsg);}
+        inline QDebug warning() const { return QDebug(QtWarningMsg);}
+        inline QDebug critical() const { return QDebug(QtCriticalMsg);}
+        inline QDebug fatal() const { return QDebug(QtFatalMsg);}
+#endif //QT_NO_DEBUG_STREAM
+        int version;
+        int line;
+        const char *file;
+        const char *function;
+        const char *category;
+    };
+private:
+    Context ctx;
+#else
+private:
+    QMessageLogger ctx;
+#endif
+};
+//simple way
+#if 0
+#undef qDebug
+#define qDebug(fmt, ...) FAV::Logger::debug(#fmt, ##__VA_ARGS__)
+#undef qDebug
+#if !defined(QT_NO_DEBUG_STREAM)
+QtAVDebug debug(const char *msg, ...); /* print debug message */
+#else // QT_NO_DEBUG_STREAM
+#undef qDebug
+QNoDebug debug(const char *msg, ...); /* print debug message */
+#define qDebug QT_NO_QDEBUG_MACRO
+#endif //QT_NO_DEBUG_STREAM
+#endif //0
+
+// complex way like Qt5. can use Qt5's logging context features
+// including qDebug() << ...
+//qDebug() Log(__FILE__, __LINE__, Q_FUNC_INFO).debug
+// DO NOT appear qDebug, qWanring etc in Logger.cpp!  They are undefined and redefined to QtAV:Internal::Logger.xxx
+#undef qDebug //was defined as QMessageLogger...
+#undef qWarning
+#undef qCritical
+#undef qFatal
+// debug and warning output can be disabled at build time in Qt
+// from qdebug.h
+
+#ifdef QT_NO_DEBUG_OUTPUT
+#define QT_NO_WARNING_OUTPUT ////FIXME. qWarning() => Logger.warning() not declared
+#undef qDebug
+inline QNoDebug qDebug() { return QNoDebug(); }
+#define qDebug QT_NO_QDEBUG_MACRO
+#else
+inline QtAVDebug qDebug() { return QtAVDebug(QtDebugMsg); }
+#define qDebug FAV::Internal::Logger(__FILE__, __LINE__, Q_FUNC_INFO).debug
+#endif //QT_NO_DEBUG_OUTPUT
+
+#ifdef QT_NO_WARNING_OUTPUT
+#undef qWarning
+inline QNoDebug qWarning() { return QNoDebug(); }
+#define qWarning QT_NO_QWARNING_MACRO
+#else
+inline QtAVDebug qWarning() { return QtAVDebug(QtWarningMsg); }
+#define qWarning FAV::Internal::Logger(__FILE__, __LINE__, Q_FUNC_INFO).warning
+#endif //QT_NO_WARNING_OUTPUT
+#define qCritical FAV::Internal::Logger(__FILE__, __LINE__, Q_FUNC_INFO).critical
+#define qFatal FAV::Internal::Logger(__FILE__, __LINE__, Q_FUNC_INFO).fatal
+} // namespace Internal
+} // namespace FAV
+
+#endif //QTAV_NO_LOG_LEVEL
+#endif // QTAV_LOGGER_H