File: objects.htm

package info (click to toggle)
nyquist 3.23%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 58,064 kB
  • sloc: ansic: 74,758; lisp: 18,104; java: 10,719; cpp: 6,688; sh: 171; xml: 58; makefile: 40; python: 15
file content (358 lines) | stat: -rw-r--r-- 11,923 bytes parent folder | download | duplicates (7)
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
<html><head><title>XLISP: An Object-oriented Lisp</title></head>

<link rel="stylesheet" type="text/css" href="manual.css">

<body>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="../reference/reference-index.htm">Reference</a>

<hr>

<h1>XLISP Object System</h1>

<hr>

<ol>
<li><nobr><a href="#1">Definitions</a></nobr></li>
<ul>
<li><nobr><a href="#define-selector">selector</a> - a symbol used to select an appropriate method</nobr></li>
<li><nobr><a href="#define-message">message</a> - a selector and a list of actual arguments</nobr></li>
<li><nobr><a href="#define-method">method</a> - the code that implements a message</nobr></li>
<li><nobr><a href="#define-object">object</a> - the top of the class hierarchy</nobr></li>
<li><nobr><a href="#define-class">class</a> - the class of all object classes</nobr></li>
</ul>
<li><nobr><a href="#2">The 'send' Function</a></nobr></li>
<li><nobr><a href="#3">The 'self' Symbol</a></nobr></li>
<li><nobr><a href="#4">The 'send-super' Function</a></nobr></li>
<li><nobr><a href="#5">The 'object' Class</a></nobr></li>
<ul>
<li><nobr><a href="#object">object</a> - the top of the class hierarchy</nobr></li>
<ul>
<li><nobr><a href="#object-show">:show</a> - show an object's instance variables</nobr></li>
<li><nobr><a href="#object-class">:class</a> - return the class of an object</nobr></li>
<li><nobr><a href="#object-isnew">:isnew</a> - the default object initialization routine</nobr></li>
<li><nobr><a href="#send-super">send-super</a> - send superclass a message</nobr></li>
</ul>
</ul>
<li><nobr><a href="#6">The 'class' Class</a></nobr></li>
<ul>
<li><nobr><a href="#class">class</a> - class of all object classes</nobr></li>
<ul>
<li><nobr><a href="#class-new">:new</a> - create a new instance of a class</nobr></li>
<li><nobr><a href="#class-isnew">:isnew</a> - initialize a new class</nobr></li>
<li><nobr><a href="#class-answer">:answer</a> - add a message to a class</nobr></li>
</ul>
</ul>
</ol>

<a name="1"></a>
<a name="define-selector"></a>
<a name="define-message"></a>
<a name="define-method"></a>
<a name="define-object"></a>
<a name="define-class"></a>

<hr>

<h2>1&nbsp; Definitions</h2>

<hr>

<p><div class="box">

<p><table cellpadding="0" cellspacing="0"><tbody>
<tr>
  <td align="right"><nobr>selector</nobr></td>
  <td valign="top"><nobr>&nbsp;&mdash;&nbsp;</nobr></td>
  <td width="100%"><nobr>a symbol used to select an appropriate method, usually a keyword</nobr></td>
</tr>
<tr>
  <td align="right"><nobr>message</nobr></td>
  <td valign="top"><nobr>&nbsp;&mdash;&nbsp;</nobr></td>
  <td width="100%"><nobr>a selector symbol and a list of actual arguments</nobr></td>
</tr>
<tr>
  <td align="right"><nobr>method</nobr></td>
  <td valign="top"><nobr>&nbsp;&mdash;&nbsp;</nobr></td>
  <td width="100%"><nobr>the Lisp code that implements a message</nobr></td>
</tr>
<tr>
  <td align="right"><nobr><a href="../reference/object.htm">object</a></nobr></td>
  <td valign="top"><nobr>&nbsp;&mdash;&nbsp;</nobr></td>
  <td width="100%"><nobr>the top of the class hierarchy</nobr></td>
</tr>
<tr>
  <td align="right"><nobr><a href="../reference/class.htm">class</a></nobr></td>
  <td valign="top"><nobr>&nbsp;&mdash;&nbsp;</nobr></td>
  <td width="100%"><nobr>the class of all object classes [including itself]</nobr></td>
