/*

* Copyright (c) 2002 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:  MsgAddressControlEditor implementation

*

*/

// ========== INCLUDE FILES ================================

#include <barsread.h>                      // for TResourceReader

#include <eikenv.h>                        // for CEikonEnv

#include <txtrich.h>                       // for CRichText

#include <AknUtils.h>                      // for AknUtils

#include <AknSettingCache.h>               // for SettingCache().InputLanguage()

#include <AknsUtils.h>                     // for AknsUtils::GetCachedColor()

#include <AknsConstants.h>                 // for KAknsIIDQsnHighlightColors and EAknsCIQsnHighlightColorsCG1

#include <aknlayout.cdl.h> // LAF

#include <txtetext.h>

#include <fldinfo.h>

#ifdef RD_TACTILE_FEEDBACK

#include <touchfeedback.h>

#endif 

#include "MsgEditorCommon.h"               //

#include "MsgAddressControlEditor.h"       // for CMsgAddressControlEditor

#include "MsgAddressControlEditorField.h"  // for CMsgAddressControlEditorField and TMsgAddressControlEditorFieldFactory

#include "MsgBaseControl.h"                // for TMsgEditPermissionFlags

#include "MsgBaseControlObserver.h"        // for MMsgBaseControlObserver

#include "MsgAddressControl.h"             // for permission flags

#include "MsgEditorPanic.h"                // for MsgEditor panics

#include "MsgEditor.hrh"                   // for EditPermission flags

#include "MsgEditorKeyCatcher.h"           // for CMsgEditorKeyCatcher

// ========== EXTERNAL DATA STRUCTURES =====================

// ========== EXTERNAL FUNCTION PROTOTYPES =================

// ========== CONSTANTS ====================================

// ========== MACROS =======================================

// ========== LOCAL CONSTANTS AND MACROS ===================

// Highlighted field does not exist.

const TInt KMsgHighlightedFieldPosNone = -1;

// Current entry not defined.

const TInt KMsgCurrentEntryNone        = -1;

const TText KZeroWidthJoiner = 0x200D;

const TText KLRMarker = 0x200E;

const TText KRLMarker = 0x200F;

// ========== MODULE DATA STRUCTURES =======================

// ========== LOCAL FUNCTION PROTOTYPES ====================

// ========== LOCAL FUNCTIONS ==============================

// ========== MEMBER FUNCTIONS =============================

// ---------------------------------------------------------

// CMsgAddressControlEditor::CMsgAddressControlEditor

//

// Constructor.

// ---------------------------------------------------------

//

