/*

* Copyright (c) 1997-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 "FRMTLAY.H"

#include "FRMTVIEW.H"

#include "FRMCONST.H"

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include "FRMCONST_INTERNAL.H"

#include "FRMCONST_PARTNER.H"

#include "TAGMA_INTERNAL.H"

#endif

/** Reports whether a character is a virama (indic vowel-killer,

used for joining syllables together) or not.

@param aCharacter The character.

@return ETrue if aCharacter is a virama.

@internalComponent */

TBool IsVirama(TChar aCharacter)

	{

	// Unicode combining class 9 indicates a virama

	return aCharacter.GetCombiningClass() == 9;

	}

/**

Reports whether a character is a graphical spacing character or not.

@param aCharacter Unicode UTF32 character to test.

@return ETrue if it is both graphical and not a combining mark.

@internalComponent

*/

TBool IsGraphicalSpacing(TChar aCharacter)

	{

	TChar::TCategory cat = aCharacter.GetCategory();

	switch (cat & 0xF0)

		{

	case TChar::EAlphaGroup:

	case TChar::ELetterOtherGroup:

	case TChar::ELetterModifierGroup:

	case TChar::ENumberGroup:

	case TChar::EPunctuationGroup:

	case TChar::ESymbolGroup:

		return ETrue;

	default:

		return EFalse;

		}

	}

TCursor::TCursor(TCursorPosition& aCursorPos,RScreenDisplay& aDisplay):

	iDisplay(aDisplay),

	iCursorPos(aCursorPos),

	iVisible(FALSE),

	iFlash(TRUE),

	iLineCursor(EFCursorInvisible),

	iTextCursor(EFCursorInvisible),

	iLineCursorBitmap(NULL),

	iAscent(-1),

	iDescent(-1),

	iWeight(ETextCursorWeight),

	iType(TTextCursor::ETypeRectangle),

	iXorColor(ETextCursorInvertColor),

	iPlacement(ECursorVertical)

	{

	}

void TCursor::SetLineCursorBitmap(const CFbsBitmap* aLineCursorBitmap)

	{

	iLineCursorBitmap=aLineCursorBitmap;

	}

/**

Sets the selection highlight to have its edges moved by the specified number of pixels.

Problems with highlights appearing in the wrong place may be due to incorrect 

font metrics, and would not be fixed in general with a call to this function.

@param aLeftExtension

	Number of pixels to the left to move the left of the highlight.

@param aRightExtension

	Number of pixels to the right to move the right of the highlight.

@param aTopExtension

	Number of pixels to the up to move the top of the highlight.

@param aBottomExtension

	Number of pixels to the down to move the bottom of the highlight.

*/

EXPORT_C void CTextView::SetHighlightExtensions(TInt aLeftExtension,

	TInt aRightExtension, TInt aTopExtension, TInt aBottomExtension)

	{

	iLayout->SetHighlightExtensions(aLeftExtension, aRightExtension,

		aTopExtension, aBottomExtension);

	}

/**

Set the delta required to position the baseline so there is enough

space for the highset glyph in pixels.  This is the height of the highest glyph - 

CFont::AscentInPixels().  Only used when using TLineSpacingControl::EAttLineSpacingControl.

By default zero.

@param aExcessHeightRequired

	Extra height above CFont::AscentInPixels() required for the highest glyph in pixels.

*/

EXPORT_C void CTextView::SetExcessHeightRequired(TInt aExcessHeightRequired)

	{

	iLayout->SetExcessHeightRequired( aExcessHeightRequired );

	}

void TCursor::SetVisibility(TVisibility aLineCursor,TVisibility aTextCursor)

	{

	TUint cursorsToDraw=EFNeitherCursor;

	if (aLineCursor==EFCursorFlashing)

		aLineCursor=EFCursorVisible;

	if (iLineCursor!=aLineCursor)

		{

		iLineCursor=aLineCursor;

		cursorsToDraw|=EFLineCursor;

		}

	if (iTextCursor!=aTextCursor)

		{

		iTextCursor=aTextCursor;

		cursorsToDraw|=EFTextCursor;

		}

	Draw(cursorsToDraw);

	}

// Change the cursor type and redraw it.

void TCursor::SetType(TTextCursor::EType aType)

	{

	if (aType != TTextCursor::ETypeNone)

		{

		iType = aType;

		Draw(EFTextCursor);

		}

	}

// Change the cursor placement and redraw it.

