usbdrv/peripheral/public/usbcque.h
author hgs
Wed, 20 Oct 2010 12:04:53 +0800
changeset 59 bbdce6bffaad
parent 33 089413cdde3c
permissions -rw-r--r--
201041_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
59
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
     1
/*
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
     3
* All rights reserved.
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
     4
* This component and the accompanying materials are made available
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
     6
* which accompanies this distribution, and is available
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
     8
*
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
     9
* Initial Contributors:
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
    10
* Nokia Corporation - initial contribution.
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
    11
*
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
    12
* Contributors:
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
    13
*
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
    14
* Description:
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
    15
* e32\include\drivers\usbcque.h
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
    16
* Simple singly linked list + its iterator for the USB Device driver.
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
    17
*
bbdce6bffaad 201041_02
hgs
parents: 33
diff changeset
    18
*/
33
089413cdde3c 201028_02
hgs
parents:
diff changeset
    19
/**
089413cdde3c 201028_02
hgs
parents:
diff changeset
    20
 @file usbcque.h
089413cdde3c 201028_02
hgs
parents:
diff changeset
    21
 @internalTechnology
089413cdde3c 201028_02
hgs
parents:
diff changeset
    22
*/
089413cdde3c 201028_02
hgs
parents:
diff changeset
    23
089413cdde3c 201028_02
hgs
parents:
diff changeset
    24
#ifndef __USBCQUE_H__
089413cdde3c 201028_02
hgs
parents:
diff changeset
    25
#define __USBCQUE_H__
089413cdde3c 201028_02
hgs
parents:
diff changeset
    26
089413cdde3c 201028_02
hgs
parents:
diff changeset
    27
#include <kernel/kernel.h>
089413cdde3c 201028_02
hgs
parents:
diff changeset
    28
089413cdde3c 201028_02
hgs
parents:
diff changeset
    29
089413cdde3c 201028_02
hgs
parents:
diff changeset
    30
//
089413cdde3c 201028_02
hgs
parents:
diff changeset
    31
// --- Class definitions ---
089413cdde3c 201028_02
hgs
parents:
diff changeset
    32
//
089413cdde3c 201028_02
hgs
parents:
diff changeset
    33
089413cdde3c 201028_02
hgs
parents:
diff changeset
    34
class TSglQueLink
089413cdde3c 201028_02
hgs
parents:
diff changeset
    35
	{
089413cdde3c 201028_02
hgs
parents:
diff changeset
    36
private:
089413cdde3c 201028_02
hgs
parents:
diff changeset
    37
	void Enque(TSglQueLink* aLink);
089413cdde3c 201028_02
hgs
parents:
diff changeset
    38
public:
089413cdde3c 201028_02
hgs
parents:
diff changeset
    39
	TSglQueLink* iNext;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    40
	friend class TSglQueBase;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    41
	};
089413cdde3c 201028_02
hgs
parents:
diff changeset
    42
089413cdde3c 201028_02
hgs
parents:
diff changeset
    43
089413cdde3c 201028_02
hgs
parents:
diff changeset
    44
class TSglQueBase
089413cdde3c 201028_02
hgs
parents:
diff changeset
    45
	{
089413cdde3c 201028_02
hgs
parents:
diff changeset
    46
protected:
089413cdde3c 201028_02
hgs
parents:
diff changeset
    47
	TSglQueBase(TInt aOffset);
089413cdde3c 201028_02
hgs
parents:
diff changeset
    48
	void DoAddLast(TAny* aPtr);
089413cdde3c 201028_02
hgs
parents:
diff changeset
    49
	void DoRemove(TAny* aPtr);
089413cdde3c 201028_02
hgs
parents:
diff changeset
    50
protected:
089413cdde3c 201028_02
hgs
parents:
diff changeset
    51
	TSglQueLink* iHead;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    52
	TSglQueLink* iLast;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    53
	TInt iOffset;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    54
	TInt iElements;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    55
private:
089413cdde3c 201028_02
hgs
parents:
diff changeset
    56
	friend class TSglQueIterBase;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    57
	};
089413cdde3c 201028_02
hgs
parents:
diff changeset
    58
