/*

* Copyright (c) 2005 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:  DM Utilities

*

*/

#ifndef __NSMLDMTREEDTD_H

#define __NSMLDMTREEDTD_H

#include <e32std.h>

#include <e32base.h>

#include <s32file.h>

#include <smldmadapter.h>

_LIT8( KNSmlDmTreeDTDVersion, "1.1" ); 

//XML generator flags

_LIT8( KNSmlDDFMgmtTree, "<MgmtTree>" ); 

_LIT8( KNSmlDDFMgmtTreeEnd, "</MgmtTree>" ); 

_LIT8( KNSmlDDFNode, "<Node>" ); 

_LIT8( KNSmlDDFNodeEnd, "</Node>" ); 

_LIT8( KNSmlDDFNodeName, "<NodeName>" ); 

_LIT8( KNSmlDDFNodeNameEnd, "</NodeName>" ); 

_LIT8( KNSmlDDFDFProperties, "<DFProperties>" ); 

_LIT8( KNSmlDDFDFPropertiesEnd, "</DFProperties>" ); 

_LIT8( KNSmlDDFPath, "<Path>" ); 

_LIT8( KNSmlDDFPathEnd, "</Path>" ); 

_LIT8( KNSmlDDFValue, "<Value>" ); 

_LIT8( KNSmlDDFValueEnd, "</Value>" ); 

_LIT8( KNSmlDDFVerDTD, "<VerDTD>" );

_LIT8( KNSmlDDFVerDTDEnd, "</VerDTD>" ); 

_LIT8( KNSmlDDFMan, "<Man>" );

_LIT8( KNSmlDDFManEnd, "</Man>" );

_LIT8( KNSmlDDFMod, "<Mod>" );

_LIT8( KNSmlDDFModEnd, "</Mod>" );

_LIT8( KNSmlDDFAccessType, "<AccessType>" );

_LIT8( KNSmlDDFAccessTypeEnd, "</AccessType>" );

_LIT8( KNSmlDDFDefaultValue, "<DefaultValue>" );

_LIT8( KNSmlDDFDefaultValueEnd, "</DefaultValue>" );

_LIT8( KNSmlDDFDescription, "<Description>" );

_LIT8( KNSmlDDFDescriptionEnd, "</Description>" );

_LIT8( KNSmlDDFDFTitle, "<DFTitle>" );

_LIT8( KNSmlDDFDFTitleEnd, "</DFTitle>" );

_LIT8( KNSmlDDFDFType, "<DFType>" );

_LIT8( KNSmlDDFDFTypeEnd, "</DFType>" );

_LIT8( KNSmlDDFDFFormat, "<DFFormat>" );

_LIT8( KNSmlDDFDFFormatEnd, "</DFFormat>" );

_LIT8( KNSmlDDFFormatB64, "<b64/>" );

_LIT8( KNSmlDDFFormatDate, "<date/>" );

_LIT8( KNSmlDDFFormatTime, "<time/>" );

_LIT8( KNSmlDDFFormatFloat, "<float/>" );

_LIT8( KNSmlDDFFormatBool, "<bool/>" );

_LIT8( KNSmlDDFFormatChr, "<chr/>" );

_LIT8( KNSmlDDFFormatInt, "<int/>" );

_LIT8( KNSmlDDFFormatNode, "<node/>" );

_LIT8( KNSmlDDFFormatNull, "<null/>" );

_LIT8( KNSmlDDFFormatXml, "<xml/>" );

_LIT8( KNSmlDDFFormatBin, "<bin/>" );

_LIT8( KNSmlDDFAccessTypeAdd, "<Add/>" );

_LIT8( KNSmlDDFAccessTypeDelete, "<Delete/>" );

_LIT8( KNSmlDDFAccessTypeGet, "<Get/>" );

_LIT8( KNSmlDDFAccessTypeReplace, "<Replace/>" );

_LIT8( KNSmlDDFAccessTypeExec, "<Exec/>" );

