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

// This file define the classes for the different PDU elements

// 

//

/**

 @file

 @publishedAll

*/

#ifndef __GSMUELEM_H__

#define __GSMUELEM_H__

// Includes

#include <e32std.h>

#include <e32base.h>

#include <charconv.h>

#include <gsmunmspacemobph.h>

class RFs;

class RReadStream;

class RWriteStream;

class CSmsEMSBufferSegmenter;

struct TEncodeParams;

// class declarations

/**

 *  Decoding error.

 *  @publishedAll

 *  @released 

 */

const TInt KErrGsmuDecoding = KErrCorrupt;

/**

 *  Thin wrapper over TLex8 to provide leaving functions when getting the next

 *  character(s).

 *  

 *  These functions leave with KErrGsmuDecoding if there are insufficient characters

 *  remaining.

 *  @publishedAll

 *  @released

 */

class TGsmuLex8 : public TLex8

	{

	public:

		TGsmuLex8(const TDesC8& aSource);

		TUint8 GetL();

		void IncL(TInt aNumber = 1);

		TPtrC8 NextWithNoIncL(TInt aLength) const;

		TPtrC8 NextWithNoIncL(TInt aLength, TBool aAcceptTruncation) const;		

		TPtrC8 NextAndIncL(TInt aLength);

	private:

		inline void LeaveL() const;

	};

/**

 *  Base class for performing all operations on octets.

 *  @publishedAll

 *  @released 

 */

class TSmsOctet

	{

public:

	inline TSmsOctet(TInt aValue);

	inline TSmsOctet(TUint8 aValue = 0);

	inline operator TInt() const;

	const TSmsOctet& operator = (TInt aValue);

	inline void FillSemiOctets(TInt aNum);

	inline TInt SemiOctetsToNum() const;

	TUint8* EncodeL(TUint8* aPtr) const;

	inline void DecodeL(TGsmuLex8& aPdu);

	inline void InternalizeL(RReadStream& aStream);

	inline void ExternalizeL(RWriteStream& aStream) const;

protected:

	/** Octet value. */

	TUint8 iValue;

	};

/**

 *  Bit masks for key first octet of an SMS PDU

 *  @publishedAll

 *  @released

 */

class TSmsFirstOctet : public TSmsOctet

	{

public:

/** TP-MTI (Message Type Indicator) First octet of all SMS PDUs. */

	enum TSmsMTI

		{

	/** SMS-DELIVER or SMS-DELIVER-REPORT message. */

		ESmsMTIDeliverOrDeliverReport=0x00,

	/** SMS-SUBMIT or SMS-SUBMIT-REPORT message. */

		ESmsMTISubmitOrSubmitReport=0x01,

	/** SMS-STATUS or SMS-COMMAND message. */

		ESmsMTIStatusReportOrCommand=0x02,

	/** Mask for these bit flags. */

		ESmsMTIMask=0x03

		};

/**

 *  TP-UDHI (User Data Header Indicator) Found in first octet of

 *  Submit and Deliver and possibly, Deliver Report and Status Report. 

 */

	enum TSmsUDHI

		{

	/** User data header indicator not present. */

		ESmsUDHIHeaderNotPresent=0x00,

	/** User data header indicator present. */

		ESmsUDHIHeaderPresent=0x40,

	/** Mask for these bit flags. */

		ESmsUDHIMask=0x40

		};

/** TP-RP (Reply Path) Found in first octet of Submit and Deliver. */

	enum TSmsReplyPath

		{

	/** Reply path does not exist. */

		ESmsReplyPathNone=0x00,

	/** Reply path exists. */

		ESmsReplyPathExists=0x080,

	/** Mask for these bit flags. */

		ESmsReplyPathMask=0x80

		};

/** TP-MMS (More Messages To Send) Found in Deliver and Status Report. */

	enum TSmsMoreMessagesToSend

		{

	/** More messages to send. */

		ESmsMoreMessagesToSend=0x00,

	/** No more messages to send. */

		ESmsNoMoreMessagesToSend=0x04,

	/** Mask for these bit flags. */

		ESmsMoreMessagesToSendMask=0x04,

		};

/** T-SRI (Status Report Indicator) Found in Status Report. */

	enum TSmsStatusReportIndicator

		{

	/** Status report is not going to be returned. */

		ESmsStatusReportNotReturned=0x00,

	/** Status report is going to be returned. */

		ESmsStatusReportReturned=0x20,

	/** Mask for these bit flags. */

		ESmsStatusReportIndicatorMask=0x20

		};

/** TP-RD bit flags. */

	enum TSmsRejectDuplicates

		/**

		 *  T-RD (Reject Duplicates) Found in Submit

		 */

		{

	/** Accept duplicates. */

		ESmsAcceptDuplicates=0x00,

	/** Reject duplicates. */

		ESmsRejectDuplicates=0x04,

	/** Mask for these bit flags. */

		ESmsRejectDuplicatesMask=0x04

		};

/** T-SRQ (Status Report Qualifier). Found in Status Report. */

	enum TSmsStatusReportQualifier

		{

	/** Status report result of submit. */

		ESmsStatusReportResultOfSubmit=0x00,

	/** Status report result of command. */

		ESmsStatusReportResultOfCommand=0x20,

	/** Mask for these bit flags. */

		ESmsStatusReportQualifierMask=0x20

		};

/** TP-VPF (Validity Period Format). Found in Submit. */

	enum TSmsValidityPeriodFormat

		{

	/** TP-VP field not present. */

		ESmsVPFNone=0x00,

	/** TP-VP field present. Enhanced format (7 octets). */

		ESmsVPFEnhanced=0x08,	// was ESmsVPFReserved, the new GSM spec!

	/** TP-VP field present, relative validity format. */

		ESmsVPFInteger=0x10,    // relative validity period

	/** TP-VP field present, absolute validity format. */

		ESmsVPFSemiOctet=0x18,  // absolute validity period

	/** Mask for these bit flags. */

		ESmsVPFMask=0x18

		};

/** TP-SRR (Status Report Request) Found in Submit and Command. */

	enum TSmsStatusReportRequest

		{

	/** Status report is not requested. */

		ESmsStatusReportNotRequested=0x00,

	/** Status report is requested. */

		ESmsStatusReportRequested=0x20,

	/** Mask for these bit flags. */

		ESmsStatusReportRequestMask=0x20

		};

public:

	TSmsFirstOctet(TInt aValue=0);

	const TSmsFirstOctet& operator = (TInt aValue);  //  Review

	};

