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
|
/* ring.c: RING IMPLEMENTATION
*
* $Id$
* Copyright (c) 2001-2020 Ravenbrook Limited. See end of file for license.
*
* .intro: This is a portable implementation of Rings.
*
* .purpose: Rings are used to manage potentially unbounded collections
* of things.
*
* .sources: <design/ring>
*/
#include "ring.h"
#include "check.h"
#include "misc.h"
SRCID(ring, "$Id$");
/* RingCheck, RingCheckSingle -- check the validity of a ring node
*
* RingCheck performs a consistency check on the ring node
* <design/ring#check>. RingCheckSingle performs the same check, but
* also checks that the ring node is a singleton
* <design/ring#.check.single>.
*/
Bool RingCheck(Ring ring)
{
CHECKL(ring != NULL);
CHECKL(ring->next != NULL);
CHECKL(ring->next->prev == ring);
CHECKL(ring->prev != NULL);
CHECKL(ring->prev->next == ring);
UNUSED(ring); /* <code/mpm.c#check.unused> */
return TRUE;
}
Bool RingCheckSingle(Ring ring)
{
CHECKL(RingCheck(ring));
CHECKL(ring->next == ring);
CHECKL(ring->prev == ring);
UNUSED(ring); /* <code/mpm.c#check.unused> */
return TRUE;
}
/* RingIsSingle -- return true if ring is a singleton
*
* <design/ring#.is.single>
*/
Bool RingIsSingle(Ring ring)
{
AVERT(Ring, ring);
return (ring->next == ring);
}
/* RingLength -- return the number of nodes in the ring, not including
* this node
*
* <design/ring#.length>
*/
Count RingLength(Ring ring)
{
Count length = 0;
Ring node, next;
AVERT(Ring, ring);
RING_FOR(node, ring, next)
++ length;
return length;
}
/* RingInit -- initialize a ring node
*/
void (RingInit)(Ring ring)
{
RingInit(ring); /* <code/mpm.h#ring.init> */
}
/* RingFinish -- finish a ring node
*/
void (RingFinish)(Ring ring)
{
RingFinish(ring); /* <code/mpm.h#ring.finish> */
}
/* RingAppend -- add a ring node to the end of a ring
*/
void (RingAppend)(Ring ring, Ring new)
{
RingAppend(ring, new); /* <code/mpm.h#ring.append> */
}
/* RingInsert -- add a ring node to the start of a ring
*/
void (RingInsert)(Ring ring, Ring new)
{
RingInsert(ring, new); /* <code/mpm.h#ring.insert> */
}
/* RingRemove -- remove a node from a ring
*/
void (RingRemove)(Ring old)
{
RingRemove(old); /* <code/mpm.h#ring.remove> */
}
/* RingNext -- get the next element of a ring
*/
Ring (RingNext)(Ring ring)
{
return RingNext(ring); /* <code/mpm.h#ring.next> */
}
/* RingPrev -- get the previous element of a ring
*/
Ring (RingPrev)(Ring ring)
{
return RingPrev(ring); /* <code/mpm.h#ring.prev> */
}
/* RING_ELT -- get the ring element structure
*
* RING_ELT has no function (as it does not have function-like
* behaviour), and is defined in <code/mpm.h#ring.elt>.
*/
/* RING_FOR -- ring iterator construct
*
* RING_FOR has no function (as it does not have function-like
* behaviour), and is defined in <code/mpm.h#ring.for>.
*/
/* C. COPYRIGHT AND LICENSE
*
* Copyright (C) 2001-2020 Ravenbrook Limited <https://www.ravenbrook.com/>.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
|