_LIT8( KNSmlDDFAccessTypeCopy, "<Copy/>" );

_LIT8( KNSmlDDFOccurrence, "<Occurrence>" );

_LIT8( KNSmlDDFOccurrenceEnd, "</Occurrence>" ); 

_LIT8( KNSmlDDFOccurrenceOne, "<One/>" );

_LIT8( KNSmlDDFOccurrenceZeroOrOne, "<ZeroOrOne/>" );

_LIT8( KNSmlDDFOccurrenceZeroOrMore, "<ZeroOrMore/>" );

_LIT8( KNSmlDDFOccurrenceOneOrMore, "<OneOrMore/>" );

_LIT8( KNSmlDDFOccurrenceZeroOrN, "<ZeroOrN/>" );

_LIT8( KNSmlDDFOccurrenceOneOrN, "<OneOrN/>" );

_LIT8( KNSmlDDFScope, "<Scope>" );

_LIT8( KNSmlDDFScopeEnd, "</Scope>" );

_LIT8( KNSmlDDFScopePermanent, "<Permanent/>" );

_LIT8( KNSmlDDFScopeDynamic, "<Dynamic/>" );

_LIT8( KNSmlDDFMIME, "<MIME>" );

_LIT8( KNSmlDDFMIMEEnd, "</MIME>" );

_LIT8( KNSmlDDFRTProperties, "<RTProperties>" ); 

_LIT8( KNSmlDDFRTPropertiesEnd, "</RTProperties>" ); 

_LIT8( KNSmlDDFACL, "<ACL>" ); 

_LIT8( KNSmlDDFACLEnd, "</ACL>" ); 

_LIT8( KNSmlDDFFormat, "<Format>" ); 

_LIT8( KNSmlDDFFormatEnd, "</Format>" ); 

_LIT8( KNSmlDDFName, "<Name>" ); 

_LIT8( KNSmlDDFNameEnd, "</Name>" ); 

_LIT8( KNSmlDDFSize, "<Size>" ); 

_LIT8( KNSmlDDFSizeEnd, "</Size>" );

_LIT8( KNSmlDDFTitle, "<Title>" ); 

_LIT8( KNSmlDDFTitleEnd, "</Title>" );

_LIT8( KNSmlDDFTStamp, "<TStamp>" ); 

_LIT8( KNSmlDDFTStampEnd, "</TStamp>" );

_LIT8( KNSmlDDFType, "<Type>" ); 

_LIT8( KNSmlDDFTypeEnd, "</Type>" );

_LIT8( KNSmlDDFVerNo, "<VerNo>" ); 

_LIT8( KNSmlDDFVerNoEnd, "</VerNo>" );

_LIT8( KNSmlDevInfoMan, "DevInfo/Man" );

_LIT8( KNSmlDevInfoMod, "DevInfo/Mod" );

_LIT( KNSmlTreeDTDPanic, "NSmlDMTreeDTD" );

_LIT8( KNSmlDDFCaseSense, "CS" );

_LIT8( KNSmlDDFCaseInSense, "CIS" );

