sl@0: // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: 
sl@0: #include <assert.h>
sl@0: #include <memory.h>
sl@0: #include <pcstore/checkeduid.h>
sl@0: #include <pcstore/descriptors.h>
sl@0: #include <pcstore/storeexception.h>
sl@0: #include "pcstoreconst.h"
sl@0: 
sl@0: namespace PCStore
sl@0: {
sl@0: const TUint crcTab[256] =
sl@0: 	{
sl@0: 	0x0000,0x1021,0x2042,0x3063,0x4084,0x50a5,0x60c6,0x70e7,0x8108,0x9129,0xa14a,
sl@0: 	0xb16b,0xc18c,0xd1ad,0xe1ce,0xf1ef,0x1231,0x0210,0x3273,0x2252,0x52b5,0x4294,
sl@0: 	0x72f7,0x62d6,0x9339,0x8318,0xb37b,0xa35a,0xd3bd,0xc39c,0xf3ff,0xe3de,0x2462,
sl@0: 	0x3443,0x0420,0x1401,0x64e6,0x74c7,0x44a4,0x5485,0xa56a,0xb54b,0x8528,0x9509,
sl@0: 	0xe5ee,0xf5cf,0xc5ac,0xd58d,0x3653,0x2672,0x1611,0x0630,0x76d7,0x66f6,0x5695,
sl@0: 	0x46b4,0xb75b,0xa77a,0x9719,0x8738,0xf7df,0xe7fe,0xd79d,0xc7bc,0x48c4,0x58e5,
sl@0: 	0x6886,0x78a7,0x0840,0x1861,0x2802,0x3823,0xc9cc,0xd9ed,0xe98e,0xf9af,0x8948,
sl@0: 	0x9969,0xa90a,0xb92b,0x5af5,0x4ad4,0x7ab7,0x6a96,0x1a71,0x0a50,0x3a33,0x2a12,
sl@0: 	0xdbfd,0xcbdc,0xfbbf,0xeb9e,0x9b79,0x8b58,0xbb3b,0xab1a,0x6ca6,0x7c87,0x4ce4,
sl@0: 	0x5cc5,0x2c22,0x3c03,0x0c60,0x1c41,0xedae,0xfd8f,0xcdec,0xddcd,0xad2a,0xbd0b,
sl@0: 	0x8d68,0x9d49,0x7e97,0x6eb6,0x5ed5,0x4ef4,0x3e13,0x2e32,0x1e51,0x0e70,0xff9f,
sl@0: 	0xefbe,0xdfdd,0xcffc,0xbf1b,0xaf3a,0x9f59,0x8f78,0x9188,0x81a9,0xb1ca,0xa1eb,
sl@0: 	0xd10c,0xc12d,0xf14e,0xe16f,0x1080,0x00a1,0x30c2,0x20e3,0x5004,0x4025,0x7046,
sl@0: 	0x6067,0x83b9,0x9398,0xa3fb,0xb3da,0xc33d,0xd31c,0xe37f,0xf35e,0x02b1,0x1290,
sl@0: 	0x22f3,0x32d2,0x4235,0x5214,0x6277,0x7256,0xb5ea,0xa5cb,0x95a8,0x8589,0xf56e,
sl@0: 	0xe54f,0xd52c,0xc50d,0x34e2,0x24c3,0x14a0,0x0481,0x7466,0x6447,0x5424,0x4405,
sl@0: 	0xa7db,0xb7fa,0x8799,0x97b8,0xe75f,0xf77e,0xc71d,0xd73c,0x26d3,0x36f2,0x0691,
sl@0: 	0x16b0,0x6657,0x7676,0x4615,0x5634,0xd94c,0xc96d,0xf90e,0xe92f,0x99c8,0x89e9,
sl@0: 	0xb98a,0xa9ab,0x5844,0x4865,0x7806,0x6827,0x18c0,0x08e1,0x3882,0x28a3,0xcb7d,
sl@0: 	0xdb5c,0xeb3f,0xfb1e,0x8bf9,0x9bd8,0xabbb,0xbb9a,0x4a75,0x5a54,0x6a37,0x7a16,
sl@0: 	0x0af1,0x1ad0,0x2ab3,0x3a92,0xfd2e,0xed0f,0xdd6c,0xcd4d,0xbdaa,0xad8b,0x9de8,
sl@0: 	0x8dc9,0x7c26,0x6c07,0x5c64,0x4c45,0x3ca2,0x2c83,0x1ce0,0x0cc1,0xef1f,0xff3e,
sl@0: 	0xcf5d,0xdf7c,0xaf9b,0xbfba,0x8fd9,0x9ff8,0x6e17,0x7e36,0x4e55,0x5e74,0x2e93,
sl@0: 	0x3eb2,0x0ed1,0x1ef0
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: Performs a CCITT CRC checksum on the specified data.
sl@0: 
sl@0: On return from this function, the referenced 16 bit integer contains the checksum.
sl@0: 
sl@0: @param aCrc    A reference to a 16 bit integer to contain the checksum.
sl@0: @param aPtr    A pointer to the start of the data to be checksum.
sl@0: @param aLength The length of the data to be checksum.
sl@0: */
sl@0: void Crc(TUint16& aCrc,const void* aPtr,TInt aLength)
sl@0: 	{
sl@0: 	const TUint8* pB=static_cast<const TUint8*>(aPtr);
sl@0: 	const TUint8* pE=pB+aLength;
sl@0: 	TUint crc=aCrc;
sl@0: 	while (pB<pE)
sl@0: 		{
sl@0: 		crc=(crc<<8)^crcTab[((crc>>8)^*pB++)&0xff];
sl@0: 		}
sl@0: 	aCrc=(TUint16)crc;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Generate a checksum for the object of TCheckedUid.
sl@0: 
sl@0: @param aPtr The pointer to the TCheckedUid.
sl@0: @return The resulted checksum for the TCheckedUid.
sl@0: */
sl@0: TUint checkSum(const void *aPtr)
sl@0: 	{
sl@0: 	const TUint8* pB=static_cast<const TUint8*>(aPtr);
sl@0: 	const TUint8* pE=pB+(KMaxCheckedUid*sizeof(TUid));
sl@0: 	TUint8 buf[(KMaxCheckedUid*sizeof(TUid))>>1];
sl@0: 	TUint8* pT=(&buf[0]);
sl@0: 	while (pB<pE)
sl@0: 		{
sl@0: 		*pT++=(*pB);
sl@0: 		pB+=2;
sl@0: 		}
sl@0: 	TUint16 crc=0;
sl@0: 	Crc(crc,&buf[0],(KMaxCheckedUid*sizeof(TUid))>>1);
sl@0: 	return(crc);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Constructor that creates a zero-valued UID type.
sl@0: */
sl@0: TUidType::TUidType()
sl@0: 	{
sl@0: 	memset(this,0,sizeof(TUidType));
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Constructor that creates a UID type and sets the UID1 component
sl@0: to the specified value.
sl@0: 
sl@0: The UID2 and UID3 components are set to KNullUid.
sl@0: 
sl@0: @param aUid1 Value for UID1.
sl@0: */
sl@0: TUidType::TUidType(TUid aUid1)
sl@0: 	{
sl@0: 	memset(this,0,sizeof(TUidType));
sl@0: 	iUid[0]=aUid1;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Constructor that creates a UID type and sets the UID1 and UID2 components
sl@0: to the specified values. 
sl@0: 
sl@0: The UID3 component is set to KNullUid.
sl@0: 
sl@0: @param aUid1 Value for UID1. 
sl@0: @param aUid2 Value for UID2.
sl@0: */
sl@0: TUidType::TUidType(TUid aUid1, TUid aUid2)
sl@0: 	{
sl@0: 	iUid[0]=aUid1;
sl@0: 	iUid[1]=aUid2;
sl@0: 	iUid[2]=KNullUid;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Constructor that creates a UID type and sets all three UID components
sl@0: to the specified values.
sl@0: 
sl@0: @param aUid1 Value for UID1.
sl@0: @param aUid2 Value for UID2.
sl@0: @param aUid3 Value for UID3.
sl@0: */
sl@0: TUidType::TUidType(TUid aUid1, TUid aUid2, TUid aUid3)
sl@0: 	{
sl@0: 	iUid[0]=aUid1;
sl@0: 	iUid[1]=aUid2;
sl@0: 	iUid[2]=aUid3;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** 
sl@0: Compares this UID type for inequality with the specified UID type.
sl@0: 
sl@0: @param aUidType The UID type to be compared.
sl@0: @return TRUE, if any component UID is not equal to the corresponding component 
sl@0: UID in the specified UID type; FALSE otherwise.
sl@0: */
sl@0: TBool TUidType::operator !=(const TUidType& aUidType) const
sl@0: 	{
sl@0: 	return(!(*this==aUidType));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Compares this UID type for equality with the specified UID type.
sl@0: 
sl@0: @param aUidType The reference to the UID type to be compared. 
sl@0: @return TRUE, if each component UID is equal to the corresponding component 
sl@0: UID in the specified UID type; FALSE, otherwise.
sl@0: */
sl@0: TBool TUidType::operator ==(const TUidType& aUidType) const 
sl@0: 	{
sl@0: 	return(iUid[0]==aUidType.iUid[0] &&
sl@0: 		iUid[1]==aUidType.iUid[1] &&
sl@0: 		iUid[2]==aUidType.iUid[2]);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Gets the most derived UID.
sl@0: 
sl@0: Taking the three UID components as a hierarchy with UID1 being the most general, 
sl@0: UID2 being more specific than UID1 and UID3 being more specific than UID2, 
sl@0: then the function returns:
sl@0: 
sl@0: UID3, if UID3 is not KNullUid.
sl@0: UID2, if UID2 is not KNullUid.
sl@0: UID1, otherwise
sl@0: 
sl@0: @return The most derived UID.
sl@0: */
sl@0: TUid TUidType::MostDerived() const
sl@0: 	{
sl@0: 	if (iUid[2]!=KNullUid) 
sl@0: 		{
sl@0: 		return(iUid[2]);
sl@0: 		}
sl@0: 	if (iUid[1]!=KNullUid) 
sl@0: 		{
sl@0: 		return(iUid[1]);
sl@0: 		}
sl@0: 	return(iUid[0]);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Gets the UID component as identified by the specified index.
sl@0: 
sl@0: @param aIndex Index value indicating which UID component to return.
sl@0: 	0 specifies UID1,
sl@0: 	1 specifies UID2,
sl@0: 	2 specifies UID3.
sl@0: 
sl@0: aIndex must be between 0 and 2.
sl@0: 
sl@0: @return The reference to the required UID component.
sl@0: */
sl@0: const TUid& TUidType::operator[](TInt aIndex) const
sl@0: 	{
sl@0: 	assert(aIndex >= 0 && aIndex <= 2);
sl@0: 	return(iUid[aIndex]);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Tests the object for a valid (non-KNullUid) UID type.
sl@0: 
sl@0: @return TRUE, if at least one of the component UIDs is not KNullUid; FALSE, 
sl@0: if all component UIDs are KNullUid.
sl@0: */
sl@0: TBool TUidType::IsValid() const 
sl@0: 	{
sl@0: 	 return(MostDerived()!=KNullUid);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Default constructor.
sl@0: 
sl@0: Initialises the object to binary zeroes.
sl@0: */
sl@0: TCheckedUid::TCheckedUid()
sl@0: 	{
sl@0: 	memset(this,0, sizeof(TCheckedUid));
sl@0: 	} 
sl@0: 
sl@0: 
sl@0: /**
sl@0: Constructor taking an existing Uid type.
sl@0: 
sl@0: The constructor calculates a checksum.
sl@0: 
sl@0: @param aUidType The reference to a Uid type to be packaged.
sl@0: */
sl@0: TCheckedUid::TCheckedUid(const TUidType& aUidType) 
sl@0: 	{
sl@0: 	Set(aUidType);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Constructor taking an existing TCheckedUid object encapsulated within
sl@0: a descriptor.
sl@0: 
sl@0: The checksum is recalculated and must match the checksum value passed in the 
sl@0: encapsulated TCheckedUid object, otherwise the content of this object is reset 
sl@0: to binary zeroes.
sl@0: 
sl@0: aDes should be an 8-bit descriptor which holds the contents of a TCheckedUid object.
sl@0: 
sl@0: @param aDes The reference to an 8-bit descriptor containing an existing TCheckedUid 
sl@0: object. 
sl@0: */
sl@0: TCheckedUid::TCheckedUid(const CDes8& aDes)
sl@0: 	{
sl@0: 	Set(aDes);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sets the specified Uid type to be packaged, and recalculates the checksum.
sl@0: 
sl@0: @param aUidType The reference to a Uid type to be set.
sl@0: */
sl@0: void TCheckedUid::Set(const TUidType& aUidType)
sl@0: 	{
sl@0: 	iType = aUidType;
sl@0: 	iCheck = Check();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sets an existing TCheckedUid object encapsulated within a descriptor.
sl@0: 
sl@0: The checksum is recalculated and must match the checksum value passed in the 
sl@0: encapsulated TCheckedUid object, otherwise the content of this object is reset 
sl@0: to binary zeroes.
sl@0: 
sl@0: aDes should be an 8-bit descriptor which holds the contents of a TCheckedUid object.
sl@0: 
sl@0: @param aDes The reference to a descriptor containing an existing TCheckedUid object.
sl@0: */
sl@0: void TCheckedUid::Set(const CDes8& aDes)
sl@0: 	{
sl@0: 	assert(aDes.Length() == sizeof(TCheckedUid));
sl@0: 	memcpy(this,aDes.Ptr(),sizeof(TCheckedUid));
sl@0: 	if (iCheck!=Check())
sl@0: 		{
sl@0: 		memset(this,0,sizeof(TCheckedUid));
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Gets a descriptor to represent this object's data.
sl@0: 
sl@0: @return The descriptor for this object's data. The descriptor's length
sl@0: is the same as the length of a TCheckedUid object.
sl@0: */
sl@0: CDes8 TCheckedUid::Des() const
sl@0: 	{
sl@0: 	return(CDes8 (reinterpret_cast<const TUint8*>(this),sizeof(TCheckedUid)));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Gets the Uid type contained in this object.
sl@0: 
sl@0: @return The Uid type.
sl@0: */
sl@0: const TUidType&  TCheckedUid::UidType() const
sl@0: 	{
sl@0: 	return(iType);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Calculates the checksum of the UIDs.
sl@0: 
sl@0: @return The checksum.
sl@0: */
sl@0: TUint TCheckedUid::Check() const
sl@0: 	{
sl@0: 	return((checkSum((reinterpret_cast<TUint8*>(const_cast<TCheckedUid*>(this)))+1)<<16)|checkSum(this));
sl@0: 	}
sl@0: }