Debian Codegraph @

docsrc/xlisp/xlisp-doc/examples/common-lisp/multiple-value-list.htm

raw
1 <html><head>
2
3 <title>cl:multiple-value-list</title>
4
5 <style type="text/css">
6 .example {
7 color: #000000;
8 background-color: #F5F5F5;
9 padding: 8px;
10 border: #808080;
11 border-style: solid;
12 border-width: 1px;
13 width:auto;
14 }
15 .button {
16 color: #000000;
17 background-color: #F5F5F5;
18 padding-top: 1px;
19 padding-bottom: 1px;
20 padding-left: 4px;
21 padding-right: 8px;
22 border: #808080;
23 border-style: solid;
24 border-width: 1px;
25 white-space: pre;
26 }
27 .box {
28 color: #000000;
29 padding-top: 4px;
30 padding-bottom: 4px;
31 padding-left: 16px;
32 padding-right: 16px;
33 border: #808080;
34 border-style: solid;
35 border-width: 1px;
36 }
37 </style>
38
39 </head>
40
41 <body>
42
43 <a href="../../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
44 <a href="../../manual/contents.htm">Contents</a> |
45 <a href="../../tutorials/tutorials.htm">Tutorials</a> |
46 <a href="../examples.htm">Examples</a> |
47 <a href="../../reference/reference-index.htm">Reference</a>
48
49 <hr>
50
51 <h1>cl:multiple-value-list</h1>
52
53 <hr>
54
55 <p>The <nobr>cl:<b>multiple-value-list</b></nobr> macro evaluates a Lisp
56 expression and returns all values in a list:</p>
57
58 <p><div class="box">
59
60 <dl>
61 <dt>(cl:<b>multiple-value-list</b> <i>expr</i>)</dt>
62 <dd><i>expr</i> - an arbitrary Lisp expression<br>
63 returns - all values in a list</dd>
64 </dl>
65
66 </div></p>
67
68 <pre class="example">
69 (defmacro <font color="#0000CC">cl:multiple-value-list</font> (expr)
70 (setq <font color="#AA5500">cl:*multiple-values*</font> nil)
71 (let ((result (eval expr)))
72 (if <font color="#AA5500">cl:*multiple-values*</font>
73 '<font color="#AA5500">*rslt*</font>
74 `(list ,result))))
75 </pre>
76
77 <p>The <nobr>cl:<b>multiple-value-list</b></nobr> macro first evaluates the
78 expression. <nobr>If the</nobr> evaluation returned multiple values, the
79 value of the <a href="../../reference/global-rslt.htm">*rslt*</a> variable
80 is returned, otherwise the normal Lisp return value is returned in a list of
81 one element.</p>
82
83 <p><nobr>The
84 <a href="global-multiple-values.htm">cl:*multiple-values*</a></nobr>
85 variable <nobr>is <a href="../../reference/t.htm">&nbsp;T&nbsp;</a></nobr>
86 if evaluating the expression returns multiple values and
87 <a href="../../reference/nil.htm">NIL</a> with a normal return value.</p>
88
89 <p>Examples:</p>
90
91 <pre class="example">
92 (cl:multiple-value-list 1) =&gt; (1) <font color="#008844">; cl:*multiple-values* =&gt; NIL</font>
93 <font color="#008844">; *rslt* =&gt; [invalid]</font>
94 (cl:multiple-value-list
95 (+ 1 1)) =&gt; (2) <font color="#008844">; cl:*multiple-values* =&gt; NIL</font>
96 <font color="#008844">; *rslt* =&gt; [invalid]</font>
97 (cl:multiple-value-list
98 (cl:values 1 2 3)) =&gt; (1 2 3) <font color="#008844">; cl:*multiple-values* =&gt; T</font>
99 <font color="#008844">; *rslt* =&gt; (1 2 3)</font>
100 </pre>
101
102 <p><nobr>&nbsp;&nbsp;<a href="#top">Back to top</a></nobr></p>
103
104 <hr>
105
106 <a href="../../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
107 <a href="../../manual/contents.htm">Contents</a> |
108 <a href="../../tutorials/tutorials.htm">Tutorials</a> |
109 <a href="../examples.htm">Examples</a> |
110 <a href="../../reference/reference-index.htm">Reference</a>
111
112 </body></html>