emailservices/emaildebug/inc/emailtrace.h
author hgs
Thu, 10 Jun 2010 16:14:05 +0300
changeset 44 c2d07d913565
parent 43 99bcbff212ad
child 47 f83bd4ae1fe3
permissions -rw-r--r--
201023
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     1
/*
40
hgs
parents: 18
diff changeset
     2
 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents: 18
diff changeset
     3
 * All rights reserved.
hgs
parents: 18
diff changeset
     4
 * This component and the accompanying materials are made available
hgs
parents: 18
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
hgs
parents: 18
diff changeset
     6
 * which accompanies this distribution, and is available
hgs
parents: 18
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents: 18
diff changeset
     8
 *
hgs
parents: 18
diff changeset
     9
 * Initial Contributors:
hgs
parents: 18
diff changeset
    10
 * Nokia Corporation - initial contribution.
hgs
parents: 18
diff changeset
    11
 *
hgs
parents: 18
diff changeset
    12
 * Contributors:
hgs
parents: 18
diff changeset
    13
 *
hgs
parents: 18
diff changeset
    14
 * Description:
hgs
parents: 18
diff changeset
    15
 *
hgs
parents: 18
diff changeset
    16
 */
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    17
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    18
#ifndef EMAILTRACE_H
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    19
#define EMAILTRACE_H
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    20
40
hgs
parents: 18
diff changeset
    21
#include <e32debug.h>
hgs
parents: 18
diff changeset
    22
#include <qdebug.h>
hgs
parents: 18
diff changeset
    23
#include <qfile.h>
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    24
40
hgs
parents: 18
diff changeset
    25
/*
44
hgs
parents: 43
diff changeset
    26
 * The NM_TRACING_SYSTEM macro can be used to enable and disable the tracing
hgs
parents: 43
diff changeset
    27
 * system in debug mode. The tracing system can be disabled in a specific
hgs
parents: 43
diff changeset
    28
 * source file by defining the macro "NM_TRACING_SYSTEM 0" before this file
hgs
parents: 43
diff changeset
    29
 * is included.
40
hgs
parents: 18
diff changeset
    30
 */
44
hgs
parents: 43
diff changeset
    31
#ifndef NM_TRACING_SYSTEM
hgs
parents: 43
diff changeset
    32
#define NM_TRACING_SYSTEM 1
hgs
parents: 43
diff changeset
    33
#endif
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    34
44
hgs
parents: 43
diff changeset
    35
/*
hgs
parents: 43
diff changeset
    36
 * The macros NM_COMMENT_TRACES, NM_ERROR_TRACES, and NM_FUNCTION_TRACES
hgs
parents: 43
diff changeset
    37
 * control which debug messages are printed. The trace logging is controlled
hgs
parents: 43
diff changeset
    38
 * with the NM_LOG_TO_FILE macro, whereas the NM_LOG_FILE macro defines which
hgs
parents: 43
diff changeset
    39
 * file is to be used in logging. The print_trace() helper function implements
hgs
parents: 43
diff changeset
    40
 * printing. If NM_LOG_TO_FILE is zero or the NM_LOG_FILE cannot be opened,
hgs
parents: 43
diff changeset
    41
 * the messages are printed to qDebug().
hgs
parents: 43
diff changeset
    42
 */
hgs
parents: 43
diff changeset
    43
#if NM_TRACING_SYSTEM && (defined(DEBUG) || defined(_DEBUG))
40
hgs
parents: 18
diff changeset
    44
44
hgs
parents: 43
diff changeset
    45
#define NM_COMMENT_TRACES  1
hgs
parents: 43
diff changeset
    46
#define NM_ERROR_TRACES    1
hgs
parents: 43
diff changeset
    47
#define NM_FUNCTION_TRACES 1
40
hgs
parents: 18
diff changeset
    48
44
hgs
parents: 43
diff changeset
    49
