epoc32/include/ct/logger.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
* ct/logger.h
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
/**
williamr@2
    23
 @file 
williamr@2
    24
 @internalTechnology
williamr@2
    25
*/
williamr@2
    26
 
williamr@2
    27
#ifndef __CT_LOGGER_H__
williamr@2
    28
#define __CT_LOGGER_H__
williamr@2
    29
williamr@2
    30
#include <e32std.h>
williamr@2
    31
williamr@2
    32
/**
williamr@2
    33
 * 
williamr@2
    34
 * Defines logging functionality for use by crypto tokens framework and file
williamr@2
    35
 * tokens server.  This is only compiled in debug builds when the macro
williamr@2
    36
 * __CT_LOGGING__ is defined.
williamr@2
    37
 *
williamr@2
    38
 * @internalTechnology
williamr@2
    39
 */
williamr@2
    40
williamr@2
    41
#if defined(_DEBUG) && defined(__CT_LOGGING__)
williamr@2
    42
williamr@2
    43
#define LOG(X)				CTLogger::Log(this, (X))
williamr@2
    44
#define LOG1(X, Y)			CTLogger::Log(this, (X), (Y))
williamr@2
    45
#define LOG2(X, Y, Z)		CTLogger::Log(this, (X), (Y), (Z))
williamr@2
    46
#define LOG_INC_INDENT()	CTLogger::UpdateIndent(1)
williamr@2
    47
#define LOG_DEC_INDENT()	CTLogger::UpdateIndent(-1)
williamr@2
    48
williamr@2
    49
#else
williamr@2
    50
williamr@2
    51
#define LOG(X)
williamr@2
    52
#define LOG1(X, Y)
williamr@2
    53
#define LOG2(X, Y, Z)
williamr@2
    54
#define LOG_INC_INDENT()
williamr@2
    55
#define LOG_DEC_INDENT()
williamr@2
    56
williamr@2
    57
#endif
williamr@2
    58
williamr@2
    59
/**
williamr@2
    60
 * Class providing methods used by logging macros.  These are not designed to be
williamr@2
    61
 * called directly.  If logging is not turned on they will simply panic.
williamr@2
    62
 */
williamr@2
    63
class CTLogger
williamr@2
    64
	{
williamr@2
    65
public:
williamr@2
    66
	IMPORT_C static void Log(TAny* aObject, TRefByValue<const TDesC16> aFmt, ...);
williamr@2
    67
	IMPORT_C static void UpdateIndent(TInt aInc);
williamr@2
    68
private:
williamr@2
    69
	static void LogL(const TDesC& aString);
williamr@2
    70
	};
williamr@2
    71
williamr@2
    72
#endif // __CTLOGGER_H__