src/log4qt/helpers/logobject.h

Go to the documentation of this file.

/******************************************************************************
 *
 * package:     Log4Qt
 * file:        logobject.h
 * created:     September 2007
 * author:      Martin Heinrich
 *
 *
 * changes:     Sep 2008, Martin Heinrich:
 *              - Replaced usage of q_atomic_increment and q_atomic_decrement
 *                with QAtomicInt.
 *              Feb 2009, Martin Heinrich
 *              - Fixed a problem where the pParent parameter of the constructor
 *                was not passed on to the QObject constructor
 *
 *
 * Copyright 2007 - 2009 Martin Heinrich
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/

#ifndef LOG4QT_LOGOBJECT_H
#define LOG4QT_LOGOBJECT_H


/******************************************************************************
 * Dependencies
 ******************************************************************************/

#include <QtCore/QObject>

#include "log4qt/helpers/classlogger.h"
#if QT_VERSION >= QT_VERSION_CHECK(4, 4, 0)
#   include <QtCore/QAtomicInt>
#   ifndef Q_ATOMIC_INT_REFERENCE_COUNTING_IS_ALWAYS_NATIVE
#       warning "QAtomicInt reference counting is not native. The class Log4Qt::LogObject is not thread-safe."
#   endif
#endif


namespace Log4Qt
{

    class Logger;

    class LogObject : public QObject
    {
        Q_OBJECT

    public:
        LogObject(QObject *pObject = 0);

        virtual ~LogObject();

    private:
        LogObject(const LogObject &rOther); // Not implemented
        LogObject &operator=(const LogObject &rOther); // Not implemented

    public:
        int referenceCount() const;

        void release();

        void retain();

    protected:
    #ifndef QT_NO_DEBUG_STREAM

        virtual QDebug debug(QDebug &rDebug) const = 0;

        // Needs to be friend to access internal data
        friend QDebug operator<<(QDebug debug,
                                 const LogObject &rLogObject);
    #endif // QT_NO_DEBUG_STREAM

        Logger* logger() const;

    private:
#if QT_VERSION < QT_VERSION_CHECK(4, 4, 0)
        volatile int mReferenceCount;
#else
        mutable QAtomicInt mReferenceCount;
#endif
        mutable ClassLogger mLog4QtClassLogger;
    };


    /**************************************************************************
     * Operators, Helper
     **************************************************************************/

    #ifndef QT_NO_DEBUG_STREAM

    QDebug operator<<(QDebug debug,
                      const LogObject &rLogObject);
    #endif


    /**************************************************************************
     * Inline
     **************************************************************************/

    inline LogObject::LogObject(QObject *pParent) :
        QObject(pParent),
        mReferenceCount()
    {}

    inline LogObject::~LogObject()
    {}

    inline int LogObject::referenceCount() const
    {   return mReferenceCount; }

    inline void LogObject::release()
#if QT_VERSION < QT_VERSION_CHECK(4, 4, 0)
    {   if ((q_atomic_decrement(&mReferenceCount) == 0) && !parent())
                delete(this);   }
#else
    {   if (!mReferenceCount.deref())
            delete(this);   }
#endif

    inline void LogObject::retain()
#if QT_VERSION < QT_VERSION_CHECK(4, 4, 0)
    {   q_atomic_increment(&mReferenceCount);   }
#else
    {   mReferenceCount.ref();  }
#endif

    inline Logger *LogObject::logger() const
    {   return mLog4QtClassLogger.logger(this);    }

} // namespace Log4Qt


// Q_DECLARE_TYPEINFO(Log4Qt::LogObject, Q_COMPLEX_TYPE); // Use default


#endif // LOG4QT_LOGOBJECT_H

---