// Copyright (c) 2002-2009 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:

//

#include <tultextresourceutils.h>

#include <tulpanics.h>

#include "languagespecificnumberconverter.h"

#include <coeutils.h>

#include <bautils.h>

#include <coemain.h>

// CP1252 ellipsis character value.

#define KEllipsis		0x2026  // cp1252=133

// KIntSize and KKeySize define maximum number of characters

// in input TInts and in keystring. KNumOfParams is maximum number of

// parameters in the resource string.

const TInt KIntSize(11); //Max 11 digits.

const TInt KNumOfParams(20); //Max 20 parameters

const TInt KKeySize (4); //Max 2 digits in index. For example %20U

// Key strings for number and unicode data.

_LIT(KNumKeyBuf, "%N"); //Number data

_LIT(KStringKeyBuf, "%U"); //Unicode data

// Key characters to format key strings.

const TText KKeyPrefix('%');

const TText KNumKey('N');

const TText KStringKey('U');

const TText KSubStringSeparator(0x0001);	// pipe ('|') character

const TText KDirNotFound( 0x0002 );

const TInt KNoIndex(-1); //No index- code in Format-method.

//Panic category

_LIT(KPanicCategory, "TulTextResourceUtils");

const TInt KExtraSpaceForMainStringDirMarker = 1;

const TInt KExtraSpaceForSubStringDirMarkers = 2;

const TText KLRMarker = 0x200E;

const TText KRLMarker = 0x200F;

// KUnknownCount is used as default value for param count in FormatStringL

const TInt KUnknownCount(-99);

//

// class TulTextResourceUtils

//

/**

Reads a resource string without memory allocation. The loaded string is stored in the 

destination TDes&. Because this method doesn't allocate memory the destination 

descriptor must be long enough.

@param aResourceId The numeric ID of the resource string to be read.

@param aDest Reference to the descriptor where the resource string is loaded.

@param aLoaderEnv Pointer to the control environment. If user doesn't

                   give this, CCoeEnv::Static is called to get it.

@panic ECCoeEnvNotInitialized Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

*/

EXPORT_C void TulTextResourceUtils::Load(TDes& aDest, TInt aResourceId, CCoeEnv* aLoaderEnv)

    {

    if (!aLoaderEnv)

        {

        aLoaderEnv=CCoeEnv::Static();

        if (!aLoaderEnv)

            User::Panic(KPanicCategory, ECCoeEnvNotInitialized);

        }

    //If aDes is too small, this function causes CCoeEnv::HandleError() to be called.

    TInt ignore(KErrNone); // To avoid compiler warning.

    // Trapped because ReadResource() is deprecated and method cannot leave.

    TRAP(ignore, aLoaderEnv->ReadResourceL(aDest, aResourceId));

	}

/**

Reads a resource string with memory allocation. 

@param aResourceId The numeric ID of the resource string to be read.

@param aLoaderEnv Pointer to the control environment. If user doesn't

                   give this, CCoeEnv::Static is called to get it.

@return Pointer to a heap descriptor containing the resource

         string. The calling program must destroy the heap descriptor

         when it is no longer needed.

@leave KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

*/

EXPORT_C HBufC* TulTextResourceUtils::LoadL(TInt aResourceId, CCoeEnv* aLoaderEnv)

    {

    if (!aLoaderEnv)

        {

        aLoaderEnv=CCoeEnv::Static();

        if (!aLoaderEnv)

            User::Leave(KErrNotSupported);

        }

    return aLoaderEnv->AllocReadResourceL(aResourceId);

	}

/**

Reads a resource string with memory allocation and replaces the first \%N-string in it 

with replacement TInt. In debug builds the Symbian OS panic mechanism is used to 

notify programming errors.

@param aResourceId The numeric ID of the resource string to be read.

@param aInt The replacing TInt.

@param aLoaderEnv Pointer to the control environment. If user doesn't

        			give this, CCoeEnv::Static is called to get it.

@return Pointer to a heap descriptor containing the formatted

        resource string. The calling program must destroy the heap 

        descriptor when it is no longer needed.

@panic EKeyStringNotFound In debug build if the key string 'N' wasn't

                           found in formatting.

@leave KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

*/