#if NM_COMMENT_TRACES || NM_ERROR_TRACES || NM_FUNCTION_TRACES
hgs
parents: 43
diff changeset
    50
hgs
parents: 43
diff changeset
    51
#define NM_LOG_TO_FILE 0
hgs
parents: 43
diff changeset
    52
#define NM_LOG_FILE    "c:/data/logs/nmail_trace.log"
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    53
40
hgs
parents: 18
diff changeset
    54
inline void print_trace(const QString& msg)
hgs
parents: 18
diff changeset
    55
{
44
hgs
parents: 43
diff changeset
    56
    static QFile file(NM_LOG_FILE);
hgs
parents: 43
diff changeset
    57
    if (NM_LOG_TO_FILE && !file.isOpen()) {
hgs
parents: 43
diff changeset
    58
        file.open(QIODevice::Append | QIODevice::Text);
hgs
parents: 43
diff changeset
    59
    }
hgs
parents: 43
diff changeset
    60
    if (file.isWritable()) {
hgs
parents: 43
diff changeset
    61
        QDebug(&file).nospace() << "[Nmail] " << msg << '\n';
40
hgs
parents: 18
diff changeset
    62
    } else {
44
hgs
parents: 43
diff changeset
    63
        qDebug().nospace() << "[Nmail] " << msg;
40
hgs
parents: 18
diff changeset
    64
    }
hgs
parents: 18
diff changeset
    65
}
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    66
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    67
#endif
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    68
40
hgs
parents: 18
diff changeset
    69
#endif /* DEBUG */
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    70
40
hgs
parents: 18
diff changeset
    71
/*
44
hgs
parents: 43
diff changeset
    72
 * The function NM_COMMENT() prints a debug message. The INFO macros and the
43
hgs
parents: 40
diff changeset
    73
 * NMLOG macro are provided for legacy compatibility. They are deprecated and
hgs
parents: 40
diff changeset
    74
 * should not be used. If sprintf() type of formatting is desired, consider
hgs
parents: 40
diff changeset
    75
 * using QString::arg() or QTextStream.
40
hgs
parents: 18
diff changeset
    76
 */
44
hgs
parents: 43
diff changeset
    77
#if NM_COMMENT_TRACES
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    78
40
hgs
parents: 18
diff changeset
    79
inline void NM_COMMENT(const QString& msg)
hgs
parents: 18
diff changeset
    80
{
hgs
parents: 18
diff changeset
    81
    print_trace("COMMENT : " + msg);
hgs
parents: 18
diff changeset
    82
}
hgs
parents: 18
diff changeset
    83
#define INFO(msg) NM_COMMENT(msg)
hgs
parents: 18
diff changeset
    84
#define INFO_1(msg,arg1)\
hgs
parents: 18
diff changeset
    85
do {\
hgs
parents: 18
diff changeset
    86
    QString __msg;\
hgs
parents: 18
diff changeset
    87
    __msg.sprintf(msg,arg1);\
hgs
parents: 18
diff changeset
    88
    NM_COMMENT(__msg);\
hgs
parents: 18
diff changeset
    89
} while (0)
hgs
parents: 18
diff changeset
    90
#define INFO_2(msg,arg1,arg2)\
hgs
parents: 18
diff changeset
    91
do {\
hgs
parents: 18
diff changeset
    92
    QString __msg;\
hgs
parents: 18
diff changeset
    93
    __msg.sprintf(msg,arg1,arg2);\
hgs
parents: 18
diff changeset
    94
    NM_COMMENT(__msg);\
hgs
parents: 18
diff changeset
    95
} while (0)
hgs
parents: 18
diff changeset
    96
#define INFO_3(msg,arg1,arg2,arg3)\
hgs
parents: 18
diff changeset
    97
do {\
hgs
parents: 18
diff changeset
    98
    QString __msg;\
hgs
parents: 18
diff changeset
    99
    __msg.sprintf(msg,arg1,arg2,arg3);\
hgs
parents: 18
diff changeset
   100
    NM_COMMENT(__msg);\
hgs
parents: 18
diff changeset
   101
} while (0)
43
hgs
parents: 40
diff changeset
   102