089413cdde3c 201028_02
hgs
parents:
diff changeset
    59
089413cdde3c 201028_02
hgs
parents:
diff changeset
    60
template<class T>
089413cdde3c 201028_02
hgs
parents:
diff changeset
    61
class TSglQue : public TSglQueBase
089413cdde3c 201028_02
hgs
parents:
diff changeset
    62
	{
089413cdde3c 201028_02
hgs
parents:
diff changeset
    63
public:
089413cdde3c 201028_02
hgs
parents:
diff changeset
    64
	inline TSglQue(TInt aOffset);
089413cdde3c 201028_02
hgs
parents:
diff changeset
    65
	inline void AddLast(T& aRef);
089413cdde3c 201028_02
hgs
parents:
diff changeset
    66
	inline void Remove(T& aRef);
089413cdde3c 201028_02
hgs
parents:
diff changeset
    67
	inline TInt Elements() const;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    68
	};
089413cdde3c 201028_02
hgs
parents:
diff changeset
    69
089413cdde3c 201028_02
hgs
parents:
diff changeset
    70
089413cdde3c 201028_02
hgs
parents:
diff changeset
    71
class TSglQueIterBase
089413cdde3c 201028_02
hgs
parents:
diff changeset
    72
	{
089413cdde3c 201028_02
hgs
parents:
diff changeset
    73
public:
089413cdde3c 201028_02
hgs
parents:
diff changeset
    74
	void SetToFirst();
089413cdde3c 201028_02
hgs
parents:
diff changeset
    75
protected:
089413cdde3c 201028_02
hgs
parents:
diff changeset
    76
	TSglQueIterBase(TSglQueBase& aQue);
089413cdde3c 201028_02
hgs
parents:
diff changeset
    77
	TAny* DoPostInc();
089413cdde3c 201028_02
hgs
parents:
diff changeset
    78
	TAny* DoCurrent();
089413cdde3c 201028_02
hgs
parents:
diff changeset
    79
protected:
089413cdde3c 201028_02
hgs
parents:
diff changeset
    80
	TInt iOffset;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    81
	TSglQueLink*& iHead;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    82
	TSglQueLink* iNext;
089413cdde3c 201028_02
hgs
parents:
diff changeset
    83
	};
089413cdde3c 201028_02
hgs
parents:
diff changeset
    84
089413cdde3c 201028_02
hgs
parents:
diff changeset
    85
089413cdde3c 201028_02
hgs
parents:
diff changeset
    86
template<class T>
089413cdde3c 201028_02
hgs
parents:
diff changeset
    87
class TSglQueIter : public TSglQueIterBase
089413cdde3c 201028_02
hgs
parents:
diff changeset
    88
	{
089413cdde3c 201028_02
hgs
parents:
diff changeset
    89
public:
089413cdde3c 201028_02
hgs
parents:
diff changeset
    90
	inline TSglQueIter(TSglQueBase& aQue);
089413cdde3c 201028_02
hgs
parents:
diff changeset
    91
	inline operator T*();
089413cdde3c 201028_02
hgs
parents:
diff changeset
    92
	inline T* operator++(TInt);
089413cdde3c 201028_02
hgs
parents:
diff changeset
    93
	};
089413cdde3c 201028_02
hgs
parents:
diff changeset
    94
089413cdde3c 201028_02
hgs
parents:
diff changeset
    95
//
089413cdde3c 201028_02
hgs
parents:
diff changeset
    96
// --- Inline implementations ---
089413cdde3c 201028_02
hgs
parents:
diff changeset
    97
//
089413cdde3c 201028_02
hgs
parents:
diff changeset
    98
089413cdde3c 201028_02
hgs
parents:
diff changeset
    99
// Class TSglQue
089413cdde3c 201028_02
hgs
parents:
diff changeset
   100
template<class T>
089413cdde3c 201028_02
hgs
parents:
diff changeset
   101
inline TSglQue<T>::TSglQue(TInt aOffset)
089413cdde3c 201028_02
hgs
parents:
diff changeset
   102
	: TSglQueBase(aOffset)
089413cdde3c 201028_02
hgs
parents:
diff changeset
   103
	{}