EXPORT_C HBufC* TulTextResourceUtils::LoadL(TInt aResourceId, TInt aInt, CCoeEnv* aLoaderEnv)

    {

    HBufC* resbuf = LoadLC(aResourceId, aLoaderEnv);

    TPtr retptr = resbuf->Des();

    //

    //Converting input TInt to a descriptor. This way the size

    //of the return string can be controlled.

    //

    TBuf<KIntSize> intbuf;

    intbuf.Num(aInt);

    if (LanguageSpecificNumberConverter::IsConversionNeeded())

        LanguageSpecificNumberConverter::Convert(intbuf);

    //

    // Get number of sub strings

    TInt count = GetSubStringCount(retptr); 

    TBool marker(EFalse); 

    if (count >= 1)

        {

        HBufC* buffer = ResolveSubStringDirsL(retptr, count, &marker);

        CleanupStack::PushL(buffer);

        TBool found(EFalse);

        TBidiText::TDirectionality mainDir = DirectionalityL(*buffer , &found);

        //Adding int    

        HBufC* retbuf = FormatStringL(*buffer, KNumKeyBuf, intbuf, mainDir);

        CleanupStack::PopAndDestroy(buffer);

        CleanupStack::PopAndDestroy(resbuf);

        if (marker && retbuf->Length())

            {

            TPtr ptr = retbuf->Des();

            RemoveNoDirMarkers(ptr);

            } 

        __ASSERT_DEBUG(retbuf->Length(), 

                    User::Panic(KPanicCategory, EKeyStringNotFound));

        return retbuf;

        }

     else

        {

        CleanupStack::PopAndDestroy(resbuf);

        HBufC* retbuf = HBufC::NewL(0); // return empty buffer

        __ASSERT_DEBUG(retbuf->Length(), 

                    User::Panic(KPanicCategory, EKeyStringNotFound));

        return retbuf;

        }

   	}

/**

Reads a resource string with memory allocation and replaces the first \%U-string in it 

with replacement string. In debug builds the Symbian OS panic mechanism is used to 

notify programming errors.

@param aResourceId The numeric ID of the resource string to be read.

@param aString Reference to the replacing string.

@param aLoaderEnv Pointer to the control environment. If user doesn't

                   give this, CCoeEnv::Static is called to get it.

@return Pointer to a heap descriptor containing the formatted

         resource string. The calling program must destroy the heap 

         descriptor when it is no longer needed.

@panic EKeyStringNotFound In debug build if the key string 'U' wasn't

                           found in formatting.

@leave KErrNotSupported Parameter aLoaderEnv is NULL and 

                         CCoeEnv::Static returned NULL.

*/

EXPORT_C HBufC* TulTextResourceUtils::LoadL(TInt aResourceId, const TDesC& aString, CCoeEnv* aLoaderEnv)

    {

    HBufC* resbuf = LoadLC(aResourceId, aLoaderEnv);

    TPtr retptr(resbuf->Des());

    // Get number of sub strings

    TInt count = GetSubStringCount(retptr); 

    TBool marker(EFalse); 

    if (count >= 1)

        {

        HBufC* buffer = ResolveSubStringDirsL(retptr, count, &marker);

        CleanupStack::PushL(buffer);

        TBool found(EFalse);

        TBidiText::TDirectionality mainDir = DirectionalityL(*buffer , &found);

        //Formating the return string with FormatStringL.

        HBufC* retbuf = FormatStringL(*buffer, KStringKeyBuf, aString, mainDir);

        CleanupStack::PopAndDestroy(buffer);

        CleanupStack::PopAndDestroy(resbuf);

        if (marker && retbuf->Length())

            {

            TPtr ptr = retbuf->Des();

            RemoveNoDirMarkers(ptr);

            } 

        __ASSERT_DEBUG(retbuf->Length(), 

                    User::Panic(KPanicCategory, EKeyStringNotFound));    

        return retbuf;

        }

     else

        {

        CleanupStack::PopAndDestroy(resbuf);

        HBufC* retbuf = HBufC::NewL(0); // return empty buffer

        __ASSERT_DEBUG(retbuf->Length(), 

                    User::Panic(KPanicCategory, EKeyStringNotFound));

        return retbuf;

        }

   	}