void TCursor::SetPlacement(TTmCursorPlacement aPlacement)

	{

	iPlacement = aPlacement;

	Draw(EFTextCursor);

	}

/** Sets the ascent and descent of the text cursor in pixels and redraw it. To

use the ascent or descent of the adjacent character pass a value of -1. */

void TCursor::SetAscentAndDescent(TInt aAscent,TInt aDescent)

	{

	iAscent = aAscent;

	iDescent = aDescent;

	Draw(EFTextCursor);

	}

/** Changes the cursor weight and redraws it.*/

void TCursor::SetWeight(TInt aWeight)

	{

	if (aWeight > 0)

		{

		iWeight = aWeight;

		Draw(EFTextCursor);

		}

	}

/** Sets the flashing state of the cursor and redraws it. */

void TCursor::SetFlash(TBool aEnabled)

	{

	iFlash = aEnabled;

	Draw(EFTextCursor);

	}

/** Sets the XOR colour of the cursor and redraws it. */

void TCursor::SetXorColor(TRgb aColor)

	{

	iXorColor = aColor;

	Draw(EFTextCursor);

	}

/** Sets the cursor so that when it is next drawn its metrics will match those

of adjacent text: cancels any overriding metrics. Does not redraw. */

void TCursor::MatchCursorHeightToAdjacentChar()

	{

	iAscent = iDescent = -1;

	}

/** Draws the specified cursors. */

void TCursor::Draw(TUint aCursors)

	{

	TPoint caret_origin;

	TInt caret_width, caret_ascent, caret_descent;

	TBool cursorsVisible = iCursorPos.GetCursor((TTmCursorPlacement)iPlacement,

											    caret_origin,caret_width,caret_ascent,caret_descent);

	caret_origin += iDisplay.TopLeftTextArea();

	if (aCursors & EFTextCursor)

		{

		if (cursorsVisible && (iTextCursor != EFCursorInvisible) && !iCursorPos.IsNewPictureFrame())

			{

			if (iTextCursor == EFCursorVisible)

				RemoveTextCursor();

			else

				{

				int ascent = 0;

				int descent = 0;

				int width = 0;

				if (iPlacement == ECursorVertical)

					{

					if (iAscent >= 0)

						ascent = iAscent;

					else

						ascent = caret_ascent;

					ascent += iFirstExtension;

					if (iDescent >= 0)

						descent = iDescent;

					else

						descent = caret_descent;

					descent += iSecondExtension;

					width = iWeight;

					// Adjust which side the cursor hangs around the origin

					// based on the sign of the 'width' from tagma.

					if (caret_width<0)

						caret_origin.iX -= iWeight;

					}

				else

					{

					ascent = 0;

					descent = iWeight;

					// Adjust which side the cursor hangs around the origin

					// based on the sign of the 'width' from tagma and set the

					// drawn width to the abs(width) value tagma has given us.

					if (caret_width < 0)

						{

						width = -caret_width;

						caret_origin.iX -= width; 

						}

					else

						width = caret_width;

					caret_origin.iX -= iFirstExtension;

					width += (iFirstExtension + iSecondExtension);

					}

				DrawTextCursor(caret_origin,width,ascent,descent);

				}

			}

		else

			RemoveTextCursor();

		}

	if (iDisplay.IsLineCursor() && (aCursors&EFLineCursor))

		{

		if (cursorsVisible && (iLineCursor != EFCursorInvisible))

			DrawLineCursor(caret_origin.iY);

		else

			RemoveLineCursor();

		}

	}

void TCursor::DrawLineCursor(TInt aHeight)

	{

	__ASSERT_ALWAYS(iLineCursorBitmap,FormPanic(EFLineCursorBitmapNotSet));

	TRect cursorMargin=iDisplay.LineCursorMargin();

	TRect bitmapRect;

	bitmapRect.iTl.iX=cursorMargin.iTl.iX+ELineCursorToLabelGap;

	bitmapRect.iBr.iX=bitmapRect.iTl.iX+iLineCursorBitmap->SizeInPixels().iWidth;

	bitmapRect.iBr.iY=aHeight;

	bitmapRect.iTl.iY=aHeight-iLineCursorBitmap->SizeInPixels().iHeight;

	iDisplay.SetRects(RScreenDisplay::EFClipLineCursor);

	iDisplay.ActivateContext();

	iDisplay.ResetClippingRect();

	if (iDisplay.UseWindowGc() && NULL != iDisplay.Layout())

		{

		iDisplay.Layout()->BeginRedraw(cursorMargin);

		}

	TRegionFix<4> clearRegion(cursorMargin);

	clearRegion.SubRect(bitmapRect);

	for (TUint ii=0; ii<(TUint)clearRegion.Count(); ii++)

		{

		iDisplay.ClearRect(clearRegion.RectangleList()[ii]);

		}

	iDisplay.BlastBitmap(bitmapRect.iTl,iLineCursorBitmap,TRect(TPoint(0,0),bitmapRect.Size()));

	if (iDisplay.UseWindowGc() && NULL != iDisplay.Layout())

		{

		iDisplay.Layout()->EndRedraw();

		}

	iDisplay.DeactivateContext();

	}

