File: PtrList.h

package info (click to toggle)
capi4hylafax 1%3A01.02.03-10sarge2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 2,856 kB
  • ctags: 2,966
  • sloc: cpp: 20,126; sh: 7,703; makefile: 215; perl: 36
file content (207 lines) | stat: -rw-r--r-- 7,109 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/*---------------------------------------------------------------------------*\

    Copyright (C) 2000 AVM GmbH. All rights reserved.

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation; either version 2
    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY, without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, and WITHOUT
    ANY LIABILITY FOR ANY DAMAGES arising out of or in connection
    with the use or performance of this software. See the
    GNU General Public License for further details.

\*---------------------------------------------------------------------------*/

#ifndef _PTRLIST_H_
#define _PTRLIST_H_

#include "aTypes.h"

/*===========================================================================*\
\*===========================================================================*/

class CPointerListElement {
public:
    typedef tResult (*ctFindFunc) (CPointerListElement *pElement, void *RefData);

    CPointerListElement (void);
    virtual ~CPointerListElement (void);

    CPointerListElement *GetNext (void);
    CPointerListElement *GetPrev (void);
    void AddAfter (CPointerListElement *pElement);
    void AddBefore (CPointerListElement *pElement);
    void Exchange (CPointerListElement *pElement);
    void RemoveFromList (void);
    CPointerListElement *RemoveAfter (void);
    CPointerListElement *RemoveBefore (void);

    tResult FindFwd (ctFindFunc func, void *RefData, CPointerListElement **ppFoundElement = 0);  // the search begin at GetNext();
    tResult FindRev (ctFindFunc func, void *RefData, CPointerListElement **ppFoundElement = 0);  // the search begin at GetPrev();

private:
    void InternalRemove (void);

    CPointerListElement *pNext;
    CPointerListElement *pPrev;
};


/*===========================================================================*\
\*===========================================================================*/

class CPointerList {
public:
    typedef tResult (*ctFindFunc) (CPointerListElement *pElement, void *RefData);

    CPointerList (void);
    virtual ~CPointerList (void);
    tBool IsEmpty (void);
    tUInt CountElements (void);

    CPointerListElement *GetFirst (void);
    CPointerListElement *GetLast (void);
    void AddFirst (CPointerListElement *pElement);
    void AddLast (CPointerListElement *pElement);

    CPointerListElement *RemoveFirst (void);
    CPointerListElement *RemoveLast (void);
    void RemoveAndDeleteAll (void);

    tResult FindFwd (ctFindFunc func, void *RefData, CPointerListElement **ppFoundElement = 0);  // the search begin at GetFirst();
    tResult FindRev (ctFindFunc func, void *RefData, CPointerListElement **ppFoundElement = 0);  // the search begin at GetLast();

private:
    CPointerListElement Head;
    CPointerListElement Tail;
};


/*===========================================================================*\
    inline Functions for CPointerListElement
\*===========================================================================*/

#include "dbgSTD.h"

inline CPointerListElement::CPointerListElement (void)
  : pNext (0),
    pPrev (0) {
    dhead ("CPointerListElement-Constructor", DCON_CPointerList);
}

inline CPointerListElement *CPointerListElement::GetNext (void) {
    dhead ("CPointerListElement::GetNext", DCON_CPointerList);
    dassert (pNext != 0);
    // the last element is for list managing only
    CPointerListElement *fret = pNext;
    RETURN ('x', (fret->pNext) ? fret : 0);
}

inline CPointerListElement *CPointerListElement::GetPrev (void) {
    dhead ("CPointerListElement::GetPrev", DCON_CPointerList);
    dassert (pPrev != 0);
    // the first element is for list managing only
    CPointerListElement *fret = pPrev;
    RETURN ('x',(fret->pPrev) ? fret : 0);
}

inline void CPointerListElement::Exchange (CPointerListElement *pElement) {
    dhead ("CPointerListElement::Exchange", DCON_CPointerList);
    dassert (pElement != 0);
    AddBefore (pElement);
    RemoveFromList();
}

inline void CPointerListElement::RemoveFromList (void) {
    dhead ("CPointerListElement::RemoveFromList", DCON_CPointerList);
    dparams ("%x", this);
    InternalRemove();
}

inline CPointerListElement *CPointerListElement::RemoveAfter (void) {
    dhead ("CPointerListElement::RemoveAfter", DCON_CPointerList);
    CPointerListElement *fret = 0;
    if (pNext && pNext->pNext) {
        fret = pNext;
        fret->InternalRemove();
    }
    RETURN ('x', fret);
}

inline CPointerListElement *CPointerListElement::RemoveBefore (void) {
    dhead ("CPointerListElement::RemoveBefore", DCON_CPointerList);
    CPointerListElement *fret = 0;
    if (pPrev && pPrev->pPrev) {
        fret = pPrev;
        fret->InternalRemove();
    }
    RETURN ('x', fret);
}


/*===========================================================================*\
    inline Functions for CPointerList
\*===========================================================================*/

inline CPointerList::CPointerList (void) {
    dhead ("CPointerList-Constructor", DCON_CPointerList);
    // initialize the list
    Head.AddAfter (&Tail);
}

inline tBool CPointerList::IsEmpty (void) {
    dhead ("CPointerList::IsEmpty", DCON_CPointerList);
    return (Head.GetNext() == 0) ? vTrue : vFalse;
}

inline CPointerListElement *CPointerList::GetFirst (void) {
    dhead ("CPointerList::GetFirst", DCON_CPointerList);
    return Head.GetNext();
}

inline CPointerListElement *CPointerList::GetLast (void) {
    dhead ("CPointerList::GetLast", DCON_CPointerList);
    return Tail.GetPrev();
}

inline void CPointerList::AddFirst (CPointerListElement *pElement) {
    dhead ("CPointerList::AddFirst", DCON_CPointerList);
    dparams ("%x", pElement);
    Head.AddAfter (pElement);
}

inline void CPointerList::AddLast (CPointerListElement *pElement) {
    dhead ("CPointerList::AddLast", DCON_CPointerList);
    dparams ("%x", pElement);
    Tail.AddBefore (pElement);
}

inline CPointerListElement *CPointerList::RemoveFirst (void) {
    dhead ("CPointerList::RemoveFirst", DCON_CPointerList);
    return Head.RemoveAfter();
}

inline CPointerListElement *CPointerList::RemoveLast (void) {
    dhead ("CPointerList::RemoveLast", DCON_CPointerList);
    return Tail.RemoveBefore();
}

inline tResult CPointerList::FindFwd (ctFindFunc func, void *RefData, CPointerListElement **ppFoundElement) {
    dhead ("CPointerList::FindFwd", DCON_CPointerList);
    return Head.FindFwd (func, RefData, ppFoundElement);
}

inline tResult CPointerList::FindRev (ctFindFunc func, void *RefData, CPointerListElement **ppFoundElement) {
    dhead ("CPointerList::FindRev", DCON_CPointerList);
    return Tail.FindRev (func, RefData, ppFoundElement);
}

/*===========================================================================*\
\*===========================================================================*/

#endif