#define NMLOG(msg) NM_COMMENT(msg)
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   103
40
hgs
parents: 18
diff changeset
   104
#else
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   105
40
hgs
parents: 18
diff changeset
   106
#define NM_COMMENT(msg)
hgs
parents: 18
diff changeset
   107
#define INFO(msg)
hgs
parents: 18
diff changeset
   108
#define INFO_1(msg,arg1)
hgs
parents: 18
diff changeset
   109
#define INFO_2(msg,arg1,arg2)
hgs
parents: 18
diff changeset
   110
#define INFO_3(msg,arg1,arg2,arg3)
43
hgs
parents: 40
diff changeset
   111
#define NMLOG(msg)
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   112
44
hgs
parents: 43
diff changeset
   113
#endif /* NM_COMMENT_TRACES */
18
578830873419 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 0
diff changeset
   114
40
hgs
parents: 18
diff changeset
   115
/*
hgs
parents: 18
diff changeset
   116
 * The function NM_ERROR() prints its second argument if the first argument
hgs
parents: 18
diff changeset
   117
 * is non-zero. The ERROR macros are provided for legacy compatibility. They
hgs
parents: 18
diff changeset
   118
 * are deprecated and should not be used. If sprintf() type of formatting is
hgs
parents: 18
diff changeset
   119
 * desired, consider using QString::arg() or QTextStream.
hgs
parents: 18
diff changeset
   120
 */
44
hgs
parents: 43
diff changeset
   121
#if NM_ERROR_TRACES
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   122
40
hgs
parents: 18
diff changeset
   123
inline void NM_ERROR(int err, const QString& msg)
hgs
parents: 18
diff changeset
   124
{
hgs
parents: 18
diff changeset
   125
    if (err) {
hgs
parents: 18
diff changeset
   126
        print_trace("ERROR : " + msg);
hgs
parents: 18
diff changeset
   127
    }
hgs
parents: 18
diff changeset
   128
}
hgs
parents: 18
diff changeset
   129
#define ERROR(err,msg) NM_ERROR(err,msg)
hgs
parents: 18
diff changeset
   130
#define ERROR_1(err,msg,arg1)\
hgs
parents: 18
diff changeset
   131
do {\
hgs
parents: 18
diff changeset
   132
    QString __msg;\
hgs
parents: 18
diff changeset
   133
    __msg.sprintf(msg,arg1);\
hgs
parents: 18
diff changeset
   134
    NM_ERROR(err,__msg);\
hgs
parents: 18
diff changeset
   135
} while (0)
hgs
parents: 18
diff changeset
   136
#define ERROR_2(err,msg,arg1,arg2)\
hgs
parents: 18
diff changeset
   137
do {\
hgs
parents: 18
diff changeset
   138
    QString __msg;\
hgs
parents: 18
diff changeset
   139
    __msg.sprintf(msg,arg1,arg2);\
hgs
parents: 18
diff changeset
   140
    NM_ERROR(err,__msg);\
hgs
parents: 18
diff changeset
   141
} while(0)
hgs
parents: 18
diff changeset
   142
#define ERROR_3(err,msg,arg1,arg2,arg3)\
hgs
parents: 18
diff changeset
   143
do {\
hgs
parents: 18
diff changeset
   144
    QString __msg;\
hgs
parents: 18
diff changeset
   145
    __msg.sprintf(msg,arg1,srg2,arg3);\
hgs
parents: 18
diff changeset
   146
    NM_ERROR(err,__msg);\
hgs
parents: 18
diff changeset
   147
} while(0)
hgs
parents: 18
diff changeset
   148
#define ERROR_GEN(msg) ERROR(KErrGeneral,msg)
hgs
parents: 18
diff changeset
   149