/**

 *  TP-FCS (Failure Cause) octet. For Deliver and Submit errors

 *  @publishedAll

 *  @released

 */

class TSmsFailureCause : public TSmsOctet

	{

public:

/** TP-FCS flags. */

	enum TSmsFailureCauseError

		{

//  Reserved values

//		....

//		....

//  PID errors

	/** Telematic interworking not supported. */

		ESmsPIDErrorTelematicInterworkingNotSupported=0x80,

	/** Short message Type 0 not supported. */

		ESmsPIDErrorShortMessageType0NotSupported=0x81,

	/** Cannot replace short message. */

		ESmsPIDErrorCannotReplaceShortMessage=0x82,

	/** Reserved. */

		ESmsPIDErrorReserved1=0x83,

	/** Reserved. */

		ESmsPIDErrorReserved2=0x84,

	/** Reserved. */

		ESmsPIDErrorReserved3=0x85,

	/** Reserved. */

		ESmsPIDErrorReserved4=0x86,

	/** Reserved. */

		ESmsPIDErrorReserved5=0x87,

	/** Reserved. */

		ESmsPIDErrorReserved6=0x88,

	/** Reserved. */

		ESmsPIDErrorReserved7=0x89,

	/** Reserved. */

		ESmsPIDErrorReserved8=0x8A,

	/** Reserved. */

		ESmsPIDErrorReserved9=0x8B,

	/** Reserved. */

		ESmsPIDErrorReserved10=0x8C,

	/** Reserved. */

		ESmsPIDErrorReserved11=0x8D,

	/** Reserved. */

		ESmsPIDErrorReserved12=0x8E,

	/** Unspecified TP-PID error. */

		ESmsPIDErrorUnspecified=0x8F,

//  DCS errors

	/** Data coding scheme (alphabet) not supported. */

		ESmsDCSErrorAlphabetNotSupported=0x90,

	/** Message class not supported. */

		ESmsDCSErrorMessageClassNotSupported=0x91,

	/** Reserved. */

		ESmsDCSErrorReserved1=0x92,

	/** Reserved. */

		ESmsDCSErrorReserved2=0x93,

	/** Reserved. */

		ESmsDCSErrorReserved3=0x94,

	/** Reserved. */

		ESmsDCSErrorReserved4=0x95,

	/** Reserved. */

		ESmsDCSErrorReserved5=0x96,

	/** Reserved. */

		ESmsDCSErrorReserved6=0x97,

	/** Reserved. */

		ESmsDCSErrorReserved7=0x98,

	/** Reserved. */

		ESmsDCSErrorReserved8=0x99,

	/** Reserved. */

		ESmsDCSErrorReserved9=0x9A,

	/** Reserved. */

		ESmsDCSErrorReserved10=0x9B,

	/** Reserved. */

		ESmsDCSErrorReserved11=0x9C,

	/** Reserved. */

		ESmsDCSErrorReserved12=0x9D,

	/** Reserved. */

		ESmsDCSErrorReserved13=0x9E,

	/** Reserved. */

		ESmsDCSErrorUnspecified=0x9F,

//  CommandErrors

	/** Command cannot be actioned. */

		ESmsCommandErrorCannotBeActioned=0xA0,

	/** Command unsupported. */

		ESmsCommandErrorUnsupported=0xA1,

	/** Reserved. */

		ESmsCommandErrorReserved1=0xA2,

	/** Reserved. */

		ESmsCommandErrorReserved2=0xA3,

	/** Reserved. */

		ESmsCommandErrorReserved3=0xA4,

	/** Reserved. */

		ESmsCommandErrorReserved4=0xA5,

	/** Reserved. */

		ESmsCommandErrorReserved5=0xA6,

	/** Reserved. */

		ESmsCommandErrorReserved6=0xA7,

	/** Reserved. */

		ESmsCommandErrorReserved7=0xA8,

	/** Reserved. */

		ESmsCommandErrorReserved8=0xA9,

	/** Reserved. */

		ESmsCommandErrorReserved9=0xAA,

	/** Reserved. */

		ESmsCommandErrorReserved10=0xAB,

	/** Reserved. */

		ESmsCommandErrorReserved11=0xAC,

	/** Reserved. */

		ESmsCommandErrorReserved12=0xAD,

	/** Reserved. */

		ESmsCommandErrorReserved13=0xAE,

	/** Unspecified TP-Command error. */

		ESmsCommandErrorUnspecified=0xAF,

//

	/** PDU not supported. */

		ESmsErrorPDUNotSupported=0xB0,

//  Reserved values

//		....

//		....

	/** SC busy. */

		ESmsErrorSCBusy=0xC0,

	/** No SC subscription. */

		ESmsErrorNoSCSubscription=0xC1,

	/** SC system failure. */

		ESmsErrorNoSCSystemFailure=0xC2,

	/** Invalid SME address. */

		ESmsErrorInvalidSMEAddress=0xC3,

	/** Destination SME barred. */

		ESmsErrorDestinationSMEBarred=0xC4,

	/** SM Rejected-Duplicate SM. */

		ESmsErrorSMRejectedDuplicateSM=0xC5,

	/** TP-VPF not supported. */

		ESmsErrorVPFNotSupported=0xC6,

	/** TP-VP not supported. */

		ESmsErrorVPNotSupported=0xC7,

//  Reserved values

//		....

//		....

	/** SIM SMS storage full. */

		ESmsErrorSIMSMSStorageFull=0xD0,

	/** No SMS storage capability in (U)SIM. */

		ESmsErrorNoSMSStorageCapabilityOnSIM=0xD1,

	/** Error in MS. */

		ESmsErrorErrorInMS=0xD2,

	/** Memory Capacity Exceeded. */

		ESmsErrorMemoryCapacityExceded=0xD3,

	/** (U)SIM Application Toolkit Busy. */

		ESmsErrorSIMApplicationToolkitBusy=0xD4,

	/** (U)SIM data download error. */

		ESmsErrorSIMDataDownloadError=0xD5,

//  Reserved values

//		....

//		....

	/** Value specific to an application. */

		ESmsApplicationError1=0xE0,

	/** Value specific to an application. */

		ESmsApplicationError2=0xE1,

	/** Value specific to an application. */

		ESmsApplicationError3=0xE2,

	/** Value specific to an application. */

		ESmsApplicationError4=0xE3,

	/** Value specific to an application. */

		ESmsApplicationError5=0xE4,

	/** Value specific to an application. */

		ESmsApplicationError6=0xE5,

	/** Value specific to an application. */

		ESmsApplicationError7=0xE6,

	/** Value specific to an application. */

		ESmsApplicationError8=0xE7,

	/** Value specific to an application. */

		ESmsApplicationError9=0xE8,

	/** Value specific to an application. */

		ESmsApplicationError10=0xE9,

	/** Value specific to an application. */

		ESmsApplicationError11=0xEA,

	/** Value specific to an application. */

		ESmsApplicationError12=0xEB,

	/** Value specific to an application. */

		ESmsApplicationError13=0xEC,

	/** Value specific to an application. */

		ESmsApplicationError14=0xED,

	/** Value specific to an application. */

		ESmsApplicationError15=0xEE,

	/** Value specific to an application. */

		ESmsApplicationError16=0xEF,

	/** Value specific to an application. */

		ESmsApplicationError17=0xF0,

	/** Value specific to an application. */

		ESmsApplicationError18=0xF1,

	/** Value specific to an application. */

		ESmsApplicationError19=0xF2,

	/** Value specific to an application. */

		ESmsApplicationError20=0xF3,

	/** Value specific to an application. */

		ESmsApplicationError21=0xF4,

	/** Value specific to an application. */

		ESmsApplicationError22=0xF5,

	/** Value specific to an application. */

		ESmsApplicationError23=0xF6,

	/** Value specific to an application. */

		ESmsApplicationError24=0xF7,

	/** Value specific to an application. */

		ESmsApplicationError25=0xF8,

	/** Value specific to an application. */

		ESmsApplicationError26=0xF9,

	/** Value specific to an application. */

		ESmsApplicationError27=0xFA,

	/** Value specific to an application. */

		ESmsApplicationError28=0xFB,

	/** Value specific to an application. */

		ESmsApplicationError29=0xFC,

	/** Value specific to an application. */

		ESmsApplicationError30=0xFD,

	/** Value specific to an application. */

		ESmsApplicationError31=0xFE,

//

	/** Unspecified error cause. */

		ESmsErrorUnspecified=0xFF,

	/**	@publishedAll	*/

		ESmsErrorFree=0x100

		};

public:

	TSmsFailureCause();

	inline TInt Error() const;

	inline void SetError(TSmsFailureCauseError aError);

	};

