Repository navigation
Expand file tree
/
Copy pathtext_writer.rs
More file actions
595 lines (540 loc) · 17.1 KB
/
Copy pathtext_writer.rs
File metadata and controls
595 lines (540 loc) · 17.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
use crate::text_output::TextOutput;
use crate::{TextSubstr, WriteText};
#[cfg(windows)]
use io_extras::os::windows::{
AsHandleOrSocket, AsRawHandleOrSocket, BorrowedHandleOrSocket, RawHandleOrSocket,
};
use layered_io::{Bufferable, LayeredWriter, WriteLayered};
use std::fmt::{self, Debug, Formatter};
use std::io::{self, Write};
use std::str;
#[cfg(feature = "terminal-io")]
use terminal_io::{Terminal, TerminalColorSupport, WriteTerminal};
use utf8_io::{Utf8Writer, WriteStr};
#[cfg(not(windows))]
use {
io_extras::os::rustix::{AsRawFd, RawFd},
std::os::fd::{AsFd, BorrowedFd},
};
/// A `WriteLayered` implementation which translates to an output
/// `WriteLayered` producing a valid Basic Text stream from an arbitrary
/// byte sequence.
///
/// `write` is not guaranteed to perform a single operation, because short
/// writes could produce invalid UTF-8, so `write` will retry as needed.
///
/// # Examples
///
/// ```rust
/// use basic_text::TextWriter;
/// use layered_io::WriteLayered;
///
/// let mut output = TextWriter::new(std::io::stdout());
///
/// // write to `output`
///
/// output.close().unwrap();
/// ```
pub struct TextWriter<Inner> {
/// The wrapped byte stream.
pub(crate) inner: Inner,
/// Text translation state.
pub(crate) output: TextOutput,
}
impl<Inner: Write> TextWriter<Utf8Writer<LayeredWriter<Inner>>> {
/// Construct a new instance of `TextWriter` wrapping `inner`, which can be
/// anything that implements [`Write`].
#[inline]
pub fn new(inner: Inner) -> Self {
Self::from_utf8(Utf8Writer::new(LayeredWriter::new(inner)))
}
/// Like `new`, but writes a U+FEFF (BOM) to the beginning of the output
/// stream for compatibility with consumers that require that to determine
/// the text encoding.
#[inline]
pub fn with_bom_compatibility(inner: Inner) -> io::Result<Self> {
Self::from_utf8_with_bom_compatibility(Utf8Writer::new(LayeredWriter::new(inner)))
}
/// Like `new`, but enables CRLF output mode, which translates "\n" to
/// "\r\n" for compatibility with consumers that need that.
///
/// Note: This is not often needed; even on Windows these days most
/// things are ok with plain '\n' line endings, [including Windows
/// Notepad]. The main notable things that really need them are IETF
/// RFCs, for example [RFC-5198].
///
/// [including Windows Notepad]: https://devblogs.microsoft.com/commandline/extended-eol-in-notepad/
/// [RFC-5198]: https://tools.ietf.org/html/rfc5198#appendix-C
#[inline]
pub fn with_crlf_compatibility(inner: Inner) -> Self {
Self::from_utf8_with_crlf_compatibility(Utf8Writer::new(LayeredWriter::new(inner)))
}
}
impl<Inner: WriteStr + WriteLayered> TextWriter<Inner> {
/// Construct a new instance of `TextWriter` wrapping `inner`, which
/// can be anything that implements `WriteStr + WriteLayered`, such as a
/// [`Utf8Writer`].
#[inline]
pub fn from_utf8(inner: Inner) -> Self {
Self {
inner,
output: TextOutput::new(),
}
}
/// Like `from_utf8`, but writes a U+FEFF (BOM) to the beginning of the
/// output stream for compatibility with consumers that require that to
/// determine the text encoding.
#[inline]
pub fn from_utf8_with_bom_compatibility(mut inner: Inner) -> io::Result<Self> {
let output = TextOutput::with_bom_compatibility(&mut inner)?;
Ok(Self { inner, output })
}
/// Like `from_utf8`, but enables CRLF output mode, which translates "\n"
/// to "\r\n" for compatibility with consumers that need that.
///
/// Note: This is not often needed; even on Windows these days most
/// things are ok with plain '\n' line endings, [including Windows
/// Notepad]. The main notable things that really need them are IETF
/// RFCs, for example [RFC-5198].
///
/// [including Windows Notepad]: https://devblogs.microsoft.com/commandline/extended-eol-in-notepad/
/// [RFC-5198]: https://tools.ietf.org/html/rfc5198#appendix-C
#[inline]
pub fn from_utf8_with_crlf_compatibility(inner: Inner) -> Self {
Self {
inner,
output: TextOutput::with_crlf_compatibility(),
}
}
/// Flush and close the underlying stream and return the underlying
/// stream object.
#[inline]
pub fn close_into_inner(self) -> io::Result<Inner> {
TextOutput::close_into_inner(self)
}
/// Return the underlying stream object.
#[inline]
pub fn abandon_into_inner(self) -> Inner {
TextOutput::abandon_into_inner(self)
}
}
#[cfg(feature = "terminal-io")]
impl<Inner: WriteStr + WriteLayered + WriteTerminal> TextWriter<Inner> {
/// Construct a new instance of `TextWriter` wrapping `inner` that
/// optionally permits "ANSI"-style color escape sequences of the form
/// `ESC [ ... m` on output.
#[inline]
pub fn with_ansi_color_output(inner: Inner) -> Self {
let ansi_color = inner.color_support() != TerminalColorSupport::Monochrome;
Self {
inner,
output: TextOutput::with_ansi_color(ansi_color),
}
}
}
#[cfg(feature = "terminal-io")]
impl<Inner: WriteStr + WriteLayered + WriteTerminal> Terminal for TextWriter<Inner> {}
#[cfg(feature = "terminal-io")]
impl<Inner: WriteStr + WriteLayered + WriteTerminal> WriteTerminal for TextWriter<Inner> {
#[inline]
fn color_support(&self) -> TerminalColorSupport {
self.inner.color_support()
}
#[inline]
fn color_preference(&self) -> bool {
self.inner.color_preference()
}
#[inline]
fn is_output_terminal(&self) -> bool {
self.inner.is_output_terminal()
}
}
impl<Inner: WriteStr + WriteLayered> WriteLayered for TextWriter<Inner> {
#[inline]
fn close(&mut self) -> io::Result<()> {
TextOutput::close(self)
}
}
impl<Inner: WriteStr + WriteLayered> WriteStr for TextWriter<Inner> {
#[inline]
fn write_str(&mut self, s: &str) -> io::Result<()> {
TextOutput::write_str(self, s)
}
}
impl<Inner: WriteStr + WriteLayered> WriteText for TextWriter<Inner> {
#[inline]
fn write_text_substr(&mut self, s: &TextSubstr) -> io::Result<()> {
TextOutput::write_text_substr(self, s)
}
}
impl<Inner: WriteStr + WriteLayered> Bufferable for TextWriter<Inner> {
#[inline]
fn abandon(&mut self) {
TextOutput::abandon(self);
}
#[inline]
fn suggested_buffer_size(&self) -> usize {
TextOutput::suggested_buffer_size(self)
}
}
impl<Inner: WriteStr + WriteLayered> Write for TextWriter<Inner> {
#[inline]
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
TextOutput::write(self, buf)
}
#[inline]
fn flush(&mut self) -> io::Result<()> {
TextOutput::flush(self)
}
#[cfg(can_vector)]
#[inline]
fn is_write_vectored(&self) -> bool {
TextOutput::is_write_vectored(self)
}
#[inline]
fn write_vectored(&mut self, bufs: &[io::IoSlice<'_>]) -> io::Result<usize> {
TextOutput::write_vectored(self, bufs)
}
#[cfg(write_all_vectored)]
#[inline]
fn write_all_vectored(&mut self, bufs: &mut [io::IoSlice<'_>]) -> io::Result<()> {
TextOutput::write_all_vectored(self, bufs)
}
}
#[cfg(not(windows))]
impl<Inner: WriteStr + WriteLayered + AsRawFd> AsRawFd for TextWriter<Inner> {
#[inline]
fn as_raw_fd(&self) -> RawFd {
self.inner.as_raw_fd()
}
}
#[cfg(not(windows))]
impl<Inner: WriteStr + WriteLayered + AsFd> AsFd for TextWriter<Inner> {
#[inline]
fn as_fd(&self) -> BorrowedFd<'_> {
self.inner.as_fd()
}
}
#[cfg(windows)]
impl<Inner: WriteStr + WriteLayered + AsRawHandleOrSocket> AsRawHandleOrSocket
for TextWriter<Inner>
{
#[inline]
fn as_raw_handle_or_socket(&self) -> RawHandleOrSocket {
self.inner.as_raw_handle_or_socket()
}
}
#[cfg(windows)]
impl<Inner: WriteStr + WriteLayered + AsHandleOrSocket> AsHandleOrSocket for TextWriter<Inner> {
#[inline]
fn as_handle_or_socket(&self) -> BorrowedHandleOrSocket<'_> {
self.inner.as_handle_or_socket()
}
}
impl<Inner: Debug> Debug for TextWriter<Inner> {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
let mut b = f.debug_struct("TextWriter");
b.field("inner", &self.inner);
b.finish()
}
}
#[cfg(test)]
fn translate_via_layered_writer(bytes: &[u8]) -> io::Result<String> {
let mut writer = TextWriter::new(Vec::<u8>::new());
match writer.write_all(bytes) {
Ok(()) => (),
Err(err) => {
writer.abandon();
return Err(err);
}
}
let inner = writer
.close_into_inner()?
.close_into_inner()?
.close_into_inner()?;
Ok(String::from_utf8(inner).unwrap())
}
#[cfg(test)]
fn translate_str_via_layered_writer(s: &str) -> io::Result<String> {
let mut writer = TextWriter::new(Vec::<u8>::new());
match writer.write_str(s) {
Ok(()) => (),
Err(err) => {
writer.abandon();
return Err(err);
}
}
let inner = writer
.close_into_inner()?
.close_into_inner()?
.close_into_inner()?;
Ok(String::from_utf8(inner).unwrap())
}
#[cfg(test)]
fn test(s: &str, expected: &str) {
assert_eq!(
translate_via_layered_writer(s.as_bytes()).unwrap(),
expected
);
assert_eq!(translate_str_via_layered_writer(s).unwrap(), expected);
}
#[cfg(test)]
fn test_error(bytes: &[u8]) {
translate_via_layered_writer(bytes).unwrap_err();
}
#[test]
fn test_empty_string() {
test("", "");
}
#[test]
fn test_no_newline() {
test_error(b"hello");
}
#[test]
fn test_nl() {
test("\n", "\n");
test("\nhello\nworld\n", "\nhello\nworld\n");
}
#[test]
fn test_bom() {
test_error("\u{feff}".as_bytes());
test_error("\u{feff}\n".as_bytes());
test_error("\u{feff}hello\u{feff}world\u{feff}".as_bytes());
test_error("\u{feff}hello\u{feff}world\u{feff}\n".as_bytes());
test_error("\u{feff}hello world\n".as_bytes());
test_error("hello\u{feff}world\n".as_bytes());
test_error("hello world\u{feff}".as_bytes());
test_error("hello world\u{feff}\n".as_bytes());
}
#[test]
fn test_crlf() {
test_error(b"\r\n");
test_error(b"\r\nhello\r\nworld\r");
test_error(b"\r\nhello\r\nworld\r\n");
test_error(b"\r\nhello world\n");
test_error(b"hello\r\nworld\n");
test_error(b"hello world\r");
test_error(b"hello world\r\n");
}
#[test]
fn test_cr_plain() {
test_error(b"\r");
test_error(b"\rhello\rworld\r");
test_error(b"\rhello\rworld\r\n");
test_error(b"\rhello world\n");
test_error(b"hello\rworld\n");
test_error(b"hello world\r");
test_error(b"hello world\r\n");
}
#[test]
fn test_ff() {
test_error(b"\x0c");
test_error(b"\x0c\n");
test_error(b"\x0chello\x0cworld\x0c");
test_error(b"\x0chello\x0cworld\x0c\n");
test_error(b"\x0chello world\n");
test_error(b"hello\x0cworld\n");
test_error(b"hello world\x0c");
test_error(b"hello world\x0c\n");
}
#[test]
fn test_del() {
test_error(b"\x7f");
test_error(b"\x7f\n");
test_error(b"\x7fhello\x7fworld\x7f");
test_error(b"\x7fhello\x7fworld\x7f\n");
test_error(b"\x7fhello world\n");
test_error(b"hello\x7fworld\n");
test_error(b"hello world\x7f");
test_error(b"hello world\x7f\n");
}
#[test]
fn test_non_text_c0() {
test_error(b"\x00");
test_error(b"\x01");
test_error(b"\x02");
test_error(b"\x03");
test_error(b"\x04");
test_error(b"\x05");
test_error(b"\x06");
test_error(b"\x07");
test_error(b"\x08");
test_error(b"\x0b");
test_error(b"\x0e");
test_error(b"\x0f");
test_error(b"\x10");
test_error(b"\x11");
test_error(b"\x12");
test_error(b"\x13");
test_error(b"\x14");
test_error(b"\x15");
test_error(b"\x16");
test_error(b"\x17");
test_error(b"\x18");
test_error(b"\x19");
test_error(b"\x1a");
test_error(b"\x1b");
test_error(b"\x1c");
test_error(b"\x1d");
test_error(b"\x1e");
test_error(b"\x1f");
test_error(b"\x00\n");
test_error(b"\x01\n");
test_error(b"\x02\n");
test_error(b"\x03\n");
test_error(b"\x04\n");
test_error(b"\x05\n");
test_error(b"\x06\n");
test_error(b"\x07\n");
test_error(b"\x08\n");
test_error(b"\x0b\n");
test_error(b"\x0e\n");
test_error(b"\x0f\n");
test_error(b"\x10\n");
test_error(b"\x11\n");
test_error(b"\x12\n");
test_error(b"\x13\n");
test_error(b"\x14\n");
test_error(b"\x15\n");
test_error(b"\x16\n");
test_error(b"\x17\n");
test_error(b"\x18\n");
test_error(b"\x19\n");
test_error(b"\x1a\n");
test_error(b"\x1b\n");
test_error(b"\x1c\n");
test_error(b"\x1d\n");
test_error(b"\x1e\n");
test_error(b"\x1f\n");
}
#[test]
fn test_c1() {
test_error("\u{80}".as_bytes());
test_error("\u{81}".as_bytes());
test_error("\u{82}".as_bytes());
test_error("\u{83}".as_bytes());
test_error("\u{84}".as_bytes());
test_error("\u{85}".as_bytes());
test_error("\u{86}".as_bytes());
test_error("\u{87}".as_bytes());
test_error("\u{88}".as_bytes());
test_error("\u{89}".as_bytes());
test_error("\u{8a}".as_bytes());
test_error("\u{8b}".as_bytes());
test_error("\u{8c}".as_bytes());
test_error("\u{8d}".as_bytes());
test_error("\u{8e}".as_bytes());
test_error("\u{8f}".as_bytes());
test_error("\u{90}".as_bytes());
test_error("\u{91}".as_bytes());
test_error("\u{92}".as_bytes());
test_error("\u{93}".as_bytes());
test_error("\u{94}".as_bytes());
test_error("\u{95}".as_bytes());
test_error("\u{96}".as_bytes());
test_error("\u{97}".as_bytes());
test_error("\u{98}".as_bytes());
test_error("\u{99}".as_bytes());
test_error("\u{9a}".as_bytes());
test_error("\u{9b}".as_bytes());
test_error("\u{9c}".as_bytes());
test_error("\u{9d}".as_bytes());
test_error("\u{9e}".as_bytes());
test_error("\u{9f}".as_bytes());
test_error("\u{80}\n".as_bytes());
test_error("\u{81}\n".as_bytes());
test_error("\u{82}\n".as_bytes());
test_error("\u{83}\n".as_bytes());
test_error("\u{84}\n".as_bytes());
test_error("\u{85}\n".as_bytes());
test_error("\u{86}\n".as_bytes());
test_error("\u{87}\n".as_bytes());
test_error("\u{88}\n".as_bytes());
test_error("\u{89}\n".as_bytes());
test_error("\u{8a}\n".as_bytes());
test_error("\u{8b}\n".as_bytes());
test_error("\u{8c}\n".as_bytes());
test_error("\u{8d}\n".as_bytes());
test_error("\u{8e}\n".as_bytes());
test_error("\u{8f}\n".as_bytes());
test_error("\u{90}\n".as_bytes());
test_error("\u{91}\n".as_bytes());
test_error("\u{92}\n".as_bytes());
test_error("\u{93}\n".as_bytes());
test_error("\u{94}\n".as_bytes());
test_error("\u{95}\n".as_bytes());
test_error("\u{96}\n".as_bytes());
test_error("\u{97}\n".as_bytes());
test_error("\u{98}\n".as_bytes());
test_error("\u{99}\n".as_bytes());
test_error("\u{9a}\n".as_bytes());
test_error("\u{9b}\n".as_bytes());
test_error("\u{9c}\n".as_bytes());
test_error("\u{9d}\n".as_bytes());
test_error("\u{9e}\n".as_bytes());
test_error("\u{9f}\n".as_bytes());
}
#[test]
fn test_nfc() {
test_error("\u{212b}".as_bytes());
test_error("\u{212b}\n".as_bytes());
test("\u{c5}\n", "\u{c5}\n");
test("\u{41}\u{30a}\n", "\u{c5}\n");
}
#[test]
fn test_leading_nonstarters() {
test_error("\u{30a}".as_bytes());
test_error("\u{30a}\n".as_bytes());
}
#[test]
fn test_esc() {
test_error(b"\x1b");
test_error(b"\x1b\n");
test_error(b"\x1b@");
test_error(b"\x1b@\n");
test_error(b"\x1b@hello\x1b@world\x1b@");
test_error(b"\x1b@hello\x1b@world\x1b@\n");
}
#[test]
fn test_csi() {
test_error(b"\x1b[");
test_error(b"\x1b[\n");
test_error(b"\x1b[@hello\x1b[@world\x1b[@");
test_error(b"\x1b[@hello\x1b[@world\x1b[@\n");
test_error(b"\x1b[+@hello\x1b[+@world\x1b[+@");
test_error(b"\x1b[+@hello\x1b[+@world\x1b[+@\n");
}
#[test]
fn test_osc() {
test_error(b"\x1b]");
test_error(b"\x1b]\n");
test_error(b"\x1b]\x07hello\x1b]\x07world\x1b]\x07");
test_error(b"\x1b]\x07hello\x1b]\x07world\x1b]\x07\n");
test_error(b"\x1b]message\x07hello\x1b]message\x07world\x1b]message\x07");
test_error(b"\x1b]message\x07hello\x1b]message\x07world\x1b]message\x07\n");
test_error(b"\x1b]mes\ns\tage\x07hello\x1b]mes\ns\tage\x07world\x1b]mes\ns\tage\x07");
test_error(b"\x1b]mes\ns\tage\x07hello\x1b]mes\ns\tage\x07world\x1b]mes\ns\tage\x07\n");
}
#[test]
fn test_linux() {
test_error(b"\x1b[[A");
test_error(b"\x1b[[A\n");
test_error(b"\x1b[[Ahello\x1b[[Aworld\x1b[[A");
test_error(b"\x1b[[Ahello\x1b[[Aworld\x1b[[A\n");
}
#[test]
fn test_unassigned() {
test_error("\u{1d455}".as_bytes());
test_error("\u{1d455}\n".as_bytes());
}
#[test]
fn test_dddha() {
test_error("\u{11099}\u{110ba}".as_bytes());
test_error("\u{1109a}".as_bytes());
test_error("\u{110ba}".as_bytes());
test_error("\u{110ba}\n".as_bytes());
test("\u{11099}\u{110ba}\n", "\u{1109a}\n");
test("\u{1109a}\n", "\u{1109a}\n");
}
// TODO: Test Stream-Safe
// TODO: test for nonstarter after push