/**

Reads a resource string with memory allocation, replaces the first \%N-string in it with

replacement TInt and the first \%U-string in it with replacement string. 

In debug builds the Symbian OS panic mechanism is used to 

notify programming errors.

@param aResourceId The numeric ID of the resource string to be read.

@param aString Reference to the replacing string.

@param aInt The replacing TInt.

@param aLoaderEnv Pointer to the control environment. If user doesn't

                   give this, CCoeEnv::Static is called to get it.

@return Pointer to a heap descriptor containing the formatted

         resource string. The calling program must destroy the heap

         descriptor when it is no longer needed.

@panic EKeyStringNotFound In debug build if the key string 'N' or 'U'

                           wasn't found in formatting.

@leave KErrNotSupported Parameter aLoaderEnv is NULL and 

                         CCoeEnv::Static returned NULL.

*/

EXPORT_C HBufC* TulTextResourceUtils::LoadL(TInt aResourceId, const TDesC& aString, TInt aInt, CCoeEnv* aLoaderEnv)

    {

    HBufC* resbuf = LoadLC(aResourceId, aLoaderEnv);

    TPtr retptr = resbuf->Des();

    //Converting input TInt to a descriptor. This way the size

    //of the return string can be controlled.

    TBuf<KIntSize> intbuf;

    intbuf.Num(aInt);

    if (LanguageSpecificNumberConverter::IsConversionNeeded())

        LanguageSpecificNumberConverter::Convert(intbuf);

    // Get number of sub strings

    TInt count = GetSubStringCount(retptr); 

    TBool marker(EFalse); 

    if (count >= 1)

        {

        HBufC* buffer = ResolveSubStringDirsL(retptr, count, &marker);

        CleanupStack::PushL(buffer);

        TBool found(EFalse);

        TBidiText::TDirectionality mainDir = DirectionalityL(*buffer , &found);

        //Adding int    

        HBufC* cacbuf = FormatStringL(*buffer, KNumKeyBuf, intbuf, mainDir);

        CleanupStack::PushL(cacbuf);

        // Resolve directionality of the modified text and 

        // forward information to Formater().

        mainDir = DirectionalityL(*cacbuf, &found);

        //Adding string.

        HBufC* retbuf = FormatStringL(*cacbuf, KStringKeyBuf, aString, mainDir);

        __ASSERT_DEBUG(retbuf->Length(), 

                        User::Panic(KPanicCategory, EKeyStringNotFound));

        CleanupStack::PopAndDestroy(cacbuf);

        CleanupStack::PopAndDestroy(buffer);

        CleanupStack::PopAndDestroy(resbuf);

        if (marker && retbuf->Length())

            {

            TPtr ptr = retbuf->Des();

            RemoveNoDirMarkers(ptr);

            }   

        __ASSERT_DEBUG(retbuf->Length(), 

                        User::Panic(KPanicCategory, EKeyStringNotFound));

        return retbuf;

        }

    else

        {

        CleanupStack::PopAndDestroy(resbuf);

        HBufC* retbuf = HBufC::NewL(0); // return empty buffer

        __ASSERT_DEBUG(retbuf->Length(), 

                        User::Panic(KPanicCategory, EKeyStringNotFound));

        return retbuf;

        }

   	}

