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