// Copyright (c) 2006-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:

//

/**

 @file

 @publishedPartner

*/

#include <mtp/cmtptypeobjectpropdesc.h>

#include <mtp/mtpdatatypeconstants.h>

#include <mtp/mtpprotocolconstants.h>

#include <mtp/cmtptypeserviceobjpropextnform.h>

#include <mtp/cmtptypeservicemethodparamextnform.h>

#include "mtpdatatypespanic.h"

// Dataset constants

const TUint CMTPTypeObjectPropDesc::KFlat1ChunkSize(5);

const TUint CMTPTypeObjectPropDesc::KFlat2ChunkSize(5);

const TUint CMTPTypeObjectPropDesc::KNumChunksWithoutForm(EIdFlat2Chunk + 1);

const TUint CMTPTypeObjectPropDesc::KNumChunksWithForm(EIdFormChunk + 1);

const TUint CMTPTypeObjectPropDescEnumerationForm::KNumberOfValuesChunk(0);

const TUint CMTPTypeObjectPropDescEnumerationForm::KValueChunks(1);

// Dataset element metadata    

const CMTPTypeCompoundBase::TElementInfo CMTPTypeObjectPropDesc::iElementMetaData[CMTPTypeObjectPropDesc::ENumElements] = 

    {

        {EIdFlat1Chunk,         EMTPTypeFlat,       {EMTPTypeUINT16,    0,                  KMTPTypeUINT16Size}},   // EPropertyCode

        {EIdFlat1Chunk,         EMTPTypeFlat,       {EMTPTypeUINT16,    2,                  KMTPTypeUINT16Size}},   // EDatatype

        {EIdFlat1Chunk,         EMTPTypeFlat,       {EMTPTypeUINT8,     4,                  KMTPTypeUINT8Size}},    // EGetSet

        {EIdDefaultValueChunk,  EMTPTypeReference,  {EMTPTypeUndefined, KMTPNotApplicable,  KMTPNotApplicable}},    // EDefaultValue

        {EIdFlat2Chunk,         EMTPTypeFlat,       {EMTPTypeUINT32,    0,                  KMTPTypeUINT32Size}},   // EGroupCode

        {EIdFlat2Chunk,         EMTPTypeFlat,       {EMTPTypeUINT8,     4,                  KMTPTypeUINT8Size}},    // EFormFlag

        {EIdFormChunk,          EMTPTypeReference,  {EMTPTypeUndefined, KMTPNotApplicable,  KMTPNotApplicable}},    // EForm

    };

EXPORT_C CMTPTypeObjectPropDesc* CMTPTypeObjectPropDesc::NewL()

    {

    CMTPTypeObjectPropDesc* self = NewLC();

    CleanupStack::Pop(self);

    return self;    

    }

