/*

* Copyright (c) 2006 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:   Implementation of debug logging utilities

*

*/

#ifndef __WINS__

#   ifdef CATALOGS_BUILD_CONFIG_HEAP_CHECKER

#       undef CATALOGS_BUILD_CONFIG_HEAP_CHECKER

#       warning "Automatically disabling heap checker in ARMV5 build!"

#   endif

#   ifdef CATALOGS_BUILD_CONFIG_DEBUG

#       warning "Debug logging on in ARM5 build"!

#   endif

#endif

#ifdef __WINS__

#   ifdef CATALOGS_BUILD_CONFIG_HEAP_CHECKER

#      warning "Heap checker available!"

#   endif

#endif

// Enable this to get alternative XML output

//#define CATALOGS_DEBUG_XML

// Quick method to disable debug functions:

// #undef CATALOGS_BUILD_CONFIG_DEBUG

// #undef CATALOGS_BUILD_CONFIG_HEAP_CHECKER

// #undef CATALOGS_EXT_LOGGER

#include <flogger.h>

#include <e32msgqueue.h>

#include <e32property.h>

#include <hal.h>

#include "catalogsdebug.h"

#include "e32debug.h"

#ifndef __WINS__

extern TUint32 GetStackPointer();

#endif

//#define _DDPRINT( x ) RDebug::Printf x

#define _DDPRINT( x )

// Logger includes from ../../debuglogger/inc/

#include "catalogsdebugdefs.h"

#include "catalogslogger.hrh"

#undef CATALOGS_FILEID

#define CATALOGS_FILEID "$Id: //depot/nf-catalogs/impl/catalogs/engine/src/catalogsdebug.cpp#43 $"

#ifdef CATALOGS_DEBUG_XML

_LIT8( KCatalogsError,   "error" );

_LIT8( KCatalogsWarning, "warning" );

_LIT8( KCatalogsInfo, "info" );

_LIT8( KCatalogsTraceIn, "func" );

_LIT8( KCatalogsTraceOut, "out" );

_LIT8( KCatalogsTraceLeave, "leave" );

_LIT8( KCatalogsTrace, "trace" );

_LIT8( KLogDir, "Catalogs" );

_LIT8( KLogName, "debug.log" );

#else

_LIT8( KCatalogsError,   "ERROR" );

_LIT8( KCatalogsWarning, "WARNING" );

_LIT8( KCatalogsInfo, "INFO" );

_LIT8( KCatalogsTraceIn, "-->" );

_LIT8( KCatalogsTraceOut, "<--" );

_LIT8( KCatalogsTraceLeave, "<--LEAVE" );

_LIT8( KCatalogsTrace, "@" );

_LIT8( KCatalogsSeparator, "\t" );

_LIT( KLogDir, "Catalogs" );

_LIT( KLogName, "debug.log" );

#endif

const TInt KLineLength = 120;

#ifdef CATALOGS_BUILD_CONFIG_DEBUG

static void Append( const char* aText, TDes16& aDestination )

    {

    TPtrC8 ptr( reinterpret_cast<const TUint8*>( aText ) );

    for ( TInt i = 0; i < ptr.Length(); i++ )

        {

        aDestination.Append( ptr[i] );

        }

    }

#endif

#ifndef CATALOGS_DEBUG_XML

static void Append( TPtrC8 aText, TDes8& aDestination, TInt aLength = 60 )

    {

    for ( TInt i = 0; i < aLength; i++ )

        {

        if ( i < aText.Length() )

            {

            aDestination.Append( aText[i] );

            }

        else

            {

            aDestination.Append( '.' );

            }

        }

    }

#else

static void Append( TPtrC8 aText, TDes16& aDestination )

    {

    TInt len = aText.Length();

    for ( TInt i = 0; i < len; i++ )

        {

        aDestination.Append( aText[i] );

        }

    }