</tr>
</tbody></table></p>

</div></p>

<p>Since XLISP was created to provide a simple basis for experimenting with
<nobr>object-oriented</nobr> programming, one of the primitive data types
included is <a href="../reference/object.htm">object</a>. <nobr>In
XLISP</nobr>, an object consists of a data structure containing a pointer to
the object's <a href="../reference/class.htm">class</a> as well as an array
containing the values of the object's instance variables.</p>

<p>Officially, there is no way to see inside an object [look at the values
of its instance variables]. The only way to communicate with an object is by
sending it a message.</p>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</a></nobr></p>

<a name="2"></a>

<hr>

<h2>2&nbsp; The 'send' Function</h2>

<hr>

<p>You can send a message to an object using the
<a href="../reference/send.htm">send</a> function:</p>

<p><div class="box">

<dl>
<dt>(<b>send</b> <i>object selector</i> [<i>args</i>])</dt>
<dd><i>object</i> - an <a href="object.htm">object</a><br>
<i>selector</i> - message selector for <i>object</i><br>
<i>arg</i> - parameter sent to <i>object</i> method<br>
returns - the <i>object</i></dd>
</dl>

</div></p>

<p>The <a href="../reference/send.htm">send</a> function takes the object as
its first argument, the message selector as its second argument [which must
be a symbol] and the message arguments as its remaining arguments. <nobr>It
determines</nobr> the class of the receiving object and attempts to find a
method corresponding to the message selector in the set of messages defined
for that class. <nobr>If the</nobr> message is not found in the object's
class and the class has a <nobr>super-class</nobr>, the search continues by
looking at the messages defined for the <nobr>super-class</nobr>. This
process continues from one <nobr>super-class</nobr> to the next until a
method for the message is found. <nobr>If no</nobr> method is found, an
error occurs.</p>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</a></nobr></p>

<a name="3"></a>

<hr>

<h2>3&nbsp; The 'self' Symbol</h2>

<hr>

<p>When a method is found, the evaluator binds the receiving object to the
symbol <a href="../reference/self.htm">self</a> and evaluates the method
using the remaining elements of the original list as arguments to the
method. These arguments are always evaluated prior to being bound to their
corresponding formal arguments. The result of evaluating the method becomes
the result of the expression.</p>

<p>Within the body of a method, a message can be sent to the current object
by calling:</p>

<pre class="example">
(send self ... )
</pre>

<p>The method lookup starts with the object's class regardless of the class
containing the current method.</p>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</a></nobr></p>

<a name="4"></a>

<hr>

<h2>4&nbsp; The 'send-super' Function</h2>

<hr>

<p>Sometimes it is desirable to invoke a general method in a superclass even
when it is overridden by a more specific method in a subclass. This can be
accomplished by calling <a
href="../reference/send-super.htm">send-super</a>, which begins the
method lookup in the superclass of the class defining the current method
rather than in the class of the current object:</p>

<p><div class="box">

<dl>
<dt>(<b>send-super</b> <i>selector</i> [<i>args</i>])</dt>
<dd><i>selector</i> - the message selector<br>
<i>args</i> - the optional message arguments<br>
returns - the result of sending the message</dd>
</dl>

</div></p>

<p>The <a href="../reference/send-super.htm">send-super</a> function
takes a selector as its first argument [which must be a symbol] and the
message arguments as its remaining arguments. Notice that <a
href="../reference/send-super.htm">send-super</a> can only be sent from
within a method, and the target of the message is always the current object
<a href="../reference/self.htm">self</a>.</p>

<pre class="example">
(send-super ... )
</pre>

<p>is similar to:</p>

<pre class="example">
(send self ... )
</pre>

<p>except that method lookup begins in the superclass of the class
containing the current method rather than the class of the current
object.</p>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</a></nobr></p>

<a name="5"></a>
<a name="object"></a>
<a name="object-show"></a>
<a name="object-class"></a>
<a name="object-isnew"></a>
<a name="send-super"></a>

<hr>

<h2>5&nbsp; The 'object' Class</h2>

