|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of the License "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
* Utility functions for copying and streaming RArray/RpointerArray.
|
|
sl@0
|
16 |
*
|
|
sl@0
|
17 |
*/
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
/**
|
|
sl@0
|
21 |
@file
|
|
sl@0
|
22 |
@internalTechnology
|
|
sl@0
|
23 |
@released
|
|
sl@0
|
24 |
*/
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
#ifndef STREAMINGARRAY_H
|
|
sl@0
|
27 |
#define STREAMINGARRAY_H
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
#include <e32std.h>
|
|
sl@0
|
30 |
#include <s32strm.h>
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
// RPointerArray utilities
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
/**
|
|
sl@0
|
36 |
Copy a pointer array of template objects to another one.
|
|
sl@0
|
37 |
Note that only objects are copied into the target array, NOT pointers.
|
|
sl@0
|
38 |
T class must provide a static T::NewL(T&) construction function.
|
|
sl@0
|
39 |
@param aTarget The pointer array to which a given array will be copied.
|
|
sl@0
|
40 |
@param aSource The pointer array which will be copied.
|
|
sl@0
|
41 |
*/
|
|
sl@0
|
42 |
template <class T>
|
|
sl@0
|
43 |
void CopyPointerArrayL(RPointerArray<T>& aTarget, const RPointerArray<T>& aSource);
|
|
sl@0
|
44 |
|
|
sl@0
|
45 |
/**
|
|
sl@0
|
46 |
Externalize an array of pointers of template class.
|
|
sl@0
|
47 |
@param aArray The pointer array which will be externalized
|
|
sl@0
|
48 |
@param aAddLength Whether the length of the array is added to the beginning of the externalized data.
|
|
sl@0
|
49 |
@return Pointer to the memory of the externalized array which is left on
|
|
sl@0
|
50 |
the cleanup stack. Ownership is transferred.
|
|
sl@0
|
51 |
|
|
sl@0
|
52 |
*/
|
|
sl@0
|
53 |
template <class T>
|
|
sl@0
|
54 |
HBufC8* ExternalizePointersArrayLC(const RPointerArray<T>& aArray, TBool aAddLength=ETrue);
|
|
sl@0
|
55 |
|
|
sl@0
|
56 |
/**
|
|
sl@0
|
57 |
Externalize an array of pointers of template class.
|
|
sl@0
|
58 |
@param aArray The pointer array which will be externalized.
|
|
sl@0
|
59 |
@param aStream A stream to the buffer where the pointer array will be externalized.
|
|
sl@0
|
60 |
@param aAddLength Whether the length of the array is added to the beginning of the externalized data.
|
|
sl@0
|
61 |
*/
|
|
sl@0
|
62 |
template <class T>
|
|
sl@0
|
63 |
void ExternalizePointersArrayL(const RPointerArray<T>& aArray, RWriteStream& aStream, TBool aAddLength=ETrue);
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
/**
|
|
sl@0
|
66 |
Internalize a given externalized pointers array stream.
|
|
sl@0
|
67 |
Template class must provide a static T::NewL(RReadStream&) function.
|
|
sl@0
|
68 |
@param aArray The pointer array which the stream will be internalized into.
|
|
sl@0
|
69 |
@param aStream A stream to the externalized pointer array
|
|
sl@0
|
70 |
@param aAddLength Whether the length of the array exists at the beginning of the data being internalized.
|
|
sl@0
|
71 |
*/
|
|
sl@0
|
72 |
template <class T>
|
|
sl@0
|
73 |
void InternalizePointersArrayL(RPointerArray<T>& aArray, RReadStream& aStream, TBool aAddLength=ETrue);
|
|
sl@0
|
74 |
|
|
sl@0
|
75 |
|
|
sl@0
|
76 |
// RArray utilities
|
|
sl@0
|
77 |
|
|
sl@0
|
78 |
/**
|
|
sl@0
|
79 |
Copy an array of fixed length template objects to another one.
|
|
sl@0
|
80 |
Note that T must have a valid copy c'tor.
|
|
sl@0
|
81 |
@param aTarget The array to which a given array will be copied.
|
|
sl@0
|
82 |
@param aSource The array which will be copied.
|
|
sl@0
|
83 |
*/
|
|
sl@0
|
84 |
template <class T>
|
|
sl@0
|
85 |
void CopyFixedLengthArrayL(RArray<T>& aTarget, const RArray<T>& aSource);
|
|
sl@0
|
86 |
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
/**
|
|
sl@0
|
89 |
Externalize an array of fixed length template objects.
|
|
sl@0
|
90 |
@param aArray The array which will be externalized.
|
|
sl@0
|
91 |
@return Pointer to the memory of the externalized array which is left on
|
|
sl@0
|
92 |
the cleanup stack. Ownership is transferred.
|
|
sl@0
|
93 |
*/
|
|
sl@0
|
94 |
template <class T>
|
|
sl@0
|
95 |
HBufC8* ExternalizeFixedLengthArrayLC(const RArray<T>& aArray);
|
|
sl@0
|
96 |
|
|
sl@0
|
97 |
/**
|
|
sl@0
|
98 |
Externalize an array of fixed length template objects.
|
|
sl@0
|
99 |
@param aArray The array which will be externalized.
|
|
sl@0
|
100 |
@param aStream A stream to the buffer where the fixed length array will be externalized.
|
|
sl@0
|
101 |
*/
|
|
sl@0
|
102 |
template <class T>
|
|
sl@0
|
103 |
void ExternalizeFixedLengthArrayL(const RArray<T>& aArray, RWriteStream& aStream);
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
/**
|
|
sl@0
|
106 |
Internalize a given externalized fixed length array stream.
|
|
sl@0
|
107 |
@param aArray The pointer array which the stream will be internalized into.
|
|
sl@0
|
108 |
@param aStream A stream to the externalized fixed length array
|
|
sl@0
|
109 |
*/
|
|
sl@0
|
110 |
template <class T>
|
|
sl@0
|
111 |
void InternalizeFixedLengthArrayL(RArray<T>& aArray, RReadStream& aStream);
|
|
sl@0
|
112 |
|
|
sl@0
|
113 |
#include <scs/streamingarray.inl>
|
|
sl@0
|
114 |
|
|
sl@0
|
115 |
#endif // STREAMINGARRAY_H
|