/**

Reads a resource string with memory allocation and replaces the \%(index)N-strings 

in it with replacement TInts from an array. In debug builds the Symbian OS 

panic mechanism is used to notify programming errors.

@param aResourceId The numeric ID of the resource string to be read.

@param aInts Reference to the array including the replacing TInts.

@param aLoaderEnv Pointer to the control environment. If user doesn't

                   give this, CCoeEnv::Static is called to get it.

@return Pointer to a heap descriptor containing the formatted

         resource string. The calling program must destroy the heap

         descriptor when it is no longer needed.

@panic ETooManyArguments In debug build if too many replacing 

                         elements in aInts array.

@leave KErrNotSupported Parameter aLoaderEnv is NULL and 

                        CCoeEnv::Static returned NULL.

*/

EXPORT_C HBufC* TulTextResourceUtils::LoadL(TInt aResourceId, const CArrayFix<TInt>& aInts, CCoeEnv* aLoaderEnv)

    {

    HBufC* resbuf = LoadLC(aResourceId, aLoaderEnv);

    TPtr retptr(resbuf->Des());

    TInt max = aInts.Count(); //Number of keystrings in resource string

    __ASSERT_DEBUG(max <= KNumOfParams, 

                    User::Panic(KPanicCategory, ETooManyArguments));

    TInt count = GetSubStringCount(retptr); 

    TBool marker(EFalse); 

    if (count >= 1)

        {

        HBufC* buffer = ResolveSubStringDirsL(retptr, count, &marker);

        CleanupStack::PushL(buffer);

        TBool found(EFalse);

        TBidiText::TDirectionality mainDir = DirectionalityL(*buffer , &found);

        //Formating the return string with FormatStringL. 

        HBufC* retbuf = FormatStringL(*buffer, aInts, max, mainDir);

        CleanupStack::PopAndDestroy(buffer);

        CleanupStack::PopAndDestroy(resbuf);

        if (marker && retbuf->Length())

            {

            TPtr ptr = retbuf->Des();

            RemoveNoDirMarkers(ptr);

            } 

        __ASSERT_DEBUG(retbuf->Length(), 

                    User::Panic(KPanicCategory, EKeyStringNotFound));    

        return retbuf;

        }

     else

        {

        CleanupStack::PopAndDestroy(resbuf);

        HBufC* retbuf = HBufC::NewL(0); // return empty buffer

        __ASSERT_DEBUG(retbuf->Length(), 

                    User::Panic(KPanicCategory, EKeyStringNotFound));

        return retbuf;

        }

    }

/**

Reads a resource string with memory allocation and replaces the \%(index)U-strings 

in it with replacement strings from an array. In debug builds the Symbian OS 

panic mechanism is used to notify programming errors.

@param aResourceId The numeric ID of the resource string to be read.

@param aStrings Reference to the array  including pointers to the

                replacing strings.

@param aLoaderEnv Pointer to the control environment. If user doesn't

                  give this, CCoeEnv::Static is called to get it.

@return Pointer to a heap descriptor containing the formatted

         resource string. The calling program must destroy the heap

         descriptor when it is no longer needed.        

@panic ETooManyArguments In debug build if too many replacing 

                          elements in aStrings 

                          array.

@leave KErrNotSupported Parameter aLoaderEnv is NULL and 

                         CCoeEnv::Static returned NULL.

*/

EXPORT_C HBufC* TulTextResourceUtils::LoadL(TInt aResourceId, const MDesCArray& aStrings, CCoeEnv* aLoaderEnv)

    {

    HBufC* resbuf = LoadLC(aResourceId, aLoaderEnv);

    TPtr retptr(resbuf->Des());

    TInt max = aStrings.MdcaCount(); //Number of keystrings in resource string

    __ASSERT_DEBUG(max <= KNumOfParams, 

                    User::Panic(KPanicCategory, ETooManyArguments));

    TInt count = GetSubStringCount(retptr); 

    TBool marker(EFalse); 

    if (count >= 1)

        {

        HBufC* buffer = ResolveSubStringDirsL(retptr, count, &marker);

        CleanupStack::PushL(buffer);

        TBool found(EFalse);

        TBidiText::TDirectionality mainDir = DirectionalityL(*buffer , &found);

        //Formating the return string with FormatStringL. 

        HBufC* retbuf = FormatStringL(*buffer, aStrings, max, mainDir);

        CleanupStack::PopAndDestroy(buffer);

        CleanupStack::PopAndDestroy(resbuf);

        if (marker && retbuf->Length())

            {

            TPtr ptr = retbuf->Des();

            RemoveNoDirMarkers(ptr);

            } 

        __ASSERT_DEBUG(retbuf->Length(), 

                    User::Panic(KPanicCategory, EKeyStringNotFound));    

        return retbuf;

        }

     else

        {

        CleanupStack::PopAndDestroy(resbuf);

        HBufC* retbuf = HBufC::NewL(0); // return empty buffer

        __ASSERT_DEBUG(retbuf->Length(), 

                    User::Panic(KPanicCategory, EKeyStringNotFound));

        return retbuf;

        }

    }