<hr>

<p><div class="box">

<p><a href="../reference/object.htm">object</a> - the top of the class hierarchy.</p>

</div></p>

<p>Messages:</p>

<p><div class="box">

<dl>

<dt>(<a href="../reference/send.htm">send</a> <i>object</i> <a href="../reference/keyword-show.htm">:show</a>)
- show an object's instance variables.</dt>
<dd>returns - the object</dd>

<br>

<dt>(<a href="../reference/send.htm">send</a> <i>object</i> <a href="../reference/keyword-class.htm">:class</a>)
- return the class of an object</dt>
<dd>returns - the class of the object</dd>

<br>

<dt>(<a href="../reference/send.htm">send</a> <i>object</i> <a href="../reference/keyword-isnew.htm">:isnew</a> <i>args</i>)
- run the default object initialization routine</dt>
<dd>returns - the object</dd>

<br>

<dt>(<a href="../reference/send.htm">send</a> <i>object</i> <a href="../reference/keyword-isa.htm">:isa</a> <i>class</i>)
- test if <i>object</i> inherits from <i>class</i></dt>
<dd>returns - <a href="../reference/t.htm">&nbsp;T&nbsp;</a> if object
is an instance of class or a subclass of class, otherwise
<a href="../reference/nil.htm">NIL</a></dd>

</dl>

</div></p>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</a></nobr></p>

<a name="6"></a>
<a name="class"></a>
<a name="class-new"></a>
<a name="class-isnew"></a>
<a name="class-answer"></a>

<hr>

<h2>6&nbsp; The 'class' Class</h2>

<hr>

<p><div class="box">

<p><a href="../reference/class.htm">class</a>
 - class of all object classes (including itself)</p>

</div></p>

<p>Messages:</p>

<p><div class="box">

<dl>

<dt>(<a href="../reference/send.htm">send</a> <i>class</i> <a href="../reference/keyword-new.htm">:new</a> <i>ivars</i> [<i>cvars</i> [<i>super</i>]])
 - create a new instance of a class</dt>
<dd>returns -    the new class object</dd>

<br>

<dt>(<a href="../reference/send.htm">send</a> <i>class</i> <a href="../reference/keyword-isnew.htm">:isnew</a> <i>ivars</i> [<i>cvars</i> [<i>super</i>]])
 - initialize a new class</dt>
<dd><i>ivars</i> - list of instance variable symbols<br>
<i>cvars</i> - list of class variable symbols<br>
<i>super</i> - the superclass, default is <a href="../reference/object.htm">object</a><br>
returns - the new class object</dd>

<br>

<dt>(<a href="../reference/send.htm">send</a> <i>class</i> <a href="../reference/keyword-answer.htm">:answer</a> <i>selector</i> <i>fargs</i> <i>body</i>)
 - add a message to a class</dt>
<dd><i>selector</i> - a message selector symbol<br>
<i>fargs</i> - the formal argument list, a lambda list<br>
<i>body</i> - a list of executable expressions<br>
returns - the object</dd>

</dl>

</div></p>

<p>When a new instance of a
<a href="../reference/class.htm">class</a> is created by sending
the message <a href="../reference/keyword-new.htm">:new</a>
to an existing <a href="../reference/class.htm">class</a>, the
message <a href="../reference/keyword-isnew.htm">:isnew</a> followed by
whatever parameters were passed to the
<a href="../reference/keyword-new.htm">:new</a> message is sent to the
newly created <a href="../reference/object.htm">object</a>.</p>

<p>When a new <a href="../reference/class.htm">class</a> is created
by sending the <a href="../reference/keyword-new.htm">:new</a> message to
the object <a href="../reference/class.htm">class</a>, an optional
parameter may be specified indicating the superclass of the new
<a href="../reference/class.htm">class</a>. If this parameter is
omitted, the new <a href="../reference/class.htm">class</a> will be
a subclass of <a href="../reference/object.htm">object</a>. A
<a href="../reference/class.htm">class</a> inherits all instance
variables, class variables, and methods from its superclass.</p>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</a></nobr></p>

<hr>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="../reference/reference-index.htm">Reference</a>

</body></html>