/**

 *  TP-ST (Status Report) octet. Found in Status Report

 *  @publishedAll

 *  @released

 */

class TSmsStatus : public TSmsOctet

	{

public:

/** TP-ST flag values. */

	enum TSmsStatusValue

		{

//  Short message transaction completed

	/** Short message received by the SME. */

		ESmsShortMessageReceivedBySME=0x00,

	/**

	 *  Short message forwarded by the SC to the SME but the SC is unable to confirm

	 *  	delivery. 

	 */

		ESmsShortMessageForwardedBySCToSMEButUnconfirmedBySC=0x01,

	/** Short message replaced by the SC. */

		ESmsShortMessageReplacedBySC=0x02,

//  Reserved values

//		....

//		....

//  Temporary error, SC still trying to transfer SM

	/** Temporary error, SC still trying to transfer SM: congestion. */

		ESmsTempError1StatusCongestion=0x20,

	/** Temporary error, SC still trying to transfer SM: SME busy. */

		ESmsTempError1StatusSMEBusy=0x21,

	/** Temporary error, SC still trying to transfer SM: No response from SME. */

		ESmsTempError1StatusNoResponseFromSME=0x22,

	/** Temporary error, SC still trying to transfer SM: Service rejected. */

		ESmsTempError1StatusServiceRejected=0x23,

	/** Temporary error, SC still trying to transfer SM: Quality of service not available. */

		ESmsTempError1StatusQualityOfServiceNotAvailable=0x24,

	/** Temporary error, SC still trying to transfer SM: Error in SME. */

		ESmsTempError1StatusErrorInSME=0x25,

//  Reserved values

//		....

//		....

//  Permanent error, SC is not making any more transfer attempts

	/**

	 *  Permanent error, SC is not making any more transfer attempts: Remote procedure

	 *  	error. 

	 */

		ESmsPermErrorRemoteProcedureError=0x40,

	/**

	 *  Permanent error, SC is not making any more transfer attempts: Incompatible

	 *  	destination. 

	 */

		ESmsPermErrorIncompatibleDestination=0x41,

	/**

	 *  Permanent error, SC is not making any more transfer attempts: Connection rejected

	 *  	by SME. 

	 */

		ESmsPermErrorConnectionRejectedBySME=0x42,

	/** Permanent error, SC is not making any more transfer attempts: Not obtainable. */

		ESmsPermErrorNotObtainable=0x43,

	/**

	 *  Permanent error, SC is not making any more transfer attempts: Quality of service

	 *  	not available. 

	 */

		ESmsPermErrorQualityOfServiceNotAvailable2=0x44,

	/**

	 *  Permanent error, SC is not making any more transfer attempts: No interworking

	 *  	available. 

	 */

		ESmsPermErrorNoInterworkingAvailable=0x45,