089413cdde3c 201028_02
hgs
parents:
diff changeset
   104
089413cdde3c 201028_02
hgs
parents:
diff changeset
   105
089413cdde3c 201028_02
hgs
parents:
diff changeset
   106
template<class T>
089413cdde3c 201028_02
hgs
parents:
diff changeset
   107
inline void TSglQue<T>::AddLast(T& aRef)
089413cdde3c 201028_02
hgs
parents:
diff changeset
   108
	{
089413cdde3c 201028_02
hgs
parents:
diff changeset
   109
	DoAddLast(&aRef);
089413cdde3c 201028_02
hgs
parents:
diff changeset
   110
	}
089413cdde3c 201028_02
hgs
parents:
diff changeset
   111
089413cdde3c 201028_02
hgs
parents:
diff changeset
   112
089413cdde3c 201028_02
hgs
parents:
diff changeset
   113
template<class T>
089413cdde3c 201028_02
hgs
parents:
diff changeset
   114
inline void TSglQue<T>::Remove(T& aRef)
089413cdde3c 201028_02
hgs
parents:
diff changeset
   115
	{
089413cdde3c 201028_02
hgs
parents:
diff changeset
   116
	DoRemove(&aRef);
089413cdde3c 201028_02
hgs
parents:
diff changeset
   117
	}
089413cdde3c 201028_02
hgs
parents:
diff changeset
   118
089413cdde3c 201028_02
hgs
parents:
diff changeset
   119
089413cdde3c 201028_02
hgs
parents:
diff changeset
   120
template<class T>
089413cdde3c 201028_02
hgs
parents:
diff changeset
   121
inline TInt TSglQue<T>::Elements() const
089413cdde3c 201028_02
hgs
parents:
diff changeset
   122
	{
089413cdde3c 201028_02
hgs
parents:
diff changeset
   123
	return iElements;
089413cdde3c 201028_02
hgs
parents:
diff changeset
   124
	}
089413cdde3c 201028_02
hgs
parents:
diff changeset
   125
089413cdde3c 201028_02
hgs
parents:
diff changeset
   126
089413cdde3c 201028_02
hgs
parents:
diff changeset
   127
// Class TSglQueIter
089413cdde3c 201028_02
hgs
parents:
diff changeset
   128
template<class T>
089413cdde3c 201028_02
hgs
parents:
diff changeset
   129
inline TSglQueIter<T>::TSglQueIter(TSglQueBase& aQue)
089413cdde3c 201028_02
hgs
parents:
diff changeset
   130
	: TSglQueIterBase(aQue)
089413cdde3c 201028_02
hgs
parents:
diff changeset
   131
	{}
089413cdde3c 201028_02
hgs
parents:
diff changeset
   132
089413cdde3c 201028_02
hgs
parents:
diff changeset
   133
089413cdde3c 201028_02
hgs
parents:
diff changeset
   134
template<class T>
089413cdde3c 201028_02
hgs
parents:
diff changeset
   135
inline TSglQueIter<T>::operator T*()
089413cdde3c 201028_02
hgs
parents:
diff changeset
   136
	{
089413cdde3c 201028_02
hgs
parents:
diff changeset
   137
	return ((T*)DoCurrent());
089413cdde3c 201028_02
hgs
parents:
diff changeset
   138
	}
089413cdde3c 201028_02
hgs
parents:
diff changeset
   139
089413cdde3c 201028_02
hgs
parents:
diff changeset
   140
template<class T>
089413cdde3c 201028_02
hgs
parents:
diff changeset
   141
inline T* TSglQueIter<T>::operator++(TInt)
089413cdde3c 201028_02
hgs
parents:
diff changeset
   142
	{
089413cdde3c 201028_02
hgs
parents:
diff changeset
   143
	return ((T*)DoPostInc());
089413cdde3c 201028_02
hgs
parents:
diff changeset
   144
	}
089413cdde3c 201028_02
hgs
parents:
diff changeset
   145
089413cdde3c 201028_02
hgs
parents:
diff changeset
   146
089413cdde3c 201028_02
hgs
parents:
diff changeset
   147
#endif	// __USBCQUE_H__