/*

* Copyright (c) 2007 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:   Provides CXhtmlParser class methods.

*

*/

#include <coemain.h>

#include <gulfont.h> 

#include <eikenv.h> 

#include <txtfrmat.h>

#include <txtetext.h>

#include <frmconst.h>

#include <e32math.h>

#include <gdi.h>

#include <AknUtils.h>

#include <fontids.hrh>

#include <gmxmldocument.h>

#include <gmxmlnode.h>

#include <gmxmlelement.h>

#include <gmxmltext.h>

#include <smilliterals.h>

#include "Xhtmldef.h"

#include "xhtmlentityconverter.h"

#include "xhtmlfontspecs.h"

#include "xhtmlstack.h"

#include "xhtmlstackmanager.h"

#include "xhtmlhyperlink.h"

#include "xhtmlparser.h"

#include "xhtmlparserlogging.h"

const TInt KNoListContext        = 0;

const TInt KUnorderedListContext = 1;

const TInt KOrderedListContext   = 2;

const TInt KNoStylePosition      = -1;

const TInt KListBullet   = 0x2022;

const TInt KListBullet2  = 0x25E6;

const TInt KPlainBullet  = 0x2d;  // '-'

const TInt KPlainBullet2 = 0x2a;  // '*'

const TInt KColon        = 0x3a;  // ':'

const TInt KSemicolon    = 0x3b;  // ';' 

const TInt KBlackColorCode = 0x000000;

const TInt KWhiteColorCode = 0xffffff;

const TInt KBlueColorCode  = 0xff0000;

const TInt KLimeColorCode  = 0x00ff00;

const TInt KRedColorCode   = 0x0000ff;

const TInt KDefaultIndentWidth  = 4; // 4 spaces

const TInt KDefaultMaxListLevels = 5;

_LIT( KWhiteSpace, " " );

_LIT( KHrSeparator, "__________" );

_LIT16(KListNumberFormat, "%d. ");

_LIT( KNullString, "" );

const TInt KHyperLinkArrayGranularity = 16;

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

const TText KZeroWidthSpace         = 0x200B;

#endif

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

// CXhtmlParser::NewL

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

//

EXPORT_C CXhtmlParser* CXhtmlParser::NewL( MXhtmlParserObserver* aParserObserver )

	{

	CXhtmlParser* self = new( ELeave ) CXhtmlParser( aParserObserver );

	CleanupStack::PushL( self );

	self->ConstructL();

	CleanupStack::Pop( self ); 

	return self;

	};

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

// CXhtmlParser::~CXhtmlParser 

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

//

CXhtmlParser::~CXhtmlParser()

	{

	if( iCurrentCharLayer )

	    {

		iCurrentCharLayer->Reset();

		delete iCurrentCharLayer;

	    }

	delete iXmlParser;    

	delete iXhtmlFontSpecs;

	delete iHyperLinkAddress;

	delete iStackManager;

	delete iXmlDocument;

	if ( iHyperLinkArray )

	    {

	    iHyperLinkArray->ResetAndDestroy();

	    delete iHyperLinkArray;

	    }

	}

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

// CXhtmlParser::CreateDomL 

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

//

EXPORT_C void CXhtmlParser::CreateDomL( RFs &aRFs, const TDesC& aFileToParse )

	{	

	XHTMLLOG_WRITE( "CXhtmlParser::CreateDomL in" );

	User::LeaveIfError( iXmlParser->ParseFile( aRFs, aFileToParse ) );

	XHTMLLOG_WRITE( "CXhtmlParser::CreateDomL out" );

	}

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

// CXhtmlParser::CreateDomL 

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

//

EXPORT_C void CXhtmlParser::CreateDomL( RFile& aFileHandleToParse )

	{

	XHTMLLOG_WRITE( "CXhtmlParser::CreateDomL in" );

	User::LeaveIfError( iXmlParser->ParseFile( aFileHandleToParse ) );

	XHTMLLOG_WRITE( "CXhtmlParser::CreateDomL out" );

	}

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

// CXhtmlParser::ParseL 

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

//

EXPORT_C void CXhtmlParser::ParseL( CRichText& aRichText )

	{

	XHTMLLOG_WRITE( "CXhtmlParser::ParseL in" );

	iRichText = &aRichText;

   	ResetValues();

   	ParseDomL( iXmlDocument);

	XHTMLLOG_WRITE( "CXhtmlParser::ParseL out" );

	}

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

// CXhtmlParser::Cancel 

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

//	

EXPORT_C void CXhtmlParser::Cancel()

    {

    iXmlParser->Cancel();

    }

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

// CXhtmlParser::SetFonts 

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

//

EXPORT_C void CXhtmlParser::SetFonts( const CFont* aBigFont,

	                                  const CFont* aDefaultFont,

	                                  const CFont* aSmallFont,

	                                  const CFont* aCourierFont )

    {

    iXhtmlFontSpecs->SetFonts( aBigFont, aDefaultFont, aSmallFont, aCourierFont );

    }

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

// CXhtmlParser::SetDefaultTextColor 

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

//   

