Commit | Line | Data |
---|---|---|
0f2d19dd JB |
1 | /* classes: h_files */ |
2 | ||
22a52da1 DH |
3 | #ifndef SCM_PORTS_H |
4 | #define SCM_PORTS_H | |
8c494e99 | 5 | |
a9178715 LC |
6 | /* Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2003, 2004, |
7 | * 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. | |
8c494e99 | 8 | * |
73be1d9e | 9 | * This library is free software; you can redistribute it and/or |
53befeb7 NJ |
10 | * modify it under the terms of the GNU Lesser General Public License |
11 | * as published by the Free Software Foundation; either version 3 of | |
12 | * the License, or (at your option) any later version. | |
8c494e99 | 13 | * |
53befeb7 NJ |
14 | * This library is distributed in the hope that it will be useful, but |
15 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
73be1d9e MV |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
17 | * Lesser General Public License for more details. | |
8c494e99 | 18 | * |
73be1d9e MV |
19 | * You should have received a copy of the GNU Lesser General Public |
20 | * License along with this library; if not, write to the Free Software | |
53befeb7 NJ |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
22 | * 02110-1301 USA | |
73be1d9e | 23 | */ |
d3a6bc94 | 24 | |
0f2d19dd | 25 | \f |
8c494e99 | 26 | |
b4309c3c | 27 | #include "libguile/__scm.h" |
0f2d19dd | 28 | |
fca14149 AW |
29 | #include <stdio.h> |
30 | #include <string.h> | |
0c247c33 | 31 | #include <unistd.h> |
fca14149 AW |
32 | #include "libguile/gc.h" |
33 | #include "libguile/tags.h" | |
34 | #include "libguile/error.h" | |
e0d86ad2 | 35 | #include "libguile/print.h" |
78446828 | 36 | #include "libguile/struct.h" |
b9ad392e | 37 | #include "libguile/threads.h" |
889975e5 | 38 | #include "libguile/strings.h" |
acdb12da | 39 | |
0f2d19dd JB |
40 | \f |
41 | ||
6c951427 | 42 | #define SCM_INITIAL_PUTBACK_BUF_SIZE 4 |
0855ef71 | 43 | |
61e452ba | 44 | /* values for the rw_active flag. */ |
92c2555f | 45 | typedef enum scm_t_port_rw_active { |
61e452ba JB |
46 | SCM_PORT_NEITHER = 0, |
47 | SCM_PORT_READ = 1, | |
48 | SCM_PORT_WRITE = 2 | |
92c2555f | 49 | } scm_t_port_rw_active; |
61e452ba | 50 | |
840ae05d JB |
51 | /* C representation of a Scheme port. */ |
52 | ||
53 | typedef struct | |
0f2d19dd | 54 | { |
ee149d03 | 55 | SCM port; /* Link back to the port object. */ |
30b126d2 AW |
56 | #if SCM_USE_PTHREAD_THREADS |
57 | scm_i_pthread_mutex_t lock; /* A recursive lock for this port. */ | |
58 | #endif | |
59 | ||
0f2d19dd JB |
60 | int revealed; /* 0 not revealed, > 1 revealed. |
61 | * Revealed ports do not get GC'd. | |
62 | */ | |
74a16888 | 63 | /* data for the underlying port implementation as a raw C value. */ |
92c2555f | 64 | scm_t_bits stream; |
0f2d19dd | 65 | |
0855ef71 | 66 | SCM file_name; /* debugging support. */ |
1be6b49c | 67 | long line_number; /* debugging support. */ |
ebf7394e | 68 | int column_number; /* debugging support. */ |
0855ef71 | 69 | |
889975e5 MG |
70 | /* Character encoding support */ |
71 | char *encoding; | |
72 | scm_t_string_failed_conversion_handler ilseq_handler; | |
73 | ||
ee149d03 JB |
74 | /* port buffers. the buffer(s) are set up for all ports. |
75 | in the case of string ports, the buffer is the string itself. | |
76 | in the case of unbuffered file ports, the buffer is a | |
77 | single char: shortbuf. */ | |
78 | ||
79 | /* this buffer is filled from read_buf to read_end using the ptob | |
80 | buffer_fill. then input requests are taken from read_pos until | |
81 | it reaches read_end. */ | |
82 | ||
83 | unsigned char *read_buf; /* buffer start. */ | |
840ae05d | 84 | const unsigned char *read_pos;/* the next unread char. */ |
ee149d03 | 85 | unsigned char *read_end; /* pointer to last buffered char + 1. */ |
f1ce9199 | 86 | scm_t_off read_buf_size; /* size of the buffer. */ |
ee149d03 | 87 | |
6c951427 GH |
88 | /* when chars are put back into the buffer, e.g., using peek-char or |
89 | unread-string, the read-buffer pointers are switched to cbuf. | |
90 | the original pointers are saved here and restored when the put-back | |
91 | chars have been consumed. */ | |
92 | unsigned char *saved_read_buf; | |
93 | const unsigned char *saved_read_pos; | |
94 | unsigned char *saved_read_end; | |
f1ce9199 | 95 | scm_t_off saved_read_buf_size; |
6c951427 | 96 | |
ee149d03 JB |
97 | /* write requests are saved into this buffer at write_pos until it |
98 | reaches write_buf + write_buf_size, then the ptob flush is | |
99 | called. */ | |
100 | ||
6c951427 | 101 | unsigned char *write_buf; /* buffer start. */ |
ee149d03 JB |
102 | unsigned char *write_pos; /* pointer to last buffered char + 1. */ |
103 | unsigned char *write_end; /* pointer to end of buffer + 1. */ | |
f1ce9199 | 104 | scm_t_off write_buf_size; /* size of the buffer. */ |
ee149d03 JB |
105 | |
106 | unsigned char shortbuf; /* buffer for "unbuffered" streams. */ | |
107 | ||
0de97b83 GH |
108 | int rw_random; /* true if the port is random access. |
109 | implies that the buffers must be | |
110 | flushed before switching between | |
111 | reading and writing, seeking, etc. */ | |
112 | ||
92c2555f | 113 | scm_t_port_rw_active rw_active; /* for random access ports, |
1be6b49c ML |
114 | indicates which of the buffers |
115 | is currently in use. can be | |
116 | SCM_PORT_WRITE, SCM_PORT_READ, | |
117 | or SCM_PORT_NEITHER. */ | |
ee149d03 | 118 | |
61e452ba | 119 | |
6c951427 GH |
120 | /* a buffer for un-read chars and strings. */ |
121 | unsigned char *putback_buf; | |
1be6b49c | 122 | size_t putback_buf_size; /* allocated size of putback_buf. */ |
f4bc4e59 LC |
123 | |
124 | /* input/output iconv conversion descriptors */ | |
125 | void *input_cd; | |
126 | void *output_cd; | |
92c2555f | 127 | } scm_t_port; |
840ae05d | 128 | |
5dbc6c06 | 129 | |
2721f918 | 130 | SCM_INTERNAL SCM scm_i_port_weak_set; |
5dbc6c06 | 131 | |
0f2d19dd | 132 | |
6fe692e9 | 133 | #define SCM_READ_BUFFER_EMPTY_P(c_port) (c_port->read_pos >= c_port->read_end) |
0f2d19dd JB |
134 | |
135 | \f | |
136 | ||
bc36d050 | 137 | #define SCM_EOF_OBJECT_P(x) (scm_is_eq ((x), SCM_EOF_VAL)) |
0c32d76c | 138 | |
0f2d19dd | 139 | /* PORT FLAGS |
dbece3a2 | 140 | * A set of flags characterizes a port. |
571031dc JB |
141 | * Note that we reserve the bits 1 << 24 and above for use by the |
142 | * routines in the port's scm_ptobfuns structure. | |
0f2d19dd JB |
143 | */ |
144 | #define SCM_OPN (1L<<16) /* Is the port open? */ | |
145 | #define SCM_RDNG (2L<<16) /* Is it a readable port? */ | |
146 | #define SCM_WRTNG (4L<<16) /* Is it writable? */ | |
ee149d03 | 147 | #define SCM_BUF0 (8L<<16) /* Is it unbuffered? */ |
ee149d03 | 148 | #define SCM_BUFLINE (64L<<16) /* Is it line-buffered? */ |
0f2d19dd | 149 | |
dc7da0be AW |
150 | #define SCM_PORTP(x) (SCM_HAS_TYP7 (x, scm_tc7_port)) |
151 | #define SCM_OPPORTP(x) (SCM_PORTP (x) && (SCM_CELL_WORD_0 (x) & SCM_OPN)) | |
152 | #define SCM_INPUT_PORT_P(x) (SCM_PORTP (x) && (SCM_CELL_WORD_0 (x) & SCM_RDNG)) | |
153 | #define SCM_OUTPUT_PORT_P(x) (SCM_PORTP (x) && (SCM_CELL_WORD_0 (x) & SCM_WRTNG)) | |
154 | #define SCM_OPINPORTP(x) (SCM_OPPORTP (x) && SCM_INPUT_PORT_P (x)) | |
155 | #define SCM_OPOUTPORTP(x) (SCM_OPPORTP (x) && SCM_OUTPUT_PORT_P (x)) | |
156 | #define SCM_OPENP(x) (SCM_OPPORTP (x)) | |
157 | #define SCM_CLOSEDP(x) (!SCM_OPENP (x)) | |
22a52da1 DH |
158 | #define SCM_CLR_PORT_OPEN_FLAG(p) \ |
159 | SCM_SET_CELL_WORD_0 ((p), SCM_CELL_WORD_0 (p) & ~SCM_OPN) | |
843524cc | 160 | |
92c2555f | 161 | #define SCM_PTAB_ENTRY(x) ((scm_t_port *) SCM_CELL_WORD_1 (x)) |
62bd5d66 | 162 | #define SCM_PORT_DESCRIPTOR(port) ((scm_t_ptob_descriptor *) SCM_CELL_WORD_2 (port)) |
34d19ef6 | 163 | #define SCM_SETPTAB_ENTRY(x, ent) (SCM_SET_CELL_WORD_1 ((x), (scm_t_bits) (ent))) |
843524cc | 164 | #define SCM_STREAM(x) (SCM_PTAB_ENTRY(x)->stream) |
34d19ef6 | 165 | #define SCM_SETSTREAM(x, s) (SCM_PTAB_ENTRY(x)->stream = (scm_t_bits) (s)) |
843524cc | 166 | #define SCM_FILENAME(x) (SCM_PTAB_ENTRY(x)->file_name) |
b24b5e13 | 167 | #define SCM_SET_FILENAME(x, n) (SCM_PTAB_ENTRY(x)->file_name = (n)) |
843524cc DH |
168 | #define SCM_LINUM(x) (SCM_PTAB_ENTRY(x)->line_number) |
169 | #define SCM_COL(x) (SCM_PTAB_ENTRY(x)->column_number) | |
170 | #define SCM_REVEALED(x) (SCM_PTAB_ENTRY(x)->revealed) | |
34d19ef6 | 171 | #define SCM_SETREVEALED(x, s) (SCM_PTAB_ENTRY(x)->revealed = (s)) |
0f2d19dd | 172 | |
b0799290 MG |
173 | #define SCM_INCLINE(port) do {SCM_LINUM (port) += 1; SCM_COL (port) = 0;} while (0) |
174 | #define SCM_ZEROCOL(port) do {SCM_COL (port) = 0;} while (0) | |
175 | #define SCM_INCCOL(port) do {SCM_COL (port) += 1;} while (0) | |
176 | #define SCM_DECCOL(port) do {if (SCM_COL (port) > 0) SCM_COL (port) -= 1;} while (0) | |
177 | #define SCM_TABCOL(port) do {SCM_COL (port) += 8 - SCM_COL (port) % 8;} while (0) | |
0f2d19dd | 178 | |
0953b549 LC |
179 | /* Maximum number of port types. */ |
180 | #define SCM_I_MAX_PORT_TYPE_COUNT 256 | |
181 | ||
0f2d19dd JB |
182 | \f |
183 | ||
affc96b5 | 184 | /* port-type description. */ |
92c2555f | 185 | typedef struct scm_t_ptob_descriptor |
0f82baf6 | 186 | { |
f12733c9 | 187 | char *name; |
0c0669cc | 188 | SCM (*mark) (SCM); |
1be6b49c | 189 | size_t (*free) (SCM); |
0c0669cc JB |
190 | int (*print) (SCM exp, SCM port, scm_print_state *pstate); |
191 | SCM (*equalp) (SCM, SCM); | |
affc96b5 GH |
192 | int (*close) (SCM port); |
193 | ||
8aa011a1 | 194 | void (*write) (SCM port, const void *data, size_t size); |
affc96b5 GH |
195 | void (*flush) (SCM port); |
196 | ||
197 | void (*end_input) (SCM port, int offset); | |
198 | int (*fill_input) (SCM port); | |
199 | int (*input_waiting) (SCM port); | |
200 | ||
f1ce9199 LC |
201 | scm_t_off (*seek) (SCM port, scm_t_off OFFSET, int WHENCE); |
202 | void (*truncate) (SCM port, scm_t_off length); | |
affc96b5 | 203 | |
92c2555f | 204 | } scm_t_ptob_descriptor; |
1be6b49c | 205 | |
12a8b769 DH |
206 | #define SCM_TC2PTOBNUM(x) (0x0ff & ((x) >> 8)) |
207 | #define SCM_PTOBNUM(x) (SCM_TC2PTOBNUM (SCM_CELL_TYPE (x))) | |
f12733c9 | 208 | /* SCM_PTOBNAME can be 0 if name is missing */ |
62bd5d66 | 209 | #define SCM_PTOBNAME(ptobnum) (scm_c_port_type_ref (ptobnum)->name) |
0f2d19dd | 210 | |
a535e9f5 | 211 | /* Port types, and their vtables. */ |
62bd5d66 AW |
212 | SCM_INTERNAL long scm_c_num_port_types (void); |
213 | SCM_API scm_t_ptob_descriptor* scm_c_port_type_ref (long ptobnum); | |
214 | SCM_API long scm_c_port_type_add_x (scm_t_ptob_descriptor *desc); | |
33b001fd MV |
215 | SCM_API scm_t_bits scm_make_port_type (char *name, |
216 | int (*fill_input) (SCM port), | |
217 | void (*write) (SCM port, | |
218 | const void *data, | |
219 | size_t size)); | |
23f2b9a3 KR |
220 | SCM_API void scm_set_port_mark (scm_t_bits tc, SCM (*mark) (SCM)); |
221 | SCM_API void scm_set_port_free (scm_t_bits tc, size_t (*free) (SCM)); | |
222 | SCM_API void scm_set_port_print (scm_t_bits tc, | |
33b001fd MV |
223 | int (*print) (SCM exp, |
224 | SCM port, | |
225 | scm_print_state *pstate)); | |
23f2b9a3 KR |
226 | SCM_API void scm_set_port_equalp (scm_t_bits tc, SCM (*equalp) (SCM, SCM)); |
227 | SCM_API void scm_set_port_close (scm_t_bits tc, int (*close) (SCM)); | |
33b001fd | 228 | |
62bd5d66 | 229 | SCM_API void scm_set_port_flush (scm_t_bits tc, void (*flush) (SCM port)); |
23f2b9a3 | 230 | SCM_API void scm_set_port_end_input (scm_t_bits tc, |
62bd5d66 AW |
231 | void (*end_input) (SCM port, |
232 | int offset)); | |
23f2b9a3 | 233 | SCM_API void scm_set_port_seek (scm_t_bits tc, |
f1ce9199 LC |
234 | scm_t_off (*seek) (SCM port, |
235 | scm_t_off OFFSET, | |
236 | int WHENCE)); | |
23f2b9a3 | 237 | SCM_API void scm_set_port_truncate (scm_t_bits tc, |
33b001fd | 238 | void (*truncate) (SCM port, |
f1ce9199 | 239 | scm_t_off length)); |
23f2b9a3 | 240 | SCM_API void scm_set_port_input_waiting (scm_t_bits tc, int (*input_waiting) (SCM)); |
a535e9f5 AW |
241 | |
242 | /* The input, output, error, and load ports. */ | |
33b001fd MV |
243 | SCM_API SCM scm_current_input_port (void); |
244 | SCM_API SCM scm_current_output_port (void); | |
245 | SCM_API SCM scm_current_error_port (void); | |
246 | SCM_API SCM scm_current_load_port (void); | |
247 | SCM_API SCM scm_set_current_input_port (SCM port); | |
248 | SCM_API SCM scm_set_current_output_port (SCM port); | |
249 | SCM_API SCM scm_set_current_error_port (SCM port); | |
661ae7ab MV |
250 | SCM_API void scm_dynwind_current_input_port (SCM port); |
251 | SCM_API void scm_dynwind_current_output_port (SCM port); | |
252 | SCM_API void scm_dynwind_current_error_port (SCM port); | |
a535e9f5 AW |
253 | SCM_INTERNAL void scm_i_dynwind_current_load_port (SCM port); |
254 | ||
255 | /* Mode bits. */ | |
256 | SCM_INTERNAL long scm_i_mode_bits (SCM modes); | |
257 | SCM_API long scm_mode_bits (char *modes); | |
258 | SCM_API SCM scm_port_mode (SCM port); | |
2721f918 | 259 | |
a535e9f5 | 260 | /* Low-level constructors. */ |
2721f918 AW |
261 | SCM_API SCM |
262 | scm_c_make_port_with_encoding (scm_t_bits tag, | |
263 | unsigned long mode_bits, | |
264 | const char *encoding, | |
265 | scm_t_string_failed_conversion_handler handler, | |
266 | scm_t_bits stream); | |
267 | SCM_API SCM scm_c_make_port (scm_t_bits tag, unsigned long mode_bits, | |
268 | scm_t_bits stream); | |
891702ea | 269 | SCM_API SCM scm_new_port_table_entry (scm_t_bits tag); |
2721f918 | 270 | |
a535e9f5 AW |
271 | /* Predicates. */ |
272 | SCM_API SCM scm_port_p (SCM x); | |
273 | SCM_API SCM scm_input_port_p (SCM x); | |
274 | SCM_API SCM scm_output_port_p (SCM x); | |
275 | SCM_API SCM scm_port_closed_p (SCM port); | |
276 | SCM_API SCM scm_eof_object_p (SCM x); | |
277 | ||
278 | /* Closing ports. */ | |
279 | SCM_API SCM scm_close_port (SCM port); | |
280 | SCM_API SCM scm_close_input_port (SCM port); | |
281 | SCM_API SCM scm_close_output_port (SCM port); | |
282 | ||
283 | /* Encoding characters to byte streams, and decoding byte streams to | |
284 | characters. */ | |
285 | SCM_INTERNAL const char *scm_i_default_port_encoding (void); | |
286 | SCM_INTERNAL void scm_i_set_default_port_encoding (const char *); | |
287 | SCM_INTERNAL void scm_i_set_port_encoding_x (SCM port, const char *str); | |
288 | SCM_API SCM scm_port_encoding (SCM port); | |
289 | SCM_API SCM scm_set_port_encoding_x (SCM port, SCM encoding); | |
290 | SCM_INTERNAL scm_t_string_failed_conversion_handler scm_i_get_conversion_strategy (SCM port); | |
291 | SCM_INTERNAL void scm_i_set_conversion_strategy_x (SCM port, | |
292 | scm_t_string_failed_conversion_handler h); | |
293 | SCM_API SCM scm_port_conversion_strategy (SCM port); | |
294 | SCM_API SCM scm_set_port_conversion_strategy_x (SCM port, SCM behavior); | |
295 | ||
296 | /* Acquiring and releasing the port lock. */ | |
14dcb5cc | 297 | SCM_API void scm_dynwind_lock_port (SCM port); |
285ac79b AW |
298 | SCM_INLINE int scm_c_lock_port (SCM port); |
299 | SCM_INLINE int scm_c_try_lock_port (SCM port); | |
300 | SCM_INLINE int scm_c_unlock_port (SCM port); | |
30b126d2 | 301 | |
19b8d12b | 302 | /* Revealed counts. */ |
33b001fd MV |
303 | SCM_API int scm_revealed_count (SCM port); |
304 | SCM_API SCM scm_port_revealed (SCM port); | |
305 | SCM_API SCM scm_set_port_revealed_x (SCM port, SCM rcount); | |
b262d306 | 306 | SCM_API SCM scm_adjust_port_revealed_x (SCM port, SCM addend); |
a535e9f5 AW |
307 | |
308 | /* Input. */ | |
0d959103 | 309 | SCM_API int scm_get_byte_or_eof (SCM port); |
0d959103 | 310 | SCM_INLINE int scm_get_byte_or_eof_unlocked (SCM port); |
c932ce0b | 311 | SCM_API int scm_peek_byte_or_eof (SCM port); |
0d959103 | 312 | SCM_INLINE int scm_peek_byte_or_eof_unlocked (SCM port); |
33b001fd | 313 | SCM_API size_t scm_c_read (SCM port, void *buffer, size_t size); |
be632904 | 314 | SCM_API size_t scm_c_read_unlocked (SCM port, void *buffer, size_t size); |
a535e9f5 | 315 | SCM_API scm_t_wchar scm_getc (SCM port); |
be632904 | 316 | SCM_API scm_t_wchar scm_getc_unlocked (SCM port); |
a535e9f5 AW |
317 | SCM_API SCM scm_read_char (SCM port); |
318 | ||
319 | /* Pushback. */ | |
320 | SCM_INTERNAL void scm_unget_byte (int c, SCM port); | |
c932ce0b | 321 | SCM_INTERNAL void scm_unget_byte_unlocked (int c, SCM port); |
a535e9f5 | 322 | SCM_API void scm_ungetc (scm_t_wchar c, SCM port); |
c932ce0b | 323 | SCM_API void scm_ungetc_unlocked (scm_t_wchar c, SCM port); |
a535e9f5 | 324 | SCM_API void scm_ungets (const char *s, int n, SCM port); |
c932ce0b | 325 | SCM_API void scm_ungets_unlocked (const char *s, int n, SCM port); |
19b8d12b | 326 | SCM_API SCM scm_peek_char (SCM port); |
a535e9f5 AW |
327 | SCM_API SCM scm_unread_char (SCM cobj, SCM port); |
328 | SCM_API SCM scm_unread_string (SCM str, SCM port); | |
329 | ||
330 | /* Manipulating the buffers. */ | |
331 | SCM_API void scm_port_non_buffer (scm_t_port *pt); | |
332 | SCM_API int scm_fill_input (SCM port); | |
4251ae2e | 333 | SCM_API int scm_fill_input_unlocked (SCM port); |
a535e9f5 AW |
334 | SCM_INTERNAL size_t scm_take_from_input_buffers (SCM port, char *dest, size_t read_len); |
335 | SCM_API SCM scm_drain_input (SCM port); | |
336 | SCM_API void scm_end_input (SCM port); | |
4251ae2e | 337 | SCM_API void scm_end_input_unlocked (SCM port); |
a535e9f5 AW |
338 | SCM_API SCM scm_force_output (SCM port); |
339 | SCM_API void scm_flush (SCM port); | |
4251ae2e | 340 | SCM_API void scm_flush_unlocked (SCM port); |
a535e9f5 AW |
341 | |
342 | /* Output. */ | |
0607ebbf AW |
343 | SCM_API void scm_putc (char c, SCM port); |
344 | SCM_INLINE void scm_putc_unlocked (char c, SCM port); | |
345 | SCM_API void scm_puts (const char *str_data, SCM port); | |
346 | SCM_INLINE void scm_puts_unlocked (const char *str_data, SCM port); | |
33b001fd | 347 | SCM_API void scm_c_write (SCM port, const void *buffer, size_t size); |
f209aeee | 348 | SCM_API void scm_c_write_unlocked (SCM port, const void *buffer, size_t size); |
33b001fd | 349 | SCM_API void scm_lfwrite (const char *ptr, size_t size, SCM port); |
f209aeee | 350 | SCM_API void scm_lfwrite_unlocked (const char *ptr, size_t size, SCM port); |
9c44cd45 MG |
351 | SCM_INTERNAL void scm_lfwrite_substr (SCM str, size_t start, size_t end, |
352 | SCM port); | |
a535e9f5 AW |
353 | |
354 | /* Querying and setting positions, and character availability. */ | |
355 | SCM_API SCM scm_char_ready_p (SCM port); | |
33b001fd MV |
356 | SCM_API SCM scm_seek (SCM object, SCM offset, SCM whence); |
357 | SCM_API SCM scm_truncate_file (SCM object, SCM length); | |
358 | SCM_API SCM scm_port_line (SCM port); | |
359 | SCM_API SCM scm_set_port_line_x (SCM port, SCM line); | |
360 | SCM_API SCM scm_port_column (SCM port); | |
361 | SCM_API SCM scm_set_port_column_x (SCM port, SCM line); | |
362 | SCM_API SCM scm_port_filename (SCM port); | |
363 | SCM_API SCM scm_set_port_filename_x (SCM port, SCM filename); | |
a535e9f5 AW |
364 | |
365 | /* Implementation helpers for port printing functions. */ | |
33b001fd MV |
366 | SCM_API int scm_port_print (SCM exp, SCM port, scm_print_state *); |
367 | SCM_API void scm_print_port_mode (SCM exp, SCM port); | |
a535e9f5 AW |
368 | |
369 | /* Iterating over all ports. */ | |
370 | SCM_API SCM scm_port_for_each (SCM proc); | |
371 | SCM_API void scm_c_port_for_each (void (*proc)(void *data, SCM p), void *data); | |
372 | SCM_API SCM scm_flush_all_ports (void); | |
373 | ||
374 | /* Void ports. */ | |
33b001fd MV |
375 | SCM_API SCM scm_void_port (char * mode_str); |
376 | SCM_API SCM scm_sys_make_void_port (SCM mode); | |
d617ee18 | 377 | |
a535e9f5 AW |
378 | /* Initialization. */ |
379 | SCM_INTERNAL void scm_init_ports (void); | |
d617ee18 MV |
380 | |
381 | ||
fca14149 AW |
382 | /* Inline function implementations. */ |
383 | ||
384 | #if SCM_CAN_INLINE || defined SCM_INLINE_C_IMPLEMENTING_INLINES | |
385 | SCM_INLINE_IMPLEMENTATION int | |
285ac79b | 386 | scm_c_lock_port (SCM port) |
fca14149 | 387 | { |
b86b70fe | 388 | #if 0 && SCM_USE_PTHREAD_THREADS |
285ac79b | 389 | return scm_i_pthread_mutex_lock (&SCM_PTAB_ENTRY (port)->lock); |
fca14149 AW |
390 | #else |
391 | return 0; | |
392 | #endif | |
393 | } | |
394 | ||
395 | SCM_INLINE_IMPLEMENTATION int | |
285ac79b | 396 | scm_c_try_lock_port (SCM port) |
fca14149 | 397 | { |
b86b70fe | 398 | #if 0 && SCM_USE_PTHREAD_THREADS |
285ac79b | 399 | return scm_i_pthread_mutex_trylock (&SCM_PTAB_ENTRY (port)->lock); |
fca14149 AW |
400 | #else |
401 | return 0; | |
402 | #endif | |
403 | } | |
404 | ||
405 | SCM_INLINE_IMPLEMENTATION int | |
285ac79b | 406 | scm_c_unlock_port (SCM port) |
fca14149 | 407 | { |
b86b70fe | 408 | #if 0 && SCM_USE_PTHREAD_THREADS |
285ac79b | 409 | return scm_i_pthread_mutex_unlock (&SCM_PTAB_ENTRY (port)->lock); |
fca14149 AW |
410 | #else |
411 | return 0; | |
412 | #endif | |
413 | } | |
414 | ||
415 | SCM_INLINE_IMPLEMENTATION int | |
0d959103 | 416 | scm_get_byte_or_eof_unlocked (SCM port) |
fca14149 AW |
417 | { |
418 | int c; | |
419 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
420 | ||
421 | if (pt->rw_active == SCM_PORT_WRITE) | |
422 | /* may be marginally faster than calling scm_flush. */ | |
62bd5d66 | 423 | SCM_PORT_DESCRIPTOR (port)->flush (port); |
fca14149 AW |
424 | |
425 | if (pt->rw_random) | |
426 | pt->rw_active = SCM_PORT_READ; | |
427 | ||
428 | if (pt->read_pos >= pt->read_end) | |
429 | { | |
4251ae2e | 430 | if (SCM_UNLIKELY (scm_fill_input_unlocked (port) == EOF)) |
fca14149 AW |
431 | return EOF; |
432 | } | |
433 | ||
434 | c = *(pt->read_pos++); | |
435 | ||
436 | return c; | |
437 | } | |
438 | ||
439 | /* Like `scm_get_byte_or_eof' but does not change PORT's `read_pos'. */ | |
440 | SCM_INLINE_IMPLEMENTATION int | |
0d959103 | 441 | scm_peek_byte_or_eof_unlocked (SCM port) |
fca14149 AW |
442 | { |
443 | int c; | |
444 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
445 | ||
446 | if (pt->rw_active == SCM_PORT_WRITE) | |
447 | /* may be marginally faster than calling scm_flush. */ | |
62bd5d66 | 448 | SCM_PORT_DESCRIPTOR (port)->flush (port); |
fca14149 AW |
449 | |
450 | if (pt->rw_random) | |
451 | pt->rw_active = SCM_PORT_READ; | |
452 | ||
453 | if (pt->read_pos >= pt->read_end) | |
454 | { | |
4251ae2e | 455 | if (SCM_UNLIKELY (scm_fill_input_unlocked (port) == EOF)) |
fca14149 AW |
456 | return EOF; |
457 | } | |
458 | ||
459 | c = *pt->read_pos; | |
460 | ||
461 | return c; | |
462 | } | |
463 | ||
464 | SCM_INLINE_IMPLEMENTATION void | |
0607ebbf | 465 | scm_putc_unlocked (char c, SCM port) |
fca14149 AW |
466 | { |
467 | SCM_ASSERT_TYPE (SCM_OPOUTPORTP (port), port, 0, NULL, "output port"); | |
f209aeee | 468 | scm_lfwrite_unlocked (&c, 1, port); |
fca14149 AW |
469 | } |
470 | ||
471 | SCM_INLINE_IMPLEMENTATION void | |
0607ebbf | 472 | scm_puts_unlocked (const char *s, SCM port) |
fca14149 AW |
473 | { |
474 | SCM_ASSERT_TYPE (SCM_OPOUTPORTP (port), port, 0, NULL, "output port"); | |
f209aeee | 475 | scm_lfwrite_unlocked (s, strlen (s), port); |
fca14149 AW |
476 | } |
477 | #endif /* SCM_CAN_INLINE || defined SCM_INLINE_C_IMPLEMENTING_INLINES */ | |
478 | ||
22a52da1 | 479 | #endif /* SCM_PORTS_H */ |
89e00824 ML |
480 | |
481 | /* | |
482 | Local Variables: | |
483 | c-file-style: "gnu" | |
484 | End: | |
485 | */ |