CMsgAddressControlEditor::CMsgAddressControlEditor(

    const CCoeControl* aParent,

    TUint32& aFlags,

    MMsgBaseControlObserver* aBaseControlObserver )

    : CMsgExpandableControlEditor( aParent, aFlags, aBaseControlObserver ),

      iHighLightedFieldPos( KMsgHighlightedFieldPosNone ),

      iCurrentEntry( KMsgCurrentEntryNone )

    {

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::~CMsgAddressControlEditor

//

// Destructor.

// ---------------------------------------------------------

//

CMsgAddressControlEditor::~CMsgAddressControlEditor()

    {

    delete iKeyCatcher;

    delete iAddressControlEditorFieldFactory;

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::ConstructL

//

// 2nd phase constructor.

// ---------------------------------------------------------

//

void CMsgAddressControlEditor::ConstructL()

    {

    CMsgExpandableControlEditor::ConstructL();

    //To Dis-able Smiley support for address fields

    RemoveFlagFromUserFlags(EAvkonEnableSmileySupport);

    iFlags |= EMsgControlModeDoNotDrawFrameBgContext; 

    iKeyCatcher = new ( ELeave ) CMsgEditorKeyCatcher();

    iKeyCatcher->ConstructL( this );

    SetAllowUndo( EFalse );

    // Variation is done inside edwin

    SetPhoneNumberGrouping( ETrue );

    iCusPos = 0;

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::ExtractEntry

//

// Extracts an entry according to aEntryNumber and returns it in aEntryString.

// ---------------------------------------------------------

//

void CMsgAddressControlEditor::ExtractEntry(

    TDes& aEntryString, TInt aEntryNumber )

    {

    __ASSERT_DEBUG( ( aEntryNumber >= 0 ) &&

        ( aEntryNumber < iRichText->ParagraphCount() ),

        Panic( EMsgInvalidEntryNumber ) );

    TInt entryLength = 0;

    TInt entryStart = iRichText->CharPosOfParagraph( entryLength, aEntryNumber );

    iRichText->Extract( aEntryString, entryStart, entryLength - 1 );

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::ReadEntry

//

// Reads an entry aEntryNumber and returns pointer to it.

// ---------------------------------------------------------

//

TPtrC CMsgAddressControlEditor::ReadEntry( TInt aEntryNumber ) const

    {

    __ASSERT_DEBUG( ( aEntryNumber >= 0 ) &&

        ( aEntryNumber < iRichText->ParagraphCount() ),

        Panic( EMsgInvalidEntryNumber ) );

    TInt entryLength = 0;

    TInt entryStart = iRichText->CharPosOfParagraph( entryLength, aEntryNumber );

    return iRichText->Read( entryStart, entryLength - 1 );

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::EntryCount

//

// Returns number of entries.

// ---------------------------------------------------------

//

TInt CMsgAddressControlEditor::EntryCount() const

    {

    return iRichText->ParagraphCount();

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::DeleteEntryL

//

// Deletes an entry aEntryNumber.

// ---------------------------------------------------------

//

void CMsgAddressControlEditor::DeleteEntryL( TInt aEntryNumber )

    {

    __ASSERT_DEBUG( ( aEntryNumber >= 0 ) &&

        ( aEntryNumber < iRichText->ParagraphCount() ),

        Panic( EMsgInvalidEntryNumber ) );

    CancelFepTransaction();

    TBool setcursorpos(EFalse);

    TInt numOfEntries = iRichText->ParagraphCount();

    TInt entryLength = 0;

    TInt entryStart = iRichText->CharPosOfParagraph( entryLength, aEntryNumber );

    if ( numOfEntries == aEntryNumber + 1 ) //entry to be deleted is the lowest one

        {

        if ( aEntryNumber != 0 ) // but not the only one

            {

            entryStart--;

            }

        else

            {

            entryLength--;

            }

        }

    if ( TextView() )

        {

        // Cursor position must not go beyond text end. Otherwise

        // panic will happen on text formatting.

        TInt newTextLength = TextLength() - entryLength;

        if ( CursorPos() > newTextLength )

            {

            SetCursorPosL( newTextLength, EFalse );

            iCusPos = newTextLength;

            setcursorpos = ETrue;

            }

        }

    iRichText->CancelInsertCharFormat();

    iRichText->DelSetInsertCharFormatL( entryStart, entryLength );

    if ( iTextView )

       {

        iTextView->HandleInsertDeleteL(

            TCursorSelection( entryStart, entryStart + entryLength ), entryLength, EFalse );

       }

     numOfEntries = iRichText->ParagraphCount();

     if( numOfEntries > 0 && numOfEntries != aEntryNumber && !setcursorpos)

        {

         TInt  txtlen = TextLength();

         TInt  curpos = CursorPos();        

         if ( aEntryNumber ) 

             {

             entryStart = iRichText->CharPosOfParagraph( entryLength, aEntryNumber - 1 );         

             curpos = entryStart + --entryLength ;

             }

         else 

             {

             entryStart = iRichText->CharPosOfParagraph( entryLength, aEntryNumber );         

             curpos+= --entryLength;

             }

         if ( TextView() )

            {

                if(curpos < txtlen)

                {

                    iCusPos = curpos;

                    SetCursorPosL( curpos, EFalse );   

                }

              else

                {

                    iCusPos =entryStart ;

                    SetCursorPosL( iCusPos, EFalse );   

                    ReportEdwinEventL( MEikEdwinObserver::EEventTextUpdate );

                }        

            }

        }

 }

 // ---------------------------------------------------------

// CMsgAddressControlEditor::GetCursorpos

//

// returns the current cursor position.

// ---------------------------------------------------------

//

TInt CMsgAddressControlEditor::GetCursorpos() const

    {

        return iCusPos;

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::ClearEntryL

//

// Clears all the text of an entry aEntryNumber but not the paragraph delimiter.

// ---------------------------------------------------------

//

void CMsgAddressControlEditor::ClearEntryL( TInt aEntryNumber, TBool aUpdate )

    {

    __ASSERT_DEBUG( ( aEntryNumber >= 0 ) &&

        ( aEntryNumber < iRichText->ParagraphCount() ),

        Panic( EMsgInvalidEntryNumber ) );

    TInt entryLength = 0;

    TInt entryStart = iRichText->CharPosOfParagraph( entryLength, aEntryNumber );

    DeleteEntryCharsL( aEntryNumber, 0, entryLength );

    if ( iTextView && aUpdate )

        {

        iTextView->HandleInsertDeleteL(

            TCursorSelection( entryStart, entryStart ), --entryLength, EFalse );

        SetCursorPosAndCancelSelectionL( entryStart );

        }

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::DeleteAllL

//

// Clears the content of the editor. Updates also the scroll bars.

// ---------------------------------------------------------

//

void CMsgAddressControlEditor::DeleteAllL()

    {

    CancelFepTransaction();

    iRichText->CancelInsertCharFormat();

    iRichText->Reset();

    if (iTextView)

        {

        SetAmountToFormatL( ETrue );

        SetCursorPosAndCancelSelectionL( 0 );

        }

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::DeleteEntryCharsL

//

// Deletes characters from aStartPos to aEndPos at entry aEntryNumber. Never

// removes the paragraph delimiter.

// ---------------------------------------------------------

//

void CMsgAddressControlEditor::DeleteEntryCharsL(

    TInt aEntryNumber, TInt aStartPos, TInt aEndPos)

    {

    __ASSERT_DEBUG( ( aEntryNumber >= 0 ) &&

        ( aEntryNumber < iRichText->ParagraphCount() ),

        Panic( EMsgInvalidEntryNumber ) );

    __ASSERT_DEBUG( ( aStartPos >= 0 ) && ( aStartPos <= aEndPos ),

        Panic( EMsgInvalidStartPos ) );

    CancelFepTransaction();

    TInt entryLength = 0;

    TInt entryStart = iRichText->CharPosOfParagraph( entryLength, aEntryNumber );

    entryLength--;

    entryLength = ( aEndPos < entryLength )

        ? aEndPos - aStartPos

        : entryLength - aStartPos;

    entryStart += aStartPos;

    if ( TextView() )

        {

        // Cursor position must not go beyond text end. Otherwise

        // panic will happen on text formatting.

        TInt newTextLength = TextLength() - entryLength;

        if ( CursorPos() > newTextLength )

            {

            SetCursorPosL( newTextLength, EFalse );

            }

        }

    iRichText->CancelInsertCharFormat();

    iRichText->DelSetInsertCharFormatL( entryStart, entryLength );

    //clear the iTextView cache too

    if ( iTextView )

        {

        iTextView->HandleInsertDeleteL(

            TCursorSelection( entryStart, entryStart + entryLength ), entryLength, EFalse );

        SetCursorPosAndCancelSelectionL( entryStart );

        }

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::SetCursorPosAndCancelSelectionL

//

// Sets cursor position to aPos and cancels selection.

// This is needed because Edwin/TextView does not do it as expected.

// ---------------------------------------------------------

//

void CMsgAddressControlEditor::SetCursorPosAndCancelSelectionL( TInt aPos )

    {

    if ( iTextView )

        {

        CancelFepTransaction();

        iTextView->SetDocPosL( aPos, EFalse );

        ForceScrollBarUpdateL();

        }

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::InsertEntryL

//

// Inserts an entry to the location aEntryNumber with strings a text aName

// and aAddress. Makes an entry as verified if aVerified = ETrue and validated

// if aValidated = ETrue.

// ---------------------------------------------------------

//

void CMsgAddressControlEditor::InsertEntryL(

    TInt aEntryNumber,

    const TDesC& aName,

    const TDesC& aAddress,

    TBool aVerified,

    TBool aValidated,

    const MVPbkContactLink* aContactLink )

    {

    __ASSERT_DEBUG( aEntryNumber >= 0 && 

                    aEntryNumber <= iRichText->ParagraphCount(),

                    Panic( EMsgInvalidEntryNumber ) );

    TChar semicolon = KSemicolon;

    TInt entryLength = 0;

    TInt numOfEntries = iRichText->ParagraphCount();

    TInt pos = TextLength();

    TChar ch = CharAtPos( pos - 1 );

    if ( ch == CEditableText::EParagraphDelimiter )

        {

        // last character is parag.delim. => decrease entry num.

        aEntryNumber--;

        }

    /*

     * Fix the split contact name issue::ECYU-7FPC93.

     * Replace any enter-key characters with space characters.

     */

    TBufC<KMaxContactLength> parsedName(aName.Left(KMaxContactLength));

    TInt enterKeyPos;

    TChar enterChar( CEditableText::EParagraphDelimiter );

    TChar spaceChar( CEditableText::ESpace );

    TPtr namePtr = parsedName.Des();

    TInt nameLength = parsedName.Length();

    enterKeyPos = namePtr.Locate(enterChar);

    while( enterKeyPos != KErrNotFound && enterKeyPos < nameLength )

        {

        namePtr[enterKeyPos] = spaceChar;

        enterKeyPos = namePtr.Locate(enterChar);

        }

    if ( aEntryNumber >= numOfEntries )

        {

        // entry appended to the end.

        iRichText->CancelInsertCharFormat();

        iRichText->InsertL( pos, CEditableText::EParagraphDelimiter );

        }

    else

        {

        // entry appended to the middle or beginning.

        iRichText->CharPosOfParagraph( entryLength, aEntryNumber );

        if ( entryLength - 1 )

            {

            InsertEntryBreakL( aEntryNumber, 0 );

            }

        }

    TInt entryStart = iRichText->CharPosOfParagraph( entryLength, aEntryNumber );

    //ECYU-7FPC93:: Fix

    HBufC* string = CreateEntryStringLC( parsedName, aAddress, aVerified );

    //HBufC* string = CreateEntryStringLC( aName, aAddress, aVerified );

    if ( aVerified || aValidated )

        {

        // Setting up the field factory.

        iRichText->SetFieldFactory( iAddressControlEditorFieldFactory );

        CMsgAddressControlEditorField* field = 

            static_cast<CMsgAddressControlEditorField*>( 

                                        iRichText->NewTextFieldL( KMsgAddressControlEditorFieldUid ) );

        if ( field )

            {

            field->SetEntryStringL( *string );

            //ECYU-7FPC93:: Fix

            field->SetNameL( parsedName );

            //field->SetNameL( aName );

            field->SetAddressL( aAddress );

            field->SetVerified( aVerified );

            field->SetValidated( aValidated );

            field->SetContactLink( aContactLink );

            iRichText->InsertFieldL( entryStart, 

                                     field, 

                                     KMsgAddressControlEditorFieldUid );

            iRichText->UpdateFieldL( entryStart );

            }

        }

    else

        {

        if ( string->Length() > 0 )

            {

            iRichText->InsertL( entryStart, *string );

            }

        else

            {

            // This should not happen. Zero lenght contact name is being added. 

            // Insert semicolon only.

            if ( iAvkonEnv->SettingCache().InputLanguage() == ELangArabic )

                {

                semicolon = KArabicSemicolon;

                }

            iRichText->InsertL( entryStart, semicolon );

            }

        }

    if ( aEntryNumber >= numOfEntries )

        {

        if ( ch != semicolon &&

             ch != CEditableText::EParagraphDelimiter &&

             ch != KArabicSemicolon )

            {

            if ( iAvkonEnv->SettingCache().InputLanguage() == ELangArabic )

                {

                semicolon = KArabicSemicolon;

                }

            iRichText->InsertL( pos, semicolon );

            }

        }

    CleanupStack::PopAndDestroy();  // string

    }

// ---------------------------------------------------------

// CMsgAddressControlEditor::InsertEntryBreakL

//

// Inserts the paragraph delimiter at aPos on entry aEntryNumber.

// ---------------------------------------------------------

//

void CMsgAddressControlEditor::InsertEntryBreakL( TInt aEntryNumber, TInt aPos )

    {

    __ASSERT_DEBUG( aEntryNumber >= 0 &&

                    aEntryNumber < iRichText->ParagraphCount(),

                    Panic( EMsgInvalidEntryNumber ) );