sl@0: // Copyright (c) 1998-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: #if !defined(__S32STRM_H__) sl@0: #define __S32STRM_H__ sl@0: #if !defined(__E32BASE_H__) sl@0: #include sl@0: #endif sl@0: sl@0: /** The largest integer value which can be stored as a TCardinality type. */ sl@0: const TInt KMaxCardinality=0x1fffffff; sl@0: // sl@0: class MStreamBuf; sl@0: class RWriteStream; sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * The read stream interface. The process of internalising from a stream is sl@0: achieved through a reference to an object of this type. sl@0: sl@0: A store aware class defines an implements an InternalizeL() member function sl@0: which is used to internalise that object and takes a reference to an sl@0: RReadStream as the interface to the read stream. sl@0: */ sl@0: class RReadStream sl@0: { sl@0: public: sl@0: inline RReadStream(); sl@0: inline RReadStream(MStreamBuf* aSource); sl@0: inline MStreamBuf* Source(); sl@0: inline void Close(); sl@0: IMPORT_C void Release(); sl@0: // sl@0: IMPORT_C void PushL(); sl@0: inline void Pop(); sl@0: // sl@0: IMPORT_C void ReadL(TDes8& aDes); sl@0: IMPORT_C void ReadL(TDes8& aDes,TInt aLength); sl@0: IMPORT_C void ReadL(TDes8& aDes,TChar aDelim); sl@0: IMPORT_C void ReadL(TUint8* aPtr,TInt aLength); sl@0: IMPORT_C void ReadL(TInt aLength); sl@0: inline void ReadL(RWriteStream& aStream); sl@0: inline void ReadL(RWriteStream& aStream,TInt aLength); sl@0: // sl@0: IMPORT_C void ReadL(TDes16& aDes); sl@0: IMPORT_C void ReadL(TDes16& aDes,TInt aLength); sl@0: IMPORT_C void ReadL(TDes16& aDes,TChar aDelim); sl@0: IMPORT_C void ReadL(TUint16* aPtr,TInt aLength); sl@0: // sl@0: IMPORT_C TInt8 ReadInt8L(); sl@0: IMPORT_C TInt16 ReadInt16L(); sl@0: IMPORT_C TInt32 ReadInt32L(); sl@0: IMPORT_C TUint8 ReadUint8L(); sl@0: IMPORT_C TUint16 ReadUint16L(); sl@0: IMPORT_C TUint32 ReadUint32L(); sl@0: IMPORT_C TReal32 ReadReal32L() __SOFTFP; sl@0: IMPORT_C TReal64 ReadReal64L() __SOFTFP; sl@0: protected: sl@0: inline void Attach(MStreamBuf* aSource); sl@0: inline void Detach(); sl@0: private: sl@0: MStreamBuf* iSrc; sl@0: private: sl@0: friend class RWriteStream; sl@0: }; sl@0: template sl@0: class MExternalizer; sl@0: class TStreamRef; sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * The write stream interface. The process of externalising to a stream is sl@0: achieved through a reference to an object of this type. sl@0: sl@0: A store aware class defines and implements an ExternalizeL() member function sl@0: which is used to externalise that object and takes a reference to an sl@0: RWriteStream as the interface to the write stream. sl@0: */ sl@0: class RWriteStream sl@0: { sl@0: public: sl@0: inline RWriteStream(); sl@0: inline RWriteStream(const MExternalizer& anExter); sl@0: inline RWriteStream(MStreamBuf* aSink); sl@0: inline MStreamBuf* Sink(); sl@0: IMPORT_C void Close(); sl@0: IMPORT_C void Release(); sl@0: IMPORT_C void CommitL(); sl@0: // sl@0: IMPORT_C void PushL(); sl@0: inline void Pop(); sl@0: // sl@0: IMPORT_C void WriteL(const TDesC8& aDes); sl@0: IMPORT_C void WriteL(const TDesC8& aDes,TInt aLength); sl@0: IMPORT_C void WriteL(const TUint8* aPtr,TInt aLength); sl@0: IMPORT_C void WriteL(RReadStream& aStream); sl@0: IMPORT_C void WriteL(RReadStream& aStream,TInt aLength); sl@0: // sl@0: IMPORT_C void WriteL(const TDesC16& aDes); sl@0: IMPORT_C void WriteL(const TDesC16& aDes,TInt aLength); sl@0: IMPORT_C void WriteL(const TUint16* aPtr,TInt aLength); sl@0: // sl@0: IMPORT_C void WriteInt8L(TInt aValue); sl@0: IMPORT_C void WriteInt16L(TInt aValue); sl@0: IMPORT_C void WriteInt32L(TInt32 aValue); sl@0: IMPORT_C void WriteUint8L(TUint aValue); sl@0: IMPORT_C void WriteUint16L(TUint aValue); sl@0: IMPORT_C void WriteUint32L(TUint32 aValue); sl@0: IMPORT_C void WriteReal32L(TReal aValue) __SOFTFP; sl@0: IMPORT_C void WriteReal64L(TReal64 aValue) __SOFTFP; sl@0: protected: sl@0: inline void Attach(MStreamBuf* aSink); sl@0: inline void Detach(); sl@0: private: sl@0: IMPORT_C void WriteRefL(TStreamRef aRef); sl@0: private: sl@0: MStreamBuf* iSnk; sl@0: const MExternalizer* iExterL; sl@0: private: sl@0: friend class TStreamRef; sl@0: }; sl@0: // sl@0: template sl@0: inline RWriteStream& operator<<(RWriteStream& aStream,const T& anObject); sl@0: template sl@0: inline RReadStream& operator>>(RReadStream& aStream,T& anObject); sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * Compact stream format for positive integer values in the range 0 to sl@0: 536,870,911 ((2^29)-1). Values in the range 0-127 are stored in a single byte, sl@0: 128-16383 in two bytes and other values in 4 bytes. sl@0: sl@0: The class provides conversion to and from TInt, and both externalization and sl@0: internalization functions. It is used to significant effect within Symbian sl@0: code. sl@0: */ sl@0: class TCardinality sl@0: { sl@0: public: sl@0: TCardinality() {} sl@0: inline TCardinality(TInt aCount); sl@0: inline operator TInt() const; sl@0: // sl@0: IMPORT_C void ExternalizeL(RWriteStream& aStream) const; sl@0: IMPORT_C void InternalizeL(RReadStream& aStream); sl@0: private: sl@0: TInt iCount; sl@0: private: sl@0: IMPORT_C static void __DbgChkRange(TInt aCount); sl@0: }; sl@0: // sl@0: /** Defines a function type for a function returned by TExternalizer::Function() sl@0: and TStreamRef. */ sl@0: typedef void (*TExternalizeFunction)(const TAny* aPtr,RWriteStream& aStream); sl@0: /** Defines a function type for a function returned by TInternalizer::Function(). */ sl@0: typedef void (*TInternalizeFunction)(TAny* aPtr,RReadStream& aStream); sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * A family of classes whose instances can be used to perform externalisation sl@0: on behalf of other objects. sl@0: sl@0: @see TStreamRef sl@0: */ sl@0: template sl@0: class TExternalizer sl@0: { sl@0: public: sl@0: inline void operator()(const T& anObject,RWriteStream& aStream) const; sl@0: inline static TExternalizeFunction Function(); sl@0: private: sl@0: static void ExternalizeAsL(const TAny* aPtr,RWriteStream& aStream); sl@0: }; sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * A specific instantiation of the family of TExternalizer classes whose sl@0: instances can be used to perform externalisation on behalf of other untyped sl@0: objects. sl@0: */ sl@0: TEMPLATE_SPECIALIZATION class TExternalizer sl@0: { sl@0: public: sl@0: /** Default constructor. */ sl@0: TExternalizer() {} sl@0: sl@0: /** Constructs the externaliser with the specified externalisation function. sl@0: sl@0: @param aFunction The externalisation function. */ sl@0: inline TExternalizer(TExternalizeFunction aFunction); sl@0: inline void operator()(const TAny* aPtr,RWriteStream& aStream) const; sl@0: sl@0: /** Gets a pointer to the function to be used to perform externalisation. sl@0: sl@0: @return The externalisation function. */ sl@0: inline TExternalizeFunction Function() const; sl@0: private: sl@0: TExternalizeFunction iFunc; sl@0: }; sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * A family of classes whose instances can be used to perform internalisation sl@0: on behalf of other objects. sl@0: */ sl@0: template sl@0: class TInternalizer sl@0: { sl@0: public: sl@0: inline void operator()(T& anObject,RReadStream& aStream) const; sl@0: inline static TInternalizeFunction Function(); sl@0: private: sl@0: static void InternalizeAsL(TAny* aPtr,RReadStream& aStream); sl@0: }; sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * A specific instantiation of the family of TInternalizer classes whose sl@0: instances can be used to perform internalisation on behalf of other objects. sl@0: */ sl@0: TEMPLATE_SPECIALIZATION class TInternalizer sl@0: { sl@0: public: sl@0: /** Default constructor. */ sl@0: TInternalizer() {} sl@0: sl@0: /** Constructs the internaliser with the specified internalisation function. sl@0: sl@0: @param aFunction The internalisation function. */ sl@0: inline TInternalizer(TInternalizeFunction aFunction); sl@0: inline void operator()(TAny* aPtr,RReadStream& aStream) const; sl@0: sl@0: /** Gets a pointer to the function to be used to perform internalisation. sl@0: sl@0: @return The internalisation function. */ sl@0: inline TInternalizeFunction Function() const; sl@0: private: sl@0: TInternalizeFunction iFunc; sl@0: }; sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * A family of classes defining an interface that can be implemented by classes sl@0: that need to perform externalisation on behalf of others. sl@0: sl@0: @see CStoreMap sl@0: */ sl@0: template sl@0: class MExternalizer sl@0: { sl@0: public: sl@0: inline void operator()(const T& anObject,RWriteStream& aStream) const; sl@0: private: sl@0: /** Performs externalisation. sl@0: sl@0: The function is called by operator(). sl@0: sl@0: @param anObject The object to be externalised. sl@0: @param aStream The write stream. */ sl@0: virtual void ExternalizeL(const T& anObject,RWriteStream& aStream) const=0; sl@0: }; sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * A family of classes defining an interface that can be implemented by classes sl@0: that need to perform internalisation on behalf of others. sl@0: sl@0: @see CStoreMap sl@0: */ sl@0: template sl@0: class MInternalizer sl@0: { sl@0: public: sl@0: inline void operator()(T& anObject,RReadStream& aStream) const; sl@0: private: sl@0: /** Performs internalisation. sl@0: sl@0: The function is called by operator(). sl@0: sl@0: @param anObject The object to be the target of the internalisation process. sl@0: @param aStream The read stream. */ sl@0: virtual void InternalizeL(T& anObject,RReadStream& aStream) const=0; sl@0: }; sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * A proxy for perfoming externalisation for classes that do not have an sl@0: externalisation member. sl@0: */ sl@0: class TStreamRef sl@0: { sl@0: public: sl@0: inline TStreamRef(const TAny* aPtr,TExternalizeFunction aFunction); sl@0: inline const TAny* Ptr() const; sl@0: inline TExternalizeFunction Function() const; sl@0: // sl@0: inline void ExternalizeL(RWriteStream& aStream) const; sl@0: private: sl@0: const TAny* iPtr; sl@0: TExternalizeFunction iFunc; sl@0: }; sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * A class whose members are used to distinguish between the two variants of sl@0: the Symbian OS internal function DoExternalizeL(). sl@0: */ sl@0: class Externalize sl@0: { sl@0: public: sl@0: /** Indicates that an object will be externalized by calling its sl@0: ExternalizeL() member. */ sl@0: class Member {}; sl@0: sl@0: /** Indicates that an object will be externalized by calling a global sl@0: ExternalizeL() function. */ sl@0: class Function {}; sl@0: }; sl@0: sl@0: /** sl@0: * @publishedAll sl@0: * @released sl@0: * A class whose members are used to distinguish between the two variants of sl@0: the Symbian OS internal function DoInternalizeL(). sl@0: */ sl@0: class Internalize sl@0: { sl@0: public: sl@0: /** Indicates that an object will be internalized by calling its sl@0: InternalizeL() member. */ sl@0: class Member {}; sl@0: sl@0: /** Indicates that an object will be internalized by calling a global sl@0: InternalizeL() function. */ sl@0: class Function {}; sl@0: }; sl@0: sl@0: #include sl@0: #endif