/**

MTP ObjectPropDesc dataset factory method. This method is used to create an 

empty MTP ObjectPropDesc dataset type with the default Datatype and Form Flag 

defined for the specified PropertyCode. 

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the ObjectPropDesc dataset.

@return A pointer to the MTP ObjectPropDesc dataset type. Ownership IS 

transfered.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeObjectPropDesc* CMTPTypeObjectPropDesc::NewL(TUint16 aPropertyCode)

    {

    CMTPTypeObjectPropDesc* self = NewLC(aPropertyCode);

    CleanupStack::Pop(self);

    return self;    

    }

/**

MTP ObjectPropDesc dataset factory method. This method is used to create an 

empty MTP ObjectPropDesc dataset type with the default Datatype and Form Flag 

defined for the specified PropertyCode. A pointer to the data type is placed on

the cleanup stack.

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the ObjectPropDesc dataset.

@return A pointer to the MTP ObjectPropDesc dataset type. Ownership IS 

transfered.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeObjectPropDesc* CMTPTypeObjectPropDesc::NewLC(TUint16 aPropertyCode)

    {    

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

    CleanupStack::PushL(self); 

    self->ConstructL(aPropertyCode, NULL);

    return self;    

    }

/**

MTP ObjectPropDesc dataset factory method. This method is used to create an 

MTP ObjectPropDesc dataset type with the default Datatype and Form Flag 

defined for the specified PropertyCode, and the specified FORM. 

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the ObjectPropDesc dataset.

@param aForm The optional ObjectPropDesc FORM dataset.

@return A pointer to the MTP ObjectPropDesc dataset type. Ownership IS 

transfered.

@leave KMTPDataTypeInvalid, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeObjectPropDesc* CMTPTypeObjectPropDesc::NewL(TUint16 aPropertyCode, const MMTPType& aForm)

    {

    CMTPTypeObjectPropDesc* self = NewLC(aPropertyCode, aForm);

    CleanupStack::Pop(self);

    return self;    

    }

/**

MTP ObjectPropDesc dataset factory method. This method is used to create an 

MTP ObjectPropDesc dataset type with the default Datatype and Form Flag 

defined for the specified PropertyCode, and the specified FORM. A pointer 

to the data type is placed on the cleanup stack.

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the ObjectPropDesc dataset.

@param aForm The optional ObjectPropDesc FORM dataset.

@return A pointer to the MTP ObjectPropDesc dataset type. Ownership IS 

transfered.

@leave KMTPDataTypeInvalid, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeObjectPropDesc* CMTPTypeObjectPropDesc::NewLC(TUint16 aPropertyCode, const MMTPType& aForm)

    {    

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

    CleanupStack::PushL(self); 

    self->ConstructL(aPropertyCode, &aForm);

    return self;    

    }

/**

MTP ObjectPropDesc dataset factory method. This method is used to create an 

MTP ObjectPropDesc dataset type with the default Datatype defined for the 

specified PropertyCode, and the specified Form Flag and FORM.  

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the ObjectPropDesc dataset.

@param aFormFlag The required Form Flag of the ObjectPropDesc.

@param aForm The optional ObjectPropDesc FORM dataset.

@return A pointer to the MTP ObjectPropDesc dataset type. Ownership IS 

transfered.

@leave KMTPDataTypeInvalid, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeObjectPropDesc* CMTPTypeObjectPropDesc::NewL(TUint16 aPropertyCode, TUint8 aFormFlag, const MMTPType* aForm)

    {

    CMTPTypeObjectPropDesc* self = NewLC(aPropertyCode, aFormFlag, aForm);

    CleanupStack::Pop(self);

    return self;    

    }

/**

MTP ObjectPropDesc dataset factory method. This method is used to create an 

MTP ObjectPropDesc dataset type with the default Datatype defined for the 

specified PropertyCode, and the specified Form Flag and FORM. A pointer 

to the data type is placed on the cleanup stack.

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the ObjectPropDesc dataset.

@param aFormFlag The required Form Flag of the ObjectPropDesc.

@param aForm The optional ObjectPropDesc FORM dataset.

@return A pointer to the MTP ObjectPropDesc dataset type. Ownership IS 

transfered.

@leave KMTPDataTypeInvalid, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeObjectPropDesc* CMTPTypeObjectPropDesc::NewLC(TUint16 aPropertyCode, TUint8 aFormFlag, const MMTPType* aForm)

    {

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

    CleanupStack::PushL(self); 

    TPropertyInfo info;

    PropertyInfoL(aPropertyCode, info);

    info.iFormFlag = aFormFlag;

    self->ConstructL(aPropertyCode, info, aForm);

    return self;    

    }

/**

MTP ObjectPropDesc dataset factory method. This method is used to create an  

MTP ObjectPropDesc dataset type with the specified values.

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the ObjectPropDesc dataset.

@param aInfo The MTP ObjectPropDesc dataset characteristics (meta data).

@param aForm The optional ObjectPropDesc FORM dataset.

@return A pointer to the MTP ObjectPropDesc dataset type. Ownership IS 

transfered.

@leave KMTPDataTypeInvalid, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/    

EXPORT_C CMTPTypeObjectPropDesc* CMTPTypeObjectPropDesc::NewL(TUint16 aPropertyCode, const TPropertyInfo& aInfo, const MMTPType* aForm)

    {

    CMTPTypeObjectPropDesc* self = CMTPTypeObjectPropDesc::NewLC(aPropertyCode, aInfo, aForm); 

    CleanupStack::Pop(self);

    return self; 

    }

/**

MTP ObjectPropDesc dataset factory method. This method is used to create an  

MTP ObjectPropDesc dataset type with the specified values. A pointer to the 

data type is placed on the cleanup stack.

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the ObjectPropDesc dataset.

@param aInfo The MTP ObjectPropDesc dataset characteristics (meta data).

@param aForm The optional ObjectPropDesc FORM dataset.

@return A pointer to the MTP ObjectPropDesc dataset type. Ownership IS 

transfered.

@leave KMTPDataTypeInvalid, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeObjectPropDesc* CMTPTypeObjectPropDesc::NewLC(TUint16 aPropertyCode, const TPropertyInfo& aInfo, const MMTPType* aForm)

    {

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

    CleanupStack::PushL(self); 

    self->ConstructL(aPropertyCode, aInfo, aForm);

    return self;    

    }

/**

Destructor.

*/

EXPORT_C CMTPTypeObjectPropDesc::~CMTPTypeObjectPropDesc()

    {

    iChunkFlat1.Close();

    iChunkDefaultValue.Close();

    iChunkFlat2.Close();

    iChunkForm.Close();

    }

EXPORT_C TInt CMTPTypeObjectPropDesc::FirstWriteChunk(TPtr8& aChunk)

    {  

    /* 

    Reset the type in preparation for the data stream, by deleting all

    except the first chunk.

    */

    for (TUint i(ChunkCount() - 1); (i >= (EIdFlat1Chunk + 1)); i--)

        {

        ChunkRemove(i);

        }

    // Setup the write chunk pointer.

    TInt err(UpdateWriteSequenceErr(CMTPTypeCompoundBase::FirstWriteChunk(aChunk)));

    switch (err)

        {

    case KMTPChunkSequenceCompletion:

        err = KErrNone;

        // Don't break, fall through to set the write sequence state.

    case KErrNone:

        // Set the write sequence state.

        iWriteSequenceState = EFlat1Chunk; 

        /* 

        Set the write sequence completion state. Initially assume that the 

        ObjectPropDesc has a FORM field. If no FORM field is subsequently

        detected in the write data stream then the completion state is 

        adjusted accordingly.

        */

        iWriteSequenceCompletionState = EFormChunk;

        break;

    default:

        break;

        }

    return  err;

    }