EXPORT_C void CXhtmlParser::SetDefaultTextColor( TRgb aColor )

    {

    iTextColor = aColor;

    }

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

// CXhtmlParser::SetMode

// 

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

// 

EXPORT_C void CXhtmlParser::SetMode( TBool aPlainText, TBool aShowUrls )

    {

    iPlainText = aPlainText;

    iShowUrls = aShowUrls;

    }

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

// CXhtmlParser::HyperLink 

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

// 

EXPORT_C TInt CXhtmlParser::HyperLink( TInt aIndex, 

                        TInt& aStartPos, TInt& aEndPos,

                        TPtrC& aAddress )

    {

    if ( aIndex >= iHyperLinkArray->Count() )

        {

        return KErrArgument;

        }

    CXhtmlHyperLink* hpLink = (*iHyperLinkArray)[aIndex];

    aStartPos = hpLink->StartPosition();

    aEndPos = hpLink->EndPosition();

    if ( hpLink->Address() )

        {

        TPtr tmpPtr = hpLink->Address()->Des();

        aAddress.Set( tmpPtr );

        }

    else

        {

        aAddress.Set(KNullString);

        }

    return KErrNone;

    }

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

// CXhtmlParser::HyperLinkCount 

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

// 

EXPORT_C TInt CXhtmlParser::HyperLinkCount()

    {

    if ( iHyperLinkArray )

        {

        return iHyperLinkArray->Count();

        }

    return 0;        

    }

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

// CXhtmlParser::ParseFileCompleteL

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

//

void CXhtmlParser::ParseFileCompleteL()

    {

	XHTMLLOG_WRITE( "CXhtmlParser::ParseFileCompleteL in" );

    delete iXmlDocument;

    iXmlDocument = iXmlParser->DetachXMLDoc();

    TRAPD( error, iObserver->ParseCompleteL() );

    if ( error )

        {

        iObserver->ParseError( error );

        }

	XHTMLLOG_WRITE( "CXhtmlParser::ParseFileCompleteL out" );

    }

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

// CXhtmlParser::CXhtmlParser

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

//

CXhtmlParser::CXhtmlParser(  MXhtmlParserObserver* aParserObserver ) :

   	iParsingAllowed( EFalse ),

	iPlainText( EFalse ),

	iShowUrls( EFalse ),

	iPreformatted( 0 ),

	iAlignment( CParaFormat::ELeftAlign ),

	iStylePos( KNoStylePosition ),

	iNewParagraph( EFalse ),

    iNewLines( 0 ),

	iForcedNewLines( 0 ),

	iSkipWhiteSpaces( ETrue ),

	iAlignmentChanged( EFalse ),

	iImageFound( EFalse ),

	iFirstTextLineAdded( EFalse ),

	iCurrentListContext( KNoListContext ), 

	iDefListLevel( 0 ),

	iBlockQuoteLevel( 0 ),

	iHyperLinkPos( 0 ),

	iTextColor( KBlackColorCode ),

    iObserver( aParserObserver ),

   	iIndentWidth( KDefaultIndentWidth ),

	iMaxListLevels( KDefaultMaxListLevels )

   	{

	}

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

// CXhtmlParser::ConstructL

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

//

void CXhtmlParser::ConstructL()

	{

	iStackManager = CXhtmlStackManager::NewL();

    iXmlParser = CMDXMLParser::NewL( this );

// This enables the correction of the following bug:

//

// ID: TPHU-72BFLV

// Title: MMS Viewer: Whitespace characters are consumed in XHTML text     

//

// Partial correction to the bug is implemented in Symbian XML parser code.

// This call sets XML parser to mode where all whitespaces are forwarded to

// XHTML parser inside DOM document. So, actual whitespace handling is 

// implemented inside XHTML parser.   

    iXmlParser->SetWhiteSpaceHandlingMode( ETrue );

    CXhtmlEntityConverter* converter =

        new ( ELeave ) CXhtmlEntityConverter();

	//Ownership transferred to XML parser

   	iXmlParser->SetEntityConverter( converter ); 

    iXhtmlFontSpecs = new ( ELeave ) CXhtmlFontSpecs();

    iHyperLinkArray = new ( ELeave ) CArrayPtrFlat<CXhtmlHyperLink>( KHyperLinkArrayGranularity );

   	}

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

// CXhtmlParser::ParseDomL 

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

//

