epoc32/include/comms-infras/metatypevariablelen.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// MetaTypeVariableLen.h
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
/**
williamr@2
    21
 @file MetaTypeVariableLen.h
williamr@2
    22
 @internalTechnology
williamr@2
    23
*/
williamr@2
    24
williamr@2
    25
#if (!defined METATYPEVARIABLELEN_H)
williamr@2
    26
#define METATYPEVARIABLELEN_H
williamr@2
    27
williamr@2
    28
#include <comms-infras/metatype.h>
williamr@2
    29
williamr@2
    30
namespace Meta
williamr@2
    31
{
williamr@2
    32
williamr@2
    33
template<class TYPE> class TMetaVarLen8;
williamr@2
    34
template<class TYPE> class TMetaVarLen16;
williamr@2
    35
typedef TMetaVarLen8<TDes8> TMetaDes8;
williamr@2
    36
typedef TMetaVarLen16<TDes16> TMetaDes16;
williamr@2
    37
williamr@2
    38
#if defined(_UNICODE)
williamr@2
    39
typedef TMetaDes16 TMetaDes;
williamr@2
    40
#else
williamr@2
    41
typedef TMetaDes8 TMetaDes;
williamr@2
    42
#endif
williamr@2
    43
williamr@2
    44
class TMetaVarLenBase : public MMetaType
williamr@2
    45
	{
williamr@2
    46
	public:
williamr@2
    47
		IMPORT_C virtual TInt Load(TPtrC8& aBuffer);
williamr@2
    48
		IMPORT_C virtual TInt Store(TDes8& aBuffer) const;
williamr@2
    49
		
williamr@2
    50
	protected:
williamr@2
    51
		TInt CheckBuf( TPtrC8& aBuffer );
williamr@2
    52
		virtual void CopyBuf(TPtrC8& aBuffer,TInt aLen) = 0;
williamr@2
    53
		virtual void AppendToBuf( TDes8& aBuffer ) const = 0;
williamr@2
    54
	};
williamr@2
    55
	
williamr@2
    56
template<class TYPE>
williamr@2
    57
class TMetaVarLen : public TMetaVarLenBase
williamr@2
    58
/**
williamr@2
    59
williamr@2
    60
Implementation of MMetaType for anything that provides Length(), SetLength(), MaxLength(),
williamr@2
    61
Copy() and Left() functions with arbitrarry element size
williamr@2
    62
williamr@2
    63
@internalComponent
williamr@2
    64
@released since v9.0 */
williamr@2
    65
	{
williamr@2
    66
public:
williamr@2
    67
	virtual void Copy(const TAny* aData);
williamr@2
    68
williamr@2
    69
protected:
williamr@2
    70
	TMetaVarLen(const TAny* aData);
williamr@2
    71
williamr@2
    72
protected:
williamr@2
    73
	TYPE* iData;
williamr@2
    74
	};
williamr@2
    75
williamr@2
    76
template<class TYPE>
williamr@2
    77
inline TMetaVarLen<TYPE>::TMetaVarLen(const TAny* aData)
williamr@2
    78
:    iData((TYPE*)aData)
williamr@2
    79
/**
williamr@2
    80
 * Constructor
williamr@2
    81
 */
williamr@2
    82
    {
williamr@2
    83
    __ASSERT_DEBUG(iData!=NULL,User::Panic(_L("TMetaVarLen"),KErrArgument));
williamr@2
    84
    }
williamr@2
    85
williamr@2
    86
template<class TYPE>
williamr@2
    87
void TMetaVarLen<TYPE>::Copy(const TAny* aData)
williamr@2
    88
/**
williamr@2
    89
 * Copies content of the member
williamr@2
    90
 */
williamr@2
    91
	{
williamr@2
    92
	const TYPE& var = *((TYPE*)aData);
williamr@2
    93
	iData->Copy(var.Left( iData->MaxLength() ));
williamr@2
    94
	}
williamr@2
    95
williamr@2
    96
template<class TYPE>
williamr@2
    97
class TMetaVarLen8 : public TMetaVarLen<TYPE>
williamr@2
    98
/**
williamr@2
    99
williamr@2
   100
Implementation of MMetaType for anything that provides Length(), SetLength(), MaxLength(),
williamr@2
   101
Copy() and Left() functions with element size 1 byte
williamr@2
   102
Like for example TDes8, TBuf8, TPtr8.
williamr@2
   103
williamr@2
   104
@internalComponent
williamr@2
   105
@released since v9.0 */
williamr@2
   106
	{
williamr@2
   107
public:
williamr@2
   108
	inline static MMetaType* NewL(const TAny* aMem, const TAny* aData);
williamr@2
   109
williamr@2
   110
	virtual TInt Length() const;
williamr@2
   111
williamr@2
   112
protected:
williamr@2
   113
	TMetaVarLen8(const TAny* aData);
williamr@2
   114
	virtual void AppendToBuf( TDes8& aBuffer ) const;
williamr@2
   115
	virtual void CopyBuf(TPtrC8& aBuffer,TInt aLen);
williamr@2
   116
williamr@2
   117
	};
williamr@2
   118
williamr@2
   119
template<class TYPE>
williamr@2
   120
class TMetaVarLen16 : public TMetaVarLen<TYPE>
williamr@2
   121
/**
williamr@2
   122
williamr@2
   123
Implementation of MMetaType for anything that provides Length(), SetLength(), MaxLength(),
williamr@2
   124
Copy() and Left() functions with element size 2 bytes
williamr@2
   125
Like for example TDes16, TBuf16, TPtr16 (ELEMENT is short).
williamr@2
   126
williamr@2
   127
@internalComponent
williamr@2
   128
@released since v9.0 */
williamr@2
   129
	{
williamr@2
   130
public:
williamr@2
   131
	inline static MMetaType* NewL(const TAny* aMem, const TAny* aData);
williamr@2
   132
williamr@2
   133
	virtual TInt Length() const;
williamr@2
   134
williamr@2
   135
protected:
williamr@2
   136
	TMetaVarLen16(const TAny* aData);
williamr@2
   137
	virtual void AppendToBuf( TDes8& aBuffer ) const;
williamr@2
   138
	virtual void CopyBuf(TPtrC8& aBuffer,TInt aLen);
williamr@2
   139
williamr@2
   140
	};
williamr@2
   141
williamr@2
   142
williamr@2
   143
template<class TYPE>
williamr@2
   144
inline TMetaVarLen16<TYPE>::TMetaVarLen16(const TAny* aData)
williamr@2
   145
:    TMetaVarLen<TYPE>(aData)
williamr@2
   146
/**
williamr@2
   147
 * Constructor
williamr@2
   148
 */
williamr@2
   149
    {
williamr@2
   150
    }
williamr@2
   151
williamr@2
   152
template<class TYPE>
williamr@2
   153
MMetaType* TMetaVarLen16<TYPE>::NewL(const TAny* aMem, const TAny* aData)
williamr@2
   154
/**
williamr@2
   155
 * Instantiates a meta type of a particular type.
williamr@2
   156
 * Used for attribure registration (in the data v-table).
williamr@2
   157
 */
williamr@2
   158
    {
williamr@2
   159
    return ::new ((TUint8*)aMem) TMetaVarLen16<TYPE>(aData);
williamr@2
   160
    }
williamr@2
   161
williamr@2
   162
template<class TYPE>
williamr@2
   163
void TMetaVarLen16<TYPE>::AppendToBuf( TDes8& aBuffer ) const
williamr@2
   164
	{
williamr@2
   165
	//copy whatever fits in (no loosing high byte as the ::Copy normally would)
williamr@2
   166
	//a litle bit dirty solution assuming a flat memory model and byte addressing mode
williamr@2
   167
	aBuffer.Append(reinterpret_cast<const TUint8*>(this->iData->Ptr()), this->iData->Length() * 2);
williamr@2
   168
	}
williamr@2
   169
williamr@2
   170
template<class TYPE>
williamr@2
   171
void TMetaVarLen16<TYPE>::CopyBuf(TPtrC8& aBuffer,TInt aLen)
williamr@2
   172
	{
williamr@2
   173
	//copy whatever fits in
williamr@2
   174
	//a litle bit dirty solution assuming a flat memory model and byte addressing mode
williamr@2
   175
	this->iData->Copy( reinterpret_cast<const TUint16*>(aBuffer.Ptr()), Min( this->iData->MaxLength(), aLen / 2 ));
williamr@2
   176
	}
williamr@2
   177
williamr@2
   178
template<class TYPE>
williamr@2
   179
TInt TMetaVarLen16<TYPE>::Length() const
williamr@2
   180
/**
williamr@2
   181
 * Returns the length of the data member
williamr@2
   182
 */
williamr@2
   183
	{
williamr@2
   184
	return this->iData->Length() * 2 + sizeof(TUint32);
williamr@2
   185
	}
williamr@2
   186
williamr@2
   187
template<class TYPE>
williamr@2
   188
inline TMetaVarLen8<TYPE>::TMetaVarLen8(const TAny* aData)
williamr@2
   189
:    TMetaVarLen<TYPE>(aData)
williamr@2
   190
/**
williamr@2
   191
 * Constructor
williamr@2
   192
 */
williamr@2
   193
    {
williamr@2
   194
    }
williamr@2
   195
williamr@2
   196
template<class TYPE>
williamr@2
   197
MMetaType* TMetaVarLen8<TYPE>::NewL(const TAny* aMem, const TAny* aData)
williamr@2
   198
/**
williamr@2
   199
 * Instantiates a meta type of a particular type.
williamr@2
   200
 * Used for attribure registration (in the data v-table).
williamr@2
   201
 */
williamr@2
   202
    {
williamr@2
   203
    return ::new ((TUint8*)aMem) TMetaVarLen8<TYPE>(aData);
williamr@2
   204
    }
williamr@2
   205
williamr@2
   206
template<class TYPE>
williamr@2
   207
#ifdef SYMBIAN_NETWORKING_CFTRANSPORT
williamr@2
   208
void TMetaVarLen8<TYPE>::CopyBuf(TPtrC8& aBuffer,TInt aLen)
williamr@2
   209
	{
williamr@2
   210
	//copy whatever fits in
williamr@2
   211
	this->iData->Copy( aBuffer.Left( Min(this->iData->MaxLength(), aLen) ) );
williamr@2
   212
	}
williamr@2
   213
#else
williamr@2
   214
void TMetaVarLen8<TYPE>::CopyBuf(TPtrC8& aBuffer,TInt /*aLen*/)
williamr@2
   215
	{
williamr@2
   216
	this->iData->Copy( aBuffer.Left( this->iData->MaxLength() ) );
williamr@2
   217
	}
williamr@2
   218
#endif
williamr@2
   219
williamr@2
   220
template<class TYPE>
williamr@2
   221
void TMetaVarLen8<TYPE>::AppendToBuf( TDes8& aBuffer ) const
williamr@2
   222
	{
williamr@2
   223
	aBuffer.Append(*this->iData);
williamr@2
   224
	}
williamr@2
   225
williamr@2
   226
template<class TYPE>
williamr@2
   227
TInt TMetaVarLen8<TYPE>::Length() const
williamr@2
   228
/**
williamr@2
   229
 * Returns the length of the data member
williamr@2
   230
 */
williamr@2
   231
	{
williamr@2
   232
	return this->iData->Length() + sizeof(TUint32);
williamr@2
   233
	}
williamr@2
   234
williamr@2
   235
} //namespace Meta
williamr@2
   236
williamr@2
   237
williamr@2
   238
#endif //METATYPE_H