EXPORT_C TInt CMTPTypeObjectPropDesc::NextWriteChunk(TPtr8& aChunk)

    {

    TInt err(KMTPChunkSequenceCompletion);

    if (iWriteSequenceState != EIdle)

        {

        err = UpdateWriteSequenceErr(CMTPTypeCompoundBase::NextWriteChunk(aChunk));

        if ((iWriteSequenceErr == KMTPChunkSequenceCompletion) && (iWriteSequenceState != EIdle))

            {

            err = KErrNone;

            }   

        }    

    return err;

    }

EXPORT_C TUint CMTPTypeObjectPropDesc::Type() const

    {

    return EMTPTypeObjectPropDescDataset;

    }

EXPORT_C TBool CMTPTypeObjectPropDesc::CommitRequired() const

    {

    return ETrue;

    }

EXPORT_C MMTPType* CMTPTypeObjectPropDesc::CommitChunkL(TPtr8& aChunk)

    {

    if (iWriteSequenceErr == KMTPChunkSequenceCompletion)

        {

        switch (iWriteSequenceState)

            {

        case EFlat1Chunk:     

            /* 

            Datatype is available, allocate sufficient chunk storage for 

            and append the DefaultValue chunk.

            */

            iChunkDefaultValue.Close();

            iChunkDefaultValue.OpenL(Uint16L(EDatatype));

            ChunkAppendL(iChunkDefaultValue);

            break;

        case EDefaultValueChunk:

            // Append the next chunk.

            ChunkAppendL(iChunkFlat2);

            break;

        case EFlat2Chunk: 

            /* 

            FormFlag and Datatype are available, allocate sufficient storage for 

            and append the FORM chunk.

            */

            {

            iChunkForm.Close();

            TUint8 flag(Uint8L(EFormFlag));

            iChunkForm.SetMeta(flag, Uint16L(EDatatype));

            if (HasFormField(flag))

                {

                iChunkForm.OpenL(iElementInfo[EIdFormChunk].iType);

                ChunkAppendL(iChunkForm);

                SetExpectedChunkCount(KNumChunksWithForm);

                }

            else

                {

                // Adjust the write sequence completion state.            

                iWriteSequenceCompletionState = EFlat2Chunk;

                }   

            }

            break;

        case EFormChunk:

        case EIdle:

        default:

            break;

            }

    if ((iWriteSequenceState != EIdle ) && (iWriteSequenceState < iWriteSequenceCompletionState))

        {

        iWriteSequenceState++;

        }

    else

        {

        iWriteSequenceState = EIdle;

        }

    }

    if (CMTPTypeCompoundBase::CommitRequired())

        {

        CMTPTypeCompoundBase::CommitChunkL(aChunk);

        }

    return NULL;

    }

void CMTPTypeObjectPropDesc::PropertyInfoL(TUint16 aPropertyCode, TPropertyInfo& aInfo)

    {    

    switch (aPropertyCode)

        {        

    case EMTPObjectPropCodeUndefined:

        aInfo.iDataType     = EMTPTypeUndefined;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPObjectPropCodeStorageID:

        aInfo.iDataType     = EMTPTypeUINT32;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPObjectPropCodeObjectFormat:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPObjectPropCodeProtectionStatus:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPObjectPropCodeObjectSize:

        aInfo.iDataType     = EMTPTypeUINT64;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPObjectPropCodeAssociationType:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeAssociationDesc:

        aInfo.iDataType     = EMTPTypeUINT32;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeObjectFileName:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeDateCreated:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = EDateTimeForm;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeDateModified:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = EDateTimeForm;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeKeywords:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeParentObject:

        aInfo.iDataType     = EMTPTypeUINT32;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPObjectPropCodeAllowedFolderContents:

        aInfo.iDataType     = EMTPTypeAUINT16;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPObjectPropCodeHidden:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeSystemObject:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodePersistentUniqueObjectIdentifier:

        aInfo.iDataType     = EMTPTypeUINT128;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPObjectPropCodeSyncID:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodePropertyBag:

        aInfo.iDataType     = EMTPTypeAUINT16;

        aInfo.iFormFlag     = ELongStringForm;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeName:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeCreatedBy:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeArtist:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeDateAuthored:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = EDateTimeForm;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeDescription:

        aInfo.iDataType     = EMTPTypeAUINT16;

        aInfo.iFormFlag     = ELongStringForm;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeURLReference:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ERegularExpressionForm;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeLanguageLocale:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ERegularExpressionForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPObjectPropCodeCopyrightInformation:

        aInfo.iDataType     = EMTPTypeAUINT16;

        aInfo.iFormFlag     = ELongStringForm;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeSource:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadWrite;

        break;

    case EMTPObjectPropCodeOriginLocation:

        aInfo.iDataType     = EMTPTypeString;