enum TNSmlDdfWBXMLTags 

	{

EDDFMgmtTree = 5,

EDDFMgmtTreeEnd,

EDDFNode,

EDDFNodeEnd,

EDDFNodeName,

EDDFNodeNameEnd,        //10

EDDFDFProperties,

EDDFDFPropertiesEnd,

EDDFPath,

EDDFPathEnd,

EDDFValue,              //15

EDDFValueEnd,

EDDFVerDTD,

EDDFVerDTDEnd,

EDDFMan,

EDDFManEnd,             //20

EDDFMod,

EDDFModEnd,

EDDFAccessType,

EDDFAccessTypeEnd,

EDDFDefaultValue,       //25

EDDFDefaultValueEnd,

EDDFDescription,

EDDFDescriptionEnd,

EDDFDFTitle,

EDDFDFTitleEnd,         //30

EDDFDFType,

EDDFDFTypeEnd,

EDDFDFFormat,

EDDFDFFormatEnd,

EDDFFormatB64,          //35

EDDFFormatBool,

EDDFFormatChr,

EDDFFormatInt,

EDDFFormatNode,

EDDFFormatNull,         //40

EDDFFormatXml,

EDDFFormatBin,

EDDFFormatDate,

EDDFFormatTime,

EDDFFormatFloat,

EDDFAccessTypeAdd,

EDDFAccessTypeDelete,

EDDFAccessTypeGet,      //45

EDDFAccessTypeReplace,

EDDFAccessTypeExec,

EDDFAccessTypeCopy,

EDDFOccurrence,

EDDFOccurrenceEnd,      //50

EDDFOccurrenceOne,

EDDFOccurrenceZeroOrOne,

EDDFOccurrenceZeroOrMore,

EDDFOccurrenceOneOrMore,

EDDFOccurrenceZeroOrN,  //55

EDDFOccurrenceOneOrN,

EDDFScope,

EDDFScopeEnd,

EDDFScopePermanent,

EDDFScopeDynamic,       //60

EDDFMIME,

EDDFMIMEEnd,

EDDFRTProperties,

EDDFRTPropertiesEnd,

EDDFACL,                //65

EDDFACLEnd,

EDDFFormat,

EDDFFormatEnd,

EDDFName,

EDDFNameEnd,            //70

EDDFSize,

EDDFSizeEnd,

EDDFTitle,

EDDFTitleEnd,

EDDFTStamp,             //75

EDDFTStampEnd,

EDDFType,

EDDFTypeEnd,

EDDFVerNo,

EDDFVerNoEnd,            //80

EDDFStaticLevel,

EDDFStaticLevelEnd,

EDDFAdapterUid,

EDDFAdapterUidEnd,

EDDFHostServerId,

EDDFHostServerIdEnd

	};

enum TNSmlDmDDFFormat 

	{

	ENSmlDmDDFLeaf,

	ENSmlDmDDFNode,

	ENSmlDmDDFNotFound

	};

//class forwards

class CNSmlDmNodeList;

// ===========================================================================

//PCData element

// ===========================================================================

/**

* CNSmlDmPcdata is data element in DDF tree structure

*

*  @since

*/

class CNSmlDmPcdata : public CBase

	{

public:

	/**

	* Length of the data in this PCDATA structure

	*/

	TInt	iLength;

	/**

	* Pointer to the data

	*/

	TAny*	iContent;       

public:

	/**

	* Constructor

	*/

	CNSmlDmPcdata();

	/**

	* Destructor

	*/

	~CNSmlDmPcdata();

	/**

	* Frees content

	*/

	void FreeContent();

	/**

	* Sets data

	* @param	aData				Data to be set

	*/

	void DataL( const TDesC8& aData );

	/**

	* Compare data

	* @param	aStr				Data start  pointer

	* @param	aLength				Data length

	* @return						ETrue if data is similar to iContent

	*/

	TBool Compare(const TUint8* aStr, TInt aLength);

private:

	};

// ===========================================================================

// RTProperties 

// ===========================================================================

/**

* CNSmlDmRTProperties contains runtime properties element in DDF tree

* structure

*

*  @since

*/

class CNSmlDmRTProperties : public CBase

	{

public:

	/**

	* ACL Property

	*/

	CNSmlDmPcdata iACL;

	/**

	* Name property

	*/

	CNSmlDmPcdata iName;				

	/**

	* Format property

	*/

	MSmlDmDDFObject::TDFFormat	iFormat;

	/**

	* Size property, optional

	*/

	CNSmlDmPcdata* iSize;		

	/**

	* Title property, optional

	*/

	CNSmlDmPcdata* iTitle;		

	/**

	* TimeStamp property, optional

	*/

	CNSmlDmPcdata* iTStamp;		

	/**

	* Type property, optional

	*/

	CNSmlDmPcdata* iType;		

	/**

	* Version number property, optional

	*/

	CNSmlDmPcdata* iVerNo;		

public:

	/**

	* Destructor

	*/

	virtual ~CNSmlDmRTProperties();

	/**

	* Generates xml of elelment

	* @param	aObject			Buffer to write xml

	*/

	void GenerateRTPropertiesL(CBufBase& aObject);

private:

	/**

	* Constructor

	*/

	CNSmlDmRTProperties();

	};

