Commit | Line | Data |
---|---|---|
2b829bbb | 1 | /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2003, 2004, 2006 Free Software Foundation, Inc. |
0f2d19dd | 2 | * |
73be1d9e MV |
3 | * This library is free software; you can redistribute it and/or |
4 | * modify it under the terms of the GNU Lesser General Public | |
5 | * License as published by the Free Software Foundation; either | |
6 | * version 2.1 of the License, or (at your option) any later version. | |
0f2d19dd | 7 | * |
73be1d9e MV |
8 | * This library is distributed in the hope that it will be useful, |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
11 | * Lesser General Public License for more details. | |
0f2d19dd | 12 | * |
73be1d9e MV |
13 | * You should have received a copy of the GNU Lesser General Public |
14 | * License along with this library; if not, write to the Free Software | |
92205699 | 15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
73be1d9e | 16 | */ |
1bbd0b84 | 17 | |
1bbd0b84 | 18 | |
0f2d19dd | 19 | \f |
d68fee48 JB |
20 | /* Headers. */ |
21 | ||
2b829bbb KR |
22 | #define _LARGEFILE64_SOURCE /* ask for stat64 etc */ |
23 | ||
bd515f37 RB |
24 | #if HAVE_CONFIG_H |
25 | # include <config.h> | |
26 | #endif | |
27 | ||
0f2d19dd | 28 | #include <stdio.h> |
e6e2e95a MD |
29 | #include <errno.h> |
30 | ||
a0599745 | 31 | #include "libguile/_scm.h" |
4e047c3e | 32 | #include "libguile/async.h" |
f0942910 | 33 | #include "libguile/eval.h" |
a0599745 | 34 | #include "libguile/objects.h" |
9511876f | 35 | #include "libguile/goops.h" |
a0599745 MD |
36 | #include "libguile/smob.h" |
37 | #include "libguile/chars.h" | |
185e369a | 38 | #include "libguile/dynwind.h" |
0f2d19dd | 39 | |
a0599745 MD |
40 | #include "libguile/keywords.h" |
41 | #include "libguile/root.h" | |
42 | #include "libguile/strings.h" | |
b42170a4 | 43 | #include "libguile/mallocs.h" |
a0599745 MD |
44 | #include "libguile/validate.h" |
45 | #include "libguile/ports.h" | |
3a5fb14d | 46 | #include "libguile/vectors.h" |
9de87eea | 47 | #include "libguile/fluids.h" |
0f2d19dd | 48 | |
bd9e24b3 GH |
49 | #ifdef HAVE_STRING_H |
50 | #include <string.h> | |
51 | #endif | |
52 | ||
0f2d19dd | 53 | #ifdef HAVE_MALLOC_H |
95b88819 | 54 | #include <malloc.h> |
0f2d19dd JB |
55 | #endif |
56 | ||
ec65f5da MV |
57 | #ifdef HAVE_IO_H |
58 | #include <io.h> | |
59 | #endif | |
60 | ||
0f2d19dd JB |
61 | #ifdef HAVE_UNISTD_H |
62 | #include <unistd.h> | |
63 | #endif | |
64 | ||
95b88819 GH |
65 | #ifdef HAVE_SYS_IOCTL_H |
66 | #include <sys/ioctl.h> | |
67 | #endif | |
d68fee48 | 68 | |
82893676 MG |
69 | #ifdef __MINGW32__ |
70 | #include <fcntl.h> | |
71 | #define ftruncate(fd, size) chsize (fd, size) | |
72 | #endif | |
73 | ||
0f2d19dd | 74 | \f |
d68fee48 | 75 | /* The port kind table --- a dynamically resized array of port types. */ |
0f2d19dd JB |
76 | |
77 | ||
78 | /* scm_ptobs scm_numptob | |
79 | * implement a dynamicly resized array of ptob records. | |
80 | * Indexes into this table are used when generating type | |
81 | * tags for smobjects (if you know a tag you can get an index and conversely). | |
82 | */ | |
92c2555f | 83 | scm_t_ptob_descriptor *scm_ptobs; |
c014a02e | 84 | long scm_numptob; |
0f2d19dd | 85 | |
ee149d03 | 86 | /* GC marker for a port with stream of SCM type. */ |
0f2d19dd | 87 | SCM |
a284e297 | 88 | scm_markstream (SCM ptr) |
0f2d19dd JB |
89 | { |
90 | int openp; | |
f9a64404 | 91 | openp = SCM_CELL_WORD_0 (ptr) & SCM_OPN; |
0f2d19dd | 92 | if (openp) |
74a16888 | 93 | return SCM_PACK (SCM_STREAM (ptr)); |
0f2d19dd JB |
94 | else |
95 | return SCM_BOOL_F; | |
96 | } | |
97 | ||
f12733c9 | 98 | /* |
f12733c9 | 99 | * We choose to use an interface similar to the smob interface with |
affc96b5 | 100 | * fill_input and write as standard fields, passed to the port |
f12733c9 MD |
101 | * type constructor, and optional fields set by setters. |
102 | */ | |
103 | ||
70df8af6 | 104 | static void |
e81d98ec | 105 | flush_port_default (SCM port SCM_UNUSED) |
70df8af6 GH |
106 | { |
107 | } | |
108 | ||
109 | static void | |
e81d98ec | 110 | end_input_default (SCM port SCM_UNUSED, int offset SCM_UNUSED) |
70df8af6 GH |
111 | { |
112 | } | |
0f2d19dd | 113 | |
4c9419ac MV |
114 | static size_t |
115 | scm_port_free0 (SCM port) | |
116 | { | |
117 | return 0; | |
118 | } | |
119 | ||
92c2555f | 120 | scm_t_bits |
f12733c9 | 121 | scm_make_port_type (char *name, |
affc96b5 | 122 | int (*fill_input) (SCM port), |
8aa011a1 | 123 | void (*write) (SCM port, const void *data, size_t size)) |
0f2d19dd JB |
124 | { |
125 | char *tmp; | |
126 | if (255 <= scm_numptob) | |
127 | goto ptoberr; | |
9de87eea | 128 | SCM_CRITICAL_SECTION_START; |
f12733c9 MD |
129 | SCM_SYSCALL (tmp = (char *) realloc ((char *) scm_ptobs, |
130 | (1 + scm_numptob) | |
92c2555f | 131 | * sizeof (scm_t_ptob_descriptor))); |
0f2d19dd JB |
132 | if (tmp) |
133 | { | |
92c2555f | 134 | scm_ptobs = (scm_t_ptob_descriptor *) tmp; |
affc96b5 | 135 | |
f12733c9 MD |
136 | scm_ptobs[scm_numptob].name = name; |
137 | scm_ptobs[scm_numptob].mark = 0; | |
4c9419ac | 138 | scm_ptobs[scm_numptob].free = scm_port_free0; |
f12733c9 MD |
139 | scm_ptobs[scm_numptob].print = scm_port_print; |
140 | scm_ptobs[scm_numptob].equalp = 0; | |
affc96b5 GH |
141 | scm_ptobs[scm_numptob].close = 0; |
142 | ||
143 | scm_ptobs[scm_numptob].write = write; | |
70df8af6 | 144 | scm_ptobs[scm_numptob].flush = flush_port_default; |
affc96b5 | 145 | |
70df8af6 | 146 | scm_ptobs[scm_numptob].end_input = end_input_default; |
affc96b5 GH |
147 | scm_ptobs[scm_numptob].fill_input = fill_input; |
148 | scm_ptobs[scm_numptob].input_waiting = 0; | |
149 | ||
f12733c9 | 150 | scm_ptobs[scm_numptob].seek = 0; |
affc96b5 GH |
151 | scm_ptobs[scm_numptob].truncate = 0; |
152 | ||
0f2d19dd JB |
153 | scm_numptob++; |
154 | } | |
9de87eea | 155 | SCM_CRITICAL_SECTION_END; |
0f2d19dd | 156 | if (!tmp) |
2500356c DH |
157 | { |
158 | ptoberr: | |
159 | scm_memory_error ("scm_make_port_type"); | |
160 | } | |
f12733c9 MD |
161 | /* Make a class object if Goops is present */ |
162 | if (scm_port_class) | |
163 | scm_make_port_classes (scm_numptob - 1, SCM_PTOBNAME (scm_numptob - 1)); | |
0f2d19dd JB |
164 | return scm_tc7_port + (scm_numptob - 1) * 256; |
165 | } | |
166 | ||
f12733c9 | 167 | void |
23f2b9a3 | 168 | scm_set_port_mark (scm_t_bits tc, SCM (*mark) (SCM)) |
f12733c9 MD |
169 | { |
170 | scm_ptobs[SCM_TC2PTOBNUM (tc)].mark = mark; | |
171 | } | |
172 | ||
173 | void | |
23f2b9a3 | 174 | scm_set_port_free (scm_t_bits tc, size_t (*free) (SCM)) |
f12733c9 MD |
175 | { |
176 | scm_ptobs[SCM_TC2PTOBNUM (tc)].free = free; | |
177 | } | |
178 | ||
179 | void | |
23f2b9a3 | 180 | scm_set_port_print (scm_t_bits tc, int (*print) (SCM exp, SCM port, |
f12733c9 MD |
181 | scm_print_state *pstate)) |
182 | { | |
183 | scm_ptobs[SCM_TC2PTOBNUM (tc)].print = print; | |
184 | } | |
185 | ||
186 | void | |
23f2b9a3 | 187 | scm_set_port_equalp (scm_t_bits tc, SCM (*equalp) (SCM, SCM)) |
f12733c9 MD |
188 | { |
189 | scm_ptobs[SCM_TC2PTOBNUM (tc)].equalp = equalp; | |
190 | } | |
191 | ||
31703ab8 | 192 | void |
23f2b9a3 | 193 | scm_set_port_flush (scm_t_bits tc, void (*flush) (SCM port)) |
31703ab8 | 194 | { |
affc96b5 | 195 | scm_ptobs[SCM_TC2PTOBNUM (tc)].flush = flush; |
31703ab8 GH |
196 | } |
197 | ||
f12733c9 | 198 | void |
23f2b9a3 | 199 | scm_set_port_end_input (scm_t_bits tc, void (*end_input) (SCM port, int offset)) |
f12733c9 | 200 | { |
affc96b5 | 201 | scm_ptobs[SCM_TC2PTOBNUM (tc)].end_input = end_input; |
f12733c9 MD |
202 | } |
203 | ||
204 | void | |
23f2b9a3 | 205 | scm_set_port_close (scm_t_bits tc, int (*close) (SCM)) |
f12733c9 | 206 | { |
affc96b5 | 207 | scm_ptobs[SCM_TC2PTOBNUM (tc)].close = close; |
f12733c9 MD |
208 | } |
209 | ||
210 | void | |
23f2b9a3 | 211 | scm_set_port_seek (scm_t_bits tc, off_t (*seek) (SCM port, |
f12733c9 MD |
212 | off_t OFFSET, |
213 | int WHENCE)) | |
214 | { | |
215 | scm_ptobs[SCM_TC2PTOBNUM (tc)].seek = seek; | |
216 | } | |
217 | ||
218 | void | |
23f2b9a3 | 219 | scm_set_port_truncate (scm_t_bits tc, void (*truncate) (SCM port, off_t length)) |
f12733c9 | 220 | { |
affc96b5 | 221 | scm_ptobs[SCM_TC2PTOBNUM (tc)].truncate = truncate; |
f12733c9 MD |
222 | } |
223 | ||
224 | void | |
23f2b9a3 | 225 | scm_set_port_input_waiting (scm_t_bits tc, int (*input_waiting) (SCM)) |
f12733c9 | 226 | { |
affc96b5 | 227 | scm_ptobs[SCM_TC2PTOBNUM (tc)].input_waiting = input_waiting; |
f12733c9 MD |
228 | } |
229 | ||
0f2d19dd | 230 | \f |
0f2d19dd | 231 | |
3b3b36dd | 232 | SCM_DEFINE (scm_char_ready_p, "char-ready?", 0, 1, 0, |
1e6808ea MG |
233 | (SCM port), |
234 | "Return @code{#t} if a character is ready on input @var{port}\n" | |
235 | "and return @code{#f} otherwise. If @code{char-ready?} returns\n" | |
236 | "@code{#t} then the next @code{read-char} operation on\n" | |
237 | "@var{port} is guaranteed not to hang. If @var{port} is a file\n" | |
238 | "port at end of file then @code{char-ready?} returns @code{#t}.\n" | |
c2dfff19 KR |
239 | "\n" |
240 | "@code{char-ready?} exists to make it possible for a\n" | |
1e6808ea MG |
241 | "program to accept characters from interactive ports without\n" |
242 | "getting stuck waiting for input. Any input editors associated\n" | |
243 | "with such ports must make sure that characters whose existence\n" | |
244 | "has been asserted by @code{char-ready?} cannot be rubbed out.\n" | |
245 | "If @code{char-ready?} were to return @code{#f} at end of file,\n" | |
246 | "a port at end of file would be indistinguishable from an\n" | |
c2dfff19 | 247 | "interactive port that has no ready characters.") |
1bbd0b84 | 248 | #define FUNC_NAME s_scm_char_ready_p |
0f2d19dd | 249 | { |
92c2555f | 250 | scm_t_port *pt; |
6c951427 | 251 | |
0f2d19dd | 252 | if (SCM_UNBNDP (port)) |
9de87eea | 253 | port = scm_current_input_port (); |
0f2d19dd | 254 | else |
34d19ef6 | 255 | SCM_VALIDATE_OPINPORT (1, port); |
d68fee48 | 256 | |
ae4c4016 JB |
257 | pt = SCM_PTAB_ENTRY (port); |
258 | ||
6c951427 GH |
259 | /* if the current read buffer is filled, or the |
260 | last pushed-back char has been read and the saved buffer is | |
261 | filled, result is true. */ | |
262 | if (pt->read_pos < pt->read_end | |
263 | || (pt->read_buf == pt->putback_buf | |
264 | && pt->saved_read_pos < pt->saved_read_end)) | |
0f2d19dd | 265 | return SCM_BOOL_T; |
ee149d03 JB |
266 | else |
267 | { | |
92c2555f | 268 | scm_t_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (port)]; |
ee149d03 | 269 | |
affc96b5 | 270 | if (ptob->input_waiting) |
7888309b | 271 | return scm_from_bool(ptob->input_waiting (port)); |
ee149d03 | 272 | else |
6c951427 | 273 | return SCM_BOOL_T; |
ee149d03 | 274 | } |
0f2d19dd | 275 | } |
1bbd0b84 | 276 | #undef FUNC_NAME |
0f2d19dd | 277 | |
c2da2648 GH |
278 | /* move up to read_len chars from port's putback and/or read buffers |
279 | into memory starting at dest. returns the number of chars moved. */ | |
280 | size_t scm_take_from_input_buffers (SCM port, char *dest, size_t read_len) | |
281 | { | |
92c2555f | 282 | scm_t_port *pt = SCM_PTAB_ENTRY (port); |
c2da2648 GH |
283 | size_t chars_read = 0; |
284 | size_t from_buf = min (pt->read_end - pt->read_pos, read_len); | |
285 | ||
286 | if (from_buf > 0) | |
287 | { | |
288 | memcpy (dest, pt->read_pos, from_buf); | |
289 | pt->read_pos += from_buf; | |
290 | chars_read += from_buf; | |
291 | read_len -= from_buf; | |
292 | dest += from_buf; | |
293 | } | |
294 | ||
295 | /* if putback was active, try the real input buffer too. */ | |
296 | if (pt->read_buf == pt->putback_buf) | |
297 | { | |
298 | from_buf = min (pt->saved_read_end - pt->saved_read_pos, read_len); | |
299 | if (from_buf > 0) | |
300 | { | |
301 | memcpy (dest, pt->saved_read_pos, from_buf); | |
302 | pt->saved_read_pos += from_buf; | |
303 | chars_read += from_buf; | |
304 | } | |
305 | } | |
306 | return chars_read; | |
307 | } | |
308 | ||
6c951427 | 309 | /* Clear a port's read buffers, returning the contents. */ |
a1ec6916 | 310 | SCM_DEFINE (scm_drain_input, "drain-input", 1, 0, 0, |
1bbd0b84 | 311 | (SCM port), |
4a151b3d GH |
312 | "This procedure clears a port's input buffers, similar\n" |
313 | "to the way that force-output clears the output buffer. The\n" | |
314 | "contents of the buffers are returned as a single string, e.g.,\n" | |
315 | "\n" | |
316 | "@lisp\n" | |
317 | "(define p (open-input-file ...))\n" | |
318 | "(drain-input p) => empty string, nothing buffered yet.\n" | |
319 | "(unread-char (read-char p) p)\n" | |
320 | "(drain-input p) => initial chars from p, up to the buffer size.\n" | |
321 | "@end lisp\n\n" | |
322 | "Draining the buffers may be useful for cleanly finishing\n" | |
323 | "buffered I/O so that the file descriptor can be used directly\n" | |
324 | "for further input.") | |
1bbd0b84 | 325 | #define FUNC_NAME s_scm_drain_input |
ee149d03 | 326 | { |
840ae05d | 327 | SCM result; |
3a5fb14d | 328 | char *data; |
28a6e1b0 | 329 | scm_t_port *pt; |
c014a02e | 330 | long count; |
ee149d03 | 331 | |
34d19ef6 | 332 | SCM_VALIDATE_OPINPORT (1, port); |
28a6e1b0 | 333 | pt = SCM_PTAB_ENTRY (port); |
840ae05d | 334 | |
6c951427 GH |
335 | count = pt->read_end - pt->read_pos; |
336 | if (pt->read_buf == pt->putback_buf) | |
337 | count += pt->saved_read_end - pt->saved_read_pos; | |
840ae05d | 338 | |
3a5fb14d MV |
339 | result = scm_i_make_string (count, &data); |
340 | scm_take_from_input_buffers (port, data, count); | |
840ae05d | 341 | return result; |
ee149d03 | 342 | } |
1bbd0b84 | 343 | #undef FUNC_NAME |
0f2d19dd JB |
344 | |
345 | \f | |
d68fee48 | 346 | /* Standard ports --- current input, output, error, and more(!). */ |
0f2d19dd | 347 | |
9de87eea MV |
348 | static SCM cur_inport_fluid; |
349 | static SCM cur_outport_fluid; | |
350 | static SCM cur_errport_fluid; | |
351 | static SCM cur_loadport_fluid; | |
352 | ||
3b3b36dd | 353 | SCM_DEFINE (scm_current_input_port, "current-input-port", 0, 0, 0, |
e1546b65 MG |
354 | (), |
355 | "Return the current input port. This is the default port used\n" | |
356 | "by many input procedures. Initially, @code{current-input-port}\n" | |
357 | "returns the @dfn{standard input} in Unix and C terminology.") | |
1bbd0b84 | 358 | #define FUNC_NAME s_scm_current_input_port |
0f2d19dd | 359 | { |
9de87eea | 360 | return scm_fluid_ref (cur_inport_fluid); |
0f2d19dd | 361 | } |
1bbd0b84 | 362 | #undef FUNC_NAME |
0f2d19dd | 363 | |
3b3b36dd | 364 | SCM_DEFINE (scm_current_output_port, "current-output-port", 0, 0, 0, |
e1546b65 MG |
365 | (), |
366 | "Return the current output port. This is the default port used\n" | |
9401323e | 367 | "by many output procedures. Initially,\n" |
e1546b65 MG |
368 | "@code{current-output-port} returns the @dfn{standard output} in\n" |
369 | "Unix and C terminology.") | |
1bbd0b84 | 370 | #define FUNC_NAME s_scm_current_output_port |
0f2d19dd | 371 | { |
9de87eea | 372 | return scm_fluid_ref (cur_outport_fluid); |
0f2d19dd | 373 | } |
1bbd0b84 | 374 | #undef FUNC_NAME |
0f2d19dd | 375 | |
3b3b36dd | 376 | SCM_DEFINE (scm_current_error_port, "current-error-port", 0, 0, 0, |
1bbd0b84 | 377 | (), |
b380b885 MD |
378 | "Return the port to which errors and warnings should be sent (the\n" |
379 | "@dfn{standard error} in Unix and C terminology).") | |
1bbd0b84 | 380 | #define FUNC_NAME s_scm_current_error_port |
0f2d19dd | 381 | { |
9de87eea | 382 | return scm_fluid_ref (cur_errport_fluid); |
0f2d19dd | 383 | } |
1bbd0b84 | 384 | #undef FUNC_NAME |
0f2d19dd | 385 | |
3b3b36dd | 386 | SCM_DEFINE (scm_current_load_port, "current-load-port", 0, 0, 0, |
e1546b65 | 387 | (), |
b450f070 | 388 | "Return the current-load-port.\n" |
e1546b65 | 389 | "The load port is used internally by @code{primitive-load}.") |
1bbd0b84 | 390 | #define FUNC_NAME s_scm_current_load_port |
31614d8e | 391 | { |
9de87eea | 392 | return scm_fluid_ref (cur_loadport_fluid); |
31614d8e | 393 | } |
1bbd0b84 | 394 | #undef FUNC_NAME |
31614d8e | 395 | |
3b3b36dd | 396 | SCM_DEFINE (scm_set_current_input_port, "set-current-input-port", 1, 0, 0, |
1bbd0b84 | 397 | (SCM port), |
8f85c0c6 NJ |
398 | "@deffnx {Scheme Procedure} set-current-output-port port\n" |
399 | "@deffnx {Scheme Procedure} set-current-error-port port\n" | |
b380b885 MD |
400 | "Change the ports returned by @code{current-input-port},\n" |
401 | "@code{current-output-port} and @code{current-error-port}, respectively,\n" | |
402 | "so that they use the supplied @var{port} for input or output.") | |
1bbd0b84 | 403 | #define FUNC_NAME s_scm_set_current_input_port |
0f2d19dd | 404 | { |
9de87eea | 405 | SCM oinp = scm_fluid_ref (cur_inport_fluid); |
34d19ef6 | 406 | SCM_VALIDATE_OPINPORT (1, port); |
9de87eea | 407 | scm_fluid_set_x (cur_inport_fluid, port); |
0f2d19dd JB |
408 | return oinp; |
409 | } | |
1bbd0b84 | 410 | #undef FUNC_NAME |
0f2d19dd JB |
411 | |
412 | ||
3b3b36dd | 413 | SCM_DEFINE (scm_set_current_output_port, "set-current-output-port", 1, 0, 0, |
e1546b65 MG |
414 | (SCM port), |
415 | "Set the current default output port to @var{port}.") | |
1bbd0b84 | 416 | #define FUNC_NAME s_scm_set_current_output_port |
0f2d19dd | 417 | { |
9de87eea | 418 | SCM ooutp = scm_fluid_ref (cur_outport_fluid); |
78446828 | 419 | port = SCM_COERCE_OUTPORT (port); |
34d19ef6 | 420 | SCM_VALIDATE_OPOUTPORT (1, port); |
9de87eea | 421 | scm_fluid_set_x (cur_outport_fluid, port); |
0f2d19dd JB |
422 | return ooutp; |
423 | } | |
1bbd0b84 | 424 | #undef FUNC_NAME |
0f2d19dd JB |
425 | |
426 | ||
3b3b36dd | 427 | SCM_DEFINE (scm_set_current_error_port, "set-current-error-port", 1, 0, 0, |
e1546b65 MG |
428 | (SCM port), |
429 | "Set the current default error port to @var{port}.") | |
1bbd0b84 | 430 | #define FUNC_NAME s_scm_set_current_error_port |
0f2d19dd | 431 | { |
9de87eea | 432 | SCM oerrp = scm_fluid_ref (cur_errport_fluid); |
78446828 | 433 | port = SCM_COERCE_OUTPORT (port); |
34d19ef6 | 434 | SCM_VALIDATE_OPOUTPORT (1, port); |
9de87eea | 435 | scm_fluid_set_x (cur_errport_fluid, port); |
0f2d19dd JB |
436 | return oerrp; |
437 | } | |
1bbd0b84 | 438 | #undef FUNC_NAME |
0f2d19dd | 439 | |
185e369a | 440 | void |
661ae7ab | 441 | scm_dynwind_current_input_port (SCM port) |
9de87eea | 442 | #define FUNC_NAME NULL |
185e369a | 443 | { |
9de87eea | 444 | SCM_VALIDATE_OPINPORT (1, port); |
661ae7ab | 445 | scm_dynwind_fluid (cur_inport_fluid, port); |
185e369a | 446 | } |
9de87eea | 447 | #undef FUNC_NAME |
185e369a MV |
448 | |
449 | void | |
661ae7ab | 450 | scm_dynwind_current_output_port (SCM port) |
9de87eea | 451 | #define FUNC_NAME NULL |
185e369a | 452 | { |
9de87eea MV |
453 | port = SCM_COERCE_OUTPORT (port); |
454 | SCM_VALIDATE_OPOUTPORT (1, port); | |
661ae7ab | 455 | scm_dynwind_fluid (cur_outport_fluid, port); |
185e369a | 456 | } |
9de87eea | 457 | #undef FUNC_NAME |
185e369a MV |
458 | |
459 | void | |
661ae7ab | 460 | scm_dynwind_current_error_port (SCM port) |
9de87eea MV |
461 | #define FUNC_NAME NULL |
462 | { | |
463 | port = SCM_COERCE_OUTPORT (port); | |
464 | SCM_VALIDATE_OPOUTPORT (1, port); | |
661ae7ab | 465 | scm_dynwind_fluid (cur_errport_fluid, port); |
9de87eea MV |
466 | } |
467 | #undef FUNC_NAME | |
468 | ||
469 | void | |
661ae7ab | 470 | scm_i_dynwind_current_load_port (SCM port) |
185e369a | 471 | { |
661ae7ab | 472 | scm_dynwind_fluid (cur_loadport_fluid, port); |
185e369a MV |
473 | } |
474 | ||
0f2d19dd | 475 | \f |
840ae05d | 476 | /* The port table --- an array of pointers to ports. */ |
0f2d19dd | 477 | |
67329a9e | 478 | scm_t_port **scm_i_port_table; |
0f2d19dd | 479 | |
67329a9e HWN |
480 | long scm_i_port_table_size = 0; /* Number of ports in scm_i_port_table. */ |
481 | long scm_i_port_table_room = 20; /* Size of the array. */ | |
0f2d19dd | 482 | |
9de87eea | 483 | scm_i_pthread_mutex_t scm_i_port_table_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER; |
b9ad392e MD |
484 | |
485 | /* This function is not and should not be thread safe. */ | |
1cc91f1b | 486 | |
da220f27 HWN |
487 | SCM |
488 | scm_new_port_table_entry (scm_t_bits tag) | |
402788a9 | 489 | #define FUNC_NAME "scm_new_port_table_entry" |
0f2d19dd | 490 | { |
85835e59 HWN |
491 | /* |
492 | We initialize the cell to empty, this is in case scm_gc_calloc | |
493 | triggers GC ; we don't want the GC to scan a half-finished Z. | |
494 | */ | |
495 | ||
67329a9e | 496 | SCM z = scm_cons (SCM_EOL, SCM_EOL); |
39e8f371 | 497 | scm_t_port *entry = (scm_t_port *) scm_gc_calloc (sizeof (scm_t_port), "port"); |
67329a9e | 498 | if (scm_i_port_table_size == scm_i_port_table_room) |
0f2d19dd | 499 | { |
4c9419ac | 500 | /* initial malloc is in gc.c. this doesn't use scm_gc_malloc etc., |
c6c79933 | 501 | since it can never be freed during gc. */ |
67329a9e | 502 | void *newt = scm_realloc ((char *) scm_i_port_table, |
4c9419ac | 503 | (size_t) (sizeof (scm_t_port *) |
67329a9e HWN |
504 | * scm_i_port_table_room * 2)); |
505 | scm_i_port_table = (scm_t_port **) newt; | |
506 | scm_i_port_table_room *= 2; | |
0f2d19dd | 507 | } |
840ae05d | 508 | |
67329a9e | 509 | entry->entry = scm_i_port_table_size; |
5f16b897 | 510 | |
840ae05d | 511 | entry->file_name = SCM_BOOL_F; |
61e452ba | 512 | entry->rw_active = SCM_PORT_NEITHER; |
5f16b897 | 513 | |
67329a9e HWN |
514 | scm_i_port_table[scm_i_port_table_size] = entry; |
515 | scm_i_port_table_size++; | |
840ae05d | 516 | |
da220f27 HWN |
517 | entry->port = z; |
518 | SCM_SET_CELL_TYPE(z, tag); | |
519 | SCM_SETPTAB_ENTRY(z, entry); | |
520 | ||
521 | return z; | |
0f2d19dd | 522 | } |
c6c79933 | 523 | #undef FUNC_NAME |
0f2d19dd | 524 | |
67329a9e HWN |
525 | #if SCM_ENABLE_DEPRECATED==1 |
526 | SCM_API scm_t_port * | |
527 | scm_add_to_port_table (SCM port) | |
528 | { | |
529 | SCM z = scm_new_port_table_entry (scm_tc7_port); | |
530 | scm_t_port * pt = SCM_PTAB_ENTRY(z); | |
531 | ||
532 | pt->port = port; | |
533 | SCM_SETCAR(z, SCM_EOL); | |
534 | SCM_SETCDR(z, SCM_EOL); | |
85835e59 | 535 | SCM_SETPTAB_ENTRY (port, pt); |
67329a9e HWN |
536 | return pt; |
537 | } | |
538 | #endif | |
539 | ||
540 | ||
6c951427 | 541 | /* Remove a port from the table and destroy it. */ |
b9ad392e MD |
542 | |
543 | /* This function is not and should not be thread safe. */ | |
544 | ||
0f2d19dd | 545 | void |
a284e297 | 546 | scm_remove_from_port_table (SCM port) |
db4b4ca6 | 547 | #define FUNC_NAME "scm_remove_from_port_table" |
0f2d19dd | 548 | { |
92c2555f | 549 | scm_t_port *p = SCM_PTAB_ENTRY (port); |
c014a02e | 550 | long i = p->entry; |
6c951427 | 551 | |
67329a9e | 552 | if (i >= scm_i_port_table_size) |
1afff620 | 553 | SCM_MISC_ERROR ("Port not in table: ~S", scm_list_1 (port)); |
6c951427 | 554 | if (p->putback_buf) |
4c9419ac MV |
555 | scm_gc_free (p->putback_buf, p->putback_buf_size, "putback buffer"); |
556 | scm_gc_free (p, sizeof (scm_t_port), "port"); | |
ee1e7e13 MD |
557 | /* Since we have just freed slot i we can shrink the table by moving |
558 | the last entry to that slot... */ | |
67329a9e | 559 | if (i < scm_i_port_table_size - 1) |
0f2d19dd | 560 | { |
67329a9e HWN |
561 | scm_i_port_table[i] = scm_i_port_table[scm_i_port_table_size - 1]; |
562 | scm_i_port_table[i]->entry = i; | |
0f2d19dd | 563 | } |
0f2d19dd | 564 | SCM_SETPTAB_ENTRY (port, 0); |
67329a9e | 565 | scm_i_port_table_size--; |
0f2d19dd | 566 | } |
db4b4ca6 DH |
567 | #undef FUNC_NAME |
568 | ||
0f2d19dd | 569 | |
fea6b4ea | 570 | #ifdef GUILE_DEBUG |
b450f070 | 571 | /* Functions for debugging. */ |
1cc91f1b | 572 | |
3b3b36dd | 573 | SCM_DEFINE (scm_pt_size, "pt-size", 0, 0, 0, |
b450f070 | 574 | (), |
1e6808ea | 575 | "Return the number of ports in the port table. @code{pt-size}\n" |
5352393c | 576 | "is only included in @code{--enable-guile-debug} builds.") |
1bbd0b84 | 577 | #define FUNC_NAME s_scm_pt_size |
0f2d19dd | 578 | { |
e11e83f3 | 579 | return scm_from_int (scm_i_port_table_size); |
0f2d19dd | 580 | } |
1bbd0b84 | 581 | #undef FUNC_NAME |
0f2d19dd | 582 | |
3b3b36dd | 583 | SCM_DEFINE (scm_pt_member, "pt-member", 1, 0, 0, |
b450f070 | 584 | (SCM index), |
1e6808ea | 585 | "Return the port at @var{index} in the port table.\n" |
5352393c MG |
586 | "@code{pt-member} is only included in\n" |
587 | "@code{--enable-guile-debug} builds.") | |
1bbd0b84 | 588 | #define FUNC_NAME s_scm_pt_member |
0f2d19dd | 589 | { |
a55c2b68 MV |
590 | size_t i = scm_to_size_t (index); |
591 | if (i >= scm_i_port_table_size) | |
0f2d19dd JB |
592 | return SCM_BOOL_F; |
593 | else | |
67329a9e | 594 | return scm_i_port_table[i]->port; |
0f2d19dd | 595 | } |
1bbd0b84 | 596 | #undef FUNC_NAME |
0f2d19dd JB |
597 | #endif |
598 | ||
70df8af6 | 599 | void |
92c2555f | 600 | scm_port_non_buffer (scm_t_port *pt) |
70df8af6 GH |
601 | { |
602 | pt->read_pos = pt->read_buf = pt->read_end = &pt->shortbuf; | |
603 | pt->write_buf = pt->write_pos = &pt->shortbuf; | |
604 | pt->read_buf_size = pt->write_buf_size = 1; | |
605 | pt->write_end = pt->write_buf + pt->write_buf_size; | |
606 | } | |
0f2d19dd | 607 | |
d68fee48 JB |
608 | \f |
609 | /* Revealed counts --- an oddity inherited from SCSH. */ | |
610 | ||
8b13c6b3 GH |
611 | /* Find a port in the table and return its revealed count. |
612 | Also used by the garbage collector. | |
0f2d19dd | 613 | */ |
1cc91f1b | 614 | |
0f2d19dd | 615 | int |
a284e297 | 616 | scm_revealed_count (SCM port) |
0f2d19dd JB |
617 | { |
618 | return SCM_REVEALED(port); | |
619 | } | |
620 | ||
621 | ||
622 | ||
623 | /* Return the revealed count for a port. */ | |
624 | ||
3b3b36dd | 625 | SCM_DEFINE (scm_port_revealed, "port-revealed", 1, 0, 0, |
1bbd0b84 | 626 | (SCM port), |
1e6808ea | 627 | "Return the revealed count for @var{port}.") |
1bbd0b84 | 628 | #define FUNC_NAME s_scm_port_revealed |
0f2d19dd | 629 | { |
78446828 | 630 | port = SCM_COERCE_OUTPORT (port); |
34d19ef6 | 631 | SCM_VALIDATE_OPENPORT (1, port); |
e11e83f3 | 632 | return scm_from_int (scm_revealed_count (port)); |
0f2d19dd | 633 | } |
1bbd0b84 | 634 | #undef FUNC_NAME |
0f2d19dd JB |
635 | |
636 | /* Set the revealed count for a port. */ | |
3b3b36dd | 637 | SCM_DEFINE (scm_set_port_revealed_x, "set-port-revealed!", 2, 0, 0, |
1bbd0b84 | 638 | (SCM port, SCM rcount), |
b450f070 | 639 | "Sets the revealed count for a port to a given value.\n" |
b380b885 | 640 | "The return value is unspecified.") |
1bbd0b84 | 641 | #define FUNC_NAME s_scm_set_port_revealed_x |
0f2d19dd | 642 | { |
78446828 | 643 | port = SCM_COERCE_OUTPORT (port); |
34d19ef6 | 644 | SCM_VALIDATE_OPENPORT (1, port); |
a55c2b68 | 645 | SCM_REVEALED (port) = scm_to_int (rcount); |
8b13c6b3 | 646 | return SCM_UNSPECIFIED; |
0f2d19dd | 647 | } |
1bbd0b84 | 648 | #undef FUNC_NAME |
0f2d19dd | 649 | |
d68fee48 JB |
650 | |
651 | \f | |
652 | /* Retrieving a port's mode. */ | |
653 | ||
eadd48de GH |
654 | /* Return the flags that characterize a port based on the mode |
655 | * string used to open a file for that port. | |
656 | * | |
657 | * See PORT FLAGS in scm.h | |
658 | */ | |
659 | ||
3a5fb14d MV |
660 | static long |
661 | scm_i_mode_bits_n (const char *modes, size_t n) | |
662 | { | |
663 | return (SCM_OPN | |
664 | | (memchr (modes, 'r', n) || memchr (modes, '+', n) ? SCM_RDNG : 0) | |
665 | | ( memchr (modes, 'w', n) | |
666 | || memchr (modes, 'a', n) | |
667 | || memchr (modes, '+', n) ? SCM_WRTNG : 0) | |
668 | | (memchr (modes, '0', n) ? SCM_BUF0 : 0) | |
669 | | (memchr (modes, 'l', n) ? SCM_BUFLINE : 0)); | |
670 | } | |
671 | ||
eadd48de | 672 | long |
a284e297 | 673 | scm_mode_bits (char *modes) |
eadd48de | 674 | { |
3a5fb14d | 675 | return scm_i_mode_bits_n (modes, strlen (modes)); |
eadd48de GH |
676 | } |
677 | ||
d617ee18 MV |
678 | long |
679 | scm_i_mode_bits (SCM modes) | |
680 | { | |
681 | long bits; | |
682 | ||
683 | if (!scm_is_string (modes)) | |
684 | scm_wrong_type_arg_msg (NULL, 0, modes, "string"); | |
685 | ||
3a5fb14d MV |
686 | bits = scm_i_mode_bits_n (scm_i_string_chars (modes), |
687 | scm_i_string_length (modes)); | |
d617ee18 MV |
688 | scm_remember_upto_here_1 (modes); |
689 | return bits; | |
690 | } | |
eadd48de GH |
691 | |
692 | /* Return the mode flags from an open port. | |
693 | * Some modes such as "append" are only used when opening | |
694 | * a file and are not returned here. */ | |
695 | ||
3b3b36dd | 696 | SCM_DEFINE (scm_port_mode, "port-mode", 1, 0, 0, |
1bbd0b84 | 697 | (SCM port), |
1e6808ea MG |
698 | "Return the port modes associated with the open port @var{port}.\n" |
699 | "These will not necessarily be identical to the modes used when\n" | |
700 | "the port was opened, since modes such as \"append\" which are\n" | |
701 | "used only during port creation are not retained.") | |
1bbd0b84 | 702 | #define FUNC_NAME s_scm_port_mode |
eadd48de | 703 | { |
26a3038d | 704 | char modes[4]; |
eadd48de | 705 | modes[0] = '\0'; |
78446828 MV |
706 | |
707 | port = SCM_COERCE_OUTPORT (port); | |
34d19ef6 | 708 | SCM_VALIDATE_OPPORT (1, port); |
f9a64404 DH |
709 | if (SCM_CELL_WORD_0 (port) & SCM_RDNG) { |
710 | if (SCM_CELL_WORD_0 (port) & SCM_WRTNG) | |
eadd48de GH |
711 | strcpy (modes, "r+"); |
712 | else | |
713 | strcpy (modes, "r"); | |
714 | } | |
f9a64404 | 715 | else if (SCM_CELL_WORD_0 (port) & SCM_WRTNG) |
eadd48de | 716 | strcpy (modes, "w"); |
f9a64404 | 717 | if (SCM_CELL_WORD_0 (port) & SCM_BUF0) |
eadd48de | 718 | strcat (modes, "0"); |
3a5fb14d | 719 | return scm_from_locale_string (modes); |
eadd48de | 720 | } |
1bbd0b84 | 721 | #undef FUNC_NAME |
eadd48de GH |
722 | |
723 | ||
d68fee48 JB |
724 | \f |
725 | /* Closing ports. */ | |
726 | ||
0f2d19dd JB |
727 | /* scm_close_port |
728 | * Call the close operation on a port object. | |
eadd48de | 729 | * see also scm_close. |
0f2d19dd | 730 | */ |
3b3b36dd | 731 | SCM_DEFINE (scm_close_port, "close-port", 1, 0, 0, |
1bbd0b84 | 732 | (SCM port), |
1e6808ea MG |
733 | "Close the specified port object. Return @code{#t} if it\n" |
734 | "successfully closes a port or @code{#f} if it was already\n" | |
735 | "closed. An exception may be raised if an error occurs, for\n" | |
736 | "example when flushing buffered output. See also @ref{Ports and\n" | |
737 | "File Descriptors, close}, for a procedure which can close file\n" | |
738 | "descriptors.") | |
1bbd0b84 | 739 | #define FUNC_NAME s_scm_close_port |
0f2d19dd | 740 | { |
1be6b49c | 741 | size_t i; |
eadd48de GH |
742 | int rv; |
743 | ||
78446828 MV |
744 | port = SCM_COERCE_OUTPORT (port); |
745 | ||
7a754ca6 | 746 | SCM_VALIDATE_PORT (1, port); |
0f2d19dd | 747 | if (SCM_CLOSEDP (port)) |
eadd48de | 748 | return SCM_BOOL_F; |
0f2d19dd | 749 | i = SCM_PTOBNUM (port); |
affc96b5 GH |
750 | if (scm_ptobs[i].close) |
751 | rv = (scm_ptobs[i].close) (port); | |
eadd48de GH |
752 | else |
753 | rv = 0; | |
9de87eea | 754 | scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex); |
0f2d19dd | 755 | scm_remove_from_port_table (port); |
9de87eea | 756 | scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex); |
22a52da1 | 757 | SCM_CLR_PORT_OPEN_FLAG (port); |
7888309b | 758 | return scm_from_bool (rv >= 0); |
7a754ca6 MD |
759 | } |
760 | #undef FUNC_NAME | |
761 | ||
762 | SCM_DEFINE (scm_close_input_port, "close-input-port", 1, 0, 0, | |
763 | (SCM port), | |
764 | "Close the specified input port object. The routine has no effect if\n" | |
765 | "the file has already been closed. An exception may be raised if an\n" | |
766 | "error occurs. The value returned is unspecified.\n\n" | |
767 | "See also @ref{Ports and File Descriptors, close}, for a procedure\n" | |
768 | "which can close file descriptors.") | |
769 | #define FUNC_NAME s_scm_close_input_port | |
770 | { | |
771 | SCM_VALIDATE_INPUT_PORT (1, port); | |
772 | scm_close_port (port); | |
773 | return SCM_UNSPECIFIED; | |
774 | } | |
775 | #undef FUNC_NAME | |
776 | ||
777 | SCM_DEFINE (scm_close_output_port, "close-output-port", 1, 0, 0, | |
778 | (SCM port), | |
779 | "Close the specified output port object. The routine has no effect if\n" | |
780 | "the file has already been closed. An exception may be raised if an\n" | |
781 | "error occurs. The value returned is unspecified.\n\n" | |
782 | "See also @ref{Ports and File Descriptors, close}, for a procedure\n" | |
783 | "which can close file descriptors.") | |
784 | #define FUNC_NAME s_scm_close_output_port | |
785 | { | |
786 | port = SCM_COERCE_OUTPORT (port); | |
787 | SCM_VALIDATE_OUTPUT_PORT (1, port); | |
788 | scm_close_port (port); | |
789 | return SCM_UNSPECIFIED; | |
0f2d19dd | 790 | } |
1bbd0b84 | 791 | #undef FUNC_NAME |
0f2d19dd | 792 | |
c536b4b3 MV |
793 | void |
794 | scm_c_port_for_each (void (*proc)(void *data, SCM p), void *data) | |
c2ca4493 | 795 | { |
c014a02e | 796 | long i; |
3a5fb14d | 797 | size_t n; |
fdfe6305 MV |
798 | SCM ports; |
799 | ||
fdfe6305 MV |
800 | /* Even without pre-emptive multithreading, running arbitrary code |
801 | while scanning the port table is unsafe because the port table | |
3a5fb14d MV |
802 | can change arbitrarily (from a GC, for example). So we first |
803 | collect the ports into a vector. -mvo */ | |
fdfe6305 | 804 | |
9de87eea | 805 | scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex); |
3a5fb14d | 806 | n = scm_i_port_table_size; |
9de87eea | 807 | scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex); |
fdfe6305 | 808 | |
4057a3e0 | 809 | ports = scm_c_make_vector (n, SCM_BOOL_F); |
3a5fb14d | 810 | |
9de87eea | 811 | scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex); |
3a5fb14d MV |
812 | if (n > scm_i_port_table_size) |
813 | n = scm_i_port_table_size; | |
814 | for (i = 0; i < n; i++) | |
4057a3e0 | 815 | SCM_SIMPLE_VECTOR_SET (ports, i, scm_i_port_table[i]->port); |
9de87eea | 816 | scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex); |
3a5fb14d MV |
817 | |
818 | for (i = 0; i < n; i++) | |
4057a3e0 | 819 | proc (data, SCM_SIMPLE_VECTOR_REF (ports, i)); |
c536b4b3 | 820 | } |
fdfe6305 | 821 | |
c536b4b3 MV |
822 | SCM_DEFINE (scm_port_for_each, "port-for-each", 1, 0, 0, |
823 | (SCM proc), | |
824 | "Apply @var{proc} to each port in the Guile port table\n" | |
825 | "in turn. The return value is unspecified. More specifically,\n" | |
826 | "@var{proc} is applied exactly once to every port that exists\n" | |
827 | "in the system at the time @var{port-for-each} is invoked.\n" | |
828 | "Changes to the port table while @var{port-for-each} is running\n" | |
829 | "have no effect as far as @var{port-for-each} is concerned.") | |
830 | #define FUNC_NAME s_scm_port_for_each | |
831 | { | |
832 | SCM_VALIDATE_PROC (1, proc); | |
833 | ||
834 | scm_c_port_for_each ((void (*)(void*,SCM))scm_call_1, proc); | |
c2ca4493 GH |
835 | return SCM_UNSPECIFIED; |
836 | } | |
837 | #undef FUNC_NAME | |
838 | ||
c536b4b3 | 839 | |
d68fee48 JB |
840 | \f |
841 | /* Utter miscellany. Gosh, we should clean this up some time. */ | |
842 | ||
3b3b36dd | 843 | SCM_DEFINE (scm_input_port_p, "input-port?", 1, 0, 0, |
1bbd0b84 | 844 | (SCM x), |
1e6808ea MG |
845 | "Return @code{#t} if @var{x} is an input port, otherwise return\n" |
846 | "@code{#f}. Any object satisfying this predicate also satisfies\n" | |
847 | "@code{port?}.") | |
1bbd0b84 | 848 | #define FUNC_NAME s_scm_input_port_p |
0f2d19dd | 849 | { |
7888309b | 850 | return scm_from_bool (SCM_INPUT_PORT_P (x)); |
0f2d19dd | 851 | } |
1bbd0b84 | 852 | #undef FUNC_NAME |
0f2d19dd | 853 | |
3b3b36dd | 854 | SCM_DEFINE (scm_output_port_p, "output-port?", 1, 0, 0, |
1bbd0b84 | 855 | (SCM x), |
1e6808ea MG |
856 | "Return @code{#t} if @var{x} is an output port, otherwise return\n" |
857 | "@code{#f}. Any object satisfying this predicate also satisfies\n" | |
858 | "@code{port?}.") | |
1bbd0b84 | 859 | #define FUNC_NAME s_scm_output_port_p |
0f2d19dd | 860 | { |
82893676 | 861 | x = SCM_COERCE_OUTPORT (x); |
7888309b | 862 | return scm_from_bool (SCM_OUTPUT_PORT_P (x)); |
0f2d19dd | 863 | } |
1bbd0b84 | 864 | #undef FUNC_NAME |
0f2d19dd | 865 | |
eb5c0a2a GH |
866 | SCM_DEFINE (scm_port_p, "port?", 1, 0, 0, |
867 | (SCM x), | |
1e6808ea | 868 | "Return a boolean indicating whether @var{x} is a port.\n" |
5352393c MG |
869 | "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n" |
870 | "@var{x}))}.") | |
eb5c0a2a GH |
871 | #define FUNC_NAME s_scm_port_p |
872 | { | |
7888309b | 873 | return scm_from_bool (SCM_PORTP (x)); |
eb5c0a2a GH |
874 | } |
875 | #undef FUNC_NAME | |
876 | ||
3b3b36dd | 877 | SCM_DEFINE (scm_port_closed_p, "port-closed?", 1, 0, 0, |
1bbd0b84 | 878 | (SCM port), |
1e6808ea MG |
879 | "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n" |
880 | "open.") | |
1bbd0b84 | 881 | #define FUNC_NAME s_scm_port_closed_p |
60d0643d | 882 | { |
34d19ef6 | 883 | SCM_VALIDATE_PORT (1, port); |
7888309b | 884 | return scm_from_bool (!SCM_OPPORTP (port)); |
60d0643d | 885 | } |
1bbd0b84 | 886 | #undef FUNC_NAME |
0f2d19dd | 887 | |
3b3b36dd | 888 | SCM_DEFINE (scm_eof_object_p, "eof-object?", 1, 0, 0, |
1bbd0b84 | 889 | (SCM x), |
1e6808ea MG |
890 | "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n" |
891 | "return @code{#f}.") | |
1bbd0b84 | 892 | #define FUNC_NAME s_scm_eof_object_p |
0f2d19dd | 893 | { |
7888309b | 894 | return scm_from_bool(SCM_EOF_OBJECT_P (x)); |
0f2d19dd | 895 | } |
1bbd0b84 | 896 | #undef FUNC_NAME |
0f2d19dd | 897 | |
3b3b36dd | 898 | SCM_DEFINE (scm_force_output, "force-output", 0, 1, 0, |
1bbd0b84 | 899 | (SCM port), |
b380b885 | 900 | "Flush the specified output port, or the current output port if @var{port}\n" |
9401323e | 901 | "is omitted. The current output buffer contents are passed to the\n" |
b380b885 MD |
902 | "underlying port implementation (e.g., in the case of fports, the\n" |
903 | "data will be written to the file and the output buffer will be cleared.)\n" | |
904 | "It has no effect on an unbuffered port.\n\n" | |
905 | "The return value is unspecified.") | |
1bbd0b84 | 906 | #define FUNC_NAME s_scm_force_output |
0f2d19dd JB |
907 | { |
908 | if (SCM_UNBNDP (port)) | |
9de87eea | 909 | port = scm_current_output_port (); |
0f2d19dd | 910 | else |
78446828 MV |
911 | { |
912 | port = SCM_COERCE_OUTPORT (port); | |
34d19ef6 | 913 | SCM_VALIDATE_OPOUTPORT (1, port); |
78446828 | 914 | } |
affc96b5 | 915 | scm_flush (port); |
ee149d03 | 916 | return SCM_UNSPECIFIED; |
0f2d19dd | 917 | } |
1bbd0b84 | 918 | #undef FUNC_NAME |
0f2d19dd | 919 | |
a1ec6916 | 920 | SCM_DEFINE (scm_flush_all_ports, "flush-all-ports", 0, 0, 0, |
1bbd0b84 | 921 | (), |
b380b885 MD |
922 | "Equivalent to calling @code{force-output} on\n" |
923 | "all open output ports. The return value is unspecified.") | |
1bbd0b84 | 924 | #define FUNC_NAME s_scm_flush_all_ports |
89ea5b7c | 925 | { |
1be6b49c | 926 | size_t i; |
89ea5b7c | 927 | |
9de87eea | 928 | scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex); |
67329a9e | 929 | for (i = 0; i < scm_i_port_table_size; i++) |
89ea5b7c | 930 | { |
67329a9e HWN |
931 | if (SCM_OPOUTPORTP (scm_i_port_table[i]->port)) |
932 | scm_flush (scm_i_port_table[i]->port); | |
89ea5b7c | 933 | } |
9de87eea | 934 | scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex); |
89ea5b7c GH |
935 | return SCM_UNSPECIFIED; |
936 | } | |
1bbd0b84 | 937 | #undef FUNC_NAME |
0f2d19dd | 938 | |
3b3b36dd | 939 | SCM_DEFINE (scm_read_char, "read-char", 0, 1, 0, |
1bbd0b84 | 940 | (SCM port), |
1e6808ea MG |
941 | "Return the next character available from @var{port}, updating\n" |
942 | "@var{port} to point to the following character. If no more\n" | |
943 | "characters are available, the end-of-file object is returned.") | |
1bbd0b84 | 944 | #define FUNC_NAME s_scm_read_char |
0f2d19dd JB |
945 | { |
946 | int c; | |
947 | if (SCM_UNBNDP (port)) | |
9de87eea | 948 | port = scm_current_input_port (); |
34d19ef6 | 949 | SCM_VALIDATE_OPINPORT (1, port); |
b7f3516f | 950 | c = scm_getc (port); |
0f2d19dd JB |
951 | if (EOF == c) |
952 | return SCM_EOF_VAL; | |
7866a09b | 953 | return SCM_MAKE_CHAR (c); |
0f2d19dd | 954 | } |
1bbd0b84 | 955 | #undef FUNC_NAME |
0f2d19dd | 956 | |
5c070ca7 | 957 | /* this should only be called when the read buffer is empty. it |
affc96b5 | 958 | tries to refill the read buffer. it returns the first char from |
5c070ca7 | 959 | the port, which is either EOF or *(pt->read_pos). */ |
6c951427 | 960 | int |
affc96b5 | 961 | scm_fill_input (SCM port) |
6c951427 | 962 | { |
92c2555f | 963 | scm_t_port *pt = SCM_PTAB_ENTRY (port); |
283a1a0e | 964 | |
6c951427 GH |
965 | if (pt->read_buf == pt->putback_buf) |
966 | { | |
967 | /* finished reading put-back chars. */ | |
968 | pt->read_buf = pt->saved_read_buf; | |
969 | pt->read_pos = pt->saved_read_pos; | |
970 | pt->read_end = pt->saved_read_end; | |
971 | pt->read_buf_size = pt->saved_read_buf_size; | |
972 | if (pt->read_pos < pt->read_end) | |
5c070ca7 | 973 | return *(pt->read_pos); |
6c951427 | 974 | } |
affc96b5 | 975 | return scm_ptobs[SCM_PTOBNUM (port)].fill_input (port); |
6c951427 GH |
976 | } |
977 | ||
ee149d03 | 978 | int |
a284e297 | 979 | scm_getc (SCM port) |
0f2d19dd JB |
980 | { |
981 | int c; | |
92c2555f | 982 | scm_t_port *pt = SCM_PTAB_ENTRY (port); |
ee149d03 | 983 | |
840ae05d | 984 | if (pt->rw_active == SCM_PORT_WRITE) |
aab1caad RB |
985 | /* may be marginally faster than calling scm_flush. */ |
986 | scm_ptobs[SCM_PTOBNUM (port)].flush (port); | |
6c951427 | 987 | |
5c070ca7 GH |
988 | if (pt->rw_random) |
989 | pt->rw_active = SCM_PORT_READ; | |
990 | ||
991 | if (pt->read_pos >= pt->read_end) | |
ee149d03 | 992 | { |
affc96b5 | 993 | if (scm_fill_input (port) == EOF) |
5c070ca7 | 994 | return EOF; |
ee149d03 JB |
995 | } |
996 | ||
5c070ca7 | 997 | c = *(pt->read_pos++); |
840ae05d | 998 | |
aab1caad | 999 | switch (c) |
ee149d03 | 1000 | { |
a727f4f6 KR |
1001 | case '\a': |
1002 | break; | |
1003 | case '\b': | |
1004 | SCM_DECCOL (port); | |
1005 | break; | |
aab1caad RB |
1006 | case '\n': |
1007 | SCM_INCLINE (port); | |
1008 | break; | |
a727f4f6 KR |
1009 | case '\r': |
1010 | SCM_ZEROCOL (port); | |
1011 | break; | |
aab1caad RB |
1012 | case '\t': |
1013 | SCM_TABCOL (port); | |
1014 | break; | |
1015 | default: | |
1016 | SCM_INCCOL (port); | |
1017 | break; | |
ee149d03 | 1018 | } |
aab1caad | 1019 | |
ee149d03 | 1020 | return c; |
0f2d19dd JB |
1021 | } |
1022 | ||
ee149d03 | 1023 | void |
a284e297 | 1024 | scm_putc (char c, SCM port) |
ee149d03 | 1025 | { |
417b0dc1 | 1026 | SCM_ASSERT_TYPE (SCM_OPOUTPORTP (port), port, 0, NULL, "output port"); |
265e6a4d | 1027 | scm_lfwrite (&c, 1, port); |
ee149d03 | 1028 | } |
3cb988bd | 1029 | |
ee149d03 | 1030 | void |
70d63753 | 1031 | scm_puts (const char *s, SCM port) |
3cb988bd | 1032 | { |
417b0dc1 | 1033 | SCM_ASSERT_TYPE (SCM_OPOUTPORTP (port), port, 0, NULL, "output port"); |
265e6a4d | 1034 | scm_lfwrite (s, strlen (s), port); |
ee149d03 | 1035 | } |
3cb988bd | 1036 | |
6fe692e9 MD |
1037 | /* scm_lfwrite |
1038 | * | |
53802ea8 MV |
1039 | * This function differs from scm_c_write; it updates port line and |
1040 | * column. */ | |
6fe692e9 | 1041 | |
ee149d03 | 1042 | void |
1be6b49c | 1043 | scm_lfwrite (const char *ptr, size_t size, SCM port) |
ee149d03 | 1044 | { |
92c2555f MV |
1045 | scm_t_port *pt = SCM_PTAB_ENTRY (port); |
1046 | scm_t_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (port)]; | |
3e2043c4 | 1047 | |
840ae05d | 1048 | if (pt->rw_active == SCM_PORT_READ) |
affc96b5 | 1049 | scm_end_input (port); |
283a1a0e | 1050 | |
31703ab8 | 1051 | ptob->write (port, ptr, size); |
840ae05d | 1052 | |
53802ea8 | 1053 | for (; size; ptr++, size--) { |
a727f4f6 KR |
1054 | if (*ptr == '\a') { |
1055 | } | |
1056 | else if (*ptr == '\b') { | |
1057 | SCM_DECCOL(port); | |
1058 | } | |
1059 | else if (*ptr == '\n') { | |
53802ea8 MV |
1060 | SCM_INCLINE(port); |
1061 | } | |
a727f4f6 KR |
1062 | else if (*ptr == '\r') { |
1063 | SCM_ZEROCOL(port); | |
1064 | } | |
53802ea8 MV |
1065 | else if (*ptr == '\t') { |
1066 | SCM_TABCOL(port); | |
1067 | } | |
1068 | else { | |
1069 | SCM_INCCOL(port); | |
1070 | } | |
1071 | } | |
1072 | ||
840ae05d JB |
1073 | if (pt->rw_random) |
1074 | pt->rw_active = SCM_PORT_WRITE; | |
ee149d03 | 1075 | } |
3cb988bd | 1076 | |
6fe692e9 MD |
1077 | /* scm_c_read |
1078 | * | |
1079 | * Used by an application to read arbitrary number of bytes from an | |
1080 | * SCM port. Same semantics as libc read, except that scm_c_read only | |
1081 | * returns less than SIZE bytes if at end-of-file. | |
1082 | * | |
1083 | * Warning: Doesn't update port line and column counts! */ | |
1084 | ||
1be6b49c ML |
1085 | size_t |
1086 | scm_c_read (SCM port, void *buffer, size_t size) | |
6fe692e9 | 1087 | { |
92c2555f | 1088 | scm_t_port *pt = SCM_PTAB_ENTRY (port); |
1be6b49c | 1089 | size_t n_read = 0, n_available; |
6fe692e9 MD |
1090 | |
1091 | if (pt->rw_active == SCM_PORT_WRITE) | |
1092 | scm_ptobs[SCM_PTOBNUM (port)].flush (port); | |
1093 | ||
1094 | if (pt->rw_random) | |
1095 | pt->rw_active = SCM_PORT_READ; | |
1096 | ||
1097 | if (SCM_READ_BUFFER_EMPTY_P (pt)) | |
1098 | { | |
1099 | if (scm_fill_input (port) == EOF) | |
1100 | return 0; | |
1101 | } | |
1102 | ||
1103 | n_available = pt->read_end - pt->read_pos; | |
1104 | ||
1105 | while (n_available < size) | |
1106 | { | |
1107 | memcpy (buffer, pt->read_pos, n_available); | |
910d1e40 | 1108 | buffer = (char *) buffer + n_available; |
6fe692e9 MD |
1109 | pt->read_pos += n_available; |
1110 | n_read += n_available; | |
1111 | ||
1112 | if (SCM_READ_BUFFER_EMPTY_P (pt)) | |
1113 | { | |
1114 | if (scm_fill_input (port) == EOF) | |
1115 | return n_read; | |
1116 | } | |
1117 | ||
1118 | size -= n_available; | |
1119 | n_available = pt->read_end - pt->read_pos; | |
1120 | } | |
1121 | ||
1122 | memcpy (buffer, pt->read_pos, size); | |
1123 | pt->read_pos += size; | |
1124 | ||
1125 | return n_read + size; | |
1126 | } | |
1127 | ||
1128 | /* scm_c_write | |
1129 | * | |
1130 | * Used by an application to write arbitrary number of bytes to an SCM | |
1131 | * port. Similar semantics as libc write. However, unlike libc | |
1132 | * write, scm_c_write writes the requested number of bytes and has no | |
1133 | * return value. | |
1134 | * | |
1135 | * Warning: Doesn't update port line and column counts! | |
1136 | */ | |
1137 | ||
1138 | void | |
1be6b49c | 1139 | scm_c_write (SCM port, const void *ptr, size_t size) |
6fe692e9 | 1140 | { |
92c2555f MV |
1141 | scm_t_port *pt = SCM_PTAB_ENTRY (port); |
1142 | scm_t_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (port)]; | |
6fe692e9 MD |
1143 | |
1144 | if (pt->rw_active == SCM_PORT_READ) | |
1145 | scm_end_input (port); | |
1146 | ||
1147 | ptob->write (port, ptr, size); | |
1148 | ||
1149 | if (pt->rw_random) | |
1150 | pt->rw_active = SCM_PORT_WRITE; | |
1151 | } | |
3cb988bd | 1152 | |
ee149d03 | 1153 | void |
a284e297 | 1154 | scm_flush (SCM port) |
ee149d03 | 1155 | { |
c014a02e | 1156 | long i = SCM_PTOBNUM (port); |
affc96b5 | 1157 | (scm_ptobs[i].flush) (port); |
ee149d03 JB |
1158 | } |
1159 | ||
283a1a0e | 1160 | void |
a284e297 | 1161 | scm_end_input (SCM port) |
283a1a0e | 1162 | { |
c014a02e | 1163 | long offset; |
92c2555f | 1164 | scm_t_port *pt = SCM_PTAB_ENTRY (port); |
283a1a0e GH |
1165 | |
1166 | if (pt->read_buf == pt->putback_buf) | |
1167 | { | |
1168 | offset = pt->read_end - pt->read_pos; | |
1169 | pt->read_buf = pt->saved_read_buf; | |
1170 | pt->read_pos = pt->saved_read_pos; | |
1171 | pt->read_end = pt->saved_read_end; | |
1172 | pt->read_buf_size = pt->saved_read_buf_size; | |
1173 | } | |
1174 | else | |
1175 | offset = 0; | |
1176 | ||
affc96b5 | 1177 | scm_ptobs[SCM_PTOBNUM (port)].end_input (port, offset); |
283a1a0e GH |
1178 | } |
1179 | ||
ee149d03 JB |
1180 | \f |
1181 | ||
1182 | ||
1183 | void | |
a284e297 | 1184 | scm_ungetc (int c, SCM port) |
c6c79933 | 1185 | #define FUNC_NAME "scm_ungetc" |
ee149d03 | 1186 | { |
92c2555f | 1187 | scm_t_port *pt = SCM_PTAB_ENTRY (port); |
840ae05d | 1188 | |
6c951427 GH |
1189 | if (pt->read_buf == pt->putback_buf) |
1190 | /* already using the put-back buffer. */ | |
1191 | { | |
1192 | /* enlarge putback_buf if necessary. */ | |
1193 | if (pt->read_end == pt->read_buf + pt->read_buf_size | |
1194 | && pt->read_buf == pt->read_pos) | |
1195 | { | |
1be6b49c | 1196 | size_t new_size = pt->read_buf_size * 2; |
c6c79933 | 1197 | unsigned char *tmp = (unsigned char *) |
4c9419ac MV |
1198 | scm_gc_realloc (pt->putback_buf, pt->read_buf_size, new_size, |
1199 | "putback buffer"); | |
6c951427 | 1200 | |
6c951427 GH |
1201 | pt->read_pos = pt->read_buf = pt->putback_buf = tmp; |
1202 | pt->read_end = pt->read_buf + pt->read_buf_size; | |
1203 | pt->read_buf_size = pt->putback_buf_size = new_size; | |
1204 | } | |
1205 | ||
1206 | /* shift any existing bytes to buffer + 1. */ | |
1207 | if (pt->read_pos == pt->read_end) | |
1208 | pt->read_end = pt->read_buf + 1; | |
1209 | else if (pt->read_pos != pt->read_buf + 1) | |
1210 | { | |
1211 | int count = pt->read_end - pt->read_pos; | |
1212 | ||
1213 | memmove (pt->read_buf + 1, pt->read_pos, count); | |
1214 | pt->read_end = pt->read_buf + 1 + count; | |
1215 | } | |
1216 | ||
1217 | pt->read_pos = pt->read_buf; | |
1218 | } | |
1219 | else | |
1220 | /* switch to the put-back buffer. */ | |
1221 | { | |
1222 | if (pt->putback_buf == NULL) | |
1223 | { | |
c357d546 | 1224 | pt->putback_buf |
4c9419ac MV |
1225 | = (unsigned char *) scm_gc_malloc (SCM_INITIAL_PUTBACK_BUF_SIZE, |
1226 | "putback buffer"); | |
6c951427 GH |
1227 | pt->putback_buf_size = SCM_INITIAL_PUTBACK_BUF_SIZE; |
1228 | } | |
1229 | ||
1230 | pt->saved_read_buf = pt->read_buf; | |
1231 | pt->saved_read_pos = pt->read_pos; | |
1232 | pt->saved_read_end = pt->read_end; | |
1233 | pt->saved_read_buf_size = pt->read_buf_size; | |
1234 | ||
1235 | pt->read_pos = pt->read_buf = pt->putback_buf; | |
1236 | pt->read_end = pt->read_buf + 1; | |
1237 | pt->read_buf_size = pt->putback_buf_size; | |
1238 | } | |
1239 | ||
1240 | *pt->read_buf = c; | |
ee149d03 | 1241 | |
840ae05d JB |
1242 | if (pt->rw_random) |
1243 | pt->rw_active = SCM_PORT_READ; | |
1244 | ||
ee149d03 JB |
1245 | if (c == '\n') |
1246 | { | |
1247 | /* What should col be in this case? | |
1248 | * We'll leave it at -1. | |
1249 | */ | |
1250 | SCM_LINUM (port) -= 1; | |
1251 | } | |
1252 | else | |
1253 | SCM_COL(port) -= 1; | |
1254 | } | |
c6c79933 | 1255 | #undef FUNC_NAME |
ee149d03 JB |
1256 | |
1257 | ||
1258 | void | |
70d63753 | 1259 | scm_ungets (const char *s, int n, SCM port) |
ee149d03 JB |
1260 | { |
1261 | /* This is simple minded and inefficient, but unreading strings is | |
1262 | * probably not a common operation, and remember that line and | |
1263 | * column numbers have to be handled... | |
1264 | * | |
1265 | * Please feel free to write an optimized version! | |
1266 | */ | |
1267 | while (n--) | |
1268 | scm_ungetc (s[n], port); | |
1269 | } | |
1270 | ||
1271 | ||
3b3b36dd | 1272 | SCM_DEFINE (scm_peek_char, "peek-char", 0, 1, 0, |
1bbd0b84 | 1273 | (SCM port), |
1e6808ea MG |
1274 | "Return the next character available from @var{port},\n" |
1275 | "@emph{without} updating @var{port} to point to the following\n" | |
1276 | "character. If no more characters are available, the\n" | |
c2dfff19 KR |
1277 | "end-of-file object is returned.\n" |
1278 | "\n" | |
1279 | "The value returned by\n" | |
1e6808ea MG |
1280 | "a call to @code{peek-char} is the same as the value that would\n" |
1281 | "have been returned by a call to @code{read-char} on the same\n" | |
1282 | "port. The only difference is that the very next call to\n" | |
1283 | "@code{read-char} or @code{peek-char} on that @var{port} will\n" | |
1284 | "return the value returned by the preceding call to\n" | |
1285 | "@code{peek-char}. In particular, a call to @code{peek-char} on\n" | |
1286 | "an interactive port will hang waiting for input whenever a call\n" | |
c2dfff19 | 1287 | "to @code{read-char} would have hung.") |
1bbd0b84 | 1288 | #define FUNC_NAME s_scm_peek_char |
ee149d03 | 1289 | { |
1a973c42 | 1290 | int c, column; |
ee149d03 | 1291 | if (SCM_UNBNDP (port)) |
9de87eea | 1292 | port = scm_current_input_port (); |
ee149d03 | 1293 | else |
34d19ef6 | 1294 | SCM_VALIDATE_OPINPORT (1, port); |
1a973c42 | 1295 | column = SCM_COL(port); |
ee149d03 JB |
1296 | c = scm_getc (port); |
1297 | if (EOF == c) | |
1298 | return SCM_EOF_VAL; | |
1299 | scm_ungetc (c, port); | |
1a973c42 | 1300 | SCM_COL(port) = column; |
7866a09b | 1301 | return SCM_MAKE_CHAR (c); |
3cb988bd | 1302 | } |
1bbd0b84 | 1303 | #undef FUNC_NAME |
3cb988bd | 1304 | |
1be4270a | 1305 | SCM_DEFINE (scm_unread_char, "unread-char", 1, 1, 0, |
1bbd0b84 | 1306 | (SCM cobj, SCM port), |
b380b885 MD |
1307 | "Place @var{char} in @var{port} so that it will be read by the\n" |
1308 | "next read operation. If called multiple times, the unread characters\n" | |
1309 | "will be read again in last-in first-out order. If @var{port} is\n" | |
1310 | "not supplied, the current input port is used.") | |
1bbd0b84 | 1311 | #define FUNC_NAME s_scm_unread_char |
0f2d19dd JB |
1312 | { |
1313 | int c; | |
1314 | ||
34d19ef6 | 1315 | SCM_VALIDATE_CHAR (1, cobj); |
0f2d19dd | 1316 | if (SCM_UNBNDP (port)) |
9de87eea | 1317 | port = scm_current_input_port (); |
0f2d19dd | 1318 | else |
34d19ef6 | 1319 | SCM_VALIDATE_OPINPORT (2, port); |
0f2d19dd | 1320 | |
7866a09b | 1321 | c = SCM_CHAR (cobj); |
0f2d19dd | 1322 | |
b7f3516f | 1323 | scm_ungetc (c, port); |
0f2d19dd JB |
1324 | return cobj; |
1325 | } | |
1bbd0b84 | 1326 | #undef FUNC_NAME |
0f2d19dd | 1327 | |
a1ec6916 | 1328 | SCM_DEFINE (scm_unread_string, "unread-string", 2, 0, 0, |
1bbd0b84 | 1329 | (SCM str, SCM port), |
b380b885 MD |
1330 | "Place the string @var{str} in @var{port} so that its characters will be\n" |
1331 | "read in subsequent read operations. If called multiple times, the\n" | |
1332 | "unread characters will be read again in last-in first-out order. If\n" | |
1333 | "@var{port} is not supplied, the current-input-port is used.") | |
1bbd0b84 | 1334 | #define FUNC_NAME s_scm_unread_string |
ee1e7e13 | 1335 | { |
34d19ef6 | 1336 | SCM_VALIDATE_STRING (1, str); |
ee1e7e13 | 1337 | if (SCM_UNBNDP (port)) |
9de87eea | 1338 | port = scm_current_input_port (); |
ee1e7e13 | 1339 | else |
34d19ef6 | 1340 | SCM_VALIDATE_OPINPORT (2, port); |
ee1e7e13 | 1341 | |
3a5fb14d | 1342 | scm_ungets (scm_i_string_chars (str), scm_i_string_length (str), port); |
ee1e7e13 MD |
1343 | |
1344 | return str; | |
1345 | } | |
1bbd0b84 | 1346 | #undef FUNC_NAME |
ee1e7e13 | 1347 | |
a1ec6916 | 1348 | SCM_DEFINE (scm_seek, "seek", 3, 0, 0, |
1e6808ea MG |
1349 | (SCM fd_port, SCM offset, SCM whence), |
1350 | "Sets the current position of @var{fd/port} to the integer\n" | |
1351 | "@var{offset}, which is interpreted according to the value of\n" | |
1352 | "@var{whence}.\n" | |
1353 | "\n" | |
1354 | "One of the following variables should be supplied for\n" | |
1355 | "@var{whence}:\n" | |
b380b885 MD |
1356 | "@defvar SEEK_SET\n" |
1357 | "Seek from the beginning of the file.\n" | |
1358 | "@end defvar\n" | |
1359 | "@defvar SEEK_CUR\n" | |
1360 | "Seek from the current position.\n" | |
1361 | "@end defvar\n" | |
1362 | "@defvar SEEK_END\n" | |
1363 | "Seek from the end of the file.\n" | |
1e6808ea MG |
1364 | "@end defvar\n" |
1365 | "If @var{fd/port} is a file descriptor, the underlying system\n" | |
1366 | "call is @code{lseek}. @var{port} may be a string port.\n" | |
1367 | "\n" | |
1368 | "The value returned is the new position in the file. This means\n" | |
1369 | "that the current position of a port can be obtained using:\n" | |
1370 | "@lisp\n" | |
b380b885 | 1371 | "(seek port 0 SEEK_CUR)\n" |
1e6808ea | 1372 | "@end lisp") |
1bbd0b84 | 1373 | #define FUNC_NAME s_scm_seek |
840ae05d | 1374 | { |
840ae05d JB |
1375 | int how; |
1376 | ||
1e6808ea | 1377 | fd_port = SCM_COERCE_OUTPORT (fd_port); |
840ae05d | 1378 | |
a55c2b68 | 1379 | how = scm_to_int (whence); |
840ae05d | 1380 | if (how != SEEK_SET && how != SEEK_CUR && how != SEEK_END) |
1bbd0b84 | 1381 | SCM_OUT_OF_RANGE (3, whence); |
23f2b9a3 | 1382 | |
1e6808ea | 1383 | if (SCM_OPPORTP (fd_port)) |
840ae05d | 1384 | { |
92c2555f | 1385 | scm_t_ptob_descriptor *ptob = scm_ptobs + SCM_PTOBNUM (fd_port); |
23f2b9a3 KR |
1386 | off_t off = scm_to_off_t (offset); |
1387 | off_t rv; | |
840ae05d JB |
1388 | |
1389 | if (!ptob->seek) | |
1bbd0b84 | 1390 | SCM_MISC_ERROR ("port is not seekable", |
1e6808ea | 1391 | scm_cons (fd_port, SCM_EOL)); |
840ae05d | 1392 | else |
1e6808ea | 1393 | rv = ptob->seek (fd_port, off, how); |
23f2b9a3 | 1394 | return scm_from_off_t (rv); |
840ae05d JB |
1395 | } |
1396 | else /* file descriptor?. */ | |
1397 | { | |
23f2b9a3 KR |
1398 | off_t_or_off64_t off = scm_to_off_t_or_off64_t (offset); |
1399 | off_t_or_off64_t rv; | |
1400 | rv = lseek_or_lseek64 (scm_to_int (fd_port), off, how); | |
840ae05d | 1401 | if (rv == -1) |
1bbd0b84 | 1402 | SCM_SYSERROR; |
23f2b9a3 | 1403 | return scm_from_off_t_or_off64_t (rv); |
840ae05d | 1404 | } |
840ae05d | 1405 | } |
1bbd0b84 | 1406 | #undef FUNC_NAME |
840ae05d | 1407 | |
82893676 MG |
1408 | #ifdef __MINGW32__ |
1409 | /* Define this function since it is not supported under Windows. */ | |
1410 | static int truncate (char *file, int length) | |
1411 | { | |
1412 | int ret = -1, fdes; | |
1413 | if ((fdes = open (file, O_BINARY | O_WRONLY)) != -1) | |
1414 | { | |
1415 | ret = chsize (fdes, length); | |
1416 | close (fdes); | |
1417 | } | |
1418 | return ret; | |
1419 | } | |
1420 | #endif /* __MINGW32__ */ | |
1421 | ||
a1ec6916 | 1422 | SCM_DEFINE (scm_truncate_file, "truncate-file", 1, 1, 0, |
1bbd0b84 | 1423 | (SCM object, SCM length), |
1e6808ea MG |
1424 | "Truncates the object referred to by @var{object} to at most\n" |
1425 | "@var{length} bytes. @var{object} can be a string containing a\n" | |
1426 | "file name or an integer file descriptor or a port.\n" | |
1427 | "@var{length} may be omitted if @var{object} is not a file name,\n" | |
7f9994d9 | 1428 | "in which case the truncation occurs at the current port\n" |
1e6808ea | 1429 | "position. The return value is unspecified.") |
1bbd0b84 | 1430 | #define FUNC_NAME s_scm_truncate_file |
840ae05d | 1431 | { |
69bc9ff3 | 1432 | int rv; |
69bc9ff3 | 1433 | |
2b829bbb KR |
1434 | /* "object" can be a port, fdes or filename. |
1435 | ||
1436 | Negative "length" makes no sense, but it's left to truncate() or | |
1437 | ftruncate() to give back an error for that (normally EINVAL). | |
1438 | */ | |
840ae05d | 1439 | |
840ae05d JB |
1440 | if (SCM_UNBNDP (length)) |
1441 | { | |
69bc9ff3 | 1442 | /* must supply length if object is a filename. */ |
7f9994d9 | 1443 | if (scm_is_string (object)) |
34d19ef6 | 1444 | SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL); |
69bc9ff3 | 1445 | |
e11e83f3 | 1446 | length = scm_seek (object, SCM_INUM0, scm_from_int (SEEK_CUR)); |
840ae05d | 1447 | } |
3fe6190f | 1448 | |
69bc9ff3 | 1449 | object = SCM_COERCE_OUTPORT (object); |
e11e83f3 | 1450 | if (scm_is_integer (object)) |
69bc9ff3 | 1451 | { |
23f2b9a3 KR |
1452 | off_t_or_off64_t c_length = scm_to_off_t_or_off64_t (length); |
1453 | SCM_SYSCALL (rv = ftruncate_or_ftruncate64 (scm_to_int (object), | |
1454 | c_length)); | |
69bc9ff3 | 1455 | } |
0c95b57d | 1456 | else if (SCM_OPOUTPORTP (object)) |
69bc9ff3 | 1457 | { |
2b829bbb | 1458 | off_t c_length = scm_to_off_t (length); |
92c2555f MV |
1459 | scm_t_port *pt = SCM_PTAB_ENTRY (object); |
1460 | scm_t_ptob_descriptor *ptob = scm_ptobs + SCM_PTOBNUM (object); | |
69bc9ff3 | 1461 | |
affc96b5 | 1462 | if (!ptob->truncate) |
1bbd0b84 | 1463 | SCM_MISC_ERROR ("port is not truncatable", SCM_EOL); |
69bc9ff3 | 1464 | if (pt->rw_active == SCM_PORT_READ) |
affc96b5 | 1465 | scm_end_input (object); |
69bc9ff3 | 1466 | else if (pt->rw_active == SCM_PORT_WRITE) |
affc96b5 | 1467 | ptob->flush (object); |
69bc9ff3 | 1468 | |
affc96b5 | 1469 | ptob->truncate (object, c_length); |
69bc9ff3 GH |
1470 | rv = 0; |
1471 | } | |
1472 | else | |
1473 | { | |
2b829bbb | 1474 | off_t_or_off64_t c_length = scm_to_off_t_or_off64_t (length); |
7f9994d9 MV |
1475 | char *str = scm_to_locale_string (object); |
1476 | int eno; | |
2b829bbb | 1477 | SCM_SYSCALL (rv = truncate_or_truncate64 (str, c_length)); |
7f9994d9 MV |
1478 | eno = errno; |
1479 | free (str); | |
1480 | errno = eno; | |
69bc9ff3 GH |
1481 | } |
1482 | if (rv == -1) | |
1bbd0b84 | 1483 | SCM_SYSERROR; |
840ae05d JB |
1484 | return SCM_UNSPECIFIED; |
1485 | } | |
1bbd0b84 | 1486 | #undef FUNC_NAME |
840ae05d | 1487 | |
a1ec6916 | 1488 | SCM_DEFINE (scm_port_line, "port-line", 1, 0, 0, |
1bbd0b84 | 1489 | (SCM port), |
a150979d KR |
1490 | "Return the current line number for @var{port}.\n" |
1491 | "\n" | |
1492 | "The first line of a file is 0. But you might want to add 1\n" | |
1493 | "when printing line numbers, since starting from 1 is\n" | |
1494 | "traditional in error messages, and likely to be more natural to\n" | |
1495 | "non-programmers.") | |
1bbd0b84 | 1496 | #define FUNC_NAME s_scm_port_line |
0f2d19dd | 1497 | { |
78446828 | 1498 | port = SCM_COERCE_OUTPORT (port); |
34d19ef6 | 1499 | SCM_VALIDATE_OPENPORT (1, port); |
e11e83f3 | 1500 | return scm_from_int (SCM_LINUM (port)); |
0f2d19dd | 1501 | } |
1bbd0b84 | 1502 | #undef FUNC_NAME |
0f2d19dd | 1503 | |
a1ec6916 | 1504 | SCM_DEFINE (scm_set_port_line_x, "set-port-line!", 2, 0, 0, |
1bbd0b84 | 1505 | (SCM port, SCM line), |
a150979d KR |
1506 | "Set the current line number for @var{port} to @var{line}. The\n" |
1507 | "first line of a file is 0.") | |
1bbd0b84 | 1508 | #define FUNC_NAME s_scm_set_port_line_x |
d043d8c2 | 1509 | { |
360fc44c | 1510 | port = SCM_COERCE_OUTPORT (port); |
34d19ef6 | 1511 | SCM_VALIDATE_OPENPORT (1, port); |
a55c2b68 | 1512 | SCM_PTAB_ENTRY (port)->line_number = scm_to_int (line); |
564478fd | 1513 | return SCM_UNSPECIFIED; |
d043d8c2 | 1514 | } |
1bbd0b84 | 1515 | #undef FUNC_NAME |
d043d8c2 | 1516 | |
a1ec6916 | 1517 | SCM_DEFINE (scm_port_column, "port-column", 1, 0, 0, |
1bbd0b84 | 1518 | (SCM port), |
a150979d KR |
1519 | "Return the current column number of @var{port}.\n" |
1520 | "If the number is\n" | |
b380b885 MD |
1521 | "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n" |
1522 | "- i.e. the first character of the first line is line 0, column 0.\n" | |
1523 | "(However, when you display a file position, for example in an error\n" | |
650a1cf9 | 1524 | "message, we recommend you add 1 to get 1-origin integers. This is\n" |
b380b885 MD |
1525 | "because lines and column numbers traditionally start with 1, and that is\n" |
1526 | "what non-programmers will find most natural.)") | |
1bbd0b84 | 1527 | #define FUNC_NAME s_scm_port_column |
0f2d19dd | 1528 | { |
78446828 | 1529 | port = SCM_COERCE_OUTPORT (port); |
34d19ef6 | 1530 | SCM_VALIDATE_OPENPORT (1, port); |
e11e83f3 | 1531 | return scm_from_int (SCM_COL (port)); |
0f2d19dd | 1532 | } |
1bbd0b84 | 1533 | #undef FUNC_NAME |
0f2d19dd | 1534 | |
a1ec6916 | 1535 | SCM_DEFINE (scm_set_port_column_x, "set-port-column!", 2, 0, 0, |
1bbd0b84 | 1536 | (SCM port, SCM column), |
a150979d KR |
1537 | "Set the current column of @var{port}. Before reading the first\n" |
1538 | "character on a line the column should be 0.") | |
1bbd0b84 | 1539 | #define FUNC_NAME s_scm_set_port_column_x |
d043d8c2 | 1540 | { |
360fc44c | 1541 | port = SCM_COERCE_OUTPORT (port); |
34d19ef6 | 1542 | SCM_VALIDATE_OPENPORT (1, port); |
a55c2b68 | 1543 | SCM_PTAB_ENTRY (port)->column_number = scm_to_int (column); |
564478fd | 1544 | return SCM_UNSPECIFIED; |
d043d8c2 | 1545 | } |
1bbd0b84 | 1546 | #undef FUNC_NAME |
d043d8c2 | 1547 | |
a1ec6916 | 1548 | SCM_DEFINE (scm_port_filename, "port-filename", 1, 0, 0, |
1bbd0b84 | 1549 | (SCM port), |
b380b885 | 1550 | "Return the filename associated with @var{port}. This function returns\n" |
2a2a730b | 1551 | "the strings \"standard input\", \"standard output\" and \"standard error\"\n" |
a3c8b9fc | 1552 | "when called on the current input, output and error ports respectively.") |
1bbd0b84 | 1553 | #define FUNC_NAME s_scm_port_filename |
0f2d19dd | 1554 | { |
78446828 | 1555 | port = SCM_COERCE_OUTPORT (port); |
34d19ef6 | 1556 | SCM_VALIDATE_OPENPORT (1, port); |
b24b5e13 | 1557 | return SCM_FILENAME (port); |
0f2d19dd | 1558 | } |
1bbd0b84 | 1559 | #undef FUNC_NAME |
0f2d19dd | 1560 | |
a1ec6916 | 1561 | SCM_DEFINE (scm_set_port_filename_x, "set-port-filename!", 2, 0, 0, |
1bbd0b84 | 1562 | (SCM port, SCM filename), |
b380b885 MD |
1563 | "Change the filename associated with @var{port}, using the current input\n" |
1564 | "port if none is specified. Note that this does not change the port's\n" | |
1565 | "source of data, but only the value that is returned by\n" | |
1566 | "@code{port-filename} and reported in diagnostic output.") | |
1bbd0b84 | 1567 | #define FUNC_NAME s_scm_set_port_filename_x |
d14af9f2 | 1568 | { |
360fc44c | 1569 | port = SCM_COERCE_OUTPORT (port); |
34d19ef6 | 1570 | SCM_VALIDATE_OPENPORT (1, port); |
360fc44c | 1571 | /* We allow the user to set the filename to whatever he likes. */ |
b24b5e13 DH |
1572 | SCM_SET_FILENAME (port, filename); |
1573 | return SCM_UNSPECIFIED; | |
d14af9f2 | 1574 | } |
1bbd0b84 | 1575 | #undef FUNC_NAME |
d14af9f2 | 1576 | |
f12733c9 MD |
1577 | void |
1578 | scm_print_port_mode (SCM exp, SCM port) | |
1579 | { | |
1580 | scm_puts (SCM_CLOSEDP (exp) | |
1581 | ? "closed: " | |
f9a64404 DH |
1582 | : (SCM_RDNG & SCM_CELL_WORD_0 (exp) |
1583 | ? (SCM_WRTNG & SCM_CELL_WORD_0 (exp) | |
f12733c9 MD |
1584 | ? "input-output: " |
1585 | : "input: ") | |
f9a64404 | 1586 | : (SCM_WRTNG & SCM_CELL_WORD_0 (exp) |
f12733c9 MD |
1587 | ? "output: " |
1588 | : "bogus: ")), | |
1589 | port); | |
1590 | } | |
1cc91f1b | 1591 | |
f12733c9 | 1592 | int |
e81d98ec | 1593 | scm_port_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED) |
0f2d19dd | 1594 | { |
f12733c9 MD |
1595 | char *type = SCM_PTOBNAME (SCM_PTOBNUM (exp)); |
1596 | if (!type) | |
1597 | type = "port"; | |
b7f3516f | 1598 | scm_puts ("#<", port); |
f12733c9 | 1599 | scm_print_port_mode (exp, port); |
b7f3516f TT |
1600 | scm_puts (type, port); |
1601 | scm_putc (' ', port); | |
0345e278 | 1602 | scm_uintprint (SCM_CELL_WORD_1 (exp), 16, port); |
b7f3516f | 1603 | scm_putc ('>', port); |
f12733c9 | 1604 | return 1; |
0f2d19dd JB |
1605 | } |
1606 | ||
0f2d19dd JB |
1607 | void |
1608 | scm_ports_prehistory () | |
0f2d19dd JB |
1609 | { |
1610 | scm_numptob = 0; | |
67329a9e | 1611 | scm_ptobs = (scm_t_ptob_descriptor *) scm_malloc (sizeof (scm_t_ptob_descriptor)); |
0f2d19dd | 1612 | } |
0f2d19dd JB |
1613 | |
1614 | \f | |
ee149d03 | 1615 | |
d68fee48 | 1616 | /* Void ports. */ |
0f2d19dd | 1617 | |
92c2555f | 1618 | scm_t_bits scm_tc16_void_port = 0; |
0f2d19dd | 1619 | |
e81d98ec | 1620 | static int fill_input_void_port (SCM port SCM_UNUSED) |
283a1a0e | 1621 | { |
70df8af6 | 1622 | return EOF; |
283a1a0e GH |
1623 | } |
1624 | ||
31703ab8 | 1625 | static void |
e81d98ec DH |
1626 | write_void_port (SCM port SCM_UNUSED, |
1627 | const void *data SCM_UNUSED, | |
1628 | size_t size SCM_UNUSED) | |
31703ab8 GH |
1629 | { |
1630 | } | |
1631 | ||
d617ee18 MV |
1632 | static SCM |
1633 | scm_i_void_port (long mode_bits) | |
0f2d19dd | 1634 | { |
9de87eea | 1635 | scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex); |
402788a9 | 1636 | { |
da220f27 HWN |
1637 | SCM answer = scm_new_port_table_entry (scm_tc16_void_port); |
1638 | scm_t_port * pt = SCM_PTAB_ENTRY(answer); | |
1639 | ||
402788a9 | 1640 | scm_port_non_buffer (pt); |
402788a9 HWN |
1641 | |
1642 | SCM_SETSTREAM (answer, 0); | |
1643 | SCM_SET_CELL_TYPE (answer, scm_tc16_void_port | mode_bits); | |
9de87eea | 1644 | scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex); |
402788a9 HWN |
1645 | return answer; |
1646 | } | |
0f2d19dd JB |
1647 | } |
1648 | ||
d617ee18 MV |
1649 | SCM |
1650 | scm_void_port (char *mode_str) | |
1651 | { | |
1652 | return scm_i_void_port (scm_mode_bits (mode_str)); | |
1653 | } | |
1654 | ||
a1ec6916 | 1655 | SCM_DEFINE (scm_sys_make_void_port, "%make-void-port", 1, 0, 0, |
1bbd0b84 | 1656 | (SCM mode), |
70df8af6 | 1657 | "Create and return a new void port. A void port acts like\n" |
bb2c02f2 | 1658 | "@file{/dev/null}. The @var{mode} argument\n" |
70df8af6 | 1659 | "specifies the input/output modes for this port: see the\n" |
b380b885 | 1660 | "documentation for @code{open-file} in @ref{File Ports}.") |
1bbd0b84 | 1661 | #define FUNC_NAME s_scm_sys_make_void_port |
0f2d19dd | 1662 | { |
d617ee18 | 1663 | return scm_i_void_port (scm_i_mode_bits (mode)); |
0f2d19dd | 1664 | } |
1bbd0b84 | 1665 | #undef FUNC_NAME |
0f2d19dd | 1666 | |
0f2d19dd | 1667 | \f |
89545eba | 1668 | /* Initialization. */ |
1cc91f1b | 1669 | |
0f2d19dd JB |
1670 | void |
1671 | scm_init_ports () | |
0f2d19dd | 1672 | { |
840ae05d | 1673 | /* lseek() symbols. */ |
e11e83f3 MV |
1674 | scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET)); |
1675 | scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR)); | |
1676 | scm_c_define ("SEEK_END", scm_from_int (SEEK_END)); | |
840ae05d | 1677 | |
70df8af6 GH |
1678 | scm_tc16_void_port = scm_make_port_type ("void", fill_input_void_port, |
1679 | write_void_port); | |
9de87eea MV |
1680 | |
1681 | cur_inport_fluid = scm_permanent_object (scm_make_fluid ()); | |
1682 | cur_outport_fluid = scm_permanent_object (scm_make_fluid ()); | |
1683 | cur_errport_fluid = scm_permanent_object (scm_make_fluid ()); | |
1684 | cur_loadport_fluid = scm_permanent_object (scm_make_fluid ()); | |
1685 | ||
a0599745 | 1686 | #include "libguile/ports.x" |
0f2d19dd | 1687 | } |
89e00824 ML |
1688 | |
1689 | /* | |
1690 | Local Variables: | |
1691 | c-file-style: "gnu" | |
1692 | End: | |
1693 | */ |