summaryrefslogtreecommitdiffstats
path: root/src/libs/xpcom18a4/ipc/ipcd/shared/src/ipcList.h
blob: a9b9c95909f4429dd4b42b18c1bbcf96fee28262 (plain)
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
208
209
210
211
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Mozilla IPC.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Darin Fisher <darin@netscape.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef ipcList_h__
#define ipcList_h__

#include "prtypes.h"

//-----------------------------------------------------------------------------
// simple list of singly-linked objects.  class T must have the following
// structure:
//
//   class T {
//   ...
//   public:
//     T *mNext;
//   };
//
// objects added to the list must be allocated with operator new.  class T may
// optionally inherit from ipcListNode<T> if it doesn't wish to define mNext
// explicitly.
//-----------------------------------------------------------------------------

template<class T>
class ipcList
{
public:
    ipcList()
        : mHead(NULL)
        , mTail(NULL)
        { }
   ~ipcList() { DeleteAll(); }

    //
    // prepends obj at the beginning of the list.
    //
    void Prepend(T *obj)
    {
        obj->mNext = mHead;
        mHead = obj;
        if (!mTail)
            mTail = mHead;
    }

    //
    // appends obj to the end of the list.
    //
    void Append(T *obj)
    {
        obj->mNext = NULL;
        if (mTail) {
            mTail->mNext = obj;
            mTail = obj;
        }
        else
            mTail = mHead = obj;
    }

    //
    // inserts b into the list after a.
    //
    void InsertAfter(T *a, T *b)
    {
        b->mNext = a->mNext;
        a->mNext = b;
        if (mTail == a)
            mTail = b;
    }

    // 
    // removes first element w/o deleting it
    //
    void RemoveFirst()
    {
        if (mHead)
            AdvanceHead();
    }

    //
    // removes element after the given element w/o deleting it
    //
    void RemoveAfter(T *obj)
    {
        T *rej = obj->mNext;
        if (rej) {
            obj->mNext = rej->mNext;
            if (rej == mTail)
                mTail = obj;
        }
    }

    //
    // deletes first element
    //
    void DeleteFirst()
    {
        T *first = mHead;
        if (first) {
            AdvanceHead();
            delete first;
        }
    }

    //
    // deletes element after the given element
    //
    void DeleteAfter(T *obj)
    {
        T *rej = obj->mNext;
        if (rej) {
            RemoveAfter(obj);
            delete rej;
        }
    }

    //
    // deletes all elements
    //
    void DeleteAll()
    {
        while (mHead)
            DeleteFirst();
    }

    const T *First() const { return mHead; }
    T       *First()       { return mHead; }
    const T *Last() const  { return mTail; }
    T       *Last()        { return mTail; }

    PRBool  IsEmpty() const { return mHead == NULL; }

    //
    // moves contents of list to another list
    //
    void MoveTo(ipcList<T> &other)
    {
        other.mHead = mHead;
        other.mTail = mTail;
        mHead = NULL;
        mTail = NULL;
    }

    // gets count of list elements
    PRUint32 Count()
    {
        T *obj = mHead;
        PRUint32 count = 0;
        while (obj) {
            count++;
            obj = obj->mNext;
        }

        return count;
    }

protected:
    void AdvanceHead()
    {
        mHead = mHead->mNext;
        if (!mHead)
            mTail = NULL;
    }

    T *mHead;
    T *mTail;
};

template<class T>
class ipcListNode
{
public:
    ipcListNode() : mNext(nsnull) {}

    T *mNext;
};

#endif // !ipcList_h__