#define ERROR_GEN_1(msg,arg1) ERROR_1(KErrGeneral,msg,arg1)
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   150
40
hgs
parents: 18
diff changeset
   151
#else
18
578830873419 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 0
diff changeset
   152
40
hgs
parents: 18
diff changeset
   153
#define NM_ERROR(err,msg)
hgs
parents: 18
diff changeset
   154
#define ERROR(err,msg)
hgs
parents: 18
diff changeset
   155
#define ERROR_1(err,msg,arg1)
hgs
parents: 18
diff changeset
   156
#define ERROR_2(err,msg,arg1,arg2)
hgs
parents: 18
diff changeset
   157
#define ERROR_3(err,msg,arg1,arg2,arg3)
hgs
parents: 18
diff changeset
   158
#define ERROR_GEN(msg)
hgs
parents: 18
diff changeset
   159
#define ERROR_GEN_1(msg,arg1)
18
578830873419 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 0
diff changeset
   160
44
hgs
parents: 43
diff changeset
   161
#endif /* NM_ERROR_TRACES */
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   162
40
hgs
parents: 18
diff changeset
   163
/*
hgs
parents: 18
diff changeset
   164
 * The macro NM_FUNCTION, when used inside a function body, enables tracing
44
hgs
parents: 43
diff changeset
   165
 * for a function. ENTER and RETURN messages are printed when entering into
hgs
parents: 43
diff changeset
   166
 * and returning from a function, respectively. In case of an exception,
hgs
parents: 43
diff changeset
   167
 * UNWIND (for stack unwinding) is printed. The FUNC_LOG macro is provided
hgs
parents: 43
diff changeset
   168
 * for legacy compatibility. It is deprecated and should not be used.
40
hgs
parents: 18
diff changeset
   169
 */
44
hgs
parents: 43
diff changeset
   170
#if NM_FUNCTION_TRACES
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   171
40
hgs
parents: 18
diff changeset
   172
class __ftracer
hgs
parents: 18
diff changeset
   173
{
hgs
parents: 18
diff changeset
   174
public:
hgs
parents: 18
diff changeset
   175
    __ftracer(const QString& _fn)
hgs
parents: 18
diff changeset
   176
    : fn(_fn)
hgs
parents: 18
diff changeset
   177
    {
hgs
parents: 18
diff changeset
   178
        print_trace("ENTER : " + fn);
hgs
parents: 18
diff changeset
   179
    }
hgs
parents: 18
diff changeset
   180
    ~__ftracer()
hgs
parents: 18
diff changeset
   181
    {
hgs
parents: 18
diff changeset
   182
        if (std::uncaught_exception()) {
hgs
parents: 18
diff changeset
   183
            print_trace("UNWIND : " + fn);
hgs
parents: 18
diff changeset
   184
        } else {
hgs
parents: 18
diff changeset
   185
            print_trace("RETURN : " + fn);
hgs
parents: 18
diff changeset
   186
        }
hgs
parents: 18
diff changeset
   187
    }
hgs
parents: 18
diff changeset
   188
private:
hgs
parents: 18
diff changeset
   189
    QString fn;
hgs
parents: 18
diff changeset
   190
};
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   191
43
hgs
parents: 40
diff changeset
   192
#define NM_FUNCTION __ftracer __ft(__PRETTY_FUNCTION__)
40
hgs
parents: 18
diff changeset
   193
#define FUNC_LOG NM_FUNCTION
hgs
parents: 18
diff changeset
   194
hgs
parents: 18
diff changeset
   195
#else
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   196
40
hgs
parents: 18
diff changeset
   197
#define NM_FUNCTION
hgs
parents: 18
diff changeset
   198
#define FUNC_LOG
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   199
44
hgs
parents: 43
diff changeset
   200
#endif /* NM_FUNCTION_TRACES */
0
8466d47a6819 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   201
40
hgs
parents: 18
diff changeset
   202
#endif /* EMAILTRACE_H */