/*

* Copyright (c) 2003 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:  SVG Implementation header file

 *

*/

#ifndef SVGDOCUMENTIMPL_H

#define SVGDOCUMENTIMPL_H

#if !defined(__E32BASE_H__)

#include <e32base.h>

#endif

#include <gdi.h>

class CSvgEngineImpl;

class   CSvgEventHandler;

class CSvgErrorImpl;

class CSvgElementImpl;

class MSvgEventReceiver;

#include "SVGXmlDocument.h"

#include "SVGEvent.h"

#include "SVGEngineInterfaceImpl.h"

#include "SVGImageLoadingObserver.h" // MSVGImageLoadingObserver

#include "SVGErrorImpl.h"

#include "Gfx2dGcOpenVG.h"

//#include "SVGImageHashMap.h"

#include "SVGFontHashMap.h"

#include "SVGMemoryManager.h"

#include "SVGTimedEntityInterface.h"

#include "SvgBitmapFontProvider.h"

class   MXmlElement;

class   CSvgSchemaData;

class   CSvgContentHandler;

class CSvgAnimationBase;

class CSvgTimeContainer;

/**

 * Enumeration to define search query constraints for FindAllElements

 */

enum TSvgSearchFlags

    {

    ESvgSearchAllElements           = 0,

    ESvgSearchExcludeUseSubtree     = 0x2,

    };

/**

 * An SVG document that represents a SVG element tree..

 */

