Debian Codegraph @

info/gcl-si/Symbols.html

raw ◀ ▶
Source reconstructed at patch state 0 of 1 — not the installed (fully patched) source.
1 Debian patch touch this file
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <title>Symbols (GCL SI Manual)</title>
7
8 <meta name="description" content="Symbols (GCL SI Manual)">
9 <meta name="keywords" content="Symbols (GCL SI Manual)">
10 <meta name="resource-type" content="document">
11 <meta name="distribution" content="global">
12 <meta name="Generator" content="makeinfo">
13 <link href="index.html" rel="start" title="Top">
14 <link href="Function-and-Variable-Index.html" rel="index" title="Function and Variable Index">
15 <link href="Function-and-Variable-Index.html#SEC_Contents" rel="contents" title="Table of Contents">
16 <link href="index.html" rel="up" title="Top">
17 <link href="Operating-System.html" rel="next" title="Operating System">
18 <link href="Compilation.html" rel="prev" title="Compilation">
19 <style type="text/css">
20 <!--
21 a.summary-letter {text-decoration: none}
22 blockquote.indentedblock {margin-right: 0em}
23 div.display {margin-left: 3.2em}
24 div.example {margin-left: 3.2em}
25 div.lisp {margin-left: 3.2em}
26 kbd {font-style: oblique}
27 pre.display {font-family: inherit}
28 pre.format {font-family: inherit}
29 pre.menu-comment {font-family: serif}
30 pre.menu-preformatted {font-family: serif}
31 span.nolinebreak {white-space: nowrap}
32 span.roman {font-family: initial; font-weight: normal}
33 span.sansserif {font-family: sans-serif; font-weight: normal}
34 ul.no-bullet {list-style: none}
35 -->
36 </style>
37
38
39 </head>
40
41 <body lang="en">
42 <span id="Symbols"></span><div class="header">
43 <p>
44 Next: <a href="Operating-System.html" accesskey="n" rel="next">Operating System</a>, Previous: <a href="Compilation.html" accesskey="p" rel="prev">Compilation</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> &nbsp; [<a href="Function-and-Variable-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
45 </div>
46 <hr>
47 <span id="Symbols-1"></span><h2 class="chapter">8 Symbols</h2>
48
49 <dl>
50 <dt id="index-GENSYM">Function: <strong>GENSYM</strong> <em>(&amp;optional (x nil))</em></dt>
51 <dd><p>Package:LISP
52 </p>
53 <p>Creates and returns a new uninterned symbol whose name is a prefix string
54 (defaults to &quot;G&quot;), followed by a decimal number. The number is incremented
55 by each call to GENSYM. X, if an integer, resets the counter. If X is a
56 string, it becomes the new prefix.
57 </p>
58
59 </dd></dl>
60
61 <dl>
62 <dt id="index-KEYWORDP">Function: <strong>KEYWORDP</strong> <em>(x)</em></dt>
63 <dd><p>Package:LISP
64 </p>
65 <p>Returns T if X is a symbol and it belongs to the KEYWORD package; NIL
66 otherwise.
67 </p>
68
69 </dd></dl>
70
71 <dl>
72 <dt id="index-REMPROP">Function: <strong>REMPROP</strong> <em>(symbol indicator)</em></dt>
73 <dd><p>Package:LISP
74 </p>
75 <p>Look on property list of SYMBOL for property with specified
76 INDICATOR. If found, splice this indicator and its value out of
77 the plist, and return T. If not found, returns NIL with no side effects.
78 </p>
79 </dd></dl>
80
81 <dl>
82 <dt id="index-SYMBOL_002dPACKAGE">Function: <strong>SYMBOL-PACKAGE</strong> <em>(symbol)</em></dt>
83 <dd><p>Package:LISP
84 </p>
85 <p>Returns the contents of the package cell of the symbol SYMBOL.
86 </p>
87
88 </dd></dl>
89
90 <dl>
91 <dt id="index-_002aPACKAGE_002a">Variable: <strong>*PACKAGE*</strong></dt>
92 <dd><p>Package:LISP
93 The current package.
94 </p>
95
96 </dd></dl>
97
98
99 <dl>
100 <dt id="index-SHADOWING_002dIMPORT">Function: <strong>SHADOWING-IMPORT</strong> <em>(symbols &amp;optional (package *package*))</em></dt>
101 <dd><p>Package:LISP
102 </p>
103 <p>Imports SYMBOLS into PACKAGE, disregarding any name conflict. If a symbol
104 of the same name is already present, then it is uninterned. SYMBOLS must
105 be a list of symbols or a symbol.
106 </p>
107
108 </dd></dl>
109
110 <dl>
111 <dt id="index-REMF">Macro: <strong>REMF</strong></dt>
112 <dd><p>Package:LISP
113 </p>
114 <p>Syntax:
115 </p><div class="example">
116 <pre class="example">(remf place indicator)
117 </pre></div>
118
119 <p>PLACE may be any place expression acceptable to SETF, and is expected
120 to hold a property list or NIL. This list is destructively altered to
121 remove the property specified by INDICATOR. Returns T if such a
122 property was present; NIL otherwise.
123 </p>
124
125 </dd></dl>
126
127 <dl>
128 <dt id="index-MAKUNBOUND">Function: <strong>MAKUNBOUND</strong> <em>(symbol)</em></dt>
129 <dd><p>Package:LISP
130 </p>
131 <p>Makes empty the value slot of SYMBOL. Returns SYMBOL.
132 </p>
133
134 </dd></dl>
135
136 <dl>
137 <dt id="index-USE_002dPACKAGE">Function: <strong>USE-PACKAGE</strong> <em>(packages-to-use &amp;optional (package *package*))</em></dt>
138 <dd><p>Package:LISP
139 </p>
140 <p>Adds all packages in PACKAGE-TO-USE list to the use list for PACKAGE so that
141 the external symbols of the used packages are available as internal symbols
142 in PACKAGE.
143 </p>
144
145 </dd></dl>
146
147 <dl>
148 <dt id="index-MAKE_002dSYMBOL">Function: <strong>MAKE-SYMBOL</strong> <em>(string)</em></dt>
149 <dd><p>Package:LISP
150 </p>
151 <p>Creates and returns a new uninterned symbol whose print name is STRING.
152 </p>
153
154 </dd></dl>
155
156 <dl>
157 <dt id="index-PSETQ">Special Form: <strong>PSETQ</strong></dt>
158 <dd><p>Package:LISP
159 </p>
160 <p>Syntax:
161 </p><div class="example">
162 <pre class="example">(psetq {var form}*)
163 </pre></div>
164
165 <p>Similar to SETQ, but evaluates all FORMs first, and then assigns each value to
166 the corresponding VAR. Returns NIL always.
167 </p>
168
169 </dd></dl>
170
171 <dl>
172 <dt id="index-PACKAGE_002dUSED_002dBY_002dLIST">Function: <strong>PACKAGE-USED-BY-LIST</strong> <em>(package)</em></dt>
173 <dd><p>Package:LISP
174 </p>
175 <p>Returns the list of packages that use PACKAGE.
176 </p>
177
178 </dd></dl>
179
180 <dl>
181 <dt id="index-SYMBOLP">Function: <strong>SYMBOLP</strong> <em>(x)</em></dt>
182 <dd><p>Package:LISP
183 </p>
184 <p>Returns T if X is a symbol; NIL otherwise.
185 </p>
186
187 </dd></dl>
188
189 <dl>
190 <dt id="index-NIL">Constant: <strong>NIL</strong></dt>
191 <dd><p>Package:LISP
192 Holds NIL.
193 </p>
194
195 </dd></dl>
196
197 <dl>
198 <dt id="index-SET">Function: <strong>SET</strong> <em>(symbol value)</em></dt>
199 <dd><p>Package:LISP
200 </p>
201 <p>Assigns the value of VALUE to the dynamic variable named by SYMBOL, and
202 returns the value assigned.
203 </p>
204
205 </dd></dl>
206
207 <dl>
208 <dt id="index-SETQ">Special Form: <strong>SETQ</strong></dt>
209 <dd><p>Package:LISP
210 </p>
211 <p>Syntax:
212 </p><div class="example">
213 <pre class="example">(setq {var form}*)
214 </pre></div>
215
216 <p>VARs are not evaluated and must be symbols. Assigns the value of the first
217 FORM to the first VAR, then assigns the value of the second FORM to the second
218 VAR, and so on. Returns the last value assigned.
219 </p>
220
221 </dd></dl>
222
223 <dl>
224 <dt id="index-UNUSE_002dPACKAGE">Function: <strong>UNUSE-PACKAGE</strong> <em>(packages-to-unuse &amp;optional (package *package*))</em></dt>
225 <dd><p>Package:LISP
226 </p>
227 <p>Removes PACKAGES-TO-UNUSE from the use list for PACKAGE.
228 </p>
229
230 </dd></dl>
231
232 <dl>
233 <dt id="index-T">Constant: <strong>T</strong></dt>
234 <dd><p>Package:LISP
235 Holds T.
236 </p>
237
238 </dd></dl>
239
240 <dl>
241 <dt id="index-PACKAGE_002dUSE_002dLIST">Function: <strong>PACKAGE-USE-LIST</strong> <em>(package)</em></dt>
242 <dd><p>Package:LISP
243 </p>
244 <p>Returns the list of packages used by PACKAGE.
245 </p>
246
247 </dd></dl>
248
249 <dl>
250 <dt id="index-LIST_002dALL_002dPACKAGES">Function: <strong>LIST-ALL-PACKAGES</strong> <em>()</em></dt>
251 <dd><p>Package:LISP
252 </p>
253 <p>Returns a list of all existing packages.
254 </p>
255
256 </dd></dl>
257
258 <dl>
259 <dt id="index-COPY_002dSYMBOL">Function: <strong>COPY-SYMBOL</strong> <em>(symbol &amp;optional (copy-props nil))</em></dt>
260 <dd><p>Package:LISP
261 </p>
262 <p>Returns a new uninterned symbol with the same print name as SYMBOL.
263 If COPY-PROPS is NIL, the function, the variable, and the property slots
264 of the new symbol have no value. Otherwise, these slots are given the
265 values of the corresponding slots of SYMBOL.
266 </p>
267
268 </dd></dl>
269
270 <dl>
271 <dt id="index-SYMBOL_002dPLIST">Function: <strong>SYMBOL-PLIST</strong> <em>(symbol)</em></dt>
272 <dd><p>Package:LISP
273 </p>
274 <p>Returns the property list of SYMBOL.
275 </p>
276
277 </dd></dl>
278
279 <dl>
280 <dt id="index-SYMBOL_002dNAME">Function: <strong>SYMBOL-NAME</strong> <em>(symbol)</em></dt>
281 <dd><p>Package:LISP
282 </p>
283 <p>Returns the print name of the symbol SYMBOL.
284 </p>
285
286 </dd></dl>
287
288 <dl>
289 <dt id="index-FIND_002dSYMBOL">Function: <strong>FIND-SYMBOL</strong> <em>(name &amp;optional (package *package*))</em></dt>
290 <dd><p>Package:LISP
291 </p>
292 <p>Returns the symbol named NAME in
293 PACKAGE. If such a symbol is found, then the second value is :INTERN,
294 :EXTERNAL, or :INHERITED to indicate how the symbol is accessible. If
295 no symbol is found then both values are NIL.
296 </p>
297
298 </dd></dl>
299
300 <dl>
301 <dt id="index-SHADOW">Function: <strong>SHADOW</strong> <em>(symbols &amp;optional (package *package*))</em></dt>
302 <dd><p>Package:LISP
303 </p>
304 <p>Creates an internal symbol in PACKAGE with the same name as each of the
305 specified SYMBOLS. SYMBOLS must be a list of symbols or a symbol.
306 </p>
307
308 </dd></dl>
309
310
311 <dl>
312 <dt id="index-FBOUNDP">Function: <strong>FBOUNDP</strong> <em>(symbol)</em></dt>
313 <dd><p>Package:LISP
314 </p>
315 <p>Returns T if SYMBOL has a global function definition or if SYMBOL names a
316 special form or a macro; NIL otherwise.
317 </p>
318
319 </dd></dl>
320
321 <dl>
322 <dt id="index-MACRO_002dFUNCTION">Function: <strong>MACRO-FUNCTION</strong> <em>(symbol)</em></dt>
323 <dd><p>Package:LISP
324 </p>
325 <p>If SYMBOL globally names a macro, then returns the expansion function.
326 Returns NIL otherwise.
327 </p>
328
329 </dd></dl>
330
331 <dl>
332 <dt id="index-IN_002dPACKAGE">Function: <strong>IN-PACKAGE</strong> <em>(package-name &amp;key (nicknames nil) (use '(lisp)))</em></dt>
333 <dd><p>Package:LISP
334 </p>
335 <p>Sets *PACKAGE* to the package with PACKAGE-NAME, creating the package if
336 it does not exist. If the package already exists then it is modified
337 to agree with USE and NICKNAMES arguments. Any new nicknames are added
338 without removing any old ones not specified. If any package in the USE list
339 is not currently used, then it is added to the use list.
340 </p>
341
342 </dd></dl>
343
344 <dl>
345 <dt id="index-MAKE_002dPACKAGE">Function: <strong>MAKE-PACKAGE</strong> <em>(package-name &amp;key (nicknames nil) (use '(lisp)))</em></dt>
346 <dd><p>Package:LISP
347 </p>
348 <p>Makes a new package having the specified PACKAGE-NAME and NICKNAMES. The
349 package will inherit all external symbols from each package in the USE list.
350 </p>
351
352 </dd></dl>
353
354 <dl>
355 <dt id="index-PACKAGE_002dSHADOWING_002dSYMBOLS">Function: <strong>PACKAGE-SHADOWING-SYMBOLS</strong> <em>(package)</em></dt>
356 <dd><p>Package:LISP
357 </p>
358 <p>Returns the list of symbols that have been declared as shadowing symbols
359 in PACKAGE.
360 </p>
361
362 </dd></dl>
363
364 <dl>
365 <dt id="index-INTERN">Function: <strong>INTERN</strong> <em>(name &amp;optional (package *package*))</em></dt>
366 <dd><p>Package:LISP
367 </p>
368 <p>Returns a symbol having the specified name, creating it if necessary.
369 Returns as the second value one of the symbols :INTERNAL, :EXTERNAL,
370 :INHERITED, and NIL.
371 </p>
372
373 </dd></dl>
374
375 <dl>
376 <dt id="index-EXPORT">Function: <strong>EXPORT</strong> <em>(symbols &amp;optional (package *package*))</em></dt>
377 <dd><p>Package:LISP
378 </p>
379 <p>Makes SYMBOLS external symbols of PACKAGE. SYMBOLS must be a list of symbols
380 or a symbol.
381 </p>
382
383 </dd></dl>
384
385 <dl>
386 <dt id="index-PACKAGEP">Function: <strong>PACKAGEP</strong> <em>(x)</em></dt>
387 <dd><p>Package:LISP
388 </p>
389 <p>Returns T if X is a package; NIL otherwise.
390 </p>
391
392 </dd></dl>
393
394 <dl>
395 <dt id="index-SYMBOL_002dFUNCTION">Function: <strong>SYMBOL-FUNCTION</strong> <em>(symbol)</em></dt>
396 <dd><p>Package:LISP
397 </p>
398 <p>Returns the current global function definition named by SYMBOL.
399 </p>
400
401 </dd></dl>
402
403 <dl>
404 <dt id="index-SYMBOL_002dVALUE">Function: <strong>SYMBOL-VALUE</strong> <em>(symbol)</em></dt>
405 <dd><p>Package:LISP
406 </p>
407 <p>Returns the current value of the dynamic (special) variable named by SYMBOL.
408 </p>
409
410 </dd></dl>
411
412 <dl>
413 <dt id="index-BOUNDP">Function: <strong>BOUNDP</strong> <em>(symbol)</em></dt>
414 <dd><p>Package:LISP
415 </p>
416 <p>Returns T if the global variable named by SYMBOL has a value; NIL otherwise.
417 </p>
418
419 </dd></dl>
420
421 <dl>
422 <dt id="index-DOCUMENTATION">Function: <strong>DOCUMENTATION</strong> <em>(symbol doc-type)</em></dt>
423 <dd><p>Package:LISP
424 </p>
425 <p>Returns the doc-string of DOC-TYPE for SYMBOL; NIL if none exists.
426 Possible doc-types are:
427 FUNCTION (special forms, macros, and functions)
428 VARIABLE (dynamic variables, including constants)
429 TYPE (types defined by DEFTYPE)
430 STRUCTURE (structures defined by DEFSTRUCT)
431 SETF (SETF methods defined by DEFSETF, DEFINE-SETF-METHOD, and
432 DEFINE-MODIFY-MACRO)
433 All built-in special forms, macros, functions, and variables have their
434 doc-strings.
435 </p>
436
437 </dd></dl>
438
439 <dl>
440 <dt id="index-GENTEMP">Function: <strong>GENTEMP</strong> <em>(&amp;optional (prefix &quot;t&quot;) (package *package*))</em></dt>
441 <dd><p>Package:LISP
442 </p>
443 <p>Creates a new symbol interned in the package PACKAGE with the given PREFIX.
444 </p>
445
446 </dd></dl>
447
448 <dl>
449 <dt id="index-RENAME_002dPACKAGE">Function: <strong>RENAME-PACKAGE</strong> <em>(package new-name &amp;optional (new-nicknames nil))</em></dt>
450 <dd><p>Package:LISP
451 </p>
452 <p>Replaces the old name and nicknames of PACKAGE with NEW-NAME and
453 NEW-NICKNAMES.
454 </p>
455
456 </dd></dl>
457
458 <dl>
459 <dt id="index-UNINTERN">Function: <strong>UNINTERN</strong> <em>(symbol &amp;optional (package *package*))</em></dt>
460 <dd><p>Package:LISP
461 </p>
462 <p>Makes SYMBOL no longer present in PACKAGE. Returns T if SYMBOL was present;
463 NIL otherwise. If PACKAGE is the home package of SYMBOL, then makes SYMBOL
464 uninterned.
465 </p>
466
467 </dd></dl>
468
469 <dl>
470 <dt id="index-UNEXPORT">Function: <strong>UNEXPORT</strong> <em>(symbols &amp;optional (package *package*))</em></dt>
471 <dd><p>Package:LISP
472 </p>
473 <p>Makes SYMBOLS no longer accessible as external symbols in PACKAGE. SYMBOLS
474 must be a list of symbols or a symbol.
475 </p>
476
477 </dd></dl>
478
479 <dl>
480 <dt id="index-PACKAGE_002dNICKNAMES">Function: <strong>PACKAGE-NICKNAMES</strong> <em>(package)</em></dt>
481 <dd><p>Package:LISP
482 </p>
483 <p>Returns as a list the nickname strings for the specified PACKAGE.
484 </p>
485
486 </dd></dl>
487
488 <dl>
489 <dt id="index-IMPORT">Function: <strong>IMPORT</strong> <em>(symbols &amp;optional (package *package*))</em></dt>
490 <dd><p>Package:LISP
491 </p>
492 <p>Makes SYMBOLS internal symbols of PACKAGE. SYMBOLS must be a list of symbols
493 or a symbol.
494 </p>
495
496 </dd></dl>
497
498 <dl>
499 <dt id="index-GET">Function: <strong>GET</strong> <em>(symbol indicator &amp;optional (default nil))</em></dt>
500 <dd><p>Package:LISP
501 </p>
502 <p>Looks on the property list of SYMBOL for the specified INDICATOR. If this
503 is found, returns the associated value. Otherwise, returns DEFAULT.
504 </p>
505
506 </dd></dl>
507
508 <dl>
509 <dt id="index-FIND_002dALL_002dSYMBOLS">Function: <strong>FIND-ALL-SYMBOLS</strong> <em>(string-or-symbol)</em></dt>
510 <dd><p>Package:LISP
511 </p>
512 <p>Returns a list of all symbols that have the specified name.
513 </p>
514
515 </dd></dl>
516
517 <dl>
518 <dt id="index-FMAKUNBOUND">Function: <strong>FMAKUNBOUND</strong> <em>(symbol)</em></dt>
519 <dd><p>Package:LISP
520 </p>
521 <p>Discards the global function definition named by SYMBOL. Returns SYMBOL.
522 </p>
523
524 </dd></dl>
525
526 <dl>
527 <dt id="index-PACKAGE_002dNAME">Function: <strong>PACKAGE-NAME</strong> <em>(package)</em></dt>
528 <dd><p>Package:LISP
529 </p>
530 <p>Returns the string that names the specified PACKAGE.
531 </p>
532
533 </dd></dl>
534
535 <dl>
536 <dt id="index-FIND_002dPACKAGE">Function: <strong>FIND-PACKAGE</strong> <em>(name)</em></dt>
537 <dd><p>Package:LISP
538 </p>
539 <p>Returns the specified package if it already exists; NIL otherwise. NAME may
540 be a string that is the name or nickname of the package. NAME may also be
541 a symbol, in which case the symbol&rsquo;s print name is used.
542 </p>
543
544 </dd></dl>
545
546
547 <dl>
548 <dt id="index-APROPOS_002dLIST">Function: <strong>APROPOS-LIST</strong> <em>(string &amp;optional (package nil))</em></dt>
549 <dd><p>Package:LISP
550 </p>
551 <p>Returns, as a list, all symbols whose print-names contain STRING as substring.
552 If PACKAGE is non-NIL, then only the specified package is searched.
553 </p>
554
555 </dd></dl>
556
557
558
559 <hr>
560 <div class="header">
561 <p>
562 Next: <a href="Operating-System.html" accesskey="n" rel="next">Operating System</a>, Previous: <a href="Compilation.html" accesskey="p" rel="prev">Compilation</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> &nbsp; [<a href="Function-and-Variable-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
563 </div>
564
565
566
567 </body>
568 </html>