Mercurial > hg > xemacs-beta
annotate src/lstream.h @ 5880:44ba043ceada
Fix a small typo
| author | Vin Shelton <acs@xemacs.org> |
|---|---|
| date | Sat, 28 Mar 2015 16:03:33 -0400 |
| parents | a216b3c2b09e |
| children |
| rev | line source |
|---|---|
| 428 | 1 /* Generic stream implementation -- header file. |
| 2 Copyright (C) 1995 Free Software Foundation, Inc. | |
| 788 | 3 Copyright (C) 1996, 2001, 2002 Ben Wing. |
| 428 | 4 |
| 5 This file is part of XEmacs. | |
| 6 | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5127
diff
changeset
|
7 XEmacs is free software: you can redistribute it and/or modify it |
| 428 | 8 under the terms of the GNU General Public License as published by the |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5127
diff
changeset
|
9 Free Software Foundation, either version 3 of the License, or (at your |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5127
diff
changeset
|
10 option) any later version. |
| 428 | 11 |
| 12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5127
diff
changeset
|
18 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. */ |
| 428 | 19 |
| 20 /* Synched up with: Not in FSF. */ | |
| 21 | |
| 22 /* Written by Ben Wing. */ | |
| 23 | |
| 440 | 24 #ifndef INCLUDED_lstream_h_ |
| 25 #define INCLUDED_lstream_h_ | |
| 428 | 26 |
|
5814
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
27 #include "tls.h" |
|
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
28 |
| 428 | 29 /************************************************************************/ |
| 30 /* definition of Lstream object */ | |
| 31 /************************************************************************/ | |
| 32 | |
|
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents:
3017
diff
changeset
|
33 DECLARE_LISP_OBJECT (lstream, struct lstream); |
| 428 | 34 #define XLSTREAM(x) XRECORD (x, lstream, struct lstream) |
| 617 | 35 #define wrap_lstream(p) wrap_record (p, lstream) |
| 428 | 36 #define LSTREAMP(x) RECORDP (x, lstream) |
| 37 /* #define CHECK_LSTREAM(x) CHECK_RECORD (x, lstream) | |
| 38 Lstream pointers should never escape to the Lisp level, so | |
| 39 functions should not be doing this. */ | |
| 40 | |
| 41 #ifndef EOF | |
| 42 #define EOF (-1) | |
| 43 #endif | |
| 44 | |
| 771 | 45 /* There have been some arguments over the what the type should be that |
| 665 | 46 specifies a count of bytes in a data block to be written out or read in, |
| 47 using Lstream_read(), Lstream_write(), and related functions. | |
| 48 Originally it was long, which worked fine; Martin "corrected" these to | |
| 49 size_t and ssize_t on the grounds that this is theoretically cleaner and | |
| 50 is in keeping with the C standards. Unfortunately, this practice is | |
| 51 horribly error-prone due to design flaws in the way that mixed | |
| 52 signed/unsigned arithmetic happens. In fact, by doing this change, | |
| 53 Martin introduced a subtle but fatal error that caused the operation of | |
| 54 sending large mail messages to the SMTP server under Windows to fail. | |
| 55 By putting all values back to be signed, avoiding any signed/unsigned | |
| 56 mixing, the bug immediately went away. The type then in use was | |
| 57 Lstream_Data_Count, so that it be reverted cleanly if a vote came to | |
| 58 that. Now it is Bytecount. | |
| 59 | |
| 60 Some earlier comments about why the type must be signed: This MUST BE | |
| 61 SIGNED, since it also is used in functions that return the number of | |
| 62 bytes actually read to or written from in an operation, and these | |
| 63 functions can return -1 to signal error. | |
| 462 | 64 |
| 65 Note that the standard Unix read() and write() functions define the | |
| 66 count going in as a size_t, which is UNSIGNED, and the count going | |
| 67 out as an ssize_t, which is SIGNED. This is a horrible design | |
| 68 flaw. Not only is it highly likely to lead to logic errors when a | |
| 69 -1 gets interpreted as a large positive number, but operations are | |
| 70 bound to fail in all sorts of horrible ways when a number in the | |
| 71 upper-half of the size_t range is passed in -- this number is | |
| 72 unrepresentable as an ssize_t, so code that checks to see how many | |
| 73 bytes are actually written (which is mandatory if you are dealing | |
| 74 with certain types of devices) will get completely screwed up. | |
| 771 | 75 |
| 665 | 76 --ben |
| 462 | 77 */ |
| 428 | 78 typedef enum lstream_buffering |
| 79 { | |
| 80 /* No buffering. */ | |
| 81 LSTREAM_UNBUFFERED, | |
| 82 /* Buffer until a '\n' character is reached. */ | |
| 83 LSTREAM_LINE_BUFFERED, | |
| 84 /* Buffer in standard-size (i.e. 512-byte) blocks. */ | |
| 85 LSTREAM_BLOCK_BUFFERED, | |
| 86 /* Buffer in blocks of a specified size. */ | |
| 87 LSTREAM_BLOCKN_BUFFERED, | |
| 88 /* Buffer until the stream is closed (only applies to write-only | |
| 89 streams). Only one call to the stream writer will be made, | |
| 90 and that is when the stream is closed. */ | |
| 91 LSTREAM_UNLIMITED | |
| 92 } Lstream_buffering; | |
| 93 | |
| 771 | 94 #if 0 |
| 95 | |
| 96 /* #### not currently implemented; correct EOF handling is quite tricky | |
| 97 in the presence of various levels of filtering streams, and simply | |
| 98 interpreting 0 as EOF works fairly well as long as the amount of | |
| 99 data you're attempting to read is large and you know whether the | |
| 100 source stream at the end of the chain is a pipe (or other blocking | |
| 101 source) or not. we really should fix this, though. */ | |
| 102 | |
| 103 /* Return values from Lstream_read(). We do NOT use the C lib trick | |
| 104 of returning 0 to maybe indicate EOF because that is simply too | |
| 105 random and error-prone. It is quite legitimate for there to be no | |
| 106 data available but no EOF, even when not in the presence of | |
| 107 non-blocking I/O. For example, decoding/encoding streams (and in | |
| 108 general, any type of filtering stream) may only be able to return | |
| 109 data after a certain amount of data on the other end is | |
| 110 available. */ | |
| 111 | |
| 112 #define LSTREAM_EOF -2 | |
| 113 | |
| 114 #endif /* 0 */ | |
| 115 | |
| 116 #define LSTREAM_ERROR -1 | |
| 117 | |
| 428 | 118 /* Methods defining how this stream works. Some may be undefined. */ |
| 119 | |
| 120 /* We do not implement the seek/tell paradigm. I tried to do that, | |
| 121 but getting the semantics right in the presence of buffering is | |
| 122 extremely tricky and very error-prone and basically not worth it. | |
| 123 This is especially the case with complicated streams like | |
| 124 decoding streams -- the seek pointer in this case can't be a single | |
| 125 integer but has to be a whole complicated structure that records | |
| 126 all of the stream's state at the time. | |
| 127 | |
| 128 Rewind semantics are generally easy to implement, so we do provide | |
| 129 a rewind method. Even rewind() may not be available on a stream, | |
| 130 however -- e.g. on process output. */ | |
| 131 | |
| 132 typedef struct lstream_implementation | |
| 133 { | |
| 442 | 134 const char *name; |
| 665 | 135 Bytecount size; /* Number of additional bytes to be |
| 814 | 136 allocated with this stream. Access this |
| 137 data using Lstream_data(). */ | |
| 1204 | 138 |
| 139 /* Description of the extra data (struct foo_lstream) attached to a | |
| 140 coding system. */ | |
| 141 const struct sized_memory_description *extra_description; | |
| 142 | |
| 428 | 143 /* Read some data from the stream's end and store it into DATA, which |
| 144 can hold SIZE bytes. Return the number of bytes read. A return | |
| 145 value of 0 means no bytes can be read at this time. This may | |
| 146 be because of an EOF, or because there is a granularity greater | |
| 147 than one byte that the stream imposes on the returned data, and | |
| 148 SIZE is less than this granularity. (This will happen frequently | |
| 149 for streams that need to return whole characters, because | |
| 150 Lstream_read() calls the reader function repeatedly until it | |
| 151 has the number of bytes it wants or until 0 is returned.) | |
| 152 The lstream functions do not treat a 0 return as EOF or do | |
| 153 anything special; however, the calling function will interpret | |
| 154 any 0 it gets back as EOF. This will normally not happen unless | |
| 155 the caller calls Lstream_read() with a very small size. | |
| 156 | |
| 157 This function can be NULL if the stream is output-only. */ | |
| 442 | 158 /* The omniscient mly, blinded by the irresistible thrall of Common |
| 428 | 159 Lisp, thinks that it is bogus that the types and implementations |
| 160 of input and output streams are the same. */ | |
| 665 | 161 Bytecount (*reader) (Lstream *stream, unsigned char *data, |
| 814 | 162 Bytecount size); |
| 428 | 163 /* Send some data to the stream's end. Data to be sent is in DATA |
| 164 and is SIZE bytes. Return the number of bytes sent. This | |
| 165 function can send and return fewer bytes than is passed in; in | |
| 166 that case, the function will just be called again until there is | |
| 167 no data left or 0 is returned. A return value of 0 means that no | |
| 168 more data can be currently stored, but there is no error; the | |
| 169 data will be squirrelled away until the writer can accept | |
| 170 data. (This is useful, e.g., of you're dealing with a | |
| 171 non-blocking file descriptor and are getting EWOULDBLOCK errors.) | |
| 172 This function can be NULL if the stream is input-only. */ | |
| 665 | 173 Bytecount (*writer) (Lstream *stream, const unsigned char *data, |
| 814 | 174 Bytecount size); |
| 428 | 175 /* Return non-zero if the last write operation on the stream resulted |
| 176 in an attempt to block (EWOULDBLOCK). If this method does not | |
| 177 exists, the implementation returns 0 */ | |
| 178 int (*was_blocked_p) (Lstream *stream); | |
|
5795
d2c0ff38ad5c
Report lstream errors when encoding/decoding.
Jerry James <james@xemacs.org>
parents:
5776
diff
changeset
|
179 /* If the reader or writer method returned LSTREAM_ERROR, the errno |
|
d2c0ff38ad5c
Report lstream errors when encoding/decoding.
Jerry James <james@xemacs.org>
parents:
5776
diff
changeset
|
180 associated with the error, or zero if there was no system error or this |
|
d2c0ff38ad5c
Report lstream errors when encoding/decoding.
Jerry James <james@xemacs.org>
parents:
5776
diff
changeset
|
181 method is not implemented. */ |
|
d2c0ff38ad5c
Report lstream errors when encoding/decoding.
Jerry James <james@xemacs.org>
parents:
5776
diff
changeset
|
182 int (*error) (Lstream *stream); |
| 428 | 183 /* Rewind the stream. If this is NULL, the stream is not seekable. */ |
| 184 int (*rewinder) (Lstream *stream); | |
| 185 /* Indicate whether this stream is seekable -- i.e. it can be rewound. | |
| 186 This method is ignored if the stream does not have a rewind | |
| 187 method. If this method is not present, the result is determined | |
| 188 by whether a rewind method is present. */ | |
| 189 int (*seekable_p) (Lstream *stream); | |
|
5776
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
190 |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
191 /* Return the number of complete characters read so far. Respects |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
192 buffering and unget. Returns -1 if unknown or not implemented. */ |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
193 Charcount (*character_tell) (Lstream *stream); |
| 428 | 194 /* Perform any additional operations necessary to flush the |
| 195 data in this stream. */ | |
| 196 int (*flusher) (Lstream *stream); | |
| 771 | 197 /* Perform any additional operations necessary to close this stream down. |
| 198 May be NULL. This function is called when Lstream_close() is called | |
| 199 (which will be called automatically on any open streams when they are | |
| 200 garbage-collected or deleted with Lstream_delete()). When this | |
| 201 function is called, all pending data in the stream will already have | |
| 202 been written out; however, the closer write more data, e.g. an "end" | |
| 203 section at the end of a file. */ | |
| 428 | 204 int (*closer) (Lstream *stream); |
| 771 | 205 /* Clean up any remaining data at the time that a stream is |
| 206 garbage-collected or deleted with Lstream_delete(). If the stream was | |
| 207 open at this point, the finalizer is called after calling | |
| 208 Lstream_close(). Called only once (NOT called at disksave time). */ | |
| 209 void (*finalizer) (Lstream *stream); | |
| 428 | 210 /* Mark this object for garbage collection. Same semantics as |
| 211 a standard Lisp_Object marker. This function can be NULL. */ | |
| 212 Lisp_Object (*marker) (Lisp_Object lstream); | |
|
5814
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
213 /* Return nonzero if this stream is using a TLS connection */ |
|
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
214 int (*tls_p) (Lstream *stream); |
|
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
215 /* Perform STARTTLS negotiation on a pair of streams, one for input and one |
|
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
216 for output. Both are transformed if negotiation is successful. */ |
|
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
217 int (*tls_negotiater) (Lstream *instream, Lstream *outstream, |
|
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
218 const Extbyte *host, Lisp_Object keylist); |
| 428 | 219 } Lstream_implementation; |
| 220 | |
| 771 | 221 #define DEFINE_LSTREAM_IMPLEMENTATION(name, c_name) \ |
| 222 Lstream_implementation lstream_##c_name[1] = \ | |
| 1204 | 223 { { (name), sizeof (struct c_name##_stream), \ |
| 224 &lstream_empty_extra_description } } | |
| 225 | |
| 226 #define DEFINE_LSTREAM_IMPLEMENTATION_WITH_DATA(name, c_name) \ | |
| 227 static const struct sized_memory_description c_name##_lstream_description_0 \ | |
| 228 = { \ | |
| 229 sizeof (struct c_name##_stream), \ | |
| 230 c_name##_lstream_description \ | |
| 231 }; \ | |
| 232 Lstream_implementation lstream_##c_name[1] = \ | |
| 233 { { (name), sizeof (struct c_name##_stream), \ | |
| 234 &c_name##_lstream_description_0 } } | |
| 771 | 235 |
| 236 #define DECLARE_LSTREAM(c_name) \ | |
| 237 extern Lstream_implementation lstream_##c_name[] | |
| 428 | 238 |
| 239 #define LSTREAM_FL_IS_OPEN 1 | |
| 240 #define LSTREAM_FL_READ 2 | |
| 241 #define LSTREAM_FL_WRITE 4 | |
| 242 #define LSTREAM_FL_NO_PARTIAL_CHARS 8 | |
| 243 #define LSTREAM_FL_CLOSE_AT_DISKSAVE 16 | |
| 244 | |
| 245 struct lstream | |
| 246 { | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
247 NORMAL_LISP_OBJECT_HEADER header; |
| 442 | 248 const Lstream_implementation *imp; /* methods for this stream */ |
| 428 | 249 Lstream_buffering buffering; /* type of buffering in use */ |
| 665 | 250 Bytecount buffering_size; /* number of bytes buffered */ |
| 428 | 251 |
| 252 unsigned char *in_buffer; /* holds characters read from stream end */ | |
| 665 | 253 Bytecount in_buffer_size; /* allocated size of buffer */ |
| 254 Bytecount in_buffer_current; /* number of characters in buffer */ | |
| 255 Bytecount in_buffer_ind; /* pointer to next character to | |
| 462 | 256 take from buffer */ |
| 428 | 257 |
| 258 unsigned char *out_buffer; /* holds characters to write to stream end */ | |
| 665 | 259 Bytecount out_buffer_size; /* allocated size of buffer */ |
| 260 Bytecount out_buffer_ind; /* pointer to next buffer spot to | |
| 462 | 261 write a character */ |
| 428 | 262 |
| 263 /* The unget buffer is more or less a stack -- things get pushed | |
| 264 onto the end and read back from the end. Lstream_read() | |
| 265 basically reads backwards from the end to get stuff; Lstream_unread() | |
| 266 similarly has to push the data on backwards. */ | |
| 267 unsigned char *unget_buffer; /* holds characters pushed back onto input */ | |
| 665 | 268 Bytecount unget_buffer_size; /* allocated size of buffer */ |
|
5776
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
269 Bytecount unget_buffer_ind; /* Next buffer spot to write a character */ |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
270 |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
271 Charcount unget_character_count; /* Count of complete characters ever ungot. */ |
| 428 | 272 |
| 665 | 273 Bytecount byte_count; |
| 456 | 274 int flags; |
| 275 max_align_t data[1]; | |
| 428 | 276 }; |
| 277 | |
| 1204 | 278 extern const struct sized_memory_description lstream_empty_extra_description; |
| 279 | |
| 428 | 280 #define LSTREAM_TYPE_P(lstr, type) \ |
| 281 ((lstr)->imp == lstream_##type) | |
| 282 | |
| 800 | 283 #ifdef ERROR_CHECK_TYPES |
| 826 | 284 DECLARE_INLINE_HEADER ( |
| 285 struct lstream * | |
| 428 | 286 error_check_lstream_type (struct lstream *stream, |
| 442 | 287 const Lstream_implementation *imp) |
| 826 | 288 ) |
| 428 | 289 { |
| 290 assert (stream->imp == imp); | |
| 291 return stream; | |
| 292 } | |
| 771 | 293 # define LSTREAM_TYPE_DATA(lstr, type) \ |
| 294 ((struct type##_stream *) \ | |
| 295 Lstream_data (error_check_lstream_type (lstr, lstream_##type))) | |
| 428 | 296 #else |
| 771 | 297 # define LSTREAM_TYPE_DATA(lstr, type) \ |
| 428 | 298 ((struct type##_stream *) Lstream_data (lstr)) |
| 299 #endif | |
| 300 | |
| 771 | 301 /* Declare that lstream-type TYPE has method M; used in initialization |
| 302 routines */ | |
| 428 | 303 #define LSTREAM_HAS_METHOD(type, m) \ |
| 304 (lstream_##type->m = type##_##m) | |
| 305 | |
| 306 | |
| 442 | 307 Lstream *Lstream_new (const Lstream_implementation *imp, |
| 308 const char *mode); | |
| 428 | 309 void Lstream_reopen (Lstream *lstr); |
| 310 void Lstream_set_buffering (Lstream *lstr, Lstream_buffering buffering, | |
| 311 int buffering_size); | |
| 312 int Lstream_flush (Lstream *lstr); | |
| 313 int Lstream_flush_out (Lstream *lstr); | |
| 314 int Lstream_fputc (Lstream *lstr, int c); | |
| 315 int Lstream_fgetc (Lstream *lstr); | |
| 316 void Lstream_fungetc (Lstream *lstr, int c); | |
|
5776
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
317 Bytecount Lstream_read (Lstream *lstr, void *data, Bytecount size); |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
318 Charcount Lstream_character_tell (Lstream *); |
| 771 | 319 int Lstream_write (Lstream *lstr, const void *data, |
| 320 Bytecount size); | |
|
5795
d2c0ff38ad5c
Report lstream errors when encoding/decoding.
Jerry James <james@xemacs.org>
parents:
5776
diff
changeset
|
321 int Lstream_errno (Lstream *lstr); |
| 428 | 322 int Lstream_was_blocked_p (Lstream *lstr); |
| 665 | 323 void Lstream_unread (Lstream *lstr, const void *data, Bytecount size); |
| 428 | 324 int Lstream_rewind (Lstream *lstr); |
| 325 int Lstream_seekable_p (Lstream *lstr); | |
| 326 int Lstream_close (Lstream *lstr); | |
|
5588
2dbefd79b3d3
Prevent SIGPIPEs in deactivate_process().
Stephen J. Turnbull <stephen@xemacs.org>
parents:
5402
diff
changeset
|
327 int Lstream_close_noflush (Lstream *lstr); |
| 771 | 328 |
|
5814
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
329 int Lstream_tls_p (Lstream *lstr); |
|
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
330 int Lstream_tls_negotiate (Lstream *instr, Lstream *outstr, |
|
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
331 const Extbyte *host, Lisp_Object keylist); |
|
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
332 |
| 428 | 333 void Lstream_delete (Lstream *lstr); |
| 334 void Lstream_set_character_mode (Lstream *str); | |
| 771 | 335 void Lstream_unset_character_mode (Lstream *lstr); |
| 428 | 336 |
| 771 | 337 /* Lstream_putc: Write out one byte to the stream. This is a macro |
| 338 and so it is very efficient. The C argument is only evaluated once | |
| 339 but the STREAM argument is evaluated more than once. Returns 0 on | |
| 340 success, -1 on error. */ | |
| 428 | 341 |
| 771 | 342 #define Lstream_putc(stream, c) \ |
| 343 /* Call the function equivalent if the out buffer is full. Otherwise, \ | |
| 344 add to the end of the out buffer and, if line buffering is called for \ | |
| 345 and the character marks the end of a line, write out the buffer. */ \ | |
| 346 ((stream)->out_buffer_ind >= (stream)->out_buffer_size ? \ | |
| 347 Lstream_fputc (stream, c) : \ | |
| 348 ((stream)->out_buffer[(stream)->out_buffer_ind++] = \ | |
| 349 (unsigned char) (c), \ | |
| 350 (stream)->byte_count++, \ | |
| 351 (stream)->buffering == LSTREAM_LINE_BUFFERED && \ | |
| 352 (stream)->out_buffer[(stream)->out_buffer_ind - 1] == '\n' ? \ | |
| 428 | 353 Lstream_flush_out (stream) : 0)) |
| 354 | |
| 771 | 355 /* Lstream_getc: Read one byte from the stream and returns it as an |
| 356 unsigned char cast to an int, or EOF on end of file or error. This | |
| 357 is a macro and so it is very efficient. The STREAM argument is | |
| 358 evaluated more than once. */ | |
| 359 | |
| 360 #define Lstream_getc(stream) \ | |
| 361 /* Retrieve from unget buffer if there are any characters there; \ | |
| 362 else retrieve from in buffer if there's anything there; \ | |
| 363 else call the function equivalent */ \ | |
| 428 | 364 ((stream)->unget_buffer_ind > 0 ? \ |
| 365 ((stream)->byte_count++, \ | |
| 366 (stream)->unget_buffer[--(stream)->unget_buffer_ind]) : \ | |
| 367 (stream)->in_buffer_ind < (stream)->in_buffer_current ? \ | |
| 368 ((stream)->byte_count++, \ | |
| 369 (stream)->in_buffer[(stream)->in_buffer_ind++]) : \ | |
| 370 Lstream_fgetc (stream)) | |
| 371 | |
| 771 | 372 /* Lstream_ungetc: Push one byte back onto the input queue, cast to |
| 373 unsigned char. This will be the next byte read from the stream. | |
| 374 Any number of bytes can be pushed back and will be read in the | |
| 375 reverse order they were pushed back -- most recent first. (This is | |
| 376 necessary for consistency -- if there are a number of bytes that | |
| 377 have been unread and I read and unread a byte, it needs to be the | |
|
5776
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
378 first to be read again.) */ |
| 771 | 379 |
|
5776
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
380 DECLARE_INLINE_HEADER ( |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
381 void |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
382 Lstream_ungetc (Lstream *lstr, int c) |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
383 ) |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
384 { |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
385 /* Add to the end if it won't overflow buffer; otherwise call the |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
386 function equivalent */ |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
387 if (lstr->unget_buffer_ind >= lstr->unget_buffer_size) |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
388 { |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
389 Lstream_fungetc (lstr, c); |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
390 } |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
391 else |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
392 { |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
393 lstr->byte_count--; |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
394 lstr->unget_buffer[lstr->unget_buffer_ind] = (unsigned char) (c); |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
395 lstr->unget_character_count |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
396 += valid_ibyteptr_p (lstr->unget_buffer + lstr->unget_buffer_ind); |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
397 lstr->unget_buffer_ind++; |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
398 } |
|
65d65b52d608
Pass character count from coding systems to buffer insertion code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5588
diff
changeset
|
399 } |
| 428 | 400 |
| 401 #define Lstream_data(stream) ((void *) ((stream)->data)) | |
| 402 #define Lstream_byte_count(stream) ((stream)->byte_count) | |
| 403 | |
| 404 | |
| 405 /************************************************************************/ | |
| 867 | 406 /* working with an Lstream as a stream of Ichars */ |
| 428 | 407 /************************************************************************/ |
| 408 | |
| 409 #ifdef MULE | |
| 410 | |
| 826 | 411 DECLARE_INLINE_HEADER ( |
| 867 | 412 Ichar |
| 413 Lstream_get_ichar (Lstream *stream) | |
| 826 | 414 ) |
| 428 | 415 { |
| 416 int c = Lstream_getc (stream); | |
| 826 | 417 return (c < 0x80 /* c == EOF || byte_ascii_p (c) */ |
| 867 | 418 ? (Ichar) c |
| 419 : Lstream_get_ichar_1 (stream, c)); | |
| 428 | 420 } |
| 421 | |
| 867 | 422 /* Write an Ichar to a stream. Return value is 0 for success, -1 for |
| 771 | 423 failure. */ |
| 424 | |
| 826 | 425 DECLARE_INLINE_HEADER ( |
| 426 int | |
| 867 | 427 Lstream_put_ichar (Lstream *stream, Ichar ch) |
| 826 | 428 ) |
| 428 | 429 { |
| 867 | 430 return ichar_ascii_p (ch) ? |
| 428 | 431 Lstream_putc (stream, ch) : |
| 867 | 432 Lstream_fput_ichar (stream, ch); |
| 428 | 433 } |
| 434 | |
| 826 | 435 DECLARE_INLINE_HEADER ( |
| 436 void | |
| 867 | 437 Lstream_unget_ichar (Lstream *stream, Ichar ch) |
| 826 | 438 ) |
| 428 | 439 { |
| 867 | 440 if (ichar_ascii_p (ch)) |
| 428 | 441 Lstream_ungetc (stream, ch); |
| 442 else | |
| 867 | 443 Lstream_funget_ichar (stream, ch); |
| 428 | 444 } |
| 445 #else /* not MULE */ | |
| 446 | |
| 867 | 447 # define Lstream_get_ichar(stream) Lstream_getc (stream) |
| 448 # define Lstream_put_ichar(stream, ch) Lstream_putc (stream, ch) | |
| 449 # define Lstream_unget_ichar(stream, ch) Lstream_ungetc (stream, ch) | |
| 428 | 450 |
| 451 #endif /* not MULE */ | |
| 452 | |
| 453 | |
| 454 /************************************************************************/ | |
| 455 /* Lstream implementations */ | |
| 456 /************************************************************************/ | |
| 457 | |
| 458 /* Flags we can pass to the filedesc and stdio streams. */ | |
| 459 | |
| 460 /* If set, close the descriptor or FILE * when the stream is closed. */ | |
| 461 #define LSTR_CLOSING 1 | |
| 462 | |
| 463 /* If set, allow quitting out of the actual I/O. */ | |
| 464 #define LSTR_ALLOW_QUIT 2 | |
| 465 | |
| 466 /* If set and filedesc_stream_set_pty_flushing() has been called | |
| 467 on the stream, do not send more than pty_max_bytes on a single | |
| 468 line without flushing the data out using the eof_char. */ | |
| 469 #define LSTR_PTY_FLUSHING 4 | |
| 470 | |
| 471 /* If set, an EWOULDBLOCK error is not treated as an error but | |
| 472 simply causes the write function to return 0 as the number | |
| 473 of bytes written out. */ | |
| 474 #define LSTR_BLOCKED_OK 8 | |
| 475 | |
| 476 Lisp_Object make_stdio_input_stream (FILE *stream, int flags); | |
| 477 Lisp_Object make_stdio_output_stream (FILE *stream, int flags); | |
| 478 Lisp_Object make_filedesc_input_stream (int filedesc, int offset, int count, | |
|
5814
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
479 int flags, tls_state_t *state); |
| 428 | 480 Lisp_Object make_filedesc_output_stream (int filedesc, int offset, int count, |
|
5814
a216b3c2b09e
Add TLS support. See xemacs-patches message with ID
Jerry James <james@xemacs.org>
parents:
5795
diff
changeset
|
481 int flags, tls_state_t *state); |
| 428 | 482 void filedesc_stream_set_pty_flushing (Lstream *stream, |
| 483 int pty_max_bytes, | |
| 867 | 484 Ibyte eof_char); |
| 428 | 485 int filedesc_stream_fd (Lstream *stream); |
| 486 Lisp_Object make_lisp_string_input_stream (Lisp_Object string, | |
| 487 Bytecount offset, | |
| 488 Bytecount len); | |
| 462 | 489 Lisp_Object make_fixed_buffer_input_stream (const void *buf, |
| 665 | 490 Bytecount size); |
| 462 | 491 Lisp_Object make_fixed_buffer_output_stream (void *buf, |
| 665 | 492 Bytecount size); |
| 442 | 493 const unsigned char *fixed_buffer_input_stream_ptr (Lstream *stream); |
| 428 | 494 unsigned char *fixed_buffer_output_stream_ptr (Lstream *stream); |
| 495 Lisp_Object make_resizing_buffer_output_stream (void); | |
| 496 unsigned char *resizing_buffer_stream_ptr (Lstream *stream); | |
| 788 | 497 Lisp_Object resizing_buffer_to_lisp_string (Lstream *stream); |
| 428 | 498 Lisp_Object make_dynarr_output_stream (unsigned_char_dynarr *dyn); |
| 499 #define LSTR_SELECTIVE 1 | |
| 500 #define LSTR_IGNORE_ACCESSIBLE 2 | |
| 665 | 501 Lisp_Object make_lisp_buffer_input_stream (struct buffer *buf, Charbpos start, |
| 502 Charbpos end, int flags); | |
| 503 Lisp_Object make_lisp_buffer_output_stream (struct buffer *buf, Charbpos pos, | |
| 428 | 504 int flags); |
| 665 | 505 Charbpos lisp_buffer_stream_startpos (Lstream *stream); |
| 428 | 506 |
| 440 | 507 #endif /* INCLUDED_lstream_h_ */ |