/*
 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 * This component and the accompanying materials are made available
 * under the terms of "Eclipse Public License v1.0"
 * which accompanies this distribution, and is available
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
 *
 * Initial Contributors:
 * Nokia Corporation - initial contribution.
 *
 * Contributors:
 *
 * Description:
 *
 */

#ifndef EMAILTRACE_H
#define EMAILTRACE_H

#include <e32debug.h>
#include <qdebug.h>
#include <qfile.h>

/*
 * The macros COMMENT_TRACES, ERROR_TRACES, and FUNCTION_TRACES control which
 * trace messages are printed. The trace message logging is controlled with
 * the LOG_TO_FILE macro, whereas the LOG_FILE macro defines which file is to
 * be used in logging. The print_trace() helper function implements printing.
 * If LOG_TO_FILE is zero or the LOG_FILE cannot be opened, the messages are
 * printed to qDebug().
 */
#if defined(DEBUG) || defined(_DEBUG)

#define COMMENT_TRACES  1
#define ERROR_TRACES    1
#define FUNCTION_TRACES 1

#if COMMENT_TRACES || ERROR_TRACES || FUNCTION_TRACES

#define LOG_TO_FILE     0
#define LOG_FILE        "c:/logs/nmail_trace.log"

inline void print_trace(const QString& msg)
{
    QFile out(LOG_FILE);
    if (LOG_TO_FILE && out.open(QIODevice::Append | QIODevice::Text)) {
        QDebug(&out) << "[Nmail]" << msg;
        out.putChar('\n');
        out.close();
    } else {
        qDebug() << "[Nmail]" << msg;
    }
}

#endif

#endif /* DEBUG */

/*
 * The function NM_COMMENT() prints a trace message. The INFO macros are
 * provided for legacy compatibility. They are deprecated and should not be
 * used. If sprintf() type of formatting is desired, consider using QString::
 * arg() or QTextStream.
 */
#if COMMENT_TRACES

inline void NM_COMMENT(const QString& msg)
{
    print_trace("COMMENT : " + msg);
}
#define INFO(msg) NM_COMMENT(msg)
#define INFO_1(msg,arg1)\
do {\
    QString __msg;\
    __msg.sprintf(msg,arg1);\
    NM_COMMENT(__msg);\
} while (0)
#define INFO_2(msg,arg1,arg2)\
do {\
    QString __msg;\
    __msg.sprintf(msg,arg1,arg2);\
    NM_COMMENT(__msg);\
} while (0)
#define INFO_3(msg,arg1,arg2,arg3)\
do {\
    QString __msg;\
    __msg.sprintf(msg,arg1,arg2,arg3);\
    NM_COMMENT(__msg);\
} while (0)

#else

#define NM_COMMENT(msg)
#define INFO(msg)
#define INFO_1(msg,arg1)
#define INFO_2(msg,arg1,arg2)
#define INFO_3(msg,arg1,arg2,arg3)

#endif /* COMMENT_TRACES */

/*
 * The function NM_ERROR() prints its second argument if the first argument
 * is non-zero. The ERROR macros are provided for legacy compatibility. They
 * are deprecated and should not be used. If sprintf() type of formatting is
 * desired, consider using QString::arg() or QTextStream.
 */
#if ERROR_TRACES

inline void NM_ERROR(int err, const QString& msg)
{
    if (err) {
        print_trace("ERROR : " + msg);
    }
}
#define ERROR(err,msg) NM_ERROR(err,msg)
#define ERROR_1(err,msg,arg1)\
do {\
    QString __msg;\
    __msg.sprintf(msg,arg1);\
    NM_ERROR(err,__msg);\
} while (0)
#define ERROR_2(err,msg,arg1,arg2)\
do {\
    QString __msg;\
    __msg.sprintf(msg,arg1,arg2);\
    NM_ERROR(err,__msg);\
} while(0)
#define ERROR_3(err,msg,arg1,arg2,arg3)\
do {\
    QString __msg;\
    __msg.sprintf(msg,arg1,srg2,arg3);\
    NM_ERROR(err,__msg);\
} while(0)
#define ERROR_GEN(msg) ERROR(KErrGeneral,msg)
#define ERROR_GEN_1(msg,arg1) ERROR_1(KErrGeneral,msg,arg1)

#else

#define NM_ERROR(err,msg)
#define ERROR(err,msg)
#define ERROR_1(err,msg,arg1)
#define ERROR_2(err,msg,arg1,arg2)
#define ERROR_3(err,msg,arg1,arg2,arg3)
#define ERROR_GEN(msg)
#define ERROR_GEN_1(msg,arg1)

#endif /* ERROR_TRACES */

/*
 * The macro NM_FUNCTION, when used inside a function body, enables tracing
 * for a function. Trace messages with labels ENTER and RETURN are printed
 * when entering into and returning from a function, respectively. In case of
 * an exception or a Symbian leave, a message with label UNWIND is printed
 * (UNWIND stands for stack unwinding). The FUNC_LOG macro is provided for
 * legacy compatibility. It is deprecated and should not be used.
 */
#if FUNCTION_TRACES

class __ftracer
{
public:
    __ftracer(const QString& _fn)
    : fn(_fn)
    {
        print_trace("ENTER : " + fn);
    }
    ~__ftracer()
    {
        if (std::uncaught_exception()) {
            print_trace("UNWIND : " + fn);
        } else {
            print_trace("RETURN : " + fn);
        }
    }
private:
    QString fn;
};

#define NM_FUNCTION __ftracer __ft(__PRETTY_FUNCTION__);
#define FUNC_LOG NM_FUNCTION

#else

#define NM_FUNCTION
#define FUNC_LOG

#endif /* FUNCTION TRACES */

#endif /* EMAILTRACE_H */