1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/security/cryptomgmtlibs/securitycommonutils/inc/streamingarray.inl Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,240 @@
1.4 +/*
1.5 +* Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of the License "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +* Implementation of utility functions for copying and streaming RArray/RpointerArray.
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +/**
1.24 + @file
1.25 + @internalTechnology
1.26 + @released
1.27 +*/
1.28 +
1.29 +#ifndef STREAMINGARRAY_INL
1.30 +#define STREAMINGARRAY_INL
1.31 +
1.32 +#include <s32mem.h>
1.33 +#include <scs/streamingarray.h>
1.34 +#include <scs/nullstream.h>
1.35 +#include <scs/streamingarray.h>
1.36 +
1.37 +// Traits classes - internally required by RArray/RPointerArray functions
1.38 +
1.39 +template <class T>
1.40 +class TTraits
1.41 + {
1.42 +public:
1.43 + static T* CopyL(const T& aRight) { return T::NewL(aRight);}
1.44 + static T* ReadFromStreamL(RReadStream& aStream) { return T::NewL(aStream); }
1.45 + static T* ReadFromStreamLC(RReadStream& aStream) { return T::NewLC(aStream); }
1.46 + static void WriteToStreamL(const T& aItem, RWriteStream& aStream) { aStream << aItem; }
1.47 + };
1.48 +
1.49 +// Specialisation for HBufC
1.50 +template <>
1.51 +class TTraits<HBufC16>
1.52 + {
1.53 +public:
1.54 + static HBufC16* CopyL(const HBufC16& aOther) { return aOther.AllocL();}
1.55 + static HBufC16* ReadFromStreamL(RReadStream& aStream) { return HBufC16::NewL(aStream, KMaxTInt); }
1.56 + static HBufC16* ReadFromStreamLC(RReadStream& aStream) { return HBufC16::NewLC(aStream, KMaxTInt); }
1.57 + static void WriteToStreamL(const HBufC16& aItem, RWriteStream& aStream) { aStream << aItem; }
1.58 + };
1.59 +
1.60 +template <>
1.61 +class TTraits<HBufC8>
1.62 + {
1.63 +public:
1.64 + static HBufC8* CopyL(const HBufC8& aOther) { return aOther.AllocL();}
1.65 + static HBufC8* ReadFromStreamL(RReadStream& aStream) { return HBufC8::NewL(aStream, KMaxTInt); }
1.66 + static HBufC8* ReadFromStreamLC(RReadStream& aStream) { return HBufC8::NewLC(aStream, KMaxTInt); }
1.67 + static void WriteToStreamL(const HBufC8& aItem, RWriteStream& aStream) { aStream << aItem; }
1.68 + };
1.69 +
1.70 +// Size calculator - internally required by RPointerArray functions
1.71 +
1.72 +template <typename T>
1.73 +TInt GetObjectBufferSizeL(const T& aObject)
1.74 + {
1.75 + TInt size(0);
1.76 + RNullWriteStream nullstream;
1.77 + CleanupClosePushL(nullstream);
1.78 + nullstream << aObject;
1.79 + nullstream.CommitL();
1.80 + size = nullstream.BytesWritten();
1.81 + CleanupStack::PopAndDestroy(&nullstream);
1.82 + return size;
1.83 + }
1.84 +
1.85 +template <class T>
1.86 +TInt ExternalizedBufferSizeL(const RPointerArray<T>& aArray)
1.87 +/**
1.88 + Calculates how much buffer is required for a pointers array to be externalized.
1.89 + @param aArray The pointer array whose buffer size will be calculated.
1.90 + @return Returns the number of bytes occupied by the elements of the pointer array.
1.91 + */
1.92 + {
1.93 + TInt totalSize(1); // 1-byte is reserved for the array count
1.94 + TInt count = aArray.Count();
1.95 +
1.96 + for (TInt i = 0; i < count; ++i)
1.97 + {
1.98 + totalSize += GetObjectBufferSizeL(*aArray[i]);
1.99 + }
1.100 + return totalSize;
1.101 + }
1.102 +
1.103 +
1.104 +// RPointerArray utilities
1.105 +
1.106 +template <class T>
1.107 +void CopyPointerArrayL(RPointerArray<T>& aTarget, const RPointerArray<T>& aSource)
1.108 + {
1.109 + TInt arrayCount = aSource.Count();
1.110 + for (TInt i = 0; i < arrayCount; ++i)
1.111 + {
1.112 + T* item = TTraits<T>::CopyL(*aSource[i]);
1.113 + CleanupStack::PushL(item);
1.114 + User::LeaveIfError(aTarget.Append(item));
1.115 + CleanupStack::Pop(item);
1.116 + }
1.117 + }
1.118 +
1.119 +template <class T>
1.120 +HBufC8* ExternalizePointersArrayLC(const RPointerArray<T>& aArray, TBool aAddLength)
1.121 + {
1.122 + TInt arraySize = ExternalizedBufferSizeL(aArray);
1.123 + HBufC8 *arrayBuf = HBufC8::NewLC(arraySize + sizeof(TInt32));
1.124 + TPtr8 arrayPtr(arrayBuf->Des());
1.125 +
1.126 + RDesWriteStream stream(arrayPtr);
1.127 + stream.PushL();
1.128 + ExternalizePointersArrayL(aArray, stream, aAddLength);
1.129 + stream.Pop();
1.130 + stream.Release();
1.131 + return arrayBuf;
1.132 + }
1.133 +
1.134 +template <class T>
1.135 +void ExternalizePointersArrayL(const RPointerArray<T>& aArray, RWriteStream& aStream, TBool aAddLength)
1.136 + {
1.137 + TInt arrayCount = aArray.Count();
1.138 + if(aAddLength)
1.139 + aStream << TCardinality(arrayCount);
1.140 + for (TInt i = 0; i < arrayCount; ++i)
1.141 + {
1.142 + TTraits<T>::WriteToStreamL(*aArray[i], aStream);
1.143 + }
1.144 + aStream.CommitL();
1.145 + }
1.146 +
1.147 +template <class T>
1.148 +void InternalizePointersArrayL(RPointerArray<T>& aArray, RReadStream& aStream, TBool aAddLength)
1.149 + {
1.150 + TInt count (0);
1.151 + if(aAddLength)
1.152 + {
1.153 + TCardinality c;
1.154 + aStream >> c;
1.155 + count = c;
1.156 + }
1.157 + for (TInt i = 0; i < count; ++i)
1.158 + {
1.159 + T* item = TTraits<T>::ReadFromStreamL(aStream);
1.160 + CleanupStack::PushL(item);
1.161 + User::LeaveIfError(aArray.Append(item));
1.162 + CleanupStack::Pop(item);
1.163 + }
1.164 + }
1.165 +
1.166 +
1.167 +// Size calculator - internally required by RArray/RPointerArray functions
1.168 +
1.169 +template <class T>
1.170 +TInt ExternalizedBufferSizeL(const RArray<T>& aArray)
1.171 +/**
1.172 + Calculates how much buffer is required for a fixed length array to be externalized.
1.173 + @param aArray The array whose buffer size will be calculated.
1.174 + @return Returns the number of bytes of the array's dynamic memory.
1.175 + */
1.176 + {
1.177 + TInt totalSize(1); // 1-byte is reserved for the array count
1.178 + TInt count = aArray.Count();
1.179 +
1.180 + for (TInt i = 0; i < count; ++i)
1.181 + {
1.182 + totalSize += GetObjectBufferSizeL(TPckgC<T>(aArray[i]));
1.183 + }
1.184 + return totalSize;
1.185 + }
1.186 +
1.187 +
1.188 +// RArray utilities
1.189 +
1.190 +template <class T>
1.191 +void CopyFixedLengthArrayL(RArray<T>& aTarget, const RArray<T>& aSource)
1.192 + {
1.193 + TInt arrayCount = aSource.Count();
1.194 + for (TInt i = 0; i < arrayCount; ++i)
1.195 + {
1.196 + User::LeaveIfError(aTarget.Append(aSource[i]));
1.197 + }
1.198 + }
1.199 +
1.200 +template <class T>
1.201 +HBufC8* ExternalizeFixedLengthArrayL(const RArray<T>& aArray)
1.202 + {
1.203 + TInt arraySize = ExternalizedBufferSizeL(aArray, arraySize);
1.204 + HBufC8 *arrayBuf = HBufC8::NewLC(arraySize + sizeof(TInt32));
1.205 + TPtr8 arrayPtr(arrayBuf->Des());
1.206 +
1.207 + RDesWriteStream stream(arrayPtr);
1.208 + stream.PushL();
1.209 + ExternalizeFixedLengthArrayL(aArray, stream);
1.210 + stream.Pop();
1.211 + stream.Release();
1.212 + return arrayBuf;
1.213 + }
1.214 +
1.215 +template <class T>
1.216 +void ExternalizeFixedLengthArrayL(const RArray<T>& aArray, RWriteStream& aStream)
1.217 + {
1.218 + TInt arrayCount = aArray.Count();
1.219 + aStream << TCardinality(arrayCount);
1.220 + for (TInt i = 0; i < arrayCount; ++i)
1.221 + {
1.222 + aStream.WriteL(TPckgC<T>(aArray[i]));
1.223 + }
1.224 + aStream.CommitL();
1.225 + }
1.226 +
1.227 +
1.228 +template <class T>
1.229 +void InternalizeFixedLengthArrayL(RArray<T>& aArray, RReadStream& aStream)
1.230 + {
1.231 + TCardinality c;
1.232 + aStream >> c;
1.233 + TInt count = c;
1.234 + for (TInt i = 0; i < count; ++i)
1.235 + {
1.236 + T item;
1.237 + TPckg<T> itemPckg(item);
1.238 + aStream.ReadL(itemPckg);
1.239 + User::LeaveIfError(aArray.Append(item));
1.240 + }
1.241 + }
1.242 +
1.243 +#endif /* STREAMINGARRAY_INL*/