const TDesC8& TypeTag( TCatalogsDebug::TType aType )

    {

    switch ( aType )

        {

        case TCatalogsDebug::EInfo:

            return KCatalogsInfo;

            break;

        case TCatalogsDebug::EError:

            return KCatalogsError;

            break;

        case TCatalogsDebug::EWarning:

            return KCatalogsWarning;

            break;

        case TCatalogsDebug::ETrace:

            return KCatalogsTrace;

            break;

        case TCatalogsDebug::ETraceIn:

            return KCatalogsTraceIn;

            break;

        case TCatalogsDebug::ETraceOut:

            return KCatalogsTraceOut;

            break;

        case TCatalogsDebug::ETraceLeave:

            return KDebugLoggerTraceLeave;

            break;            

        default:

            DASSERT( EFalse );

            break;

        }

    return KNullDesC(); // for compiler

    }

#endif

EXPORT_C TCatalogsDebug::TCatalogsDebug(

    TType aType,

    const char* aFunction,

    TInt aLine,

    const char* aFileId,

    TUint aDeltaTime,

    TInt aOutput )

        : iType( aType ), iFunction( aFunction ), iLine( aLine ), iFileId( aFileId ), 

          iDeltaTime( aDeltaTime ), iOutput( aOutput )

    {}

inline RCatalogsDebugHeap* DebugHeap()

    {

    return static_cast< RCatalogsDebugHeap* >( &User::Heap() );

    }

void TCatalogsDebug::PrintGeneral( TPtr8 aPrintBuf )

    {

#ifdef CATALOGS_DEBUG_XML

    // Insert start tag beginning.

    aPrintBuf.AppendFormat( "<%S name=\"", &TypeTag( iType ) );

    // Process the function string. Assume __PRETTY_FUNCTION__ -style string

    TPtrC8 func( reinterpret_cast<const TUint8*>( iFunction ) );

    // drop params

    func.Set( func.Left( func.Locate( '(' ) ) );

    // drop return value (if specified)

    TInt nameStart = func.LocateReverse( ' ' );

    if ( nameStart != KErrNotFound )

        {

        func.Set( func.Mid( nameStart+1 ) );

        }

    // Insert method name

    aPrintBuf.Append( func );

    aPrintBuf.Append( "\" file=\"" );

    // Insert file name

    aPrintBuf.Append( TDesC8( iFileId ) );

    // Insert the rest of the attributes

    RThread thread;

    TInt totalAllocSize = 0;

    User::AllocSize( totalAllocSize );

    aPrintBuf.AppendFormat( "\" line=\"%d\" thread=\"%x%x\" alloc=\"%d\">",

        iLine, (TUint32)(thread.Id().Id()>>32), (TUint32)thread.Id().Id(), totalAllocSize>>10 );

#else   // CATALOGS_DEBUG_XML

    // Insert current thread id.

    RThread thread;

    aPrintBuf.AppendNum( thread.Id().Id(), EHex );

    aPrintBuf.Append( ' ' );

    // Process the function string. Assume __PRETTY_FUNCTION__ -style string

    TPtrC8 ptr( reinterpret_cast<const TUint8*>( iFunction ) );

    // drop params

    ptr.Set( ptr.Left( ptr.Locate( '(' ) ) );

    // drop return value (if specified)

    TInt nameStart = ptr.LocateReverse( ' ' );

    if ( nameStart != KErrNotFound )

        {

//        aPrintBuf.Append( ptr.Mid( nameStart+1 ) );

        Append( ptr.Mid( nameStart+1 ), aPrintBuf );

        }

    else

        {

//        aPrintBuf.Append( ptr );

        Append( ptr, aPrintBuf );

        }

    aPrintBuf.Append( KCatalogsSeparator );

    aPrintBuf.AppendNum( iLine );

    aPrintBuf.Append( KCatalogsSeparator );

    TInt totalAllocSize = 0;

    User::AllocSize( totalAllocSize );

    aPrintBuf.Append( 'M' );

    aPrintBuf.AppendNum( totalAllocSize>>10 );

    TThreadStackInfo stackInfo;

    TInt err = thread.StackInfo( stackInfo );

    if( err == KErrNone )

        {

#ifdef __WINS__        

        volatile TInt32 currentSp=0;

        __asm { mov currentSp, esp }

#else

        TInt32 currentSp = GetStackPointer();

#endif        

//         TInt remainingStack = currentSp - (TInt)stackInfo.iLimit;

        TInt remainingStack = (TInt)stackInfo.iBase - currentSp;

        aPrintBuf.Append( '/' );

        if( remainingStack > 1023 )

            {

            aPrintBuf.AppendNum( remainingStack >> 10 );

            aPrintBuf.Append( 'k' );

            }

        else

            {

            aPrintBuf.AppendNum( remainingStack );

            }

        }

    aPrintBuf.Append( KCatalogsSeparator );

    switch ( iType )

        {

        case EError:

            aPrintBuf.Append( KCatalogsError );

            break;

        case EWarning:

            aPrintBuf.Append( KCatalogsWarning );

            break;

        case ETrace:

            aPrintBuf.Append( KCatalogsTrace );

            break;

        case ETraceIn:

            aPrintBuf.Append( KCatalogsTraceIn );

            break;

        case ETraceOut:

            aPrintBuf.Append( KCatalogsTraceOut );

            break;            

        case ETraceLeave:

        	aPrintBuf.Append( KCatalogsTraceLeave );

            break;            

        case EInfo:

            aPrintBuf.Append( KCatalogsInfo );

            break;

        default:

            break;

        }

#endif // CATALOGS_DEBUG_XML

    }