void TCursor::RemoveLineCursor()

	{

	TRect cursorMargin=iDisplay.LineCursorMargin();

	iDisplay.SetRects(RScreenDisplay::EFClipLineCursor);

	iDisplay.ActivateContext();

	iDisplay.ResetClippingRect();

	if (iDisplay.UseWindowGc() && NULL != iDisplay.Layout())

		{

		iDisplay.Layout()->BeginRedraw(cursorMargin);

		}

	iDisplay.ClearRect(cursorMargin);

	if (iDisplay.UseWindowGc() && NULL != iDisplay.Layout())

		{

		iDisplay.Layout()->EndRedraw();

		}

	iDisplay.DeactivateContext();

	}

/** Draws the text cursor. */

void TCursor::DrawTextCursor(TPoint aOrigin,TInt aWidth,TInt aAscent,TInt aDescent)

	{

	TTextCursor cursor;

 	cursor.iType = iType;

	cursor.iHeight = aAscent + aDescent;

	cursor.iAscent = aAscent;

	cursor.iWidth = aWidth;

	cursor.iFlags = iFlash ? 0 : TTextCursor::EFlagNoFlash;

	if (iPlacement == ECursorVertical)

		cursor.iFlags |= TTextCursor::EFlagClipVertical;

	if (iPlacement == ECursorUnderlineNext || iPlacement == ECursorUnderlinePrev)

		cursor.iFlags |= TTextCursor::EFlagClipHorizontal;

	cursor.iColor = iXorColor;

	iDisplay.SetTextCursor(aOrigin,cursor);

	iVisible = TRUE;

	}

/** Removes the text cursor only if it is currently visible in this window. */

void TCursor::RemoveTextCursor()

	{

	if (iVisible)

		{

		iDisplay.RemoveTextCursor();

		iVisible = FALSE;

		}

	}

void TCursor::SetExtensions(TInt aFirstExtension, TInt aSecondExtension)

	{

	TBool redraw=EFalse;

	if (aFirstExtension!=iFirstExtension)

		{

		iFirstExtension=aFirstExtension;

		redraw=ETrue;

		}

	if (aSecondExtension!=iSecondExtension)

		{

		iSecondExtension=aSecondExtension;

		redraw=ETrue;

		}

	if( redraw)

		Draw(EFTextCursor);

	}

/** Allocates and constructs a CTextView object.

@param aLayout Pointer to the layout object referenced by the text view. Must 

not be NULL or a panic occurs. 

@param aDisplay The rectangle in which text is displayed (the "view rectangle"). 

@param aGd Bitmapped graphics device to draw to, e.g. the screen. 

@param aDeviceMap The device map used for drawing and formatting. 

@param aWin The window to draw to. Should not be NULL. 

@param aGroupWin Window group. Must be provided if a text cursor is to be displayed. 

It can be NULL if you don't need a text cursor. 

@param aSession Pointer to the window server session. 

@return Pointer to the new CTextView object. */

EXPORT_C CTextView *CTextView::NewL(CTextLayout *aLayout,const TRect &aDisplay,CBitmapDevice *aGd,

									MGraphicsDeviceMap *aDeviceMap,RWindow *aWin,RWindowGroup *aGroupWin,

									RWsSession *aSession)

	{

	CTextView* self = new(ELeave) CTextView();

  	CleanupStack::PushL(self);

	self->ConstructL(aLayout,aDisplay,aGd,aDeviceMap,aWin,aGroupWin,aSession);

	CleanupStack::Pop();

	return self;

	}

/** Called when system is idle. Use to do background formatting. Enters OOM

state before leaving */