class CSvgDocumentImpl : public CBase,

                         public MXmlDocument,

                         public MSVGImageLoadingObserver,

                         public MSvgTimedEntityInterface

    {

    public:

        /**

         * Two Phase constructor for SVG document

         * @since 1.0

         * @param aHasParent - Indicates whether document has a 

         *                              parent document or not

         *        aSyncBehavDefault - Indicates default synchronised behaviour

         *                            for runtime synchronisation.

         *        aSyncTolDefault - Indicates the synchronised tolerance in 

         *                          msecs for runtime synchronisation.

         * @return CSvgDocumentImpl* 

         */

        void Reset(MSvgEvent* aEvent);

        static CSvgDocumentImpl* NewL(CSvgBitmapFontProvider* aSvgBitmapFontProvider, 

            const TBool aHasParent = EFalse,

            const TSvgSyncBehaviour aSyncBehavDefault = KSvgDefaultSyncBehaviour,

            const TInt32 aSyncTolDefault = KSvgDefaultSyncTolerance );

        /**

         * Need method description

         *

         * @since 1.0

         * @param aHasParent - Indicates whether document has a 

         *                              parent document or not

         *        aSyncBehavDefault - Indicates default synchronised behaviour

         *                            for runtime synchronisation.

         *        aSyncTolDefault - Indicates the synchronised tolerance in 

         *                          msecs for runtime synchronisation.

         * @return

         */

        static CSvgDocumentImpl* NewLC(CSvgBitmapFontProvider* aSvgBitmapFontProvider, 

            const TBool aHasParent = EFalse,

            const TSvgSyncBehaviour aSyncBehavDefault = KSvgDefaultSyncBehaviour,

            const TInt32 aSyncTolDefault = KSvgDefaultSyncTolerance );

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        virtual                 ~CSvgDocumentImpl();

    public:

        /**

         * ImageLoadingObserver interface method.

         * Called from Image loading class to notify image loading

         * completion.

         *

         * @since 1.0

         * @param : aErrorStatus -- error status, if any

         * @return : none

         */

        virtual void ImageLoadingCompleted( TInt aErrorStatus );

        // Pointer/Hyperlink related

        void FindAllElements( CSvgElementImpl* aStartElement, TInt aElementId,

                              RPointerArray<CSvgElementImpl>& aList,

                              TSvgSearchFlags aFlags = ESvgSearchAllElements );

        TBool SvgElementPresent(CSvgElementImpl* aElement);

        TBool SearchByPointer(CSvgElementImpl* aParent, CSvgElementImpl* aElement);

        CXmlElementImpl* GetFocusElement();

        void SetFocusElement(CXmlElementImpl* aElement );

        // From MXmlDocument

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        MXmlElement*            CreateElementL( const TDesC& aTagName );

        MXmlElement*            CreateElementL( const TUint8 aTagName );

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        TInt                    CreateAttribute( const TDesC& aName );

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        MXmlElement*            GetElementById( const TDesC& aElementId );

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        TInt           GetNumberOfIds(MXmlElement* aElement);

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        TDesC*            GetId( TInt index );

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        void            FindAllIds( CSvgElementImpl* aStartElement, RPointerArray<TDesC>& aList );

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        MXmlElement*            AppendChildL( MXmlElement* aAppendChild );

        // From MSvgDocument

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        /**

         * Get URL

         */

        TDesC&         GetUrl();       // method of CSvgDocumentImpl

        /**

         * get root element

         */

        IMPORT_C MXmlElement*   RootElement();  // method of CSvgDocumentImpl

        // Class functions

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        CSvgSchemaData*         SchemaData();

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        void                    SetUri( const TDesC& aUri );

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        void                    GetUri( TDes& aUri );

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        void                    SetEngine( CSvgEngineImpl* aEngine );

        /**

         * Need method description

         *

         * @since 1.0

         * @param

         * @return

         */

        CSvgEngineImpl*         Engine();

        /**

         * Add an object to the list of objects that are notified of an event

         *

         * @since 1.0

         * @param aElement - An SVG element that wants to be registered for an event (implements MSvgEventReceiver interface)

         * @param aEventMask - A bit mask that indicates the types of events an object listens for

         * @return None

         */

        void                    AddToEventReceiverListL( MSvgEventReceiver* aElement,

                                                        TUint8 aEventMask );

        /**

         * Add an object to the list of objects that are notified of an event

         * Has an additional parameter aEvent which is used to check for interactive events 

         *

         * @since v3.2

         * @param aElement - An SVG element that wants to be registered for an event (implements MSvgEventReceiver interface)

         * @param aEvent - An SVG Event that the target element needs to generate 

         * @param aEventMask - A bit mask that indicates the types of events an object listens for

         * @return None

         */

        void                    AddToEventReceiverListL( MSvgEventReceiver* aElement,

                                                         TSvgEvent aEvent,

                                                        TUint8 aEventMask );

         /**

         * Removed an object to the list of objects that are notified of an event

         *

         * @since 1.0

         * @param aElement - An SVG element that wants to be registered for an event (implements MSvgEventReceiver interface)

         * @return None

         */

        void                    RemoveFromEventReceiverList( MSvgEventReceiver* aElement );

          /**

         * Provide the event end time information to the Event Handler

         *

         * @since 1.0

         * @param aElement - An element that, ultimately, processes the event (eg. an animation element)

         * @param aTime - The end time for an event on the target element

         * @param aTargetElement - The element for which the event is processed

         * @return

         */

        void                    AddEventBeginTime(MSvgEventReceiver* aElement, TUint32 aTime, MSvgEventReceiver* aTargetElement );

        /**

         * An internal method that sorts the events in a time scale

         *

         * @since 1.0

         * @param None

         * @return None

         */

        void                    SortEventList();

         /**

         * returns the next (or prev) focussable object starting with a given index

         *

         * @since 1.0

         * @param aIndex - search for a focussable object with this index

         * @param aNext - Etrue (next) EFalse (prev) (go forward or backward for search)

         * @param aEventMask - Event mask for event types the client is interested in

         * @param aNewIndex - Return the actual index where the object was found

         * @return The focussable object or NULL if not found

         */

        CSvgElementImpl*        GetEventReceiverElement(TInt32 aIndex, TBool aNext, TUint8 aEventMask, TInt32& aNewIndex);

             /**

         * Checks whether the current loaded file is animatable or static

         *

         *

         *

         * @param : None

         * @return: TBool boolean

         */

        TBool IsAnimationFile();

         /**

         * Checks whether the aSubEventMask is has a valid value set

         * @since v3.2

         * @param : aSubEventMask - The bitmap mask which contains the list

         *                          of interactive events if any with the element.  

         * @return: Etrue - if aSubEventMask has some valid bits set else EFalsee

         */

        TBool IsValidSubEventMask(TUint16 aSubEventMask);

           /**

         * Sets DRM Check Enable/Disable

         *

         *

         * @param : TBool : aEnable Boolean

         * @return: None

         */

        void SetDRMMode(TBool aEnable);

        void ReInitialize();

        /**

         * Load a svg content from the given filename

         *

         * @param : aFileName : filename of content (binary or text content)

         * @param : aError : error object to store error-info

         * @return: None

         */

        void Load( const TDesC& aFileName, CSvgErrorImpl& aError );

        /**

         * Load a svg content from the given byte-array

         *

         * @param : aByteData : byte-array content (binary or text content)

         * @param : aError : error object to store error-info

         * @return: None

         */

        void Load( const TDesC8& aByteData, CSvgErrorImpl& aError, TBool aRemoveFalseSwitchElements = ETrue );

		/**

         * Load a svg content from JSR226 that is already TDesc16

         *

         * @param : aSvgString

         * @param : aError : error object to store error-info

         * @return: None

         */

        void Load16BitString( const TDesC16& aSvgString, CSvgErrorImpl& aError, TBool aRemoveFalseSwitchElements = ETrue );

        /**

         * Load a svg content from the given file-handle

         *

         * @param : aFileHandle : file-handle content (binary or text content)

         * @param : aError : error object to store error-info

         * @return: None

         */

        void Load( RFile& aFileHandle, CSvgErrorImpl& aError );

        /**

         * Set the document to be in thumbnailmode, which will not consume the DRM right

         * if the Svg content is DRM encrypted.

         *

         * @param : aThumbNailMode : thumbnail mode flag.

         * @return:

         */

        void SetThumbNailMode( TBool aThumbNailMode );

        /**

        * Set the document to disable/enable consuming drm rights

        * @param aEnable: ETrue for disabling consumption of drm rights

        * @return : none

        */

        void SetDRMRights(TBool aEnable);

        /**

         * Return whether the loaded document is a thumbnail only.  ETrue is returned only

         * when the loaded content is DRM protected AND SetThumbNailMode is called with ETrue.

         *

         * @return:

         */

        TBool IsThumbNailOnly();

        /**

         * Set the flag to indicate this document was prepared (PrepareDom) or loaded (Load).

         *

         * @return: None

         */

        void SetWasPrepared( TBool aBool );

        /**

         * Return whether this document was prepared (PrepareDom) or loaded (Load).

         *

         * @return: Prepared or Loaded.

         */

        TBool WasPrepared();

        /**

         * Set the list of MSvgLoadingListener for this document to send

         * back notification of parsing progress.  NULL is also valid.

         * @param : aList : Pointer to list

         * @return : none

         */

        void SetLoadingListeners( const RPointerArray<MSvgLoadingListener>* aList );

        /**

         * Set the list of MSvgLoadingListener for this document to send

         * back notification of parsing progress.  NULL is also valid.

         * @param : aList : Pointer to list

         * @return : none

         */

        const RPointerArray<MSvgLoadingListener>* GetLoadingListeners();

        /**

         * Add a MSvgMouseListener to this SvgEngine

         *

         * @param : aListener -- listener to add to listener list

         * @return: None

         */

        void AddInternalMouseListener( const MSvgMouseListener* aListener );

        /**

         * Remove a MSvgMouseListener to this SvgEngine

         *

         * @param : aListener -- listener to remove from listener list

         * @return: None

         */

        void RemoveInternalMouseListener( const MSvgMouseListener* aListener );

        /**

         * Return number of mouselisteners.

         *

         * @return: mouse-listener count

         */

        TInt MouseInternalListenerCount();

        /**

         * Send to mouse listeners of a mouse-pressed event.

         *

         * @param : aElements -- elements affected by mouse-event.

         * @param : aX -- X-cooordinate of mouse-event.

         * @param : aY -- X-cooordinate of mouse-event.

         * @return: None

         */

        void NotifyInternalMousePressed( RPointerArray<CSvgElementImpl>& aElements,

                                 TInt aX, TInt aY );

        /**

         * Send to mouse listeners of a mouse-released event.

         *

         * @param : aElements -- elements affected by mouse-event.

         * @param : aX -- X-cooordinate of mouse-event.

         * @param : aY -- X-cooordinate of mouse-event.

         * @return: None

         */

        void NotifyInternalMouseReleased( RPointerArray<CSvgElementImpl>& aElements,

                                  TInt aX, TInt aY );

        /**

         * Send to mouse listeners of a mouse-entered event.

         *

         * @param : aElements -- elements affected by mouse-event.

         * @param : aX -- X-cooordinate of mouse-event.

         * @param : aY -- X-cooordinate of mouse-event.

         * @return: None

         */

        void NotifyInternalMouseEntered( RPointerArray<CSvgElementImpl>& aElements,

                                 TInt aX, TInt aY );

        /**

         * Send to mouse listeners of a mouse-exited event.

         *

         * @param : aElements -- elements affected by mouse-event.

         * @param : aX -- X-cooordinate of mouse-event.

         * @param : aY -- X-cooordinate of mouse-event.

         * @return: None

         */

        void NotifyInternalMouseExited( RPointerArray<CSvgElementImpl>& aElements,

                                TInt aX, TInt aY );

        /**

         * Send to mouse listeners of a mouse-moved event.