1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/security/cryptomgmtlibs/securitycommonutils/inc/streamingarray.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,115 @@
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 +* 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_H
1.30 +#define STREAMINGARRAY_H
1.31 +
1.32 +#include <e32std.h>
1.33 +#include <s32strm.h>
1.34 +
1.35 +
1.36 +// RPointerArray utilities
1.37 +
1.38 +/**
1.39 + Copy a pointer array of template objects to another one.
1.40 + Note that only objects are copied into the target array, NOT pointers.
1.41 + T class must provide a static T::NewL(T&) construction function.
1.42 + @param aTarget The pointer array to which a given array will be copied.
1.43 + @param aSource The pointer array which will be copied.
1.44 + */
1.45 +template <class T>
1.46 +void CopyPointerArrayL(RPointerArray<T>& aTarget, const RPointerArray<T>& aSource);
1.47 +
1.48 +/**
1.49 + Externalize an array of pointers of template class.
1.50 + @param aArray The pointer array which will be externalized
1.51 + @param aAddLength Whether the length of the array is added to the beginning of the externalized data.
1.52 + @return Pointer to the memory of the externalized array which is left on
1.53 + the cleanup stack. Ownership is transferred.
1.54 +
1.55 + */
1.56 +template <class T>
1.57 +HBufC8* ExternalizePointersArrayLC(const RPointerArray<T>& aArray, TBool aAddLength=ETrue);
1.58 +
1.59 +/**
1.60 + Externalize an array of pointers of template class.
1.61 + @param aArray The pointer array which will be externalized.
1.62 + @param aStream A stream to the buffer where the pointer array will be externalized.
1.63 + @param aAddLength Whether the length of the array is added to the beginning of the externalized data.
1.64 + */
1.65 +template <class T>
1.66 +void ExternalizePointersArrayL(const RPointerArray<T>& aArray, RWriteStream& aStream, TBool aAddLength=ETrue);
1.67 +
1.68 +/**
1.69 + Internalize a given externalized pointers array stream.
1.70 + Template class must provide a static T::NewL(RReadStream&) function.
1.71 + @param aArray The pointer array which the stream will be internalized into.
1.72 + @param aStream A stream to the externalized pointer array
1.73 + @param aAddLength Whether the length of the array exists at the beginning of the data being internalized.
1.74 + */
1.75 +template <class T>
1.76 +void InternalizePointersArrayL(RPointerArray<T>& aArray, RReadStream& aStream, TBool aAddLength=ETrue);
1.77 +
1.78 +
1.79 +// RArray utilities
1.80 +
1.81 +/**
1.82 + Copy an array of fixed length template objects to another one.
1.83 + Note that T must have a valid copy c'tor.
1.84 + @param aTarget The array to which a given array will be copied.
1.85 + @param aSource The array which will be copied.
1.86 + */
1.87 +template <class T>
1.88 +void CopyFixedLengthArrayL(RArray<T>& aTarget, const RArray<T>& aSource);
1.89 +
1.90 +
1.91 +/**
1.92 + Externalize an array of fixed length template objects.
1.93 + @param aArray The array which will be externalized.
1.94 + @return Pointer to the memory of the externalized array which is left on
1.95 + the cleanup stack. Ownership is transferred.
1.96 + */
1.97 +template <class T>
1.98 +HBufC8* ExternalizeFixedLengthArrayLC(const RArray<T>& aArray);
1.99 +
1.100 +/**
1.101 + Externalize an array of fixed length template objects.
1.102 + @param aArray The array which will be externalized.
1.103 + @param aStream A stream to the buffer where the fixed length array will be externalized.
1.104 + */
1.105 +template <class T>
1.106 +void ExternalizeFixedLengthArrayL(const RArray<T>& aArray, RWriteStream& aStream);
1.107 +
1.108 +/**
1.109 + Internalize a given externalized fixed length array stream.
1.110 + @param aArray The pointer array which the stream will be internalized into.
1.111 + @param aStream A stream to the externalized fixed length array
1.112 + */
1.113 +template <class T>
1.114 +void InternalizeFixedLengthArrayL(RArray<T>& aArray, RReadStream& aStream);
1.115 +
1.116 +#include <scs/streamingarray.inl>
1.117 +
1.118 +#endif // STREAMINGARRAY_H