File: save.htm

package info (click to toggle)
nyquist 3.12%2Bds-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 58,036 kB
  • sloc: ansic: 74,355; lisp: 20,485; java: 9,390; cpp: 6,695; sh: 207; xml: 58; makefile: 39
file content (124 lines) | stat: -rw-r--r-- 4,379 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
<html><head><title>XLISP save</title>

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

</head>

<body>

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

<hr>

<h1>save</h1>

<hr>

<p><table cellpadding="0" cellspacing="0" style="margin-left:10px"><tbody>
<tr valign="top">
  <td><nobr>Type:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>function (subr)</nobr></td>
</tr>
<tr valign="top">
  <td><nobr>Source:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr> xldmem.c, xlimage.c</nobr></td>
</tr>
</tbody></table></p>

<h2>Syntax</h2>

<dl>
<dt>(save <i>file</i>)</dt>
<dd><i>file</i> - a string or symbol for the name of the file<br>
returns - <a href="t.htm">&nbsp;T&nbsp;</a> if workspace was
written, <a href="nil.htm">NIL</a> otherwise</dd>
</dl>

<h2>Description</h2>

<p>The 'save' function saves the current XLISP workspace [system state] to
the specified file. The 'file' may be a string or a symbol. If the 'file'
does not include a '.wks' suffix, it will be extended to be called
'file.wks'. The function returns
<a href="t.htm">&nbsp;T&nbsp;</a> if the workspace was properly
created and saved, <a href="nil.htm">NIL</a> is returned
otherwise. There can be several saved workspaces. These workspaces can be
restored as often as desired.</p>

<h2>Examples</h2>

<pre class="example">
(setq myvar 5)       <font color="#008844">; set MYVAR to value 5</font>
myvar                <font color="#008844">; returns 5</font>

(save 'farp)         <font color="#008844">; save workspace in FARP.wks</font>

(setq myvar "garp")  <font color="#008844">; change MYVAR to "garp"</font>
myvar                <font color="#008844">; returns "garp"</font>

(restore 'farp)      <font color="#008844">; restore workspace</font>
myvar                <font color="#008844">; returns 5</font>
</pre>

<p><b>Bug:</b> The 'save' function generates a system error if the 'file'
being created already exists. This 'file' will be modified and will not be
restorable after restarting XLISP. [I still haven't tested this with
Nyquist.]</p>

<p><b>Note:</b> The saved workspace size is implementation dependent, but
can be fairly large.</p>

<p><b>File names:</b> In the PC and DOS world, all file names and extensions
[&quot;foo.bat&quot;] are automatically made uppercase. In using XLISP, this
means you don't have to worry about whether the name is &quot;foo.bat&quot;,
&quot;FOO.BAT&quot; or even &quot;FoO.bAt&quot;, they will all work.
However, in other file systems [UNIX in particular], uppercase and lowercase
do make a difference:</p>

<p>This will create a file named FOO-FILE in UNIX, because XLISP uppercases
its symbols:</p>

<pre class="example">
(open 'foo-file :direction :output)
</pre>

<p>This will create a file named 'foo-file' because UNIX doesn't
uppercase its file names:</p>

<pre class="example">
(open "foo-file" :direction :output)
</pre>

<p>So, if you are having trouble with opening and accessing files, check to
make sure the file name is in the proper case.</p>

<p><b>Common Lisp:</b> The XLISP 'save' function is similar in use to the
'save-world' function in Common Lisp. The primarily difference is that
'save-world' allows you to restart everything since it creates an executable
file. The 'save' function requires you to start XLISP up first and then do a
<a href="restore.htm">restore</a>. Depending on the operating system
that you are using, it is possible to write a 'save-world' equivalent using
'save', <a href="restore.htm">restore</a> and system.htm
functions.</p>

<p>See the
<a href="../manual/xlisp-man-031.htm#save">save</a>
function in the <nobr>XLISP 2.0</nobr> manual.</p>

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

<hr>

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

</body></html>