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
|
/* The class definition for the root of the hierarchy */
/* pool.c: PROTOCOL IMPLEMENTATION
*
* $Id$
* Copyright (c) 2001-2020 Ravenbrook Limited. See end of file for license.
*
* <design/protocol>.
*/
#include "mpm.h"
#include "protocol.h"
SRCID(protocol, "$Id$");
/* The class definitions for the root of the hierarchy */
static void InstClassInitInternal(InstClass klass);
DEFINE_CLASS(Inst, Inst, klass)
{
InstClassInitInternal(klass);
klass->instStruct.klass = CLASS(InstClass);
AVERT(InstClass, klass);
}
DEFINE_CLASS(Inst, InstClass, klass)
{
/* Can't use INHERIT_CLASS(klass, InstClass, Inst) here because it
causes infinite regression, so we have to set this one up by
hand. */
InstClassInitInternal(klass);
klass->superclass = &CLASS_STATIC(Inst);
klass->name = "InstClass";
klass->level = ClassLevelInstClass;
klass->display[ClassLevelInstClass] = CLASS_ID(InstClass);
AVERT(InstClass, klass);
}
static void InstClassInitInternal(InstClass klass)
{
ClassLevel i;
klass->name = "Inst";
klass->superclass = NULL;
for (i = 0; i < ClassDEPTH; ++i)
klass->display[i] = NULL;
klass->level = 0;
klass->display[klass->level] = CLASS_ID(Inst);
/* Generic methods */
klass->describe = InstDescribe;
klass->finish = InstFinish;
klass->init = InstInit;
/* We can't call CLASS(InstClass) here because it causes a loop back
to here, so we have to tie this knot specially. */
klass->instStruct.klass = &CLASS_STATIC(InstClass);
klass->sig = InstClassSig;
AVERT(InstClass, klass);
}
/* InstClassCheck -- check a protocol class */
Bool InstClassCheck(InstClass klass)
{
ClassLevel i;
CHECKS(InstClass, klass);
CHECKL(klass->name != NULL);
CHECKL(klass->level < ClassDEPTH);
for (i = 0; i <= klass->level; ++i) {
CHECKL(klass->display[i] != NULL);
}
for (i = klass->level + 1; i < ClassDEPTH; ++i) {
CHECKL(klass->display[i] == NULL);
}
CHECKL(FUNCHECK(klass->describe));
CHECKL(FUNCHECK(klass->finish));
CHECKL(FUNCHECK(klass->init));
return TRUE;
}
/* InstInit -- initialize a protocol instance
*
* Initialisation makes the instance valid, so that it will pass
* InstCheck, and the instance can be specialized to be a member of a
* subclass.
*/
void InstInit(Inst inst)
{
AVER(inst != NULL);
inst->klass = CLASS(Inst);
AVERC(Inst, inst);
}
/* InstFinish -- finish a protocol instance
*
* Finishing makes the instance invalid, so that it will fail
* InstCheck and can't be used.
*/
static InstClassStruct invalidClassStruct = {
/* .instStruct = */ {&invalidClassStruct},
/* .sig = */ SigInvalid,
/* .name = */ "Invalid",
/* .superclass = */ &invalidClassStruct,
/* .level = */ 0,
/* .display = */ {(ClassId)&invalidClassStruct},
/* .describe = */ NULL,
/* .finish = */ NULL,
/* .init = */ NULL,
};
void InstFinish(Inst inst)
{
AVERC(Inst, inst);
inst->klass = &invalidClassStruct;
}
/* InstCheck -- check a protocol instance */
Bool InstCheck(Inst inst)
{
CHECKD(InstClass, inst->klass);
return TRUE;
}
void ClassRegister(InstClass klass)
{
Word classId;
/* label the pool class with its name */
EventInit();
classId = EventInternString(ClassName(klass));
EventLabelPointer(klass, classId);
}
Res InstDescribe(Inst inst, mps_lib_FILE *stream, Count depth)
{
InstClass klass;
if (!TESTC(Inst, inst))
return ResPARAM;
if (stream == NULL)
return ResPARAM;
klass = ClassOfPoly(Inst, inst);
return WriteF(stream, depth,
"$S $P\n", (WriteFS)ClassName(klass), inst,
NULL);
}
/* 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.
*/
|