void TCatalogsDebug::FileWrite( const TDesC8& aPrintBuf )

    {

    TLex8 lex( aPrintBuf );

    TInt length = KLineLength;

    lex.Mark();

    while ( ! lex.Eos() )

        {

        while ( length-- > 0 && ! lex.Eos() )

            {

            lex.Inc();

            }

        length = KLineLength;

        TPtrC8 line( lex.MarkedToken() );

        lex.Mark();

        RFileLogger::Write( KLogDir, KLogName, EFileLoggingModeAppend, line );

        }

    }

EXPORT_C void TCatalogsDebug::Print( TRefByValue<const TDesC16> aFmt, ... )

    {

    VA_LIST list;

    VA_START( list, aFmt );

    HBufC8* buffer = NULL;

    HBufC* buffer16 = NULL;

    HBufC8* buffer16to8  = NULL;

    if( iOutput & EOutputExtLogger )

        if( !DebugHeap()->IsEnabled( iType ) ) return;

    // Disable debug heap (if installed) to prevent infinite recursion.

    TBool debugHeapActive = RCatalogsDebugHeap::Activate( EFalse );

    buffer = HBufC8::New( KCatalogsDebugBufferSize );

    if ( buffer == NULL ) goto exit1;

    PrintGeneral( buffer->Des() );

    buffer16 = HBufC::New( KCatalogsDebugBufferSize );

    if ( buffer16 == NULL ) goto exit2;

    buffer16->Des().AppendFormatList( aFmt, list );

    buffer16to8 = HBufC8::New( buffer16->Length() );

    if ( buffer16to8 == NULL ) goto exit3;

    buffer16to8->Des().Copy( *buffer16 );

#ifndef CATALOGS_DEBUG_XML

    buffer->Des().Append( KCatalogsSeparator );

    buffer->Des().Append( *buffer16to8 );

#else

    TInt formatPos = buffer->Length();

    buffer->Des().Append( *buffer16to8 );

    // replace xml-evil chars with ¤

    TPtr8 formattedText = buffer->Des().MidTPtr( formatPos );

    TInt pos;

    while( (pos = formattedText.Locate( '<' )) != KErrNotFound )

        {

        formattedText[pos] = '¤';

        }

    while( (pos = formattedText.Locate( '>' )) != KErrNotFound )

        {

        formattedText[pos] = '¤';

        }

    while( (pos = formattedText.Locate( '&' )) != KErrNotFound )

        {

        formattedText[pos] = '¤';

        }

#endif

#ifdef CATALOGS_DEBUG_XML

    // In tag is not closed until after out

    if( iType != ETraceIn )

        {

        // close the tag

        buffer->Des().AppendFormat( "</%S>", &TypeTag( iType ) );

        if( iType == ETraceOut || iType == ETraceLeave )

            {

            buffer->Des().AppendFormat( "</%S>", &KCatalogsTraceIn() );

            }

        }

#endif

    if( iOutput & EOutputRDebug )

        RDebug::Printf( (char*)buffer->Des().PtrZ() );

    if( iOutput & EOutputExtLogger )

        DebugHeap()->ChunkOutput( *buffer, iDeltaTime );

    if( iOutput & EOutputFileLogger )

        FileWrite( *buffer );

    delete buffer16to8;

exit3:

    delete buffer16;

exit2:

    delete buffer;

exit1:

    RCatalogsDebugHeap::Activate( debugHeapActive );

    }