// ===========================================================================

// DFProperties 

// ===========================================================================

/**

* CNSmlDmDFProperties contains description framwork properties element in

* DDF tree structure

*

*  @since

*/

class CNSmlDmDFProperties : public CBase

	{

public:

	/**

	* Accestype property of the node

	*/

	TUint8 iAccessTypes;

	/**

	* Default value property of the node, optional

	*/

	CNSmlDmPcdata* iDefaultValue;					

	/**

	* Description property of the node, optional

	*/

	CNSmlDmPcdata* iDescription;	

	/**

	* Format property of the node

	*/

	MSmlDmDDFObject::TDFFormat iDFFormat;		

	/**

	* Occurrence property of the node, optional

	*/

	MSmlDmDDFObject::TOccurence iOccurrence;

	/**

	* Scope property of the node, optional

	*/

	MSmlDmDDFObject::TScope iScope;	

	/**

	* Title property of the node, optional

	*/

	CNSmlDmPcdata* iDFTitle;

	/**

	* Type property of the node, optional

	*/

	CNSmlDmPcdata* iDFType;

    TBool iCaseSense;

public:

	/**

	* Desstructor

	*/

	~CNSmlDmDFProperties();

	/**

	* Constructor

	*/

	CNSmlDmDFProperties();

	/**

	* Generates xml of elelment

	* @param	aObject			Buffer to write xml

	*/

	void GenerateDFPropertiesL(CBufBase& aObject);

	/**

	* Generates wbxml of elelment

	* @param	aObject			Buffer to write xml

	*/

	void GenerateDFPropertiesWBXMLL(RWriteStream& aStream);

private:

	/**

	* Generates xml of elelment

	* @param	aObject			Buffer to write xml

	*/

	void GenerateDFPropsSubmethodL(CBufBase& aObject);

	};

// ===========================================================================

// CNSmlDmNode 

// ===========================================================================

/**

* CNSmlDmNode is node object in DDF structure

*

*  @since

*/

class CNSmlDmNode : public CBase, public MSmlDmDDFObject

	{

public:

	/**

	* Path of the node, optional

	*/

	CNSmlDmPcdata* iPath;

	/**

	* Run time properties of the node, optional

	*/

	CNSmlDmRTProperties* iRTProperties;

	/**

	* Description framework properties of the node

	*/

	CNSmlDmDFProperties iDFProperties;

	/**

	* Children of the node, optional

	* (if null -> leaf otherwise interior node)

	*/

	CNSmlDmNodeList* iNodeListPtr;

	/**

	* Default value of the node, optional

	*/

	CNSmlDmPcdata* iValue;

	/**

	* Name of the node

	*/

	CNSmlDmPcdata iNodeName;

	/**

	* True if node is static level, i.e. before firs nameless level

	*/

	TBool iStaticLevel;

	/**

	* Implementation uid of adapter which handles the current node

	*/

	TUint32 iImplUid;

	/**

	* Host server id which handles adapter

	*/

	TUint8 iHostServerId;

public:

	/**

	* Constructor

	*/

	CNSmlDmNode();

	/**

	* Desstructor

	*/

	virtual ~CNSmlDmNode();

	/**

	* Sets access types to node

	* @param	aAccessTypes		Access types

	*/

	void SetAccessTypesL( TSmlDmAccessTypes aAccessTypes );

	/**

	* Sets default value to node

	* @param	aDefaultValue		Default value

	*/

	void SetDefaultValueL( const TDesC8& aDefaultValue ); 

	/**

	* Sets description to node

	* @param	aDescription		Description

	*/

	void SetDescriptionL( const TDesC8& aDescription );

	/**

	* Sets format of the node

	* @param	aFormat				Format