email/imum/logging/Logging.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: Logging.h
       
    15 *
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __LOGGING_H__
       
    21 #define __LOGGING_H__
       
    22 
       
    23 /*****************************************************************************
       
    24  DEBUGGING ACTIVE
       
    25 *****************************************************************************/
       
    26 #ifdef _DEBUG
       
    27 
       
    28 /**
       
    29  * These macros should be defined in the component header, before including
       
    30  * this file.
       
    31  *
       
    32  * @code_start
       
    33  * #define _IMUM_LOG_NAME xxx
       
    34  * #define _IMUM_LOG_PATH xxxx
       
    35  * #define _IMUM_LOG_COMPONENT_ID 0
       
    36  * #define _IMUM_LOG_BANNER xxx
       
    37  * #include <logging.h>
       
    38  * @code_end
       
    39  */
       
    40 
       
    41 /** The name of the file, where the logs should appear (e.g. component.txt) */
       
    42 #ifndef _IMUM_LOG_NAME
       
    43 #define _IMUM_LOG_NAME "Imum.txt"
       
    44 #pragma message( "*** Macro _IMUM_LOG_NAME undefined, using default :" _IMUM_LOG_NAME )
       
    45 #endif
       
    46 
       
    47 /** The name of the folder under the c:\logs (e.g. component)*/
       
    48 #ifndef _IMUM_LOG_PATH
       
    49 #define _IMUM_LOG_PATH "Email"
       
    50 #pragma message( "*** Macro _IMUM_LOG_PATH undefined, using default :" _IMUM_LOG_PATH )
       
    51 #endif
       
    52 
       
    53 /** The id the component */
       
    54 #ifndef _IMUM_LOG_COMPONENT_ID
       
    55 #define _IMUM_LOG_COMPONENT_ID 0
       
    56 #pragma message( "*** Macro _IMUM_LOG_COMPONENT_ID undefined, using default : 0" )
       
    57 #endif
       
    58 
       
    59 /** The banner text for the logs */
       
    60 #ifndef _IMUM_LOG_BANNER
       
    61 #define _IMUM_LOG_BANNER "Internet Mail UI MTM %d.%d.%d"
       
    62 #endif
       
    63 
       
    64 /** LOGGING DATA */
       
    65 #include "ImumLogUtils.h"
       
    66 
       
    67 /*****************************************************************************
       
    68  NO DEBUGGING
       
    69 *****************************************************************************/
       
    70 #else // _DEBUG
       
    71 #include "ImumLogUtils.h"
       
    72 #endif
       
    73 
       
    74 #endif // __LOGGING_H__