EXPORT_C void TCatalogsDebug::Print( const char* aFmt, ... )

    {

    VA_LIST list;

    VA_START( list, aFmt );

    if( iOutput & EOutputExtLogger )

        {

        if( !DebugHeap()->IsEnabled( iType ) ) return;

        }

    // Disable debug heap (if installed) to prevent infinite recursion.

    TBool debugHeapActive = RCatalogsDebugHeap::Activate( EFalse );

    HBufC8* buffer = HBufC8::New( KCatalogsDebugBufferSize );

    if ( buffer == NULL ) return;

    PrintGeneral( buffer->Des() );

#ifndef CATALOGS_DEBUG_XML

    buffer->Des().Append( KCatalogsSeparator );

    buffer->Des().AppendFormatList( TPtrC8( ( const TUint8* )aFmt ), list );

#else

    TInt formatPos = buffer->Length();

    buffer->Des().AppendFormatList( TPtrC8( ( const TUint8* )aFmt ), list );

    // replace xml-evil chars with ¤

    TPtr8 formattedText = buffer->Des().MidTPtr( formatPos );

    TInt pos;

    while( (pos = formattedText.Locate( '<' )) != KErrNotFound )

        {

        formattedText[pos] = '¤';

        }

    while( (pos = formattedText.Locate( '>' )) != KErrNotFound )

        {

        formattedText[pos] = '¤';

        }

    while( (pos = formattedText.Locate( '&' )) != KErrNotFound )

        {

        formattedText[pos] = '¤';

        }

    // In tag is not closed until after out

    if( iType != ETraceIn )

        {

        // close the tag

        buffer->Des().AppendFormat( "</%S>", &TypeTag( iType ) );

        if( iType == ETraceOut || iType == ETraceLeave )

            {

            buffer->Des().AppendFormat( "</%S>", &KCatalogsTraceIn() );

            }

        }

#endif

    if( iOutput & EOutputRDebug )

        RDebug::Printf( (char*)buffer->Des().PtrZ() );

    if( iOutput & EOutputExtLogger )

        DebugHeap()->ChunkOutput( *buffer, iDeltaTime );

    if( iOutput & EOutputFileLogger )

        FileWrite( *buffer );

    delete buffer;

    RCatalogsDebugHeap::Activate( debugHeapActive );

    }

EXPORT_C void TCatalogsDebug::DumpData( const TAny* aData, TInt aSize, TInt aClipToSize )

    {

    TInt size = aSize;

    Print( "dump: %d bytes total", aSize );

    TUint8* data = ( TUint8* )aData;

    while ( size > 0 )

        {

        // Cut dumps of > aClipToSize from the middle.

        if ( ( aSize-size > aClipToSize/2 ) && ( size > aClipToSize/2 ) )

            {

            TInt clipAmount = ( ( aSize - aClipToSize ) / 8 + 1 ) * 8;

            Print( "... %d bytes of data clipped ...", clipAmount );

            size -= clipAmount;

            data += clipAmount;

            continue;

            }

        switch ( size )

            {

            case 1:

                Print( "%04x: %02x", aSize-size,

                       ( TInt )data[0] );

                break;

            case 2:

                Print( "%04x: %02x %02x", aSize-size,

                       ( TInt )data[0], ( TInt )data[1] );

                break;

            case 3:

                Print( "%04x: %02x %02x %02x", aSize-size,

                       ( TInt )data[0], ( TInt )data[1], ( TInt )data[2] );

                break;

            case 4:

                Print( "%04x: %02x %02x %02x %02x", aSize-size,

                       ( TInt )data[0], ( TInt )data[1], ( TInt )data[2],

                       ( TInt )data[3] );

                break;