EXPORT_C TInt CTextView::IdleL(TAny *aSelf)

	{

	if (((CTextView *) aSelf)->NoMemoryCheckL())

		return EFalse;

	return ((CTextView *) aSelf)->NextLineL();

	}

EXPORT_C CTextView::CTextView():

	iDisplay(&iDrawTextLayoutContext),

	iCursor(iCursorPos,iDisplay),

	iCursorPos(),

	iFlags(EFEverythingVisible | EFFlickerFreeRedraw | EFTextVisible),

	iHorizontalScroll(EFNoPreviousHorizontalScroll),

	iContextIsNavigation(ETrue)

	{

	__ASSERT_DEBUG(EFMemoryOK != EFRecovering,FormPanic(EFSystemConstantsChanged));

	}

EXPORT_C void CTextView::ConstructL(CTextLayout *aLayout,const TRect &aDisplay,CBitmapDevice *aGd,

									MGraphicsDeviceMap *aDeviceMap,RWindow *aWin,RWindowGroup *aGroupWin,

									RWsSession *aSession)

	{

	__ASSERT_ALWAYS(aLayout,FormPanic(EFInvalidLayout));

	iHorizontalScrollJump=EFDefaultHorizontalScrollJump;

	iWrap = CIdle::NewL(EFBackgroundFormattingPriority);

	SetLayout(aLayout);

	SetViewRect(aDisplay);

	SetDisplayContextL(aGd,aWin,aGroupWin,aSession);

	// Tell the Layout classes about the Graphics Device

	aLayout->SetImageDeviceMap(aDeviceMap);

	iDrawTextLayoutContext.SetDrawToEveryPixel(ETrue);

	}

EXPORT_C CTextView::~CTextView()

	{

	delete iPictureFrame;

	delete iWrap;

	DestroyWindowServerObjects();

	}

/** Changes the text layout object used by the text view.

@param aLayout Pointer to the text layout object used by the text view. Must 

not be NULL or a panic occurs. */

EXPORT_C void CTextView::SetLayout(CTextLayout *aLayout)

	{

	__ASSERT_ALWAYS(aLayout,FormPanic(EFInvalidLayout));

	iLayout = aLayout;

	iCursorPos.SetLayout(aLayout);

	iDisplay.SetLayout(aLayout);

	}

/** Changes the window server handles which the display uses. Any of the parameters 

can be NULL in which case they are not changed.

@param aGd Pointer to the bitmapped graphics device to draw to. 

@param aWin Pointer to the view window. 

@param aGroupWin Pointer to the window group. 

@param aSession Pointer to the window server session. */

EXPORT_C void CTextView::SetDisplayContextL(CBitmapDevice * aGd,RWindow *aWin,RWindowGroup *aGroupWin,RWsSession *aSession)

	{

	if (aSession)

		iDisplay.SetWindowsServer(aSession);

	if (aGroupWin)

		iDisplay.SetWindowGroup(aGroupWin);

	if (aWin)

		{

		iDisplay.SetWindow(aWin);

		iLayout->SetWindow(aWin);

		}

	if (aGd)

		iDisplay.SetGraphicsDeviceL(aGd);

	}

/** Sets the rectangle in which the text is displayed.

Note:

A valid band height (>0) must be supplied(i.e. aViewRect.Tl.iY coordinate must be lower than the aViewRect.Br.iY coordinate) or the expected amount of formatting will not take place. This could lead to panics when trying to retrieve formatting information that does not exist.

@param aDisplay The view rectangle. */

EXPORT_C void CTextView::SetViewRect(const TRect &aViewRect)

	{

	iDrawTextLayoutContext.iViewRect = aViewRect;

	iLayout->SetBandHeight(aViewRect.Height());

	TRect oldViewRect = iDrawTextLayoutContext.iViewRect;

	iDrawTextLayoutContext.iViewRect = aViewRect;

	iLayout->SetBandHeight(aViewRect.Height());

	if (NULL != iDisplay.Window() && ! oldViewRect.IsEmpty())

		{

		iDisplay.Window()->Invalidate(oldViewRect);

		}

	}

// deprecated, planning to remove

EXPORT_C void CTextView::AlterViewRect(const TRect &aViewRect)

	{

	iReducedDrawingAreaRect = aViewRect;

	}

/** Sets the label and line cursor margin widths. 

Does not redraw.

@param aLabels The width in pixels of the label margin. 

@param aLineCursor The width in pixels of the line cursor margin. */