/**

Reads a resource string with memory allocation and replaces the

\%(index)U-strings in it with replacement strings from an array and

the \%(index)N-strings in it with replacement TInts from another

array. In debug builds the Symbian OS panic mechanism is used to 

notify programming errors.

@param aResourceId The numeric ID of the resource string to be read.

@param aStrings Reference to the array including pointers to the

                 replacing strings.

@param aInts Reference to the array including the replacing TInts.

@param aLoaderEnv Pointer to the control environment. If user doesn't

                   give this, CCoeEnv::Static is called to get it.

@return Pointer to a heap descriptor containing the formatted

         resource string. The calling program must destroy the heap

         descriptor when it is no longer needed.        

@panic ETooManyArguments In debug build if too many replacing 

                          elements in aStrings and/or aInts arrays.

@leave KErrNotSupported Parameter aLoaderEnv is NULL and 

                         CCoeEnv::Static returned NULL.

*/

EXPORT_C HBufC* TulTextResourceUtils::LoadL(TInt aResourceId, const MDesCArray& aStrings, const CArrayFix<TInt>& aInts, CCoeEnv* aLoaderEnv)

    {

    HBufC* resbuf = LoadLC(aResourceId, aLoaderEnv);

    TPtr retptr(resbuf->Des());

    //Number of keystrings in resource string.

    TInt max = (aInts.Count() + aStrings.MdcaCount()); 

    __ASSERT_DEBUG(max <= KNumOfParams, User::Panic(KPanicCategory,

                    ETooManyArguments));

    // Get number of sub strings

    TInt count = GetSubStringCount(retptr); 

    TBool marker(EFalse); 

    if (count >= 1)

        {

        HBufC* buffer = ResolveSubStringDirsL(retptr, count, &marker);

        CleanupStack::PushL(buffer);

        TBool found(EFalse);

        TBidiText::TDirectionality mainDir = DirectionalityL(*buffer , &found);

        //Adding int    

        HBufC* cacbuf = FormatStringL(*buffer, aInts, max, mainDir); //Adding ints

        CleanupStack::PushL(cacbuf);

        // Resolve directionality of the modified text and 

        // forward information to Formater().

        mainDir = DirectionalityL(*cacbuf, &found);

        //Adding string.

        HBufC* retbuf = FormatStringL(*cacbuf, aStrings, max, mainDir); //Adding strings

        __ASSERT_DEBUG(retbuf->Length(), 

                        User::Panic(KPanicCategory, EKeyStringNotFound));

        CleanupStack::PopAndDestroy(cacbuf);

        CleanupStack::PopAndDestroy(buffer);

        CleanupStack::PopAndDestroy(resbuf);

        if (marker && retbuf->Length())

            {

            TPtr ptr = retbuf->Des();

            RemoveNoDirMarkers(ptr);

            }   

        __ASSERT_DEBUG(retbuf->Length(), 

                        User::Panic(KPanicCategory, EKeyStringNotFound));

        return retbuf;

        }

    else

        {

        CleanupStack::PopAndDestroy(resbuf);

        HBufC* retbuf = HBufC::NewL(0); // return empty buffer

        __ASSERT_DEBUG(retbuf->Length(),