void CXhtmlParser::ParseDomL( CMDXMLDocument* aXmlDocument )

	{

	XHTMLLOG_WRITE( "CXhtmlParser::ParseDomL in" );

    TCharFormat charFormat;

	TCharFormatMask charFormatMask;

	charFormat.iFontSpec = iXhtmlFontSpecs->DefaultFont()->FontSpecInTwips();

	charFormat.iFontPresentation.iTextColor = iTextColor;

    charFormatMask.SetAttrib( EAttColor );

    charFormatMask.SetAttrib( EAttFontTypeface );

    charFormatMask.SetAttrib( EAttFontPosture );

    charFormatMask.SetAttrib( EAttFontHeight );

    charFormatMask.SetAttrib( EAttFontStrokeWeight );

    // delete old CharFormatLayer

    if( iCurrentCharLayer )

	    {

		iCurrentCharLayer->Reset();

		delete iCurrentCharLayer;

		iCurrentCharLayer = NULL;

	    }

	// create new CharFormatLayer based on GlobalCharFormatLayer and

	// custom font/color

	CCharFormatLayer* charFormatLayer = CCharFormatLayer::NewL( charFormat,

	    charFormatMask );

	charFormatLayer->SetBase( iRichText->GlobalCharFormatLayer() );

	iCurrentCharLayer = charFormatLayer;

	CMDXMLNode* node = aXmlDocument->DocumentElement();   

	while( node )

		{

		OpenNodeL( node );

		if( node->FirstChild() )

		    {

		    node = node->FirstChild();

		    }

		else if( node->NextSibling() )

			{

			CloseNodeL( node );

			node = node->NextSibling();

			}

		else 

			{

			while( node )

				{

				CloseNodeL( node );

				if( node->NextSibling() )

					{

					node = node->NextSibling();

					break;

					}				

				node = node->ParentNode();			

				}

			}

		}	

	XHTMLLOG_WRITE( "CXhtmlParser::ParseDomL out" );

	}

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

// CXhtmlParser::OpenNodeL

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

//

void CXhtmlParser::OpenNodeL( CMDXMLNode* aNode )

	{

    switch( aNode->NodeType() )

        {

	    case CMDXMLNode::EElementNode:

	        {

	        CMDXMLElement* element = static_cast<CMDXMLElement*>( aNode );

	        // PrepareForBeginElementL does some operations needed before possible

	        // attributes are handled.

	        //

	        // In practice PrepareForBeginElementL adds a new style to stylestack

	        // If there is no attributes within this tag, this style is not used although

	        // it is on the stack

	        PrepareForBeginElementL( element->NodeName() );

            // handle possible attributes related to begin tag

            for( TInt i = 0; i<element->NumAttributes(); ++i )

                {

                TPtrC name;

                TPtrC value;

                if ( element->AttributeDetails( i, name, value ) == KErrNone )

                    {

                    AttributeValueL( name, value );

                    }

                }

    		// Handles actual begin tag. If it doesn't cause changes to 

    		// style or paragraphs, doesn't do anything	

    		BeginElementL( element->NodeName() );

            break;    		    

    		}

	    case CMDXMLNode::ETextNode:

    	    {

    		CMDXMLText* txt = static_cast<CMDXMLText*>( aNode );

    		// Adds actual text to CRichText object.

    		// Style and paragraph format are added later when

    		// end tags are handled   	

    		ContentL( txt->Data() );

            break;    		    

        	}

	    case CMDXMLNode::ECDATASectionNode:

    	    {

            // CDATA section skipped

    		break;

            }

        case CMDXMLNode::ECommentNode:

    	    {

    	    // comment skipped

       		break;

            }

        default:

            {

            break;

            }

	    }

	}

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

// CXhtmlParser::CloseNode 

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

//

void CXhtmlParser::CloseNodeL( CMDXMLNode* aNode )

	{

	if( aNode->NodeType()==CMDXMLNode::EElementNode )

		{

        EndElementL( aNode->NodeName() );

   		}	

	}

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

// CXhtmlParser::PrepareForBeginElementL 

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

//

void CXhtmlParser::PrepareForBeginElementL( const TDesC& aName )

	{

	iAlignmentChanged = EFalse;

	iImageFound = EFalse;

	if ( !aName.CompareF( KATag ) )

        {

        BeginHyperLink( iRichText->DocumentLength() );

        }

    else if ( !aName.CompareF( KImgTag ) )

        {

        iImageFound = ETrue;

        }

	BeginStyleL();

	}

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

// CXhtmlParser::BeginElementL

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

//

void CXhtmlParser::BeginElementL( const TDesC& aName )

	{

	iImageFound = EFalse;

	// If default alignment changed within this tag, begin new paragraph with new alignment.

	// Add information about changed alignment. This info is used later

	// to end paragraph

    if ( iAlignmentChanged )

	    {

	    iStackManager->StyleStack()->Top()->iAlignmentChanged = ETrue;

        iAlignmentChanged = EFalse;

        BeginParagraphL( iAlignment );

   		}

	if( !aName.CompareF( KHtmlTag ) )

		{

		}

    else if( !aName.CompareF( KHrTag ) )

        {

 	    BeginParagraphL( CParaFormat::ECenterAlign );

 	    // default alignment is center

	    BeginStyleL();

	    TCharFormat charFormat;

	    TCharFormatMask charFormatMask;

	    charFormat.iFontSpec = iXhtmlFontSpecs->DefaultFont()->FontSpecInTwips();

	    charFormatMask.SetAttrib( EAttFontHeight );

	    charFormatMask.SetAttrib( EAttFontTypeface );

	    charFormatMask.SetAttrib( EAttFontPosture );

        charFormatMask.SetAttrib( EAttFontStrokeWeight );

	    ChangeCurrentStyleL(charFormat, charFormatMask);

	    InsertTextL( KHrSeparator);