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